| blob | cdcb7df853fffd06c42a14e6d2f031e76e401d94 |
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"
689 "Non-nil means insert the first line setting Org-mode in empty files.
690 When the function `org-mode' is called interactively in an empty file, this
691 normally means that the file name does not automatically trigger Org-mode.
692 To ensure that the file will always be in Org-mode in the future, a
693 line enforcing Org-mode will be inserted into the buffer, if this option
694 has been set."
699 "Non-nil means use alternative key bindings for some keys.
700 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
701 These keys are also used by other packages like shift-selection-mode'
702 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
703 If you want to use Org-mode together with one of these other modes,
704 or more generally if you would like to move some Org-mode commands to
705 other keys, set this variable and configure the keys with the variable
706 `org-disputed-keys'.
708 This option is only relevant at load-time of Org-mode, and must be set
709 *before* org.el is loaded. Changing it requires a restart of Emacs to
710 become effective."
715 "Non-nil means use extra key sequence definitions for certain commands.
716 This happens automatically if you run XEmacs or if `window-system'
717 is nil. This variable lets you do the same manually. You must
718 set it before loading org.
720 Example: on Carbon Emacs 22 running graphically, with an external
721 keyboard on a Powerbook, the default way of setting M-left might
722 not work for either Alt or ESC. Setting this variable will make
723 it work for ESC."
737 "Keys for which Org-mode and other modes compete.
738 This is an alist, cars are the default keys, second element specifies
739 the alternative to use when `org-replace-disputed-keys' is t.
741 Keys can be specified in any syntax supported by `define-key'.
742 The value of this option takes effect only at Org-mode's startup,
743 therefore you'll have to restart Emacs to apply it after changing."
748 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
749 Or return the original if not disputed.
750 Also apply the translations defined in `org-xemacs-key-equivalents'."
755 org-disputed-keys)))
759 key)
769 "Define a key, possibly translated, as returned by `org-key'."
773 "The ellipsis to use in the Org-mode outline.
774 When nil, just use the standard three dots. When a string, use that instead,
775 When a face, use the standard 3 dots, but with the specified face.
776 The change affects only Org-mode (which will then use its own display table).
777 Changing this requires executing `M-x org-mode' in a buffer to become
778 effective."
788 "Keywords in Org-mode."
793 "String to mark deadline entries.
794 A deadline is this string, followed by a time stamp. Should be a word,
795 terminated by a colon. You can insert a schedule keyword and
797 Changes become only effective after restarting Emacs."
802 "String to mark scheduled TODO entries.
803 A schedule is this string, followed by a time stamp. Should be a word,
804 terminated by a colon. You can insert a schedule keyword and
806 Changes become only effective after restarting Emacs."
811 "String used as the prefix for timestamps logging closing a TODO entry."
816 "String used as prefix for timestamps clocking work hours on an item."
828 "Entries starting with this keyword will never be exported.
829 An entry can be toggled between COMMENT and normal with
831 Changes become only effective after restarting Emacs."
836 "Entries starting with this keyword will be exported in fixed-width font.
837 Quoting applies only to the text in the entry following the headline, and does
838 not extend beyond the next headline, even if that is lower level.
839 An entry can be toggled between QUOTE and normal with
846 "Regular expression for specifying repeated events.
850 "Options concerning the general structure of Org-mode files."
855 "Options about how to make context of a location visible."
879 "Non-nil means show full hierarchy when revealing a location.
880 Org-mode often shows locations in an org-mode file which might have
881 been invisible before. When this is set, the hierarchy of headings
882 above the exposed location is shown.
883 Turning this off for example for sparse trees makes them very compact.
884 Instead of t, this can also be an alist specifying this option for different
885 contexts. Valid contexts are
886 agenda when exposing an entry from the agenda
887 org-goto when using the command `org-goto' on key C-c C-j
888 occur-tree when using the command `org-occur' on key C-c /
889 tags-tree when constructing a sparse tree based on tags matches
890 link-search when exposing search matches associated with a link
891 mark-goto when exposing the jump goal of a mark
892 bookmark-jump when exposing a bookmark location
893 isearch when exiting from an incremental search
894 default default for all contexts not set explicitly"
899 "Non-nil means show following heading when revealing a location.
900 Org-mode often shows locations in an org-mode file which might have
901 been invisible before. When this is set, the heading following the
902 match is shown.
903 Turning this off for example for sparse trees makes them very compact,
904 but makes it harder to edit the location of the match. In such a case,
906 Instead of t, this can also be an alist specifying this option for different
907 contexts. See `org-show-hierarchy-above' for valid contexts."
912 "Non-nil means show all sibling heading when revealing a location.
913 Org-mode often shows locations in an org-mode file which might have
914 been invisible before. When this is set, the sibling of the current entry
915 heading are all made visible. If `org-show-hierarchy-above' is t,
916 the same happens on each level of the hierarchy above the current entry.
918 By default this is on for the isearch context, off for all other contexts.
919 Turning this off for example for sparse trees makes them very compact,
920 but makes it harder to edit the location of the match. In such a case,
922 Instead of t, this can also be an alist specifying this option for different
923 contexts. See `org-show-hierarchy-above' for valid contexts."
928 "Non-nil means show the entry below a headline when revealing a location.
929 Org-mode often shows locations in an org-mode file which might have
930 been invisible before. When this is set, the text below the headline that is
931 exposed is also shown.
933 By default this is off for all contexts.
934 Instead of t, this can also be an alist specifying this option for different
935 contexts. See `org-show-hierarchy-above' for valid contexts."
940 "How should indirect tree buffers be displayed?
941 This applies to indirect buffers created with the commands
943 Valid values are:
944 current-window Display in the current window
945 other-window Just display in another window.
946 dedicated-frame Create one new frame, and re-use it each time.
947 new-frame Make a new frame each time. Note that in this case
948 previously-made indirect buffers are kept, and you need to
949 kill these buffers yourself."
959 "Non-nil means activate single letter commands at beginning of a headline.
960 This may also be a function to test for appropriate locations where speed
961 commands should be active."
969 "Alist of additional speed commands.
970 This list will be checked before `org-speed-commands-default'
971 when the variable `org-use-speed-commands' is non-nil
972 and when the cursor is at the beginning of a headline.
973 The car if each entry is a string with a single letter, which must
974 be assigned to `self-insert-command' in the global map.
975 The cdr is either a command to be called interactively, a function
976 to be called, or a form to be evaluated.
977 An entry that is just a list with a single string will be interpreted
978 as a descriptive headline that will be added when listing the speed
979 commands in the Help buffer using the `?' speed command."
991 "Options concerning visibility cycling in Org-mode."
996 "Non-nil means skip CHILDREN state in entries that don't have any."
1001 "Maximum level which should still be subject to visibility cycling.
1002 Levels higher than this will, for cycling, be treated as text, not a headline.
1003 When `org-odd-levels-only' is set, a value of N in this variable actually
1004 means 2N-1 stars as the limiting headline.
1005 When nil, cycle all levels.
1006 Note that the limiting level of cycling is also influenced by
1007 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1008 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1009 than its value."
1016 "Names of drawers. Drawers are not opened by cycling on the headline above.
1017 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1018 this:
1019 :DRAWERNAME:
1020 .....
1021 :END:
1023 the property API.
1025 Drawers can be defined on the per-file basis with a line like:
1027 #+DRAWERS: HIDDEN STATE PROPERTIES"
1033 "Non-nil means entering Org-mode will fold all blocks.
1034 This can also be set in on a per-file basis with
1036 #+STARTUP: hideblocks
1037 #+STARTUP: showblocks"
1043 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1044 This makes it possible to do global cycling without having to use S-TAB or
1046 of the buffer must not be a headline -- it may be empty or some other text.
1047 When used in this way, `org-cycle-hook' is disabled temporarily to make
1048 sure the cursor stays at the beginning of the buffer. When this option is
1049 nil, don't do anything special at the beginning of the buffer."
1054 "Non-nil means cycle entry level or item indentation in new empty entries.
1056 When the cursor is at the end of an empty headline, i.e., with only stars
1057 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1058 and then all possible ancestor states, before returning to the original state.
1059 This makes data entry extremely fast: M-RET to create a new headline,
1060 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1062 When the cursor is at the end of an empty plain list item, one TAB will
1063 make it a subitem, two or more tabs will back up to make this an item
1064 higher up in the item hierarchy."
1069 "Where should `org-cycle' emulate TAB.
1070 nil Never
1071 white Only in completely white lines
1072 whitestart Only at the beginning of lines, before the first non-white char
1073 t Everywhere except in headlines
1074 exc-hl-bol Everywhere except at the start of a headline
1075 If TAB is used in a place where it does not emulate TAB, the current subtree
1076 visibility is cycled."
1083 ))
1086 "Number of empty lines needed to keep an empty line between collapsed trees.
1087 If you leave an empty line between the end of a subtree and the following
1088 headline, this empty line is hidden when the subtree is folded.
1089 Org-mode will leave (exactly) one empty line visible if the number of
1090 empty lines is equal or larger to the number given in this variable.
1091 So the default 2 means at least 2 empty lines after the end of a subtree
1092 are needed to produce free space between a collapsed subtree and the
1093 following headline.
1095 If the number is negative, and the number of empty lines is at least -N,
1096 all empty lines are shown.
1098 Special case: when 0, never leave empty lines in collapsed view."
1104 "Hook that is run before visibility cycling is happening.
1105 The function(s) in this hook must accept a single argument which indicates
1106 the new state that will be set right after running this hook. The
1107 argument is a symbol. Before a global state change, it can have the values
1108 `overview', `content', or `all'. Before a local state change, it can have
1109 the values `folded', `children', or `subtree'."
1114 org-cycle-hide-drawers
1115 org-cycle-hide-inline-tasks
1116 org-cycle-show-empty-lines
1117 org-optimize-window-after-visibility-change)
1118 "Hook that is run after `org-cycle' has changed the buffer visibility.
1119 The function(s) in this hook must accept a single argument which indicates
1120 the new state that was set by the most recent `org-cycle' command. The
1121 argument is a symbol. After a global state change, it can have the values
1122 `overview', `contents', or `all'. After a local state change, it can have
1123 the values `folded', `children', or `subtree'."
1128 "Options concerning structure editing in Org-mode."
1133 "Non-nil means skip even levels and only use odd levels for the outline.
1134 This has the effect that two stars are being added/taken away in
1135 promotion/demotion commands. It also influences how levels are
1136 handled by the exporters.
1137 Changing it requires restart of `font-lock-mode' to become effective
1138 for fontification also in regions already fontified.
1139 You may also set this on a per-file basis by adding one of the following
1140 lines to the buffer:
1142 #+STARTUP: odd
1143 #+STARTUP: oddeven"
1149 "Non-nil means adapt indentation to outline node level.
1151 When this variable is set, Org assumes that you write outlines by
1152 indenting text in each node to align with the headline (after the stars).
1153 The following issues are influenced by this variable:
1155 - When this is set and the *entire* text in an entry is indented, the
1156 indentation is increased by one space in a demotion command, and
1157 decreased by one in a promotion command. If any line in the entry
1158 body starts with text at column 0, indentation is not changed at all.
1160 - Property drawers and planning information is inserted indented when
1161 this variable s set. When nil, they will not be indented.
1163 - TAB indents a line relative to context. The lines below a headline
1164 will be indented when this variable is set.
1166 Note that this is all about true indentation, by adding and removing
1167 space characters. See also `org-indent.el' which does level-dependent
1168 indentation in a virtual way, i.e. at display time in Emacs."
1173 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1175 When t, `C-a' will bring back the cursor to the beginning of the
1176 headline text, i.e. after the stars and after a possible TODO
1177 keyword. In an item, this will be the position after bullet and
1178 check-box, if any. When the cursor is already at that position,
1179 another `C-a' will bring it to the beginning of the line.
1181 `C-e' will jump to the end of the headline, ignoring the presence
1182 of tags in the headline. A second `C-e' will then jump to the
1183 true end of the line, after any tags. This also means that, when
1184 this variable is non-nil, `C-e' also will never jump beyond the
1185 end of the heading of a folded section, i.e. not after the
1186 ellipses.
1188 When set to the symbol `reversed', the first `C-a' or `C-e' works
1189 normally, going to the true line boundary first. Only a directly
1190 following, identical keypress will bring the cursor to the
1191 special positions.
1193 This may also be a cons cell where the behavior for `C-a' and
1194 `C-e' is set separately."
1213 "Non-nil means `C-k' will behave specially in headlines.
1214 When nil, `C-k' will call the default `kill-line' command.
1215 When t, the following will happen while the cursor is in the headline:
1217 - When the cursor is at the beginning of a headline, kill the entire
1218 line and possible the folded subtree below the line.
1219 - When in the middle of the headline text, kill the headline up to the tags.
1220 - When after the headline text, kill the tags."
1225 "Non-nil means, do not delete a hidden subtree with C-k.
1226 When set to the symbol `error', simply throw an error when C-k is
1227 used to kill (part-of) a headline that has hidden text behind it.
1228 Any other non-nil value will result in a query to the user, if it is
1229 OK to kill that hidden subtree. When nil, kill without remorse."
1238 "Check if in invisible region before inserting or deleting a character.
1239 Valid values are:
1241 nil Do not check, so just do invisible edits.
1242 error Throw an error and do nothing.
1243 show Make point visible, and do the requested edit.
1244 show-and-error Make point visible, then throw an error and abort the edit.
1245 smart Make point visible, and do insertion/deletion if it is
1246 adjacent to visible text and the change feels predictable.
1247 Never delete a previously invisible character or add in the
1248 middle or right after an invisible region. Basically, this
1249 allows insertion and backward-delete right before ellipses.
1250 FIXME: maybe in this case we should not even show?"
1261 "Non-nil means when yanking subtrees, fold them.
1262 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1263 it starts with a heading and all other headings in it are either children
1264 or siblings, then fold all the subtrees. However, do this only if no
1265 text after the yank would be swallowed into a folded tree by this action."
1270 "Non-nil means when yanking subtrees, adjust the level.
1271 With this setting, `org-paste-subtree' is used to insert the subtree, see
1272 this function for details."
1277 "Non-nil means M-RET will split the line at the cursor position.
1278 When nil, it will go to the end of the line before making a
1279 new line.
1280 You may also set this option in a different way for different
1281 contexts. Valid contexts are:
1283 headline when creating a new headline
1284 item when creating a new item
1285 table in a table field
1286 default the value to be used for all contexts not explicitly
1287 customized"
1304 "Non-nil means insert new headings after the current subtree.
1305 When nil, the new heading is created directly after the current line.
1308 for the duration of the command."
1314 "Should `org-insert-heading' leave a blank line before new heading/item?
1315 The value is an alist, with `heading' and `plain-list-item' as CAR,
1316 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1317 which case Org will look at the surrounding headings/items and try to
1318 make an intelligent decision whether to insert a blank line or not.
1320 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1321 set, the setting here is ignored and no empty line is inserted, to avoid
1322 breaking the list structure."
1335 "Hook being run after inserting a new heading."
1341 This currently only means they are never auto-wrapped.
1342 When nil, such lines will be treated like ordinary lines.
1343 See also the QUOTE keyword."
1348 "Non-nil means typing characters in `org-goto' starts incremental search.
1349 When nil, you can use these keybindings to navigate the buffer:
1351 q Quit the org-goto interface
1352 n Go to the next visible heading
1353 p Go to the previous visible heading
1354 f Go one heading forward on same level
1355 b Go one heading backward on same level
1356 u Go one heading up"
1361 "Options concerning sparse trees in Org-mode."
1366 "Non-nil means highlight all matches that define a sparse tree.
1367 The highlights will automatically disappear the next time the buffer is
1368 changed by an edit command."
1373 "Non-nil means any change to the buffer will remove temporary highlights.
1374 Such highlights are created by `org-occur' and `org-clock-display'.
1375 When nil, `C-c C-c needs to be used to get rid of the highlights.
1376 The highlights created by `org-preview-latex-fragment' always need
1377 `C-c C-c' to be removed."
1384 "Hook that is run after `org-occur' has constructed a sparse tree.
1385 This can be used to recenter the window to show as much of the structure
1386 as possible."
1391 "Options concerning imenu and speedbar in Org-mode."
1396 "The maximum level for Imenu access to Org-mode headlines.
1397 This also applied for speedbar access."
1402 "Options concerning tables in Org-mode."
1408 When nil, such lines will be treated like ordinary lines.
1410 When equal to the symbol `optimized', the table editor will be optimized to
1411 do the following:
1412 - Automatic overwrite mode in front of whitespace in table fields.
1413 This makes the structure of the table stay in tact as long as the edited
1414 field does not exceed the column width.
1415 - Minimize the number of realigns. Normally, the table is aligned each time
1416 TAB or RET are pressed to move to another field. With optimization this
1417 happens only if changes to a field might have changed the column width.
1418 Optimization requires replacing the functions `self-insert-command',
1419 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1420 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1421 very good at guessing when a re-align will be necessary, but you can always
1424 If you would like to use the optimized version in Org-mode, but the
1425 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1427 This variable can be used to turn on and off the table editor during a session,
1428 but in order to toggle optimization, a restart is required.
1430 See also the variable `org-table-auto-blank-field'."
1439 "Non-nil means cluster self-insert commands for undo when possible.
1440 If this is set, then, like in the Emacs command loop, 20 consecutive
1441 characters will be undone together.
1442 This is configurable, because there is some impact on typing performance."
1447 "Non-nil means TAB will automatically notice a table.el table.
1448 When it sees such a table, it moves point into it and - if necessary -
1449 calls `table-recognize-table'."
1454 "Options concerning links in Org-mode."
1459 "Buffer-local version of `org-link-abbrev-alist', which see.
1464 "Alist of link abbreviations.
1465 The car of each element is a string, to be replaced at the start of a link.
1467 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1469 [[linkkey:tag][description]]
1471 The 'linkkey' must be a word word, starting with a letter, followed
1472 by letters, numbers, '-' or '_'.
1474 If REPLACE is a string, the tag will simply be appended to create the link.
1477 at that point (see the function `url-hexify-string'). If the string contains
1479 be invoked: this function takes the tag as its only argument and must return
1480 a string.
1482 REPLACE may also be a function that will be called with the tag as the
1483 only argument to create the link, which should be returned as a string.
1485 See the manual for examples."
1495 "Non-nil means Org will display descriptive links.
1496 E.g. [[http://orgmode.org][Org website]] will be displayed as
1498 description. When set to `nil', Org will display the full links
1499 literally.
1501 You can interactively set the value of this variable by calling
1502 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1507 "How the path name in file links should be stored.
1508 Valid values are:
1510 relative Relative to the current directory, i.e. the directory of the file
1511 into which the link is being inserted.
1512 absolute Absolute path, if possible with ~ for home directory.
1513 noabbrev Absolute path, no abbreviation of home directory.
1514 adaptive Use relative path for files in the current directory and sub-
1515 directories of it. For other files, use an absolute path."
1524 "Types of links that should be activated in Org-mode files.
1525 This is a list of symbols, each leading to the activation of a certain link
1526 type. In principle, it does not hurt to turn on most link types - there may
1527 be a small gain when turning off unused link types. The types are:
1529 bracket The recommended [[link][description]] or [[link]] links with hiding.
1530 angle Links in angular brackets that may contain whitespace like
1531 <bbdb:Carsten Dominik>.
1532 plain Plain links in normal text, no whitespace, like http://google.com.
1533 radio Text that is matched by a radio target, see manual for details.
1534 tag Tag settings in a headline (link to tag search).
1535 date Time stamps (link to calendar).
1536 footnote Footnote labels.
1538 Changing this variable requires a restart of Emacs to become effective."
1550 "Function to use for generating link descriptions from links.
1551 When nil, the link location will be used. This function must take
1552 two parameters: the first one is the link, the second one is the
1553 description generated by `org-insert-link'. The function should
1554 return the description to use."
1559 "Options concerning storing links in Org-mode."
1564 "When non-nil, hexify URL when creating a link."
1570 "Format of the description part of a link to an email or usenet message.
1571 The following %-escapes will be replaced by corresponding information:
1579 %s subject
1580 %d date
1581 %m message-id.
1583 You may use normal field width specification between the % and the letter.
1584 This is for example useful to limit the length of the subject.
1598 It should match if the message is from the user him/herself."
1603 "Non-nil means file links from `org-store-link' contain context.
1604 A search string will be added to the file name with :: as separator and
1605 used to find the context when the link is activated by the command
1606 `org-open-at-point'. When this option is t, the entire active region
1607 will be placed in the search string of the file link. If set to a
1608 positive integer, only the first n lines of context will be stored.
1611 negates this setting for the duration of the command."
1616 "Non-nil means keep link in list for entire session.
1618 The command `org-store-link' adds a link pointing to the current
1619 location to an internal list. These links accumulate during a session.
1620 The command `org-insert-link' can be used to insert links into any
1621 Org-mode file (offering completion for all stored links). When this
1623 will be removed from the list, to make completing the unused links
1624 more efficient."
1629 "Options concerning following links in Org-mode."
1634 "Function to translate links with different syntax to Org syntax.
1635 This can be used to translate links created for example by the Planner
1636 or emacs-wiki packages to Org syntax.
1637 The function must accept two parameters, a TYPE containing the link
1639 which is everything after the link protocol. It should return a cons
1640 with possibly modified values of type and path.
1641 Org contains a function for this, so if you set this variable to
1642 `org-translate-link-from-planner', you should be able follow many
1643 links created by planner."
1648 "Hook that is run after a link has been followed."
1653 "Non-nil means on links TAB will follow the link.
1654 Needs to be set before org.el is loaded.
1655 This really should not be used, it does not make sense, and the
1656 implementation is bad."
1661 "Non-nil means on links RET will follow the link.
1662 In tables, the special behavior of RET has precedence."
1668 "Non-nil means mouse-1 on a link will follow the link.
1669 A longer mouse click will still set point. Does not work on XEmacs.
1670 Needs to be set before org.el is loaded."
1675 "Number of different positions to be recorded in the ring.
1676 Changing this requires a restart of Emacs to work correctly."
1681 "Non-nil means internal links in Org files must exactly match a headline.
1682 When nil, the link search tries to match a phrase with all words
1683 in the search text."
1690 query-to-create)))
1698 "Setup the frame configuration for following links.
1699 When following a link with Emacs, it may often be useful to display
1700 this link in another window or frame. This variable can be used to
1701 set this up for the different types of links.
1702 For VM, use any of
1703 `vm-visit-folder'
1704 `vm-visit-folder-other-window'
1705 `vm-visit-folder-other-frame'
1706 For Gnus, use any of
1707 `gnus'
1708 `gnus-other-frame'
1709 `org-gnus-no-new-news'
1710 For FILE, use any of
1711 `find-file'
1712 `find-file-other-window'
1713 `find-file-other-frame'
1714 For Wanderlust use any of
1715 `wl'
1716 `wl-other-frame'
1717 For the calendar, use the variable `calendar-setup'.
1718 For BBDB, it is currently only possible to display the matches in
1719 another window."
1743 "Non-nil means use indirect buffer to display infile links.
1744 Activating internal links (from one location in a file to another location
1745 in the same file) normally just jumps to the location. When the link is
1747 is displayed in
1748 another window. When this option is set, the other window actually displays
1749 an indirect buffer clone of the current buffer, to avoid any visibility
1750 changes to the current buffer."
1755 "Non-nil means `org-open-file' will open non-existing files.
1756 When nil, an error will be generated.
1757 This variable applies only to external applications because they
1758 might choke on non-existing files. If the link is to a file that
1759 will be opened in Emacs, the variable is ignored."
1764 "Non-nil means a link to a directory really means to index.org.
1765 When nil, following a directory link will run dired or open a finder/explorer
1766 window on that directory."
1771 "Function and arguments to call for following mailto links.
1772 This is a list with the first element being a Lisp function, and the
1773 remaining elements being arguments to the function. In string arguments,
1774 %a will be replaced by the address, and %s will be replaced by the subject
1775 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1784 "Non-nil means ask for confirmation before executing shell links.
1785 Shell links can be dangerous: just think about a link
1787 [[shell:rm -rf ~/*][Google Search]]
1790 but really it would remove your entire home directory.
1791 Therefore we advise against setting this variable to nil.
1792 Just change it to `y-or-n-p' if you want to confirm with a
1800 'safe-local-variable
1804 "A regexp to skip confirmation for shell links."
1810 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1811 Elisp links can be dangerous: just think about a link
1816 but really it would remove your entire home directory.
1817 Therefore we advise against setting this variable to nil.
1818 Just change it to `y-or-n-p' if you want to confirm with a
1826 'safe-local-variable
1830 "A regexp to skip confirmation for Elisp links."
1839 "Default file applications on a UNIX or GNU/Linux system.
1850 "Default file applications on a MacOS X system.
1852 for some files for which the OS does not have a good default.
1860 'mswindows-shell-execute
1865 'mswindows-shell-execute
1868 "Default file applications on a Windows NT system.
1873 '(
1878 )
1879 "External applications for opening `file:path' items in a document.
1880 Org-mode uses system defaults for different file types, but
1881 you can use this variable to set the application for a given file
1882 extension. The entries in this list are cons cells where the car identifies
1883 files and the cdr the corresponding command. Possible values for the
1884 file identifier are
1886 ways, depending on its contents:
1888 - Alphanumeric characters only:
1889 Match links with this file extension.
1891 to open PDFs with evince.
1893 - Regular expression: Match links where the
1894 filename matches the regexp. If you want to
1895 use groups here, use shy groups.
1899 to open *.html and *.xhtml with firefox.
1901 - Regular expression which contains (non-shy) groups:
1903 anything after that, matches the regexp.
1904 In a custom command string, %1, %2, etc. are replaced with
1905 the parts of the link that were matched by the groups.
1906 For backwards compatibility, if a command string is given
1907 that does not use any of the group matches, this case is
1908 handled identically to the second one (i.e. match against
1909 file name only).
1910 In a custom lisp form, you can access the group matches with
1911 (match-string n link).
1914 to open [[file:document.pdf::5]] with evince at page 5.
1916 `directory' Matches a directory
1917 `remote' Matches a remote file, accessible through tramp or efs.
1918 Remote files most likely should be visited through Emacs
1919 because external applications cannot handle such paths.
1920 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1921 so all files Emacs knows how to handle. Using this with
1922 command `emacs' will open most files in Emacs. Beware that this
1923 will also open html files inside Emacs, unless you add
1925 t Default for files not matched by any of the other options.
1926 `system' The system command to open files, like `open' on Windows
1927 and Mac OS X, and mailcap under GNU/Linux. This is the command
1928 that will be selected if you call `C-c C-o' with a double
1931 Possible values for the command are:
1932 `emacs' The file will be visited by the current Emacs process.
1933 `default' Use the default application for this file type, which is the
1934 association for t in the list, most likely in the system-specific
1935 part.
1936 This can be used to overrule an unwanted setting in the
1937 system-specific variable.
1939 This command is specified by the entry whose car is `system'.
1940 Most likely, the system-specific version of this variable
1941 does define this command, but you can overrule/replace it
1942 here.
1943 string A command to be executed by a shell; %s will be replaced
1944 by the path to the file.
1945 sexp A Lisp form which will be evaluated. The file path will
1946 be available in the Lisp variable `file'.
1947 For more examples, see the system specific constants
1948 `org-file-apps-defaults-macosx'
1949 `org-file-apps-defaults-windowsnt'
1950 `org-file-apps-defaults-gnu'."
1960 auto-mode))
1969 "The URL of the DOI server."
1975 "Options concerning refiling entries in Org-mode."
1980 "Directory with org files.
1981 This is just a default location to look for Org files. There is no need
1982 at all to put your files into this directory. It is only used in the
1983 following situations:
1985 1. When a capture template specifies a target file that is not an
1986 absolute path. The path will then be interpreted relative to
1987 `org-directory'
1988 2. When a capture note is filed away in an interactive way (when exiting the
1989 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1990 with `org-directory' as the default path."
1997 "Default target for storing notes.
1998 Used as a fall back file for org-remember.el and org-capture.el, for
1999 templates that do not specify a target file."
2005 file))
2008 "The default interface to be used for `org-goto'.
2009 Allowed values are:
2010 outline The interface shows an outline of the relevant file
2011 and the correct heading is found by moving through
2012 the outline or by searching with incremental search.
2013 outline-path-completion Headlines in the current buffer are offered via
2014 completion. This is the interface also used by
2015 the refile command."
2022 "Maximum target level when running `org-goto' with refile interface."
2027 "Non-nil means store new notes at the beginning of a file or entry.
2028 When nil, new notes will be filed to the end of a file or entry.
2029 This can also be a list with cons cells of regular expressions that
2030 are matched against file names, and values."
2041 "Information to record when a task is refiled.
2043 Possible values are:
2045 nil Don't add anything
2046 time Add a time stamp to the task
2047 note Prompt for a note and add it with template `org-log-note-headings'
2049 This option can also be set with on a per-file-basis with
2051 #+STARTUP: nologrefile
2052 #+STARTUP: logrefile
2053 #+STARTUP: lognoterefile
2055 You can have local logging settings for a subtree by setting the LOGGING
2056 property to one or more of these keywords.
2058 When bulk-refiling from the agenda, the value `note' is forbidden and
2059 will temporarily be changed to `time'."
2070 This is a list of cons cells. Each cell contains:
2071 - a specification of the files to be considered, either a list of files,
2072 or a symbol whose function or variable value will be used to retrieve
2073 a file name or a list of file names. If you use `org-agenda-files' for
2074 that, all agenda files will be scanned for targets. Nil means consider
2075 headings in the current buffer.
2076 - A specification of how to find candidate refile targets. This may be
2077 any of:
2079 This tag has to be present in all target headlines, inheritance will
2080 not be considered.
2082 todo keyword.
2084 headlines that are refiling targets.
2085 - a cons cell (:level . N). Any headline of level N is considered a target.
2086 Note that, when `org-odd-levels-only' is set, level corresponds to
2087 order in hierarchy, not to the number of stars.
2088 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2089 Note that, when `org-odd-levels-only' is set, level corresponds to
2090 order in hierarchy, not to the number of stars.
2092 Each element of this list generates a set of possible targets.
2093 The union of these sets is presented (with completion) to
2094 the user by `org-refile'.
2096 You can set the variable `org-refile-target-verify-function' to a function
2097 to verify each headline found by the simple criteria above.
2099 When this variable is nil, all top-level headlines in the current buffer
2100 are used, equivalent to the value `((nil . (:level . 1))'."
2116 "Function to verify if the headline at point should be a refile target.
2117 The function will be called without arguments, with point at the
2118 beginning of the headline. It should return t and leave point
2119 where it is if the headline is a valid target for refiling.
2121 If the target should not be selected, the function must return nil.
2122 In addition to this, it may move point to a place from where the search
2123 should be continued. For example, the function may decide that the entire
2124 subtree of the current entry should be excluded and move point to the end
2125 of the subtree."
2130 "Non-nil means cache refile targets to speed up the process.
2131 The cache for a particular file will be updated automatically when
2132 the buffer has been killed, or when any of the marker used for flagging
2133 refile targets no longer points at a live buffer.
2134 If you have added new entries to a buffer that might themselves be targets,
2135 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2136 find that easier, `C-u C-u C-u C-c C-w'."
2142 "Non-nil means provide refile targets as paths.
2143 So a level 3 headline will be available as level1/level2/level3.
2145 When the value is `file', also include the file name (without directory)
2146 into the path. In this case, you can also stop the completion after
2147 the file name, to get entries inserted as top level in the file.
2149 When `full-file-path', include the full file path."
2158 "Non-nil means complete the outline path in hierarchical steps.
2159 When Org-mode uses the refile interface to select an outline path
2160 \(see variable `org-refile-use-outline-path'), the completion of
2161 the path can be done is a single go, or if can be done in steps down
2162 the headline hierarchy. Going in steps is probably the best if you
2163 do not use a special completion package like `ido' or `icicles'.
2164 However, when using these packages, going in one step can be very
2165 fast, while still showing the whole path to the entry."
2170 "Non-nil means allow to create new nodes as refile targets.
2172 of an existing node. When the value of this variable is `confirm',
2173 new node creation must be confirmed by the user (recommended)
2174 When nil, the completion must match an existing entry.
2176 Note that, if the new heading is not seen by the criteria
2177 listed in `org-refile-targets', multiple instances of the same
2178 heading would be created by trying again to file under the new
2179 heading."
2187 "Non-nil means also refile active region within a subtree.
2189 By default `org-refile' doesn't allow refiling regions if they
2190 don't contain a set of subtrees, but it might be convenient to
2191 do so sometimes: in that case, the first line of the region is
2192 converted to a headline before refiling."
2198 "Options concerning TODO items in Org-mode."
2203 "Options concerning Progress logging in Org-mode."
2210 "The available interpretation symbols for customizing `org-todo-keywords'.
2214 "List of TODO entry keyword sequences and their interpretation.
2217 Each sequence starts with a symbol, either `sequence' or `type',
2218 indicating if the keywords should be interpreted as a sequence of
2219 action steps, or as different types of TODO items. The first
2220 keywords are states requiring action - these states will select a headline
2221 for inclusion into the global TODO list Org-mode produces. If one of
2224 the last keyword is treated as the only DONE state of the sequence.
2227 additional state where no keyword is present. For details about this
2228 cycling, see the manual.
2230 TODO keywords and interpretation can also be set on a per-file basis with
2231 the special #+SEQ_TODO and #+TYP_TODO lines.
2233 Each keyword can optionally specify a character for fast state selection
2234 \(in combination with the variable `org-use-fast-todo-selection')
2235 and specifiers for state change logging, using the same syntax that
2238 indicates to record a time stamp each time this state is selected.
2240 Each keyword may also specify if a timestamp or a note should be
2241 recorded when entering or leaving the state, by adding additional
2242 characters in the parenthesis after the keyword. This looks like this:
2244 record only the time of the state change. With X and Y being either
2246 Y when leaving the state if and only if the *target* state does not
2247 define X. You may omit any of the fast-selection key or X or /Y,
2248 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2250 For backward compatibility, this variable may also be just a list
2251 of keywords. In this case the interpretation (sequence or type) will be
2252 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2262 ;;Quick and dirty way to see
2263 ;;`org-todo-interpretations'. This takes the
2264 ;;place of item arguments
2265 :convert-widget
2272 org-todo-interpretation-widgets))
2273 widget))
2304 "Controls how TODO keywords are interpreted.
2305 This variable is in principle obsolete and is only used for
2306 backward compatibility, if the interpretation of todo keywords is
2307 not given already in `org-todo-keywords'. See that variable for
2308 more information."
2315 "Non-nil means use the fast todo selection scheme with C-c C-t.
2316 This variable describes if and under what circumstances the cycling
2317 mechanism for TODO keywords will be replaced by a single-key, direct
2318 selection scheme.
2320 When nil, fast selection is never used.
2322 When the symbol `prefix', it will be used when `org-todo' is called
2323 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2324 `C-u t' in an agenda buffer.
2326 When t, fast selection is used by default. In this case, the prefix
2327 argument forces cycling instead.
2329 In all cases, the special interface is only used if access keys have
2330 actually been assigned by the user, i.e. if keywords in the configuration
2331 are followed by a letter in parenthesis, like TODO(t)."
2339 "Non-nil means update todo statistics after insert and toggle.
2340 ALL-HEADLINES means update todo statistics by including headlines
2341 with no TODO keyword as well, counting them as not done.
2342 A list of TODO keywords means the same, but skip keywords that are
2343 not in this list.
2345 When this is set, todo statistics is updated in the parent of the
2346 current entry each time a todo state is changed."
2356 "Non-nil means TODO statistics covers just direct children.
2357 When nil, all entries in the subtree are considered.
2358 This has only an effect if `org-provide-todo-statistics' is set.
2359 To set this to nil for only a single subtree, use a COOKIE_DATA
2365 "Hook which is run after the state of a TODO item was changed.
2366 The new state (a string with a TODO keyword, or nil) is available in the
2367 Lisp variable `org-state'."
2372 "Hook for functions that are allowed to block a state change.
2374 Functions in this hook should not modify the buffer.
2375 Each function gets as its single argument a property list,
2376 see `org-trigger-hook' for more information about this list.
2378 If any of the functions in this hook returns nil, the state change
2382 "Hook for functions that are triggered by a state change.
2384 Each function gets as its single argument a property list with at
2385 least the following elements:
2387 (:type type-of-change :position pos-at-entry-start
2388 :from old-state :to new-state)
2390 Depending on the type, more properties may be present.
2392 This mechanism is currently implemented for:
2394 TODO state changes
2395 ------------------
2396 :type todo-state-change
2397 :from previous state (keyword as a string), or nil, or a symbol
2398 'todo' or 'done', to indicate the general type of state.
2402 "Non-nil means undone TODO entries will block switching the parent to DONE.
2403 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2404 be blocked if any prior sibling is not yet done.
2405 Finally, if the parent is blocked because of ordered siblings of its own,
2406 the child will also be blocked."
2418 "Non-nil means unchecked boxes will block switching the parent to DONE.
2419 When this is nil, checkboxes have no influence on switching TODO states.
2420 When non-nil, you first need to check off all check boxes before the TODO
2421 entry can be switched to DONE.
2422 This variable needs to be set before org.el is loaded, and you need to
2423 restart Emacs after a change to make the change effective. The only way
2424 to change is while Emacs is running is through the customize interface."
2436 "Non-nil means inserting a TODO heading is treated as state change.
2438 logging will apply if appropriate. When nil, the new TODO item will
2439 be inserted directly, and no logging will take place."
2444 "Non-nil means switching TODO states with S-cursor counts as state change.
2445 This is the default behavior. However, setting this to nil allows a
2446 convenient way to select a TODO state and bypass any logging associated
2447 with that."
2452 "Tag changes that should be triggered by TODO state changes.
2453 This is a list. Each entry is
2455 (state-change (tag . flag) .......)
2457 State-change can be a string with a state, and empty string to indicate the
2458 state that has no TODO keyword, or it can be one of the symbols `todo'
2459 or `done', meaning any not-done or done state, respectively."
2473 "Information to record when a task moves to the DONE state.
2475 Possible values are:
2477 nil Don't add anything, just change the keyword
2478 time Add a time stamp to the task
2479 note Prompt for a note and add it with template `org-log-note-headings'
2481 This option can also be set with on a per-file-basis with
2483 #+STARTUP: nologdone
2484 #+STARTUP: logdone
2485 #+STARTUP: lognotedone
2487 You can have local logging settings for a subtree by setting the LOGGING
2488 property to one or more of these keywords."
2496 ;; Normalize old uses of org-log-done.
2503 "Information to record when the scheduling date of a tasks is modified.
2505 Possible values are:
2507 nil Don't add anything, just change the date
2508 time Add a time stamp to the task
2509 note Prompt for a note and add it with template `org-log-note-headings'
2511 This option can also be set with on a per-file-basis with
2513 #+STARTUP: nologreschedule
2514 #+STARTUP: logreschedule
2515 #+STARTUP: lognotereschedule"
2524 "Information to record when the deadline date of a tasks is modified.
2526 Possible values are:
2528 nil Don't add anything, just change the date
2529 time Add a time stamp to the task
2530 note Prompt for a note and add it with template `org-log-note-headings'
2532 This option can also be set with on a per-file-basis with
2534 #+STARTUP: nologredeadline
2535 #+STARTUP: logredeadline
2536 #+STARTUP: lognoteredeadline
2538 You can have local logging settings for a subtree by setting the LOGGING
2539 property to one or more of these keywords."
2548 "Non-nil means record a note when clocking out of an item.
2549 This can also be configured on a per-file basis by adding one of
2550 the following lines anywhere in the buffer:
2552 #+STARTUP: lognoteclock-out
2553 #+STARTUP: nolognoteclock-out"
2559 "Non-nil means the CLOSED time stamp will contain date and time.
2560 When nil, only the date will be recorded."
2574 "Headings for notes added to entries.
2575 The value is an alist, with the car being a symbol indicating the note
2576 context, and the cdr is the heading to be used. The heading may also be the
2577 empty string.
2578 %t in the heading will be replaced by a time stamp.
2579 %T will be an active time stamp instead the default inactive one
2580 %d will be replaced by a short-format time stamp.
2581 %D will be replaced by an active short-format time stamp.
2582 %s will be replaced by the new TODO state, in double quotes.
2583 %S will be replaced by the old TODO state, in double quotes.
2584 %u will be replaced by the user name.
2585 %U will be replaced by the full user name.
2587 In fact, it is not a good idea to change the `state' entry, because
2588 agenda log mode depends on the format of these entries."
2594 "Heading when changing todo state (todo sequence only)"
2608 "Non-nil means insert state change notes and time stamps into a drawer.
2609 When nil, state changes notes will be inserted after the headline and
2610 any scheduling and clock lines, but not inside a drawer.
2612 The value of this variable should be the name of the drawer to use.
2613 LOGBOOK is proposed as the default drawer for this purpose, you can
2614 also set this to a string to define the drawer of your choice.
2618 A value of t or nil can also be set with on a per-file-basis with
2620 #+STARTUP: logdrawer
2621 #+STARTUP: nologdrawer
2623 If this variable is set, `org-log-state-notes-insert-after-drawers'
2624 will be ignored.
2626 You can set the property LOG_INTO_DRAWER to overrule this setting for
2627 a subtree."
2639 "Return the value of `org-log-into-drawer', but let properties overrule.
2640 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2641 used instead of the default value."
2650 "Non-nil means insert state change notes after any drawers in entry.
2651 Only the drawers that *immediately* follow the headline and the
2652 deadline/scheduled line are skipped.
2653 When nil, insert notes right after the heading and perhaps the line
2654 with deadline/scheduling if present.
2656 This variable will have no effect if `org-log-into-drawer' is
2657 set."
2663 "Non-nil means the latest state note will be directly after heading.
2664 When nil, the state change notes will be ordered according to time.
2666 This option can also be set with on a per-file-basis with
2668 #+STARTUP: logstatesreversed
2669 #+STARTUP: nologstatesreversed"
2675 "The TODO state to which a repeater should return the repeating task.
2676 By default this is the first task in a TODO sequence, or the previous state
2677 in a TODO_TYP set. But you can specify another task here.
2678 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2685 "Non-nil means record moving through the DONE state when triggering repeat.
2686 An auto-repeating task is immediately switched back to TODO when
2689 record a closing note, there will be no record of the task moving
2690 through DONE. This variable forces taking a note anyway.
2692 nil Don't force a record
2693 time Record a time stamp
2694 note Prompt for a note and add it with template `org-log-note-headings'
2696 This option can also be set with on a per-file-basis with
2698 #+STARTUP: nologrepeat
2699 #+STARTUP: logrepeat
2700 #+STARTUP: lognoterepeat
2702 You can have local logging settings for a subtree by setting the LOGGING
2703 property to one or more of these keywords."
2713 "Priorities in Org-mode."
2718 "Non-nil means priority commands are active.
2719 When nil, these commands will be disabled, so that you never accidentally
2720 set a priority."
2725 "The highest priority of TODO items. A character like ?A, ?B etc.
2726 Must have a smaller ASCII number than `org-lowest-priority'."
2731 "The lowest priority of TODO items. A character like ?A, ?B etc.
2732 Must have a larger ASCII number than `org-highest-priority'."
2737 "The default priority of TODO items.
2738 This is the priority an item gets if no explicit priority is given.
2739 When starting to cycle on an empty priority the first step in the cycle
2740 depends on `org-priority-start-cycle-with-default'. The resulting first
2741 step priority must not exceed the range from `org-highest-priority' to
2742 `org-lowest-priority' which means that `org-default-priority' has to be
2743 in this range exclusive or inclusive the range boundaries. Else the
2744 first step refuses to set the default and the second will fall back
2745 to (depending on the command used) the highest or lowest priority."
2750 "Non-nil means start with default priority when starting to cycle.
2751 When this is nil, the first step in the cycle will be (depending on the
2752 command used) one higher or lower than the default priority.
2753 See also `org-default-priority'."
2758 "Function to extract the priority from a string.
2759 The string is normally the headline. If this is nil Org computes the
2760 priority from the priority cookie like [#A] in the headline. It returns
2761 an integer, increasing by 1000 for each priority level.
2762 The user can set a different function here, which should take a string
2763 as an argument and return the numeric priority."
2769 "Options concerning time stamps and deadlines in Org-mode."
2774 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2775 When nil, these labeled time stamps are forces into the second line of an
2776 entry, just after the headline. When scheduling from the global TODO list,
2777 the time stamp will always be forced into the second line."
2782 "Formats for `format-time-string' which are used for time stamps.
2786 "Number of minutes to round time stamps to.
2787 These are two values, the first applies when first creating a time stamp.
2788 The second applies when changing it with the commands `S-up' and `S-down'.
2789 When changing the time stamp, this means that it will change in steps
2790 of N minutes, as given by the second value.
2792 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2793 numbers should be factors of 60, so for example 5, 10, 15.
2795 When this is larger than 1, you can still force an exact time stamp by using
2796 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2797 and by using a prefix arg to `S-up/down' to specify the exact number
2798 of minutes to shift."
2808 ;; Normalize old customizations of this variable.
2812 org-time-stamp-rounding-minutes)))
2815 "Non-nil means overlay custom formats over all time stamps.
2816 The formats are defined through the variable `org-time-stamp-custom-formats'.
2817 To turn this on on a per-file basis, insert anywhere in the file:
2818 #+STARTUP: customtime"
2826 "Custom formats for time stamps. See `format-time-string' for the syntax.
2827 These are overlaid over the default ISO format if the variable
2828 `org-display-custom-times' is set. Time like %H:%M should be at the
2829 end of the second format. The custom formats are also honored by export
2830 commands, if custom time display is turned on at the time of export."
2835 "Get the right format for a time string."
2840 f)))
2844 "The format string used when creating CLOCKSUM lines.
2845 This is also used when Org mode generates a time duration.
2847 The value can be a single format string containing two
2848 %-sequences, which will be filled with the number of hours and
2849 minutes in that order.
2851 Alternatively, the value can be a plist associating any of the
2852 keys :years, :months, :weeks, :days, :hours or :minutes with
2853 format strings. The time duration is formatted using only the
2854 time components that are needed and concatenating the results.
2855 If a time unit in absent, it falls back to the next smallest
2856 unit.
2858 The keys :require-years, :require-months, :require-days,
2859 :require-weeks, :require-hours, :require-minutes are also
2860 meaningful. A non-nil value for these keys indicates that the
2861 corresponding time component should always be included, even if
2862 its value is 0.
2865 For example,
2868 :require-minutes t)
2870 means durations longer than a day will be expressed in days,
2871 hours and minutes, and durations less than a day will always be
2872 expressed in hours and minutes (even for durations less than an
2873 hour).
2875 The value
2879 means durations longer than a day will be expressed in days and
2880 minutes, and durations less than a day will be expressed entirely
2881 in minutes (even for durations longer than an hour)."
2920 See `org-time-clocksum-format' for more on time clock formats."
2928 E.g. by default, one day is considered to be a 8 hours effort,
2929 so a task that has been clocked for 16 hours will be displayed
2930 as during 2 days in the clock display or in the clocktable.
2932 See `org-effort-durations' on how to set effort durations
2933 and `org-time-clocksum-format' for more on time clock formats."
2940 "The format string used when creating CLOCKSUM lines,
2941 or when Org mode generates a time duration, if
2942 `org-time-clocksum-use-fractional' is enabled.
2944 The value can be a single format string containing one
2945 %-sequence, which will be filled with the number of hours as
2946 a float.
2948 Alternatively, the value can be a plist associating any of the
2949 keys :years, :months, :weeks, :days, :hours or :minutes with
2950 a format string. The time duration is formatted using the
2951 largest time unit which gives a non-zero integer part. If all
2952 specified formats have zero integer part, the smallest time unit
2953 is used."
2970 "Number of days before expiration during which a deadline becomes active.
2971 This variable governs the display in sparse trees and in the agenda.
2972 When 0 or negative, it means use this number (the absolute value of it)
2973 even if a deadline has a different individual lead time specified.
2975 Custom commands can set this variable in the options section."
2981 "Number of days before a scheduled item becomes active.
2982 This variable governs the display in sparse trees and in the agenda.
2983 The default value (i.e. 0) means: don't delay scheduled item.
2984 When negative, it means use this number (the absolute value of it)
2985 even if a scheduled item has a different individual delay time
2986 specified.
2988 Custom commands can set this variable in the options section."
2995 "Non-nil means assume future for incomplete date input from user.
2996 This affects the following situations:
2997 1. The user gives a month but not a year.
3000 2. The user gives a day, but no month.
3003 it will be considered as *this* month.
3005 If you set this variable to the symbol `time', then also the following
3006 will work:
3008 3. If the user gives a time.
3009 If the time is before now, it will be interpreted as tomorrow.
3011 Currently none of this works for ISO week specifications.
3013 When this option is nil, the current day, month and year will always be
3014 used as defaults.
3016 See also `org-agenda-jump-prefer-future'."
3024 "Should the agenda jump command prefer the future for incomplete dates?
3025 The default is to do the same as configured in `org-read-date-prefer-future'.
3026 But you can also set a deviating value here.
3027 This may t or nil, or the symbol `org-read-date-prefer-future'."
3033 org-read-date-prefer-future)
3038 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3040 Depending on the system Emacs is running on, certain dates cannot
3041 be represented with the type used internally to represent time.
3042 Dates between 1970-1-1 and 2038-1-1 can always be represented
3043 correctly. Some systems allow for earlier dates, some for later,
3044 some for both. One way to find out it to insert any date into an
3045 Org buffer, putting the cursor on the year and hitting S-up and
3046 S-down to test the range.
3048 When this variable is set to t, the date/time prompt will not let
3049 you specify dates outside the 1970-2037 range, so it is certain that
3050 these dates will work in whatever version of Emacs you are
3051 running, and also that you can move a file from one Emacs implementation
3052 to another. WHenever Org is forcing the year for you, it will display
3053 a message and beep.
3055 When this variable is nil, Org will check if the date is
3056 representable in the specific Emacs implementation you are using.
3057 If not, it will force a year, usually the current year, and beep
3058 to remind you. Currently this setting is not recommended because
3059 the likelihood that you will open your Org files in an Emacs that
3060 has limited date range is not negligible.
3062 A workaround for this problem is to use diary sexp dates for time
3063 stamps outside of this range."
3069 "Non-nil means display current interpretation of date prompt live.
3070 This display will be in an overlay, in the minibuffer."
3075 "Non-nil means pop up a calendar when prompting for a date.
3076 In the calendar, the date can be selected with mouse-1. However, the
3077 minibuffer will also be active, and you can simply enter the date as well.
3078 When nil, only the minibuffer will be available."
3086 'org-read-date-minibuffer-setup-hook
3089 "Hook to be used to set up keys for the date/time interface.
3090 Add key definitions to `minibuffer-local-map', which will be a
3091 temporary copy.
3093 WARNING: This option is obsolete, you should use
3094 `org-read-date-minibuffer-local-map' to set up keys."
3099 "The hour when your day really ends. Must be an integer.
3100 This has influence for the following applications:
3102 the time given here, the day recognized as TODAY is actually yesterday.
3103 - When a date is read from the user and it is still before the time given
3104 here, the current date and time will be assumed to be yesterday, 23:59.
3105 Also, timestamps inserted in capture templates follow this rule.
3107 IMPORTANT: This is a feature whose implementation is and likely will
3108 remain incomplete. Really, it is only here because past midnight seems to
3109 be the favorite working time of John Wiegley :-)"
3114 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3115 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3117 23:59 of the previous day."
3123 "When non-nil, use the last clock out time for `org-todo'.
3124 Note that this option has precedence over the combined use of
3125 `org-use-effective-time' and `org-extend-today-until'."
3127 ;; :version "24.3"
3131 "Non-nil means S-down will increase the time in a time stamp.
3132 When nil, S-up will increase."
3137 "Non-nil means make the calendar window follow timestamp changes.
3138 When a timestamp is modified and the calendar window is visible, it will be
3139 moved to the new date."
3144 "Options concerning tags in Org-mode."
3149 "List of tags allowed in Org-mode files.
3150 When this list is nil, Org-mode will base TAG input on what is already in the
3151 buffer.
3152 The value of this variable is an alist, the car of each entry must be a
3153 keyword as a string, the cdr may be a character that is used to select
3154 that tag through the fast-tag-selection interface.
3155 See the manual for details."
3170 "List of tags that will always appear in all Org-mode files.
3171 This is in addition to any in buffer settings or customizations
3172 of `org-tag-alist'.
3173 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3174 The value of this variable is an alist, the car of each entry must be a
3175 keyword as a string, the cdr may be a character that is used to select
3176 that tag through the fast-tag-selection interface.
3177 See the manual for details.
3178 To disable these tags on a per-file basis, insert anywhere in the file:
3179 #+STARTUP: noptag"
3190 "If non-nil, always offer completion for all tags of all agenda files.
3191 Instead of customizing this variable directly, you might want to
3192 set it locally for capture buffers, because there no list of
3193 tags in that file can be created dynamically (there are none).
3195 (add-hook 'org-capture-mode-hook
3196 (lambda ()
3197 (set (make-local-variable
3198 'org-complete-tags-always-offer-all-agenda-tags)
3199 t)))"
3205 "List of tags that can be inherited by all entries in the file.
3206 The tags will be inherited if the variable `org-use-tag-inheritance'
3207 says they should be.
3211 "Non-nil means use fast tag selection scheme.
3212 This is a special interface to select and deselect tags with single keys.
3213 When nil, fast selection is never used.
3214 When the symbol `auto', fast selection is used if and only if selection
3215 characters for tags have been configured, either through the variable
3216 `org-tag-alist' or through a #+TAGS line in the buffer.
3217 When t, fast selection is always used and selection keys are assigned
3218 automatically if necessary."
3226 "Non-nil means fast tag selection exits after first change.
3227 When nil, you have to press RET to exit it.
3228 During fast tag selection, you can toggle this flag with `C-c'.
3229 This variable can also have the value `expert'. In this case, the window
3230 displaying the tags menu is not even shown, until you press C-c again."
3238 "Non-nil means fast tags selection interface will also offer TODO states.
3242 "The column to which tags should be indented in a headline.
3243 If this number is positive, it specifies the column. If it is negative,
3244 it means that the tags should be flushright to that column. For example,
3245 -80 works well for a normal 80 character screen.
3246 When 0, place tags directly after headline text, with only one space in
3247 between."
3252 "Non-nil keeps tags aligned when modifying headlines.
3253 Some operations (i.e. demoting) change the length of a headline and
3254 therefore shift the tags around. With this option turned on, after
3255 each such operation the tags are again aligned to `org-tags-column'."
3260 "Non-nil means tags in levels apply also for sublevels.
3261 When nil, only the tags directly given in a specific line apply there.
3262 This may also be a list of tags that should be inherited, or a regexp that
3263 matches tags that should be inherited. Additional control is possible
3264 with the variable `org-tags-exclude-from-inheritance' which gives an
3265 explicit list of tags to be excluded from inheritance, even if the value of
3266 `org-use-tag-inheritance' would select it for inheritance.
3268 If this option is t, a match early-on in a tree can lead to a large
3269 number of matches in the subtree when constructing the agenda or creating
3270 a sparse tree. If you only want to see the first match in a tree during
3271 a search, check out the variable `org-tags-match-list-sublevels'."
3280 "List of tags that should never be inherited.
3281 This is a way to exclude a few tags from inheritance. For way to do
3282 the opposite, to actively allow inheritance for selected tags,
3283 see the variable `org-use-tag-inheritance'."
3288 "Check if TAG is one that should be inherited."
3300 "Non-nil means list also sublevels of headlines matching a search.
3301 This variable applies to tags/property searches, and also to stuck
3302 projects because this search is based on a tags match as well.
3304 When set to the symbol `indented', sublevels are indented with
3305 leading dots.
3307 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3308 the sublevels of a headline matching a tag search often also match
3309 the same search. Listing all of them can create very long lists.
3310 Setting this variable to nil causes subtrees of a match to be skipped.
3312 This variable is semi-obsolete and probably should always be true. It
3313 is better to limit inheritance to certain tags using the variables
3314 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3322 "When set, tags are sorted using this function as a comparator."
3338 "Options concerning properties in Org-mode."
3343 "How property key/value pairs should be formatted by `indent-line'.
3344 When `indent-line' hits a property definition, it will format the line
3345 according to this format, mainly to make sure that the values are
3346 lined-up with respect to each other."
3351 "Alist of properties and functions to adjust inserted values.
3352 Elements of this alist must be of the form
3354 ([string] [function])
3356 where [string] must be a property name and [function] must be a
3357 lambda expression: this lambda expression must take one argument,
3358 the value to adjust, and return the new value as a string.
3362 and the clock summary:
3365 (let ((clocksum (org-clock-sum-current-item))
3366 (effort (org-duration-string-to-minutes
3368 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3375 "Non-nil means properties apply also for sublevels.
3377 This setting is chiefly used during property searches. Turning it on can
3378 cause significant overhead when doing a search, which is why it is not
3379 on by default.
3381 When nil, only the properties directly given in the current entry count.
3382 When t, every property is inherited. The value may also be a list of
3383 properties that should have inheritance, or a regular expression matching
3384 properties that should be inherited.
3386 However, note that some special properties use inheritance under special
3387 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3389 for valid values of a property.
3391 Note for programmers:
3392 When querying an entry with `org-entry-get', you can control if inheritance
3393 should be used. By default, `org-entry-get' looks only at the local
3394 properties. You can request inheritance by setting the inherit argument
3395 to t (to force inheritance) or to `selective' (to respect the setting
3396 in this variable)."
3405 "Check if PROPERTY is one that should be inherited."
3416 "The default column format, if no other format has been defined.
3417 This variable can be set on the per-file basis by inserting a line
3419 #+COLUMNS: %25ITEM ....."
3424 "The ellipses to be used when a field in column view is truncated.
3425 When this is the empty string, as many characters as possible are shown,
3426 but then there will be no visual indication that the field has been truncated.
3427 When this is a string of length N, the last N characters of a truncated
3428 field are replaced by this string. If the column is narrower than the
3429 ellipses string, only part of the ellipses string will be shown."
3434 "Function that modifies values for display in column view.
3435 For example, it can be used to cut out a certain part from a time stamp.
3436 The function must take 2 arguments:
3438 column-title The title of the column (*not* the property name)
3439 value The value that should be modified.
3441 The function should return the value that should be displayed,
3442 or nil if the normal value should be used."
3447 "The property that is being used to keep track of effort estimates.
3448 Effort estimates given in this property need to have the format H:MM."
3456 "List of property/value pairs that can be inherited by any entry.
3458 These are fixed values, for the preset properties. The user variable
3459 that can be used to add to this list is `org-global-properties'.
3461 The entries in this list are cons cells where the car is a property
3462 name and cdr is a string with the value. If the value represents
3467 "List of property/value pairs that can be inherited by any entry.
3469 This list will be combined with the constant `org-global-properties-fixed'.
3471 The entries in this list are cons cells where the car is a property
3472 name and cdr is a string with the value.
3474 You can set buffer-local values for the same purpose in the variable
3475 `org-file-properties' this by adding lines like
3477 #+PROPERTY: NAME VALUE"
3484 "List of property/value pairs that can be inherited by any entry.
3485 Valid for the current buffer.
3490 "Options concerning agenda views in Org-mode."
3495 "Variable used by org files to set a category for agenda display.
3496 Such files should use a file variable to set it, for example
3500 or contain a special line
3502 #+CATEGORY: ELisp
3504 If the file does not specify a category, then file's base name
3510 "The files to be used for agenda display.
3514 If an entry is a directory, all files in that directory that are matched by
3515 `org-agenda-file-regexp' will be part of the file list.
3517 If the value of the variable is not a list but a single file name, then
3518 the list of agenda files is actually stored and maintained in that file, one
3519 agenda file per line. In this file paths can be given relative to
3520 `org-directory'. Tilde expansion and environment variable substitution
3521 are also made."
3528 "Regular expression to match files for `org-agenda-files'.
3529 If any element in the list in that variable contains a directory instead
3530 of a normal file, all files in that directory that are matched by this
3531 regular expression will be included."
3536 "List of extra files to be searched by text search commands.
3537 These files will be search in addition to the agenda files by the
3538 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3539 Note that these files will only be searched for text search commands,
3540 not for the other agenda views like todo lists, tag searches or the weekly
3541 agenda. This variable is intended to list notes and possibly archive files
3542 that should also be searched by these two commands.
3543 In fact, if the first element in the list is the symbol `agenda-archives',
3544 than all archive files of all agenda files will be added to the search
3545 scope."
3556 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3557 A nil value means to remove them, after a query, from the list."
3562 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3563 The command `org-calendar-goto-agenda' will be bound to this key. The
3564 default is the character `c' because then `c' can be used to switch back and
3565 forth between agenda and calendar."
3570 "The key to be installed in `calendar-mode-map' for adding diary entries.
3571 This option is irrelevant until `org-agenda-diary-file' has been configured
3572 to point to an Org-mode file. When that is the case, the command
3573 `org-agenda-diary-entry' will be bound to the key given here, by default
3574 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3575 if you want to continue doing this, you need to change this to a different
3576 key."
3581 "File to which to add new entries with the `i' key in agenda and calendar.
3582 When this is the symbol `diary-file', the functionality in the Emacs
3583 calendar will be used to add entries to the `diary-file'. But when this
3584 points to a file, `org-agenda-diary-entry' will be used instead."
3598 org-calendar-insert-diary-entry-key
3602 "Options for embedding LaTeX code into Org-mode."
3610 "Options for creating images from LaTeX fragments.
3611 This is a property list with the following properties:
3613 `default' means use the foreground of the default face.
3614 `auto' means use the foreground from the text face.
3616 `default' means use the background of the default face.
3617 `auto' means use the background from the text face.
3618 :scale a scaling factor for the size of the images, to get more pixels
3619 :html-foreground, :html-background, :html-scale
3620 the same numbers for HTML export.
3621 :matchers a list indicating which matchers should be used to
3622 find LaTeX fragments. Valid members of this list are:
3633 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3634 When nil, just push out a message."
3641 Use this to specify additional executable file say a jar file.
3643 When using MathToWeb as the converter, specify the full-path to
3644 your mathtoweb.jar file."
3652 "Command to convert LaTeX fragments to MathML.
3653 Replace format-specifiers in the command as noted below and use
3654 `shell-command' to convert LaTeX to MathML.
3655 %j: Executable file in fully expanded form as specified by
3656 `org-latex-to-mathml-jar-file'.
3657 %I: Input LaTeX file in fully expanded form
3658 %o: Output MathML file
3659 This command is used by `org-create-math-formula'.
3661 When using MathToWeb as the converter, set this to
3670 "Program to convert LaTeX fragments with.
3672 dvipng Process the LaTeX fragments to dvi file, then convert
3673 dvi files to png files using dvipng.
3674 This will also include processing of non-math environments.
3675 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3676 to convert pdf files to png files"
3684 "Path to store latex preview images.
3685 A relative path here creates many directories relative to the
3686 processed org files paths. An absolute path puts all preview
3687 images at the same place."
3693 "Return t if `org-latex-to-mathml-convert-command' is usable."
3696 org-latex-to-mathml-convert-command)
3698 org-latex-to-mathml-convert-command))))
3703 t))))))
3710 \[PACKAGES]
3711 \[DEFAULT-PACKAGES]
3712 % The settings below are copied from fullpage.sty
3725 "The document header used for processing LaTeX fragments.
3726 It is imperative that this header make sure that no page number
3727 appears on the page. The package defined in the variables
3728 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3730 header, or they will be appended."
3735 "Set the packages alist and make sure it has 3 elements per entry."
3739 x))
3740 val)))
3743 "Get the packages alist and make sure it has 3 elements per entry."
3747 x))
3766 "Alist of default packages to be inserted in the header.
3768 Change this only if one of the packages here causes an
3769 incompatibility with another package you are using.
3771 The packages in this list are needed by one part or another of
3772 Org mode to function properly:
3774 - inputenc, fontenc: for basic font and character selection
3775 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3776 symbols used for interpreting the entities in `org-entities'.
3777 You can skip some of these packages if you don't use any of the
3778 symbols in it.
3779 - graphicx: for including images
3780 - float, wrapfig: for figure placement
3781 - longtable: for long tables
3782 - hyperref: for cross references
3784 Therefore you should not modify this variable unless you know
3785 what you are doing. The one reason to change it anyway is that
3786 you might be loading some other package that conflicts with one
3787 of the default packages. Each cell is of the format
3789 the package also needs to be included when compiling LaTeX
3790 snippets into images for inclusion into non-LaTeX output."
3805 "Alist of packages to be inserted in every LaTeX header.
3807 These will be inserted after `org-latex-default-packages-alist'.
3808 Each cell is of the format:
3812 SNIPPET-FLAG, when t, indicates that this package is also needed
3813 when turning LaTeX snippets into images for inclusion into
3814 non-LaTeX output.
3816 Make sure that you only list packages here which:
3818 - you want in every file
3819 - do not conflict with the setup in `org-format-latex-header'.
3820 - do not conflict with the default packages in
3821 `org-latex-default-packages-alist'."
3835 "Settings for Org-mode appearance."
3840 "Non-nil means fontify only the stars in each headline.
3841 When nil, the entire headline is fontified.
3842 Changing it requires restart of `font-lock-mode' to become effective
3843 also in regions already fontified."
3848 "Non-nil means hide the first N-1 stars in a headline.
3849 This works by using the face `org-hide' for these stars. This
3850 face is white for a light background, and black for a dark
3851 background. You may have to customize the face `org-hide' to
3852 make this work.
3853 Changing it requires restart of `font-lock-mode' to become effective
3854 also in regions already fontified.
3855 You may also set this on a per-file basis by adding one of the following
3856 lines to the buffer:
3858 #+STARTUP: hidestars
3859 #+STARTUP: showstars"
3864 "List of symbols corresponding to keywords to be hidden the org buffer.
3865 For example, a value '(title) for this list will make the document's title
3866 appear in the buffer without the initial #+TITLE: keyword."
3875 "List of properties (as strings) with a special meaning.
3876 The default use of these custom properties is to let the user
3877 hide them with `org-toggle-custom-properties-visibility'."
3884 "Non-nil means change the face of a headline if it is marked DONE.
3885 Normally, only the TODO/DONE keyword indicates the state of a headline.
3886 When this is non-nil, the headline after the keyword is set to the
3887 `org-headline-done' as an additional indication."
3892 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3893 Changing this variable requires a restart of Emacs to take effect."
3898 "Non-nil means fontify the whole line for headings.
3899 This is useful when setting a background color for the
3900 org-level-* faces."
3905 "Non-nil means highlight LaTeX related syntax in the buffer.
3906 When non nil, the value should be a list containing any of the
3907 following symbols:
3908 `latex' Highlight LaTeX snippets and environments.
3909 `script' Highlight subscript and superscript.
3910 `entities' Highlight entities."
3920 "Non-nil mean font-lock should hide the emphasis marker characters."
3925 "Non-nil means show entities as UTF8 characters.
3932 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3938 "Regular expression for matching emphasis.
3939 After a match, the match groups contain these elements:
3940 0 The match of the full regular expression, including the characters
3941 before and after the proper match
3942 1 The character before the proper match, or empty at beginning of line
3943 2 The proper match, including the leading and trailing markers
3944 3 The leading marker like * or /, indicating the type of highlighting
3945 4 The text between the emphasis markers, not including the markers
3952 "Set variable and compute the emphasis regular expression."
3956 org-emphasis-alist org-emphasis-regexp-components)
3968 ;; make sure special characters appear at the right position in the class
3980 ;; Make the regexp
3988 body1
4000 body1
4008 "Components used to build the regular expression for emphasis.
4009 This is a list with five entries. Terminology: In an emphasis string
4013 specify what is allowed/forbidden in each part:
4015 pre Chars allowed as prematch. Beginning of line will be allowed too.
4016 post Chars allowed as postmatch. End of line will be allowed too.
4017 border The chars *forbidden* as border characters.
4019 non-shy groups here, and don't allow newline here.
4020 newline The maximum number of newlines allowed in an emphasis exp.
4022 Use customize to modify this, or restart Emacs after changing it."
4041 )
4042 "Special syntax for emphasized text.
4043 Text starting and ending with a special character will be emphasized, for
4044 example *bold*, _underlined_ and /italic/. This variable sets the marker
4045 characters, the face to be used by font-lock for highlighting in Org-mode
4046 Emacs buffers, and the HTML tags to be used for this.
4047 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
4048 Use customize to modify this, or restart Emacs after changing it."
4063 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4066 ;;; Miscellaneous options
4069 "Completion in Org-mode."
4074 "Non-nil means use ido completion wherever possible.
4075 Note that `ido-mode' must be active for this variable to be relevant.
4076 If you decide to turn this variable on, you might well want to turn off
4077 `org-outline-path-complete-in-steps'.
4078 See also `org-completion-use-iswitchb'."
4083 "Non-nil means use iswitchb completion wherever possible.
4084 Note that `iswitchb-mode' must be active for this variable to be relevant.
4085 If you decide to turn this variable on, you might well want to turn off
4086 `org-outline-path-complete-in-steps'.
4087 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4093 Normal means, no org-mode-specific context."
4097 ;;; Functions and variables from their packages
4098 ;; Declared here to avoid compiler warnings
4100 ;; XEmacs only
4106 ;; Emacs only
4109 ;; Various packages
4128 org-agenda-format-item "org-agenda"
4155 ;;; Autoload and prepare some org modules
4157 ;; Some table stuff that needs to be defined here, because it is used
4158 ;; by the functions setting up org-mode or checking for table context.
4171 "Detect the first line outside a table when searching from within it.
4174 ;; Autoload the functions in org-table.el that are needed by functions here.
4180 ;;;###autoload
4182 "Unconditionally turn on `orgtbl-mode'."
4187 "Return t if the cursor is inside an org-type table.
4188 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4193 org-table-line-regexp)))
4194 nil))
4198 "Return t if and only if we are at a table.el table."
4205 "If there is a table.el table nearby, recognize it and move into it."
4211 nil
4221 t
4226 t)
4227 nil)
4228 nil))
4231 "Return t if the cursor is inside a hline in a table."
4236 nil))
4240 "Apply FUNCTION to the start of all tables in the buffer."
4250 ;; Exclude tables in src/example/verbatim/clocktable blocks
4258 ;; Declare and autoload functions from ox.el and al.
4264 ;; Declare and autoload functions from org-agenda.el
4282 "Return non-nil if clock is currently running.
4283 The return value is actually the clock marker."
4288 org-clock-update-time-maybe
4289 org-clocktable-shift)))
4292 "Check if the current buffer contains the running clock.
4293 If yes, offer to stop it and to save the buffer with the changes."
4302 "Check if this line starts a clock table, if yes, shift the time block."
4306 ;;;###autoload
4308 "Set up hooks for clock persistence."
4313 ;; Define the variable already here, to make sure we have it.
4315 "Non-nil if Org-Indent mode is enabled.
4318 ;; Autoload archiving code
4319 ;; The stuff that is needed for cycling and tags has to be defined here.
4322 "Options concerning archiving in Org-mode."
4327 "The location where subtrees should be archived.
4329 The value of this variable is a string, consisting of two parts,
4330 separated by a double-colon. The first part is a filename and
4331 the second part is a headline.
4333 When the filename is omitted, archiving happens in the same file.
4334 %s in the filename will be replaced by the current file
4335 name (without the directory part). Archiving to a different file
4336 is useful to keep archived entries from contributing to the
4337 Org-mode Agenda.
4339 The archived entries will be filed as subtrees of the specified
4340 headline. When the headline is omitted, the subtrees are simply
4341 filed away at the end of the file, as top-level entries. Also in
4342 the heading you can use %s to represent the file name, this can be
4343 useful when using the same archive for a number of different files.
4345 Here are a few examples:
4347 If the current file is Projects.org, archive in file
4348 Projects.org_archive, as top-level trees. This is the default.
4351 Archive in the current file, under the top-level headline
4355 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4358 Archive in file ~/org/archive.org (absolute path), under headlines
4363 items to the datetree. Items are placed in either the CLOSED
4364 date of the item, or the current date if there is no CLOSED date.
4365 The heading will be a subentry to the current date. There doesn't
4366 need to be a heading, but there always needs to be a slash after
4367 datetree. For example, to store archived items directly in the
4371 Archive in file ./basement (relative path), as level 3 trees
4374 You may set this option on a per-file basis by adding to the buffer a
4375 line like
4377 #+ARCHIVE: basement::** Finished Tasks
4379 You may also define it locally for a subtree by setting an ARCHIVE property
4380 in the entry. If such a property is found in an entry, or anywhere up
4381 the hierarchy, it will be used."
4386 "The tag that marks a subtree as archived.
4387 An archived subtree does not open during visibility cycling, and does
4388 not contribute to the agenda listings.
4389 After changing this, font-lock must be restarted in the relevant buffers to
4390 get the proper fontification."
4396 "Non-nil means the agenda will skip any items located in archived trees.
4397 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4398 variable is no longer recommended, you should leave it at the value t.
4399 Instead, use the key `v' to cycle the archives-mode in the agenda."
4405 "Non-nil means ignore archived trees when creating column view."
4411 "Non-nil means `org-cycle' will open archived trees.
4412 An archived tree is a tree marked with the tag ARCHIVE.
4413 When nil, archived trees will stay folded. You can still open them with
4414 normal outline commands like `show-all', but not with the cycling commands."
4420 "Non-nil means sparse tree construction shows matches in archived trees.
4421 When nil, matches in these trees are highlighted, but the trees are kept in
4422 collapsed state."
4428 "The default date type when building a sparse tree.
4429 When this is nil, a date is a scheduled or a deadline timestamp.
4430 Otherwise, these types are allowed:
4432 all: all timestamps
4433 active: only active timestamps (<...>)
4434 inactive: only inactive timestamps (<...)
4435 scheduled: only scheduled timestamps
4436 deadline: only deadline timestamps"
4447 "Re-hide all archived subtrees after a visibility state change."
4458 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4461 "Cycle subtree even if it is archived."
4468 "Re-hide all archived subtrees after a visibility state change."
4485 flag)))
4493 ;; Autoload Column View Code
4501 org-columns-get-format-and-top-level
4502 org-columns-compute
4503 org-columns-remove-overlays))
4505 ;; Autoload ID code
4513 org-id-copy
4514 org-id-get-with-outline-path-completion
4515 org-id-get-with-outline-drilling))
4517 ;;; Variables for pre-computed regular expressions, all buffer local
4535 "Matches a headline and puts everything into groups:
4536 group 1: the stars
4537 group 2: The todo keyword, maybe
4538 group 3: Priority cookie
4539 group 4: True headline
4543 "Printf format to make regexp to match an exact headline.
4544 This regexp will match the headline of any node which has the
4545 exact headline text that is put into the format, but may have any
4549 "Matches a headline and puts TODO state into group 2 if present.
4595 "Regular expression to match a plain time or time range.
4596 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4597 groups carry important information:
4598 0 the full match
4599 1 the first time, range or not
4607 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4608 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4609 groups carry important information:
4610 0 the full match
4611 7 hours of duration
4620 "Regular expression to match a timestamp time or time range.
4621 After a match, the following groups carry important information:
4622 0 the full match
4623 1 date plus weekday, for back referencing to make sure both times are on the same day
4624 2 the first time, range or not
4685 "Variable associated with STARTUP options for org-mode.
4686 Each element is a list of three items: the startup options (as written
4687 in the #+STARTUP line), the corresponding variable, and the value to set
4688 this variable to if the option is found. An optional forth element PUSH
4692 "Update PROPS with KEY and VAL."
4706 "Printf format for a regexp matching a headline with some keyword.
4707 This regexp will match the headline of any node which has the
4708 exact keyword that is put into the format. The keyword isn't in
4712 "Printf format for a regexp matching a headline, possibly with some keyword.
4713 This regexp can match any headline with the specified keyword, or
4714 without a keyword. The keyword isn't in any group by default,
4718 "Precompute regular expressions for current buffer."
4737 kwds kws0 kwsa key log value cat arch tags const links hw dws
4738 tail sep kws1 prio props ftags drawers ext-setup-or-nil setup-contents
4760 ;; general TODO-like setup
4772 links)))
4779 props))))
4784 ftags
4794 l var val)
4822 ;; search for property blocks
4831 props)))))))
4848 ;; Process the TODO keywords
4850 ;; Use the global values as if they had been given locally.
4862 kws)))
4865 kwsa nil
4868 ;; 1 2
4876 kw)
4878 kws0)
4895 ;; Process the constants
4903 ;; Process the tags.
4914 tgs))
4922 ;; Compute the regular expressions and other local variables.
4923 ;; Using `org-outline-regexp-bol' would complicate them much,
4924 ;; because of the fixed white space at the end of that string.
4932 org-drawer-regexp
4936 org-not-done-keywords
4938 org-todo-regexp
4942 org-not-done-regexp
4946 org-not-done-heading-regexp
4948 org-todo-line-regexp
4950 org-complex-heading-regexp
4957 org-complex-heading-regexp-format
4962 ;; Stats cookies can be stuck to body.
4969 org-todo-line-tags-regexp
4976 org-deadline-time-regexp
4978 org-deadline-line-regexp
4980 org-scheduled-regexp
4982 org-scheduled-time-regexp
4984 org-closed-time-regexp
4986 org-keyword-time-regexp
4992 org-keyword-time-not-clock-regexp
4998 org-maybe-keyword-time-regexp
5004 org-all-time-keywords
5007 org-clock-string org-closed-string)))
5012 "Return the contents of FILE, as a string."
5026 "Extract the log state setting from a TODO keyword string.
5040 "Remove a pair of parenthesis at the end of each string in LIST."
5044 x))
5045 list))
5048 "Assign fast keys to a keyword-key alist.
5049 Respect keys that are already there."
5067 ;;; Some variables used in various places
5074 "Function to be called when `C-c C-c' is used.
5078 ;; FIXME: Occasionally check by commenting these, to make sure
5079 ;; no other functions uses these, forgetting to let-bind them.
5084 ;; Defined somewhere in this file, but used before definition.
5090 ;;;; Define the Org-mode
5092 ;; We use a before-change function to check if a table might need
5093 ;; an update.
5095 "Indicates that a table might need an update.
5096 This variable is set by `org-before-change-function'.
5099 "Every change indicates that a table might need an update."
5114 (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"))
5117 ;; Other stuff we need.
5123 ;; (require 'org-macs) moved higher up in the file before it is first used
5125 ;; (require 'org-compat) moved higher up in the file before it is first used
5133 ;; babel
5136 ;;;###autoload
5138 "Outline-based notes management and organizer, alias
5141 Org-mode develops organizational tasks around a NOTES file which
5142 contains information about projects as plain text. Org-mode is
5143 implemented on top of outline-mode, which is ideal to keep the content
5144 of large files well structured. It supports ToDo items, deadlines and
5145 time stamps, which magically appear in the diary listing of the Emacs
5146 calendar. Tables are easily created with a built-in table editor.
5147 Plain text URL-like links connect to websites, emails (VM), Usenet
5148 messages (Gnus), BBDB entries, and any files related to the project.
5149 For printing and sharing of notes, an Org-mode file (or a part of it)
5150 can be exported as a structured ASCII or HTML file.
5152 The following commands are available:
5156 ;; Get rid of Outline menus, they are not needed
5157 ;; Need to do this here because define-derived-mode sets up
5158 ;; the keymap so late. Still, it is a waste to call this each time
5159 ;; we switch another buffer into org-mode.
5162 ;; Assume this is Greg's port, it uses easymenu
5188 org-display-table 4
5191 org-ellipsis)))
5196 ;; tag faces set outside customize.... force initialization.
5198 ;; Calc embedded
5200 ;; Modify a few syntax entries
5211 ;; Activate before-change-function
5215 ;; Check for running clock before killing a buffer
5217 ;; Initialize macros templates.
5219 ;; Initialize radio targets.
5221 ;; Indentation.
5224 ;; Filling and auto-filling.
5226 ;; Comments.
5228 ;; Beginning/end of defun
5231 ;; Next error for sparse trees
5233 ;; Make sure dependence stuff works reliably, even for users who set it
5234 ;; too late :-(
5246 ;; Align options lines
5248 'align-mode-rules-list
5253 ;; Imenu
5257 ;; Make isearch reveal context
5260 ;; Emacs 21 and XEmacs make use of the hook
5262 ;; Emacs 22 deals with this through a special variable
5266 ;; Setup the pcomplete hooks
5279 ;; If empty file that did not turn on org-mode automatically, make it to.
5295 ;; Try to set org-hide correctly
5302 org-emphasis-alist)
5303 st))
5314 "unspecified-bg"
5327 "Current time, possibly rounded to ROUNDING-MINUTES.
5328 When ROUNDING-MINUTES is not an integer, fall back on the car of
5329 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5330 the rounding returns a past time."
5342 res))))
5345 "Return today date, considering `org-extend-today-until'."
5350 ;;;; Font-Lock stuff, including the activators
5381 "Regular expression used to analyze links.
5382 Here is what the match groups contain after a match:
5383 1: http:
5384 2: http
5385 3: path
5386 4: [desc]
5397 "Create a regular expression which will match a balanced sexp.
5398 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5399 as single character strings.
5400 The regexp returned will match the entire expression including the
5401 delimiters. It will also define a single group which contains the
5402 match except for the outermost delimiters. The maximum depth of
5403 stacked delimiters is N. Escaping delimiters is not possible."
5432 "Update the link regular expressions.
5433 This should be called after the variable `org-link-types' has changed."
5437 org-link-re-with-space
5443 org-link-re-with-space2
5449 org-link-re-with-space3
5454 org-angle-link-re
5460 org-plain-link-re
5464 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5465 org-bracket-link-regexp
5467 org-bracket-link-analytic-regexp
5475 org-bracket-link-analytic-regexp++
5483 org-any-link-re
5492 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5495 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5496 "Regular expression matching time strings for analysis.
5497 This one does not require the space after the date, so it can be used
5499 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5517 "Regular expression matching a time stamp or time stamp range.
5523 "Run through the buffer and add overlays to emphasized strings."
5532 'face
5545 rtn))
5548 "Insert or change an emphasis, i.e. a font like bold or italic.
5549 If there is an active region, change that region to a new emphasis.
5550 If there is no region, just insert the marker characters and position
5551 the cursor between them.
5552 CHAR should be either the marker character, or the first character of the
5553 HTML tag associated with that emphasis. If CHAR is a space, the means
5554 to remove the emphasis of the selected region.
5555 If char is not given (for example in an interactive call) it
5556 will be prompted for."
5607 "Run through the buffer and add overlays to links."
5617 nil
5624 t))))
5632 t)))
5635 "When non-nil, fontify code in code blocks."
5642 "When non-nil, allow promoting a top level subtree.
5643 The leading star of the top level headline will be replaced
5644 by a #."
5655 "Fontify #+ lines and blocks, in the correct ways."
5658 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5659 limit t)
5667 end end1 quoting block-type ovl)
5670 ;; a single line of backend-specific content
5678 ; for backend-specific code
5679 t)
5681 ;; Truly a block
5694 beg end
5702 ;; remove old background overlays
5707 ;; add a background overlay
5722 t))
5742 t)
5748 ;; just any other in-buffer setting, but not indented
5752 t)
5756 "Run through the buffer and add overlays to links."
5765 t)))
5768 "Run through the buffer and add overlays to footnotes."
5775 'keymap org-mouse-map
5776 'help-echo
5778 "Footnote definition"
5780 'font-lock-fontified t
5781 'font-lock-multiline t
5785 "Run through the buffer and add overlays to bracketed links."
5790 ;; FIXME: Above we should remove the escapes. But that
5791 ;; requires another match, protecting match data, a lot
5792 ;; of overhead for font-lock.
5801 ;; We need to remove the invisible property here. Table narrowing
5802 ;; may have made some of this invisible.
5820 t)))
5823 "Run through the buffer and add overlays to dates."
5835 t)))
5844 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5848 "Run through the buffer and add overlays to target matches."
5856 'keymap org-mouse-map
5860 t)))))
5863 "Find all radio targets in this file and update the regular expression."
5878 t)))
5886 "Compute regular expression for LaTeX, entities and sub/superscript.
5887 Result depends on variable `org-highlight-latex-and-related'."
5889 'org-latex-and-related-regexp
5901 org-latex-regexps)))))
5908 "Highlight LaTeX snippets and environments, entities and sub/superscript.
5909 LIMIT bounds the search for syntax to highlight. Stop at first
5910 highlighted object, if any. Return t if some highlighting was
5911 done, nil otherwise."
5920 1
5928 nil)))
5931 "Restart `font-lock-mode', to force refontification."
5937 "Return a list of all targets in this file.
5938 When optional argument RADIO is non-nil, only find radio
5939 targets."
5944 ;; Make sure point is really within the object.
5949 rtn)))
5952 "Make regular expression matching all strings in TARGETS.
5953 The regular expression finds the targets also if there is a line break
5954 between words."
5963 x)
5964 targets
5976 t)))
5979 "Compute the outline level of the heading at point.
5980 If this is called at a normal headline, the level is the number of stars.
5981 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5986 0
5992 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5999 "Functions that can manipulate `org-font-lock-extra-keywords'.
6000 This is called after `org-font-lock-extra-keywords' is defined, but before
6001 it is installed to be used by font lock. This can be useful if something
6005 "Run `org-font-lock-hook' within LIMIT."
6009 "Set font lock defaults for the current buffer."
6014 ;; Call the hook
6016 ;; Headlines
6023 ;; Table lines
6026 ;; Table internals
6031 ;; Drawers
6034 ;; Properties
6038 ;; Links
6048 ;; TODO keyword
6050 org-todo-regexp)
6052 ;; DONE
6060 nil)
6061 ;; Priorities
6063 ;; Tags
6065 ;; Special keywords
6070 ;; Emphasis
6075 ;; Checkboxes
6076 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6081 ;; Description list items
6084 ;; ARCHIVEd headings
6086 org-outline-regexp-bol
6089 ;; Specials
6093 ;; Code
6095 ;; COMMENT
6101 ;; Blocks and meta lines
6103 )))
6106 ;; Now set the full font-lock-keywords
6113 "Toggle the composition display of entities as UTF8 characters."
6129 "Display or hide properties in `org-custom-properties'."
6146 org-custom-properties)))))))
6149 "Find an entity to fontify."
6155 limit t)
6170 nil))))
6173 "Fontify string S like in Org-mode."
6185 "Get the right face for match N in font-lock matching of headlines."
6198 "Get the right face for a TODO keyword KWD.
6199 If KWD is a number, get the corresponding match group."
6207 "Create a face list that inherits INHERIT, but sets the foreground color.
6208 When FACE-OR-COLOR is not a string, just return it."
6212 face-or-color)
6213 face-or-color))
6216 "Add the special tag faces."
6225 "Add the special priority faces."
6233 org-priority-faces)))
6238 "Get the right face for a TODO keyword KWD.
6239 If KWD is a number, get the corresponding match group."
6246 "Remove fontification and activation overlays from links."
6251 deactivate-mark buffer-file-name buffer-file-truename)
6255 invisible t intangible t
6256 org-no-flyspell t org-emphasis t))
6266 "Remove specific display properties that have been added by font lock.
6267 The will remove the raise properties that are used to show superscripts
6268 and subscripts."
6278 "Add raise properties to sub/superscripts."
6282 org-match-substring-regexp
6283 org-match-substring-with-braces-regexp)
6284 limit t)
6294 ;; FIXME: Should we go back one character here, for a_b^c
6295 ;; (goto-char (1- pos)) ;????????????????????
6297 t
6299 'display
6315 t)))))
6317 ;;;; Visibility cycling, including org-goto and indirect buffer
6319 ;;; Cycling
6330 ;;;###autoload
6332 "TAB-action and visibility cycling for Org-mode.
6334 This is the command invoked in Org-mode by the TAB key. Its main purpose
6335 is outline visibility cycling, but it also invokes other actions
6336 in special contexts.
6338 - When this function is called with a prefix argument, rotate the entire
6339 buffer through 3 states (global cycling)
6340 1. OVERVIEW: Show only top-level headlines.
6341 2. CONTENTS: Show all headlines of all levels, but no body text.
6342 3. SHOW ALL: Show everything.
6343 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6344 determined by the variable `org-startup-folded', and by any VISIBILITY
6345 properties in the buffer.
6346 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6347 including any drawers.
6349 - When inside a table, re-align the table and move to the next field.
6351 - When point is at the beginning of a headline, rotate the subtree started
6352 by this line through 3 different states (local cycling)
6353 1. FOLDED: Only the main headline is shown.
6354 2. CHILDREN: The main headline and the direct children are shown.
6355 From this state, you can move to one of the children
6356 and zoom in further.
6357 3. SUBTREE: Show the entire subtree, including body text.
6358 If there is no subtree, switch directly from CHILDREN to FOLDED.
6360 - When point is at the beginning of an empty headline and the variable
6361 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6362 of the headline by demoting and promoting it to likely levels. This
6363 speeds up creation document structure by pressing TAB once or several
6364 times right after creating a new headline.
6366 - When there is a numeric prefix, go up to a heading with level ARG, do
6367 a `show-subtree' and return to the previous cursor position. If ARG
6368 is negative, go up that many levels.
6370 - When point is not at the beginning of a headline, execute the global
6371 binding for TAB, which is re-indenting the line. See the option
6372 `org-cycle-emulate-tab' for details.
6374 - Special case: if point is at the beginning of the buffer and there is
6375 no headline in line 1, this function will act as if called with prefix arg
6376 (C-u TAB, same as S-TAB) also when called without prefix arg.
6377 But only if also the variable `org-cycle-global-at-bob' is t."
6388 org-inlinetask-min-level
6393 limit-level)))
6396 outline-regexp
6404 org-cycle-hook))
6408 ;; special case: use global cycling
6422 ;; Table: enter it or move to the next field.
6433 ;; Global cycling: delegate to `org-cycle-internal-global'.
6436 ;; Drawers: delegate to `org-flag-drawer'.
6444 ;; Show-subtree, ARG levels up from here.
6452 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6460 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6467 ;; From there: TAB emulation and template completion.
6489 t
6498 "Do the global cycling action."
6499 ;; Hack to avoid display of messages for .org attachments in Gnus
6505 ;; We just created the overview - now do table of contents
6506 ;; This can be slow in very large buffers, so indicate action
6516 ;; We just showed the table of contents - now show everything
6524 ;; Default action: go to overview
6532 "Do the local cycling action."
6535 ;; First, determine end of headline (EOH), end of subtree or item
6536 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6556 ;; Determine end invisible part of buffer (EOL)
6558 ;; XEmacs doesn't have `next-single-char-property-change'
6568 ;; Find out what to do next and set `this-command'
6571 ;; Nothing is hidden behind this heading
6584 org-cycle-skip-children-state-if-no-children))))
6585 ;; Entire subtree is hidden in one line: children view
6592 ;; FIXME: This slows down the func way too much.
6593 ;; How keep drawers hidden in subtree anyway?
6594 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6595 ;; (org-cycle-hide-drawers 'subtree))
6597 ;; Fold every list in subtree to top-level items.
6620 ;; We just showed the children, or no children are there,
6621 ;; now show everything.
6630 ;; Default action: hide the subtree.
6638 ;;;###autoload
6640 "Cycle the global visibility. For details see `org-cycle'.
6642 With a numeric prefix, show all headlines up to that level."
6658 "Set the visibility required by startup options and properties."
6673 "Switch subtree visibilities according to :VISIBILITY: property."
6680 nil t)
6704 ;; This function uses outline-regexp instead of the more fundamental
6705 ;; org-outline-regexp so that org-cycle-global works outside of Org
6706 ;; buffers, where outline-regexp is needed.
6708 "Switch to overview mode, showing only top-level headlines.
6709 Really, this shows all headlines with level equal or greater than the level
6710 of the first headline in the buffer. This is important, because if the
6711 first headline is not level one, then (hide-sublevels 1) gives confusing
6712 results."
6723 "Show all headlines in the buffer, like a table of contents.
6724 With numerical argument N, show content up to level N."
6727 ;; Visit all headings and show their offspring
6734 t)
6743 "Adjust the window after a change in outline visibility.
6744 This function is the default value of the hook `org-cycle-hook'."
6754 "Remove outline overlays that do not contain non-white stuff."
6764 "Fix visibility issues after moving a subtree."
6765 ;; First, find a reasonable region to look at:
6766 ;; Start two siblings above, end three below
6784 ;; Properly fold already folded siblings
6795 "Show empty lines above all visible headlines.
6796 The region to be covered depends on STATE when called through
6797 `org-cycle-hook'. Lisp program can use t for STATE to get the
6798 entire buffer covered. Note that an empty line is only shown if there
6799 are at least `org-cycle-separator-lines' empty lines before the headline."
6809 beg end b e)
6833 ;; Never hide empty lines at the end of the file.
6843 "Move to the parent and re-show empty lines before visible headlines."
6849 "Return `org-agenda-files' list, plus all open org-mode files.
6850 This is useful for operations that need to scan all of a user's
6851 open and agenda-wise Org files."
6859 files))
6862 "Return the beginning position of the current entry."
6866 "Return the end position of the current entry."
6870 "Re-hide all drawers after a visibility state change."
6885 "Re-hide inline task when switching to 'contents visibility state."
6888 org-inlinetask-min-level)
6892 "When FLAG is non-nil, hide the drawer we are within.
6893 Otherwise make it visible."
6905 "Is the end of the current subtree visible?"
6910 "Move cursor to the first headline and recenter the headline.
6911 Optional argument N means put the headline into the Nth line of the window."
6917 ;;; Saving and restoring visibility
6920 "Return a list of the locations of all outline overlays.
6921 These are overlays with the `invisible' property value `outline'.
6922 The return value is a list of cons cells, with start and stop
6923 positions for each overlay.
6924 If USE-MARKERS is set, return the positions as markers."
6942 "Create visibility overlays for all positions in DATA.
6943 DATA should have been made by `org-outline-overlay-data'."
6951 data)))))
6953 ;;; Folding of blocks
6960 "Call FUNCTION at the head of all source blocks in the current buffer.
6961 Optional arguments START and END can be used to limit the range."
6973 "Toggle the visibility of all blocks in the current buffer."
6977 "Fold all blocks in the current buffer."
6983 "Unfold all blocks in the current buffer."
6989 "Toggle visibility of block at point."
7000 "Toggle the visibility of the current block."
7007 ov)
7023 ;; make the block accessible to isearch
7025 ov 'isearch-open-invisible
7036 ;; org-tab-after-check-for-cycling-hook
7038 ;; Remove overlays when changing major mode
7043 ;;; Org-goto
7049 "Set the keymap `org-goto'."
7053 mouse-drag-region universal-argument org-occur))
7054 cmd)
7070 nil)
7071 (org-defkey map "q" 'org-goto-quit)
7072 (org-defkey map "n" 'outline-next-visible-heading)
7073 (org-defkey map "p" 'outline-previous-visible-heading)
7074 (org-defkey map "f" 'outline-forward-same-level)
7075 (org-defkey map "b" 'outline-backward-same-level)
7076 (org-defkey map "u" 'outline-up-heading))
7077 (org-defkey map "/" 'org-occur)
7078 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7079 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7080 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7081 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7082 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7083 map)))
7085 (defconst org-goto-help
7086 "Browse buffer copy, to find location or copy text.%s
7087 RET=jump to location C-g=quit and return to previous location
7088 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7090 (defvar org-goto-start-pos) ; dynamically scoped parameter
7092 ;; FIXME: Docstring does not mention both interfaces
7093 (defun org-goto (&optional alternative-interface)
7094 "Look up a different location in the current file, keeping current visibility.
7096 When you want look-up or go to a different location in a
7097 document, the fastest way is often to fold the entire buffer and
7098 then dive into the tree. This method has the disadvantage, that
7099 the previous location will be folded, which may not be what you
7100 want.
7102 This command works around this by showing a copy of the current
7103 buffer in an indirect buffer, in overview mode. You can dive
7104 into the tree in that copy, use org-occur and incremental search
7105 to find a location. When pressing RET or `Q', the command
7106 returns to the original buffer in which the visibility is still
7107 unchanged. After RET it will also jump to the location selected
7108 in the indirect buffer and expose the headline hierarchy above.
7110 With a prefix argument, use the alternative interface: e.g. if
7111 `org-goto-interface' is 'outline use 'outline-path-completion."
7112 (interactive "P")
7113 (org-goto-map)
7114 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7115 (org-refile-use-outline-path t)
7116 (org-refile-target-verify-function nil)
7117 (interface
7118 (if (not alternative-interface)
7119 org-goto-interface
7120 (if (eq org-goto-interface 'outline)
7121 'outline-path-completion
7122 'outline)))
7123 (org-goto-start-pos (point))
7124 (selected-point
7125 (if (eq interface 'outline)
7126 (car (org-get-location (current-buffer) org-goto-help))
7127 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7128 (org-refile-check-position pa)
7129 (nth 3 pa)))))
7130 (if selected-point
7131 (progn
7132 (org-mark-ring-push org-goto-start-pos)
7133 (goto-char selected-point)
7134 (if (or (outline-invisible-p) (org-invisible-p2))
7135 (org-show-context 'org-goto)))
7136 (message "Quit"))))
7138 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7139 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7140 (defvar org-goto-local-auto-isearch-map) ; defined below
7142 (defun org-get-location (buf help)
7143 "Let the user select a location in the Org-mode buffer BUF.
7144 This function uses a recursive edit. It returns the selected position
7145 or nil."
7146 (org-no-popups
7147 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7148 (isearch-hide-immediately nil)
7149 (isearch-search-fun-function
7150 (lambda () 'org-goto-local-search-headings))
7151 (org-goto-selected-point org-goto-exit-command))
7152 (save-excursion
7153 (save-window-excursion
7154 (delete-other-windows)
7155 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7156 (org-pop-to-buffer-same-window
7157 (condition-case nil
7158 (make-indirect-buffer (current-buffer) "*org-goto*")
7159 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7160 (with-output-to-temp-buffer "*Org Help*"
7161 (princ (format help (if org-goto-auto-isearch
7162 " Just type for auto-isearch."
7163 " n/p/f/b/u to navigate, q to quit."))))
7164 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7165 (setq buffer-read-only nil)
7166 (let ((org-startup-truncated t)
7167 (org-startup-folded nil)
7168 (org-startup-align-all-tables nil))
7169 (org-mode)
7170 (org-overview))
7171 (setq buffer-read-only t)
7172 (if (and (boundp 'org-goto-start-pos)
7173 (integer-or-marker-p org-goto-start-pos))
7174 (let ((org-show-hierarchy-above t)
7175 (org-show-siblings t)
7176 (org-show-following-heading t))
7177 (goto-char org-goto-start-pos)
7178 (and (outline-invisible-p) (org-show-context)))
7179 (goto-char (point-min)))
7180 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7181 (message "Select location and press RET")
7182 (use-local-map org-goto-map)
7183 (recursive-edit)))
7184 (kill-buffer "*org-goto*")
7185 (cons org-goto-selected-point org-goto-exit-command))))
7187 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7188 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7189 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7190 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7192 (defun org-goto-local-search-headings (string bound noerror)
7193 "Search and make sure that any matches are in headlines."
7194 (catch 'return
7195 (while (if isearch-forward
7196 (search-forward string bound noerror)
7197 (search-backward string bound noerror))
7198 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7199 (and (member :headline context)
7200 (not (member :tags context))))
7201 (throw 'return (point))))))
7203 (defun org-goto-local-auto-isearch ()
7204 "Start isearch."
7205 (interactive)
7206 (goto-char (point-min))
7207 (let ((keys (this-command-keys)))
7208 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7209 (isearch-mode t)
7210 (isearch-process-search-char (string-to-char keys)))))
7212 (defun org-goto-ret (&optional arg)
7213 "Finish `org-goto' by going to the new location."
7214 (interactive "P")
7215 (setq org-goto-selected-point (point)
7216 org-goto-exit-command 'return)
7217 (throw 'exit nil))
7219 (defun org-goto-left ()
7220 "Finish `org-goto' by going to the new location."
7221 (interactive)
7222 (if (org-at-heading-p)
7223 (progn
7224 (beginning-of-line 1)
7225 (setq org-goto-selected-point (point)
7226 org-goto-exit-command 'left)
7227 (throw 'exit nil))
7228 (error "Not on a heading")))
7230 (defun org-goto-right ()
7231 "Finish `org-goto' by going to the new location."
7232 (interactive)
7233 (if (org-at-heading-p)
7234 (progn
7235 (setq org-goto-selected-point (point)
7236 org-goto-exit-command 'right)
7237 (throw 'exit nil))
7238 (error "Not on a heading")))
7240 (defun org-goto-quit ()
7241 "Finish `org-goto' without cursor motion."
7242 (interactive)
7243 (setq org-goto-selected-point nil)
7244 (setq org-goto-exit-command 'quit)
7245 (throw 'exit nil))
7247 ;;; Indirect buffer display of subtrees
7249 (defvar org-indirect-dedicated-frame nil
7250 "This is the frame being used for indirect tree display.")
7251 (defvar org-last-indirect-buffer nil)
7253 (defun org-tree-to-indirect-buffer (&optional arg)
7254 "Create indirect buffer and narrow it to current subtree.
7255 With a numerical prefix ARG, go up to this level and then take that tree.
7256 If ARG is negative, go up that many levels.
7258 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7259 indirect buffer previously made with this command, to avoid proliferation of
7260 indirect buffers. However, when you call the command with a \
7262 when `org-indirect-buffer-display' is `new-frame', the last buffer
7263 is kept so that you can work with several indirect buffers at the same time.
7264 If `org-indirect-buffer-display' is `dedicated-frame', the \
7266 requests that a new frame be made for the new buffer, so that the dedicated
7267 frame is not changed."
7268 (interactive "P")
7269 (let ((cbuf (current-buffer))
7270 (cwin (selected-window))
7271 (pos (point))
7272 beg end level heading ibuf)
7273 (save-excursion
7274 (org-back-to-heading t)
7275 (when (numberp arg)
7276 (setq level (org-outline-level))
7277 (if (< arg 0) (setq arg (+ level arg)))
7278 (while (> (setq level (org-outline-level)) arg)
7279 (org-up-heading-safe)))
7280 (setq beg (point)
7281 heading (org-get-heading))
7282 (org-end-of-subtree t t)
7283 (if (org-at-heading-p) (backward-char 1))
7284 (setq end (point)))
7285 (if (and (buffer-live-p org-last-indirect-buffer)
7286 (not (eq org-indirect-buffer-display 'new-frame))
7287 (not arg))
7288 (kill-buffer org-last-indirect-buffer))
7289 (setq ibuf (org-get-indirect-buffer cbuf)
7290 org-last-indirect-buffer ibuf)
7291 (cond
7292 ((or (eq org-indirect-buffer-display 'new-frame)
7293 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7294 (select-frame (make-frame))
7295 (delete-other-windows)
7296 (org-pop-to-buffer-same-window ibuf)
7297 (org-set-frame-title heading))
7298 ((eq org-indirect-buffer-display 'dedicated-frame)
7299 (raise-frame
7300 (select-frame (or (and org-indirect-dedicated-frame
7301 (frame-live-p org-indirect-dedicated-frame)
7302 org-indirect-dedicated-frame)
7303 (setq org-indirect-dedicated-frame (make-frame)))))
7304 (delete-other-windows)
7305 (org-pop-to-buffer-same-window ibuf)
7306 (org-set-frame-title (concat "Indirect: " heading)))
7307 ((eq org-indirect-buffer-display 'current-window)
7308 (org-pop-to-buffer-same-window ibuf))
7309 ((eq org-indirect-buffer-display 'other-window)
7310 (pop-to-buffer ibuf))
7311 (t (error "Invalid value")))
7312 (if (featurep 'xemacs)
7313 (save-excursion (org-mode) (turn-on-font-lock)))
7314 (narrow-to-region beg end)
7315 (show-all)
7316 (goto-char pos)
7317 (run-hook-with-args 'org-cycle-hook 'all)
7318 (and (window-live-p cwin) (select-window cwin))))
7320 (defun org-get-indirect-buffer (&optional buffer)
7321 (setq buffer (or buffer (current-buffer)))
7322 (let ((n 1) (base (buffer-name buffer)) bname)
7323 (while (buffer-live-p
7324 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7325 (setq n (1+ n)))
7326 (condition-case nil
7327 (make-indirect-buffer buffer bname 'clone)
7328 (error (make-indirect-buffer buffer bname)))))
7330 (defun org-set-frame-title (title)
7331 "Set the title of the current frame to the string TITLE."
7332 ;; FIXME: how to name a single frame in XEmacs???
7333 (unless (featurep 'xemacs)
7334 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7336 ;;;; Structure editing
7338 ;;; Inserting headlines
7340 (defun org-previous-line-empty-p ()
7341 (save-excursion
7342 (and (not (bobp))
7343 (or (beginning-of-line 0) t)
7344 (save-match-data
7347 (defun org-insert-heading (&optional force-heading invisible-ok)
7348 "Insert a new heading or item with same depth at point.
7349 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7350 If point is at the beginning of a headline, insert a sibling before the
7351 current headline. If point is not at the beginning, split the line,
7352 create the new headline with the text in the current line after point
7353 \(but see also the variable `org-M-RET-may-split-line').
7355 With a double prefix arg, force the heading to be inserted at the
7356 end of the parent subtree.
7358 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7359 This is important for non-interactive uses of the command."
7360 (interactive "P")
7361 (if (or (= (buffer-size) 0)
7362 (and (not (save-excursion
7363 (and (ignore-errors (org-back-to-heading invisible-ok))
7364 (org-at-heading-p))))
7365 (or force-heading (not (org-in-item-p)))))
7366 (progn
7368 (run-hooks 'org-insert-heading-hook))
7369 (when (or force-heading (not (org-insert-item)))
7370 (let* ((empty-line-p nil)
7371 (level nil)
7372 (on-heading (org-at-heading-p))
7373 (head (save-excursion
7374 (condition-case nil
7375 (progn
7376 (org-back-to-heading invisible-ok)
7377 (when (and (not on-heading)
7378 (featurep 'org-inlinetask)
7379 (integerp org-inlinetask-min-level)
7380 (>= (length (match-string 0))
7381 org-inlinetask-min-level))
7382 ;; Find a heading level before the inline task
7383 (while (and (setq level (org-up-heading-safe))
7384 (>= level org-inlinetask-min-level)))
7385 (if (org-at-heading-p)
7386 (org-back-to-heading invisible-ok)
7387 (error "This should not happen")))
7388 (setq empty-line-p (org-previous-line-empty-p))
7389 (match-string 0))
7390 (error "*"))))
7391 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7392 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7393 pos hide-previous previous-pos)
7394 (cond
7395 ((and (org-at-heading-p) (bolp)
7396 (or (bobp)
7397 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7398 ;; insert before the current line
7399 (open-line (if blank 2 1)))
7400 ((and (bolp)
7401 (not org-insert-heading-respect-content)
7402 (or (bobp)
7403 (save-excursion
7404 (backward-char 1) (not (outline-invisible-p)))))
7405 ;; insert right here
7406 nil)
7407 (t
7408 ;; somewhere in the line
7409 (save-excursion
7410 (setq previous-pos (point-at-bol))
7411 (end-of-line)
7412 (setq hide-previous (outline-invisible-p)))
7413 (and org-insert-heading-respect-content (org-show-subtree))
7414 (let ((split
7415 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7416 (save-excursion
7417 (let ((p (point)))
7418 (goto-char (point-at-bol))
7419 (and (looking-at org-complex-heading-regexp)
7420 (match-beginning 4)
7421 (> p (match-beginning 4)))))))
7422 tags pos)
7423 (cond
7424 (org-insert-heading-respect-content
7425 (if (not (equal force-heading '(16)))
7426 (progn
7427 (org-end-of-subtree nil t)
7429 (while (and (not (bobp))
7431 (backward-delete-char 1)))
7432 (org-up-heading-safe)
7433 (org-end-of-subtree nil t))
7434 (when (featurep 'org-inlinetask)
7435 (while (and (not (eobp))
7437 (>= (length (match-string 1))
7438 org-inlinetask-min-level))
7439 (org-end-of-subtree nil t)))
7440 (or (bolp) (newline))
7441 (or (org-previous-line-empty-p)
7442 (and blank (newline)))
7443 (open-line 1))
7444 ((org-at-heading-p)
7445 (when hide-previous
7446 (show-children)
7447 (org-show-entry))
7449 (setq tags (and (match-end 2) (match-string 2)))
7450 (and (match-end 1)
7451 (delete-region (match-beginning 1) (match-end 1)))
7452 (setq pos (point-at-bol))
7453 (or split (end-of-line 1))
7454 (delete-horizontal-space)
7456 (buffer-substring (point-at-bol) (point)))
7457 (insert " "))
7458 (newline (if blank 2 1))
7459 (when tags
7460 (save-excursion
7461 (goto-char pos)
7462 (end-of-line 1)
7463 (insert " " tags)
7464 (org-set-tags nil 'align))))
7465 (t
7466 (or split (end-of-line 1))
7467 (newline (if blank 2 1)))))))
7468 (insert head) (just-one-space)
7469 (setq pos (point))
7470 (end-of-line 1)
7471 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7472 (when (and org-insert-heading-respect-content hide-previous)
7473 (save-excursion
7474 (goto-char previous-pos)
7475 (hide-subtree)))
7476 (run-hooks 'org-insert-heading-hook)))))
7478 (defun org-get-heading (&optional no-tags no-todo)
7479 "Return the heading of the current entry, without the stars.
7480 When NO-TAGS is non-nil, don't include tags.
7481 When NO-TODO is non-nil, don't include TODO keywords."
7482 (save-excursion
7483 (org-back-to-heading t)
7484 (cond
7485 ((and no-tags no-todo)
7486 (looking-at org-complex-heading-regexp)
7487 (match-string 4))
7488 (no-tags
7489 (looking-at (concat org-outline-regexp
7492 (match-string 1))
7493 (no-todo
7494 (looking-at org-todo-line-regexp)
7495 (match-string 3))
7496 (t (looking-at org-heading-regexp)
7497 (match-string 2)))))
7499 (defvar orgstruct-mode) ; defined below
7501 (defun org-heading-components ()
7502 "Return the components of the current heading.
7503 This is a list with the following elements:
7504 - the level as an integer
7505 - the reduced level, different if `org-odd-levels-only' is set.
7506 - the TODO keyword, or nil
7507 - the priority character, like ?A, or nil if no priority is given
7508 - the headline text itself, or the tags string if no headline text
7509 - the tags string, or nil."
7510 (save-excursion
7511 (org-back-to-heading t)
7512 (if (let (case-fold-search)
7513 (looking-at
7514 (if orgstruct-mode
7515 org-heading-regexp
7516 org-complex-heading-regexp)))
7517 (if orgstruct-mode
7518 (list (length (match-string 1))
7519 (org-reduced-level (length (match-string 1)))
7520 nil
7521 nil
7522 (match-string 2)
7523 nil)
7524 (list (length (match-string 1))
7525 (org-reduced-level (length (match-string 1)))
7526 (org-match-string-no-properties 2)
7527 (and (match-end 3) (aref (match-string 3) 2))
7528 (org-match-string-no-properties 4)
7529 (org-match-string-no-properties 5))))))
7531 (defun org-get-entry ()
7532 "Get the entry text, after heading, entire subtree."
7533 (save-excursion
7534 (org-back-to-heading t)
7535 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7537 (defun org-insert-heading-after-current ()
7538 "Insert a new heading with same level as current, after current subtree."
7539 (interactive)
7540 (org-back-to-heading)
7541 (org-insert-heading)
7542 (org-move-subtree-down)
7543 (end-of-line 1))
7545 (defun org-insert-heading-respect-content (invisible-ok)
7546 "Insert heading with `org-insert-heading-respect-content' set to t."
7547 (interactive "P")
7548 (let ((org-insert-heading-respect-content t))
7549 (org-insert-heading t invisible-ok)))
7551 (defun org-insert-todo-heading-respect-content (&optional force-state)
7552 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7553 (interactive "P")
7554 (let ((org-insert-heading-respect-content t))
7555 (org-insert-todo-heading force-state t)))
7557 (defun org-insert-todo-heading (arg &optional force-heading)
7558 "Insert a new heading with the same level and TODO state as current heading.
7559 If the heading has no TODO state, or if the state is DONE, use the first
7560 state (TODO by default). Also one prefix arg, force first state. With two
7561 prefix args, force inserting at the end of the parent subtree."
7562 (interactive "P")
7563 (when (or force-heading (not (org-insert-item 'checkbox)))
7564 (org-insert-heading (or (and (equal arg '(16)) '(16))
7565 force-heading))
7566 (save-excursion
7567 (org-back-to-heading)
7568 (outline-previous-heading)
7569 (looking-at org-todo-line-regexp))
7570 (let*
7571 ((new-mark-x
7572 (if (or arg
7573 (not (match-beginning 2))
7574 (member (match-string 2) org-done-keywords))
7575 (car org-todo-keywords-1)
7576 (match-string 2)))
7577 (new-mark
7578 (or
7579 (run-hook-with-args-until-success
7580 'org-todo-get-default-hook new-mark-x nil)
7581 new-mark-x)))
7582 (beginning-of-line 1)
7583 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7584 (if org-treat-insert-todo-heading-as-state-change
7585 (org-todo new-mark)
7586 (insert new-mark " "))))
7587 (when org-provide-todo-statistics
7588 (org-update-parent-todo-statistics))))
7590 (defun org-insert-subheading (arg)
7591 "Insert a new subheading and demote it.
7592 Works for outline headings and for plain lists alike."
7593 (interactive "P")
7594 (org-insert-heading arg)
7595 (cond
7596 ((org-at-heading-p) (org-do-demote))
7597 ((org-at-item-p) (org-indent-item))))
7599 (defun org-insert-todo-subheading (arg)
7600 "Insert a new subheading with TODO keyword or checkbox and demote it.
7601 Works for outline headings and for plain lists alike."
7602 (interactive "P")
7603 (org-insert-todo-heading arg)
7604 (cond
7605 ((org-at-heading-p) (org-do-demote))
7606 ((org-at-item-p) (org-indent-item))))
7608 ;;; Promotion and Demotion
7610 (defvar org-after-demote-entry-hook nil
7611 "Hook run after an entry has been demoted.
7612 The cursor will be at the beginning of the entry.
7613 When a subtree is being demoted, the hook will be called for each node.")
7615 (defvar org-after-promote-entry-hook nil
7616 "Hook run after an entry has been promoted.
7617 The cursor will be at the beginning of the entry.
7618 When a subtree is being promoted, the hook will be called for each node.")
7620 (defun org-promote-subtree ()
7621 "Promote the entire subtree.
7622 See also `org-promote'."
7623 (interactive)
7624 (save-excursion
7625 (org-with-limited-levels (org-map-tree 'org-promote)))
7626 (org-fix-position-after-promote))
7628 (defun org-demote-subtree ()
7629 "Demote the entire subtree. See `org-demote'.
7630 See also `org-promote'."
7631 (interactive)
7632 (save-excursion
7633 (org-with-limited-levels (org-map-tree 'org-demote)))
7634 (org-fix-position-after-promote))
7637 (defun org-do-promote ()
7638 "Promote the current heading higher up the tree.
7639 If the region is active in `transient-mark-mode', promote all headings
7640 in the region."
7641 (interactive)
7642 (save-excursion
7643 (if (org-region-active-p)
7644 (org-map-region 'org-promote (region-beginning) (region-end))
7645 (org-promote)))
7646 (org-fix-position-after-promote))
7648 (defun org-do-demote ()
7649 "Demote the current heading lower down the tree.
7650 If the region is active in `transient-mark-mode', demote all headings
7651 in the region."
7652 (interactive)
7653 (save-excursion
7654 (if (org-region-active-p)
7655 (org-map-region 'org-demote (region-beginning) (region-end))
7656 (org-demote)))
7657 (org-fix-position-after-promote))
7659 (defun org-fix-position-after-promote ()
7660 "Make sure that after pro/demotion cursor position is right."
7661 (let ((pos (point)))
7662 (when (save-excursion
7663 (beginning-of-line 1)
7664 (looking-at org-todo-line-regexp)
7665 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7666 (cond ((eobp) (insert " "))
7667 ((eolp) (insert " "))
7668 ((equal (char-after) ?\ ) (forward-char 1))))))
7670 (defun org-current-level ()
7671 "Return the level of the current entry, or nil if before the first headline.
7672 The level is the number of stars at the beginning of the headline."
7673 (save-excursion
7674 (org-with-limited-levels
7675 (if (ignore-errors (org-back-to-heading t))
7676 (funcall outline-level)))))
7678 (defun org-get-previous-line-level ()
7679 "Return the outline depth of the last headline before the current line.
7680 Returns 0 for the first headline in the buffer, and nil if before the
7681 first headline."
7682 (let ((current-level (org-current-level))
7683 (prev-level (when (> (line-number-at-pos) 1)
7684 (save-excursion
7685 (beginning-of-line 0)
7686 (org-current-level)))))
7687 (cond ((null current-level) nil) ; Before first headline
7688 ((null prev-level) 0) ; At first headline
7689 (prev-level))))
7691 (defun org-reduced-level (l)
7692 "Compute the effective level of a heading.
7693 This takes into account the setting of `org-odd-levels-only'."
7694 (cond
7695 ((zerop l) 0)
7696 (org-odd-levels-only (1+ (floor (/ l 2))))
7697 (t l)))
7699 (defun org-level-increment ()
7700 "Return the number of stars that will be added or removed at a
7701 time to headlines when structure editing, based on the value of
7702 `org-odd-levels-only'."
7703 (if org-odd-levels-only 2 1))
7705 (defun org-get-valid-level (level &optional change)
7706 "Rectify a level change under the influence of `org-odd-levels-only'
7707 LEVEL is a current level, CHANGE is by how much the level should be
7708 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7709 even level numbers will become the next higher odd number."
7710 (if org-odd-levels-only
7711 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7712 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7713 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7714 (max 1 (+ level (or change 0)))))
7716 (if (boundp 'define-obsolete-function-alias)
7717 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7718 (define-obsolete-function-alias 'org-get-legal-level
7719 'org-get-valid-level)
7720 (define-obsolete-function-alias 'org-get-legal-level
7721 'org-get-valid-level "23.1")))
7723 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7724 ;; ̀org-with-limited-levels'
7725 (defun org-promote ()
7726 "Promote the current heading higher up the tree.
7727 If the region is active in `transient-mark-mode', promote all headings
7728 in the region."
7729 (org-back-to-heading t)
7730 (let* ((level (save-match-data (funcall outline-level)))
7731 (after-change-functions (remove 'flyspell-after-change-function
7732 after-change-functions))
7733 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7734 (diff (abs (- level (length up-head) -1))))
7735 (cond ((and (= level 1) org-called-with-limited-levels
7736 org-allow-promoting-top-level-subtree)
7737 (replace-match "# " nil t))
7738 ((= level 1)
7739 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7740 (t (replace-match up-head nil t)))
7741 ;; Fixup tag positioning
7742 (unless (= level 1)
7743 (and org-auto-align-tags (org-set-tags nil t))
7744 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7745 (run-hooks 'org-after-promote-entry-hook)))
7747 (defun org-demote ()
7748 "Demote the current heading lower down the tree.
7749 If the region is active in `transient-mark-mode', demote all headings
7750 in the region."
7751 (org-back-to-heading t)
7752 (let* ((level (save-match-data (funcall outline-level)))
7753 (after-change-functions (remove 'flyspell-after-change-function
7754 after-change-functions))
7755 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7756 (diff (abs (- level (length down-head) -1))))
7757 (replace-match down-head nil t)
7758 ;; Fixup tag positioning
7759 (and org-auto-align-tags (org-set-tags nil t))
7760 (if org-adapt-indentation (org-fixup-indentation diff))
7761 (run-hooks 'org-after-demote-entry-hook)))
7763 (defun org-cycle-level ()
7764 "Cycle the level of an empty headline through possible states.
7765 This goes first to child, then to parent, level, then up the hierarchy.
7766 After top level, it switches back to sibling level."
7767 (interactive)
7768 (let ((org-adapt-indentation nil))
7769 (when (org-point-at-end-of-empty-headline)
7770 (setq this-command 'org-cycle-level) ; Only needed for caching
7771 (let ((cur-level (org-current-level))
7772 (prev-level (org-get-previous-line-level)))
7773 (cond
7774 ;; If first headline in file, promote to top-level.
7775 ((= prev-level 0)
7776 (loop repeat (/ (- cur-level 1) (org-level-increment))
7777 do (org-do-promote)))
7778 ;; If same level as prev, demote one.
7779 ((= prev-level cur-level)
7780 (org-do-demote))
7781 ;; If parent is top-level, promote to top level if not already.
7782 ((= prev-level 1)
7783 (loop repeat (/ (- cur-level 1) (org-level-increment))
7784 do (org-do-promote)))
7785 ;; If top-level, return to prev-level.
7786 ((= cur-level 1)
7787 (loop repeat (/ (- prev-level 1) (org-level-increment))
7788 do (org-do-demote)))
7789 ;; If less than prev-level, promote one.
7790 ((< cur-level prev-level)
7791 (org-do-promote))
7792 ;; If deeper than prev-level, promote until higher than
7793 ;; prev-level.
7794 ((> cur-level prev-level)
7795 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7796 do (org-do-promote))))
7797 t))))
7799 (defun org-map-tree (fun)
7800 "Call FUN for every heading underneath the current one."
7801 (org-back-to-heading)
7802 (let ((level (funcall outline-level)))
7803 (save-excursion
7804 (funcall fun)
7805 (while (and (progn
7806 (outline-next-heading)
7807 (> (funcall outline-level) level))
7808 (not (eobp)))
7809 (funcall fun)))))
7811 (defun org-map-region (fun beg end)
7812 "Call FUN for every heading between BEG and END."
7813 (let ((org-ignore-region t))
7814 (save-excursion
7815 (setq end (copy-marker end))
7816 (goto-char beg)
7817 (if (and (re-search-forward org-outline-regexp-bol nil t)
7818 (< (point) end))
7819 (funcall fun))
7820 (while (and (progn
7821 (outline-next-heading)
7822 (< (point) end))
7823 (not (eobp)))
7824 (funcall fun)))))
7826 (defvar org-property-end-re) ; silence byte-compiler
7827 (defun org-fixup-indentation (diff)
7828 "Change the indentation in the current entry by DIFF.
7829 However, if any line in the current entry has no indentation, or if it
7830 would end up with no indentation after the change, nothing at all is done."
7831 (save-excursion
7832 (let ((end (save-excursion (outline-next-heading)
7833 (point-marker)))
7834 (prohibit (if (> diff 0)
7837 col)
7838 (unless (save-excursion (end-of-line 1)
7839 (re-search-forward prohibit end t))
7840 (while (and (< (point) end)
7842 (goto-char (match-end 0))
7843 (setq col (current-column))
7844 (if (< diff 0) (replace-match ""))
7845 (org-indent-to-column (+ diff col))))
7846 (move-marker end nil))))
7848 (defun org-convert-to-odd-levels ()
7849 "Convert an org-mode file with all levels allowed to one with odd levels.
7850 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7851 level 5 etc."
7852 (interactive)
7853 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7854 (let ((outline-level 'org-outline-level)
7855 (org-odd-levels-only nil) n)
7856 (save-excursion
7857 (goto-char (point-min))
7859 (setq n (- (length (match-string 0)) 2))
7860 (while (>= (setq n (1- n)) 0)
7861 (org-demote))
7862 (end-of-line 1))))))
7864 (defun org-convert-to-oddeven-levels ()
7865 "Convert an org-mode file with only odd levels to one with odd/even levels.
7866 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7867 file contains a section with an even level, conversion would
7868 destroy the structure of the file. An error is signaled in this
7869 case."
7870 (interactive)
7871 (goto-char (point-min))
7872 ;; First check if there are no even levels
7874 (org-show-context t)
7875 (error "Not all levels are odd in this file. Conversion not possible"))
7876 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7877 (let ((outline-regexp org-outline-regexp)
7878 (outline-level 'org-outline-level)
7879 (org-odd-levels-only nil) n)
7880 (save-excursion
7881 (goto-char (point-min))
7883 (setq n (/ (1- (length (match-string 0))) 2))
7884 (while (>= (setq n (1- n)) 0)
7885 (org-promote))
7886 (end-of-line 1))))))
7888 (defun org-tr-level (n)
7889 "Make N odd if required."
7890 (if org-odd-levels-only (1+ (/ n 2)) n))
7892 ;;; Vertical tree motion, cutting and pasting of subtrees
7894 (defun org-move-subtree-up (&optional arg)
7895 "Move the current subtree up past ARG headlines of the same level."
7896 (interactive "p")
7897 (org-move-subtree-down (- (prefix-numeric-value arg))))
7899 (defun org-move-subtree-down (&optional arg)
7900 "Move the current subtree down past ARG headlines of the same level."
7901 (interactive "p")
7902 (setq arg (prefix-numeric-value arg))
7903 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7904 'org-get-last-sibling))
7905 (ins-point (make-marker))
7906 (cnt (abs arg))
7907 (col (current-column))
7908 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7909 ;; Select the tree
7910 (org-back-to-heading)
7911 (setq beg0 (point))
7912 (save-excursion
7913 (setq ne-beg (org-back-over-empty-lines))
7914 (setq beg (point)))
7915 (save-match-data
7916 (save-excursion (outline-end-of-heading)
7917 (setq folded (outline-invisible-p)))
7918 (outline-end-of-subtree))
7919 (outline-next-heading)
7920 (setq ne-end (org-back-over-empty-lines))
7921 (setq end (point))
7922 (goto-char beg0)
7923 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7924 ;; include less whitespace
7925 (save-excursion
7926 (goto-char beg)
7927 (forward-line (- ne-beg ne-end))
7928 (setq beg (point))))
7929 ;; Find insertion point, with error handling
7930 (while (> cnt 0)
7931 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7932 (progn (goto-char beg0)
7933 (user-error "Cannot move past superior level or buffer limit")))
7934 (setq cnt (1- cnt)))
7935 (if (> arg 0)
7936 ;; Moving forward - still need to move over subtree
7937 (progn (org-end-of-subtree t t)
7938 (save-excursion
7939 (org-back-over-empty-lines)
7940 (or (bolp) (newline)))))
7941 (setq ne-ins (org-back-over-empty-lines))
7942 (move-marker ins-point (point))
7943 (setq txt (buffer-substring beg end))
7944 (org-save-markers-in-region beg end)
7945 (delete-region beg end)
7946 (org-remove-empty-overlays-at beg)
7947 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7948 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7950 (let ((bbb (point)))
7951 (insert-before-markers txt)
7952 (org-reinstall-markers-in-region bbb)
7953 (move-marker ins-point bbb))
7955 (setq ins-end (point))
7956 (goto-char ins-point)
7957 (org-skip-whitespace)
7958 (when (and (< arg 0)
7959 (org-first-sibling-p)
7960 (> ne-ins ne-beg))
7961 ;; Move whitespace back to beginning
7962 (save-excursion
7963 (goto-char ins-end)
7964 (let ((kill-whole-line t))
7965 (kill-line (- ne-ins ne-beg)) (point)))
7967 (move-marker ins-point nil)
7968 (if folded
7969 (hide-subtree)
7970 (org-show-entry)
7971 (show-children)
7972 (org-cycle-hide-drawers 'children))
7973 (org-clean-visibility-after-subtree-move)
7974 ;; move back to the initial column we were at
7975 (move-to-column col)))
7977 (defvar org-subtree-clip ""
7978 "Clipboard for cut and paste of subtrees.
7979 This is actually only a copy of the kill, because we use the normal kill
7980 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7982 (defvar org-subtree-clip-folded nil
7983 "Was the last copied subtree folded?
7984 This is used to fold the tree back after pasting.")
7986 (defun org-cut-subtree (&optional n)
7987 "Cut the current subtree into the clipboard.
7988 With prefix arg N, cut this many sequential subtrees.
7989 This is a short-hand for marking the subtree and then cutting it."
7990 (interactive "p")
7991 (org-copy-subtree n 'cut))
7993 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
7994 "Cut the current subtree into the clipboard.
7995 With prefix arg N, cut this many sequential subtrees.
7996 This is a short-hand for marking the subtree and then copying it.
7997 If CUT is non-nil, actually cut the subtree.
7998 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7999 of some markers in the region, even if CUT is non-nil. This is
8000 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8001 (interactive "p")
8002 (let (beg end folded (beg0 (point)))
8003 (if (org-called-interactively-p 'any)
8004 (org-back-to-heading nil) ; take what looks like a subtree
8005 (org-back-to-heading t)) ; take what is really there
8006 (setq beg (point))
8008 (save-match-data
8009 (if nosubtrees
8010 (outline-next-heading)
8011 (save-excursion (outline-end-of-heading)
8012 (setq folded (outline-invisible-p)))
8013 (condition-case nil
8014 (org-forward-heading-same-level (1- n) t)
8015 (error nil))
8016 (org-end-of-subtree t t)))
8017 (setq end (point))
8018 (goto-char beg0)
8019 (when (> end beg)
8020 (setq org-subtree-clip-folded folded)
8021 (when (or cut force-store-markers)
8022 (org-save-markers-in-region beg end))
8023 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8024 (setq org-subtree-clip (current-kill 0))
8025 (message "%s: Subtree(s) with %d characters"
8026 (if cut "Cut" "Copied")
8027 (length org-subtree-clip)))))
8029 (defun org-paste-subtree (&optional level tree for-yank)
8030 "Paste the clipboard as a subtree, with modification of headline level.
8031 The entire subtree is promoted or demoted in order to match a new headline
8032 level.
8034 If the cursor is at the beginning of a headline, the same level as
8035 that headline is used to paste the tree.
8037 If not, the new level is derived from the *visible* headings
8038 before and after the insertion point, and taken to be the inferior headline
8039 level of the two. So if the previous visible heading is level 3 and the
8040 next is level 4 (or vice versa), level 4 will be used for insertion.
8041 This makes sure that the subtree remains an independent subtree and does
8042 not swallow low level entries.
8044 You can also force a different level, either by using a numeric prefix
8045 argument, or by inserting the heading marker by hand. For example, if the
8048 If optional TREE is given, use this text instead of the kill ring.
8050 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8051 move back over whitespace before inserting, and move point to the end of
8052 the inserted text when done."
8053 (interactive "P")
8054 (setq tree (or tree (and kill-ring (current-kill 0))))
8055 (unless (org-kill-is-subtree-p tree)
8056 (error "%s"
8057 (substitute-command-keys
8059 (org-with-limited-levels
8060 (let* ((visp (not (outline-invisible-p)))
8061 (txt tree)
8063 (old-level (if (string-match org-outline-regexp-bol txt)
8064 (- (match-end 0) (match-beginning 0) 1)
8065 -1))
8066 (force-level (cond (level (prefix-numeric-value level))
8068 (string-match
8070 (point-at-bol) (point))))
8071 (- (match-end 1) (match-beginning 1)))
8072 ((and (bolp)
8073 (looking-at org-outline-regexp))
8074 (- (match-end 0) (point) 1))))
8075 (previous-level (save-excursion
8076 (condition-case nil
8077 (progn
8078 (outline-previous-visible-heading 1)
8079 (if (looking-at ^re_)
8080 (- (match-end 0) (match-beginning 0) 1)
8081 1))
8082 (error 1))))
8083 (next-level (save-excursion
8084 (condition-case nil
8085 (progn
8086 (or (looking-at org-outline-regexp)
8087 (outline-next-visible-heading 1))
8088 (if (looking-at ^re_)
8089 (- (match-end 0) (match-beginning 0) 1)
8090 1))
8091 (error 1))))
8092 (new-level (or force-level (max previous-level next-level)))
8093 (shift (if (or (= old-level -1)
8094 (= new-level -1)
8095 (= old-level new-level))
8096 0
8097 (- new-level old-level)))
8098 (delta (if (> shift 0) -1 1))
8099 (func (if (> shift 0) 'org-demote 'org-promote))
8100 (org-odd-levels-only nil)
8101 beg end newend)
8102 ;; Remove the forced level indicator
8103 (if force-level
8104 (delete-region (point-at-bol) (point)))
8105 ;; Paste
8106 (beginning-of-line (if (bolp) 1 2))
8107 (setq beg (point))
8108 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8109 (insert-before-markers txt)
8111 (setq newend (point))
8112 (org-reinstall-markers-in-region beg)
8113 (setq end (point))
8114 (goto-char beg)
8116 (setq beg (point))
8117 (if (and (outline-invisible-p) visp)
8118 (save-excursion (outline-show-heading)))
8119 ;; Shift if necessary
8120 (unless (= shift 0)
8121 (save-restriction
8122 (narrow-to-region beg end)
8123 (while (not (= shift 0))
8124 (org-map-region func (point-min) (point-max))
8125 (setq shift (+ delta shift)))
8126 (goto-char (point-min))
8127 (setq newend (point-max))))
8128 (when (or (org-called-interactively-p 'interactive) for-yank)
8129 (message "Clipboard pasted as level %d subtree" new-level))
8130 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8131 kill-ring
8132 (eq org-subtree-clip (current-kill 0))
8133 org-subtree-clip-folded)
8134 ;; The tree was folded before it was killed/copied
8135 (hide-subtree))
8136 (and for-yank (goto-char newend)))))
8138 (defun org-kill-is-subtree-p (&optional txt)
8139 "Check if the current kill is an outline subtree, or a set of trees.
8140 Returns nil if kill does not start with a headline, or if the first
8141 headline level is not the largest headline level in the tree.
8142 So this will actually accept several entries of equal levels as well,
8143 which is OK for `org-paste-subtree'.
8144 If optional TXT is given, check this string instead of the current kill."
8145 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8146 (re (org-get-limited-outline-regexp))
8147 (^re (concat "^" re))
8148 (start-level (and kill
8149 (string-match
8151 kill)
8152 (- (match-end 2) (match-beginning 2) 1)))
8153 (start (1+ (or (match-beginning 2) -1))))
8154 (if (not start-level)
8155 (progn
8156 nil) ;; does not even start with a heading
8157 (catch 'exit
8158 (while (setq start (string-match ^re kill (1+ start)))
8159 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8160 (throw 'exit nil)))
8161 t))))
8163 (defvar org-markers-to-move nil
8164 "Markers that should be moved with a cut-and-paste operation.
8165 Those markers are stored together with their positions relative to
8166 the start of the region.")
8168 (defun org-save-markers-in-region (beg end)
8169 "Check markers in region.
8170 If these markers are between BEG and END, record their position relative
8171 to BEG, so that after moving the block of text, we can put the markers back
8172 into place.
8173 This function gets called just before an entry or tree gets cut from the
8174 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8175 called immediately, to move the markers with the entries."
8176 (setq org-markers-to-move nil)
8177 (when (featurep 'org-clock)
8178 (org-clock-save-markers-for-cut-and-paste beg end))
8179 (when (featurep 'org-agenda)
8180 (org-agenda-save-markers-for-cut-and-paste beg end)))
8182 (defun org-check-and-save-marker (marker beg end)
8183 "Check if MARKER is between BEG and END.
8184 If yes, remember the marker and the distance to BEG."
8185 (when (and (marker-buffer marker)
8186 (equal (marker-buffer marker) (current-buffer)))
8187 (if (and (>= marker beg) (< marker end))
8188 (push (cons marker (- marker beg)) org-markers-to-move))))
8190 (defun org-reinstall-markers-in-region (beg)
8191 "Move all remembered markers to their position relative to BEG."
8192 (mapc (lambda (x)
8193 (move-marker (car x) (+ beg (cdr x))))
8194 org-markers-to-move)
8195 (setq org-markers-to-move nil))
8197 (defun org-narrow-to-subtree ()
8198 "Narrow buffer to the current subtree."
8199 (interactive)
8200 (save-excursion
8201 (save-match-data
8202 (org-with-limited-levels
8203 (narrow-to-region
8204 (progn (org-back-to-heading t) (point))
8205 (progn (org-end-of-subtree t t)
8206 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8207 (point)))))))
8209 (defun org-narrow-to-block ()
8210 "Narrow buffer to the current block."
8211 (interactive)
8212 (let* ((case-fold-search t)
8215 (if blockp
8216 (narrow-to-region (car blockp) (cdr blockp))
8217 (error "Not in a block"))))
8219 (eval-when-compile
8220 (defvar org-property-drawer-re))
8222 (defvar org-property-start-re) ;; defined below
8223 (defun org-clone-subtree-with-time-shift (n &optional shift)
8224 "Clone the task (subtree) at point N times.
8225 The clones will be inserted as siblings.
8227 In interactive use, the user will be prompted for the number of
8228 clones to be produced, and for a time SHIFT, which may be a
8229 repeater as used in time stamps, for example `+3d'.
8231 When a valid repeater is given and the entry contains any time
8232 stamps, the clones will become a sequence in time, with time
8233 stamps in the subtree shifted for each clone produced. If SHIFT
8234 is nil or the empty string, time stamps will be left alone. The
8235 ID property of the original subtree is removed.
8237 If the original subtree did contain time stamps with a repeater,
8238 the following will happen:
8239 - the repeater will be removed in each clone
8240 - an additional clone will be produced, with the current, unshifted
8241 date(s) in the entry.
8242 - the original entry will be placed *after* all the clones, with
8243 repeater intact.
8244 - the start days in the repeater in the original entry will be shifted
8245 to past the last clone.
8246 In this way you can spell out a number of instances of a repeating task,
8247 and still retain the repeater to cover future instances of the task."
8248 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
8249 (let (beg end template task idprop
8250 shift-n shift-what doshift nmin nmax (n-no-remove -1)
8251 (drawer-re org-drawer-regexp))
8252 (if (not (and (integerp n) (> n 0)))
8253 (error "Invalid number of replications %s" n))
8256 shift)))
8257 (error "Invalid shift specification %s" shift))
8258 (when doshift
8259 (setq shift-n (string-to-number (match-string 1 shift))
8260 shift-what (cdr (assoc (match-string 2 shift)
8261 '(("d" . day) ("w" . week)
8262 ("m" . month) ("y" . year))))))
8263 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8264 (setq nmin 1 nmax n)
8265 (org-back-to-heading t)
8266 (setq beg (point))
8267 (setq idprop (org-entry-get nil "ID"))
8268 (org-end-of-subtree t t)
8270 (setq end (point))
8271 (setq template (buffer-substring beg end))
8272 (when (and doshift
8274 (delete-region beg end)
8275 (setq end beg)
8276 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8277 (goto-char end)
8278 (loop for n from nmin to nmax do
8279 ;; prepare clone
8280 (with-temp-buffer
8281 (insert template)
8282 (org-mode)
8283 (goto-char (point-min))
8284 (org-show-subtree)
8285 (and idprop (if org-clone-delete-id
8286 (org-entry-delete nil "ID")
8287 (org-id-get-create t)))
8288 (unless (= n 0)
8290 (kill-whole-line))
8291 (goto-char (point-min))
8292 (while (re-search-forward drawer-re nil t)
8293 (mapc (lambda (d)
8294 (org-remove-empty-drawer-at d (point))) org-drawers)))
8295 (goto-char (point-min))
8296 (when doshift
8297 (while (re-search-forward org-ts-regexp-both nil t)
8298 (org-timestamp-change (* n shift-n) shift-what))
8299 (unless (= n n-no-remove)
8300 (goto-char (point-min))
8301 (while (re-search-forward org-ts-regexp nil t)
8302 (save-excursion
8303 (goto-char (match-beginning 0))
8305 (delete-region (match-beginning 1) (match-end 1)))))))
8306 (setq task (buffer-string)))
8307 (insert task))
8308 (goto-char beg)))
8310 ;;; Outline Sorting
8312 (defun org-sort (with-case)
8313 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8314 Optional argument WITH-CASE means sort case-sensitively."
8315 (interactive "P")
8316 (cond
8317 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8318 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8319 (t
8320 (org-call-with-arg 'org-sort-entries with-case))))
8322 (defun org-sort-remove-invisible (s)
8323 "Remove invisible links from string S."
8324 (remove-text-properties 0 (length s) org-rm-props s)
8325 (while (string-match org-bracket-link-regexp s)
8326 (setq s (replace-match (if (match-end 2)
8327 (match-string 3 s)
8328 (match-string 1 s)) t t s)))
8329 (let ((st (format " %s " s)))
8330 (while (string-match org-emph-re st)
8331 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8332 (setq s (substring st 1 -1)))
8333 s)
8335 (defvar org-priority-regexp) ; defined later in the file
8337 (defvar org-after-sorting-entries-or-items-hook nil
8338 "Hook that is run after a bunch of entries or items have been sorted.
8339 When children are sorted, the cursor is in the parent line when this
8340 hook gets called. When a region or a plain list is sorted, the cursor
8341 will be in the first entry of the sorted region/list.")
8343 (defun org-sort-entries
8344 (&optional with-case sorting-type getkey-func compare-func property)
8345 "Sort entries on a certain level of an outline tree.
8346 If there is an active region, the entries in the region are sorted.
8347 Else, if the cursor is before the first entry, sort the top-level items.
8348 Else, the children of the entry at point are sorted.
8350 Sorting can be alphabetically, numerically, by date/time as given by
8351 a time stamp, by a property, by priority order, or by a custom function.
8353 The command prompts for the sorting type unless it has been given to the
8354 function through the SORTING-TYPE argument, which needs to be a character,
8355 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8356 precise meaning of each character:
8358 n Numerically, by converting the beginning of the entry/item to a number.
8359 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8360 o By order of TODO keywords.
8361 t By date/time, either the first active time stamp in the entry, or, if
8362 none exist, by the first inactive one.
8363 s By the scheduled date/time.
8364 d By deadline date/time.
8365 c By creation time, which is assumed to be the first inactive time stamp
8366 at the beginning of a line.
8367 p By priority according to the cookie.
8368 r By the value of a property.
8370 Capital letters will reverse the sort order.
8372 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8373 called with point at the beginning of the record. It must return either
8374 a string or a number that should serve as the sorting key for that record.
8376 Comparing entries ignores case by default. However, with an optional argument
8377 WITH-CASE, the sorting considers case as well.
8379 Sorting is done against the visible part of the headlines, it ignores hidden
8380 links."
8381 (interactive "P")
8382 (let ((case-func (if with-case 'identity 'downcase))
8383 (cmstr
8384 ;; The clock marker is lost when using `sort-subr', let's
8385 ;; store the clocking string.
8386 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8387 (save-excursion
8388 (goto-char org-clock-marker)
8389 (looking-back "^.*") (match-string-no-properties 0))))
8390 start beg end stars re re2
8391 txt what tmp)
8392 ;; Find beginning and end of region to sort
8393 (cond
8394 ((org-region-active-p)
8395 ;; we will sort the region
8396 (setq end (region-end)
8397 what "region")
8398 (goto-char (region-beginning))
8399 (if (not (org-at-heading-p)) (outline-next-heading))
8400 (setq start (point)))
8401 ((or (org-at-heading-p)
8402 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8403 ;; we will sort the children of the current headline
8404 (org-back-to-heading)
8405 (setq start (point)
8406 end (progn (org-end-of-subtree t t)
8408 (org-back-over-empty-lines)
8409 (point))
8410 what "children")
8411 (goto-char start)
8412 (show-subtree)
8413 (outline-next-heading))
8414 (t
8415 ;; we will sort the top-level entries in this file
8416 (goto-char (point-min))
8417 (or (org-at-heading-p) (outline-next-heading))
8418 (setq start (point))
8419 (goto-char (point-max))
8420 (beginning-of-line 1)
8422 ;; File ends in a non-white line
8423 (end-of-line 1)
8425 (setq end (point-max))
8426 (setq what "top-level")
8427 (goto-char start)
8428 (show-all)))
8430 (setq beg (point))
8431 (if (>= beg end) (error "Nothing to sort"))
8434 (setq stars (match-string 1)
8435 re (concat "^" (regexp-quote stars) " +")
8437 txt (buffer-substring beg end))
8439 (if (and (not (equal stars "*")) (string-match re2 txt))
8440 (error "Region to sort contains a level above the first entry"))
8442 (unless sorting-type
8443 (message
8444 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8446 A/N/P/R/O/F/T/S/D/C means reversed:"
8447 what)
8448 (setq sorting-type (read-char-exclusive))
8450 (unless getkey-func
8451 (and (= (downcase sorting-type) ?f)
8452 (setq getkey-func
8453 (org-icompleting-read "Sort using function: "
8454 obarray 'fboundp t nil nil))
8455 (setq getkey-func (intern getkey-func))))
8457 (and (= (downcase sorting-type) ?r)
8458 (not property)
8459 (setq property
8460 (org-icompleting-read "Property: "
8461 (mapcar 'list (org-buffer-property-keys t))
8462 nil t))))
8464 (message "Sorting entries...")
8466 (save-restriction
8467 (narrow-to-region start end)
8468 (let ((dcst (downcase sorting-type))
8469 (case-fold-search nil)
8470 (now (current-time)))
8471 (sort-subr
8472 (/= dcst sorting-type)
8473 ;; This function moves to the beginning character of the "record" to
8474 ;; be sorted.
8475 (lambda nil
8476 (if (re-search-forward re nil t)
8477 (goto-char (match-beginning 0))
8478 (goto-char (point-max))))
8479 ;; This function moves to the last character of the "record" being
8480 ;; sorted.
8481 (lambda nil
8482 (save-match-data
8483 (condition-case nil
8484 (outline-forward-same-level 1)
8485 (error
8486 (goto-char (point-max))))))
8487 ;; This function returns the value that gets sorted against.
8488 (lambda nil
8489 (cond
8490 ((= dcst ?n)
8491 (if (looking-at org-complex-heading-regexp)
8492 (string-to-number (org-sort-remove-invisible (match-string 4)))
8493 nil))
8494 ((= dcst ?a)
8495 (if (looking-at org-complex-heading-regexp)
8496 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8497 nil))
8498 ((= dcst ?t)
8499 (let ((end (save-excursion (outline-next-heading) (point))))
8500 (if (or (re-search-forward org-ts-regexp end t)
8501 (re-search-forward org-ts-regexp-both end t))
8502 (org-time-string-to-seconds (match-string 0))
8503 (org-float-time now))))
8504 ((= dcst ?c)
8505 (let ((end (save-excursion (outline-next-heading) (point))))
8506 (if (re-search-forward
8508 end t)
8509 (org-time-string-to-seconds (match-string 0))
8510 (org-float-time now))))
8511 ((= dcst ?s)
8512 (let ((end (save-excursion (outline-next-heading) (point))))
8513 (if (re-search-forward org-scheduled-time-regexp end t)
8514 (org-time-string-to-seconds (match-string 1))
8515 (org-float-time now))))
8516 ((= dcst ?d)
8517 (let ((end (save-excursion (outline-next-heading) (point))))
8518 (if (re-search-forward org-deadline-time-regexp end t)
8519 (org-time-string-to-seconds (match-string 1))
8520 (org-float-time now))))
8521 ((= dcst ?p)
8522 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8523 (string-to-char (match-string 2))
8524 org-default-priority))
8525 ((= dcst ?r)
8526 (or (org-entry-get nil property) ""))
8527 ((= dcst ?o)
8528 (if (looking-at org-complex-heading-regexp)
8529 (- 9999 (length (member (match-string 2)
8530 org-todo-keywords-1)))))
8531 ((= dcst ?f)
8532 (if getkey-func
8533 (progn
8534 (setq tmp (funcall getkey-func))
8535 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8536 tmp)
8537 (error "Invalid key function `%s'" getkey-func)))
8538 (t (error "Invalid sorting type `%c'" sorting-type))))
8539 nil
8540 (cond
8541 ((= dcst ?a) 'string<)
8542 ((= dcst ?f) compare-func)
8543 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8544 (run-hooks 'org-after-sorting-entries-or-items-hook)
8545 ;; Reset the clock marker if needed
8546 (when cmstr
8547 (save-excursion
8548 (goto-char start)
8549 (search-forward cmstr nil t)
8550 (move-marker org-clock-marker (point))))
8551 (message "Sorting entries...done")))
8553 (defun org-do-sort (table what &optional with-case sorting-type)
8554 "Sort TABLE of WHAT according to SORTING-TYPE.
8555 The user will be prompted for the SORTING-TYPE if the call to this
8556 function does not specify it. WHAT is only for the prompt, to indicate
8557 what is being sorted. The sorting key will be extracted from
8558 the car of the elements of the table.
8559 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8560 (unless sorting-type
8561 (message
8562 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8563 what)
8564 (setq sorting-type (read-char-exclusive)))
8565 (let ((dcst (downcase sorting-type))
8566 extractfun comparefun)
8567 ;; Define the appropriate functions
8568 (cond
8569 ((= dcst ?n)
8570 (setq extractfun 'string-to-number
8571 comparefun (if (= dcst sorting-type) '< '>)))
8572 ((= dcst ?a)
8573 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8574 (lambda(x) (downcase (org-sort-remove-invisible x))))
8575 comparefun (if (= dcst sorting-type)
8576 'string<
8577 (lambda (a b) (and (not (string< a b))
8578 (not (string= a b)))))))
8579 ((= dcst ?t)
8580 (setq extractfun
8581 (lambda (x)
8582 (if (or (string-match org-ts-regexp x)
8583 (string-match org-ts-regexp-both x))
8584 (org-float-time
8585 (org-time-string-to-time (match-string 0 x)))
8586 0))
8587 comparefun (if (= dcst sorting-type) '< '>)))
8588 (t (error "Invalid sorting type `%c'" sorting-type)))
8590 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8591 table)
8592 (lambda (a b) (funcall comparefun (car a) (car b))))))
8595 ;;; The orgstruct minor mode
8597 ;; Define a minor mode which can be used in other modes in order to
8598 ;; integrate the org-mode structure editing commands.
8600 ;; This is really a hack, because the org-mode structure commands use
8601 ;; keys which normally belong to the major mode. Here is how it
8602 ;; works: The minor mode defines all the keys necessary to operate the
8603 ;; structure commands, but wraps the commands into a function which
8604 ;; tests if the cursor is currently at a headline or a plain list
8605 ;; item. If that is the case, the structure command is used,
8606 ;; temporarily setting many Org-mode variables like regular
8607 ;; expressions for filling etc. However, when any of those keys is
8608 ;; used at a different location, function uses `key-binding' to look
8609 ;; up if the key has an associated command in another currently active
8610 ;; keymap (minor modes, major mode, global), and executes that
8611 ;; command. There might be problems if any of the keys is otherwise
8612 ;; used as a prefix key.
8614 (defcustom orgstruct-heading-prefix-regexp ""
8615 "Regexp that matches the custom prefix of Org headlines in
8616 orgstruct(++)-mode."
8617 :group 'org
8618 :type 'string)
8619 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8621 (defcustom orgstruct-setup-hook nil
8622 "Hook run after orgstruct-mode-map is filled."
8623 :group 'org
8624 :type 'hook)
8626 (defvar orgstruct-initialized nil)
8628 (defvar org-local-vars nil
8629 "List of local variables, for use by `orgstruct-mode'.")
8631 ;;;###autoload
8632 (define-minor-mode orgstruct-mode
8633 "Toggle the minor mode `orgstruct-mode'.
8634 This mode is for using Org-mode structure commands in other
8635 modes. The following keys behave as if Org-mode were active, if
8636 the cursor is on a headline, or on a plain list item (both as
8637 defined by Org-mode)."
8638 nil " OrgStruct" (make-sparse-keymap)
8639 (when orgstruct-mode
8640 (org-load-modules-maybe)
8641 (unless orgstruct-initialized
8642 (orgstruct-setup)
8643 (setq orgstruct-initialized t))))
8645 ;;;###autoload
8646 (defun turn-on-orgstruct ()
8647 "Unconditionally turn on `orgstruct-mode'."
8648 (orgstruct-mode 1))
8650 (defvar org-fb-vars nil)
8651 (make-variable-buffer-local 'org-fb-vars)
8652 (defun orgstruct++-mode (&optional arg)
8653 "Toggle `orgstruct-mode', the enhanced version of it.
8654 In addition to setting orgstruct-mode, this also exports all
8655 indentation and autofilling variables from org-mode into the
8656 buffer. It will also recognize item context in multiline items."
8657 (interactive "P")
8658 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8659 (if (< arg 1)
8660 (progn (orgstruct-mode -1)
8661 (mapc (lambda(v)
8662 (org-set-local (car v)
8663 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8664 org-fb-vars))
8665 (orgstruct-mode 1)
8666 (setq org-fb-vars nil)
8667 (let (var val)
8668 (mapc
8669 (lambda (x)
8670 (when (string-match
8672 (symbol-name (car x)))
8673 (setq var (car x) val (nth 1 x))
8674 (push (list var `(quote ,(eval var))) org-fb-vars)
8675 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8676 org-local-vars)
8677 (org-set-local 'orgstruct-is-++ t))))
8679 (defvar orgstruct-is-++ nil
8680 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8681 (make-variable-buffer-local 'orgstruct-is-++)
8683 ;;;###autoload
8684 (defun turn-on-orgstruct++ ()
8685 "Unconditionally turn on `orgstruct++-mode'."
8686 (orgstruct++-mode 1))
8688 (defun orgstruct-error ()
8689 "Error when there is no default binding for a structure key."
8690 (interactive)
8691 (error "This key has no function outside structure elements"))
8693 (defun orgstruct-setup ()
8694 "Setup orgstruct keymap."
8695 (dolist (f
8696 '("org-meta"
8697 "org-shift"
8698 "org-shiftmeta"
8699 org-shifttab
8700 org-backward-element
8701 org-backward-heading-same-level
8702 org-ctrl-c-ret
8703 org-cycle
8704 org-forward-heading-same-level
8705 org-insert-heading
8706 org-insert-heading-respect-content
8707 org-kill-note-or-show-branches
8708 org-mark-subtree
8709 org-narrow-to-subtree
8710 org-promote-subtree
8711 org-reveal
8712 org-show-subtree
8713 org-sort
8714 org-up-element
8715 outline-demote
8716 outline-next-visible-heading
8717 outline-previous-visible-heading
8718 outline-promote
8719 outline-up-heading
8720 show-children))
8721 (dolist (f (if (stringp f)
8722 (let ((flist))
8723 (dolist (postfix
8724 '("-return" "tab" "left" "right" "up" "down")
8725 flist)
8726 (let ((f (intern (concat f postfix))))
8727 (when (fboundp f)
8728 (push f flist)))))
8729 (list f)))
8730 (dolist (binding (nconc (where-is-internal f org-mode-map)
8731 (where-is-internal f outline-mode-map)))
8732 ;; TODO use local-function-key-map
8733 (dolist (rep '(("<tab>" . "TAB")
8734 ("<return>" . "RET")
8735 ("<escape>" . "ESC")
8736 ("<delete>" . "DEL")))
8737 (setq binding (read-kbd-macro (replace-regexp-in-string
8738 (regexp-quote (car rep))
8739 (cdr rep)
8740 (key-description binding)))))
8741 (let ((key (lookup-key orgstruct-mode-map binding)))
8742 (when (or (not key) (numberp key))
8743 (condition-case nil
8744 (org-defkey orgstruct-mode-map
8745 binding
8746 (orgstruct-make-binding f binding))
8747 (error nil)))))))
8748 (run-hooks 'orgstruct-setup-hook))
8750 (defun orgstruct-make-binding (fun key)
8751 "Create a function for binding in the structure minor mode.
8752 FUN is the command to call inside a table. KEY is the key that
8753 should be checked in for a command to execute outside of tables."
8754 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8755 (let ((nname name)
8756 (i 0))
8757 (while (fboundp (intern nname))
8758 (setq nname (format "%s-%d" name (setq i (1+ i)))))
8759 (setq name (intern nname)))
8760 (eval
8761 `(defun ,name (arg)
8763 "Outside of structure, run the binding of `"
8764 (key-description key) "'.")
8765 (interactive "p")
8766 (unless
8767 (let* ((org-heading-regexp
8768 (concat "^"
8769 orgstruct-heading-prefix-regexp
8771 (org-outline-regexp
8773 (org-outline-regexp-bol
8774 (concat "^" org-outline-regexp))
8775 (outline-regexp org-outline-regexp)
8777 (outline-level 'outline-level)
8778 (outline-heading-alist))
8779 (when (org-context-p 'headline 'item
8780 ,(when (memq fun '(org-insert-heading))
8781 '(when orgstruct-is-++
8782 'item-body)))
8783 (org-run-like-in-org-mode ',fun)
8784 t))
8785 (let* ((orgstruct-mode)
8786 (binding (key-binding ,key)))
8787 (if (keymapp binding)
8788 (set-temporary-overlay-map binding)
8789 (call-interactively
8790 (or binding 'orgstruct-error)))))))
8791 name))
8793 (defun org-contextualize-keys (alist contexts)
8794 "Return valid elements in ALIST depending on CONTEXTS.
8796 `org-agenda-custom-commands' or `org-capture-templates' are the
8797 values used for ALIST, and `org-agenda-custom-commands-contexts'
8798 or `org-capture-templates-contexts' are the associated contexts
8799 definitions."
8800 (let ((contexts
8801 ;; normalize contexts
8802 (mapcar
8803 (lambda(c) (cond ((listp (cadr c))
8804 (list (car c) (car c) (cadr c)))
8805 ((string= "" (cadr c))
8806 (list (car c) (car c) (caddr c)))
8807 (t c))) contexts))
8808 (a alist) c r s)
8809 ;; loop over all commands or templates
8810 (while (setq c (pop a))
8811 (let (vrules repl)
8812 (cond
8813 ((not (assoc (car c) contexts))
8814 (push c r))
8815 ((and (assoc (car c) contexts)
8816 (setq vrules (org-contextualize-validate-key
8817 (car c) contexts)))
8818 (mapc (lambda (vr)
8819 (when (not (equal (car vr) (cadr vr)))
8820 (setq repl vr))) vrules)
8821 (if (not repl) (push c r)
8822 (push (cadr repl) s)
8823 (push
8824 (cons (car c)
8825 (cdr (or (assoc (cadr repl) alist)
8826 (error "Undefined key `%s' as contextual replacement for `%s'"
8827 (cadr repl) (car c)))))
8828 r))))))
8829 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8830 (delq
8831 nil
8832 (delete-dups
8833 (mapcar (lambda (x)
8834 (let ((tpl (car x)))
8835 (when (not (delq
8836 nil
8837 (mapcar (lambda(y)
8838 (equal y tpl)) s))) x)))
8839 (reverse r))))))
8841 (defun org-contextualize-validate-key (key contexts)
8842 "Check CONTEXTS for agenda or capture KEY."
8843 (let (r rr res)
8844 (while (setq r (pop contexts))
8845 (mapc
8846 (lambda (rr)
8847 (when
8848 (and (equal key (car r))
8849 (if (functionp rr) (funcall rr)
8850 (or (and (eq (car rr) 'in-file)
8851 (buffer-file-name)
8852 (string-match (cdr rr) (buffer-file-name)))
8853 (and (eq (car rr) 'in-mode)
8854 (string-match (cdr rr) (symbol-name major-mode)))
8855 (and (eq (car rr) 'in-buffer)
8856 (string-match (cdr rr) (buffer-name)))
8857 (when (and (eq (car rr) 'not-in-file)
8858 (buffer-file-name))
8859 (not (string-match (cdr rr) (buffer-file-name))))
8860 (when (eq (car rr) 'not-in-mode)
8861 (not (string-match (cdr rr) (symbol-name major-mode))))
8862 (when (eq (car rr) 'not-in-buffer)
8863 (not (string-match (cdr rr) (buffer-name)))))))
8864 (push r res)))
8865 (car (last r))))
8866 (delete-dups (delq nil res))))
8868 (defun org-context-p (&rest contexts)
8869 "Check if local context is any of CONTEXTS.
8870 Possible values in the list of contexts are `table', `headline', and `item'."
8871 (let ((pos (point)))
8872 (goto-char (point-at-bol))
8873 (prog1 (or (and (memq 'table contexts)
8875 (and (memq 'headline contexts)
8876 (looking-at org-outline-regexp))
8877 (and (memq 'item contexts)
8879 (and (memq 'item-body contexts)
8880 (org-in-item-p)))
8881 (goto-char pos))))
8883 (defun org-get-local-variables ()
8884 "Return a list of all local variables in an Org mode buffer."
8885 (let (varlist)
8886 (with-current-buffer (get-buffer-create "*Org tmp*")
8887 (erase-buffer)
8888 (org-mode)
8889 (setq varlist (buffer-local-variables)))
8890 (kill-buffer "*Org tmp*")
8891 (delq nil
8892 (mapcar
8893 (lambda (x)
8894 (setq x
8895 (if (symbolp x)
8896 (list x)
8897 (list (car x) (cdr x))))
8898 (if (and (not (get (car x) 'org-state))
8899 (string-match
8900 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8901 (symbol-name (car x))))
8902 x nil))
8903 varlist))))
8905 (defun org-clone-local-variables (from-buffer &optional regexp)
8906 "Clone local variables from FROM-BUFFER.
8907 Optional argument REGEXP selects variables to clone."
8908 (mapc
8909 (lambda (pair)
8910 (and (symbolp (car pair))
8911 (or (null regexp)
8912 (string-match regexp (symbol-name (car pair))))
8913 (set (make-local-variable (car pair))
8914 (cdr pair))))
8915 (buffer-local-variables from-buffer)))
8917 ;;;###autoload
8918 (defun org-run-like-in-org-mode (cmd)
8919 "Run a command, pretending that the current buffer is in Org-mode.
8920 This will temporarily bind local variables that are typically bound in
8921 Org-mode to the values they have in Org-mode, and then interactively
8922 call CMD."
8923 (org-load-modules-maybe)
8924 (unless org-local-vars
8925 (setq org-local-vars (org-get-local-variables)))
8926 (let (binds)
8927 (dolist (var org-local-vars)
8928 (when (or (not (boundp (car var)))
8929 (eq (symbol-value (car var))
8930 (default-value (car var))))
8931 (push (list (car var) `(quote ,(cadr var))) binds)))
8932 (eval `(let ,binds
8933 (call-interactively (quote ,cmd))))))
8935 ;;;; Archiving
8937 (defun org-get-category (&optional pos force-refresh)
8938 "Get the category applying to position POS."
8939 (save-match-data
8940 (if force-refresh (org-refresh-category-properties))
8941 (let ((pos (or pos (point))))
8942 (or (get-text-property pos 'org-category)
8943 (progn (org-refresh-category-properties)
8944 (get-text-property pos 'org-category))))))
8946 (defun org-refresh-category-properties ()
8947 "Refresh category text properties in the buffer."
8948 (let ((case-fold-search t)
8949 (inhibit-read-only t)
8950 (def-cat (cond
8951 ((null org-category)
8952 (if buffer-file-name
8953 (file-name-sans-extension
8954 (file-name-nondirectory buffer-file-name))
8955 "???"))
8956 ((symbolp org-category) (symbol-name org-category))
8957 (t org-category)))
8958 beg end cat pos optionp)
8959 (org-with-silent-modifications
8960 (save-excursion
8961 (save-restriction
8962 (widen)
8963 (goto-char (point-min))
8964 (put-text-property (point) (point-max) 'org-category def-cat)
8965 (while (re-search-forward
8967 (setq pos (match-end 0)
8968 optionp (equal (char-after (match-beginning 0)) ?#)
8969 cat (org-trim (match-string 2)))
8970 (if optionp
8971 (setq beg (point-at-bol) end (point-max))
8972 (org-back-to-heading t)
8973 (setq beg (point) end (org-end-of-subtree t t)))
8974 (put-text-property beg end 'org-category cat)
8975 (put-text-property beg end 'org-category-position beg)
8976 (goto-char pos)))))))
8978 (defun org-refresh-properties (dprop tprop)
8979 "Refresh buffer text properties.
8980 DPROP is the drawer property and TPROP is the corresponding text
8981 property to set."
8982 (let ((case-fold-search t)
8983 (inhibit-read-only t) p)
8984 (org-with-silent-modifications
8985 (save-excursion
8986 (save-restriction
8987 (widen)
8988 (goto-char (point-min))
8990 (setq p (org-match-string-no-properties 1))
8991 (save-excursion
8992 (org-back-to-heading t)
8993 (put-text-property
8994 (point-at-bol) (point-at-eol) tprop p))))))))
8997 ;;;; Link Stuff
8999 ;;; Link abbreviations
9001 (defun org-link-expand-abbrev (link)
9002 "Apply replacements as defined in `org-link-abbrev-alist'."
9004 (let* ((key (match-string 1 link))
9005 (as (or (assoc key org-link-abbrev-alist-local)
9006 (assoc key org-link-abbrev-alist)))
9007 (tag (and (match-end 2) (match-string 3 link)))
9008 rpl)
9009 (if (not as)
9010 link
9011 (setq rpl (cdr as))
9012 (cond
9013 ((symbolp rpl) (funcall rpl tag))
9015 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
9016 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9017 ((string-match "%h" rpl)
9018 (replace-match (url-hexify-string (or tag "")) t t rpl))
9019 (t (concat rpl tag)))))
9020 link))
9022 ;;; Storing and inserting links
9024 (defvar org-insert-link-history nil
9025 "Minibuffer history for links inserted with `org-insert-link'.")
9027 (defvar org-stored-links nil
9028 "Contains the links stored with `org-store-link'.")
9030 (defvar org-store-link-plist nil
9031 "Plist with info about the most recently link created with `org-store-link'.")
9033 (defvar org-link-protocols nil
9034 "Link protocols added to Org-mode using `org-add-link-type'.")
9036 (defvar org-store-link-functions nil
9037 "List of functions that are called to create and store a link.
9038 Each function will be called in turn until one returns a non-nil
9039 value. Each function should check if it is responsible for creating
9040 this link (for example by looking at the major mode).
9041 If not, it must exit and return nil.
9042 If yes, it should return a non-nil value after a calling
9043 `org-store-link-props' with a list of properties and values.
9044 Special properties are:
9048 This is obligatory as well.
9049 :description Optional default description for the second pair
9050 of brackets in an Org-mode link. The user can still change
9051 this when inserting this link into an Org-mode buffer.
9053 In addition to these, any additional properties can be specified
9054 and then used in capture templates.")
9056 (defun org-add-link-type (type &optional follow export)
9057 "Add TYPE to the list of `org-link-types'.
9058 Re-compute all regular expressions depending on `org-link-types'
9060 FOLLOW and EXPORT are two functions.
9062 FOLLOW should take the link path as the single argument and do whatever
9063 is necessary to follow the link, for example find a file or display
9064 a mail message.
9066 EXPORT should format the link path for export to one of the export formats.
9067 It should be a function accepting three arguments:
9070 desc the description of the link, if any, or a description added by
9071 org-export-normalize-links if there is none
9072 format the export format, a symbol like `html' or `latex' or `ascii'..
9074 The function may use the FORMAT information to return different values
9075 depending on the format. The return value will be put literally into
9076 the exported file. If the return value is nil, this means Org should
9077 do what it normally does with links which do not have EXPORT defined.
9079 Org-mode has a built-in default for exporting links. If you are happy with
9080 this default, there is no need to define an export function for the link
9081 type. For a simple example of an export function, see `org-bbdb.el'."
9082 (add-to-list 'org-link-types type t)
9083 (org-make-link-regexps)
9084 (if (assoc type org-link-protocols)
9085 (setcdr (assoc type org-link-protocols) (list follow export))
9086 (push (list type follow export) org-link-protocols)))
9088 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9089 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9091 ;;;###autoload
9092 (defun org-store-link (arg)
9094 This link is added to `org-stored-links' and can later be inserted
9097 For some link types, a prefix arg is interpreted.
9098 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9099 For file links, arg negates `org-context-in-file-links'.
9101 A double prefix arg force skipping storing functions that are not
9102 part of Org's core."
9103 (interactive "P")
9104 (org-load-modules-maybe)
9105 (setq org-store-link-plist nil) ; reset
9106 (org-with-limited-levels
9107 (let (link cpltxt desc description search txt custom-id agenda-link sfuns sfunsn)
9108 (cond
9109 ((and (not (equal arg '(16)))
9110 (setq sfuns
9111 (delq
9112 nil (mapcar (lambda (f) (let (fs) (if (funcall f) (push f fs))))
9113 org-store-link-functions))
9114 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9115 (or (and (cdr sfuns)
9116 (funcall (intern
9117 (completing-read "Which function for creating the link? "
9118 sfunsn t (car sfunsn)))))
9119 (funcall (caar sfuns)))
9120 (setq link (plist-get org-store-link-plist :link)
9121 desc (or (plist-get org-store-link-plist :description) link))))
9122 ((org-src-edit-buffer-p)
9123 (let (label gc)
9124 (while (or (not label)
9125 (save-excursion
9126 (save-restriction
9127 (widen)
9128 (goto-char (point-min))
9129 (re-search-forward
9130 (regexp-quote (format org-coderef-label-format label))
9131 nil t))))
9132 (when label (message "Label exists already") (sit-for 2))
9133 (setq label (read-string "Code line label: " label)))
9134 (end-of-line 1)
9135 (setq link (format org-coderef-label-format label))
9136 (setq gc (- 79 (length link)))
9137 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9138 (insert link)
9139 (setq link (concat "(" label ")") desc nil)))
9141 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9142 ;; We are in the agenda, link to referenced location
9143 (let ((m (or (get-text-property (point) 'org-hd-marker)
9144 (get-text-property (point) 'org-marker))))
9145 (when m
9146 (org-with-point-at m
9147 (setq agenda-link
9148 (if (org-called-interactively-p 'any)
9149 (call-interactively 'org-store-link)
9150 (org-store-link nil)))))))
9152 ((eq major-mode 'calendar-mode)
9153 (let ((cd (calendar-cursor-to-date)))
9154 (setq link
9155 (format-time-string
9156 (car org-time-stamp-formats)
9157 (apply 'encode-time
9158 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9159 nil nil nil))))
9160 (org-store-link-props :type "calendar" :date cd)))
9162 ((eq major-mode 'help-mode)
9163 (setq link (concat "help:" (save-excursion
9164 (goto-char (point-min))
9165 (looking-at "^[^ ]+")
9166 (match-string 0))))
9167 (org-store-link-props :type "help"))
9169 ((eq major-mode 'w3-mode)
9170 (setq cpltxt (if (and (buffer-name)
9171 (not (string-match "Untitled" (buffer-name))))
9172 (buffer-name)
9173 (url-view-url t))
9174 link (url-view-url t))
9175 (org-store-link-props :type "w3" :url (url-view-url t)))
9177 ((setq search (run-hook-with-args-until-success
9178 'org-create-file-search-functions))
9179 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9180 "::" search))
9181 (setq cpltxt (or description link)))
9183 ((eq major-mode 'image-mode)
9184 (setq cpltxt (concat "file:"
9185 (abbreviate-file-name buffer-file-name))
9186 link cpltxt)
9187 (org-store-link-props :type "image" :file buffer-file-name))
9189 ((eq major-mode 'dired-mode)
9190 ;; link to the file in the current line
9191 (let ((file (dired-get-filename nil t)))
9192 (setq file (if file
9193 (abbreviate-file-name
9194 (expand-file-name (dired-get-filename nil t)))
9195 ;; otherwise, no file so use current directory.
9196 default-directory))
9197 (setq cpltxt (concat "file:" file)
9198 link cpltxt)))
9200 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9201 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9202 (cond
9204 (setq cpltxt
9205 (concat "file:"
9206 (abbreviate-file-name
9207 (buffer-file-name (buffer-base-buffer)))
9208 "::" (match-string 1))
9209 link cpltxt))
9210 ((and (featurep 'org-id)
9211 (or (eq org-id-link-to-org-use-id t)
9212 (and (org-called-interactively-p 'any)
9213 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9214 (and (eq org-id-link-to-org-use-id
9215 'create-if-interactive-and-no-custom-id)
9216 (not custom-id))))
9217 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9218 ;; We can make a link using the ID.
9219 (setq link (condition-case nil
9220 (prog1 (org-id-store-link)
9221 (setq desc (plist-get org-store-link-plist :description)))
9222 (error
9223 ;; probably before first headline, link to file only
9224 (concat "file:"
9225 (abbreviate-file-name
9226 (buffer-file-name (buffer-base-buffer))))))))
9227 (t
9228 ;; Just link to current headline
9229 (setq cpltxt (concat "file:"
9230 (abbreviate-file-name
9231 (buffer-file-name (buffer-base-buffer)))))
9232 ;; Add a context search string
9233 (when (org-xor org-context-in-file-links arg)
9234 (let* ((ee (org-element-at-point))
9235 (et (org-element-type ee))
9236 (ev (plist-get (cadr ee) :value)))
9237 (setq txt (cond
9238 ((org-at-heading-p) nil)
9239 ((eq et 'keyword) ev)
9240 ((org-region-active-p)
9241 (buffer-substring (region-beginning) (region-end)))))
9243 (setq cpltxt
9244 (concat cpltxt "::"
9245 (condition-case nil
9246 (org-make-org-heading-search-string txt)
9247 (error "")))
9248 desc (or (and (eq et 'keyword) ev)
9249 (nth 4 (ignore-errors (org-heading-components)))
9250 "NONE")))))
9252 (setq cpltxt (substring cpltxt 0 -2)))
9253 (setq link cpltxt))))
9255 ((buffer-file-name (buffer-base-buffer))
9256 ;; Just link to this file here.
9257 (setq cpltxt (concat "file:"
9258 (abbreviate-file-name
9259 (buffer-file-name (buffer-base-buffer)))))
9260 ;; Add a context string
9261 (when (org-xor org-context-in-file-links arg)
9262 (setq txt (if (org-region-active-p)
9263 (buffer-substring (region-beginning) (region-end))
9264 (buffer-substring (point-at-bol) (point-at-eol))))
9265 ;; Only use search option if there is some text.
9267 (setq cpltxt
9268 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9269 desc "NONE")))
9270 (setq link cpltxt))
9272 ((org-called-interactively-p 'interactive)
9273 (user-error "No method for storing a link from this buffer"))
9275 (t (setq link nil)))
9277 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9278 (setq link (or link cpltxt)
9279 desc (or desc cpltxt))
9280 (cond ((equal desc "NONE") (setq desc nil))
9281 ((string-match org-bracket-link-regexp desc)
9282 (setq desc (replace-regexp-in-string
9283 org-bracket-link-regexp
9285 (length desc)) "*" "")) desc))))
9287 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
9288 (progn
9289 (setq org-stored-links
9290 (cons (list link desc) org-stored-links))
9291 (message "Stored: %s" (or desc link))
9292 (when custom-id
9293 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
9294 "::#" custom-id))
9295 (setq org-stored-links
9296 (cons (list link desc) org-stored-links))))
9297 (or agenda-link (and link (org-make-link-string link desc)))))))
9299 (defun org-store-link-props (&rest plist)
9300 "Store link properties, extract names and addresses."
9301 (let (x adr)
9302 (when (setq x (plist-get plist :from))
9303 (setq adr (mail-extract-address-components x))
9304 (setq plist (plist-put plist :fromname (car adr)))
9305 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9306 (when (setq x (plist-get plist :to))
9307 (setq adr (mail-extract-address-components x))
9308 (setq plist (plist-put plist :toname (car adr)))
9309 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9310 (let ((from (plist-get plist :from))
9311 (to (plist-get plist :to)))
9312 (when (and from to org-from-is-user-regexp)
9313 (setq plist
9314 (plist-put plist :fromto
9315 (if (string-match org-from-is-user-regexp from)
9316 (concat "to %t")
9317 (concat "from %f"))))))
9318 (setq org-store-link-plist plist))
9320 (defun org-add-link-props (&rest plist)
9321 "Add these properties to the link property list."
9322 (let (key value)
9323 (while plist
9324 (setq key (pop plist) value (pop plist))
9325 (setq org-store-link-plist
9326 (plist-put org-store-link-plist key value)))))
9328 (defun org-email-link-description (&optional fmt)
9329 "Return the description part of an email link.
9330 This takes information from `org-store-link-plist' and formats it
9331 according to FMT (default from `org-email-link-description-format')."
9332 (setq fmt (or fmt org-email-link-description-format))
9333 (let* ((p org-store-link-plist)
9334 (to (plist-get p :toaddress))
9335 (from (plist-get p :fromaddress))
9336 (table
9337 (list
9338 (cons "%c" (plist-get p :fromto))
9339 (cons "%F" (plist-get p :from))
9340 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9341 (cons "%T" (plist-get p :to))
9342 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9343 (cons "%s" (plist-get p :subject))
9344 (cons "%d" (plist-get p :date))
9345 (cons "%m" (plist-get p :message-id)))))
9346 (when (string-match "%c" fmt)
9347 ;; Check if the user wrote this message
9348 (if (and org-from-is-user-regexp from to
9349 (save-match-data (string-match org-from-is-user-regexp from)))
9350 (setq fmt (replace-match "to %t" t t fmt))
9351 (setq fmt (replace-match "from %f" t t fmt))))
9352 (org-replace-escapes fmt table)))
9354 (defun org-make-org-heading-search-string (&optional string)
9355 "Make search string for the current headline or STRING."
9356 (let ((s (or string
9357 (and (derived-mode-p 'org-mode)
9358 (save-excursion
9359 (org-back-to-heading t)
9360 (org-element-property :raw-value (org-element-at-point))))))
9361 (lines org-context-in-file-links))
9362 (or string (setq s (concat "*" s))) ; Add * for headlines
9364 (when (and string (integerp lines) (> lines 0))
9366 (when (< lines (length slines))
9367 (setq s (mapconcat
9368 'identity
9369 (reverse (nthcdr (- (length slines) lines)
9373 (defun org-make-link-string (link &optional description)
9374 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9376 (error "Empty link"))
9377 (when (and description
9378 (stringp description)
9380 (setq description nil))
9381 (when (stringp description)
9382 ;; Remove brackets from the description, they are fatal.
9384 (setq description (replace-match "{" t t description)))
9386 (setq description (replace-match "}" t t description))))
9387 (when (equal link description)
9388 ;; No description needed, it is identical
9389 (setq description nil))
9390 (when (and (not description)
9391 (not (string-match (org-image-file-name-regexp) link))
9392 (not (equal link (org-link-escape link))))
9393 (setq description (org-extract-attributes link)))
9394 (setq link
9395 (cond ((string-match (org-image-file-name-regexp) link) link)
9396 ((string-match org-link-types-re link)
9397 (concat (match-string 1 link)
9398 (org-link-escape (substring link (match-end 1)))))
9399 (t (org-link-escape link))))
9400 (concat "[[" link "]"
9401 (if description (concat "[" description "]") "")
9402 "]"))
9404 (defconst org-link-escape-chars
9405 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9406 "List of characters that should be escaped in link.
9407 This is the list that is used for internal purposes.")
9409 (defconst org-link-escape-chars-browser
9410 '(?\ )
9411 "List of escapes for characters that are problematic in links.
9412 This is the list that is used before handing over to the browser.")
9414 (defun org-link-escape (text &optional table merge)
9415 "Return percent escaped representation of TEXT.
9416 TEXT is a string with the text to escape.
9417 Optional argument TABLE is a list with characters that should be
9418 escaped. When nil, `org-link-escape-chars' is used.
9419 If optional argument MERGE is set, merge TABLE into
9420 `org-link-escape-chars'."
9421 (cond
9422 ((and table merge)
9423 (mapc (lambda (defchr)
9424 (unless (member defchr table)
9425 (setq table (cons defchr table)))) org-link-escape-chars))
9426 ((null table)
9427 (setq table org-link-escape-chars)))
9428 (mapconcat
9429 (lambda (char)
9430 (if (or (member char table)
9431 (and (or (< char 32) (= char 37) (> char 126))
9432 org-url-hexify-p))
9433 (mapconcat (lambda (sequence-element)
9434 (format "%%%.2X" sequence-element))
9435 (or (encode-coding-char char 'utf-8)
9436 (error "Unable to percent escape character: %s"
9437 (char-to-string char))) "")
9438 (char-to-string char))) text ""))
9440 (defun org-link-unescape (str)
9441 "Unhex hexified Unicode strings as returned from the JavaScript function
9442 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9443 (unless (and (null str) (string= "" str))
9444 (let ((pos 0) (case-fold-search t) unhexed)
9446 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9447 (setq str (replace-match unhexed t t str))
9448 (setq pos (+ pos (length unhexed))))))
9449 str)
9451 (defun org-link-unescape-compound (hex)
9452 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9453 Note: this function also decodes single byte encodings like
9454 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9455 (save-match-data
9456 (let* ((bytes (cdr (split-string hex "%")))
9457 (ret "")
9458 (eat 0)
9459 (sum 0))
9460 (while bytes
9461 (let* ((val (string-to-number (pop bytes) 16))
9462 (shift-xor
9463 (if (= 0 eat)
9464 (cond
9465 ((>= val 252) (cons 6 252))
9466 ((>= val 248) (cons 5 248))
9467 ((>= val 240) (cons 4 240))
9468 ((>= val 224) (cons 3 224))
9469 ((>= val 192) (cons 2 192))
9470 (t (cons 0 0)))
9471 (cons 6 128))))
9472 (if (>= val 192) (setq eat (car shift-xor)))
9473 (setq val (logxor val (cdr shift-xor)))
9474 (setq sum (+ (lsh sum (car shift-xor)) val))
9475 (if (> eat 0) (setq eat (- eat 1)))
9476 (cond
9477 ((= 0 eat) ;multi byte
9478 (setq ret (concat ret (org-char-to-string sum)))
9479 (setq sum 0))
9480 ((not bytes) ; single byte(s)
9481 (setq ret (org-link-unescape-single-byte-sequence hex))))
9482 )) ;; end (while bytes
9483 ret )))
9485 (defun org-link-unescape-single-byte-sequence (hex)
9486 "Unhexify hex-encoded single byte character sequences."
9487 (mapconcat (lambda (byte)
9488 (char-to-string (string-to-number byte 16)))
9489 (cdr (split-string hex "%")) ""))
9491 (defun org-xor (a b)
9492 "Exclusive or."
9493 (if a (not b) b))
9495 (defun org-fixup-message-id-for-http (s)
9496 "Replace special characters in a message id, so it can be used in an http query."
9497 (when (string-match "%" s)
9498 (setq s (mapconcat (lambda (c)
9499 (if (eq c ?%)
9500 "%25"
9501 (char-to-string c)))
9502 s "")))
9503 (while (string-match "<" s)
9504 (setq s (replace-match "%3C" t t s)))
9505 (while (string-match ">" s)
9506 (setq s (replace-match "%3E" t t s)))
9507 (while (string-match "@" s)
9508 (setq s (replace-match "%40" t t s)))
9509 s)
9511 (defun org-link-prettify (link)
9512 "Return a human-readable representation of LINK.
9513 The car of LINK must be a raw link the cdr of LINK must be either
9514 a link description or nil."
9515 (let ((desc (or (cadr link) "<no description>")))
9516 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9517 "<" (car link) ">")))
9519 ;;;###autoload
9520 (defun org-insert-link-global ()
9521 "Insert a link like Org-mode does.
9522 This command can be called in any mode to insert a link in Org-mode syntax."
9523 (interactive)
9524 (org-load-modules-maybe)
9525 (org-run-like-in-org-mode 'org-insert-link))
9527 (defun org-insert-all-links (&optional keep)
9528 "Insert all links in `org-stored-links'."
9529 (interactive "P")
9530 (let ((links (copy-sequence org-stored-links)) l)
9531 (while (setq l (if keep (pop links) (pop org-stored-links)))
9532 (insert "- ")
9533 (org-insert-link nil (car l) (cadr l))
9536 (defun org-link-fontify-links-to-this-file ()
9537 "Fontify links to the current file in `org-stored-links'."
9538 (let ((f (buffer-file-name)) a b)
9539 (setq a (mapcar (lambda(l)
9540 (let ((ll (car l)))
9542 (equal f (expand-file-name (match-string 1 ll))))
9543 ll)))
9544 org-stored-links))
9545 (when (featurep 'org-id)
9546 (setq b (mapcar (lambda(l)
9547 (let ((ll (car l)))
9549 (equal f (expand-file-name
9550 (or (org-id-find-id-file
9551 (match-string 1 ll)) ""))))
9552 ll)))
9553 org-stored-links)))
9554 (mapcar (lambda(l)
9555 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9556 (delq nil (append a b)))))
9558 (defvar org-link-links-in-this-file nil)
9559 (defun org-insert-link (&optional complete-file link-location default-description)
9560 "Insert a link. At the prompt, enter the link.
9562 Completion can be used to insert any of the link protocol prefixes like
9563 http or ftp in use.
9565 The history can be used to select a link previously stored with
9566 `org-store-link'. When the empty string is entered (i.e. if you just
9567 press RET at the prompt), the link defaults to the most recently
9568 stored link. As SPC triggers completion in the minibuffer, you need to
9569 use M-SPC or C-q SPC to force the insertion of a space character.
9571 You will also be prompted for a description, and if one is given, it will
9572 be displayed in the buffer instead of the link.
9574 If there is already a link at point, this command will allow you to edit link
9575 and description parts.
9578 be selected using completion. The path to the file will be relative to the
9579 current directory if the file is in the current directory or a subdirectory.
9580 Otherwise, the link will be the absolute path as completed in the minibuffer
9581 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9582 option `org-link-file-path-type'.
9585 the current directory or below.
9588 `org-keep-stored-link-after-insertion'.
9590 If `org-make-link-description-function' is non-nil, this function will be
9591 called with the link target, and the result will be the default
9592 link description.
9594 If the LINK-LOCATION parameter is non-nil, this value will be
9595 used as the link location instead of reading one interactively.
9597 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9598 be used as the default description."
9599 (interactive "P")
9600 (let* ((wcf (current-window-configuration))
9601 (origbuf (current-buffer))
9602 (region (if (org-region-active-p)
9603 (buffer-substring (region-beginning) (region-end))))
9604 (remove (and region (list (region-beginning) (region-end))))
9605 (desc region)
9606 tmphist ; byte-compile incorrectly complains about this
9607 (link link-location)
9608 (abbrevs org-link-abbrev-alist-local)
9609 entry file all-prefixes auto-desc)
9610 (cond
9611 (link-location) ; specified by arg, just use it.
9612 ((org-in-regexp org-bracket-link-regexp 1)
9613 ;; We do have a link at point, and we are going to edit it.
9614 (setq remove (list (match-beginning 0) (match-end 0)))
9615 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9616 (setq link (read-string "Link: "
9617 (org-link-unescape
9618 (org-match-string-no-properties 1)))))
9619 ((or (org-in-regexp org-angle-link-re)
9620 (org-in-regexp org-plain-link-re))
9621 ;; Convert to bracket link
9622 (setq remove (list (match-beginning 0) (match-end 0))
9623 link (read-string "Link: "
9624 (org-remove-angle-brackets (match-string 0)))))
9625 ((member complete-file '((4) (16)))
9626 ;; Completing read for file names.
9627 (setq link (org-file-complete-link complete-file)))
9628 (t
9629 ;; Read link, with completion for stored links.
9630 (org-link-fontify-links-to-this-file)
9631 (org-switch-to-buffer-other-window "*Org Links*")
9632 (with-current-buffer "*Org Links*"
9633 (erase-buffer)
9634 (insert "Insert a link.
9636 (when org-stored-links
9638 (insert (mapconcat 'org-link-prettify
9640 (goto-char (point-min)))
9641 (let ((cw (selected-window)))
9642 (select-window (get-buffer-window "*Org Links*" 'visible))
9643 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9644 (unless (pos-visible-in-window-p (point-max))
9645 (org-fit-window-to-buffer))
9646 (and (window-live-p cw) (select-window cw)))
9647 ;; Fake a link history, containing the stored links.
9648 (setq tmphist (append (mapcar 'car org-stored-links)
9649 org-insert-link-history))
9650 (setq all-prefixes (append (mapcar 'car abbrevs)
9651 (mapcar 'car org-link-abbrev-alist)
9652 org-link-types))
9653 (unwind-protect
9654 (progn
9655 (setq link
9656 (org-completing-read
9657 "Link: "
9658 (append
9659 (mapcar (lambda (x) (concat x ":"))
9660 all-prefixes)
9661 (mapcar 'car org-stored-links))
9662 nil nil nil
9663 'tmphist
9664 (caar org-stored-links)))
9666 (error "No link selected"))
9667 (mapc (lambda(l)
9668 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9669 org-stored-links)
9670 (if (or (member link all-prefixes)
9671 (and (equal ":" (substring link -1))
9672 (member (substring link 0 -1) all-prefixes)
9673 (setq link (substring link 0 -1))))
9674 (setq link (with-current-buffer origbuf
9675 (org-link-try-special-completion link)))))
9676 (set-window-configuration wcf)
9677 (kill-buffer "*Org Links*"))
9678 (setq entry (assoc link org-stored-links))
9679 (or entry (push link org-insert-link-history))
9680 (setq desc (or desc (nth 1 entry)))))
9682 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9683 (not org-keep-stored-link-after-insertion))
9684 (setq org-stored-links (delq (assoc link org-stored-links)
9685 org-stored-links)))
9687 (if (string-match org-plain-link-re link)
9688 ;; URL-like link, normalize the use of angular brackets.
9689 (setq link (org-remove-angle-brackets link)))
9691 ;; Check if we are linking to the current file with a search
9692 ;; option If yes, simplify the link by using only the search
9693 ;; option.
9694 (when (and buffer-file-name
9696 (let* ((path (match-string 1 link))
9697 (case-fold-search nil)
9698 (search (match-string 2 link)))
9699 (save-match-data
9700 (if (equal (file-truename buffer-file-name) (file-truename path))
9701 ;; We are linking to this same file, with a search option
9702 (setq link search)))))
9704 ;; Check if we can/should use a relative path. If yes, simplify the link
9706 (let* ((type (match-string 1 link))
9707 (path (match-string 2 link))
9708 (origpath path)
9709 (case-fold-search nil))
9710 (cond
9711 ((or (eq org-link-file-path-type 'absolute)
9712 (equal complete-file '(16)))
9713 (setq path (abbreviate-file-name (expand-file-name path))))
9714 ((eq org-link-file-path-type 'noabbrev)
9715 (setq path (expand-file-name path)))
9716 ((eq org-link-file-path-type 'relative)
9717 (setq path (file-relative-name path)))
9718 (t
9719 (save-match-data
9720 (if (string-match (concat "^" (regexp-quote
9721 (expand-file-name
9722 (file-name-as-directory
9723 default-directory))))
9724 (expand-file-name path))
9725 ;; We are linking a file with relative path name.
9726 (setq path (substring (expand-file-name path)
9727 (match-end 0)))
9728 (setq path (abbreviate-file-name (expand-file-name path)))))))
9729 (setq link (concat type path))
9730 (if (equal desc origpath)
9731 (setq desc path))))
9733 (if org-make-link-description-function
9734 (setq desc
9735 (or (condition-case nil
9736 (funcall org-make-link-description-function link desc)
9737 (error (progn (message "Can't get link description from `%s'"
9738 (symbol-name org-make-link-description-function))
9739 (sit-for 2) nil)))
9740 (read-string "Description: " default-description)))
9741 (if default-description (setq desc default-description)
9742 (setq desc (or (and auto-desc desc)
9743 (read-string "Description: " desc)))))
9746 (if remove (apply 'delete-region remove))
9747 (insert (org-make-link-string link desc))))
9749 (defun org-link-try-special-completion (type)
9750 "If there is completion support for link type TYPE, offer it."
9751 (let ((fun (intern (concat "org-" type "-complete-link"))))
9752 (if (functionp fun)
9753 (funcall fun)
9754 (read-string "Link (no completion support): " (concat type ":")))))
9756 (defun org-file-complete-link (&optional arg)
9757 "Create a file link using completion."
9758 (let (file link)
9759 (setq file (org-iread-file-name "File: "))
9760 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9761 (pwd1 (file-name-as-directory (abbreviate-file-name
9762 (expand-file-name ".")))))
9763 (cond
9764 ((equal arg '(16))
9765 (setq link (concat
9766 "file:"
9767 (abbreviate-file-name (expand-file-name file)))))
9769 (setq link (concat "file:" (match-string 1 file))))
9771 (expand-file-name file))
9772 (setq link (concat
9773 "file:" (match-string 1 (expand-file-name file)))))
9774 (t (setq link (concat "file:" file)))))
9775 link))
9777 (defun org-iread-file-name (&rest args)
9778 "Read-file-name using `ido-mode' speedup if available.
9779 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
9780 See `read-file-name' for a description of parameters."
9781 (org-without-partial-completion
9782 (if (and org-completion-use-ido
9783 (fboundp 'ido-read-file-name)
9784 (boundp 'ido-mode) ido-mode
9785 (listp (second args)))
9786 (let ((ido-enter-matching-directory nil))
9787 (apply 'ido-read-file-name args))
9788 (apply 'read-file-name args))))
9790 (defun org-completing-read (&rest args)
9791 "Completing-read with SPACE being a normal character."
9792 (let ((enable-recursive-minibuffers t)
9793 (minibuffer-local-completion-map
9794 (copy-keymap minibuffer-local-completion-map)))
9795 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9796 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9797 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9798 (apply 'org-icompleting-read args)))
9800 (defun org-completing-read-no-i (&rest args)
9801 (let (org-completion-use-ido org-completion-use-iswitchb)
9802 (apply 'org-completing-read args)))
9804 (defun org-iswitchb-completing-read (prompt choices &rest args)
9805 "Use iswitch as a completing-read replacement to choose from choices.
9806 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9807 from."
9808 (let* ((iswitchb-use-virtual-buffers nil)
9809 (iswitchb-make-buflist-hook
9810 (lambda ()
9811 (setq iswitchb-temp-buflist choices))))
9812 (iswitchb-read-buffer prompt)))
9814 (defun org-icompleting-read (&rest args)
9815 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9816 (org-without-partial-completion
9817 (if (and org-completion-use-ido
9818 (fboundp 'ido-completing-read)
9819 (boundp 'ido-mode) ido-mode
9820 (listp (second args)))
9821 (let ((ido-enter-matching-directory nil))
9822 (apply 'ido-completing-read (concat (car args))
9823 (if (consp (car (nth 1 args)))
9824 (mapcar 'car (nth 1 args))
9825 (nth 1 args))
9826 (cddr args)))
9827 (if (and org-completion-use-iswitchb
9828 (boundp 'iswitchb-mode) iswitchb-mode
9829 (listp (second args)))
9830 (apply 'org-iswitchb-completing-read (concat (car args))
9831 (if (consp (car (nth 1 args)))
9832 (mapcar 'car (nth 1 args))
9833 (nth 1 args))
9834 (cddr args))
9835 (apply 'completing-read args)))))
9837 (defun org-extract-attributes (s)
9838 "Extract the attributes cookie from a string and set as text property."
9839 (let (a attr (start 0) key value)
9840 (save-match-data
9842 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9844 (setq key (match-string 1 a) value (match-string 2 a)
9845 start (match-end 0)
9846 attr (plist-put attr (intern key) value))))
9847 (org-add-props s nil 'org-attr attr))
9848 s))
9850 (defun org-extract-attributes-from-string (tag)
9851 (let (key value attr)
9853 (setq key (match-string 1 tag) value (match-string 2 tag)
9854 tag (replace-match "" t t tag)
9855 attr (plist-put attr (intern key) value)))
9856 (cons tag attr)))
9858 (defun org-attributes-to-string (plist)
9859 "Format a property list into an HTML attribute list."
9860 (let ((s "") key value)
9861 (while plist
9862 (setq key (pop plist) value (pop plist))
9863 (and value
9865 s))
9867 ;;; Opening/following a link
9869 (defvar org-link-search-failed nil)
9871 (defvar org-open-link-functions nil
9872 "Hook for functions finding a plain text link.
9873 These functions must take a single argument, the link content.
9874 They will be called for links that look like [[link text][description]]
9878 These functions will be called *before* Org attempts to resolve the
9879 link by doing text searches in the current buffer - so if you want a
9881 handle this as a special case.
9883 When the function does handle the link, it must return a non-nil value.
9884 If it decides that it is not responsible for this link, it must return
9885 nil to indicate that that Org-mode can continue with other options
9886 like exact and fuzzy text search.")
9888 (defun org-next-link (&optional search-backward)
9889 "Move forward to the next link.
9890 If the link is in hidden text, expose it."
9891 (interactive "P")
9892 (when (and org-link-search-failed (eq this-command last-command))
9893 (goto-char (point-min))
9894 (message "Link search wrapped back to beginning of buffer"))
9895 (setq org-link-search-failed nil)
9896 (let* ((pos (point))
9897 (ct (org-context))
9898 (a (assoc :link ct))
9899 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
9900 (cond (a (goto-char (nth (if search-backward 1 2) a)))
9901 ((looking-at org-any-link-re)
9902 ;; Don't stay stuck at link without an org-link face
9903 (forward-char (if search-backward -1 1))))
9904 (if (funcall srch-fun org-any-link-re nil t)
9905 (progn
9906 (goto-char (match-beginning 0))
9907 (if (outline-invisible-p) (org-show-context)))
9908 (goto-char pos)
9909 (setq org-link-search-failed t)
9910 (message "No further link found"))))
9912 (defun org-previous-link ()
9913 "Move backward to the previous link.
9914 If the link is in hidden text, expose it."
9915 (interactive)
9916 (funcall 'org-next-link t))
9918 (defun org-translate-link (s)
9919 "Translate a link string if a translation function has been defined."
9920 (if (and org-link-translation-function
9921 (fboundp org-link-translation-function)
9923 (progn
9924 (setq s (funcall org-link-translation-function
9925 (match-string 1 s) (match-string 2 s)))
9926 (concat (car s) ":" (cdr s)))
9927 s))
9929 (defun org-translate-link-from-planner (type path)
9930 "Translate a link from Emacs Planner syntax so that Org can follow it.
9931 This is still an experimental function, your mileage may vary."
9932 (cond
9933 ((member type '("http" "https" "news" "ftp"))
9934 ;; standard Internet links are the same.
9935 nil)
9936 ((and (equal type "irc") (string-match "^//" path))
9937 ;; Planner has two / at the beginning of an irc link, we have 1.
9938 ;; We should have zero, actually....
9939 (setq path (substring path 1)))
9940 ((and (equal type "lisp") (string-match "^/" path))
9941 ;; Planner has a slash, we do not.
9942 (setq type "elisp" path (substring path 1)))
9944 ;; A typical message link. Planner has the id after the final slash,
9945 ;; we separate it with a hash mark
9946 (setq path (concat (match-string 1 path) "#"
9947 (org-remove-angle-brackets (match-string 2 path)))))
9948 )
9949 (cons type path))
9951 (defun org-find-file-at-mouse (ev)
9952 "Open file link or URL at mouse."
9953 (interactive "e")
9954 (mouse-set-point ev)
9955 (org-open-at-point 'in-emacs))
9957 (defun org-open-at-mouse (ev)
9958 "Open file link or URL at mouse.
9959 See the docstring of `org-open-file' for details."
9960 (interactive "e")
9961 (mouse-set-point ev)
9962 (if (eq major-mode 'org-agenda-mode)
9963 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9964 (org-open-at-point))
9966 (defvar org-window-config-before-follow-link nil
9967 "The window configuration before following a link.
9968 This is saved in case the need arises to restore it.")
9970 (defvar org-open-link-marker (make-marker)
9971 "Marker pointing to the location where `org-open-at-point; was called.")
9973 ;;;###autoload
9974 (defun org-open-at-point-global ()
9975 "Follow a link like Org-mode does.
9976 This command can be called in any mode to follow a link that has
9977 Org-mode syntax."
9978 (interactive)
9979 (org-run-like-in-org-mode 'org-open-at-point))
9981 ;;;###autoload
9982 (defun org-open-link-from-string (s &optional arg reference-buffer)
9983 "Open a link in the string S, as if it was in Org-mode."
9985 (let ((reference-buffer (or reference-buffer (current-buffer))))
9986 (with-temp-buffer
9987 (let ((org-inhibit-startup (not reference-buffer)))
9988 (org-mode)
9989 (insert s)
9990 (goto-char (point-min))
9991 (when reference-buffer
9992 (setq org-link-abbrev-alist-local
9993 (with-current-buffer reference-buffer
9994 org-link-abbrev-alist-local)))
9995 (org-open-at-point arg reference-buffer)))))
9997 (defvar org-open-at-point-functions nil
9998 "Hook that is run when following a link at point.
10000 Functions in this hook must return t if they identify and follow
10001 a link at point. If they don't find anything interesting at point,
10002 they must return nil.")
10004 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10005 (defun org-open-at-point (&optional arg reference-buffer)
10006 "Open link at or after point.
10007 If there is no link at point, this function will search forward up to
10008 the end of the current line.
10009 Normally, files will be opened by an appropriate application. If the
10010 optional prefix argument ARG is non-nil, Emacs will visit the file.
10011 With a double prefix argument, try to open outside of Emacs, in the
10012 application the system uses for this file type."
10013 (interactive "P")
10014 ;; if in a code block, then open the block's results
10015 (unless (call-interactively #'org-babel-open-src-block-result)
10016 (org-load-modules-maybe)
10017 (move-marker org-open-link-marker (point))
10018 (setq org-window-config-before-follow-link (current-window-configuration))
10019 (org-remove-occur-highlights nil nil t)
10020 (cond
10021 ((and (org-at-heading-p)
10022 (not (org-at-timestamp-p t))
10023 (not (org-in-regexp
10028 (not (get-text-property (point) 'org-linked-text)))
10029 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10030 (lk0 (car lkall))
10031 (lk (if (stringp lk0) (list lk0) lk0))
10032 (lkend (cdr lkall)))
10033 (mapcar (lambda(l)
10034 (search-forward l nil lkend)
10035 (goto-char (match-beginning 0))
10036 (org-open-at-point))
10037 lk))
10038 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10039 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10040 ((and (org-at-timestamp-p t)
10041 (not (org-in-regexp org-bracket-link-regexp)))
10042 (org-follow-timestamp-link))
10043 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10044 (not (org-in-regexp org-any-link-re)))
10045 (org-footnote-action))
10046 (t
10047 (let (type path link line search (pos (point)))
10048 (catch 'match
10049 (save-excursion
10051 (when (org-in-regexp org-bracket-link-regexp 1)
10052 (setq link (org-extract-attributes
10053 (org-link-unescape (org-match-string-no-properties 1))))
10055 (setq link (replace-match " " t t link)))
10056 (setq link (org-link-expand-abbrev link))
10057 (cond
10058 ((or (file-name-absolute-p link)
10060 (setq type "file" path link))
10061 ((string-match org-link-re-with-space3 link)
10062 (setq type (match-string 1 link) path (match-string 2 link)))
10064 (setq type "help" path (match-string 1 link)))
10065 (t (setq type "thisfile" path link)))
10066 (throw 'match t)))
10068 (when (get-text-property (point) 'org-linked-text)
10069 (setq type "thisfile"
10070 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10071 (1+ (point)) (point))
10072 path (buffer-substring
10073 (or (previous-single-property-change pos 'org-linked-text)
10074 (point-min))
10075 (or (next-single-property-change pos 'org-linked-text)
10076 (point-max))))
10077 (throw 'match t))
10079 (save-excursion
10080 (when (or (org-in-regexp org-angle-link-re)
10081 (let ((match (org-in-regexp org-plain-link-re)))
10082 ;; Check a plain link is not within a bracket link
10083 (and match
10084 (save-excursion
10085 (progn
10086 (goto-char (car match))
10087 (not (org-in-regexp org-bracket-link-regexp))))))
10088 (let ((line_ending (save-excursion (end-of-line) (point))))
10089 ;; We are in a line before a plain or bracket link
10090 (or (re-search-forward org-plain-link-re line_ending t)
10091 (re-search-forward org-bracket-link-regexp line_ending t))))
10092 (setq type (match-string 1)
10093 path (org-link-unescape (match-string 2)))
10094 (throw 'match t)))
10095 (save-excursion
10097 (setq type "tags"
10098 path (match-string 1))
10099 (while (string-match ":" path)
10100 (setq path (replace-match "+" t t path)))
10101 (throw 'match t)))
10103 (setq type "tree-match"
10104 path (match-string 1))
10105 (throw 'match t)))
10106 (unless path
10107 (user-error "No link found"))
10109 ;; switch back to reference buffer
10110 ;; needed when if called in a temporary buffer through
10111 ;; org-open-link-from-string
10112 (with-current-buffer (or reference-buffer (current-buffer))
10114 ;; Remove any trailing spaces in path
10116 (setq path (replace-match "" t t path)))
10117 (if (and org-link-translation-function
10118 (fboundp org-link-translation-function))
10119 ;; Check if we need to translate the link
10120 (let ((tmp (funcall org-link-translation-function type path)))
10121 (setq type (car tmp) path (cdr tmp))))
10123 (cond
10125 ((assoc type org-link-protocols)
10126 (funcall (nth 1 (assoc type org-link-protocols)) path))
10128 ((equal type "help")
10129 (let ((f-or-v (intern path)))
10130 (cond ((fboundp f-or-v)
10131 (describe-function f-or-v))
10132 ((boundp f-or-v)
10133 (describe-variable f-or-v))
10134 (t (error "Not a known function or variable")))))
10136 ((equal type "mailto")
10137 (let ((cmd (car org-link-mailto-program))
10138 (args (cdr org-link-mailto-program)) args1
10139 (address path) (subject "") a)
10141 (setq address (match-string 1 path)
10142 subject (org-link-escape (match-string 2 path))))
10143 (while args
10144 (cond
10145 ((not (stringp (car args))) (push (pop args) args1))
10146 (t (setq a (pop args))
10147 (if (string-match "%a" a)
10148 (setq a (replace-match address t t a)))
10149 (if (string-match "%s" a)
10150 (setq a (replace-match subject t t a)))
10151 (push a args1))))
10152 (apply cmd (nreverse args1))))
10154 ((member type '("http" "https" "ftp" "news"))
10155 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10156 (org-link-escape
10157 path org-link-escape-chars-browser)
10158 path))))
10160 ((string= type "doi")
10161 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10162 (org-link-escape
10163 path org-link-escape-chars-browser)
10164 path))))
10166 ((member type '("message"))
10167 (browse-url (concat type ":" path)))
10169 ((string= type "tags")
10170 (org-tags-view arg path))
10172 ((string= type "tree-match")
10175 ((string= type "file")
10177 (setq line (string-to-number (match-string 1 path))
10178 path (substring path 0 (match-beginning 0)))
10180 (setq search (match-string 1 path)
10181 path (substring path 0 (match-beginning 0)))))
10182 (if (string-match "[*?{]" (file-name-nondirectory path))
10183 (dired path)
10184 (org-open-file path arg line search)))
10186 ((string= type "shell")
10187 (let ((buf (generate-new-buffer "*Org Shell Output"))
10188 (cmd path))
10189 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10190 (string-match org-confirm-shell-link-not-regexp cmd))
10191 (not org-confirm-shell-link-function)
10192 (funcall org-confirm-shell-link-function
10194 (org-add-props cmd nil
10195 'face 'org-warning))))
10196 (progn
10197 (message "Executing %s" cmd)
10198 (shell-command cmd buf)
10199 (if (featurep 'midnight)
10200 (setq clean-buffer-list-kill-buffer-names
10201 (cons buf clean-buffer-list-kill-buffer-names))))
10202 (error "Abort"))))
10204 ((string= type "elisp")
10205 (let ((cmd path))
10206 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10207 (string-match org-confirm-elisp-link-not-regexp cmd))
10208 (not org-confirm-elisp-link-function)
10209 (funcall org-confirm-elisp-link-function
10211 (org-add-props cmd nil
10212 'face 'org-warning))))
10213 (message "%s => %s" cmd
10214 (if (equal (string-to-char cmd) ?\()
10215 (eval (read cmd))
10216 (call-interactively (read cmd))))
10217 (error "Abort"))))
10219 ((and (string= type "thisfile")
10220 (run-hook-with-args-until-success
10221 'org-open-link-functions path)))
10223 ((string= type "thisfile")
10224 (if arg
10225 (switch-to-buffer-other-window
10226 (org-get-buffer-for-internal-link (current-buffer)))
10227 (org-mark-ring-push))
10228 (let ((cmd `(org-link-search
10229 ,path
10230 ,(cond ((equal arg '(4)) ''occur)
10231 ((equal arg '(16)) ''org-occur))
10232 ,pos)))
10233 (condition-case nil (let ((org-link-search-inhibit-query t))
10234 (eval cmd))
10235 (error (progn (widen) (eval cmd))))))
10237 (t (browse-url-at-point)))))))
10238 (move-marker org-open-link-marker nil)
10239 (run-hook-with-args 'org-follow-link-hook)))
10241 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10242 "Offer links in the current entry and return the selected link.
10243 If there is only one link, return it.
10244 If NTH is an integer, return the NTH link found.
10245 If ZERO is a string, check also this string for a link, and if
10246 there is one, return it."
10247 (with-current-buffer buffer
10248 (save-excursion
10249 (save-restriction
10250 (widen)
10251 (goto-char marker)
10255 (cnt ?0)
10256 (in-emacs (if (integerp nth) nil nth))
10257 have-zero end links link c)
10258 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10259 (push (match-string 0 zero) links)
10260 (setq cnt (1- cnt) have-zero t))
10261 (save-excursion
10262 (org-back-to-heading t)
10263 (setq end (save-excursion (outline-next-heading) (point)))
10264 (while (re-search-forward re end t)
10265 (push (match-string 0) links))
10266 (setq links (org-uniquify (reverse links))))
10267 (cond
10268 ((null links)
10269 (message "No links"))
10270 ((equal (length links) 1)
10271 (setq link (car links)))
10272 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10273 (setq link (nth (if have-zero nth (1- nth)) links)))
10274 (t ; we have to select a link
10275 (save-excursion
10276 (save-window-excursion
10277 (delete-other-windows)
10278 (with-output-to-temp-buffer "*Select Link*"
10279 (mapc (lambda (l)
10280 (if (not (string-match org-bracket-link-regexp l))
10282 (org-remove-angle-brackets l)))
10283 (if (match-end 3)
10285 (match-string 3 l) (match-string 1 l)))
10287 (match-string 1 l))))))
10288 links))
10289 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10290 (message "Select link to open, RET to open all:")
10291 (setq c (read-char-exclusive))
10292 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10293 (when (equal c ?q) (error "Abort"))
10294 (if (equal c ?\C-m)
10295 (setq link links)
10296 (setq nth (- c ?0))
10297 (if have-zero (setq nth (1+ nth)))
10298 (unless (and (integerp nth) (>= (length links) nth))
10299 (error "Invalid link selection"))
10300 (setq link (nth (1- nth) links)))))
10301 (cons link end))))))
10303 ;; Add special file links that specify the way of opening
10305 (org-add-link-type "file+sys" 'org-open-file-with-system)
10306 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10307 (defun org-open-file-with-system (path)
10308 "Open file at PATH using the system way of opening it."
10309 (org-open-file path 'system))
10310 (defun org-open-file-with-emacs (path)
10311 "Open file at PATH in Emacs."
10312 (org-open-file path 'emacs))
10315 ;;; File search
10317 (defvar org-create-file-search-functions nil
10318 "List of functions to construct the right search string for a file link.
10319 These functions are called in turn with point at the location to
10320 which the link should point.
10322 A function in the hook should first test if it would like to
10323 handle this file type, for example by checking the `major-mode'
10324 or the file extension. If it decides not to handle this file, it
10325 should just return nil to give other functions a chance. If it
10326 does handle the file, it must return the search string to be used
10327 when following the link. The search string will be part of the
10328 file link, given after a double colon, and `org-open-at-point'
10329 will automatically search for it. If special measures must be
10330 taken to make the search successful, another function should be
10331 added to the companion hook `org-execute-file-search-functions',
10332 which see.
10334 A function in this hook may also use `setq' to set the variable
10335 `description' to provide a suggestion for the descriptive text to
10336 be used for this link when it gets inserted into an Org-mode
10339 (defvar org-execute-file-search-functions nil
10340 "List of functions to execute a file search triggered by a link.
10342 Functions added to this hook must accept a single argument, the
10343 search string that was part of the file link, the part after the
10344 double colon. The function must first check if it would like to
10345 handle this search, for example by checking the `major-mode' or
10346 the file extension. If it decides not to handle this search, it
10347 should just return nil to give other functions a chance. If it
10348 does handle the search, it must return a non-nil value to keep
10349 other functions from trying.
10351 Each function can access the current prefix argument through the
10352 variable `current-prefix-argument'. Note that a single prefix is
10353 used to force opening a link in Emacs, so it may be good to only
10354 use a numeric or double prefix to guide the search function.
10356 In case this is needed, a function in this hook can also restore
10357 the window configuration before `org-open-at-point' was called using:
10359 (set-window-configuration org-window-config-before-follow-link)")
10361 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10362 (defun org-link-search (s &optional type avoid-pos stealth)
10363 "Search for a link search option.
10364 If S is surrounded by forward slashes, it is interpreted as a
10365 regular expression. In org-mode files, this will create an `org-occur'
10366 sparse tree. In ordinary files, `occur' will be used to list matches.
10367 If the current buffer is in `dired-mode', grep will be used to search
10368 in all files. If AVOID-POS is given, ignore matches near that position.
10370 When optional argument STEALTH is non-nil, do not modify
10371 visibility around point, thus ignoring
10372 `org-show-hierarchy-above', `org-show-following-heading' and
10373 `org-show-siblings' variables."
10374 (let ((case-fold-search t)
10378 org-emphasis-alist)
10380 (pos (point))
10381 (pre nil) (post nil)
10382 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10383 (cond
10384 ;; First check if there are any special search functions
10385 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10386 ;; Now try the builtin stuff
10387 ((and (equal (string-to-char s0) ?#)
10388 (> (length s0) 1)
10389 (save-excursion
10390 (goto-char (point-min))
10391 (and
10392 (re-search-forward
10394 (setq type 'dedicated
10395 pos (match-beginning 0))))
10396 ;; There is an exact target for this
10397 (goto-char pos)
10398 (org-back-to-heading t)))
10399 ((save-excursion
10400 (goto-char (point-min))
10401 (and
10402 (re-search-forward
10403 (concat "<<" (regexp-quote s0) ">>") nil t)
10404 (setq type 'dedicated
10405 pos (match-beginning 0))))
10406 ;; There is an exact target for this
10407 (goto-char pos))
10408 ((save-excursion
10409 (goto-char (point-min))
10410 (and
10411 (re-search-forward
10413 (setq type 'dedicated pos (match-beginning 0))))
10414 ;; Found an invisible target.
10415 (goto-char pos))
10416 ((save-excursion
10417 (goto-char (point-min))
10418 (and
10419 (re-search-forward
10421 (setq type 'dedicated pos (match-beginning 0))))
10422 ;; Found an element with a matching #+name affiliated keyword.
10423 (goto-char pos))
10425 (save-excursion
10426 (goto-char (point-min))
10427 (and
10428 (re-search-forward
10429 (concat "[^[]" (regexp-quote
10430 (format org-coderef-label-format
10431 (match-string 1 s0))))
10432 nil t)
10433 (setq type 'dedicated
10434 pos (1+ (match-beginning 0))))))
10435 ;; There is a coderef target for this
10436 (goto-char pos))
10438 ;; A regular expression
10439 (cond
10440 ((derived-mode-p 'org-mode)
10441 (org-occur (match-string 1 s)))
10442 (t (org-do-occur (match-string 1 s)))))
10443 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10444 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10445 (goto-char (point-min))
10446 (cond
10447 ((let (case-fold-search)
10448 (re-search-forward (format org-complex-heading-regexp-format
10449 (regexp-quote s))
10450 nil t))
10451 ;; OK, found a match
10452 (setq type 'dedicated)
10453 (goto-char (match-beginning 0)))
10454 ((and (not org-link-search-inhibit-query)
10455 (eq org-link-search-must-match-exact-headline 'query-to-create)
10456 (y-or-n-p "No match - create this as a new heading? "))
10457 (goto-char (point-max))
10458 (or (bolp) (newline))
10460 (beginning-of-line 0))
10461 (t
10462 (goto-char pos)
10463 (error "No match"))))
10464 (t
10465 ;; A normal search string
10466 (when (equal (string-to-char s) ?*)
10467 ;; Anchor on headlines, post may include tags.
10470 s (substring s 1)))
10471 (remove-text-properties
10472 0 (length s)
10473 '(face nil mouse-face nil keymap nil fontified nil) s)
10474 ;; Make a series of regular expressions to find a match
10483 re4 (concat "[^a-zA-Z_]" re4_)
10485 re1 (concat pre re2 post)
10486 re3 (concat pre (if pre re4_ re4) post)
10487 re5 (concat pre ".*" re4)
10488 re2 (concat pre re2)
10489 re2a (concat pre (if pre re2a_ re2a))
10490 re4 (concat pre (if pre re4_ re4))
10494 ))
10495 (cond
10496 ((eq type 'org-occur) (org-occur reall))
10497 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10498 (t (goto-char (point-min))
10499 (setq type 'fuzzy)
10500 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10501 (org-search-not-self 1 re1 nil t)
10502 (org-search-not-self 1 re2 nil t)
10503 (org-search-not-self 1 re2a nil t)
10504 (org-search-not-self 1 re3 nil t)
10505 (org-search-not-self 1 re4 nil t)
10506 (org-search-not-self 1 re5 nil t)
10507 )
10508 (goto-char (match-beginning 1))
10509 (goto-char pos)
10510 (error "No match"))))))
10511 (and (derived-mode-p 'org-mode)
10512 (not stealth)
10513 (org-show-context 'link-search))
10514 type))
10516 (defun org-search-not-self (group &rest args)
10517 "Execute `re-search-forward', but only accept matches that do not
10518 enclose the position of `org-open-link-marker'."
10519 (let ((m org-open-link-marker))
10520 (catch 'exit
10521 (while (apply 're-search-forward args)
10522 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10523 (goto-char (match-end group))
10524 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10525 (> (match-beginning 0) (marker-position m))
10526 (< (match-end 0) (marker-position m)))
10527 (save-match-data
10528 (or (not (org-in-regexp
10529 org-bracket-link-analytic-regexp 1))
10530 (not (match-end 4)) ; no description
10531 (and (<= (match-beginning 4) (point))
10532 (>= (match-end 4) (point))))))
10533 (throw 'exit (point))))))))
10535 (defun org-get-buffer-for-internal-link (buffer)
10536 "Return a buffer to be used for displaying the link target of internal links."
10537 (cond
10538 ((not org-display-internal-link-with-indirect-buffer)
10539 buffer)
10540 ((string-match "(Clone)$" (buffer-name buffer))
10541 (message "Buffer is already a clone, not making another one")
10542 ;; we also do not modify visibility in this case
10543 buffer)
10544 (t ; make a new indirect buffer for displaying the link
10545 (let* ((bn (buffer-name buffer))
10546 (ibn (concat bn "(Clone)"))
10547 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10548 (with-current-buffer ib (org-overview))
10549 ib))))
10551 (defun org-do-occur (regexp &optional cleanup)
10552 "Call the Emacs command `occur'.
10553 If CLEANUP is non-nil, remove the printout of the regular expression
10554 in the *Occur* buffer. This is useful if the regex is long and not useful
10555 to read."
10556 (occur regexp)
10557 (when cleanup
10558 (let ((cwin (selected-window)) win beg end)
10559 (when (setq win (get-buffer-window "*Occur*"))
10560 (select-window win))
10561 (goto-char (point-min))
10562 (when (re-search-forward "match[a-z]+" nil t)
10563 (setq beg (match-end 0))
10565 (setq end (1- (match-beginning 0)))))
10566 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10567 (goto-char (point-min))
10568 (select-window cwin))))
10570 ;;; The mark ring for links jumps
10572 (defvar org-mark-ring nil
10573 "Mark ring for positions before jumps in Org-mode.")
10574 (defvar org-mark-ring-last-goto nil
10575 "Last position in the mark ring used to go back.")
10576 ;; Fill and close the ring
10577 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10578 (loop for i from 1 to org-mark-ring-length do
10579 (push (make-marker) org-mark-ring))
10580 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10581 org-mark-ring)
10583 (defun org-mark-ring-push (&optional pos buffer)
10584 "Put the current position or POS into the mark ring and rotate it."
10585 (interactive)
10586 (setq pos (or pos (point)))
10587 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10588 (move-marker (car org-mark-ring)
10589 (or pos (point))
10590 (or buffer (current-buffer)))
10591 (message "%s"
10592 (substitute-command-keys
10595 (defun org-mark-ring-goto (&optional n)
10596 "Jump to the previous position in the mark ring.
10597 With prefix arg N, jump back that many stored positions. When
10598 called several times in succession, walk through the entire ring.
10599 Org-mode commands jumping to a different position in the current file,
10600 or to another Org-mode file, automatically push the old position
10601 onto the ring."
10602 (interactive "p")
10603 (let (p m)
10604 (if (eq last-command this-command)
10605 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10606 (setq p org-mark-ring))
10607 (setq org-mark-ring-last-goto p)
10608 (setq m (car p))
10609 (org-pop-to-buffer-same-window (marker-buffer m))
10610 (goto-char m)
10611 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10613 (defun org-remove-angle-brackets (s)
10614 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10615 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10616 s)
10617 (defun org-add-angle-brackets (s)
10618 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10619 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10620 s)
10621 (defun org-remove-double-quotes (s)
10624 s)
10626 ;;; Following specific links
10628 (defun org-follow-timestamp-link ()
10629 "Open an agenda view for the time-stamp date/range at point."
10630 (cond
10631 ((org-at-date-range-p t)
10632 (let ((org-agenda-start-on-weekday)
10633 (t1 (match-string 1))
10634 (t2 (match-string 2)) tt1 tt2)
10635 (setq tt1 (time-to-days (org-time-string-to-time t1))
10636 tt2 (time-to-days (org-time-string-to-time t2)))
10637 (let ((org-agenda-buffer-tmp-name
10638 (format "*Org Agenda(a:%s)"
10639 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10640 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10641 ((org-at-timestamp-p t)
10642 (let ((org-agenda-buffer-tmp-name
10643 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10644 (org-agenda-list nil (time-to-days (org-time-string-to-time
10645 (substring (match-string 1) 0 10)))
10646 1)))
10647 (t (error "This should not happen"))))
10650 ;;; Following file links
10651 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10652 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10653 (declare-function mailcap-mime-info
10654 "mailcap" (string &optional request no-decode))
10655 (defvar org-wait nil)
10656 (defun org-open-file (path &optional in-emacs line search)
10657 "Open the file at PATH.
10658 First, this expands any special file name abbreviations. Then the
10659 configuration variable `org-file-apps' is checked if it contains an
10660 entry for this file type, and if yes, the corresponding command is launched.
10662 If no application is found, Emacs simply visits the file.
10664 With optional prefix argument IN-EMACS, Emacs will visit the file.
10666 prefix arg, Org tries to avoid opening in Emacs
10667 and to use an external application to visit the file.
10669 Optional LINE specifies a line to go to, optional SEARCH a string
10670 to search for. If LINE or SEARCH is given, the file will be
10671 opened in Emacs, unless an entry from org-file-apps that makes
10672 use of groups in a regexp matches.
10674 If you want to change the way frames are used when following a
10675 link, please customize `org-link-frame-setup'.
10677 If the file does not exist, an error is thrown."
10678 (let* ((file (if (equal path "")
10679 buffer-file-name
10680 (substitute-in-file-name (expand-file-name path))))
10681 (file-apps (append org-file-apps (org-default-apps)))
10682 (apps (org-remove-if
10683 'org-file-apps-entry-match-against-dlink-p file-apps))
10684 (apps-dlink (org-remove-if-not
10685 'org-file-apps-entry-match-against-dlink-p file-apps))
10686 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10687 (dirp (if remp nil (file-directory-p file)))
10688 (file (if (and dirp org-open-directory-means-index-dot-org)
10689 (concat (file-name-as-directory file) "index.org")
10690 file))
10691 (a-m-a-p (assq 'auto-mode apps))
10692 (dfile (downcase file))
10693 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10694 (link (cond ((and (eq line nil)
10695 (eq search nil))
10696 file)
10697 (line
10698 (concat file "::" (number-to-string line)))
10699 (search
10700 (concat file "::" search))))
10701 (dlink (downcase link))
10702 (old-buffer (current-buffer))
10703 (old-pos (point))
10704 (old-mode major-mode)
10705 ext cmd link-match-data)
10707 (setq ext (match-string 1 dfile))
10709 (setq ext (match-string 1 dfile))))
10710 (cond
10711 ((member in-emacs '((16) system))
10712 (setq cmd (cdr (assoc 'system apps))))
10713 (in-emacs (setq cmd 'emacs))
10714 (t
10715 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10716 (and dirp (cdr (assoc 'directory apps)))
10717 ; first, try matching against apps-dlink
10718 ; if we get a match here, store the match data for later
10719 (let ((match (assoc-default dlink apps-dlink
10720 'string-match)))
10721 (if match
10722 (progn (setq link-match-data (match-data))
10723 match)
10724 (progn (setq in-emacs (or in-emacs line search))
10725 nil))) ; if we have no match in apps-dlink,
10726 ; always open the file in emacs if line or search
10727 ; is given (for backwards compatibility)
10728 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10729 'string-match)
10730 (cdr (assoc ext apps))
10731 (cdr (assoc t apps))))))
10732 (when (eq cmd 'system)
10733 (setq cmd (cdr (assoc 'system apps))))
10734 (when (eq cmd 'default)
10735 (setq cmd (cdr (assoc t apps))))
10736 (when (eq cmd 'mailcap)
10737 (require 'mailcap)
10738 (mailcap-parse-mailcaps)
10739 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10740 (command (mailcap-mime-info mime-type)))
10741 (if (stringp command)
10742 (setq cmd command)
10743 (setq cmd 'emacs))))
10744 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10745 (not (file-exists-p file))
10746 (not org-open-non-existing-files))
10747 (error "No such file: %s" file))
10748 (cond
10750 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10752 (setq cmd (replace-match "%s" t t cmd)))
10753 (while (string-match "%s" cmd)
10754 (setq cmd (replace-match
10755 (save-match-data
10756 (shell-quote-argument
10757 (convert-standard-filename file)))
10758 t t cmd)))
10760 ;; Replace "%1", "%2" etc. in command with group matches from regex
10761 (save-match-data
10762 (let ((match-index 1)
10763 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10764 (set-match-data link-match-data)
10765 (while (<= match-index number-of-groups)
10766 (let ((regex (concat "%" (number-to-string match-index)))
10767 (replace-with (match-string match-index dlink)))
10768 (while (string-match regex cmd)
10769 (setq cmd (replace-match replace-with t t cmd))))
10770 (setq match-index (+ match-index 1)))))
10772 (save-window-excursion
10773 (message "Running %s...done" cmd)
10774 (start-process-shell-command cmd nil cmd)
10775 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
10776 ((or (stringp cmd)
10777 (eq cmd 'emacs))
10778 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10779 (widen)
10780 (if line (org-goto-line line)
10781 (if search (org-link-search search))))
10782 ((consp cmd)
10783 (let ((file (convert-standard-filename file)))
10784 (save-match-data
10785 (set-match-data link-match-data)
10786 (eval cmd))))
10787 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10788 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10789 (or (not (equal old-buffer (current-buffer)))
10790 (not (equal old-pos (point))))
10791 (org-mark-ring-push old-pos old-buffer))))
10793 (defun org-file-apps-entry-match-against-dlink-p (entry)
10794 "This function returns non-nil if `entry' uses a regular
10795 expression which should be matched against the whole link by
10796 org-open-file.
10798 It assumes that is the case when the entry uses a regular
10799 expression which has at least one grouping construct and the
10800 action is either a lisp form or a command string containing
10801 '%1', i.e. using at least one subexpression match as a
10802 parameter."
10803 (let ((selector (car entry))
10804 (action (cdr entry)))
10805 (if (stringp selector)
10806 (and (> (regexp-opt-depth selector) 0)
10807 (or (and (stringp action)
10808 (string-match "%[0-9]" action))
10809 (consp action)))
10810 nil)))
10812 (defun org-default-apps ()
10813 "Return the default applications for this operating system."
10814 (cond
10815 ((eq system-type 'darwin)
10816 org-file-apps-defaults-macosx)
10817 ((eq system-type 'windows-nt)
10818 org-file-apps-defaults-windowsnt)
10819 (t org-file-apps-defaults-gnu)))
10821 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10822 "Convert extensions to regular expressions in the cars of LIST.
10823 Also, weed out any non-string entries, because the return value is used
10824 only for regexp matching.
10825 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10826 point to the symbol `emacs', indicating that the file should
10827 be opened in Emacs."
10828 (append
10829 (delq nil
10830 (mapcar (lambda (x)
10831 (if (not (stringp (car x)))
10832 nil
10834 x
10836 list))
10837 (if add-auto-mode
10838 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10840 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10841 (defun org-file-remote-p (file)
10842 "Test whether FILE specifies a location on a remote system.
10843 Return non-nil if the location is indeed remote.
10847 (cond ((fboundp 'file-remote-p)
10848 (file-remote-p file))
10849 ((fboundp 'tramp-handle-file-remote-p)
10850 (tramp-handle-file-remote-p file))
10851 ((and (boundp 'ange-ftp-name-format)
10852 (string-match (car ange-ftp-name-format) file))
10853 t)))
10856 ;;;; Refiling
10858 (defun org-get-org-file ()
10859 "Read a filename, with default directory `org-directory'."
10860 (let ((default (or org-default-notes-file remember-data-file)))
10861 (read-file-name (format "File name [%s]: " default)
10862 (file-name-as-directory org-directory)
10863 default)))
10865 (defun org-notes-order-reversed-p ()
10866 "Check if the current file should receive notes in reversed order."
10867 (cond
10868 ((not org-reverse-note-order) nil)
10869 ((eq t org-reverse-note-order) t)
10870 ((not (listp org-reverse-note-order)) nil)
10871 (t (catch 'exit
10872 (let ((all org-reverse-note-order)
10873 entry)
10874 (while (setq entry (pop all))
10875 (if (string-match (car entry) buffer-file-name)
10876 (throw 'exit (cdr entry))))
10877 nil)))))
10879 (defvar org-refile-target-table nil
10880 "The list of refile targets, created by `org-refile'.")
10882 (defvar org-agenda-new-buffers nil
10883 "Buffers created to visit agenda files.")
10885 (defvar org-refile-cache nil
10886 "Cache for refile targets.")
10888 (defvar org-refile-markers nil
10889 "All the markers used for caching refile locations.")
10891 (defun org-refile-marker (pos)
10892 "Get a new refile marker, but only if caching is in use."
10893 (if (not org-refile-use-cache)
10894 pos
10895 (let ((m (make-marker)))
10896 (move-marker m pos)
10897 (push m org-refile-markers)
10898 m)))
10900 (defun org-refile-cache-clear ()
10901 "Clear the refile cache and disable all the markers."
10902 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10903 (setq org-refile-markers nil)
10904 (setq org-refile-cache nil)
10905 (message "Refile cache has been cleared"))
10907 (defun org-refile-cache-check-set (set)
10908 "Check if all the markers in the cache still have live buffers."
10909 (let (marker)
10910 (catch 'exit
10911 (while (and set (setq marker (nth 3 (pop set))))
10912 ;; if org-refile-use-outline-path is 'file, marker may be nil
10913 (when (and marker (null (marker-buffer marker)))
10914 (message "not found") (sit-for 3)
10915 (throw 'exit nil)))
10916 t)))
10918 (defun org-refile-cache-put (set &rest identifiers)
10919 "Push the refile targets SET into the cache, under IDENTIFIERS."
10920 (let* ((key (sha1 (prin1-to-string identifiers)))
10921 (entry (assoc key org-refile-cache)))
10922 (if entry
10923 (setcdr entry set)
10924 (push (cons key set) org-refile-cache))))
10926 (defun org-refile-cache-get (&rest identifiers)
10927 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10928 (cond
10929 ((not org-refile-cache) nil)
10930 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10931 (t
10932 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10933 org-refile-cache))))
10934 (and set (org-refile-cache-check-set set) set)))))
10936 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10937 "Produce a table with refile targets."
10938 (let ((case-fold-search nil)
10939 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10940 (entries (or org-refile-targets '((nil . (:level . 1)))))
10941 targets tgs txt re files f desc descre fast-path-p level pos0)
10942 (message "Getting targets...")
10943 (with-current-buffer (or default-buffer (current-buffer))
10944 (while (setq entry (pop entries))
10945 (setq files (car entry) desc (cdr entry))
10946 (setq fast-path-p nil)
10947 (cond
10948 ((null files) (setq files (list (current-buffer))))
10949 ((eq files 'org-agenda-files)
10950 (setq files (org-agenda-files 'unrestricted)))
10951 ((and (symbolp files) (fboundp files))
10952 (setq files (funcall files)))
10953 ((and (symbolp files) (boundp files))
10954 (setq files (symbol-value files))))
10955 (if (stringp files) (setq files (list files)))
10956 (cond
10957 ((eq (car desc) :tag)
10959 ((eq (car desc) :todo)
10961 ((eq (car desc) :regexp)
10962 (setq descre (cdr desc)))
10963 ((eq (car desc) :level)
10965 (if org-odd-levels-only
10966 (1- (* 2 (cdr desc)))
10967 (cdr desc)))
10969 ((eq (car desc) :maxlevel)
10970 (setq fast-path-p t)
10972 (if org-odd-levels-only
10973 (1- (* 2 (cdr desc)))
10974 (cdr desc)))
10976 (t (error "Bad refiling target description %s" desc)))
10977 (while (setq f (pop files))
10978 (with-current-buffer
10979 (if (bufferp f) f (org-get-agenda-file-buffer f))
10980 (or
10981 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10982 (progn
10983 (if (bufferp f) (setq f (buffer-file-name
10984 (buffer-base-buffer f))))
10985 (setq f (and f (expand-file-name f)))
10986 (if (eq org-refile-use-outline-path 'file)
10987 (push (list (file-name-nondirectory f) f nil nil) tgs))
10988 (save-excursion
10989 (save-restriction
10990 (widen)
10991 (goto-char (point-min))
10992 (while (re-search-forward descre nil t)
10993 (goto-char (setq pos0 (point-at-bol)))
10994 (catch 'next
10995 (when org-refile-target-verify-function
10996 (save-match-data
10997 (or (funcall org-refile-target-verify-function)
10998 (throw 'next t))))
10999 (when (and (looking-at org-complex-heading-regexp)
11000 (not (member (match-string 4) excluded-entries))
11001 (match-string 4))
11002 (setq level (org-reduced-level
11003 (- (match-end 1) (match-beginning 1)))
11004 txt (org-link-display-format (match-string 4))
11006 re (format org-complex-heading-regexp-format
11007 (regexp-quote (match-string 4))))
11008 (when org-refile-use-outline-path
11009 (setq txt (mapconcat
11010 'org-protect-slash
11011 (append
11012 (if (eq org-refile-use-outline-path
11013 'file)
11014 (list (file-name-nondirectory
11015 (buffer-file-name
11016 (buffer-base-buffer))))
11017 (if (eq org-refile-use-outline-path
11018 'full-file-path)
11019 (list (buffer-file-name
11020 (buffer-base-buffer)))))
11021 (org-get-outline-path fast-path-p
11022 level txt)
11023 (list txt))
11024 "/")))
11025 (push (list txt f re (org-refile-marker (point)))
11026 tgs)))
11027 (when (= (point) pos0)
11028 ;; verification function has not moved point
11029 (goto-char (point-at-eol))))))))
11030 (when org-refile-use-cache
11031 (org-refile-cache-put tgs (buffer-file-name) descre))
11032 (setq targets (append tgs targets))
11033 ))))
11034 (message "Getting targets...done")
11035 (nreverse targets)))
11037 (defun org-protect-slash (s)
11038 (while (string-match "/" s)
11040 s)
11042 (defvar org-olpa (make-vector 20 nil))
11044 (defun org-get-outline-path (&optional fastp level heading)
11045 "Return the outline path to the current entry, as a list.
11047 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11048 routine which makes outline path derivations for an entire file,
11049 avoiding backtracing. Refile target collection makes use of that."
11050 (if fastp
11051 (progn
11052 (if (> level 19)
11053 (error "Outline path failure, more than 19 levels"))
11054 (loop for i from level upto 19 do
11055 (aset org-olpa i nil))
11056 (prog1
11057 (delq nil (append org-olpa nil))
11058 (aset org-olpa level heading)))
11059 (let (rtn case-fold-search)
11060 (save-excursion
11061 (save-restriction
11062 (widen)
11063 (while (org-up-heading-safe)
11064 (when (looking-at org-complex-heading-regexp)
11065 (push (org-match-string-no-properties 4) rtn)))
11066 rtn)))))
11068 (defun org-format-outline-path (path &optional width prefix separator)
11069 "Format the outline path PATH for display.
11070 WIDTH is the maximum number of characters that is available.
11071 PREFIX is a prefix to be included in the returned string,
11072 such as the file name.
11073 SEPARATOR is inserted between the different parts of the path,
11075 (setq width (or width 79))
11076 (if prefix (setq width (- width (length prefix))))
11077 (if (not path)
11078 (or prefix "")
11079 (let* ((nsteps (length path))
11080 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11081 (maxwidth (if (<= total-width width)
11082 10000 ;; everything fits
11083 ;; we need to shorten the level headings
11084 (/ (- width nsteps) nsteps)))
11085 (org-odd-levels-only nil)
11086 (n 0)
11087 (total (1+ (length prefix))))
11088 (setq maxwidth (max maxwidth 10))
11089 (concat prefix
11090 (if prefix (or separator "/"))
11091 (mapconcat
11092 (lambda (h)
11093 (setq n (1+ n))
11094 (if (and (= n nsteps) (< maxwidth 10000))
11095 (setq maxwidth (- total-width total)))
11096 (if (< (length h) maxwidth)
11097 (progn (setq total (+ total (length h) 1)) h)
11098 (setq h (substring h 0 (- maxwidth 2))
11099 total (+ total maxwidth 1))
11101 (setq h (substring h 0 (match-beginning 0))))
11102 (setq h (concat h "..")))
11103 (org-add-props h nil 'face
11104 (nth (% (1- n) org-n-level-faces)
11105 org-level-faces))
11106 h)
11107 path (or separator "/"))))))
11109 (defun org-display-outline-path (&optional file current separator just-return-string)
11110 "Display the current outline path in the echo area.
11112 If FILE is non-nil, prepend the output with the file name.
11113 If CURRENT is non-nil, append the current heading to the output.
11114 SEPARATOR is passed through to `org-format-outline-path'. It separates
11116 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11117 (interactive "P")
11118 (let* (case-fold-search
11119 message-log-max ; Don't populate the *Messages* buffer
11120 (bfn (buffer-file-name (buffer-base-buffer)))
11121 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11122 res)
11123 (if current (setq path (append path
11124 (save-excursion
11125 (org-back-to-heading t)
11126 (if (looking-at org-complex-heading-regexp)
11127 (list (match-string 4)))))))
11128 (setq res
11129 (org-format-outline-path
11130 path
11131 (1- (frame-width))
11132 (and file bfn (concat (file-name-nondirectory bfn) separator))
11133 separator))
11134 (if just-return-string
11135 (org-no-properties res)
11136 (message "%s" res))))
11138 (defvar org-refile-history nil
11139 "History for refiling operations.")
11141 (defvar org-after-refile-insert-hook nil
11142 "Hook run after `org-refile' has inserted its stuff at the new location.
11143 Note that this is still *before* the stuff will be removed from
11144 the *old* location.")
11146 (defvar org-capture-last-stored-marker)
11147 (defvar org-refile-keep nil
11148 "Non-nil means `org-refile' will copy instead of refile.")
11150 (defun org-copy ()
11151 "Like `org-refile', but copy."
11152 (interactive)
11153 (let ((org-refile-keep t))
11154 (funcall 'org-refile nil nil nil "Copy")))
11156 (defun org-refile (&optional goto default-buffer rfloc msg)
11157 "Move the entry or entries at point to another heading.
11158 The list of target headings is compiled using the information in
11159 `org-refile-targets', which see.
11161 At the target location, the entry is filed as a subitem of the target
11162 heading. Depending on `org-reverse-note-order', the new subitem will
11163 either be the first or the last subitem.
11165 If there is an active region, all entries in that region will be moved.
11166 However, the region must fulfill the requirement that the first heading
11167 is the first one sets the top-level of the moved text - at most siblings
11168 below it are allowed.
11170 With prefix arg GOTO, the command will only visit the target location
11171 and not actually move anything.
11174 go to the location where the last refiling operation has put the subtree.
11175 With a prefix argument of `2', refile to the running clock.
11177 RFLOC can be a refile location obtained in a different way.
11182 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11184 If you are using target caching (see `org-refile-use-cache'),
11185 you have to clear the target cache in order to find new targets.
11186 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11187 prefix argument (`C-u C-u C-u C-c C-w')."
11189 (interactive "P")
11190 (if (member goto '(0 (64)))
11191 (org-refile-cache-clear)
11192 (let* ((actionmsg (or msg "Refile"))
11193 (cbuf (current-buffer))
11194 (regionp (org-region-active-p))
11195 (region-start (and regionp (region-beginning)))
11196 (region-end (and regionp (region-end)))
11197 (region-length (and regionp (- region-end region-start)))
11198 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11199 pos it nbuf file re level reversed)
11200 (setq last-command nil)
11201 (when regionp
11202 (goto-char region-start)
11203 (or (bolp) (goto-char (point-at-bol)))
11204 (setq region-start (point))
11205 (unless (or (org-kill-is-subtree-p
11206 (buffer-substring region-start region-end))
11207 (prog1 org-refile-active-region-within-subtree
11208 (org-toggle-heading)))
11209 (error "The region is not a (sequence of) subtree(s)")))
11210 (if (equal goto '(16))
11211 (org-refile-goto-last-stored)
11212 (when (or
11213 (and (equal goto 2)
11214 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11215 (prog1
11216 (setq it (list (or org-clock-heading "running clock")
11217 (buffer-file-name
11218 (marker-buffer org-clock-hd-marker))
11219 ""
11220 (marker-position org-clock-hd-marker)))
11221 (setq goto nil)))
11222 (setq it (or rfloc
11223 (let (heading-text)
11224 (save-excursion
11225 (unless goto
11226 (org-back-to-heading t)
11227 (setq heading-text
11228 (nth 4 (org-heading-components))))
11230 (org-refile-get-location
11231 (cond (goto "Goto")
11232 (regionp (concat actionmsg " region to"))
11235 default-buffer
11236 (and (not (equal '(4) goto))
11237 org-refile-allow-creating-parent-nodes)
11238 goto))))))
11239 (setq file (nth 1 it)
11240 re (nth 2 it)
11241 pos (nth 3 it))
11242 (if (and (not goto)
11243 pos
11244 (equal (buffer-file-name) file)
11245 (if regionp
11246 (and (>= pos region-start)
11247 (<= pos region-end))
11248 (and (>= pos (point))
11249 (< pos (save-excursion
11250 (org-end-of-subtree t t))))))
11251 (error "Cannot refile to position inside the tree or region"))
11253 (setq nbuf (or (find-buffer-visiting file)
11254 (find-file-noselect file)))
11255 (if goto
11256 (progn
11257 (org-pop-to-buffer-same-window nbuf)
11258 (goto-char pos)
11259 (org-show-context 'org-goto))
11260 (if regionp
11261 (progn
11262 (org-kill-new (buffer-substring region-start region-end))
11263 (org-save-markers-in-region region-start region-end))
11264 (org-copy-subtree 1 nil t))
11265 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11266 (find-file-noselect file)))
11267 (setq reversed (org-notes-order-reversed-p))
11268 (save-excursion
11269 (save-restriction
11270 (widen)
11271 (if pos
11272 (progn
11273 (goto-char pos)
11274 (looking-at org-outline-regexp)
11275 (setq level (org-get-valid-level (funcall outline-level) 1))
11276 (goto-char
11277 (if reversed
11278 (or (outline-next-heading) (point-max))
11279 (or (save-excursion (org-get-next-sibling))
11280 (org-end-of-subtree t t)
11281 (point-max)))))
11282 (setq level 1)
11283 (if (not reversed)
11284 (goto-char (point-max))
11285 (goto-char (point-min))
11286 (or (outline-next-heading) (goto-char (point-max)))))
11287 (if (not (bolp)) (newline))
11288 (org-paste-subtree level)
11289 (when org-log-refile
11290 (org-add-log-setup 'refile nil nil 'findpos
11291 org-log-refile)
11292 (unless (eq org-log-refile 'note)
11293 (save-excursion (org-add-log-note))))
11294 (and org-auto-align-tags
11295 (let ((org-loop-over-headlines-in-active-region nil))
11296 (org-set-tags nil t)))
11297 (with-demoted-errors
11298 (bookmark-set "org-refile-last-stored"))
11299 ;; If we are refiling for capture, make sure that the
11300 ;; last-capture pointers point here
11301 (when (org-bound-and-true-p org-refile-for-capture)
11302 (with-demoted-errors
11303 (bookmark-set "org-capture-last-stored-marker"))
11304 (move-marker org-capture-last-stored-marker (point)))
11305 (if (fboundp 'deactivate-mark) (deactivate-mark))
11306 (run-hooks 'org-after-refile-insert-hook))))
11307 (unless org-refile-keep
11308 (if regionp
11309 (delete-region (point) (+ (point) region-length))
11310 (org-cut-subtree)))
11311 (when (featurep 'org-inlinetask)
11312 (org-inlinetask-remove-END-maybe))
11313 (setq org-markers-to-move nil)
11316 (defun org-refile-goto-last-stored ()
11317 "Go to the location where the last refile was stored."
11318 (interactive)
11319 (bookmark-jump "org-refile-last-stored")
11320 (message "This is the location of the last refile"))
11322 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11323 no-exclude)
11324 "Prompt the user for a refile location, using PROMPT.
11325 PROMPT should not be suffixed with a colon and a space, because
11326 this function appends the default value from
11327 `org-refile-history' automatically, if that is not empty.
11328 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11329 this is used for the GOTO interface."
11330 (let ((org-refile-targets org-refile-targets)
11331 (org-refile-use-outline-path org-refile-use-outline-path)
11332 excluded-entries)
11333 (when (and (derived-mode-p 'org-mode)
11334 (not org-refile-use-cache)
11335 (not no-exclude))
11336 (org-map-tree
11337 (lambda()
11338 (setq excluded-entries
11339 (append excluded-entries (list (org-get-heading t t)))))))
11340 (setq org-refile-target-table
11341 (org-refile-get-targets default-buffer excluded-entries)))
11342 (unless org-refile-target-table
11343 (error "No refile targets"))
11344 (let* ((cbuf (current-buffer))
11345 (partial-completion-mode nil)
11346 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11347 (cfunc (if (and org-refile-use-outline-path
11348 org-outline-path-complete-in-steps)
11349 'org-olpath-completing-read
11350 'org-icompleting-read))
11351 (extra (if org-refile-use-outline-path "/" ""))
11352 (cbnex (concat (buffer-name) extra))
11353 (filename (and cfn (expand-file-name cfn)))
11354 (tbl (mapcar
11355 (lambda (x)
11356 (if (and (not (member org-refile-use-outline-path
11357 '(file full-file-path)))
11358 (not (equal filename (nth 1 x))))
11359 (cons (concat (car x) extra " ("
11360 (file-name-nondirectory (nth 1 x)) ")")
11361 (cdr x))
11362 (cons (concat (car x) extra) (cdr x))))
11363 org-refile-target-table))
11364 (completion-ignore-case t)
11365 cdef
11366 (prompt (concat prompt
11367 (or (and (car org-refile-history)
11368 (concat " (default " (car org-refile-history) ")"))
11369 (and (assoc cbnex tbl) (setq cdef cbnex)
11370 (concat " (default " cbnex ")"))) ": "))
11371 pa answ parent-target child parent old-hist)
11372 (setq old-hist org-refile-history)
11373 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11374 nil 'org-refile-history (or cdef (car org-refile-history))))
11375 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11376 (org-refile-check-position pa)
11377 (if pa
11378 (progn
11379 (when (or (not org-refile-history)
11380 (not (eq old-hist org-refile-history))
11381 (not (equal (car pa) (car org-refile-history))))
11382 (setq org-refile-history
11383 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11384 org-refile-history
11385 (cdr org-refile-history))))
11386 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11387 (pop org-refile-history)))
11388 pa)
11390 (progn
11391 (setq parent (match-string 1 answ)
11392 child (match-string 2 answ))
11393 (setq parent-target (or (assoc parent tbl)
11394 (assoc (concat parent "/") tbl)))
11395 (when (and parent-target
11396 (or (eq new-nodes t)
11397 (and (eq new-nodes 'confirm)
11399 child)))))
11400 (org-refile-new-child parent-target child)))
11401 (error "Invalid target location")))))
11403 (declare-function org-string-nw-p "org-macs" (s))
11404 (defun org-refile-check-position (refile-pointer)
11405 "Check if the refile pointer matches the headline to which it points."
11406 (let* ((file (nth 1 refile-pointer))
11407 (re (nth 2 refile-pointer))
11408 (pos (nth 3 refile-pointer))
11409 buffer)
11410 (if (and (not (markerp pos)) (not file))
11411 (error "Please save the buffer to a file before refiling")
11412 (when (org-string-nw-p re)
11413 (setq buffer (if (markerp pos)
11414 (marker-buffer pos)
11415 (or (find-buffer-visiting file)
11416 (find-file-noselect file))))
11417 (with-current-buffer buffer
11418 (save-excursion
11419 (save-restriction
11420 (widen)
11421 (goto-char pos)
11422 (beginning-of-line 1)
11423 (unless (org-looking-at-p re)
11424 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11426 (defun org-refile-new-child (parent-target child)
11427 "Use refile target PARENT-TARGET to add new CHILD below it."
11428 (unless parent-target
11429 (error "Cannot find parent for new node"))
11430 (let ((file (nth 1 parent-target))
11431 (pos (nth 3 parent-target))
11432 level)
11433 (with-current-buffer (or (find-buffer-visiting file)
11434 (find-file-noselect file))
11435 (save-excursion
11436 (save-restriction
11437 (widen)
11438 (if pos
11439 (goto-char pos)
11440 (goto-char (point-max))
11441 (if (not (bolp)) (newline)))
11442 (when (looking-at org-outline-regexp)
11443 (setq level (funcall outline-level))
11444 (org-end-of-subtree t t))
11445 (org-back-over-empty-lines)
11447 (if pos (org-get-valid-level level 1) 1) ?*)
11449 (beginning-of-line 0)
11450 (list (concat (car parent-target) "/" child) file "" (point)))))))
11452 (defun org-olpath-completing-read (prompt collection &rest args)
11453 "Read an outline path like a file name."
11454 (let ((thetable collection)
11455 (org-completion-use-ido nil) ; does not work with ido.
11456 (org-completion-use-iswitchb nil)) ; or iswitchb
11457 (apply
11458 'org-icompleting-read prompt
11459 (lambda (string predicate &optional flag)
11460 (let (rtn r f (l (length string)))
11461 (cond
11462 ((eq flag nil)
11463 ;; try completion
11464 (try-completion string thetable))
11465 ((eq flag t)
11466 ;; all-completions
11467 (setq rtn (all-completions string thetable predicate))
11468 (mapcar
11469 (lambda (x)
11470 (setq r (substring x l))
11471 (if (string-match " ([^)]*)$" x)
11472 (setq f (match-string 0 x))
11473 (setq f ""))
11474 (if (string-match "/" r)
11475 (concat string (substring r 0 (match-end 0)) f)
11476 x))
11477 rtn))
11478 ((eq flag 'lambda)
11479 ;; exact match?
11480 (assoc string thetable)))))
11481 args)))
11483 ;;;; Dynamic blocks
11485 (defun org-find-dblock (name)
11486 "Find the first dynamic block with name NAME in the buffer.
11487 If not found, stay at current position and return nil."
11488 (let ((case-fold-search t) pos)
11489 (save-excursion
11490 (goto-char (point-min))
11491 (setq pos (and (re-search-forward
11493 (match-beginning 0))))
11494 (if pos (goto-char pos))
11495 pos))
11497 (defconst org-dblock-start-re
11499 "Matches the start line of a dynamic block, with parameters.")
11502 "Matches the end of a dynamic block.")
11504 (defun org-create-dblock (plist)
11505 "Create a dynamic block section, with parameters taken from PLIST.
11506 PLIST must contain a :name entry which is used as name of the block."
11508 (end-of-line 1)
11509 (newline))
11510 (let ((col (current-column))
11511 (name (plist-get plist :name)))
11512 (insert "#+BEGIN: " name)
11513 (while plist
11514 (if (eq (car plist) :name)
11515 (setq plist (cddr plist))
11516 (insert " " (prin1-to-string (pop plist)))))
11518 (beginning-of-line -2)))
11520 (defun org-prepare-dblock ()
11521 "Prepare dynamic block for refresh.
11522 This empties the block, puts the cursor at the insert position and returns
11523 the property list including an extra property :name with the block name."
11524 (unless (looking-at org-dblock-start-re)
11525 (error "Not at a dynamic block"))
11526 (let* ((begdel (1+ (match-end 0)))
11527 (name (org-no-properties (match-string 1)))
11528 (params (append (list :name name)
11529 (read (concat "(" (match-string 3) ")")))))
11530 (save-excursion
11531 (beginning-of-line 1)
11533 (setq params (plist-put params :indentation-column (current-column))))
11534 (unless (re-search-forward org-dblock-end-re nil t)
11535 (error "Dynamic block not terminated"))
11536 (setq params
11537 (append params
11538 (list :content (buffer-substring
11539 begdel (match-beginning 0)))))
11540 (delete-region begdel (match-beginning 0))
11541 (goto-char begdel)
11542 (open-line 1)
11543 params))
11545 (defun org-map-dblocks (&optional command)
11546 "Apply COMMAND to all dynamic blocks in the current buffer.
11547 If COMMAND is not given, use `org-update-dblock'."
11548 (let ((cmd (or command 'org-update-dblock)))
11549 (save-excursion
11550 (goto-char (point-min))
11551 (while (re-search-forward org-dblock-start-re nil t)
11552 (goto-char (match-beginning 0))
11553 (save-excursion
11554 (condition-case nil
11555 (funcall cmd)
11556 (error (message "Error during update of dynamic block"))))
11557 (unless (re-search-forward org-dblock-end-re nil t)
11558 (error "Dynamic block not terminated"))))))
11560 (defun org-dblock-update (&optional arg)
11561 "User command for updating dynamic blocks.
11562 Update the dynamic block at point. With prefix ARG, update all dynamic
11563 blocks in the buffer."
11564 (interactive "P")
11565 (if arg
11566 (org-update-all-dblocks)
11567 (or (looking-at org-dblock-start-re)
11568 (org-beginning-of-dblock))
11569 (org-update-dblock)))
11571 (defun org-update-dblock ()
11572 "Update the dynamic block at point.
11573 This means to empty the block, parse for parameters and then call
11574 the correct writing function."
11575 (interactive)
11576 (save-window-excursion
11577 (let* ((pos (point))
11578 (line (org-current-line))
11579 (params (org-prepare-dblock))
11580 (name (plist-get params :name))
11581 (indent (plist-get params :indentation-column))
11582 (cmd (intern (concat "org-dblock-write:" name))))
11583 (message "Updating dynamic block `%s' at line %d..." name line)
11584 (funcall cmd params)
11585 (message "Updating dynamic block `%s' at line %d...done" name line)
11586 (goto-char pos)
11587 (when (and indent (> indent 0))
11588 (setq indent (make-string indent ?\ ))
11589 (save-excursion
11590 (org-beginning-of-dblock)
11591 (forward-line 1)
11592 (while (not (looking-at org-dblock-end-re))
11593 (insert indent)
11594 (beginning-of-line 2))
11595 (when (looking-at org-dblock-end-re)
11597 (replace-match ""))
11598 (insert indent)))))))
11600 (defun org-beginning-of-dblock ()
11601 "Find the beginning of the dynamic block at point.
11602 Error if there is no such block at point."
11603 (let ((pos (point))
11604 beg)
11605 (end-of-line 1)
11606 (if (and (re-search-backward org-dblock-start-re nil t)
11607 (setq beg (match-beginning 0))
11608 (re-search-forward org-dblock-end-re nil t)
11609 (> (match-end 0) pos))
11610 (goto-char beg)
11611 (goto-char pos)
11612 (error "Not in a dynamic block"))))
11614 (defun org-update-all-dblocks ()
11615 "Update all dynamic blocks in the buffer.
11616 This function can be used in a hook."
11617 (interactive)
11618 (when (derived-mode-p 'org-mode)
11619 (org-map-dblocks 'org-update-dblock)))
11622 ;;;; Completion
11624 (defun org-get-export-keywords ()
11625 "Return a list of all currently understood export keywords.
11626 Export keywords include options, block names, attributes and
11627 keywords relative to each registered export back-end."
11628 (delq nil
11629 (let (keywords)
11630 (mapc
11631 (lambda (back-end)
11632 (let ((props (cdr back-end)))
11633 ;; Back-end name (for keywords, like #+LATEX:)
11634 (push (upcase (symbol-name (car back-end))) keywords)
11635 ;; Back-end options.
11636 (mapc (lambda (option) (push (cadr option) keywords))
11637 (plist-get (cdr back-end) :options-alist))))
11638 (org-bound-and-true-p org-export-registered-backends))
11639 keywords)))
11641 (defconst org-options-keywords
11642 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11643 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11644 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11645 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11646 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:" "INFOJS_OPT:"))
11648 (defcustom org-structure-template-alist
11663 ("L" "#+LaTeX: "
11667 ("H" "#+HTML: "
11670 ("A" "#+ASCII: ")
11671 ("i" "#+INDEX: ?"
11672 "#+INDEX: ?")
11673 ("I" "#+INCLUDE: %file ?"
11675 "Structure completion elements.
11676 This is a list of abbreviation keys and values. The value gets inserted
11677 if you type `<' followed by the key and then press the completion key,
11678 usually `M-TAB'. %file will be replaced by a file name after prompting
11679 for the file using completion. The cursor will be placed at the position
11680 of the `?` in the template.
11681 There are two templates for each key, the first uses the original Org syntax,
11682 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11683 the default when the /org-mtags.el/ module has been loaded. See also the
11684 variable `org-mtags-prefer-muse-templates'."
11685 :group 'org-completion
11686 :type '(repeat
11687 (string :tag "Key")
11688 (string :tag "Template")
11689 (string :tag "Muse Template")))
11691 (defun org-try-structure-completion ()
11692 "Try to complete a structure template before point.
11694 expands them."
11695 (let ((l (buffer-substring (point-at-bol) (point)))
11696 a)
11699 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11700 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11701 (match-beginning 1)) a)
11702 t)))
11704 (defun org-complete-expand-structure-template (start cell)
11705 "Expand a structure template."
11706 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11707 (rpl (nth (if musep 2 1) cell))
11708 (ind ""))
11709 (delete-region start (point))
11711 (cond
11712 ((bolp))
11714 (setq ind (buffer-substring (point-at-bol) (point))))
11715 (t (newline))))
11716 (setq start (point))
11717 (if (string-match "%file" rpl)
11718 (setq rpl (replace-match
11719 (concat
11721 (save-match-data
11722 (abbreviate-file-name (read-file-name "Include file: ")))
11724 t t rpl)))
11727 (insert rpl)
11730 ;;;; TODO, DEADLINE, Comments
11732 (defun org-toggle-comment ()
11733 "Change the COMMENT state of an entry."
11734 (interactive)
11735 (save-excursion
11736 (org-back-to-heading)
11737 (let (case-fold-search)
11738 (cond
11739 ((looking-at (format org-heading-keyword-regexp-format
11740 org-comment-string))
11741 (goto-char (match-end 1))
11742 (looking-at (concat " +" org-comment-string))
11743 (replace-match "" t t)
11744 (when (eolp) (insert " ")))
11745 ((looking-at org-outline-regexp)
11746 (goto-char (match-end 0))
11747 (insert org-comment-string " "))))))
11749 (defvar org-last-todo-state-is-todo nil
11750 "This is non-nil when the last TODO state change led to a TODO state.
11751 If the last change removed the TODO tag or switched to DONE, then
11752 this is nil.")
11754 (defvar org-setting-tags nil) ; dynamically skipped
11756 (defvar org-todo-setup-filter-hook nil
11757 "Hook for functions that pre-filter todo specs.
11758 Each function takes a todo spec and returns either nil or the spec
11759 transformed into canonical form." )
11761 (defvar org-todo-get-default-hook nil
11762 "Hook for functions that get a default item for todo.
11763 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11764 nil or a string to be used for the todo mark." )
11766 (defvar org-agenda-headline-snapshot-before-repeat)
11768 (defun org-current-effective-time ()
11769 "Return current time adjusted for `org-extend-today-until' variable."
11770 (let* ((ct (org-current-time))
11771 (dct (decode-time ct))
11772 (ct1
11773 (cond
11774 (org-use-last-clock-out-time-as-effective-time
11775 (or (org-clock-get-last-clock-out-time) ct))
11776 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
11777 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
11778 (t ct))))
11779 ct1))
11781 (defun org-todo-yesterday (&optional arg)
11782 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11783 (interactive "P")
11784 (if (eq major-mode 'org-agenda-mode)
11785 (apply 'org-agenda-todo-yesterday arg)
11786 (let* ((hour (third (decode-time
11787 (org-current-time))))
11788 (org-extend-today-until (1+ hour)))
11789 (org-todo arg))))
11791 (defvar org-block-entry-blocking ""
11792 "First entry preventing the TODO state change.")
11794 (defun org-todo (&optional arg)
11795 "Change the TODO state of an item.
11796 The state of an item is given by a keyword at the start of the heading,
11797 like
11798 *** TODO Write paper
11799 *** DONE Call mom
11801 The different keywords are specified in the variable `org-todo-keywords'.
11803 So for this example: when the item starts with TODO, it is changed to DONE.
11804 When it starts with DONE, the DONE is removed. And when neither TODO nor
11805 DONE are present, add TODO at the beginning of the heading.
11808 state.
11809 With numeric prefix arg, switch to that state.
11811 keywords (nextset).
11813 With a numeric prefix arg of 0, inhibit note taking for the change.
11815 For calling through lisp, arg is also interpreted in the following way:
11816 'none -> empty state
11818 'done -> switch to DONE
11819 'nextset -> switch to the next set of keywords
11820 'previousset -> switch to the previous set of keywords
11822 really is a member of `org-todo-keywords'."
11823 (interactive "P")
11824 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11825 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11826 'region-start-level 'region))
11827 org-loop-over-headlines-in-active-region)
11828 (org-map-entries
11829 `(org-todo ,arg)
11830 org-loop-over-headlines-in-active-region
11831 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11832 (if (equal arg '(16)) (setq arg 'nextset))
11833 (let ((org-blocker-hook org-blocker-hook)
11834 commentp
11835 case-fold-search)
11836 (when (equal arg '(64))
11837 (setq arg nil org-blocker-hook nil))
11838 (when (and org-blocker-hook
11839 (or org-inhibit-blocking
11840 (org-entry-get nil "NOBLOCKING")))
11841 (setq org-blocker-hook nil))
11842 (save-excursion
11843 (catch 'exit
11844 (org-back-to-heading t)
11846 (org-toggle-comment)
11847 (setq commentp t))
11848 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11851 (let* ((match-data (match-data))
11852 (startpos (point-at-bol))
11853 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11854 (org-log-done org-log-done)
11855 (org-log-repeat org-log-repeat)
11856 (org-todo-log-states org-todo-log-states)
11857 (org-inhibit-logging
11858 (if (equal arg 0)
11859 (progn (setq arg nil) 'note) org-inhibit-logging))
11860 (this (match-string 1))
11861 (hl-pos (match-beginning 0))
11862 (head (org-get-todo-sequence-head this))
11863 (ass (assoc head org-todo-kwd-alist))
11864 (interpret (nth 1 ass))
11865 (done-word (nth 3 ass))
11866 (final-done-word (nth 4 ass))
11867 (org-last-state (or this ""))
11868 (completion-ignore-case t)
11869 (member (member this org-todo-keywords-1))
11870 (tail (cdr member))
11871 (org-state (cond
11872 ((and org-todo-key-trigger
11873 (or (and (equal arg '(4))
11874 (eq org-use-fast-todo-selection 'prefix))
11875 (and (not arg) org-use-fast-todo-selection
11876 (not (eq org-use-fast-todo-selection
11877 'prefix)))))
11878 ;; Use fast selection
11879 (org-fast-todo-selection))
11880 ((and (equal arg '(4))
11881 (or (not org-use-fast-todo-selection)
11882 (not org-todo-key-trigger)))
11883 ;; Read a state with completion
11884 (org-icompleting-read
11885 "State: " (mapcar (lambda(x) (list x))
11886 org-todo-keywords-1)
11887 nil t))
11888 ((eq arg 'right)
11889 (if this
11890 (if tail (car tail) nil)
11891 (car org-todo-keywords-1)))
11892 ((eq arg 'left)
11893 (if (equal member org-todo-keywords-1)
11894 nil
11895 (if this
11896 (nth (- (length org-todo-keywords-1)
11897 (length tail) 2)
11898 org-todo-keywords-1)
11899 (org-last org-todo-keywords-1))))
11900 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11901 (setq arg nil))) ; hack to fall back to cycling
11902 (arg
11903 ;; user or caller requests a specific state
11904 (cond
11905 ((equal arg "") nil)
11906 ((eq arg 'none) nil)
11907 ((eq arg 'done) (or done-word (car org-done-keywords)))
11908 ((eq arg 'nextset)
11909 (or (car (cdr (member head org-todo-heads)))
11910 (car org-todo-heads)))
11911 ((eq arg 'previousset)
11912 (let ((org-todo-heads (reverse org-todo-heads)))
11913 (or (car (cdr (member head org-todo-heads)))
11914 (car org-todo-heads))))
11915 ((car (member arg org-todo-keywords-1)))
11916 ((stringp arg)
11917 (error "State `%s' not valid in this file" arg))
11918 ((nth (1- (prefix-numeric-value arg))
11919 org-todo-keywords-1))))
11920 ((null member) (or head (car org-todo-keywords-1)))
11921 ((equal this final-done-word) nil) ;; -> make empty
11922 ((null tail) nil) ;; -> first entry
11923 ((memq interpret '(type priority))
11924 (if (eq this-command last-command)
11925 (car tail)
11926 (if (> (length tail) 0)
11927 (or done-word (car org-done-keywords))
11928 nil)))
11929 (t
11930 (car tail))))
11931 (org-state (or
11932 (run-hook-with-args-until-success
11933 'org-todo-get-default-hook org-state org-last-state)
11934 org-state))
11935 (next (if org-state (concat " " org-state " ") " "))
11936 (change-plist (list :type 'todo-state-change :from this :to org-state
11937 :position startpos))
11938 dolog now-done-p)
11939 (when org-blocker-hook
11940 (setq org-last-todo-state-is-todo
11941 (not (member this org-done-keywords)))
11942 (unless (save-excursion
11943 (save-match-data
11944 (org-with-wide-buffer
11945 (run-hook-with-args-until-failure
11946 'org-blocker-hook change-plist))))
11947 (if (org-called-interactively-p 'interactive)
11949 this org-state org-block-entry-blocking)
11950 ;; fail silently
11952 this org-state org-block-entry-blocking)
11953 (throw 'exit nil))))
11954 (store-match-data match-data)
11955 (replace-match next t t)
11956 (unless (pos-visible-in-window-p hl-pos)
11957 (message "TODO state changed to %s" (org-trim next)))
11958 (unless head
11959 (setq head (org-get-todo-sequence-head org-state)
11960 ass (assoc head org-todo-kwd-alist)
11961 interpret (nth 1 ass)
11962 done-word (nth 3 ass)
11963 final-done-word (nth 4 ass)))
11964 (when (memq arg '(nextset previousset))
11965 (message "Keyword-Set %d/%d: %s"
11966 (- (length org-todo-sets) -1
11967 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11968 (length org-todo-sets)
11969 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11970 (setq org-last-todo-state-is-todo
11971 (not (member org-state org-done-keywords)))
11972 (setq now-done-p (and (member org-state org-done-keywords)
11973 (not (member this org-done-keywords))))
11974 (and logging (org-local-logging logging))
11975 (when (and (or org-todo-log-states org-log-done)
11976 (not (eq org-inhibit-logging t))
11977 (not (memq arg '(nextset previousset))))
11978 ;; we need to look at recording a time and note
11979 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11980 (nth 2 (assoc this org-todo-log-states))))
11981 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11982 (setq dolog 'time))
11983 (when (and org-state
11984 (member org-state org-not-done-keywords)
11985 (not (member this org-not-done-keywords)))
11986 ;; This is now a todo state and was not one before
11987 ;; If there was a CLOSED time stamp, get rid of it.
11988 (org-add-planning-info nil nil 'closed))
11989 (when (and now-done-p org-log-done)
11990 ;; It is now done, and it was not done before
11991 (org-add-planning-info 'closed (org-current-effective-time))
11992 (if (and (not dolog) (eq 'note org-log-done))
11993 (org-add-log-setup 'done org-state this 'findpos 'note)))
11994 (when (and org-state dolog)
11995 ;; This is a non-nil state, and we need to log it
11996 (org-add-log-setup 'state org-state this 'findpos dolog)))
11997 ;; Fixup tag positioning
11998 (org-todo-trigger-tag-changes org-state)
11999 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12000 (when org-provide-todo-statistics
12001 (org-update-parent-todo-statistics))
12002 (run-hooks 'org-after-todo-state-change-hook)
12003 (if (and arg (not (member org-state org-done-keywords)))
12004 (setq head (org-get-todo-sequence-head org-state)))
12005 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12006 ;; Do we need to trigger a repeat?
12007 (when now-done-p
12008 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12009 ;; This is for the agenda, take a snapshot of the headline.
12010 (save-match-data
12011 (setq org-agenda-headline-snapshot-before-repeat
12012 (org-get-heading))))
12013 (org-auto-repeat-maybe org-state))
12014 ;; Fixup cursor location if close to the keyword
12015 (if (and (outline-on-heading-p)
12016 (not (bolp))
12017 (save-excursion (beginning-of-line 1)
12018 (looking-at org-todo-line-regexp))
12019 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12020 (progn
12021 (goto-char (or (match-end 2) (match-end 1)))
12022 (and (looking-at " ") (just-one-space))))
12023 (when org-trigger-hook
12024 (save-excursion
12025 (run-hook-with-args 'org-trigger-hook change-plist)))
12026 (when commentp (org-toggle-comment))))))))
12028 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12029 "Block turning an entry into a TODO, using the hierarchy.
12030 This checks whether the current task should be blocked from state
12031 changes. Such blocking occurs when:
12033 1. The task has children which are not all in a completed state.
12035 2. A task has a parent with the property :ORDERED:, and there
12036 are siblings prior to the current task with incomplete
12037 status.
12039 3. The parent of the task is blocked because it has siblings that should
12040 be done first, or is child of a block grandparent TODO entry."
12042 (if (not org-enforce-todo-dependencies)
12043 t ; if locally turned off don't block
12044 (catch 'dont-block
12045 ;; If this is not a todo state change, or if this entry is already DONE,
12046 ;; do not block
12047 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12048 (member (plist-get change-plist :from)
12049 (cons 'done org-done-keywords))
12050 (member (plist-get change-plist :to)
12051 (cons 'todo org-not-done-keywords))
12052 (not (plist-get change-plist :to)))
12053 (throw 'dont-block t))
12054 ;; If this task has children, and any are undone, it's blocked
12055 (save-excursion
12056 (org-back-to-heading t)
12057 (let ((this-level (funcall outline-level)))
12058 (outline-next-heading)
12059 (let ((child-level (funcall outline-level)))
12060 (while (and (not (eobp))
12061 (> child-level this-level))
12062 ;; this todo has children, check whether they are all
12063 ;; completed
12064 (if (and (not (org-entry-is-done-p))
12065 (org-entry-is-todo-p))
12066 (progn (setq org-block-entry-blocking (org-get-heading))
12067 (throw 'dont-block nil)))
12068 (outline-next-heading)
12069 (setq child-level (funcall outline-level))))))
12070 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12071 ;; any previous siblings are undone, it's blocked
12072 (save-excursion
12073 (org-back-to-heading t)
12074 (let* ((pos (point))
12075 (parent-pos (and (org-up-heading-safe) (point))))
12076 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12077 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12078 (forward-line 1)
12079 (re-search-forward org-not-done-heading-regexp pos t))
12080 (setq org-block-entry-blocking (match-string 0))
12081 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12082 ;; Search further up the hierarchy, to see if an ancestor is blocked
12083 (while t
12084 (goto-char parent-pos)
12085 (if (not (looking-at org-not-done-heading-regexp))
12086 (throw 'dont-block t)) ; do not block, parent is not a TODO
12087 (setq pos (point))
12088 (setq parent-pos (and (org-up-heading-safe) (point)))
12089 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12090 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12091 (forward-line 1)
12092 (re-search-forward org-not-done-heading-regexp pos t)
12093 (setq org-block-entry-blocking (org-get-heading)))
12094 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12096 (defcustom org-track-ordered-property-with-tag nil
12097 "Should the ORDERED property also be shown as a tag?
12098 The ORDERED property decides if an entry should require subtasks to be
12099 completed in sequence. Since a property is not very visible, setting
12100 this option means that toggling the ORDERED property with the command
12101 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12102 not relevant for the behavior, but it makes things more visible.
12104 Note that toggling the tag with tags commands will not change the property
12105 and therefore not influence behavior!
12107 This can be t, meaning the tag ORDERED should be used, It can also be a
12108 string to select a different tag for this task."
12109 :group 'org-todo
12110 :type '(choice
12111 (const :tag "No tracking" nil)
12112 (const :tag "Track with ORDERED tag" t)
12113 (string :tag "Use other tag")))
12115 (defun org-toggle-ordered-property ()
12116 "Toggle the ORDERED property of the current entry.
12117 For better visibility, you can track the value of this property with a tag.
12118 See variable `org-track-ordered-property-with-tag'."
12119 (interactive)
12120 (let* ((t1 org-track-ordered-property-with-tag)
12121 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12122 (save-excursion
12123 (org-back-to-heading)
12124 (if (org-entry-get nil "ORDERED")
12125 (progn
12126 (org-delete-property "ORDERED" "PROPERTIES")
12127 (and tag (org-toggle-tag tag 'off))
12128 (message "Subtasks can be completed in arbitrary order"))
12129 (org-entry-put nil "ORDERED" "t")
12130 (and tag (org-toggle-tag tag 'on))
12131 (message "Subtasks must be completed in sequence")))))
12133 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12134 (defun org-block-todo-from-checkboxes (change-plist)
12135 "Block turning an entry into a TODO, using checkboxes.
12136 This checks whether the current task should be blocked from state
12137 changes because there are unchecked boxes in this entry."
12138 (if (not org-enforce-todo-checkbox-dependencies)
12139 t ; if locally turned off don't block
12140 (catch 'dont-block
12141 ;; If this is not a todo state change, or if this entry is already DONE,
12142 ;; do not block
12143 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12144 (member (plist-get change-plist :from)
12145 (cons 'done org-done-keywords))
12146 (member (plist-get change-plist :to)
12147 (cons 'todo org-not-done-keywords))
12148 (not (plist-get change-plist :to)))
12149 (throw 'dont-block t))
12150 ;; If this task has checkboxes that are not checked, it's blocked
12151 (save-excursion
12152 (org-back-to-heading t)
12153 (let ((beg (point)) end)
12154 (outline-next-heading)
12155 (setq end (point))
12156 (goto-char beg)
12157 (if (org-list-search-forward
12158 (concat (org-item-beginning-re)
12161 end t)
12162 (progn
12163 (if (boundp 'org-blocked-by-checkboxes)
12164 (setq org-blocked-by-checkboxes t))
12165 (throw 'dont-block nil)))))
12166 t))) ; do not block
12168 (defun org-entry-blocked-p ()
12169 "Is the current entry blocked?"
12170 (org-with-silent-modifications
12171 (if (org-entry-get nil "NOBLOCKING")
12172 nil ;; Never block this entry
12173 (not (run-hook-with-args-until-failure
12174 'org-blocker-hook
12175 (list :type 'todo-state-change
12176 :position (point)
12177 :from 'todo
12178 :to 'done))))))
12180 (defun org-update-statistics-cookies (all)
12181 "Update the statistics cookie, either from TODO or from checkboxes.
12182 This should be called with the cursor in a line with a statistics cookie."
12183 (interactive "P")
12184 (if all
12185 (progn
12186 (org-update-checkbox-count 'all)
12187 (org-map-entries 'org-update-parent-todo-statistics))
12188 (if (not (org-at-heading-p))
12189 (org-update-checkbox-count)
12190 (let ((pos (point-marker))
12191 end l1 l2)
12192 (ignore-errors (org-back-to-heading t))
12193 (if (not (org-at-heading-p))
12194 (org-update-checkbox-count)
12195 (setq l1 (org-outline-level))
12196 (setq end (save-excursion
12197 (outline-next-heading)
12198 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12199 (point)))
12200 (if (and (save-excursion
12201 (re-search-forward
12203 (not (save-excursion (re-search-forward
12205 (org-update-checkbox-count)
12206 (if (and l2 (> l2 l1))
12207 (progn
12208 (goto-char end)
12209 (org-update-parent-todo-statistics))
12210 (goto-char pos)
12211 (beginning-of-line 1)
12212 (while (re-search-forward
12214 (point-at-eol) t)
12215 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12216 (goto-char pos)
12217 (move-marker pos nil)))))
12219 (defvar org-entry-property-inherited-from) ;; defined below
12220 (defun org-update-parent-todo-statistics ()
12221 "Update any statistics cookie in the parent of the current headline.
12222 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12223 the entire subtree and this will travel up the hierarchy and update
12224 statistics everywhere."
12225 (let* ((prop (save-excursion (org-up-heading-safe)
12226 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12227 (recursive (or (not org-hierarchical-todo-statistics)
12229 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12230 0))
12231 (first t)
12233 level ltoggle l1 new ndel
12234 (cnt-all 0) (cnt-done 0) is-percent kwd
12235 checkbox-beg ov ovs ove cookie-present)
12236 (catch 'exit
12237 (save-excursion
12238 (beginning-of-line 1)
12239 (setq ltoggle (funcall outline-level))
12240 ;; Three situations are to consider:
12242 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12243 ;; to the top-level ancestor on the headline;
12245 ;; 2. If parent has "recursive" property, repeat up to the
12246 ;; headline setting that property, taking inheritance into
12247 ;; account;
12249 ;; 3. Else, move up to direct parent and proceed only once.
12250 (while (and (setq level (org-up-heading-safe))
12251 (or recursive first)
12252 (>= (point) lim))
12253 (setq first nil cookie-present nil)
12254 (unless (and level
12255 (not (string-match
12257 (downcase (or (org-entry-get nil "COOKIE_DATA")
12258 "")))))
12259 (throw 'exit nil))
12260 (while (re-search-forward box-re (point-at-eol) t)
12261 (setq cnt-all 0 cnt-done 0 cookie-present t)
12262 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12263 (save-match-data
12264 (unless (outline-next-heading) (throw 'exit nil))
12265 (while (and (looking-at org-complex-heading-regexp)
12266 (> (setq l1 (length (match-string 1))) level))
12267 (setq kwd (and (or recursive (= l1 ltoggle))
12268 (match-string 2)))
12269 (if (or (eq org-provide-todo-statistics 'all-headlines)
12270 (and (listp org-provide-todo-statistics)
12271 (or (member kwd org-provide-todo-statistics)
12272 (member kwd org-done-keywords))))
12273 (setq cnt-all (1+ cnt-all))
12274 (if (eq org-provide-todo-statistics t)
12275 (and kwd (setq cnt-all (1+ cnt-all)))))
12276 (and (member kwd org-done-keywords)
12277 (setq cnt-done (1+ cnt-done)))
12278 (outline-next-heading)))
12279 (setq new
12280 (if is-percent
12281 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12282 (format "[%d/%d]" cnt-done cnt-all))
12283 ndel (- (match-end 0) checkbox-beg))
12284 ;; handle overlays when updating cookie from column view
12285 (when (setq ov (car (overlays-at checkbox-beg)))
12286 (setq ovs (overlay-start ov) ove (overlay-end ov))
12287 (delete-overlay ov))
12288 (goto-char checkbox-beg)
12289 (insert new)
12290 (delete-region (point) (+ (point) ndel))
12291 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12292 (when ov (move-overlay ov ovs ove)))
12293 (when cookie-present
12294 (run-hook-with-args 'org-after-todo-statistics-hook
12295 cnt-done (- cnt-all cnt-done))))))
12296 (run-hooks 'org-todo-statistics-hook)))
12298 (defvar org-after-todo-statistics-hook nil
12299 "Hook that is called after a TODO statistics cookie has been updated.
12300 Each function is called with two arguments: the number of not-done entries
12301 and the number of done entries.
12303 For example, the following function, when added to this hook, will switch
12304 an entry to DONE when all children are done, and back to TODO when new
12305 entries are set to a TODO status. Note that this hook is only called
12306 when there is a statistics cookie in the headline!
12308 (defun org-summary-todo (n-done n-not-done)
12310 (let (org-log-done org-log-states) ; turn off logging
12312 ")
12314 (defvar org-todo-statistics-hook nil
12315 "Hook that is run whenever Org thinks TODO statistics should be updated.
12316 This hook runs even if there is no statistics cookie present, in which case
12317 `org-after-todo-statistics-hook' would not run.")
12319 (defun org-todo-trigger-tag-changes (state)
12320 "Apply the changes defined in `org-todo-state-tags-triggers'."
12321 (let ((l org-todo-state-tags-triggers)
12322 changes)
12323 (when (or (not state) (equal state ""))
12324 (setq changes (append changes (cdr (assoc "" l)))))
12325 (when (and (stringp state) (> (length state) 0))
12326 (setq changes (append changes (cdr (assoc state l)))))
12327 (when (member state org-not-done-keywords)
12328 (setq changes (append changes (cdr (assoc 'todo l)))))
12329 (when (member state org-done-keywords)
12330 (setq changes (append changes (cdr (assoc 'done l)))))
12331 (dolist (c changes)
12332 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12334 (defun org-local-logging (value)
12335 "Get logging settings from a property VALUE."
12336 (let* (words w a)
12337 ;; directly set the variables, they are already local.
12338 (setq org-log-done nil
12339 org-log-repeat nil
12340 org-todo-log-states nil)
12341 (setq words (org-split-string value))
12342 (while (setq w (pop words))
12343 (cond
12344 ((setq a (assoc w org-startup-options))
12345 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12346 (set (nth 1 a) (nth 2 a))))
12347 ((setq a (org-extract-log-state-settings w))
12348 (and (member (car a) org-todo-keywords-1)
12349 (push a org-todo-log-states)))))))
12351 (defun org-get-todo-sequence-head (kwd)
12352 "Return the head of the TODO sequence to which KWD belongs.
12353 If KWD is not set, check if there is a text property remembering the
12354 right sequence."
12355 (let (p)
12356 (cond
12357 ((not kwd)
12358 (or (get-text-property (point-at-bol) 'org-todo-head)
12359 (progn
12360 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12361 nil (point-at-eol)))
12362 (get-text-property p 'org-todo-head))))
12363 ((not (member kwd org-todo-keywords-1))
12364 (car org-todo-keywords-1))
12365 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12367 (defun org-fast-todo-selection ()
12368 "Fast TODO keyword selection with single keys.
12369 Returns the new TODO keyword, or nil if no state change should occur."
12370 (let* ((fulltable org-todo-key-alist)
12371 (done-keywords org-done-keywords) ;; needed for the faces.
12372 (maxlen (apply 'max (mapcar
12373 (lambda (x)
12374 (if (stringp (car x)) (string-width (car x)) 0))
12375 fulltable)))
12376 (expert nil)
12377 (fwidth (+ maxlen 3 1 3))
12378 (ncol (/ (- (window-width) 4) fwidth))
12379 tg cnt e c tbl
12380 groups ingroup)
12381 (save-excursion
12382 (save-window-excursion
12383 (if expert
12384 (set-buffer (get-buffer-create " *Org todo*"))
12385 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12386 (erase-buffer)
12387 (org-set-local 'org-done-keywords done-keywords)
12388 (setq tbl fulltable cnt 0)
12389 (while (setq e (pop tbl))
12390 (cond
12391 ((equal e '(:startgroup))
12392 (push '() groups) (setq ingroup t)
12393 (when (not (= cnt 0))
12394 (setq cnt 0)
12396 (insert "{ "))
12397 ((equal e '(:endgroup))
12398 (setq ingroup nil cnt 0)
12400 ((equal e '(:newline))
12401 (when (not (= cnt 0))
12402 (setq cnt 0)
12404 (setq e (car tbl))
12405 (while (equal (car tbl) '(:newline))
12407 (setq tbl (cdr tbl)))))
12408 (t
12409 (setq tg (car e) c (cdr e))
12410 (if ingroup (push tg (car groups)))
12411 (setq tg (org-add-props tg nil 'face
12412 (org-get-todo-face tg)))
12413 (if (and (= cnt 0) (not ingroup)) (insert " "))
12414 (insert "[" c "] " tg (make-string
12415 (- fwidth 4 (length tg)) ?\ ))
12416 (when (= (setq cnt (1+ cnt)) ncol)
12418 (if ingroup (insert " "))
12419 (setq cnt 0)))))
12421 (goto-char (point-min))
12422 (if (not expert) (org-fit-window-to-buffer))
12423 (message "[a-z..]:Set [SPC]:clear")
12424 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12425 (cond
12426 ((or (= c ?\C-g)
12427 (and (= c ?q) (not (rassoc c fulltable))))
12428 (setq quit-flag t))
12429 ((= c ?\ ) nil)
12430 ((setq e (rassoc c fulltable) tg (car e))
12431 tg)
12432 (t (setq quit-flag t)))))))
12434 (defun org-entry-is-todo-p ()
12435 (member (org-get-todo-state) org-not-done-keywords))
12437 (defun org-entry-is-done-p ()
12438 (member (org-get-todo-state) org-done-keywords))
12440 (defun org-get-todo-state ()
12441 (save-excursion
12442 (org-back-to-heading t)
12443 (and (looking-at org-todo-line-regexp)
12444 (match-end 2)
12445 (match-string 2))))
12447 (defun org-at-date-range-p (&optional inactive-ok)
12448 "Is the cursor inside a date range?"
12449 (interactive)
12450 (save-excursion
12451 (catch 'exit
12452 (let ((pos (point)))
12454 (skip-chars-backward "<[")
12455 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12456 (>= (match-end 0) pos)
12457 (throw 'exit t))
12459 (skip-chars-backward "<[")
12460 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12461 (>= (match-end 0) pos)
12462 (throw 'exit t)))
12463 nil)))
12465 (defun org-get-repeat (&optional tagline)
12466 "Check if there is a deadline/schedule with repeater in this entry."
12467 (save-match-data
12468 (save-excursion
12469 (org-back-to-heading t)
12470 (and (re-search-forward (if tagline
12472 org-repeat-re)
12473 (org-entry-end-position) t)
12474 (match-string-no-properties 1)))))
12476 (defvar org-last-changed-timestamp)
12477 (defvar org-last-inserted-timestamp)
12478 (defvar org-log-post-message)
12479 (defvar org-log-note-purpose)
12480 (defvar org-log-note-how)
12481 (defvar org-log-note-extra)
12482 (defun org-auto-repeat-maybe (done-word)
12483 "Check if the current headline contains a repeated deadline/schedule.
12484 If yes, set TODO state back to what it was and change the base date
12485 of repeating deadline/scheduled time stamps to new date.
12486 This function is run automatically after each state change to a DONE state."
12487 ;; last-state is dynamically scoped into this function
12488 (let* ((repeat (org-get-repeat))
12489 (aa (assoc org-last-state org-todo-kwd-alist))
12490 (interpret (nth 1 aa))
12491 (head (nth 2 aa))
12492 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12493 (msg "Entry repeats: ")
12494 (org-log-done nil)
12495 (org-todo-log-states nil)
12496 re type n what ts time to-state)
12497 (when repeat
12498 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12499 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12500 org-todo-repeat-to-state))
12501 (unless (and to-state (member to-state org-todo-keywords-1))
12502 (setq to-state (if (eq interpret 'type) org-last-state head)))
12503 (org-todo to-state)
12504 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12505 (org-entry-put nil "LAST_REPEAT" (format-time-string
12506 (org-time-stamp-format t t))))
12507 (when org-log-repeat
12508 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12509 (memq 'org-add-log-note post-command-hook))
12510 ;; OK, we are already setup for some record
12511 (if (eq org-log-repeat 'note)
12512 ;; make sure we take a note, not only a time stamp
12513 (setq org-log-note-how 'note))
12514 ;; Set up for taking a record
12515 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12516 org-last-state
12517 'findpos org-log-repeat)))
12518 (org-back-to-heading t)
12519 (org-add-planning-info nil nil 'closed)
12523 (while (re-search-forward
12524 re (save-excursion (outline-next-heading) (point)) t)
12525 (setq type (if (match-end 1) org-scheduled-string
12526 (if (match-end 3) org-deadline-string "Plain:"))
12527 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12529 (setq n (string-to-number (match-string 2 ts))
12530 what (match-string 3 ts))
12531 (if (equal what "w") (setq n (* n 7) what "d"))
12533 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12534 ;; Preparation, see if we need to modify the start date for the change
12535 (when (match-end 1)
12536 (setq time (save-match-data (org-time-string-to-time ts)))
12537 (cond
12538 ((equal (match-string 1 ts) ".")
12539 ;; Shift starting date to today
12540 (org-timestamp-change
12541 (- (org-today) (time-to-days time))
12542 'day))
12543 ((equal (match-string 1 ts) "+")
12544 (let ((nshiftmax 10) (nshift 0))
12545 (while (or (= nshift 0)
12546 (<= (time-to-days time)
12547 (time-to-days (current-time))))
12548 (when (= (incf nshift) nshiftmax)
12549 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12550 (error "Abort")))
12551 (org-timestamp-change n (cdr (assoc what whata)))
12552 (org-at-timestamp-p t)
12553 (setq ts (match-string 1))
12554 (setq time (save-match-data (org-time-string-to-time ts)))))
12555 (org-timestamp-change (- n) (cdr (assoc what whata)))
12556 ;; rematch, so that we have everything in place for the real shift
12557 (org-at-timestamp-p t)
12558 (setq ts (match-string 1))
12560 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12561 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12562 (setq org-log-post-message msg)
12563 (message "%s" msg))))
12565 (defun org-show-todo-tree (arg)
12566 "Make a compact tree which shows all headlines marked with TODO.
12567 The tree will show the lines where the regexp matches, and all higher
12568 headlines above the match.
12570 With a numeric prefix N, construct a sparse tree for the Nth element
12571 of `org-todo-keywords-1'."
12572 (interactive "P")
12573 (let ((case-fold-search nil)
12574 (kwd-re
12575 (cond ((null arg) org-not-done-regexp)
12576 ((equal arg '(4))
12577 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12578 (mapcar 'list org-todo-keywords-1))))
12582 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12583 (regexp-quote (nth (1- (prefix-numeric-value arg))
12584 org-todo-keywords-1)))
12585 (t (error "Invalid prefix argument: %s" arg)))))
12586 (message "%d TODO entries found"
12587 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12589 (defun org-deadline (&optional arg time)
12591 With one universal prefix argument, remove any deadline from the item.
12592 With two universal prefix arguments, prompt for a warning delay.
12593 With argument TIME, set the deadline at the corresponding date. TIME
12595 (interactive "P")
12596 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12597 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12598 'region-start-level 'region))
12599 org-loop-over-headlines-in-active-region)
12600 (org-map-entries
12601 `(org-deadline ',arg ,time)
12602 org-loop-over-headlines-in-active-region
12603 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12604 (let* ((old-date (org-entry-get nil "DEADLINE"))
12605 (repeater (and old-date
12606 (string-match
12608 old-date)
12609 (match-string 1 old-date))))
12610 (cond
12611 ((equal arg '(4))
12612 (when (and old-date org-log-redeadline)
12613 (org-add-log-setup 'deldeadline nil old-date 'findpos
12614 org-log-redeadline))
12615 (org-remove-timestamp-with-keyword org-deadline-string)
12616 (message "Item no longer has a deadline."))
12617 ((equal arg '(16))
12618 (save-excursion
12619 (if (re-search-forward
12620 org-deadline-time-regexp
12621 (save-excursion (outline-next-heading) (point)) t)
12622 (let* ((rpl0 (match-string 1))
12623 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12624 (replace-match
12625 (concat org-deadline-string
12626 " <" rpl
12627 (format " -%dd" (abs
12628 (- (time-to-days
12629 (save-match-data
12630 (org-read-date nil t nil "Warn starting from")))
12631 (time-to-days nil))))
12632 ">") t t))
12633 (user-error "No deadline information to update"))))
12634 (t
12635 (org-add-planning-info 'deadline time 'closed)
12636 (when (and old-date org-log-redeadline
12637 (not (equal old-date
12638 (substring org-last-inserted-timestamp 1 -1))))
12639 (org-add-log-setup 'redeadline nil old-date 'findpos
12640 org-log-redeadline))
12641 (when repeater
12642 (save-excursion
12643 (org-back-to-heading t)
12644 (when (re-search-forward (concat org-deadline-string " "
12645 org-last-inserted-timestamp)
12646 (save-excursion
12647 (outline-next-heading) (point)) t)
12648 (goto-char (1- (match-end 0)))
12649 (insert " " repeater)
12650 (setq org-last-inserted-timestamp
12651 (concat (substring org-last-inserted-timestamp 0 -1)
12652 " " repeater
12653 (substring org-last-inserted-timestamp -1))))))
12654 (message "Deadline on %s" org-last-inserted-timestamp))))))
12656 (defun org-schedule (&optional arg time)
12657 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12658 With one universal prefix argument, remove any scheduling date from the item.
12659 With two universal prefix arguments, prompt for a delay cookie.
12660 With argument TIME, scheduled at the corresponding date. TIME can
12662 (interactive "P")
12663 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12664 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12665 'region-start-level 'region))
12666 org-loop-over-headlines-in-active-region)
12667 (org-map-entries
12668 `(org-schedule ',arg ,time)
12669 org-loop-over-headlines-in-active-region
12670 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12671 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12672 (repeater (and old-date
12673 (string-match
12675 old-date)
12676 (match-string 1 old-date))))
12677 (cond
12678 ((equal arg '(4))
12679 (progn
12680 (when (and old-date org-log-reschedule)
12681 (org-add-log-setup 'delschedule nil old-date 'findpos
12682 org-log-reschedule))
12683 (org-remove-timestamp-with-keyword org-scheduled-string)
12684 (message "Item is no longer scheduled.")))
12685 ((equal arg '(16))
12686 (save-excursion
12687 (if (re-search-forward
12688 org-scheduled-time-regexp
12689 (save-excursion (outline-next-heading) (point)) t)
12690 (let* ((rpl0 (match-string 1))
12691 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12692 (replace-match
12693 (concat org-scheduled-string
12694 " <" rpl
12695 (format " -%dd" (abs
12696 (- (time-to-days
12697 (save-match-data
12698 (org-read-date nil t nil "Delay until")))
12699 (time-to-days nil))))
12700 ">") t t))
12701 (user-error "No scheduled information to update"))))
12702 (t
12703 (org-add-planning-info 'scheduled time 'closed)
12704 (when (and old-date org-log-reschedule
12705 (not (equal old-date
12706 (substring org-last-inserted-timestamp 1 -1))))
12707 (org-add-log-setup 'reschedule nil old-date 'findpos
12708 org-log-reschedule))
12709 (when repeater
12710 (save-excursion
12711 (org-back-to-heading t)
12712 (when (re-search-forward (concat org-scheduled-string " "
12713 org-last-inserted-timestamp)
12714 (save-excursion
12715 (outline-next-heading) (point)) t)
12716 (goto-char (1- (match-end 0)))
12717 (insert " " repeater)
12718 (setq org-last-inserted-timestamp
12719 (concat (substring org-last-inserted-timestamp 0 -1)
12720 " " repeater
12721 (substring org-last-inserted-timestamp -1))))))
12722 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12724 (defun org-get-scheduled-time (pom &optional inherit)
12725 "Get the scheduled time as a time tuple, of a format suitable
12726 for calling org-schedule with, or if there is no scheduling,
12727 returns nil."
12728 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12729 (when time
12730 (apply 'encode-time (org-parse-time-string time)))))
12732 (defun org-get-deadline-time (pom &optional inherit)
12733 "Get the deadline as a time tuple, of a format suitable for
12734 calling org-deadline with, or if there is no scheduling, returns
12735 nil."
12736 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12737 (when time
12738 (apply 'encode-time (org-parse-time-string time)))))
12740 (defun org-remove-timestamp-with-keyword (keyword)
12741 "Remove all time stamps with KEYWORD in the current entry."
12743 beg)
12744 (save-excursion
12745 (org-back-to-heading t)
12746 (setq beg (point))
12747 (outline-next-heading)
12748 (while (re-search-backward re beg t)
12749 (replace-match "")
12751 (equal (char-before) ?\ ))
12752 (backward-delete-char 1)
12754 (point-at-bol) (point-at-eol)))
12755 (delete-region (point-at-bol)
12756 (min (point-max) (1+ (point-at-eol))))))))))
12758 (defun org-add-planning-info (what &optional time &rest remove)
12759 "Insert new timestamp with keyword in the line directly after the headline.
12760 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12761 If non is given, the user is prompted for a date.
12762 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12763 be removed."
12764 (interactive)
12765 (let (org-time-was-given org-end-time-was-given ts
12766 end default-time default-input)
12768 (catch 'exit
12769 (when (and (memq what '(scheduled deadline))
12770 (or (not time)
12771 (and (stringp time)
12772 (string-match "^[-+]+[0-9]" time))))
12773 ;; Try to get a default date/time from existing timestamp
12774 (save-excursion
12775 (org-back-to-heading t)
12776 (setq end (save-excursion (outline-next-heading) (point)))
12777 (when (re-search-forward (if (eq what 'scheduled)
12778 org-scheduled-time-regexp
12779 org-deadline-time-regexp)
12780 end t)
12781 (setq ts (match-string 1)
12782 default-time
12783 (apply 'encode-time (org-parse-time-string ts))
12784 default-input (and ts (org-get-compact-tod ts))))))
12785 (when what
12786 (setq time
12787 (if (stringp time)
12788 ;; This is a string (relative or absolute), set proper date
12789 (apply 'encode-time
12790 (org-read-date-analyze
12791 time default-time (decode-time default-time)))
12792 ;; If necessary, get the time from the user
12793 (or time (org-read-date nil 'to-time nil nil
12794 default-time default-input)))))
12796 (when (and org-insert-labeled-timestamps-at-point
12797 (member what '(scheduled deadline)))
12798 (insert
12799 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12800 (org-insert-time-stamp time org-time-was-given
12801 nil nil nil (list org-end-time-was-given))
12802 (setq what nil))
12803 (save-excursion
12804 (save-restriction
12805 (let (col list elt ts buffer-invisibility-spec)
12806 (org-back-to-heading t)
12808 (goto-char (match-end 1))
12809 (setq col (current-column))
12810 (goto-char (match-end 0))
12812 (when (and (not what)
12813 (not (looking-at
12815 org-keyword-time-not-clock-regexp))))
12816 ;; Nothing to add, nothing to remove...... :-)
12817 (throw 'exit nil))
12818 (if (and (not (looking-at org-outline-regexp))
12821 (not (equal (match-string 1) org-clock-string)))
12822 (narrow-to-region (match-beginning 0) (match-end 0))
12824 (backward-char 1)
12825 (narrow-to-region (point) (point))
12826 (and org-adapt-indentation (org-indent-to-column col)))
12827 ;; Check if we have to remove something.
12828 (setq list (cons what remove))
12829 (while list
12830 (setq elt (pop list))
12831 (when (or (and (eq elt 'scheduled)
12832 (re-search-forward org-scheduled-time-regexp nil t))
12833 (and (eq elt 'deadline)
12834 (re-search-forward org-deadline-time-regexp nil t))
12835 (and (eq elt 'closed)
12836 (re-search-forward org-closed-time-regexp nil t)))
12837 (replace-match "")
12838 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12840 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12841 (when what
12842 (insert
12843 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12844 (cond ((eq what 'scheduled) org-scheduled-string)
12845 ((eq what 'deadline) org-deadline-string)
12846 ((eq what 'closed) org-closed-string))
12847 " ")
12848 (setq ts (org-insert-time-stamp
12849 time
12850 (or org-time-was-given
12851 (and (eq what 'closed) org-log-done-with-time))
12852 (eq what 'closed)
12853 nil nil (list org-end-time-was-given)))
12854 (insert
12855 (if (not (or (bolp) (eq (char-before) ?\ )
12856 (memq (char-after) '(32 10))
12857 (eobp))) " " ""))
12858 (end-of-line 1))
12859 (goto-char (point-min))
12860 (widen)
12863 (delete-region (1- (point)) (point-at-eol)))
12864 ts))))))
12866 (defvar org-log-note-marker (make-marker))
12867 (defvar org-log-note-purpose nil)
12868 (defvar org-log-note-state nil)
12869 (defvar org-log-note-previous-state nil)
12870 (defvar org-log-note-how nil)
12871 (defvar org-log-note-extra nil)
12872 (defvar org-log-note-window-configuration nil)
12873 (defvar org-log-note-return-to (make-marker))
12874 (defvar org-log-note-effective-time nil
12875 "Remembered current time so that dynamically scoped
12876 `org-extend-today-until' affects tha timestamps in state change
12877 log")
12879 (defvar org-log-post-message nil
12880 "Message to be displayed after a log note has been stored.
12881 The auto-repeater uses this.")
12883 (defun org-add-note ()
12884 "Add a note to the current entry.
12885 This is done in the same way as adding a state change note."
12886 (interactive)
12887 (org-add-log-setup 'note nil nil 'findpos nil))
12889 (defvar org-property-end-re)
12890 (defun org-add-log-setup (&optional purpose state prev-state
12891 findpos how extra)
12892 "Set up the post command hook to take a note.
12893 If this is about to TODO state change, the new state is expected in STATE.
12894 When FINDPOS is non-nil, find the correct position for the note in
12895 the current entry. If not, assume that it can be inserted at point.
12896 HOW is an indicator what kind of note should be created.
12897 EXTRA is additional text that will be inserted into the notes buffer."
12898 (let* ((org-log-into-drawer (org-log-into-drawer))
12899 (drawer (cond ((stringp org-log-into-drawer)
12900 org-log-into-drawer)
12901 (org-log-into-drawer "LOGBOOK"))))
12902 (save-restriction
12903 (save-excursion
12904 (when findpos
12905 (org-back-to-heading t)
12906 (narrow-to-region (point) (save-excursion
12907 (outline-next-heading) (point)))
12911 (goto-char (match-end 0))
12912 (cond
12913 (drawer
12915 nil t)
12916 (progn
12917 (goto-char (match-end 0))
12918 (or org-log-states-order-reversed
12919 (and (re-search-forward org-property-end-re nil t)
12920 (goto-char (1- (match-beginning 0))))))
12922 (beginning-of-line 0)
12923 (org-indent-line)
12924 (beginning-of-line 2)
12925 (org-indent-line)
12926 (end-of-line 0)))
12927 ((and org-log-state-notes-insert-after-drawers
12928 (save-excursion
12929 (forward-line) (looking-at org-drawer-regexp)))
12930 (forward-line)
12931 (while (looking-at org-drawer-regexp)
12932 (goto-char (match-end 0))
12933 (re-search-forward org-property-end-re (point-max) t)
12934 (forward-line))
12935 (forward-line -1)))
12936 (unless org-log-states-order-reversed
12938 (org-skip-over-state-notes)
12940 (move-marker org-log-note-marker (point))
12941 (setq org-log-note-purpose purpose
12942 org-log-note-state state
12943 org-log-note-previous-state prev-state
12944 org-log-note-how how
12945 org-log-note-extra extra
12946 org-log-note-effective-time (org-current-effective-time))
12947 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12949 (defun org-skip-over-state-notes ()
12950 "Skip past the list of State notes in an entry."
12952 (when (ignore-errors (goto-char (org-in-item-p)))
12953 (let* ((struct (org-list-struct))
12954 (prevs (org-list-prevs-alist struct)))
12956 (goto-char (or (org-list-get-next-item (point) struct prevs)
12957 (org-list-get-item-end (point) struct)))))))
12959 (defun org-add-log-note (&optional purpose)
12960 "Pop up a window for taking a note, and add this note later at point."
12961 (remove-hook 'post-command-hook 'org-add-log-note)
12962 (setq org-log-note-window-configuration (current-window-configuration))
12963 (delete-other-windows)
12964 (move-marker org-log-note-return-to (point))
12965 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12966 (goto-char org-log-note-marker)
12967 (org-switch-to-buffer-other-window "*Org Note*")
12968 (erase-buffer)
12969 (if (memq org-log-note-how '(time state))
12970 (let (current-prefix-arg) (org-store-log-note))
12971 (let ((org-inhibit-startup t)) (org-mode))
12972 (insert (format "# Insert note for %s.
12974 (cond
12975 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12976 ((eq org-log-note-purpose 'done) "closed todo item")
12977 ((eq org-log-note-purpose 'state)
12979 (or org-log-note-previous-state "")
12980 (or org-log-note-state "")))
12981 ((eq org-log-note-purpose 'reschedule)
12982 "rescheduling")
12983 ((eq org-log-note-purpose 'delschedule)
12984 "no longer scheduled")
12985 ((eq org-log-note-purpose 'redeadline)
12986 "changing deadline")
12987 ((eq org-log-note-purpose 'deldeadline)
12988 "removing deadline")
12989 ((eq org-log-note-purpose 'refile)
12990 "refiling")
12991 ((eq org-log-note-purpose 'note)
12992 "this entry")
12993 (t (error "This should not happen")))))
12994 (if org-log-note-extra (insert org-log-note-extra))
12995 (org-set-local 'org-finish-function 'org-store-log-note)
12996 (run-hooks 'org-log-buffer-setup-hook)))
12998 (defvar org-note-abort nil) ; dynamically scoped
12999 (defun org-store-log-note ()
13000 "Finish taking a log note, and insert it to where it belongs."
13001 (let ((txt (buffer-string)))
13002 (kill-buffer (current-buffer))
13003 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13004 lines ind bul)
13006 (setq txt (replace-match "" t t txt)))
13008 (setq txt (replace-match "" t t txt)))
13011 (setq note
13012 (org-replace-escapes
13013 note
13014 (list (cons "%u" (user-login-name))
13015 (cons "%U" user-full-name)
13016 (cons "%t" (format-time-string
13017 (org-time-stamp-format 'long 'inactive)
13018 org-log-note-effective-time))
13019 (cons "%T" (format-time-string
13020 (org-time-stamp-format 'long nil)
13021 org-log-note-effective-time))
13022 (cons "%d" (format-time-string
13023 (org-time-stamp-format nil 'inactive)
13024 org-log-note-effective-time))
13025 (cons "%D" (format-time-string
13026 (org-time-stamp-format nil nil)
13027 org-log-note-effective-time))
13028 (cons "%s" (if org-log-note-state
13030 ""))
13031 (cons "%S" (if org-log-note-previous-state
13035 (push note lines))
13036 (when (or current-prefix-arg org-note-abort)
13037 (when org-log-into-drawer
13038 (org-remove-empty-drawer-at
13039 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13040 org-log-note-marker))
13041 (setq lines nil))
13042 (when lines
13043 (with-current-buffer (marker-buffer org-log-note-marker)
13044 (save-excursion
13045 (goto-char org-log-note-marker)
13046 (move-marker org-log-note-marker nil)
13047 (end-of-line 1)
13049 (setq ind (save-excursion
13050 (if (ignore-errors (goto-char (org-in-item-p)))
13051 (let ((struct (org-list-struct)))
13052 (org-list-get-ind
13053 (org-list-get-top-point struct) struct))
13055 (cond
13056 ((and (org-at-heading-p)
13057 org-adapt-indentation)
13058 (1+ (org-current-level)))
13059 ((org-at-heading-p) 0)
13060 (t (org-get-indentation))))))
13061 (setq bul (org-list-bullet-string "-"))
13062 (org-indent-line-to ind)
13063 (insert bul (pop lines))
13064 (let ((ind-body (+ (length bul) ind)))
13065 (while lines
13067 (org-indent-line-to ind-body)
13068 (insert (pop lines))))
13069 (message "Note stored")
13070 (org-back-to-heading t)
13071 (org-cycle-hide-drawers 'children))))))
13072 (set-window-configuration org-log-note-window-configuration)
13073 (with-current-buffer (marker-buffer org-log-note-return-to)
13074 (goto-char org-log-note-return-to))
13075 (move-marker org-log-note-return-to nil)
13076 (and org-log-post-message (message "%s" org-log-post-message)))
13078 (defun org-remove-empty-drawer-at (drawer pos)
13079 "Remove an empty drawer DRAWER at position POS.
13080 POS may also be a marker."
13081 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13082 (save-excursion
13083 (save-restriction
13084 (widen)
13085 (goto-char pos)
13086 (if (org-in-regexp
13088 (replace-match ""))))))
13090 (defvar org-ts-type nil)
13091 (defun org-sparse-tree (&optional arg type)
13092 "Create a sparse tree, prompt for the details.
13093 This command can create sparse trees. You first need to select the type
13094 of match used to create the tree:
13096 t Show all TODO entries.
13097 T Show entries with a specific TODO keyword.
13098 m Show entries selected by a tags/property match.
13099 p Enter a property name and its value (both with completion on existing
13100 names/values) and show entries with that property.
13101 r Show entries matching a regular expression (`/' can be used as well).
13102 b Show deadlines and scheduled items before a date.
13103 a Show deadlines and scheduled items after a date.
13104 d Show deadlines due within `org-deadline-warning-days'.
13105 D Show deadlines and scheduled items between a date range."
13106 (interactive "P")
13107 (let (ans kwd value ts-type)
13108 (setq type (or type org-sparse-tree-default-date-type))
13109 (setq org-ts-type type)
13110 (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"
13111 (cond ((eq type 'all) "all timestamps")
13112 ((eq type 'scheduled) "only scheduled")
13113 ((eq type 'deadline) "only deadline")
13114 ((eq type 'active) "only active timestamps")
13115 ((eq type 'inactive) "only inactive timestamps")
13116 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13117 (t "scheduled/deadline")))
13118 (setq ans (read-char-exclusive))
13119 (cond
13120 ((equal ans ?c)
13121 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
13122 ((equal ans ?d)
13123 (call-interactively 'org-check-deadlines))
13124 ((equal ans ?b)
13125 (call-interactively 'org-check-before-date))
13126 ((equal ans ?a)
13127 (call-interactively 'org-check-after-date))
13128 ((equal ans ?D)
13129 (call-interactively 'org-check-dates-range))
13130 ((equal ans ?t)
13131 (call-interactively 'org-show-todo-tree))
13132 ((equal ans ?T)
13133 (org-show-todo-tree '(4)))
13134 ((member ans '(?T ?m))
13135 (call-interactively 'org-match-sparse-tree))
13136 ((member ans '(?p ?P))
13137 (setq kwd (org-icompleting-read "Property: "
13138 (mapcar 'list (org-buffer-property-keys))))
13139 (setq value (org-icompleting-read "Value: "
13140 (mapcar 'list (org-property-values kwd))))
13143 (org-match-sparse-tree arg (concat kwd "=" value)))
13144 ((member ans '(?r ?R ?/))
13145 (call-interactively 'org-occur))
13148 (defvar org-occur-highlights nil
13149 "List of overlays used for occur matches.")
13150 (make-variable-buffer-local 'org-occur-highlights)
13151 (defvar org-occur-parameters nil
13152 "Parameters of the active org-occur calls.
13153 This is a list, each call to org-occur pushes as cons cell,
13154 containing the regular expression and the callback, onto the list.
13155 The list can contain several entries if `org-occur' has been called
13156 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13157 will only contain one set of parameters. When the highlights are
13158 removed (for example with `C-c C-c', or with the next edit (depending
13159 on `org-remove-highlights-with-change'), this variable is emptied
13160 as well.")
13161 (make-variable-buffer-local 'org-occur-parameters)
13163 (defun org-occur (regexp &optional keep-previous callback)
13164 "Make a compact tree which shows all matches of REGEXP.
13165 The tree will show the lines where the regexp matches, and all higher
13166 headlines above the match. It will also show the heading after the match,
13167 to make sure editing the matching entry is easy.
13168 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13169 call to `org-occur' will be kept, to allow stacking of calls to this
13170 command.
13171 If CALLBACK is non-nil, it is a function which is called to confirm
13172 that the match should indeed be shown."
13174 (when (equal regexp "")
13175 (error "Regexp cannot be empty"))
13176 (unless keep-previous
13177 (org-remove-occur-highlights nil nil t))
13178 (push (cons regexp callback) org-occur-parameters)
13179 (let ((cnt 0))
13180 (save-excursion
13181 (goto-char (point-min))
13182 (if (or (not keep-previous) ; do not want to keep
13183 (not org-occur-highlights)) ; no previous matches
13184 ;; hide everything
13185 (org-overview))
13186 (while (re-search-forward regexp nil t)
13187 (when (or (not callback)
13188 (save-match-data (funcall callback)))
13189 (setq cnt (1+ cnt))
13190 (when org-highlight-sparse-tree-matches
13191 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13192 (org-show-context 'occur-tree))))
13193 (when org-remove-highlights-with-change
13194 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13195 nil 'local))
13196 (unless org-sparse-tree-open-archived-trees
13197 (org-hide-archived-subtrees (point-min) (point-max)))
13198 (run-hooks 'org-occur-hook)
13199 (if (org-called-interactively-p 'interactive)
13200 (message "%d match(es) for regexp %s" cnt regexp))
13201 cnt))
13203 (defun org-occur-next-match (&optional n reset)
13204 "Function for `next-error-function' to find sparse tree matches.
13205 N is the number of matches to move, when negative move backwards.
13206 RESET is entirely ignored - this function always goes back to the
13207 starting point when no match is found."
13208 (let* ((limit (if (< n 0) (point-min) (point-max)))
13209 (search-func (if (< n 0)
13210 'previous-single-char-property-change
13211 'next-single-char-property-change))
13212 (n (abs n))
13213 (pos (point))
13214 p1)
13215 (catch 'exit
13216 (while (setq p1 (funcall search-func (point) 'org-type))
13217 (when (equal p1 limit)
13218 (goto-char pos)
13219 (error "No more matches"))
13220 (when (equal (get-char-property p1 'org-type) 'org-occur)
13221 (setq n (1- n))
13222 (when (= n 0)
13223 (goto-char p1)
13224 (throw 'exit (point))))
13225 (goto-char p1))
13226 (goto-char p1)
13227 (error "No more matches"))))
13229 (defun org-show-context (&optional key)
13230 "Make sure point and context are visible.
13231 How much context is shown depends upon the variables
13232 `org-show-hierarchy-above', `org-show-following-heading',
13233 `org-show-entry-below' and `org-show-siblings'."
13234 (let ((heading-p (org-at-heading-p t))
13235 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13236 (following-p (org-get-alist-option org-show-following-heading key))
13237 (entry-p (org-get-alist-option org-show-entry-below key))
13238 (siblings-p (org-get-alist-option org-show-siblings key)))
13239 (catch 'exit
13240 ;; Show heading or entry text
13241 (if (and heading-p (not entry-p))
13242 (org-flag-heading nil) ; only show the heading
13243 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13244 (org-show-hidden-entry))) ; show entire entry
13245 (when following-p
13246 ;; Show next sibling, or heading below text
13247 (save-excursion
13248 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13249 (org-flag-heading nil))))
13250 (when siblings-p (org-show-siblings))
13251 (when hierarchy-p
13252 ;; show all higher headings, possibly with siblings
13253 (save-excursion
13254 (while (and (condition-case nil
13255 (progn (org-up-heading-all 1) t)
13256 (error nil))
13257 (not (bobp)))
13258 (org-flag-heading nil)
13259 (when siblings-p (org-show-siblings))))))))
13261 (defvar org-reveal-start-hook nil
13262 "Hook run before revealing a location.")
13264 (defun org-reveal (&optional siblings)
13265 "Show current entry, hierarchy above it, and the following headline.
13266 This can be used to show a consistent set of context around locations
13267 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13268 not t for the search context.
13270 With optional argument SIBLINGS, on each level of the hierarchy all
13271 siblings are shown. This repairs the tree structure to what it would
13272 look like when opened with hierarchical calls to `org-cycle'.
13274 go to the parent and show the
13275 entire tree."
13276 (interactive "P")
13277 (run-hooks 'org-reveal-start-hook)
13278 (let ((org-show-hierarchy-above t)
13279 (org-show-following-heading t)
13280 (org-show-siblings (if siblings t org-show-siblings)))
13281 (org-show-context nil))
13282 (when (equal siblings '(16))
13283 (save-excursion
13284 (when (org-up-heading-safe)
13285 (org-show-subtree)
13286 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13288 (defun org-highlight-new-match (beg end)
13289 "Highlight from BEG to END and mark the highlight is an occur headline."
13290 (let ((ov (make-overlay beg end)))
13291 (overlay-put ov 'face 'secondary-selection)
13292 (overlay-put ov 'org-type 'org-occur)
13293 (push ov org-occur-highlights)))
13295 (defun org-remove-occur-highlights (&optional beg end noremove)
13296 "Remove the occur highlights from the buffer.
13297 BEG and END are ignored. If NOREMOVE is nil, remove this function
13298 from the `before-change-functions' in the current buffer."
13299 (interactive)
13300 (unless org-inhibit-highlight-removal
13301 (mapc 'delete-overlay org-occur-highlights)
13302 (setq org-occur-highlights nil)
13303 (setq org-occur-parameters nil)
13304 (unless noremove
13305 (remove-hook 'before-change-functions
13306 'org-remove-occur-highlights 'local))))
13308 ;;;; Priorities
13311 "Regular expression matching the priority indicator.")
13313 (defvar org-remove-priority-next-time nil)
13315 (defun org-priority-up ()
13316 "Increase the priority of the current item."
13317 (interactive)
13318 (org-priority 'up))
13320 (defun org-priority-down ()
13321 "Decrease the priority of the current item."
13322 (interactive)
13323 (org-priority 'down))
13325 (defun org-priority (&optional action show)
13326 "Change the priority of an item.
13327 ACTION can be `set', `up', `down', or a character."
13328 (interactive "P")
13329 (if (equal action '(4))
13330 (org-show-priority)
13331 (unless org-enable-priority-commands
13332 (error "Priority commands are disabled"))
13333 (setq action (or action 'set))
13334 (let (current new news have remove)
13335 (save-excursion
13336 (org-back-to-heading t)
13337 (if (looking-at org-priority-regexp)
13338 (setq current (string-to-char (match-string 2))
13339 have t))
13340 (cond
13341 ((eq action 'remove)
13342 (setq remove t new ?\ ))
13343 ((or (eq action 'set)
13344 (if (featurep 'xemacs) (characterp action) (integerp action)))
13345 (if (not (eq action 'set))
13346 (setq new action)
13347 (message "Priority %c-%c, SPC to remove: "
13348 org-highest-priority org-lowest-priority)
13349 (save-match-data
13350 (setq new (read-char-exclusive))))
13351 (if (and (= (upcase org-highest-priority) org-highest-priority)
13352 (= (upcase org-lowest-priority) org-lowest-priority))
13353 (setq new (upcase new)))
13354 (cond ((equal new ?\ ) (setq remove t))
13355 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13356 (error "Priority must be between `%c' and `%c'"
13357 org-highest-priority org-lowest-priority))))
13358 ((eq action 'up)
13359 (setq new (if have
13360 (1- current) ; normal cycling
13361 ;; last priority was empty
13362 (if (eq last-command this-command)
13363 org-lowest-priority ; wrap around empty to lowest
13364 ;; default
13365 (if org-priority-start-cycle-with-default
13366 org-default-priority
13367 (1- org-default-priority))))))
13368 ((eq action 'down)
13369 (setq new (if have
13370 (1+ current) ; normal cycling
13371 ;; last priority was empty
13372 (if (eq last-command this-command)
13373 org-highest-priority ; wrap around empty to highest
13374 ;; default
13375 (if org-priority-start-cycle-with-default
13376 org-default-priority
13377 (1+ org-default-priority))))))
13378 (t (error "Invalid action")))
13379 (if (or (< (upcase new) org-highest-priority)
13380 (> (upcase new) org-lowest-priority))
13381 (if (and (memq action '(up down))
13382 (not have) (not (eq last-command this-command)))
13383 ;; `new' is from default priority
13384 (error
13385 "The default can not be set, see `org-default-priority' why")
13386 ;; normal cycling: `new' is beyond highest/lowest priority
13387 ;; and is wrapped around to the empty priority
13388 (setq remove t)))
13389 (setq news (format "%c" new))
13390 (if have
13391 (if remove
13392 (replace-match "" t t nil 1)
13393 (replace-match news t t nil 2))
13394 (if remove
13395 (error "No priority cookie found in line")
13396 (let ((case-fold-search nil))
13397 (looking-at org-todo-line-regexp))
13398 (if (match-end 2)
13399 (progn
13400 (goto-char (match-end 2))
13401 (insert " [#" news "]"))
13402 (goto-char (match-beginning 3))
13403 (insert "[#" news "] "))))
13404 (org-preserve-lc (org-set-tags nil 'align)))
13405 (if remove
13406 (message "Priority removed")
13407 (message "Priority of current item set to %s" news)))))
13409 (defun org-show-priority ()
13410 "Show the priority of the current item.
13411 This priority is composed of the main priority given with the [#A] cookies,
13412 and by additional input from the age of a schedules or deadline entry."
13413 (interactive)
13414 (let ((pri (if (eq major-mode 'org-agenda-mode)
13415 (org-get-at-bol 'priority)
13416 (save-excursion
13417 (save-match-data
13418 (beginning-of-line)
13419 (and (looking-at org-heading-regexp)
13420 (org-get-priority (match-string 0))))))))
13421 (message "Priority is %d" (if pri pri -1000))))
13423 (defun org-get-priority (s)
13424 "Find priority cookie and return priority."
13425 (save-match-data
13426 (if (functionp org-get-priority-function)
13427 (funcall org-get-priority-function)
13428 (if (not (string-match org-priority-regexp s))
13429 (* 1000 (- org-lowest-priority org-default-priority))
13430 (* 1000 (- org-lowest-priority
13431 (string-to-char (match-string 2 s))))))))
13433 ;;;; Tags
13435 (defvar org-agenda-archives-mode)
13436 (defvar org-map-continue-from nil
13437 "Position from where mapping should continue.
13438 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13440 (defvar org-scanner-tags nil
13441 "The current tag list while the tags scanner is running.")
13442 (defvar org-trust-scanner-tags nil
13443 "Should `org-get-tags-at' use the tags for the scanner.
13444 This is for internal dynamical scoping only.
13445 When this is non-nil, the function `org-get-tags-at' will return the value
13446 of `org-scanner-tags' instead of building the list by itself. This
13447 can lead to large speed-ups when the tags scanner is used in a file with
13448 many entries, and when the list of tags is retrieved, for example to
13449 obtain a list of properties. Building the tags list for each entry in such
13450 a file becomes an N^2 operation - but with this variable set, it scales
13451 as N.")
13453 (defun org-scan-tags (action matcher todo-only &optional start-level)
13454 "Sca headline tags with inheritance and produce output ACTION.
13456 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13457 or `agenda' to produce an entry list for an agenda view. It can also be
13458 a Lisp form or a function that should be called at each matched headline, in
13459 this case the return value is a list of all return values from these calls.
13461 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13462 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13463 only lines with a not-done TODO keyword are included in the output.
13464 This should be the same variable that was scoped into
13465 and set by `org-make-tags-matcher' when it constructed MATCHER.
13467 START-LEVEL can be a string with asterisks, reducing the scope to
13468 headlines matching this string."
13469 (require 'org-agenda)
13470 (let* ((re (concat "^"
13471 (if start-level
13472 ;; Get the correct level to match
13474 org-outline-regexp)
13478 (props (list 'face 'default
13479 'done-face 'org-agenda-done
13480 'undone-face 'default
13481 'mouse-face 'highlight
13482 'org-not-done-regexp org-not-done-regexp
13483 'org-todo-regexp org-todo-regexp
13484 'org-complex-heading-regexp org-complex-heading-regexp
13485 'help-echo
13486 (format "mouse-2 or RET jump to org file %s"
13487 (abbreviate-file-name
13488 (or (buffer-file-name (buffer-base-buffer))
13489 (buffer-name (buffer-base-buffer)))))))
13490 (case-fold-search nil)
13491 (org-map-continue-from nil)
13492 lspos tags tags-list
13493 (tags-alist (list (cons 0 org-file-tags)))
13494 (llast 0) rtn rtn1 level category i txt
13495 todo marker entry priority)
13496 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13497 (setq action (list 'lambda nil action)))
13498 (save-excursion
13499 (goto-char (point-min))
13500 (when (eq action 'sparse-tree)
13501 (org-overview)
13502 (org-remove-occur-highlights))
13503 (while (re-search-forward re nil t)
13504 (setq org-map-continue-from nil)
13505 (catch :skip
13506 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13507 tags (if (match-end 4) (org-match-string-no-properties 4)))
13508 (goto-char (setq lspos (match-beginning 0)))
13509 (setq level (org-reduced-level (org-outline-level))
13510 category (org-get-category))
13511 (setq i llast llast level)
13512 ;; remove tag lists from same and sublevels
13513 (while (>= i level)
13514 (when (setq entry (assoc i tags-alist))
13515 (setq tags-alist (delete entry tags-alist)))
13516 (setq i (1- i)))
13517 ;; add the next tags
13518 (when tags
13519 (setq tags (org-split-string tags ":")
13520 tags-alist
13521 (cons (cons level tags) tags-alist)))
13522 ;; compile tags for current headline
13523 (setq tags-list
13524 (if org-use-tag-inheritance
13525 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13526 tags)
13527 org-scanner-tags tags-list)
13528 (when org-use-tag-inheritance
13529 (setcdr (car tags-alist)
13530 (mapcar (lambda (x)
13531 (setq x (copy-sequence x))
13532 (org-add-prop-inherited x))
13533 (cdar tags-alist))))
13534 (when (and tags org-use-tag-inheritance
13535 (or (not (eq t org-use-tag-inheritance))
13536 org-tags-exclude-from-inheritance))
13537 ;; selective inheritance, remove uninherited ones
13538 (setcdr (car tags-alist)
13539 (org-remove-uninherited-tags (cdar tags-alist))))
13540 (when (and
13542 ;; eval matcher only when the todo condition is OK
13543 (and (or (not todo-only) (member todo org-not-done-keywords))
13544 (let ((case-fold-search t) (org-trust-scanner-tags t))
13545 (eval matcher)))
13547 ;; Call the skipper, but return t if it does not skip,
13548 ;; so that the `and' form continues evaluating
13549 (progn
13550 (unless (eq action 'sparse-tree) (org-agenda-skip))
13551 t)
13553 ;; Check if timestamps are deselecting this entry
13554 (or (not todo-only)
13555 (and (member todo org-not-done-keywords)
13556 (or (not org-agenda-tags-todo-honor-ignore-options)
13557 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13559 ;; select this headline
13560 (cond
13561 ((eq action 'sparse-tree)
13562 (and org-highlight-sparse-tree-matches
13563 (org-get-heading) (match-end 0)
13564 (org-highlight-new-match
13565 (match-beginning 1) (match-end 1)))
13566 (org-show-context 'tags-tree))
13567 ((eq action 'agenda)
13568 (setq txt (org-agenda-format-item
13569 ""
13570 (concat
13571 (if (eq org-tags-match-list-sublevels 'indented)
13572 (make-string (1- level) ?.) "")
13573 (org-get-heading))
13574 level category
13575 tags-list)
13576 priority (org-get-priority txt))
13577 (goto-char lspos)
13578 (setq marker (org-agenda-new-marker))
13579 (org-add-props txt props
13580 'org-marker marker 'org-hd-marker marker 'org-category category
13581 'todo-state todo
13582 'priority priority 'type "tagsmatch")
13583 (push txt rtn))
13584 ((functionp action)
13585 (setq org-map-continue-from nil)
13586 (save-excursion
13587 (setq rtn1 (funcall action))
13588 (push rtn1 rtn)))
13589 (t (error "Invalid action")))
13591 ;; if we are to skip sublevels, jump to end of subtree
13592 (unless org-tags-match-list-sublevels
13593 (org-end-of-subtree t)
13594 (backward-char 1))))
13595 ;; Get the correct position from where to continue
13596 (if org-map-continue-from
13597 (goto-char org-map-continue-from)
13598 (and (= (point) lspos) (end-of-line 1)))))
13599 (when (and (eq action 'sparse-tree)
13600 (not org-sparse-tree-open-archived-trees))
13601 (org-hide-archived-subtrees (point-min) (point-max)))
13602 (nreverse rtn)))
13604 (defun org-remove-uninherited-tags (tags)
13605 "Remove all tags that are not inherited from the list TAGS."
13606 (cond
13607 ((eq org-use-tag-inheritance t)
13608 (if org-tags-exclude-from-inheritance
13609 (org-delete-all org-tags-exclude-from-inheritance tags)
13610 tags))
13611 ((not org-use-tag-inheritance) nil)
13612 ((stringp org-use-tag-inheritance)
13613 (delq nil (mapcar
13614 (lambda (x)
13615 (if (and (string-match org-use-tag-inheritance x)
13616 (not (member x org-tags-exclude-from-inheritance)))
13617 x nil))
13618 tags)))
13619 ((listp org-use-tag-inheritance)
13620 (delq nil (mapcar
13621 (lambda (x)
13622 (if (member x org-use-tag-inheritance) x nil))
13623 tags)))))
13625 (defun org-match-sparse-tree (&optional todo-only match)
13626 "Create a sparse tree according to tags string MATCH.
13627 MATCH can contain positive and negative selection of tags, like
13629 If optional argument TODO-ONLY is non-nil, only select lines that are
13630 also TODO lines."
13631 (interactive "P")
13632 (org-agenda-prepare-buffers (list (current-buffer)))
13633 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13635 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13637 (defvar org-cached-props nil)
13638 (defun org-cached-entry-get (pom property)
13639 (if (or (eq t org-use-property-inheritance)
13640 (and (stringp org-use-property-inheritance)
13641 (string-match org-use-property-inheritance property))
13642 (and (listp org-use-property-inheritance)
13643 (member property org-use-property-inheritance)))
13644 ;; Caching is not possible, check it directly
13645 (org-entry-get pom property 'inherit)
13646 ;; Get all properties, so that we can do complicated checks easily
13647 (cdr (assoc property (or org-cached-props
13648 (setq org-cached-props
13649 (org-entry-properties pom)))))))
13651 (defun org-global-tags-completion-table (&optional files)
13652 "Return the list of all tags in all agenda buffer/files.
13653 Optional FILES argument is a list of files which can be used
13654 instead of the agenda files."
13655 (save-excursion
13656 (org-uniquify
13657 (delq nil
13658 (apply 'append
13659 (mapcar
13660 (lambda (file)
13661 (set-buffer (find-file-noselect file))
13662 (append (org-get-buffer-tags)
13663 (mapcar (lambda (x) (if (stringp (car-safe x))
13664 (list (car-safe x)) nil))
13665 org-tag-alist)))
13666 (if (and files (car files))
13667 files
13668 (org-agenda-files))))))))
13670 (defun org-make-tags-matcher (match)
13671 "Create the TAGS/TODO matcher form for the selection string MATCH.
13673 The variable `todo-only' is scoped dynamically into this function.
13674 It will be set to t if the matcher restricts matching to TODO entries,
13675 otherwise will not be touched.
13677 Returns a cons of the selection string MATCH and the constructed
13678 lisp form implementing the matcher. The matcher is to be evaluated
13679 at an Org entry, with point on the headline, and returns t if the
13680 entry matches the selection string MATCH. The returned lisp form
13681 references two variables with information about the entry, which
13682 must be bound around the form's evaluation: todo, the TODO keyword
13683 at the entry (or nil of none); and tags-list, the list of all tags
13684 at the entry including inherited ones. Additionally, the category
13685 of the entry (if any) must be specified as the text property
13686 'org-category on the headline.
13688 See also `org-scan-tags'.
13689 "
13690 (declare (special todo-only))
13691 (unless (boundp 'todo-only)
13692 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13693 (unless match
13694 ;; Get a new match request, with completion
13695 (let ((org-last-tags-completion-table
13696 (org-global-tags-completion-table)))
13697 (setq match (org-completing-read-no-i
13698 "Match: " 'org-tags-completion-function nil nil nil
13699 'org-tags-history))))
13701 ;; Parse the string and create a lisp form
13702 (let ((match0 match)
13703 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13704 minus tag mm
13705 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13706 orterms term orlist re-p str-p level-p level-op time-p
13707 prop-p pn pv po gv rest)
13708 (if (string-match "/+" match)
13709 ;; match contains also a todo-matching request
13710 (progn
13711 (setq tagsmatch (substring match 0 (match-beginning 0))
13712 todomatch (substring match (match-end 0)))
13713 (if (string-match "^!" todomatch)
13714 (setq todo-only t todomatch (substring todomatch 1)))
13716 (setq todomatch nil)))
13717 ;; only matching tags
13718 (setq tagsmatch match todomatch nil))
13720 ;; Make the tags matcher
13722 (setq tagsmatcher t)
13723 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13724 (while (setq term (pop orterms))
13726 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13727 (while (string-match re term)
13728 (setq rest (substring term (match-end 0))
13729 minus (and (match-end 1)
13730 (equal (match-string 1 term) "-"))
13731 tag (save-match-data (replace-regexp-in-string
13733 (match-string 2 term)))
13734 re-p (equal (string-to-char tag) ?{)
13735 level-p (match-end 4)
13736 prop-p (match-end 5)
13737 mm (cond
13738 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13739 (level-p
13740 (setq level-op (org-op-to-function (match-string 3 term)))
13741 `(,level-op level ,(string-to-number
13742 (match-string 4 term))))
13743 (prop-p
13744 (setq pn (match-string 5 term)
13745 po (match-string 6 term)
13746 pv (match-string 7 term)
13747 re-p (equal (string-to-char pv) ?{)
13749 time-p (save-match-data
13751 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13752 (if time-p (setq pv (org-matcher-time pv)))
13753 (setq po (org-op-to-function po (if time-p 'time str-p)))
13754 (cond
13755 ((equal pn "CATEGORY")
13756 (setq gv '(get-text-property (point) 'org-category)))
13757 ((equal pn "TODO")
13758 (setq gv 'todo))
13759 (t
13760 (setq gv `(org-cached-entry-get nil ,pn))))
13761 (if re-p
13762 (if (eq po 'org<>)
13763 `(not (string-match ,pv (or ,gv "")))
13764 `(string-match ,pv (or ,gv "")))
13765 (if str-p
13766 `(,po (or ,gv "") ,pv)
13767 `(,po (string-to-number (or ,gv ""))
13768 ,(string-to-number pv) ))))
13769 (t `(member ,tag tags-list)))
13770 mm (if minus (list 'not mm) mm)
13771 term rest)
13772 (push mm tagsmatcher))
13773 (push (if (> (length tagsmatcher) 1)
13774 (cons 'and tagsmatcher)
13775 (car tagsmatcher))
13776 orlist)
13777 (setq tagsmatcher nil))
13778 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13779 (setq tagsmatcher
13780 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13781 ;; Make the todo matcher
13783 (setq todomatcher t)
13784 (setq orterms (org-split-string todomatch "|") orlist nil)
13785 (while (setq term (pop orterms))
13786 (while (string-match re term)
13787 (setq minus (and (match-end 1)
13788 (equal (match-string 1 term) "-"))
13789 kwd (match-string 2 term)
13790 re-p (equal (string-to-char kwd) ?{)
13791 term (substring term (match-end 0))
13792 mm (if re-p
13793 `(string-match ,(substring kwd 1 -1) todo)
13794 (list 'equal 'todo kwd))
13795 mm (if minus (list 'not mm) mm))
13796 (push mm todomatcher))
13797 (push (if (> (length todomatcher) 1)
13798 (cons 'and todomatcher)
13799 (car todomatcher))
13800 orlist)
13801 (setq todomatcher nil))
13802 (setq todomatcher (if (> (length orlist) 1)
13803 (cons 'or orlist) (car orlist))))
13805 ;; Return the string and lisp forms of the matcher
13806 (setq matcher (if todomatcher
13807 (list 'and tagsmatcher todomatcher)
13808 tagsmatcher))
13809 (when todo-only
13810 (setq matcher (list 'and '(member todo org-not-done-keywords)
13811 matcher)))
13812 (cons match0 matcher)))
13814 (defun org-op-to-function (op &optional stringp)
13815 "Turn an operator into the appropriate function."
13816 (setq op
13817 (cond
13818 ((equal op "<" ) '(< string< org-time<))
13819 ((equal op ">" ) '(> org-string> org-time>))
13820 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13821 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13822 ((member op '("=" "==")) '(= string= org-time=))
13823 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13824 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13826 (defun org<> (a b) (not (= a b)))
13827 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13828 (defun org-string>= (a b) (not (string< a b)))
13829 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13830 (defun org-string<> (a b) (not (string= a b)))
13831 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13832 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13833 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13834 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13835 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13836 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13837 (defun org-2ft (s)
13838 "Convert S to a floating point time.
13839 If S is already a number, just return it. If it is a string, parse
13840 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13841 (cond
13842 ((numberp s) s)
13843 ((stringp s)
13844 (condition-case nil
13845 (float-time (apply 'encode-time (org-parse-time-string s)))
13846 (error 0.)))
13847 (t 0.)))
13849 (defun org-time-today ()
13850 "Time in seconds today at 0:00.
13851 Returns the float number of seconds since the beginning of the
13852 epoch to the beginning of today (00:00)."
13853 (float-time (apply 'encode-time
13854 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13856 (defun org-matcher-time (s)
13857 "Interpret a time comparison value."
13858 (save-match-data
13859 (cond
13860 ((string= s "<now>") (float-time))
13861 ((string= s "<today>") (org-time-today))
13862 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13863 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13865 (+ (org-time-today)
13866 (* (string-to-number (match-string 1 s))
13867 (cdr (assoc (match-string 2 s)
13868 '(("d" . 86400.0) ("w" . 604800.0)
13869 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13870 (t (org-2ft s)))))
13872 (defun org-match-any-p (re list)
13873 "Does re match any element of list?"
13874 (setq list (mapcar (lambda (x) (string-match re x)) list))
13875 (delq nil list))
13877 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13878 (defvar org-tags-overlay (make-overlay 1 1))
13879 (org-detach-overlay org-tags-overlay)
13881 (defun org-get-local-tags-at (&optional pos)
13882 "Get a list of tags defined in the current headline."
13883 (org-get-tags-at pos 'local))
13885 (defun org-get-local-tags ()
13886 "Get a list of tags defined in the current headline."
13887 (org-get-tags-at nil 'local))
13889 (defun org-get-tags-at (&optional pos local)
13890 "Get a list of all headline tags applicable at POS.
13891 POS defaults to point. If tags are inherited, the list contains
13892 the targets in the same sequence as the headlines appear, i.e.
13893 the tags of the current headline come last.
13894 When LOCAL is non-nil, only return tags from the current headline,
13895 ignore inherited ones."
13896 (interactive)
13897 (if (and org-trust-scanner-tags
13898 (or (not pos) (equal pos (point)))
13899 (not local))
13900 org-scanner-tags
13901 (let (tags ltags lastpos parent)
13902 (save-excursion
13903 (save-restriction
13904 (widen)
13905 (goto-char (or pos (point)))
13906 (save-match-data
13907 (catch 'done
13908 (condition-case nil
13909 (progn
13910 (org-back-to-heading t)
13911 (while (not (equal lastpos (point)))
13912 (setq lastpos (point))
13913 (when (looking-at
13915 (setq ltags (org-split-string
13916 (org-match-string-no-properties 1) ":"))
13917 (when parent
13918 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13919 (setq tags (append
13920 (if parent
13921 (org-remove-uninherited-tags ltags)
13922 ltags)
13923 tags)))
13924 (or org-use-tag-inheritance (throw 'done t))
13925 (if local (throw 'done t))
13926 (or (org-up-heading-safe) (error nil))
13927 (setq parent t)))
13928 (error nil)))))
13929 (if local
13930 tags
13931 (reverse (delete-dups
13932 (reverse (append
13933 (org-remove-uninherited-tags
13934 org-file-tags) tags)))))))))
13936 (defun org-add-prop-inherited (s)
13937 (add-text-properties 0 (length s) '(inherited t) s)
13938 s)
13940 (defun org-toggle-tag (tag &optional onoff)
13941 "Toggle the tag TAG for the current line.
13942 If ONOFF is `on' or `off', don't toggle but set to this state."
13943 (let (res current)
13944 (save-excursion
13945 (org-back-to-heading t)
13947 (point-at-eol) t)
13948 (progn
13949 (setq current (match-string 1))
13950 (replace-match ""))
13951 (setq current ""))
13952 (setq current (nreverse (org-split-string current ":")))
13953 (cond
13954 ((eq onoff 'on)
13955 (setq res t)
13956 (or (member tag current) (push tag current)))
13957 ((eq onoff 'off)
13958 (or (not (member tag current)) (setq current (delete tag current))))
13959 (t (if (member tag current)
13960 (setq current (delete tag current))
13961 (setq res t)
13962 (push tag current))))
13963 (end-of-line 1)
13964 (if current
13965 (progn
13966 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13967 (org-set-tags nil t))
13968 (delete-horizontal-space))
13969 (run-hooks 'org-after-tags-change-hook))
13970 res))
13972 (defun org-align-tags-here (to-col)
13973 ;; Assumes that this is a headline
13974 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13975 (beginning-of-line 1)
13977 (< pos (match-beginning 2)))
13978 (progn
13979 (setq tags-l (- (match-end 2) (match-beginning 2)))
13980 (goto-char (match-beginning 1))
13981 (insert " ")
13982 (delete-region (point) (1+ (match-beginning 2)))
13983 (setq ncol (max (current-column)
13984 (1+ col)
13985 (if (> to-col 0)
13986 to-col
13987 (- (abs to-col) tags-l))))
13988 (setq p (point))
13989 (insert (make-string (- ncol (current-column)) ?\ ))
13990 (setq ncol (current-column))
13991 (when indent-tabs-mode (tabify p (point-at-eol)))
13992 (org-move-to-column (min ncol col) t))
13993 (goto-char pos))))
13995 (defun org-set-tags-command (&optional arg just-align)
13996 "Call the set-tags command for the current entry."
13997 (interactive "P")
13998 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13999 (org-set-tags arg just-align)
14000 (save-excursion
14001 (unless (and (org-region-active-p)
14002 org-loop-over-headlines-in-active-region)
14003 (org-back-to-heading t))
14004 (org-set-tags arg just-align))))
14006 (defun org-set-tags-to (data)
14007 "Set the tags of the current entry to DATA, replacing the current tags.
14008 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14009 If DATA is nil or the empty string, any tags will be removed."
14010 (interactive "sTags: ")
14011 (setq data
14012 (cond
14013 ((eq data nil) "")
14014 ((equal data "") "")
14015 ((stringp data)
14016 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14017 ":"))
14018 ((listp data)
14019 (concat ":" (mapconcat 'identity data ":") ":"))))
14020 (when data
14021 (save-excursion
14022 (org-back-to-heading t)
14023 (when (looking-at org-complex-heading-regexp)
14024 (if (match-end 5)
14025 (progn
14026 (goto-char (match-beginning 5))
14027 (insert data)
14028 (delete-region (point) (point-at-eol))
14029 (org-set-tags nil 'align))
14030 (goto-char (point-at-eol))
14031 (insert " " data)
14032 (org-set-tags nil 'align)))
14033 (beginning-of-line 1)
14035 (delete-region (match-beginning 1) (match-end 1))))))
14037 (defun org-align-all-tags ()
14038 "Align the tags i all headings."
14039 (interactive)
14040 (save-excursion
14041 (or (ignore-errors (org-back-to-heading t))
14042 (outline-next-heading))
14043 (if (org-at-heading-p)
14044 (org-set-tags t)
14045 (message "No headings"))))
14047 (defvar org-indent-indentation-per-level)
14048 (defun org-set-tags (&optional arg just-align)
14049 "Set the tags for the current headline.
14050 With prefix ARG, realign all tags in headings in the current buffer."
14051 (interactive "P")
14052 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14053 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14054 'region-start-level 'region))
14055 org-loop-over-headlines-in-active-region)
14056 (org-map-entries
14057 ;; We don't use ARG and JUST-ALIGN here these args are not
14058 ;; useful when looping over headlines
14059 `(org-set-tags)
14060 org-loop-over-headlines-in-active-region
14061 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14062 (let* ((re org-outline-regexp-bol)
14063 (current (unless arg (org-get-tags-string)))
14064 (col (current-column))
14065 (org-setting-tags t)
14066 table current-tags inherited-tags ; computed below when needed
14067 tags p0 c0 c1 rpl di tc level)
14068 (if arg
14069 (save-excursion
14070 (goto-char (point-min))
14071 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14072 (while (re-search-forward re nil t)
14073 (org-set-tags nil t)
14074 (end-of-line 1)))
14075 (message "All tags realigned to column %d" org-tags-column))
14076 (if just-align
14077 (setq tags current)
14078 ;; Get a new set of tags from the user
14079 (save-excursion
14080 (setq table (append org-tag-persistent-alist
14081 (or org-tag-alist (org-get-buffer-tags))
14082 (and
14083 org-complete-tags-always-offer-all-agenda-tags
14084 (org-global-tags-completion-table
14085 (org-agenda-files))))
14086 org-last-tags-completion-table table
14087 current-tags (org-split-string current ":")
14088 inherited-tags (nreverse
14089 (nthcdr (length current-tags)
14090 (nreverse (org-get-tags-at))))
14091 tags
14092 (if (or (eq t org-use-fast-tag-selection)
14093 (and org-use-fast-tag-selection
14094 (delq nil (mapcar 'cdr table))))
14095 (org-fast-tag-selection
14096 current-tags inherited-tags table
14097 (if org-fast-tag-selection-include-todo
14098 org-todo-key-alist))
14099 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14100 (org-trim
14101 (org-icompleting-read "Tags: "
14102 'org-tags-completion-function
14103 nil nil current 'org-tags-history))))))
14104 (while (string-match "[-+&]+" tags)
14105 ;; No boolean logic, just a list
14106 (setq tags (replace-match ":" t t tags))))
14108 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14110 (if org-tags-sort-function
14111 (setq tags (mapconcat 'identity
14112 (sort (org-split-string
14113 tags (org-re "[^[:alnum:]_@#%]+"))
14114 org-tags-sort-function) ":")))
14117 (setq tags "")
14118 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14119 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14121 ;; Insert new tags at the correct column
14122 (beginning-of-line 1)
14123 (setq level (or (and (looking-at org-outline-regexp)
14124 (- (match-end 0) (point) 1))
14125 1))
14126 (cond
14127 ((and (equal current "") (equal tags "")))
14128 ((re-search-forward
14130 (point-at-eol) t)
14131 (if (equal tags "")
14132 (setq rpl "")
14133 (goto-char (match-beginning 0))
14134 (setq c0 (current-column)
14135 ;; compute offset for the case of org-indent-mode active
14136 di (if org-indent-mode
14137 (* (1- org-indent-indentation-per-level) (1- level))
14138 0)
14139 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14140 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14141 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14142 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14143 (replace-match rpl t t)
14144 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14145 tags)
14146 (t (error "Tags alignment failed")))
14147 (org-move-to-column col)
14148 (unless just-align
14149 (run-hooks 'org-after-tags-change-hook))))))
14151 (defun org-change-tag-in-region (beg end tag off)
14152 "Add or remove TAG for each entry in the region.
14153 This works in the agenda, and also in an org-mode buffer."
14154 (interactive
14155 (list (region-beginning) (region-end)
14156 (let ((org-last-tags-completion-table
14157 (if (derived-mode-p 'org-mode)
14158 (org-get-buffer-tags)
14159 (org-global-tags-completion-table))))
14160 (org-icompleting-read
14161 "Tag: " 'org-tags-completion-function nil nil nil
14162 'org-tags-history))
14163 (progn
14165 (equal (read-char-exclusive) ?r))))
14166 (if (fboundp 'deactivate-mark) (deactivate-mark))
14167 (let ((agendap (equal major-mode 'org-agenda-mode))
14168 l1 l2 m buf pos newhead (cnt 0))
14169 (goto-char end)
14170 (setq l2 (1- (org-current-line)))
14171 (goto-char beg)
14172 (setq l1 (org-current-line))
14173 (loop for l from l1 to l2 do
14174 (org-goto-line l)
14175 (setq m (get-text-property (point) 'org-hd-marker))
14176 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14177 (and agendap m))
14178 (setq buf (if agendap (marker-buffer m) (current-buffer))
14179 pos (if agendap m (point)))
14180 (with-current-buffer buf
14181 (save-excursion
14182 (save-restriction
14183 (goto-char pos)
14184 (setq cnt (1+ cnt))
14185 (org-toggle-tag tag (if off 'off 'on))
14186 (setq newhead (org-get-heading)))))
14187 (and agendap (org-agenda-change-all-lines newhead m))))
14188 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14190 (defun org-tags-completion-function (string predicate &optional flag)
14191 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14192 (confirm (lambda (x) (stringp (car x)))))
14194 (setq s1 (match-string 1 string)
14195 s2 (match-string 2 string))
14196 (setq s1 "" s2 string))
14197 (cond
14198 ((eq flag nil)
14199 ;; try completion
14200 (setq rtn (try-completion s2 ctable confirm))
14201 (if (stringp rtn)
14202 (setq rtn
14203 (concat s1 s2 (substring rtn (length s2))
14204 (if (and org-add-colon-after-tag-completion
14205 (assoc rtn ctable))
14206 ":" ""))))
14207 rtn)
14208 ((eq flag t)
14209 ;; all-completions
14210 (all-completions s2 ctable confirm)
14211 )
14212 ((eq flag 'lambda)
14213 ;; exact match?
14214 (assoc s2 ctable)))
14215 ))
14217 (defun org-fast-tag-insert (kwd tags face &optional end)
14218 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
14219 (insert (format "%-12s" (concat kwd ":"))
14220 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14221 (or end "")))
14223 (defun org-fast-tag-show-exit (flag)
14224 (save-excursion
14225 (org-goto-line 3)
14227 (replace-match ""))
14228 (when flag
14229 (end-of-line 1)
14230 (org-move-to-column (- (window-width) 19) t)
14231 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14233 (defun org-set-current-tags-overlay (current prefix)
14234 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14235 (if (featurep 'xemacs)
14236 (org-overlay-display org-tags-overlay (concat prefix s)
14237 'secondary-selection)
14238 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14239 (org-overlay-display org-tags-overlay (concat prefix s)))))
14241 (defvar org-last-tag-selection-key nil)
14242 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14243 "Fast tag selection with single keys.
14244 CURRENT is the current list of tags in the headline, INHERITED is the
14245 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14246 possibly with grouping information. TODO-TABLE is a similar table with
14247 TODO keywords, should these have keys assigned to them.
14248 If the keys are nil, a-z are automatically assigned.
14249 Returns the new tags string, or nil to not change the current settings."
14250 (let* ((fulltable (append table todo-table))
14251 (maxlen (apply 'max (mapcar
14252 (lambda (x)
14253 (if (stringp (car x)) (string-width (car x)) 0))
14254 fulltable)))
14255 (buf (current-buffer))
14256 (expert (eq org-fast-tag-selection-single-key 'expert))
14257 (buffer-tags nil)
14258 (fwidth (+ maxlen 3 1 3))
14259 (ncol (/ (- (window-width) 4) fwidth))
14260 (i-face 'org-done)
14261 (c-face 'org-todo)
14262 tg cnt e c char c1 c2 ntable tbl rtn
14263 ov-start ov-end ov-prefix
14264 (exit-after-next org-fast-tag-selection-single-key)
14265 (done-keywords org-done-keywords)
14266 groups ingroup)
14267 (save-excursion
14268 (beginning-of-line 1)
14269 (if (looking-at
14271 (setq ov-start (match-beginning 1)
14272 ov-end (match-end 1)
14273 ov-prefix "")
14274 (setq ov-start (1- (point-at-eol))
14275 ov-end (1+ ov-start))
14277 (setq ov-prefix
14278 (concat
14279 (buffer-substring (1- (point)) (point))
14280 (if (> (current-column) org-tags-column)
14281 " "
14282 (make-string (- org-tags-column (current-column)) ?\ ))))))
14283 (move-overlay org-tags-overlay ov-start ov-end)
14284 (save-window-excursion
14285 (if expert
14286 (set-buffer (get-buffer-create " *Org tags*"))
14287 (delete-other-windows)
14288 (split-window-vertically)
14289 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14290 (erase-buffer)
14291 (org-set-local 'org-done-keywords done-keywords)
14294 (org-fast-tag-show-exit exit-after-next)
14295 (org-set-current-tags-overlay current ov-prefix)
14296 (setq tbl fulltable char ?a cnt 0)
14297 (while (setq e (pop tbl))
14298 (cond
14299 ((equal (car e) :startgroup)
14300 (push '() groups) (setq ingroup t)
14301 (when (not (= cnt 0))
14302 (setq cnt 0)
14304 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14305 ((equal (car e) :endgroup)
14306 (setq ingroup nil cnt 0)
14308 ((equal e '(:newline))
14309 (when (not (= cnt 0))
14310 (setq cnt 0)
14312 (setq e (car tbl))
14313 (while (equal (car tbl) '(:newline))
14315 (setq tbl (cdr tbl)))))
14316 (t
14317 (setq tg (copy-sequence (car e)) c2 nil)
14318 (if (cdr e)
14319 (setq c (cdr e))
14320 ;; automatically assign a character.
14321 (setq c1 (string-to-char
14322 (downcase (substring
14323 tg (if (= (string-to-char tg) ?@) 1 0)))))
14324 (if (or (rassoc c1 ntable) (rassoc c1 table))
14325 (while (or (rassoc char ntable) (rassoc char table))
14326 (setq char (1+ char)))
14327 (setq c2 c1))
14328 (setq c (or c2 char)))
14329 (if ingroup (push tg (car groups)))
14330 (setq tg (org-add-props tg nil 'face
14331 (cond
14332 ((not (assoc tg table))
14333 (org-get-todo-face tg))
14334 ((member tg current) c-face)
14335 ((member tg inherited) i-face))))
14336 (if (and (= cnt 0) (not ingroup)) (insert " "))
14337 (insert "[" c "] " tg (make-string
14338 (- fwidth 4 (length tg)) ?\ ))
14339 (push (cons tg c) ntable)
14340 (when (= (setq cnt (1+ cnt)) ncol)
14342 (if ingroup (insert " "))
14343 (setq cnt 0)))))
14344 (setq ntable (nreverse ntable))
14346 (goto-char (point-min))
14347 (if (not expert) (org-fit-window-to-buffer))
14348 (setq rtn
14349 (catch 'exit
14350 (while t
14351 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14352 (if (not groups) "no " "")
14353 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14354 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14355 (setq org-last-tag-selection-key c)
14356 (cond
14358 ((= c ?!)
14359 (setq groups (not groups))
14360 (goto-char (point-min))
14361 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14362 ((= c ?\C-c)
14363 (if (not expert)
14364 (org-fast-tag-show-exit
14365 (setq exit-after-next (not exit-after-next)))
14366 (setq expert nil)
14367 (delete-other-windows)
14368 (set-window-buffer (split-window-vertically) " *Org tags*")
14369 (org-switch-to-buffer-other-window " *Org tags*")
14370 (org-fit-window-to-buffer)))
14371 ((or (= c ?\C-g)
14372 (and (= c ?q) (not (rassoc c ntable))))
14373 (org-detach-overlay org-tags-overlay)
14374 (setq quit-flag t))
14375 ((= c ?\ )
14376 (setq current nil)
14377 (if exit-after-next (setq exit-after-next 'now)))
14379 (condition-case nil
14380 (setq tg (org-icompleting-read
14381 "Tag: "
14382 (or buffer-tags
14383 (with-current-buffer buf
14384 (org-get-buffer-tags)))))
14385 (quit (setq tg "")))
14387 (add-to-list 'buffer-tags (list tg))
14388 (if (member tg current)
14389 (setq current (delete tg current))
14390 (push tg current)))
14391 (if exit-after-next (setq exit-after-next 'now)))
14392 ((setq e (rassoc c todo-table) tg (car e))
14393 (with-current-buffer buf
14394 (save-excursion (org-todo tg)))
14395 (if exit-after-next (setq exit-after-next 'now)))
14396 ((setq e (rassoc c ntable) tg (car e))
14397 (if (member tg current)
14398 (setq current (delete tg current))
14399 (loop for g in groups do
14400 (if (member tg g)
14401 (mapc (lambda (x)
14402 (setq current (delete x current)))
14403 g)))
14404 (push tg current))
14405 (if exit-after-next (setq exit-after-next 'now))))
14407 ;; Create a sorted list
14408 (setq current
14409 (sort current
14410 (lambda (a b)
14411 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14412 (if (eq exit-after-next 'now) (throw 'exit t))
14413 (goto-char (point-min))
14414 (beginning-of-line 2)
14415 (delete-region (point) (point-at-eol))
14416 (org-fast-tag-insert "Current" current c-face)
14417 (org-set-current-tags-overlay current ov-prefix)
14418 (while (re-search-forward
14420 (setq tg (match-string 1))
14421 (add-text-properties
14422 (match-beginning 1) (match-end 1)
14423 (list 'face
14424 (cond
14425 ((member tg current) c-face)
14426 ((member tg inherited) i-face)
14427 (t (get-text-property (match-beginning 1) 'face))))))
14428 (goto-char (point-min)))))
14429 (org-detach-overlay org-tags-overlay)
14430 (if rtn
14431 (mapconcat 'identity current ":")
14432 nil))))
14434 (defun org-get-tags-string ()
14435 "Get the TAGS string in the current headline."
14436 (unless (org-at-heading-p t)
14437 (error "Not on a heading"))
14438 (save-excursion
14439 (beginning-of-line 1)
14441 (org-match-string-no-properties 1)
14442 "")))
14444 (defun org-get-tags ()
14445 "Get the list of tags specified in the current headline."
14446 (org-split-string (org-get-tags-string) ":"))
14448 (defun org-get-buffer-tags ()
14449 "Get a table of all tags used in the buffer, for completion."
14450 (let (tags)
14451 (save-excursion
14452 (goto-char (point-min))
14453 (while (re-search-forward
14455 (when (equal (char-after (point-at-bol 0)) ?*)
14456 (mapc (lambda (x) (add-to-list 'tags x))
14457 (org-split-string (org-match-string-no-properties 1) ":")))))
14458 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14459 (mapcar 'list tags)))
14461 ;;;; The mapping API
14463 (defun org-map-entries (func &optional match scope &rest skip)
14464 "Call FUNC at each headline selected by MATCH in SCOPE.
14466 FUNC is a function or a lisp form. The function will be called without
14467 arguments, with the cursor positioned at the beginning of the headline.
14468 The return values of all calls to the function will be collected and
14469 returned as a list.
14471 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14472 does not need to preserve point. After evaluation, the cursor will be
14473 moved to the end of the line (presumably of the headline of the
14474 processed entry) and search continues from there. Under some
14475 circumstances, this may not produce the wanted results. For example,
14476 if you have removed (e.g. archived) the current (sub)tree it could
14477 mean that the next entry will be skipped entirely. In such cases, you
14478 can specify the position from where search should continue by making
14479 FUNC set the variable `org-map-continue-from' to the desired buffer
14480 position.
14482 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14483 Only headlines that are matched by this query will be considered during
14484 the iteration. When MATCH is nil or t, all headlines will be
14485 visited by the iteration.
14487 SCOPE determines the scope of this command. It can be any of:
14489 nil The current buffer, respecting the restriction if any
14490 tree The subtree started with the entry at point
14491 region The entries within the active region, if any
14492 region-start-level
14493 The entries within the active region, but only those at
14494 the same level than the first one.
14495 file The current buffer, without restriction
14496 file-with-archives
14497 The current buffer, and any archives associated with it
14498 agenda All agenda files
14499 agenda-with-archives
14500 All agenda files with any archive files associated with them
14501 \(file1 file2 ...)
14502 If this is a list, all files in the list will be scanned
14504 The remaining args are treated as settings for the skipping facilities of
14505 the scanner. The following items can be given here:
14507 archive skip trees with the archive tag.
14508 comment skip trees with the COMMENT keyword
14509 function or Emacs Lisp form:
14510 will be used as value for `org-agenda-skip-function', so whenever
14511 the function returns t, FUNC will not be called for that
14512 entry and search will continue from the point where the
14513 function leaves it.
14515 If your function needs to retrieve the tags including inherited tags
14516 at the *current* entry, you can use the value of the variable
14517 `org-scanner-tags' which will be much faster than getting the value
14518 with `org-get-tags-at'. If your function gets properties with
14519 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14520 to t around the call to `org-entry-properties' to get the same speedup.
14521 Note that if your function moves around to retrieve tags and properties at
14522 a *different* entry, you cannot use these techniques."
14523 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14524 (not (org-region-active-p)))
14525 (let* ((org-agenda-archives-mode nil) ; just to make sure
14526 (org-agenda-skip-archived-trees (memq 'archive skip))
14527 (org-agenda-skip-comment-trees (memq 'comment skip))
14528 (org-agenda-skip-function
14529 (car (org-delete-all '(comment archive) skip)))
14530 (org-tags-match-list-sublevels t)
14531 (start-level (eq scope 'region-start-level))
14532 matcher file res
14533 org-todo-keywords-for-agenda
14534 org-done-keywords-for-agenda
14535 org-todo-keyword-alist-for-agenda
14536 org-drawers-for-agenda
14537 org-tag-alist-for-agenda
14538 todo-only)
14540 (cond
14541 ((eq match t) (setq matcher t))
14542 ((eq match nil) (setq matcher t))
14543 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14545 (save-excursion
14546 (save-restriction
14547 (cond ((eq scope 'tree)
14548 (org-back-to-heading t)
14549 (org-narrow-to-subtree)
14550 (setq scope nil))
14551 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14552 (org-region-active-p))
14553 ;; If needed, set start-level to a string like "2"
14554 (when start-level
14555 (save-excursion
14556 (goto-char (region-beginning))
14557 (unless (org-at-heading-p) (outline-next-heading))
14558 (setq start-level (org-current-level))))
14559 (narrow-to-region (region-beginning)
14560 (save-excursion
14561 (goto-char (region-end))
14562 (unless (and (bolp) (org-at-heading-p))
14563 (outline-next-heading))
14564 (point)))
14565 (setq scope nil)))
14567 (if (not scope)
14568 (progn
14569 (org-agenda-prepare-buffers
14570 (list (buffer-file-name (current-buffer))))
14571 (setq res (org-scan-tags func matcher todo-only start-level)))
14572 ;; Get the right scope
14573 (cond
14574 ((and scope (listp scope) (symbolp (car scope)))
14575 (setq scope (eval scope)))
14576 ((eq scope 'agenda)
14577 (setq scope (org-agenda-files t)))
14578 ((eq scope 'agenda-with-archives)
14579 (setq scope (org-agenda-files t))
14580 (setq scope (org-add-archive-files scope)))
14581 ((eq scope 'file)
14582 (setq scope (list (buffer-file-name))))
14583 ((eq scope 'file-with-archives)
14584 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14585 (org-agenda-prepare-buffers scope)
14586 (while (setq file (pop scope))
14587 (with-current-buffer (org-find-base-buffer-visiting file)
14588 (save-excursion
14589 (save-restriction
14590 (widen)
14591 (goto-char (point-min))
14592 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14593 res)))
14595 ;;;; Properties
14597 ;;; Setting and retrieving properties
14599 (defconst org-special-properties
14600 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14601 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14602 "The special properties valid in Org-mode.
14604 These are properties that are not defined in the property drawer,
14605 but in some other way.")
14607 (defconst org-default-properties
14608 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14609 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14610 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14611 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14612 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14613 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14614 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14615 "Some properties that are used by Org-mode for various purposes.
14616 Being in this list makes sure that they are offered for completion.")
14619 "Regular expression matching the first line of a property drawer.")
14622 "Regular expression matching the last line of a property drawer.")
14625 "Regular expression matching the first line of a property drawer.")
14628 "Regular expression matching the first line of a property drawer.")
14630 (defconst org-property-drawer-re
14633 "Matches an entire property drawer.")
14635 (defconst org-clock-drawer-re
14638 "Matches an entire clock drawer.")
14640 (defsubst org-re-property (property)
14641 "Return a regexp matching a PROPERTY line.
14642 Match group 1 will be set to the value."
14645 (defsubst org-re-property-keyword (property)
14646 "Return a regexp matching a PROPERTY line, possibly with no
14647 value for the property."
14650 (defun org-property-action ()
14651 "Do an action on properties."
14652 (interactive)
14653 (let (c)
14654 (org-at-property-p)
14655 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14656 (setq c (read-char-exclusive))
14657 (cond
14658 ((equal c ?s)
14659 (call-interactively 'org-set-property))
14660 ((equal c ?d)
14661 (call-interactively 'org-delete-property))
14662 ((equal c ?D)
14663 (call-interactively 'org-delete-property-globally))
14664 ((equal c ?c)
14665 (call-interactively 'org-compute-property-at-point))
14666 (t (error "No such property action %c" c)))))
14668 (defun org-inc-effort ()
14669 "Increment the value of the effort property in the current entry."
14670 (interactive)
14671 (org-set-effort nil t))
14673 (defvar org-clock-effort) ;; Defined in org-clock.el
14674 (defvar org-clock-current-task) ;; Defined in org-clock.el
14675 (defun org-set-effort (&optional value increment)
14676 "Set the effort property of the current entry.
14677 With numerical prefix arg, use the nth allowed value, 0 stands for the
14678 10th allowed value.
14680 When INCREMENT is non-nil, set the property to the next allowed value."
14681 (interactive "P")
14682 (if (equal value 0) (setq value 10))
14683 (let* ((completion-ignore-case t)
14684 (prop org-effort-property)
14685 (cur (org-entry-get nil prop))
14686 (allowed (org-property-get-allowed-values nil prop 'table))
14687 (existing (mapcar 'list (org-property-values prop)))
14688 (heading (nth 4 (org-heading-components)))
14689 rpl
14690 (val (cond
14691 ((stringp value) value)
14692 ((and allowed (integerp value))
14693 (or (car (nth (1- value) allowed))
14694 (car (org-last allowed))))
14695 ((and allowed increment)
14696 (or (caadr (member (list cur) allowed))
14697 (error "Allowed effort values are not set")))
14698 (allowed
14699 (message "Select 1-9,0, [RET%s]: %s"
14700 (if cur (concat "=" cur) "")
14701 (mapconcat 'car allowed " "))
14702 (setq rpl (read-char-exclusive))
14704 cur
14705 (setq rpl (- rpl ?0))
14706 (if (equal rpl 0) (setq rpl 10))
14707 (if (and (> rpl 0) (<= rpl (length allowed)))
14708 (car (nth (1- rpl) allowed))
14709 (org-completing-read "Effort: " allowed nil))))
14710 (t
14711 (let (org-completion-use-ido org-completion-use-iswitchb)
14712 (org-completing-read
14714 (concat "[" cur "]") "")
14715 ": ")
14716 existing nil nil "" nil cur))))))
14717 (unless (equal (org-entry-get nil prop) val)
14718 (org-entry-put nil prop val))
14719 (save-excursion
14720 (org-back-to-heading t)
14721 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
14722 (when (string= heading org-clock-current-task)
14723 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
14724 (org-clock-update-mode-line))
14725 (message "%s is now %s" prop val)))
14727 (defun org-at-property-p ()
14728 "Is cursor inside a property drawer?"
14729 (save-excursion
14730 (beginning-of-line 1)
14732 (save-match-data ;; Used by calling procedures
14733 (let ((p (point))
14734 (range (unless (org-before-first-heading-p)
14735 (org-get-property-block))))
14736 (and range (<= (car range) p) (< p (cdr range))))))))
14738 (defun org-get-property-block (&optional beg end force)
14739 "Return the (beg . end) range of the body of the property drawer.
14740 BEG and END are the beginning and end of the current subtree, or of
14741 the part before the first headline. If they are not given, they will
14742 be found. If the drawer does not exist and FORCE is non-nil, create
14743 the drawer."
14744 (catch 'exit
14745 (save-excursion
14746 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14747 (progn (org-back-to-heading t) (point))))
14748 (end (or end (and (not (outline-next-heading)) (point-max))
14749 (point))))
14750 (goto-char beg)
14751 (if (re-search-forward org-property-start-re end t)
14752 (setq beg (1+ (match-end 0)))
14753 (if force
14754 (save-excursion
14755 (org-insert-property-drawer)
14756 (setq end (progn (outline-next-heading) (point))))
14757 (throw 'exit nil))
14758 (goto-char beg)
14759 (if (re-search-forward org-property-start-re end t)
14760 (setq beg (1+ (match-end 0)))))
14761 (if (re-search-forward org-property-end-re end t)
14762 (setq end (match-beginning 0))
14763 (or force (throw 'exit nil))
14764 (goto-char beg)
14765 (setq end beg)
14766 (org-indent-line)
14768 (cons beg end)))))
14770 (defun org-entry-properties (&optional pom which specific)
14771 "Get all properties of the entry at point-or-marker POM.
14772 This includes the TODO keyword, the tags, time strings for deadline,
14773 scheduled, and clocking, and any additional properties defined in the
14774 entry. The return value is an alist, keys may occur multiple times
14775 if the property key was used several times.
14776 POM may also be nil, in which case the current entry is used.
14777 If WHICH is nil or `all', get all properties. If WHICH is
14778 `special' or `standard', only get that subclass. If WHICH
14779 is a string only get exactly this property. SPECIFIC can be a string, the
14780 specific property we are interested in. Specifying it can speed
14781 things up because then unnecessary parsing is avoided."
14782 (setq which (or which 'all))
14783 (org-with-point-at pom
14784 (let ((clockstr (substring org-clock-string 0 -1))
14785 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14786 (case-fold-search nil)
14787 beg end range props sum-props key key1 value string clocksum clocksumt)
14788 (save-excursion
14789 (when (condition-case nil
14790 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14791 (error nil))
14792 (setq beg (point))
14793 (setq sum-props (get-text-property (point) 'org-summaries))
14794 (setq clocksum (get-text-property (point) :org-clock-minutes)
14795 clocksumt (get-text-property (point) :org-clock-minutes-today))
14796 (outline-next-heading)
14797 (setq end (point))
14798 (when (memq which '(all special))
14799 ;; Get the special properties, like TODO and tags
14800 (goto-char beg)
14801 (when (and (or (not specific) (string= specific "TODO"))
14802 (looking-at org-todo-line-regexp) (match-end 2))
14803 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14804 (when (and (or (not specific) (string= specific "PRIORITY"))
14805 (looking-at org-priority-regexp))
14806 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14807 (when (or (not specific) (string= specific "FILE"))
14808 (push (cons "FILE" buffer-file-name) props))
14809 (when (and (or (not specific) (string= specific "TAGS"))
14810 (setq value (org-get-tags-string))
14812 (push (cons "TAGS" value) props))
14813 (when (and (or (not specific) (string= specific "ALLTAGS"))
14814 (setq value (org-get-tags-at)))
14815 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14816 ":"))
14817 props))
14818 (when (or (not specific) (string= specific "BLOCKED"))
14819 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14820 (when (or (not specific)
14821 (member specific
14822 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14823 "TIMESTAMP" "TIMESTAMP_IA")))
14824 (catch 'match
14825 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14826 (setq key (if (match-end 1)
14827 (substring (org-match-string-no-properties 1)
14828 0 -1))
14829 string (if (equal key clockstr)
14830 (org-trim
14831 (buffer-substring-no-properties
14832 (match-beginning 3) (goto-char
14833 (point-at-eol))))
14834 (substring (org-match-string-no-properties 3)
14835 1 -1)))
14836 ;; Get the correct property name from the key. This is
14837 ;; necessary if the user has configured time keywords.
14838 (setq key1 (concat key ":"))
14839 (cond
14840 ((not key)
14841 (setq key
14842 (if (= (char-after (match-beginning 3)) ?\[)
14843 "TIMESTAMP_IA" "TIMESTAMP")))
14844 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14845 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14846 ((equal key1 org-closed-string) (setq key "CLOSED"))
14847 ((equal key1 org-clock-string) (setq key "CLOCK")))
14848 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14849 (progn
14850 (push (cons key string) props)
14851 ;; no need to search further if match is found
14852 (throw 'match t))
14853 (when (or (equal key "CLOCK") (not (assoc key props)))
14854 (push (cons key string) props)))))))
14856 (when (memq which '(all standard))
14857 ;; Get the standard properties, like :PROP: ...
14858 (setq range (org-get-property-block beg end))
14859 (when range
14860 (goto-char (car range))
14861 (while (re-search-forward
14863 (cdr range) t)
14864 (setq key (org-match-string-no-properties 1)
14865 value (org-trim (or (org-match-string-no-properties 2) "")))
14866 (unless (member key excluded)
14867 (push (cons key (or value "")) props)))))
14868 (if clocksum
14869 (push (cons "CLOCKSUM"
14870 (org-columns-number-to-string (/ (float clocksum) 60.)
14871 'add_times))
14872 props))
14873 (if clocksumt
14874 (push (cons "CLOCKSUM_T"
14875 (org-columns-number-to-string (/ (float clocksumt) 60.)
14876 'add_times))
14877 props))
14878 (unless (assoc "CATEGORY" props)
14879 (push (cons "CATEGORY" (org-get-category)) props))
14880 (append sum-props (nreverse props)))))))
14882 (defun org-entry-get (pom property &optional inherit literal-nil)
14883 "Get value of PROPERTY for entry or content at point-or-marker POM.
14884 If INHERIT is non-nil and the entry does not have the property,
14885 then also check higher levels of the hierarchy.
14886 If INHERIT is the symbol `selective', use inheritance only if the setting
14887 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14888 If the property is present but empty, the return value is the empty string.
14889 If the property is not present at all, nil is returned.
14892 do not interpret it as the list atom nil. This is used for inheritance
14894 (org-with-point-at pom
14895 (if (and inherit (if (eq inherit 'selective)
14896 (org-property-inherit-p property)
14897 t))
14898 (org-entry-get-with-inheritance property literal-nil)
14899 (if (member property org-special-properties)
14900 ;; We need a special property. Use `org-entry-properties' to
14901 ;; retrieve it, but specify the wanted property
14902 (cdr (assoc property (org-entry-properties nil 'special property)))
14903 (let ((range (org-get-property-block)))
14904 (when (and range (not (eq (car range) (cdr range))))
14905 (let* ((props (list (or (assoc property org-file-properties)
14906 (assoc property org-global-properties)
14907 (assoc property org-global-properties-fixed))))
14908 (ap (lambda (key)
14909 (when (re-search-forward
14910 (org-re-property key) (cdr range) t)
14911 (setq props
14912 (org-update-property-plist
14913 key
14914 (if (match-end 1)
14915 (org-match-string-no-properties 1) "")
14916 props)))))
14917 val)
14918 (goto-char (car range))
14919 (funcall ap property)
14920 (goto-char (car range))
14921 (while (funcall ap (concat property "+")))
14922 (setq val (cdr (assoc property props)))
14923 (when val (if literal-nil val (org-not-nil val))))))))))
14925 (defun org-property-or-variable-value (var &optional inherit)
14926 "Check if there is a property fixing the value of VAR.
14927 If yes, return this value. If not, return the current value of the variable."
14928 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14930 (read prop)
14931 (symbol-value var))))
14933 (defun org-entry-delete (pom property &optional delete-empty-drawer)
14934 "Delete the property PROPERTY from entry at point-or-marker POM.
14935 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
14936 an empty drawer to delete."
14937 (org-with-point-at pom
14938 (if (member property org-special-properties)
14939 nil ; cannot delete these properties.
14940 (let ((range (org-get-property-block)))
14941 (if (and range
14942 (goto-char (car range))
14943 (re-search-forward
14944 (org-re-property property)
14945 (cdr range) t))
14946 (progn
14947 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14948 (and delete-empty-drawer
14949 (org-remove-empty-drawer-at
14950 delete-empty-drawer (car range)))
14951 t)
14952 nil)))))
14954 ;; Multi-values properties are properties that contain multiple values
14955 ;; These values are assumed to be single words, separated by whitespace.
14956 (defun org-entry-add-to-multivalued-property (pom property value)
14957 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14958 (let* ((old (org-entry-get pom property))
14960 (setq value (org-entry-protect-space value))
14961 (unless (member value values)
14962 (setq values (cons value values))
14963 (org-entry-put pom property
14964 (mapconcat 'identity values " ")))))
14966 (defun org-entry-remove-from-multivalued-property (pom property value)
14967 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14968 (let* ((old (org-entry-get pom property))
14970 (setq value (org-entry-protect-space value))
14971 (when (member value values)
14972 (setq values (delete value values))
14973 (org-entry-put pom property
14974 (mapconcat 'identity values " ")))))
14976 (defun org-entry-member-in-multivalued-property (pom property value)
14977 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14978 (let* ((old (org-entry-get pom property))
14980 (setq value (org-entry-protect-space value))
14981 (member value values)))
14983 (defun org-entry-get-multivalued-property (pom property)
14984 "Return a list of values in a multivalued property."
14985 (let* ((value (org-entry-get pom property))
14987 (mapcar 'org-entry-restore-space values)))
14989 (defun org-entry-put-multivalued-property (pom property &rest values)
14990 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14991 VALUES should be a list of strings. Spaces will be protected."
14992 (org-entry-put pom property
14993 (mapconcat 'org-entry-protect-space values " "))
14994 (let* ((value (org-entry-get pom property))
14996 (mapcar 'org-entry-restore-space values)))
14998 (defun org-entry-protect-space (s)
14999 "Protect spaces and newline in string S."
15000 (while (string-match " " s)
15001 (setq s (replace-match "%20" t t s)))
15003 (setq s (replace-match "%0A" t t s)))
15004 s)
15006 (defun org-entry-restore-space (s)
15007 "Restore spaces and newline in string S."
15008 (while (string-match "%20" s)
15009 (setq s (replace-match " " t t s)))
15010 (while (string-match "%0A" s)
15012 s)
15014 (defvar org-entry-property-inherited-from (make-marker)
15015 "Marker pointing to the entry from where a property was inherited.
15016 Each call to `org-entry-get-with-inheritance' will set this marker to the
15017 location of the entry where the inheritance search matched. If there was
15018 no match, the marker will point nowhere.
15019 Note that also `org-entry-get' calls this function, if the INHERIT flag
15020 is set.")
15022 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15023 "Get PROPERTY of entry or content at point, search higher levels if needed.
15024 The search will stop at the first ancestor which has the property defined.
15026 should be considered as undefined (this is the meaning of nil here).
15028 (move-marker org-entry-property-inherited-from nil)
15029 (let (tmp)
15030 (save-excursion
15031 (save-restriction
15032 (widen)
15033 (catch 'ex
15034 (while t
15035 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15036 (or (ignore-errors (org-back-to-heading t))
15037 (goto-char (point-min)))
15038 (move-marker org-entry-property-inherited-from (point))
15039 (throw 'ex tmp))
15040 (or (ignore-errors (org-up-heading-safe))
15041 (throw 'ex nil))))))
15042 (setq tmp (or tmp
15043 (cdr (assoc property org-file-properties))
15044 (cdr (assoc property org-global-properties))
15045 (cdr (assoc property org-global-properties-fixed))))
15046 (if literal-nil tmp (org-not-nil tmp))))
15048 (defvar org-property-changed-functions nil
15049 "Hook called when the value of a property has changed.
15050 Each hook function should accept two arguments, the name of the property
15051 and the new value.")
15053 (defun org-entry-put (pom property value)
15054 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15055 (org-with-point-at pom
15056 (org-back-to-heading t)
15057 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15058 range)
15059 (cond
15060 ((equal property "TODO")
15062 (not (member value org-todo-keywords-1)))
15064 (if (or (not value)
15066 (setq value 'none))
15067 (org-todo value)
15068 (org-set-tags nil 'align))
15069 ((equal property "PRIORITY")
15071 (string-to-char value) ?\ ))
15072 (org-set-tags nil 'align))
15073 ((equal property "CLOCKSUM")
15074 (if (not (re-search-forward
15076 (error "Cannot find a clock log")
15077 (goto-char (- (match-end 1) 2))
15078 (cond
15079 ((eq value 'earlier) (org-timestamp-down))
15080 ((eq value 'later) (org-timestamp-up)))
15081 (org-clock-sum-current-item)))
15082 ((equal property "SCHEDULED")
15083 (if (re-search-forward org-scheduled-time-regexp end t)
15084 (cond
15085 ((eq value 'earlier) (org-timestamp-change -1 'day))
15086 ((eq value 'later) (org-timestamp-change 1 'day))
15087 (t (call-interactively 'org-schedule)))
15088 (call-interactively 'org-schedule)))
15089 ((equal property "DEADLINE")
15090 (if (re-search-forward org-deadline-time-regexp end t)
15091 (cond
15092 ((eq value 'earlier) (org-timestamp-change -1 'day))
15093 ((eq value 'later) (org-timestamp-change 1 'day))
15094 (t (call-interactively 'org-deadline)))
15095 (call-interactively 'org-deadline)))
15096 ((member property org-special-properties)
15097 (error "The %s property can not yet be set with `org-entry-put'"
15098 property))
15099 (t ; a non-special property
15100 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15101 (setq range (org-get-property-block beg end 'force))
15102 (goto-char (car range))
15103 (if (re-search-forward
15104 (org-re-property-keyword property) (cdr range) t)
15105 (progn
15106 (delete-region (match-beginning 0) (match-end 0))
15107 (goto-char (match-beginning 0)))
15108 (goto-char (cdr range))
15110 (backward-char 1)
15111 (org-indent-line))
15112 (insert ":" property ":")
15113 (and value (insert " " value))
15114 (org-indent-line)))))
15115 (run-hook-with-args 'org-property-changed-functions property value)))
15117 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15118 "Get all property keys in the current buffer.
15119 With INCLUDE-SPECIALS, also list the special properties that reflect things
15120 like tags and TODO state.
15121 With INCLUDE-DEFAULTS, also include properties that has special meaning
15122 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15123 and others.
15124 With INCLUDE-COLUMNS, also include property names given in COLUMN
15125 formats in the current buffer."
15126 (let (rtn range cfmt s p)
15127 (save-excursion
15128 (save-restriction
15129 (widen)
15130 (goto-char (point-min))
15131 (while (re-search-forward org-property-start-re nil t)
15132 (setq range (org-get-property-block))
15133 (goto-char (car range))
15134 (while (re-search-forward
15136 (cdr range) t)
15137 (add-to-list 'rtn (org-match-string-no-properties 1)))
15138 (outline-next-heading))))
15140 (when include-specials
15141 (setq rtn (append org-special-properties rtn)))
15143 (when include-defaults
15144 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15145 (add-to-list 'rtn org-effort-property))
15147 (when include-columns
15148 (save-excursion
15149 (save-restriction
15150 (widen)
15151 (goto-char (point-min))
15152 (while (re-search-forward
15154 nil t)
15155 (setq cfmt (match-string 2) s 0)
15157 cfmt s)
15158 (setq s (match-end 0)
15159 p (match-string 1 cfmt))
15160 (unless (or (equal p "ITEM")
15161 (member p org-special-properties))
15162 (add-to-list 'rtn (match-string 1 cfmt))))))))
15164 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15166 (defun org-property-values (key)
15167 "Return a list of all values of property KEY in the current buffer."
15168 (save-excursion
15169 (save-restriction
15170 (widen)
15171 (goto-char (point-min))
15172 (let ((re (org-re-property key))
15173 values)
15174 (while (re-search-forward re nil t)
15175 (add-to-list 'values (org-trim (match-string 1))))
15176 (delete "" values)))))
15178 (defun org-insert-property-drawer ()
15179 "Insert a property drawer into the current entry."
15180 (org-back-to-heading t)
15181 (looking-at org-outline-regexp)
15182 (let ((indent (if org-adapt-indentation
15183 (- (match-end 0) (match-beginning 0))
15184 0))
15185 (beg (point))
15187 end hiddenp)
15188 (outline-next-heading)
15189 (setq end (point))
15190 (goto-char beg)
15191 (while (re-search-forward re end t))
15192 (setq hiddenp (outline-invisible-p))
15193 (end-of-line 1)
15196 (if (member (match-string 1) '("CLOCK:" ":END:"))
15197 ;; just skip this line
15198 (beginning-of-line 2)
15199 ;; Drawer start, find the end
15201 (beginning-of-line 1)))
15202 (org-skip-over-state-notes)
15204 (if (eq (char-before) ?*) (forward-char 1))
15206 (beginning-of-line 0)
15207 (org-indent-to-column indent)
15208 (beginning-of-line 2)
15209 (org-indent-to-column indent)
15210 (beginning-of-line 0)
15211 (if hiddenp
15212 (save-excursion
15213 (org-back-to-heading t)
15214 (hide-entry))
15215 (org-flag-drawer t))))
15217 (defun org-insert-drawer (&optional arg drawer)
15218 "Insert a drawer at point.
15220 Optional argument DRAWER, when non-nil, is a string representing
15221 drawer's name. Otherwise, the user is prompted for a name.
15223 If a region is active, insert the drawer around that region
15224 instead.
15226 Point is left between drawer's boundaries."
15227 (interactive "P")
15228 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15229 "LOGBOOK"))
15230 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15231 ;; internally by Org. They are meant to be inserted
15232 ;; automatically.
15233 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15234 ;; Remove system drawers from list. Note: For some reason,
15235 ;; `org-completing-read' ignores the predicate while
15236 ;; `completing-read' handles it fine.
15237 (drawer (if arg "PROPERTIES"
15238 (or drawer
15239 (completing-read
15240 "Drawer: " org-drawers
15241 (lambda (d) (not (member d system-drawers))))))))
15242 (cond
15243 ;; With C-u, fall back on `org-insert-property-drawer'
15244 (arg (org-insert-property-drawer))
15245 ;; With an active region, insert a drawer at point.
15246 ((not (org-region-active-p))
15247 (progn
15250 (forward-line -2)))
15251 ;; Otherwise, insert the drawer at point
15252 (t
15253 (let ((rbeg (region-beginning))
15254 (rend (copy-marker (region-end))))
15255 (unwind-protect
15256 (progn
15257 (goto-char rbeg)
15258 (beginning-of-line)
15259 (when (save-excursion
15260 (re-search-forward org-outline-regexp-bol rend t))
15261 (error "Drawers cannot contain headlines"))
15262 ;; Position point at the beginning of the first
15263 ;; non-blank line in region. Insert drawer's opening
15264 ;; there, then indent it.
15265 (org-skip-whitespace)
15266 (beginning-of-line)
15268 (forward-line -1)
15269 (indent-for-tab-command)
15270 ;; Move point to the beginning of the first blank line
15271 ;; after the last non-blank line in region. Insert
15272 ;; drawer's closing, then indent it.
15273 (goto-char rend)
15276 (deactivate-mark t)
15277 (indent-for-tab-command)
15279 ;; Clear marker, whatever the outcome of insertion is.
15280 (set-marker rend nil)))))))
15282 (defvar org-property-set-functions-alist nil
15283 "Property set function alist.
15284 Each entry should have the following format:
15286 (PROPERTY . READ-FUNCTION)
15288 The read function will be called with the same argument as
15289 `org-completing-read'.")
15291 (defun org-set-property-function (property)
15292 "Get the function that should be used to set PROPERTY.
15293 This is computed according to `org-property-set-functions-alist'."
15294 (or (cdr (assoc property org-property-set-functions-alist))
15295 'org-completing-read))
15297 (defun org-read-property-value (property)
15298 "Read PROPERTY value from user."
15299 (let* ((completion-ignore-case t)
15300 (allowed (org-property-get-allowed-values nil property 'table))
15301 (cur (org-entry-get nil property))
15302 (prompt (concat property " value"
15304 (concat " [" cur "]") "") ": "))
15305 (set-function (org-set-property-function property))
15306 (val (if allowed
15307 (funcall set-function prompt allowed nil
15308 (not (get-text-property 0 'org-unrestricted
15309 (caar allowed))))
15310 (let (org-completion-use-ido org-completion-use-iswitchb)
15311 (funcall set-function prompt
15312 (mapcar 'list (org-property-values property))
15313 nil nil "" nil cur)))))
15314 (if (equal val "")
15315 cur
15316 val)))
15318 (defvar org-last-set-property nil)
15319 (defvar org-last-set-property-value nil)
15320 (defun org-read-property-name ()
15321 "Read a property name."
15322 (let* ((completion-ignore-case t)
15323 (keys (org-buffer-property-keys nil t t))
15324 (default-prop (or (save-excursion
15325 (save-match-data
15326 (beginning-of-line)
15328 (null (string= (match-string 1) "END"))
15329 (match-string 1))))
15330 org-last-set-property))
15331 (property (org-icompleting-read
15332 (concat "Property"
15333 (if default-prop (concat " [" default-prop "]") "")
15334 ": ")
15335 (mapcar 'list keys)
15336 nil nil nil nil
15337 default-prop)))
15338 (if (member property keys)
15339 property
15340 (or (cdr (assoc (downcase property)
15341 (mapcar (lambda (x) (cons (downcase x) x))
15342 keys)))
15343 property))))
15345 (defun org-set-property-and-value (use-last)
15346 "Allow to set [PROPERTY]: [value] direction from prompt.
15347 When use-default, don't even ask, just use the last
15349 (interactive "P")
15350 (let* ((completion-ignore-case t)
15351 (pv (or (and use-last org-last-set-property-value)
15352 (org-completing-read
15354 nil nil nil nil nil
15355 org-last-set-property-value)))
15356 prop val)
15358 (setq prop (match-string 1 pv)
15359 val (match-string 2 pv))
15360 (org-set-property prop val))))
15362 (defun org-set-property (property value)
15363 "In the current entry, set PROPERTY to VALUE.
15364 When called interactively, this will prompt for a property name, offering
15365 completion on existing and default properties. And then it will prompt
15366 for a value, offering completion either on allowed values (via an inherited
15367 xxx_ALL property) or on existing values in other instances of this property
15368 in the current file."
15369 (interactive (list nil nil))
15370 (let* ((property (or property (org-read-property-name)))
15371 (value (or value (org-read-property-value property)))
15372 (fn (cdr (assoc property org-properties-postprocess-alist))))
15373 (setq org-last-set-property property)
15374 (setq org-last-set-property-value (concat property ": " value))
15375 ;; Possibly postprocess the inserted value:
15376 (when fn (setq value (funcall fn value)))
15377 (unless (equal (org-entry-get nil property) value)
15378 (org-entry-put nil property value))))
15380 (defun org-delete-property (property &optional delete-empty-drawer)
15381 "In the current entry, delete PROPERTY.
15382 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15383 an empty drawer to delete."
15384 (interactive
15385 (let* ((completion-ignore-case t)
15386 (prop (org-icompleting-read "Property: "
15387 (org-entry-properties nil 'standard))))
15388 (list prop)))
15389 (message "Property %s %s" property
15390 (if (org-entry-delete nil property delete-empty-drawer)
15391 "deleted"
15392 "was not present in the entry")))
15394 (defun org-delete-property-globally (property)
15395 "Remove PROPERTY globally, from all entries."
15396 (interactive
15397 (let* ((completion-ignore-case t)
15398 (prop (org-icompleting-read
15399 "Globally remove property: "
15400 (mapcar 'list (org-buffer-property-keys)))))
15401 (list prop)))
15402 (save-excursion
15403 (save-restriction
15404 (widen)
15405 (goto-char (point-min))
15406 (let ((cnt 0))
15407 (while (re-search-forward
15408 (org-re-property property)
15409 nil t)
15410 (setq cnt (1+ cnt))
15411 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15414 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15416 (defun org-compute-property-at-point ()
15417 "Compute the property at point.
15418 This looks for an enclosing column format, extracts the operator and
15419 then applies it to the property in the column format's scope."
15420 (interactive)
15421 (unless (org-at-property-p)
15422 (error "Not at a property"))
15423 (let ((prop (org-match-string-no-properties 2)))
15424 (org-columns-get-format-and-top-level)
15425 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15426 (error "No operator defined for property %s" prop))
15427 (org-columns-compute prop)))
15429 (defvar org-property-allowed-value-functions nil
15430 "Hook for functions supplying allowed values for a specific property.
15431 The functions must take a single argument, the name of the property, and
15433 the values, this means that these values are intended as defaults for
15434 completion, but that other values should be allowed too.
15435 The functions must return nil if they are not responsible for this
15436 property.")
15438 (defun org-property-get-allowed-values (pom property &optional table)
15439 "Get allowed values for the property PROPERTY.
15440 When TABLE is non-nil, return an alist that can directly be used for
15441 completion."
15442 (let (vals)
15443 (cond
15444 ((equal property "TODO")
15445 (setq vals (org-with-point-at pom
15446 (append org-todo-keywords-1 '("")))))
15447 ((equal property "PRIORITY")
15448 (let ((n org-lowest-priority))
15449 (while (>= n org-highest-priority)
15450 (push (char-to-string n) vals)
15451 (setq n (1- n)))))
15452 ((member property org-special-properties))
15453 ((setq vals (run-hook-with-args-until-success
15454 'org-property-allowed-value-functions property)))
15455 (t
15456 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15458 (setq vals (car (read-from-string (concat "(" vals ")"))))
15459 (setq vals (mapcar (lambda (x)
15460 (cond ((stringp x) x)
15461 ((numberp x) (number-to-string x))
15462 ((symbolp x) (symbol-name x))
15463 (t "???")))
15464 vals)))))
15465 (when (member ":ETC" vals)
15466 (setq vals (remove ":ETC" vals))
15467 (org-add-props (car vals) '(org-unrestricted t)))
15468 (if table (mapcar 'list vals) vals)))
15470 (defun org-property-previous-allowed-value (&optional previous)
15471 "Switch to the next allowed value for this property."
15472 (interactive)
15473 (org-property-next-allowed-value t))
15475 (defun org-property-next-allowed-value (&optional previous)
15476 "Switch to the next allowed value for this property."
15477 (interactive)
15478 (unless (org-at-property-p)
15479 (error "Not at a property"))
15480 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15481 (key (match-string 2))
15482 (value (match-string 3))
15483 (allowed (or (org-property-get-allowed-values (point) key)
15484 (and (member value '("[ ]" "[-]" "[X]"))
15485 '("[ ]" "[X]"))))
15486 (heading (save-match-data (nth 4 (org-heading-components))))
15487 nval)
15488 (unless allowed
15489 (error "Allowed values for this property have not been defined"))
15490 (if previous (setq allowed (reverse allowed)))
15491 (if (member value allowed)
15492 (setq nval (car (cdr (member value allowed)))))
15493 (setq nval (or nval (car allowed)))
15494 (if (equal nval value)
15495 (error "Only one allowed value for this property"))
15496 (org-at-property-p)
15497 (replace-match (concat " :" key ": " nval) t t)
15498 (org-indent-line)
15499 (beginning-of-line 1)
15501 (when (equal prop org-effort-property)
15502 (save-excursion
15503 (org-back-to-heading t)
15504 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15505 (when (string= org-clock-current-task heading)
15506 (setq org-clock-effort nval)
15507 (org-clock-update-mode-line)))
15508 (run-hook-with-args 'org-property-changed-functions key nval)))
15510 (defun org-find-olp (path &optional this-buffer)
15511 "Return a marker pointing to the entry at outline path OLP.
15512 If anything goes wrong, throw an error.
15513 You can wrap this call to catch the error like this:
15515 (condition-case msg
15516 (org-mobile-locate-entry (match-string 4))
15517 (error (nth 1 msg)))
15519 The return value will then be either a string with the error message,
15520 or a marker if everything is OK.
15522 If THIS-BUFFER is set, the outline path does not contain a file,
15523 only headings."
15524 (let* ((file (if this-buffer buffer-file-name (pop path)))
15525 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15526 (level 1)
15527 (lmin 1)
15528 (lmax 1)
15529 limit re end found pos heading cnt flevel)
15530 (unless buffer (error "File not found :%s" file))
15531 (with-current-buffer buffer
15532 (save-excursion
15533 (save-restriction
15534 (widen)
15535 (setq limit (point-max))
15536 (goto-char (point-min))
15537 (while (setq heading (pop path))
15538 (setq re (format org-complex-heading-regexp-format
15539 (regexp-quote heading)))
15540 (setq cnt 0 pos (point))
15541 (while (re-search-forward re end t)
15542 (setq level (- (match-end 1) (match-beginning 1)))
15543 (if (and (>= level lmin) (<= level lmax))
15544 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15545 (when (= cnt 0) (error "Heading not found on level %d: %s"
15546 lmax heading))
15547 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15548 lmax heading))
15549 (goto-char found)
15550 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15551 (setq end (save-excursion (org-end-of-subtree t t))))
15552 (when (org-at-heading-p)
15553 (point-marker)))))))
15555 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15556 "Find node HEADING in BUFFER.
15557 Return a marker to the heading if it was found, or nil if not.
15558 If POS-ONLY is set, return just the position instead of a marker.
15560 The heading text must match exact, but it may have a TODO keyword,
15561 a priority cookie and tags in the standard locations."
15562 (with-current-buffer (or buffer (current-buffer))
15563 (save-excursion
15564 (save-restriction
15565 (widen)
15566 (goto-char (point-min))
15567 (let (case-fold-search)
15568 (if (re-search-forward
15569 (format org-complex-heading-regexp-format
15570 (regexp-quote heading)) nil t)
15571 (if pos-only
15572 (match-beginning 0)
15573 (move-marker (make-marker) (match-beginning 0)))))))))
15575 (defun org-find-exact-heading-in-directory (heading &optional dir)
15576 "Find Org node headline HEADING in all .org files in directory DIR.
15577 When the target headline is found, return a marker to this location."
15578 (let ((files (directory-files (or dir default-directory)
15580 file visiting m buffer)
15581 (catch 'found
15582 (while (setq file (pop files))
15583 (message "trying %s" file)
15584 (setq visiting (org-find-base-buffer-visiting file))
15585 (setq buffer (or visiting (find-file-noselect file)))
15586 (setq m (org-find-exact-headline-in-buffer
15587 heading buffer))
15588 (when (and (not m) (not visiting)) (kill-buffer buffer))
15589 (and m (throw 'found m))))))
15591 (defun org-find-entry-with-id (ident)
15592 "Locate the entry that contains the ID property with exact value IDENT.
15593 IDENT can be a string, a symbol or a number, this function will search for
15594 the string representation of it.
15595 Return the position where this entry starts, or nil if there is no such entry."
15596 (interactive "sID: ")
15597 (let ((id (cond
15598 ((stringp ident) ident)
15599 ((symbol-name ident) (symbol-name ident))
15600 ((numberp ident) (number-to-string ident))
15601 (t (error "IDENT %s must be a string, symbol or number" ident))))
15602 (case-fold-search nil))
15603 (save-excursion
15604 (save-restriction
15605 (widen)
15606 (goto-char (point-min))
15607 (when (re-search-forward
15609 nil t)
15610 (org-back-to-heading t)
15611 (point))))))
15613 ;;;; Timestamps
15615 (defvar org-last-changed-timestamp nil)
15616 (defvar org-last-inserted-timestamp nil
15617 "The last time stamp inserted with `org-insert-time-stamp'.")
15618 (defvar org-time-was-given) ; dynamically scoped parameter
15619 (defvar org-end-time-was-given) ; dynamically scoped parameter
15620 (defvar org-ts-what) ; dynamically scoped parameter
15622 (defun org-time-stamp (arg &optional inactive)
15623 "Prompt for a date/time and insert a time stamp.
15624 If the user specifies a time like HH:MM or if this command is
15625 called with at least one prefix argument, the time stamp contains
15626 the date and the time. Otherwise, only the date is be included.
15628 All parts of a date not specified by the user is filled in from
15629 the current date/time. So if you just press return without
15630 typing anything, the time stamp will represent the current
15631 date/time.
15633 If there is already a timestamp at the cursor, it will be
15634 modified.
15636 With two universal prefix arguments, insert an active timestamp
15637 with the current time without prompting the user."
15638 (interactive "P")
15639 (let* ((ts nil)
15640 (default-time
15641 ;; Default time is either today, or, when entering a range,
15642 ;; the range start.
15643 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15644 (save-excursion
15645 (re-search-backward
15647 (- (point) 20) t)))
15648 (apply 'encode-time (org-parse-time-string (match-string 1)))
15649 (current-time)))
15650 (default-input (and ts (org-get-compact-tod ts)))
15651 (repeater (save-excursion
15652 (save-match-data
15653 (beginning-of-line)
15654 (when (re-search-forward
15656 (save-excursion (progn (end-of-line) (point))) t)
15657 (match-string 0)))))
15658 org-time-was-given org-end-time-was-given time)
15659 (cond
15660 ((and (org-at-timestamp-p t)
15661 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15662 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15663 (insert "--")
15664 (setq time (let ((this-command this-command))
15665 (org-read-date arg 'totime nil nil
15666 default-time default-input inactive)))
15667 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15668 ((org-at-timestamp-p t)
15669 (setq time (let ((this-command this-command))
15670 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15671 (when (org-at-timestamp-p t) ; just to get the match data
15672 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15673 (replace-match "")
15674 (setq org-last-changed-timestamp
15675 (org-insert-time-stamp
15676 time (or org-time-was-given arg)
15677 inactive nil nil (list org-end-time-was-given)))
15678 (when repeater (goto-char (1- (point))) (insert " " repeater)
15679 (setq org-last-changed-timestamp
15680 (concat (substring org-last-inserted-timestamp 0 -1)
15681 " " repeater ">"))))
15682 (message "Timestamp updated"))
15683 ((equal arg '(16))
15684 (org-insert-time-stamp (current-time) t))
15685 (t
15686 (setq time (let ((this-command this-command))
15687 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15688 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15689 nil nil (list org-end-time-was-given))))))
15691 ;; FIXME: can we use this for something else, like computing time differences?
15692 (defun org-get-compact-tod (s)
15693 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15694 (let* ((t1 (match-string 1 s))
15695 (h1 (string-to-number (match-string 2 s)))
15696 (m1 (string-to-number (match-string 3 s)))
15697 (t2 (and (match-end 4) (match-string 5 s)))
15698 (h2 (and t2 (string-to-number (match-string 6 s))))
15699 (m2 (and t2 (string-to-number (match-string 7 s))))
15700 dh dm)
15701 (if (not t2)
15702 t1
15703 (setq dh (- h2 h1) dm (- m2 m1))
15704 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15705 (concat t1 "+" (number-to-string dh)
15706 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15708 (defun org-time-stamp-inactive (&optional arg)
15709 "Insert an inactive time stamp.
15710 An inactive time stamp is enclosed in square brackets instead of angle
15711 brackets. It is inactive in the sense that it does not trigger agenda entries,
15712 does not link to the calendar and cannot be changed with the S-cursor keys.
15713 So these are more for recording a certain time/date."
15714 (interactive "P")
15715 (org-time-stamp arg 'inactive))
15717 (defvar org-date-ovl (make-overlay 1 1))
15718 (overlay-put org-date-ovl 'face 'org-date-selected)
15719 (org-detach-overlay org-date-ovl)
15721 (defvar org-ans1) ; dynamically scoped parameter
15722 (defvar org-ans2) ; dynamically scoped parameter
15724 (defvar org-plain-time-of-day-regexp) ; defined below
15726 (defvar org-overriding-default-time nil) ; dynamically scoped
15727 (defvar org-read-date-overlay nil)
15728 (defvar org-dcst nil) ; dynamically scoped
15729 (defvar org-read-date-history nil)
15730 (defvar org-read-date-final-answer nil)
15731 (defvar org-read-date-analyze-futurep nil)
15732 (defvar org-read-date-analyze-forced-year nil)
15733 (defvar org-read-date-inactive)
15735 (defvar org-read-date-minibuffer-local-map
15736 (let ((map (make-sparse-keymap)))
15737 (set-keymap-parent map minibuffer-local-map)
15738 (org-defkey map (kbd ".")
15739 (lambda () (interactive)
15740 (org-eval-in-calendar '(calendar-goto-today))))
15741 (org-defkey map [(meta shift left)]
15742 (lambda () (interactive)
15743 (org-eval-in-calendar '(calendar-backward-month 1))))
15744 (org-defkey map [(meta shift right)]
15745 (lambda () (interactive)
15746 (org-eval-in-calendar '(calendar-forward-month 1))))
15747 (org-defkey map [(meta shift up)]
15748 (lambda () (interactive)
15749 (org-eval-in-calendar '(calendar-backward-year 1))))
15750 (org-defkey map [(meta shift down)]
15751 (lambda () (interactive)
15752 (org-eval-in-calendar '(calendar-forward-year 1))))
15753 (org-defkey map [?\e (shift left)]
15754 (lambda () (interactive)
15755 (org-eval-in-calendar '(calendar-backward-month 1))))
15756 (org-defkey map [?\e (shift right)]
15757 (lambda () (interactive)
15758 (org-eval-in-calendar '(calendar-forward-month 1))))
15759 (org-defkey map [?\e (shift up)]
15760 (lambda () (interactive)
15761 (org-eval-in-calendar '(calendar-backward-year 1))))
15762 (org-defkey map [?\e (shift down)]
15763 (lambda () (interactive)
15764 (org-eval-in-calendar '(calendar-forward-year 1))))
15765 (org-defkey map [(shift up)]
15766 (lambda () (interactive)
15767 (org-eval-in-calendar '(calendar-backward-week 1))))
15768 (org-defkey map [(shift down)]
15769 (lambda () (interactive)
15770 (org-eval-in-calendar '(calendar-forward-week 1))))
15771 (org-defkey map [(shift left)]
15772 (lambda () (interactive)
15773 (org-eval-in-calendar '(calendar-backward-day 1))))
15774 (org-defkey map [(shift right)]
15775 (lambda () (interactive)
15776 (org-eval-in-calendar '(calendar-forward-day 1))))
15777 (org-defkey map "!"
15778 (lambda () (interactive)
15779 (org-eval-in-calendar '(diary-view-entries))
15780 (message "")))
15781 (org-defkey map ">"
15782 (lambda () (interactive)
15783 (org-eval-in-calendar '(scroll-calendar-left 1))))
15784 (org-defkey map "<"
15785 (lambda () (interactive)
15786 (org-eval-in-calendar '(scroll-calendar-right 1))))
15787 (org-defkey map "\C-v"
15788 (lambda () (interactive)
15789 (org-eval-in-calendar
15790 '(calendar-scroll-left-three-months 1))))
15791 (org-defkey map "\M-v"
15792 (lambda () (interactive)
15793 (org-eval-in-calendar
15794 '(calendar-scroll-right-three-months 1))))
15795 map)
15796 "Keymap for minibuffer commands when using `org-read-date'.")
15798 (defun org-read-date (&optional org-with-time to-time from-string prompt
15799 default-time default-input inactive)
15800 "Read a date, possibly a time, and make things smooth for the user.
15801 The prompt will suggest to enter an ISO date, but you can also enter anything
15802 which will at least partially be understood by `parse-time-string'.
15803 Unrecognized parts of the date will default to the current day, month, year,
15804 hour and minute. If this command is called to replace a timestamp at point,
15805 or to enter the second timestamp of a range, the default time is taken
15806 from the existing stamp. Furthermore, the command prefers the future,
15807 so if you are giving a date where the year is not given, and the day-month
15808 combination is already past in the current year, it will assume you
15809 mean next year. For details, see the manual. A few examples:
15811 3-2-5 --> 2003-02-05
15812 feb 15 --> currentyear-02-15
15813 2/15 --> currentyear-02-15
15814 sep 12 9 --> 2009-09-12
15815 12:45 --> today 12:45
15816 22 sept 0:34 --> currentyear-09-22 0:34
15817 12 --> currentyear-currentmonth-12
15818 Fri --> nearest Friday (today or later)
15819 etc.
15821 Furthermore you can specify a relative date by giving, as the *first* thing
15822 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15823 change in days weeks, months, years.
15824 With a single plus or minus, the date is relative to today. With a double
15825 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15826 +4d --> four days from today
15827 +4 --> same as above
15828 +2w --> two weeks from today
15829 ++5 --> five days from default date
15831 The function understands only English month and weekday abbreviations.
15833 While prompting, a calendar is popped up - you can also select the
15834 date with the mouse (button 1). The calendar shows a period of three
15835 months. To scroll it to other months, use the keys `>' and `<'.
15836 If you don't like the calendar, turn it off with
15837 \(setq org-read-date-popup-calendar nil)
15839 With optional argument TO-TIME, the date will immediately be converted
15840 to an internal time.
15841 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15842 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15843 still enter a time, and this function will inform the calling routine
15844 about this change. The calling routine may then choose to change the
15845 format used to insert the time stamp into the buffer to include the time.
15846 With optional argument FROM-STRING, read from this string instead from
15847 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15848 the time/date that is used for everything that is not specified by the
15849 user."
15850 (require 'parse-time)
15851 (let* ((org-time-stamp-rounding-minutes
15852 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15853 (org-dcst org-display-custom-times)
15854 (ct (org-current-time))
15855 (org-def (or org-overriding-default-time default-time ct))
15856 (org-defdecode (decode-time org-def))
15857 (dummy (progn
15858 (when (< (nth 2 org-defdecode) org-extend-today-until)
15859 (setcar (nthcdr 2 org-defdecode) -1)
15860 (setcar (nthcdr 1 org-defdecode) 59)
15861 (setq org-def (apply 'encode-time org-defdecode)
15862 org-defdecode (decode-time org-def)))))
15863 (mouse-autoselect-window nil) ; Don't let the mouse jump
15864 (calendar-frame-setup nil)
15865 (calendar-setup nil)
15866 (calendar-move-hook nil)
15867 (calendar-view-diary-initially-flag nil)
15868 (calendar-view-holidays-initially-flag nil)
15869 (timestr (format-time-string
15870 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15871 (prompt (concat (if prompt (concat prompt " ") "")
15872 (format "Date+time [%s]: " timestr)))
15873 ans (org-ans0 "") org-ans1 org-ans2 final)
15875 (cond
15876 (from-string (setq ans from-string))
15877 (org-read-date-popup-calendar
15878 (save-excursion
15879 (save-window-excursion
15880 (calendar)
15881 (org-eval-in-calendar '(setq cursor-type nil) t)
15882 (unwind-protect
15883 (progn
15884 (calendar-forward-day (- (time-to-days org-def)
15885 (calendar-absolute-from-gregorian
15886 (calendar-current-date))))
15887 (org-eval-in-calendar nil t)
15888 (let* ((old-map (current-local-map))
15889 (map (copy-keymap calendar-mode-map))
15890 (minibuffer-local-map
15891 (copy-keymap org-read-date-minibuffer-local-map)))
15892 (org-defkey map (kbd "RET") 'org-calendar-select)
15893 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15894 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15895 (unwind-protect
15896 (progn
15897 (use-local-map map)
15898 (setq org-read-date-inactive inactive)
15899 (add-hook 'post-command-hook 'org-read-date-display)
15900 (setq org-ans0 (read-string prompt default-input
15901 'org-read-date-history nil))
15902 ;; org-ans0: from prompt
15903 ;; org-ans1: from mouse click
15904 ;; org-ans2: from calendar motion
15905 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15906 (remove-hook 'post-command-hook 'org-read-date-display)
15907 (use-local-map old-map)
15908 (when org-read-date-overlay
15909 (delete-overlay org-read-date-overlay)
15910 (setq org-read-date-overlay nil)))))
15911 (bury-buffer "*Calendar*")))))
15913 (t ; Naked prompt only
15914 (unwind-protect
15915 (setq ans (read-string prompt default-input
15916 'org-read-date-history timestr))
15917 (when org-read-date-overlay
15918 (delete-overlay org-read-date-overlay)
15919 (setq org-read-date-overlay nil)))))
15921 (setq final (org-read-date-analyze ans org-def org-defdecode))
15923 (when org-read-date-analyze-forced-year
15924 (message "Year was forced into %s"
15925 (if org-read-date-force-compatible-dates
15926 "compatible range (1970-2037)"
15927 "range representable on this machine"))
15928 (ding))
15930 ;; One round trip to get rid of 34th of August and stuff like that....
15931 (setq final (decode-time (apply 'encode-time final)))
15933 (setq org-read-date-final-answer ans)
15935 (if to-time
15936 (apply 'encode-time final)
15937 (if (and (boundp 'org-time-was-given) org-time-was-given)
15938 (format "%04d-%02d-%02d %02d:%02d"
15939 (nth 5 final) (nth 4 final) (nth 3 final)
15940 (nth 2 final) (nth 1 final))
15941 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15943 (defvar org-def)
15944 (defvar org-defdecode)
15945 (defvar org-with-time)
15946 (defun org-read-date-display ()
15947 "Display the current date prompt interpretation in the minibuffer."
15948 (when org-read-date-display-live
15949 (when org-read-date-overlay
15950 (delete-overlay org-read-date-overlay))
15951 (when (minibufferp (current-buffer))
15952 (save-excursion
15953 (end-of-line 1)
15954 (while (not (equal (buffer-substring
15955 (max (point-min) (- (point) 4)) (point))
15956 " "))
15957 (insert " ")))
15958 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15959 " " (or org-ans1 org-ans2)))
15960 (org-end-time-was-given nil)
15961 (f (org-read-date-analyze ans org-def org-defdecode))
15962 (fmts (if org-dcst
15963 org-time-stamp-custom-formats
15964 org-time-stamp-formats))
15965 (fmt (if (or org-with-time
15966 (and (boundp 'org-time-was-given) org-time-was-given))
15967 (cdr fmts)
15968 (car fmts)))
15969 (txt (format-time-string fmt (apply 'encode-time f)))
15970 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15971 (txt (concat "=> " txt)))
15972 (when (and org-end-time-was-given
15973 (string-match org-plain-time-of-day-regexp txt))
15974 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15975 org-end-time-was-given
15976 (substring txt (match-end 0)))))
15977 (when org-read-date-analyze-futurep
15978 (setq txt (concat txt " (=>F)")))
15979 (setq org-read-date-overlay
15980 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15981 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15983 (defun org-read-date-analyze (ans org-def org-defdecode)
15984 "Analyze the combined answer of the date prompt."
15985 ;; FIXME: cleanup and comment
15986 (let ((nowdecode (decode-time (current-time)))
15987 delta deltan deltaw deltadef year month day
15988 hour minute second wday pm h2 m2 tl wday1
15989 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15990 (setq org-read-date-analyze-futurep nil
15991 org-read-date-analyze-forced-year nil)
15993 (setq ans "+0"))
15995 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15996 (setq ans (replace-match "" t t ans)
15997 deltan (car delta)
15998 deltaw (nth 1 delta)
15999 deltadef (nth 2 delta)))
16001 ;; Check if there is an iso week date in there. If yes, store the
16002 ;; info and postpone interpreting it until the rest of the parsing
16003 ;; is done.
16004 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16005 (setq iso-year (if (match-end 1)
16006 (org-small-year-to-year
16007 (string-to-number (match-string 1 ans))))
16008 iso-weekday (if (match-end 3)
16009 (string-to-number (match-string 3 ans)))
16010 iso-week (string-to-number (match-string 2 ans)))
16011 (setq ans (replace-match "" t t ans)))
16013 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16014 (when (string-match
16016 (setq year (if (match-end 2)
16017 (string-to-number (match-string 2 ans))
16018 (progn (setq kill-year t)
16019 (string-to-number (format-time-string "%Y"))))
16020 month (string-to-number (match-string 3 ans))
16021 day (string-to-number (match-string 4 ans)))
16022 (if (< year 100) (setq year (+ 2000 year)))
16024 t nil ans)))
16026 ;; Help matching dotted european dates
16027 (when (string-match
16028 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16029 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16030 (setq kill-year t)
16031 (string-to-number (format-time-string "%Y")))
16032 day (string-to-number (match-string 1 ans))
16033 month (string-to-number (match-string 2 ans))
16034 ans (replace-match (format "%04d-%02d-%02d" year month day)
16035 t nil ans)))
16037 ;; Help matching american dates, like 5/30 or 5/30/7
16038 (when (string-match
16039 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16040 (setq year (if (match-end 4)
16041 (string-to-number (match-string 4 ans))
16042 (progn (setq kill-year t)
16043 (string-to-number (format-time-string "%Y"))))
16044 month (string-to-number (match-string 1 ans))
16045 day (string-to-number (match-string 2 ans)))
16046 (if (< year 100) (setq year (+ 2000 year)))
16048 t nil ans)))
16049 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16050 ;; If there is a time with am/pm, and *no* time without it, we convert
16051 ;; so that matching will be successful.
16052 (loop for i from 1 to 2 do ; twice, for end time as well
16055 (setq hour (string-to-number (match-string 1 ans))
16056 minute (if (match-end 3)
16057 (string-to-number (match-string 3 ans))
16058 0)
16059 pm (equal ?p
16060 (string-to-char (downcase (match-string 4 ans)))))
16061 (if (and (= hour 12) (not pm))
16062 (setq hour 0)
16063 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16064 (setq ans (replace-match (format "%02d:%02d" hour minute)
16065 t t ans))))
16067 ;; Check if a time range is given as a duration
16068 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16069 (setq hour (string-to-number (match-string 1 ans))
16070 h2 (+ hour (string-to-number (match-string 3 ans)))
16071 minute (string-to-number (match-string 2 ans))
16072 m2 (+ minute (if (match-end 5) (string-to-number
16073 (match-string 5 ans))0)))
16074 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16075 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16076 t t ans)))
16078 ;; Check if there is a time range
16079 (when (boundp 'org-end-time-was-given)
16080 (setq org-time-was-given nil)
16081 (when (and (string-match org-plain-time-of-day-regexp ans)
16082 (match-end 8))
16083 (setq org-end-time-was-given (match-string 8 ans))
16084 (setq ans (concat (substring ans 0 (match-beginning 7))
16085 (substring ans (match-end 7))))))
16087 (setq tl (parse-time-string ans)
16088 day (or (nth 3 tl) (nth 3 org-defdecode))
16089 month (or (nth 4 tl)
16090 (if (and org-read-date-prefer-future
16091 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16092 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16093 (nth 4 org-defdecode)))
16094 year (or (and (not kill-year) (nth 5 tl))
16095 (if (and org-read-date-prefer-future
16096 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16097 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16098 (nth 5 org-defdecode)))
16099 hour (or (nth 2 tl) (nth 2 org-defdecode))
16100 minute (or (nth 1 tl) (nth 1 org-defdecode))
16101 second (or (nth 0 tl) 0)
16102 wday (nth 6 tl))
16104 (when (and (eq org-read-date-prefer-future 'time)
16105 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16106 (equal day (nth 3 nowdecode))
16107 (equal month (nth 4 nowdecode))
16108 (equal year (nth 5 nowdecode))
16109 (nth 2 tl)
16110 (or (< (nth 2 tl) (nth 2 nowdecode))
16111 (and (= (nth 2 tl) (nth 2 nowdecode))
16112 (nth 1 tl)
16113 (< (nth 1 tl) (nth 1 nowdecode)))))
16114 (setq day (1+ day)
16115 futurep t))
16117 ;; Special date definitions below
16118 (cond
16119 (iso-week
16120 ;; There was an iso week
16121 (require 'cal-iso)
16122 (setq futurep nil)
16123 (setq year (or iso-year year)
16124 day (or iso-weekday wday 1)
16125 wday nil ; to make sure that the trigger below does not match
16126 iso-date (calendar-gregorian-from-absolute
16127 (calendar-absolute-from-iso
16128 (list iso-week day year))))
16129 ; FIXME: Should we also push ISO weeks into the future?
16130 ; (when (and org-read-date-prefer-future
16131 ; (not iso-year)
16132 ; (< (calendar-absolute-from-gregorian iso-date)
16133 ; (time-to-days (current-time))))
16134 ; (setq year (1+ year)
16135 ; iso-date (calendar-gregorian-from-absolute
16136 ; (calendar-absolute-from-iso
16137 ; (list iso-week day year)))))
16138 (setq month (car iso-date)
16139 year (nth 2 iso-date)
16140 day (nth 1 iso-date)))
16141 (deltan
16142 (setq futurep nil)
16143 (unless deltadef
16144 (let ((now (decode-time (current-time))))
16145 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16146 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16147 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16148 ((equal deltaw "m") (setq month (+ month deltan)))
16149 ((equal deltaw "y") (setq year (+ year deltan)))))
16150 ((and wday (not (nth 3 tl)))
16151 ;; Weekday was given, but no day, so pick that day in the week
16152 ;; on or after the derived date.
16153 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16154 (unless (equal wday wday1)
16155 (setq day (+ day (% (- wday wday1 -7) 7))))))
16156 (if (and (boundp 'org-time-was-given)
16157 (nth 2 tl))
16158 (setq org-time-was-given t))
16159 (if (< year 100) (setq year (+ 2000 year)))
16160 ;; Check of the date is representable
16161 (if org-read-date-force-compatible-dates
16162 (progn
16163 (if (< year 1970)
16164 (setq year 1970 org-read-date-analyze-forced-year t))
16165 (if (> year 2037)
16166 (setq year 2037 org-read-date-analyze-forced-year t)))
16167 (condition-case nil
16168 (ignore (encode-time second minute hour day month year))
16169 (error
16170 (setq year (nth 5 org-defdecode))
16171 (setq org-read-date-analyze-forced-year t))))
16172 (setq org-read-date-analyze-futurep futurep)
16173 (list second minute hour day month year)))
16175 (defvar parse-time-weekdays)
16176 (defun org-read-date-get-relative (s today default)
16177 "Check string S for special relative date string.
16178 TODAY and DEFAULT are internal times, for today and for a default.
16179 Return shift list (N what def-flag)
16181 N is the number of WHATs to shift.
16182 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16183 the DEFAULT date rather than TODAY."
16184 (require 'parse-time)
16185 (when (and
16186 (string-match
16187 (concat
16192 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16193 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16194 (string-to-char (substring (match-string 1 s) -1))
16195 ?+))
16196 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16197 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16198 (what (if (match-end 3) (match-string 3 s) "d"))
16199 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16200 (date (if rel default today))
16201 (wday (nth 6 (decode-time date)))
16202 delta)
16203 (if wday1
16204 (progn
16205 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16206 (if (= dir ?-) (setq delta (- delta 7)))
16207 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16208 (list delta "d" rel))
16209 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16211 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16212 "Turn a user-specified date into the internal representation.
16213 The internal representation needed by the calendar is (month day year).
16214 This is a wrapper to handle the brain-dead convention in calendar that
16215 user function argument order change dependent on argument order."
16216 (if (boundp 'calendar-date-style)
16217 (cond
16218 ((eq calendar-date-style 'american)
16219 (list arg1 arg2 arg3))
16220 ((eq calendar-date-style 'european)
16221 (list arg2 arg1 arg3))
16222 ((eq calendar-date-style 'iso)
16223 (list arg2 arg3 arg1)))
16224 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16225 (if (org-bound-and-true-p european-calendar-style)
16226 (list arg2 arg1 arg3)
16227 (list arg1 arg2 arg3)))))
16229 (defun org-eval-in-calendar (form &optional keepdate)
16230 "Eval FORM in the calendar window and return to current window.
16231 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16232 otherwise stick to the current value of `org-ans2'."
16233 (let ((sf (selected-frame))
16234 (sw (selected-window)))
16235 (select-window (get-buffer-window "*Calendar*" t))
16236 (eval form)
16237 (when (and (not keepdate) (calendar-cursor-to-date))
16238 (let* ((date (calendar-cursor-to-date))
16239 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16240 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16241 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16242 (select-window sw)
16243 (org-select-frame-set-input-focus sf)))
16245 (defun org-calendar-select ()
16246 "Return to `org-read-date' with the date currently selected.
16247 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16248 (interactive)
16249 (when (calendar-cursor-to-date)
16250 (let* ((date (calendar-cursor-to-date))
16251 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16252 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16253 (if (active-minibuffer-window) (exit-minibuffer))))
16255 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16256 "Insert a date stamp for the date given by the internal TIME.
16257 WITH-HM means use the stamp format that includes the time of the day.
16258 INACTIVE means use square brackets instead of angular ones, so that the
16259 stamp will not contribute to the agenda.
16260 PRE and POST are optional strings to be inserted before and after the
16261 stamp.
16262 The command returns the inserted time stamp."
16263 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16264 stamp)
16265 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16266 (insert-before-markers (or pre ""))
16267 (when (listp extra)
16268 (setq extra (car extra))
16269 (if (and (stringp extra)
16271 (setq extra (format "-%02d:%02d"
16272 (string-to-number (match-string 1 extra))
16273 (string-to-number (match-string 2 extra))))
16274 (setq extra nil)))
16275 (when extra
16276 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16277 (insert-before-markers (setq stamp (format-time-string fmt time)))
16278 (insert-before-markers (or post ""))
16279 (setq org-last-inserted-timestamp stamp)))
16281 (defun org-toggle-time-stamp-overlays ()
16282 "Toggle the use of custom time stamp formats."
16283 (interactive)
16284 (setq org-display-custom-times (not org-display-custom-times))
16285 (unless org-display-custom-times
16286 (let ((p (point-min)) (bmp (buffer-modified-p)))
16287 (while (setq p (next-single-property-change p 'display))
16288 (if (and (get-text-property p 'display)
16289 (eq (get-text-property p 'face) 'org-date))
16290 (remove-text-properties
16291 p (setq p (next-single-property-change p 'display))
16292 '(display t))))
16293 (set-buffer-modified-p bmp)))
16294 (if (featurep 'xemacs)
16295 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16296 (org-restart-font-lock)
16297 (setq org-table-may-need-update t)
16298 (if org-display-custom-times
16299 (message "Time stamps are overlaid with custom format")
16300 (message "Time stamp overlays removed")))
16302 (defun org-display-custom-time (beg end)
16303 "Overlay modified time stamp format over timestamp between BEG and END."
16304 (let* ((ts (buffer-substring beg end))
16305 t1 w1 with-hm tf time str w2 (off 0))
16306 (save-match-data
16307 (setq t1 (org-parse-time-string ts t))
16308 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16309 (setq off (- (match-end 0) (match-beginning 0)))))
16310 (setq end (- end off))
16311 (setq w1 (- end beg)
16312 with-hm (and (nth 1 t1) (nth 2 t1))
16313 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16314 time (org-fix-decoded-time t1)
16315 str (org-add-props
16316 (format-time-string
16317 (substring tf 1 -1) (apply 'encode-time time))
16318 nil 'mouse-face 'highlight)
16319 w2 (length str))
16320 (if (not (= w2 w1))
16321 (add-text-properties (1+ beg) (+ 2 beg)
16322 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16323 (if (featurep 'xemacs)
16324 (progn
16325 (put-text-property beg end 'invisible t)
16326 (put-text-property beg end 'end-glyph (make-glyph str)))
16327 (put-text-property beg end 'display str))))
16329 (defun org-translate-time (string)
16330 "Translate all timestamps in STRING to custom format.
16331 But do this only if the variable `org-display-custom-times' is set."
16332 (when org-display-custom-times
16333 (save-match-data
16334 (let* ((start 0)
16335 (re org-ts-regexp-both)
16336 t1 with-hm inactive tf time str beg end)
16337 (while (setq start (string-match re string start))
16338 (setq beg (match-beginning 0)
16339 end (match-end 0)
16340 t1 (save-match-data
16341 (org-parse-time-string (substring string beg end) t))
16342 with-hm (and (nth 1 t1) (nth 2 t1))
16343 inactive (equal (substring string beg (1+ beg)) "[")
16344 tf (funcall (if with-hm 'cdr 'car)
16345 org-time-stamp-custom-formats)
16346 time (org-fix-decoded-time t1)
16347 str (format-time-string
16348 (concat
16349 (if inactive "[" "<") (substring tf 1 -1)
16350 (if inactive "]" ">"))
16351 (apply 'encode-time time))
16352 string (replace-match str t t string)
16353 start (+ start (length str)))))))
16354 string)
16356 (defun org-fix-decoded-time (time)
16357 "Set 0 instead of nil for the first 6 elements of time.
16358 Don't touch the rest."
16359 (let ((n 0))
16360 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16362 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.3")
16364 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16365 "Difference between TIMESTAMP-STRING and now in days.
16366 If SECONDS is non-nil, return the difference in seconds."
16367 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16368 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16369 (funcall fdiff (current-time)))))
16371 (defun org-deadline-close (timestamp-string &optional ndays)
16372 "Is the time in TIMESTAMP-STRING close to the current date?"
16373 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16374 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16375 (not (org-entry-is-done-p))))
16377 (defun org-get-wdays (ts &optional delay zero-delay)
16378 "Get the deadline lead time appropriate for timestring TS.
16379 When DELAY is non-nil, get the delay time for scheduled items
16380 instead of the deadline lead time. When ZERO-DELAY is non-nil
16381 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16382 don't try to find the delay cookie in the scheduled timestamp."
16383 (let ((tv (if delay org-scheduled-delay-days
16384 org-deadline-warning-days)))
16385 (cond
16386 ((or (and delay (< tv 0))
16387 (and delay zero-delay (<= tv 0))
16388 (and (not delay) (<= tv 0)))
16389 ;; Enforce this value no matter what
16390 (- tv))
16392 ;; lead time is specified.
16393 (floor (* (string-to-number (match-string 1 ts))
16394 (cdr (assoc (match-string 2 ts)
16395 '(("d" . 1) ("w" . 7)
16396 ("m" . 30.4) ("y" . 365.25)
16397 ("h" . 0.041667)))))))
16398 ;; go for the default.
16399 (t tv))))
16401 (defun org-calendar-select-mouse (ev)
16402 "Return to `org-read-date' with the date currently selected.
16403 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16404 (interactive "e")
16405 (mouse-set-point ev)
16406 (when (calendar-cursor-to-date)
16407 (let* ((date (calendar-cursor-to-date))
16408 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16409 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16410 (if (active-minibuffer-window) (exit-minibuffer))))
16412 (defun org-check-deadlines (ndays)
16413 "Check if there are any deadlines due or past due.
16414 A deadline is considered due if it happens within `org-deadline-warning-days'
16415 days from today's date. If the deadline appears in an entry marked DONE,
16416 it is not shown. The prefix arg NDAYS can be used to test that many
16418 (interactive "P")
16419 (let* ((org-warn-days
16420 (cond
16421 ((equal ndays '(4)) 100000)
16422 (ndays (prefix-numeric-value ndays))
16423 (t (abs org-deadline-warning-days))))
16424 (case-fold-search nil)
16426 (callback
16427 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16429 (message "%d deadlines past-due or due within %d days"
16430 (org-occur regexp nil callback)
16431 org-warn-days)))
16433 (defsubst org-re-timestamp (type)
16434 "Return a regexp for timestamp TYPE.
16435 Allowed values for TYPE are:
16437 all: all timestamps
16438 active: only active timestamps (<...>)
16439 inactive: only inactive timestamps ([...])
16440 scheduled: only scheduled timestamps
16441 deadline: only deadline timestamps
16443 When TYPE is nil, fall back on returning a regexp that matches
16444 both scheduled and deadline timestamps."
16445 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16446 ((eq type 'active) org-ts-regexp)
16450 ((eq type 'scheduled-or-deadline)
16453 (defun org-check-before-date (date)
16454 "Check if there are deadlines or scheduled entries before DATE."
16455 (interactive (list (org-read-date)))
16456 (let ((case-fold-search nil)
16457 (regexp (org-re-timestamp org-ts-type))
16458 (callback
16459 (lambda () (time-less-p
16460 (org-time-string-to-time (match-string 1))
16461 (org-time-string-to-time date)))))
16462 (message "%d entries before %s"
16463 (org-occur regexp nil callback) date)))
16465 (defun org-check-after-date (date)
16466 "Check if there are deadlines or scheduled entries after DATE."
16467 (interactive (list (org-read-date)))
16468 (let ((case-fold-search nil)
16469 (regexp (org-re-timestamp org-ts-type))
16470 (callback
16471 (lambda () (not
16472 (time-less-p
16473 (org-time-string-to-time (match-string 1))
16474 (org-time-string-to-time date))))))
16475 (message "%d entries after %s"
16476 (org-occur regexp nil callback) date)))
16478 (defun org-check-dates-range (start-date end-date)
16479 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16480 (interactive (list (org-read-date nil nil nil "Range starts")
16481 (org-read-date nil nil nil "Range end")))
16482 (let ((case-fold-search nil)
16483 (regexp (org-re-timestamp org-ts-type))
16484 (callback
16485 (lambda ()
16486 (let ((match (match-string 1)))
16487 (and
16488 (not (time-less-p
16489 (org-time-string-to-time match)
16490 (org-time-string-to-time start-date)))
16491 (time-less-p
16492 (org-time-string-to-time match)
16493 (org-time-string-to-time end-date)))))))
16494 (message "%d entries between %s and %s"
16495 (org-occur regexp nil callback) start-date end-date)))
16497 (defun org-evaluate-time-range (&optional to-buffer)
16498 "Evaluate a time range by computing the difference between start and end.
16499 Normally the result is just printed in the echo area, but with prefix arg
16500 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16501 If the time range is actually in a table, the result is inserted into the
16502 next column.
16503 For time difference computation, a year is assumed to be exactly 365
16504 days in order to avoid rounding problems."
16505 (interactive "P")
16506 (or
16507 (org-clock-update-time-maybe)
16508 (save-excursion
16509 (unless (org-at-date-range-p t)
16510 (goto-char (point-at-bol))
16511 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16512 (if (not (org-at-date-range-p t))
16513 (error "Not at a time-stamp range, and none found in current line")))
16514 (let* ((ts1 (match-string 1))
16515 (ts2 (match-string 2))
16516 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16517 (match-end (match-end 0))
16518 (time1 (org-time-string-to-time ts1))
16519 (time2 (org-time-string-to-time ts2))
16520 (t1 (org-float-time time1))
16521 (t2 (org-float-time time2))
16522 (diff (abs (- t2 t1)))
16523 (negative (< (- t2 t1) 0))
16524 ;; (ys (floor (* 365 24 60 60)))
16525 (ds (* 24 60 60))
16526 (hs (* 60 60))
16527 (fy "%dy %dd %02d:%02d")
16528 (fy1 "%dy %dd")
16529 (fd "%dd %02d:%02d")
16530 (fd1 "%dd")
16531 (fh "%02d:%02d")
16532 y d h m align)
16533 (if havetime
16534 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16535 y 0
16536 d (floor (/ diff ds)) diff (mod diff ds)
16537 h (floor (/ diff hs)) diff (mod diff hs)
16538 m (floor (/ diff 60)))
16539 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16540 y 0
16541 d (floor (+ (/ diff ds) 0.5))
16542 h 0 m 0))
16543 (if (not to-buffer)
16544 (message "%s" (org-make-tdiff-string y d h m))
16545 (if (org-at-table-p)
16546 (progn
16547 (goto-char match-end)
16548 (setq align t)
16549 (and (looking-at " *|") (goto-char (match-end 0))))
16550 (goto-char match-end))
16551 (if (looking-at
16553 (replace-match ""))
16554 (if negative (insert " -"))
16555 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16556 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16557 (insert " " (format fh h m))))
16558 (if align (org-table-align))
16559 (message "Time difference inserted")))))
16561 (defun org-make-tdiff-string (y d h m)
16562 (let ((fmt "")
16563 (l nil))
16564 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16565 l (push y l)))
16566 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16567 l (push d l)))
16568 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16569 l (push h l)))
16570 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16571 l (push m l)))
16572 (apply 'format fmt (nreverse l))))
16574 (defun org-time-string-to-time (s &optional buffer pos)
16575 "Convert a timestamp string into internal time."
16576 (condition-case errdata
16577 (apply 'encode-time (org-parse-time-string s))
16579 s (if (not (and buffer pos))
16580 ""
16581 (format " at %d in buffer `%s'" pos buffer))
16582 (cdr errdata)))))
16584 (defun org-time-string-to-seconds (s)
16585 "Convert a timestamp string to a number of seconds."
16586 (org-float-time (org-time-string-to-time s)))
16588 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16589 "Convert a time stamp to an absolute day number.
16590 If there is a specifier for a cyclic time stamp, get the closest
16591 date to DAYNR.
16592 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16593 The variable date is bound by the calendar when this is called."
16594 (cond
16596 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16597 daynr
16598 (+ daynr 1000)))
16600 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16601 (time-to-days (current-time))) (match-string 0 s)
16602 prefer show-all))
16603 (t (time-to-days
16604 (condition-case errdata
16605 (apply 'encode-time (org-parse-time-string s))
16607 s (if (not (and buffer pos))
16608 ""
16609 (format " at %d in buffer `%s'" pos buffer))
16610 (cdr errdata))))))))
16612 (defun org-days-to-iso-week (days)
16613 "Return the iso week number."
16614 (require 'cal-iso)
16615 (car (calendar-iso-from-absolute days)))
16617 (defun org-small-year-to-year (year)
16618 "Convert 2-digit years into 4-digit years.
16619 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16620 The year 2000 cannot be abbreviated. Any year larger than 99
16621 is returned unchanged."
16622 (if (< year 38)
16623 (setq year (+ 2000 year))
16624 (if (< year 100)
16625 (setq year (+ 1900 year))))
16626 year)
16628 (defun org-time-from-absolute (d)
16629 "Return the time corresponding to date D.
16630 D may be an absolute day number, or a calendar-type list (month day year)."
16631 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16632 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16634 (defun org-calendar-holiday ()
16635 "List of holidays, for Diary display in Org-mode."
16636 (require 'holidays)
16637 (let ((hl (funcall
16638 (if (fboundp 'calendar-check-holidays)
16639 'calendar-check-holidays 'check-calendar-holidays) date)))
16640 (if hl (mapconcat 'identity hl "; "))))
16642 (defun org-diary-sexp-entry (sexp entry date)
16643 "Process a SEXP diary ENTRY for DATE."
16644 (require 'diary-lib)
16645 (let ((result (if calendar-debug-sexp
16646 (let ((stack-trace-on-error t))
16647 (eval (car (read-from-string sexp))))
16648 (condition-case nil
16649 (eval (car (read-from-string sexp)))
16650 (error
16651 (beep)
16652 (message "Bad sexp at line %d in %s: %s"
16653 (org-current-line)
16654 (buffer-file-name) sexp)
16655 (sleep-for 2))))))
16656 (cond ((stringp result) (split-string result "; "))
16657 ((and (consp result)
16658 (not (consp (cdr result)))
16659 (stringp (cdr result))) (cdr result))
16660 ((and (consp result)
16661 (stringp (car result))) result)
16662 (result entry))))
16664 (defun org-diary-to-ical-string (frombuf)
16665 "Get iCalendar entries from diary entries in buffer FROMBUF.
16666 This uses the icalendar.el library."
16667 (let* ((tmpdir (if (featurep 'xemacs)
16668 (temp-directory)
16669 temporary-file-directory))
16670 (tmpfile (make-temp-name
16671 (expand-file-name "orgics" tmpdir)))
16672 buf rtn b e)
16673 (with-current-buffer frombuf
16674 (icalendar-export-region (point-min) (point-max) tmpfile)
16675 (setq buf (find-buffer-visiting tmpfile))
16676 (set-buffer buf)
16677 (goto-char (point-min))
16678 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16679 (setq b (match-beginning 0)))
16680 (goto-char (point-max))
16681 (if (re-search-backward "^END:VEVENT" nil t)
16682 (setq e (match-end 0)))
16684 (kill-buffer buf)
16685 (delete-file tmpfile)
16686 rtn))
16688 (defun org-closest-date (start current change prefer show-all)
16689 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16690 When PREFER is `past', return a date that is either CURRENT or past.
16691 When PREFER is `future', return a date that is either CURRENT or future.
16692 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16693 ;; Make the proper lists from the dates
16694 (catch 'exit
16695 (let ((a1 '(("h" . hour)
16696 ("d" . day)
16697 ("w" . week)
16698 ("m" . month)
16699 ("y" . year)))
16700 (shour (nth 2 (org-parse-time-string start)))
16701 dn dw sday cday n1 n2 n0
16702 d m y y1 y2 date1 date2 nmonths nm ny m2)
16704 (setq start (org-date-to-gregorian start)
16705 current (org-date-to-gregorian
16706 (if show-all
16707 current
16708 (time-to-days (current-time))))
16709 sday (calendar-absolute-from-gregorian start)
16710 cday (calendar-absolute-from-gregorian current))
16712 (if (<= cday sday) (throw 'exit sday))
16715 (setq dn (string-to-number (match-string 1 change))
16716 dw (cdr (assoc (match-string 2 change) a1)))
16717 (error "Invalid change specifier: %s" change))
16718 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16719 (cond
16720 ((eq dw 'hour)
16721 (let ((missing-hours
16722 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16723 dn)))
16724 (setq n1 (if (zerop missing-hours) cday
16725 (- cday (1+ (floor (/ missing-hours 24)))))
16726 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16727 ((eq dw 'day)
16728 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16729 n2 (+ n1 dn)))
16730 ((eq dw 'year)
16731 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16732 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16733 (setq date1 (list m d y1)
16734 n1 (calendar-absolute-from-gregorian date1)
16735 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16736 n2 (calendar-absolute-from-gregorian date2)))
16737 ((eq dw 'month)
16738 ;; approx number of month between the two dates
16739 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16740 ;; How often does dn fit in there?
16741 (setq d (nth 1 start) m (car start) y (nth 2 start)
16742 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16743 m (+ m nm)
16744 ny (floor (/ m 12))
16745 y (+ y ny)
16746 m (- m (* ny 12)))
16747 (while (> m 12) (setq m (- m 12) y (1+ y)))
16748 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16749 (setq m2 (+ m dn) y2 y)
16750 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16751 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16752 (while (<= n2 cday)
16753 (setq n1 n2 m m2 y y2)
16754 (setq m2 (+ m dn) y2 y)
16755 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16756 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16757 ;; Make sure n1 is the earlier date
16758 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16759 (if show-all
16760 (cond
16761 ((eq prefer 'past) (if (= cday n2) n2 n1))
16762 ((eq prefer 'future) (if (= cday n1) n1 n2))
16763 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16764 (cond
16765 ((eq prefer 'past) (if (= cday n2) n2 n1))
16766 ((eq prefer 'future) (if (= cday n1) n1 n2))
16767 (t (if (= cday n1) n1 n2)))))))
16769 (defun org-date-to-gregorian (date)
16770 "Turn any specification of DATE into a Gregorian date for the calendar."
16771 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16772 ((and (listp date) (= (length date) 3)) date)
16773 ((stringp date)
16774 (setq date (org-parse-time-string date))
16775 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16776 ((listp date)
16777 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16779 (defun org-parse-time-string (s &optional nodefault)
16780 "Parse the standard Org-mode time string.
16781 This should be a lot faster than the normal `parse-time-string'.
16782 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16783 hour and minute fields will be nil if not given."
16784 (cond ((string-match org-ts-regexp0 s)
16785 (list 0
16786 (if (or (match-beginning 8) (not nodefault))
16787 (string-to-number (or (match-string 8 s) "0")))
16788 (if (or (match-beginning 7) (not nodefault))
16789 (string-to-number (or (match-string 7 s) "0")))
16790 (string-to-number (match-string 4 s))
16791 (string-to-number (match-string 3 s))
16792 (string-to-number (match-string 2 s))
16793 nil nil nil))
16794 ((string-match "^<[^>]+>$" s)
16795 (decode-time (seconds-to-time (org-matcher-time s))))
16796 (t (error "Not a standard Org-mode time string: %s" s))))
16798 (defun org-timestamp-up (&optional arg)
16799 "Increase the date item at the cursor by one.
16800 If the cursor is on the year, change the year. If it is on the month,
16801 the day or the time, change that.
16802 With prefix ARG, change by that many units."
16803 (interactive "p")
16804 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16806 (defun org-timestamp-down (&optional arg)
16807 "Decrease the date item at the cursor by one.
16808 If the cursor is on the year, change the year. If it is on the month,
16809 the day or the time, change that.
16810 With prefix ARG, change by that many units."
16811 (interactive "p")
16812 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16814 (defun org-timestamp-up-day (&optional arg)
16815 "Increase the date in the time stamp by one day.
16816 With prefix ARG, change that many days."
16817 (interactive "p")
16818 (if (and (not (org-at-timestamp-p t))
16819 (org-at-heading-p))
16820 (org-todo 'up)
16821 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16823 (defun org-timestamp-down-day (&optional arg)
16824 "Decrease the date in the time stamp by one day.
16825 With prefix ARG, change that many days."
16826 (interactive "p")
16827 (if (and (not (org-at-timestamp-p t))
16828 (org-at-heading-p))
16829 (org-todo 'down)
16830 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16832 (defun org-at-timestamp-p (&optional inactive-ok)
16833 "Determine if the cursor is in or at a timestamp."
16834 (interactive)
16835 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16836 (pos (point))
16837 (ans (or (looking-at tsr)
16838 (save-excursion
16840 (if (> (point) (point-min)) (backward-char 1))
16841 (and (looking-at tsr)
16842 (> (- (match-end 0) pos) -1))))))
16843 (and ans
16844 (boundp 'org-ts-what)
16845 (setq org-ts-what
16846 (cond
16847 ((= pos (match-beginning 0)) 'bracket)
16848 ;; Point is considered to be "on the bracket" whether
16849 ;; it's really on it or right after it.
16850 ((= pos (1- (match-end 0))) 'bracket)
16851 ((= pos (match-end 0)) 'after)
16852 ((org-pos-in-match-range pos 2) 'year)
16853 ((org-pos-in-match-range pos 3) 'month)
16854 ((org-pos-in-match-range pos 7) 'hour)
16855 ((org-pos-in-match-range pos 8) 'minute)
16856 ((or (org-pos-in-match-range pos 4)
16857 (org-pos-in-match-range pos 5)) 'day)
16858 ((and (> pos (or (match-end 8) (match-end 5)))
16859 (< pos (match-end 0)))
16860 (- pos (or (match-end 8) (match-end 5))))
16861 (t 'day))))
16862 ans))
16864 (defun org-toggle-timestamp-type ()
16865 "Toggle the type (<active> or [inactive]) of a time stamp."
16866 (interactive)
16867 (when (org-at-timestamp-p t)
16868 (let ((beg (match-beginning 0)) (end (match-end 0))
16869 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16870 (save-excursion
16871 (goto-char beg)
16872 (while (re-search-forward "[][<>]" end t)
16873 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16874 t t)))
16875 (message "Timestamp is now %sactive"
16876 (if (equal (char-after beg) ?<) "" "in")))))
16878 (defun org-at-clock-log-p nil
16879 "Is the cursor on the clock log line?"
16880 (save-excursion
16881 (move-beginning-of-line 1)
16884 (defvar org-clock-history) ; defined in org-clock.el
16885 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16886 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
16887 "Change the date in the time stamp at point.
16888 The date will be changed by N times WHAT. WHAT can be `day', `month',
16889 `year', `minute', `second'. If WHAT is not given, the cursor position
16890 in the timestamp determines what will be changed.
16892 (let ((origin (point)) origin-cat
16893 with-hm inactive
16894 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16895 org-ts-what
16896 extra rem
16897 ts time time0 fixnext clrgx)
16898 (if (not (org-at-timestamp-p t))
16899 (error "Not at a timestamp"))
16900 (if (and (not what) (eq org-ts-what 'bracket))
16901 (org-toggle-timestamp-type)
16902 ;; Point isn't on brackets. Remember the part of the time-stamp
16903 ;; the point was in. Indeed, size of time-stamps may change,
16904 ;; but point must be kept in the same category nonetheless.
16905 (setq origin-cat org-ts-what)
16906 (if (and (not what) (not (eq org-ts-what 'day))
16907 org-display-custom-times
16908 (get-text-property (point) 'display)
16909 (not (get-text-property (1- (point)) 'display)))
16910 (setq org-ts-what 'day))
16911 (setq org-ts-what (or what org-ts-what)
16912 inactive (= (char-after (match-beginning 0)) ?\[)
16913 ts (match-string 0))
16914 (replace-match "")
16915 (when (string-match
16916 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
16917 ts)
16918 (setq extra (match-string 1 ts))
16919 (if suppress-tmp-delay
16920 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
16922 (setq with-hm t))
16923 (setq time0 (org-parse-time-string ts))
16924 (when (and updown
16925 (eq org-ts-what 'minute)
16926 (not current-prefix-arg))
16927 ;; This looks like s-up and s-down. Change by one rounding step.
16928 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16929 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16930 (setcar (cdr time0) (+ (nth 1 time0)
16931 (if (> n 0) (- rem) (- dm rem))))))
16932 (setq time
16933 (encode-time (or (car time0) 0)
16934 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16935 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16936 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16937 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16938 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16939 (nthcdr 6 time0)))
16940 (when (and (member org-ts-what '(hour minute))
16941 extra
16943 (setq extra (org-modify-ts-extra
16944 extra
16945 (if (eq org-ts-what 'hour) 2 5)
16946 n dm)))
16947 (when (integerp org-ts-what)
16948 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16949 (if (eq what 'calendar)
16950 (let ((cal-date (org-get-date-from-calendar)))
16951 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16952 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16953 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16954 (setcar time0 (or (car time0) 0))
16955 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16956 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16957 (setq time (apply 'encode-time time0))))
16958 ;; Insert the new time-stamp, and ensure point stays in the same
16959 ;; category as before (i.e. not after the last position in that
16960 ;; category).
16961 (let ((pos (point)))
16962 ;; Stay before inserted string. `save-excursion' is of no use.
16963 (setq org-last-changed-timestamp
16964 (org-insert-time-stamp time with-hm inactive nil nil extra))
16965 (goto-char pos))
16966 (save-match-data
16967 (looking-at org-ts-regexp3)
16968 (goto-char (cond
16969 ;; `day' category ends before `hour' if any, or at
16970 ;; the end of the day name.
16971 ((eq origin-cat 'day)
16972 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16973 ((eq origin-cat 'hour) (min (match-end 7) origin))
16974 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16975 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16976 ;; `year' and `month' have both fixed size: point
16977 ;; couldn't have moved into another part.
16978 (t origin))))
16979 ;; Update clock if on a CLOCK line.
16980 (org-clock-update-time-maybe)
16981 ;; Maybe adjust the closest clock in `org-clock-history'
16982 (when org-clock-adjust-closest
16983 (if (not (and (org-at-clock-log-p)
16984 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16985 org-clock-history))))))
16986 (message "No clock to adjust")
16987 (cond ((save-excursion ; fix previous clock?
16988 (re-search-backward org-ts-regexp0 nil t)
16991 ((save-excursion ; fix next clock?
16992 (re-search-backward org-ts-regexp0 nil t)
16995 (save-window-excursion
16996 ;; Find closest clock to point, adjust the previous/next one in history
16997 (let* ((p (save-excursion (org-back-to-heading t)))
16998 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16999 (clfixnth
17000 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17001 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17002 (if (not clfixpos)
17003 (message "No clock to adjust")
17004 (save-excursion
17005 (org-goto-marker-or-bmk clfixpos)
17006 (org-show-subtree)
17007 (when (re-search-forward clrgx nil t)
17008 (goto-char (match-beginning 1))
17009 (let (org-clock-adjust-closest)
17010 (org-timestamp-change n org-ts-what updown))
17011 (message "Clock adjusted in %s for heading: %s"
17012 (file-name-nondirectory (buffer-file-name))
17013 (org-get-heading t t)))))))))
17014 ;; Try to recenter the calendar window, if any.
17015 (if (and org-calendar-follow-timestamp-change
17016 (get-buffer-window "*Calendar*" t)
17017 (memq org-ts-what '(day month year)))
17018 (org-recenter-calendar (time-to-days time))))))
17020 (defun org-modify-ts-extra (s pos n dm)
17021 "Change the different parts of the lead-time and repeat fields in timestamp."
17022 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17023 ng h m new rem)
17024 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17025 (cond
17026 ((or (org-pos-in-match-range pos 2)
17027 (org-pos-in-match-range pos 3))
17028 (setq m (string-to-number (match-string 3 s))
17029 h (string-to-number (match-string 2 s)))
17030 (if (org-pos-in-match-range pos 2)
17031 (setq h (+ h n))
17032 (setq n (* dm (org-no-warnings (signum n))))
17033 (when (not (= 0 (setq rem (% m dm))))
17034 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17035 (setq m (+ m n)))
17036 (if (< m 0) (setq m (+ m 60) h (1- h)))
17037 (if (> m 59) (setq m (- m 60) h (1+ h)))
17038 (setq h (min 24 (max 0 h)))
17039 (setq ng 1 new (format "-%02d:%02d" h m)))
17040 ((org-pos-in-match-range pos 6)
17041 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17042 ((org-pos-in-match-range pos 5)
17043 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17045 ((org-pos-in-match-range pos 9)
17046 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17047 ((org-pos-in-match-range pos 8)
17048 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17050 (when ng
17051 (setq s (concat
17052 (substring s 0 (match-beginning ng))
17053 new
17054 (substring s (match-end ng))))))
17055 s))
17057 (defun org-recenter-calendar (date)
17058 "If the calendar is visible, recenter it to DATE."
17059 (let ((cwin (get-buffer-window "*Calendar*" t)))
17060 (when cwin
17061 (let ((calendar-move-hook nil))
17062 (with-selected-window cwin
17063 (calendar-goto-date (if (listp date) date
17064 (calendar-gregorian-from-absolute date))))))))
17066 (defun org-goto-calendar (&optional arg)
17067 "Go to the Emacs calendar at the current date.
17068 If there is a time stamp in the current line, go to that date.
17069 A prefix ARG can be used to force the current date."
17070 (interactive "P")
17071 (let ((tsr org-ts-regexp) diff
17072 (calendar-move-hook nil)
17073 (calendar-view-holidays-initially-flag nil)
17074 (calendar-view-diary-initially-flag nil))
17075 (if (or (org-at-timestamp-p)
17076 (save-excursion
17077 (beginning-of-line 1)
17078 (looking-at (concat ".*" tsr))))
17079 (let ((d1 (time-to-days (current-time)))
17080 (d2 (time-to-days
17081 (org-time-string-to-time (match-string 1)))))
17082 (setq diff (- d2 d1))))
17083 (calendar)
17084 (calendar-goto-today)
17085 (if (and diff (not arg)) (calendar-forward-day diff))))
17087 (defun org-get-date-from-calendar ()
17088 "Return a list (month day year) of date at point in calendar."
17089 (with-current-buffer "*Calendar*"
17090 (save-match-data
17091 (calendar-cursor-to-date))))
17093 (defun org-date-from-calendar ()
17094 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17095 If there is already a time stamp at the cursor position, update it."
17096 (interactive)
17097 (if (org-at-timestamp-p t)
17098 (org-timestamp-change 0 'calendar)
17099 (let ((cal-date (org-get-date-from-calendar)))
17100 (org-insert-time-stamp
17101 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17103 (defcustom org-effort-durations
17104 `(("h" . 60)
17105 ("d" . ,(* 60 8))
17106 ("w" . ,(* 60 8 5))
17107 ("m" . ,(* 60 8 5 4))
17108 ("y" . ,(* 60 8 5 40)))
17109 "Conversion factor to minutes for an effort modifier.
17111 Each entry has the form (MODIFIER . MINUTES).
17113 In an effort string, a number followed by MODIFIER is multiplied
17114 by the specified number of MINUTES to obtain an effort in
17115 minutes.
17119 :group 'org-agenda
17120 :version "24.1"
17121 :type '(alist :key-type (string :tag "Modifier")
17122 :value-type (number :tag "Minutes")))
17124 (defun org-minutes-to-clocksum-string (m)
17125 "Format number of minutes as a clocksum string.
17126 The format is determined by `org-time-clocksum-format',
17127 `org-time-clocksum-use-fractional' and
17128 `org-time-clocksum-fractional-format' and
17129 `org-time-clocksum-use-effort-durations'."
17130 (let ((clocksum "") h d w mo y fmt n)
17131 (setq h (if org-time-clocksum-use-effort-durations
17132 (cdr (assoc "h" org-effort-durations)) 60)
17133 d (if org-time-clocksum-use-effort-durations
17134 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17135 w (if org-time-clocksum-use-effort-durations
17136 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17137 mo (if org-time-clocksum-use-effort-durations
17138 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17139 y (if org-time-clocksum-use-effort-durations
17140 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17141 ;; fractional format
17142 (if org-time-clocksum-use-fractional
17143 (cond
17144 ;; single format string
17145 ((stringp org-time-clocksum-fractional-format)
17146 (format org-time-clocksum-fractional-format (/ m (float h))))
17147 ;; choice of fractional formats for different time units
17148 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17149 (> (/ (truncate m) (* y d h)) 0))
17150 (format fmt (/ m (* y d (float h)))))
17151 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17152 (> (/ (truncate m) (* mo d h)) 0))
17153 (format fmt (/ m (* mo d (float h)))))
17154 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17155 (> (/ (truncate m) (* w d h)) 0))
17156 (format fmt (/ m (* w d (float h)))))
17157 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17158 (> (/ (truncate m) (* d h)) 0))
17159 (format fmt (/ m (* d (float h)))))
17160 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17161 (> (/ (truncate m) h) 0))
17162 (format fmt (/ m (float h))))
17163 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17164 (format fmt m))
17165 ;; fall back to smallest time unit with a format
17166 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17167 (format fmt (/ m (float h))))
17168 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17169 (format fmt (/ m (* d (float h)))))
17170 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17171 (format fmt (/ m (* w d (float h)))))
17172 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17173 (format fmt (/ m (* mo d (float h)))))
17174 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17175 (format fmt (/ m (* y d (float h))))))
17176 ;; standard (non-fractional) format, with single format string
17177 (if (stringp org-time-clocksum-format)
17178 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17179 ;; separate formats components
17180 (and (setq fmt (plist-get org-time-clocksum-format :years))
17181 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17182 (plist-get org-time-clocksum-format :require-years))
17183 (setq clocksum (concat clocksum (format fmt n))
17184 m (- m (* n y d h))))
17185 (and (setq fmt (plist-get org-time-clocksum-format :months))
17186 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17187 (plist-get org-time-clocksum-format :require-months))
17188 (setq clocksum (concat clocksum (format fmt n))
17189 m (- m (* n mo d h))))
17190 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17191 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17192 (plist-get org-time-clocksum-format :require-weeks))
17193 (setq clocksum (concat clocksum (format fmt n))
17194 m (- m (* n w d h))))
17195 (and (setq fmt (plist-get org-time-clocksum-format :days))
17196 (or (> (setq n (/ (truncate m) (* d h))) 0)
17197 (plist-get org-time-clocksum-format :require-days))
17198 (setq clocksum (concat clocksum (format fmt n))
17199 m (- m (* n d h))))
17200 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17201 (or (> (setq n (/ (truncate m) h)) 0)
17202 (plist-get org-time-clocksum-format :require-hours))
17203 (setq clocksum (concat clocksum (format fmt n))
17204 m (- m (* n h))))
17205 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17206 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17207 (setq clocksum (concat clocksum (format fmt m))))
17208 ;; return formatted time duration
17209 clocksum))))
17211 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17212 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17213 "Org mode version 8.0")
17215 (defun org-hours-to-clocksum-string (n)
17216 (org-minutes-to-clocksum-string (* n 60)))
17218 (defun org-hh:mm-string-to-minutes (s)
17219 "Convert a string H:MM to a number of minutes.
17220 If the string is just a number, interpret it as minutes.
17221 In fact, the first hh:mm or number in the string will be taken,
17222 there can be extra stuff in the string.
17223 If no number is found, the return value is 0."
17224 (cond
17225 ((integerp s) s)
17227 (+ (* (string-to-number (match-string 1 s)) 60)
17228 (string-to-number (match-string 2 s))))
17230 (string-to-number (match-string 1 s)))
17231 (t 0)))
17233 (defcustom org-image-actual-width t
17234 "Should we use the actual width of images when inlining them?
17236 When set to `t', always use the image width.
17238 When set to a number, use imagemagick (when available) to set
17239 the image's width to this value.
17241 When set to a number in a list, try to get the width from the
17242 #+ATTR.* keyword if it matches a width specification like
17245 When set to nil, try to get the width from an #+ATTR.* keyword
17246 and fall back on the original width if none is found.
17248 This requires Emacs >= 24.1, build with imagemagick support."
17249 :group 'org-appearance
17250 :version "24.3"
17251 :type '(choice
17252 (const :tag "Use the image width" t)
17253 (integer :tag "Use a number of pixels")
17254 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17255 (const :tag "Use #+ATTR* or don't resize" nil)))
17257 (defcustom org-agenda-inhibit-startup t
17258 "Inhibit startup when preparing agenda buffers.
17259 When this variable is `t' (the default), the initialization of
17260 the Org agenda buffers is inhibited: e.g. the visibility state
17261 is not set, the tables are not re-aligned, etc."
17262 :type 'boolean
17263 :version "24.3"
17264 :group 'org-agenda)
17266 (defun org-duration-string-to-minutes (s &optional output-to-string)
17267 "Convert a duration string S to minutes.
17269 A bare number is interpreted as minutes, modifiers can be set by
17270 customizing `org-effort-durations' (which see).
17272 Entries containing a colon are interpreted as H:MM by
17273 `org-hh:mm-string-to-minutes'."
17274 (let ((result 0)
17276 (regexp-opt (mapcar 'car org-effort-durations))
17278 (while (string-match re s)
17279 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17280 (string-to-number (match-string 1 s))))
17281 (setq s (replace-match "" nil t s)))
17282 (setq result (floor result))
17283 (incf result (org-hh:mm-string-to-minutes s))
17284 (if output-to-string (number-to-string result) result)))
17286 ;;;; Files
17288 (defun org-save-all-org-buffers ()
17289 "Save all Org-mode buffers without user confirmation."
17290 (interactive)
17291 (message "Saving all Org-mode buffers...")
17292 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17293 (when (featurep 'org-id) (org-id-locations-save))
17294 (message "Saving all Org-mode buffers... done"))
17296 (defun org-revert-all-org-buffers ()
17297 "Revert all Org-mode buffers.
17298 Prompt for confirmation when there are unsaved changes.
17299 Be sure you know what you are doing before letting this function
17300 overwrite your changes.
17302 This function is useful in a setup where one tracks org files
17303 with a version control system, to revert on one machine after pulling
17304 changes from another. I believe the procedure must be like this:
17306 1. M-x org-save-all-org-buffers
17307 2. Pull changes from the other machine, resolve conflicts
17308 3. M-x org-revert-all-org-buffers"
17309 (interactive)
17310 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17311 (error "Abort"))
17312 (save-excursion
17313 (save-window-excursion
17314 (mapc
17315 (lambda (b)
17316 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17317 (with-current-buffer b buffer-file-name))
17318 (org-pop-to-buffer-same-window b)
17319 (revert-buffer t 'no-confirm)))
17320 (buffer-list))
17321 (when (and (featurep 'org-id) org-id-track-globally)
17322 (org-id-locations-load)))))
17324 ;;;; Agenda files
17326 ;;;###autoload
17327 (defun org-switchb (&optional arg)
17328 "Switch between Org buffers.
17329 With one prefix argument, restrict available buffers to files.
17330 With two prefix arguments, restrict available buffers to agenda files.
17332 Defaults to `iswitchb' for buffer name completion.
17333 Set `org-completion-use-ido' to make it use ido instead."
17334 (interactive "P")
17335 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17336 ((equal arg '(16)) (org-buffer-list 'agenda))
17337 (t (org-buffer-list))))
17338 (org-completion-use-iswitchb org-completion-use-iswitchb)
17339 (org-completion-use-ido org-completion-use-ido))
17340 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17341 (setq org-completion-use-iswitchb t))
17342 (org-pop-to-buffer-same-window
17343 (org-icompleting-read "Org buffer: "
17344 (mapcar 'list (mapcar 'buffer-name blist))
17345 nil t))))
17347 ;;; Define some older names previously used for this functionality
17348 ;;;###autoload
17349 (defalias 'org-ido-switchb 'org-switchb)
17350 ;;;###autoload
17351 (defalias 'org-iswitchb 'org-switchb)
17353 (defun org-buffer-list (&optional predicate exclude-tmp)
17354 "Return a list of Org buffers.
17355 PREDICATE can be `export', `files' or `agenda'.
17357 export restrict the list to Export buffers.
17358 files restrict the list to buffers visiting Org files.
17359 agenda restrict the list to buffers visiting agenda files.
17361 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17362 (let* ((bfn nil)
17363 (agenda-files (and (eq predicate 'agenda)
17364 (mapcar 'file-truename (org-agenda-files t))))
17365 (filter
17366 (cond
17367 ((eq predicate 'files)
17368 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17369 ((eq predicate 'export)
17370 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17371 ((eq predicate 'agenda)
17372 (lambda (b)
17373 (with-current-buffer b
17374 (and (derived-mode-p 'org-mode)
17375 (setq bfn (buffer-file-name b))
17376 (member (file-truename bfn) agenda-files)))))
17377 (t (lambda (b) (with-current-buffer b
17378 (or (derived-mode-p 'org-mode)
17379 (string-match "\*Org .*Export"
17380 (buffer-name b)))))))))
17381 (delq nil
17382 (mapcar
17383 (lambda(b)
17384 (if (and (funcall filter b)
17385 (or (not exclude-tmp)
17386 (not (string-match "tmp" (buffer-name b)))))
17387 b
17388 nil))
17389 (buffer-list)))))
17391 (defun org-agenda-files (&optional unrestricted archives)
17392 "Get the list of agenda files.
17393 Optional UNRESTRICTED means return the full list even if a restriction
17394 is currently in place.
17395 When ARCHIVES is t, include all archive files that are really being
17396 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17397 `org-agenda-archives-mode' is t."
17398 (let ((files
17399 (cond
17400 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17401 ((stringp org-agenda-files) (org-read-agenda-file-list))
17402 ((listp org-agenda-files) org-agenda-files)
17403 (t (error "Invalid value of `org-agenda-files'")))))
17404 (setq files (apply 'append
17405 (mapcar (lambda (f)
17406 (if (file-directory-p f)
17407 (directory-files
17408 f t org-agenda-file-regexp)
17409 (list f)))
17410 files)))
17411 (when org-agenda-skip-unavailable-files
17412 (setq files (delq nil
17413 (mapcar (function
17414 (lambda (file)
17415 (and (file-readable-p file) file)))
17416 files))))
17417 (when (or (eq archives t)
17418 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17419 (setq files (org-add-archive-files files)))
17420 files))
17422 (defun org-agenda-file-p (&optional file)
17423 "Return non-nil, if FILE is an agenda file.
17424 If FILE is omitted, use the file associated with the current
17425 buffer."
17426 (member (or file (buffer-file-name))
17427 (org-agenda-files t)))
17429 (defun org-edit-agenda-file-list ()
17430 "Edit the list of agenda files.
17431 Depending on setup, this either uses customize to edit the variable
17432 `org-agenda-files', or it visits the file that is holding the list. In the
17433 latter case, the buffer is set up in a way that saving it automatically kills
17434 the buffer and restores the previous window configuration."
17435 (interactive)
17436 (if (stringp org-agenda-files)
17437 (let ((cw (current-window-configuration)))
17438 (find-file org-agenda-files)
17439 (org-set-local 'org-window-configuration cw)
17440 (org-add-hook 'after-save-hook
17441 (lambda ()
17442 (set-window-configuration
17443 (prog1 org-window-configuration
17444 (kill-buffer (current-buffer))))
17445 (org-install-agenda-files-menu)
17446 (message "New agenda file list installed"))
17447 nil 'local)
17448 (message "%s" (substitute-command-keys
17450 (customize-variable 'org-agenda-files)))
17452 (defun org-store-new-agenda-file-list (list)
17453 "Set new value for the agenda file list and save it correctly."
17454 (if (stringp org-agenda-files)
17455 (let ((fe (org-read-agenda-file-list t)) b u)
17456 (while (setq b (find-buffer-visiting org-agenda-files))
17457 (kill-buffer b))
17458 (with-temp-file org-agenda-files
17459 (insert
17460 (mapconcat
17461 (lambda (f) ;; Keep un-expanded entries.
17462 (if (setq u (assoc f fe))
17463 (cdr u)
17464 f))
17467 (let ((org-mode-hook nil) (org-inhibit-startup t)
17468 (org-insert-mode-line-in-empty-file nil))
17469 (setq org-agenda-files list)
17470 (customize-save-variable 'org-agenda-files org-agenda-files))))
17472 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17473 "Read the list of agenda files from a file.
17474 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17475 filenames, used by `org-store-new-agenda-file-list' to write back
17476 un-expanded file names."
17477 (when (file-directory-p org-agenda-files)
17478 (error "`org-agenda-files' cannot be a single directory"))
17479 (when (stringp org-agenda-files)
17480 (with-temp-buffer
17481 (insert-file-contents org-agenda-files)
17482 (mapcar
17483 (lambda (f)
17484 (let ((e (expand-file-name (substitute-in-file-name f)
17485 org-directory)))
17486 (if pair-with-expansion
17487 (cons e f)
17488 e)))
17491 ;;;###autoload
17492 (defun org-cycle-agenda-files ()
17493 "Cycle through the files in `org-agenda-files'.
17494 If the current buffer visits an agenda file, find the next one in the list.
17495 If the current buffer does not, find the first agenda file."
17496 (interactive)
17497 (let* ((fs (org-agenda-files t))
17498 (files (append fs (list (car fs))))
17499 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17500 file)
17501 (unless files (error "No agenda files"))
17502 (catch 'exit
17503 (while (setq file (pop files))
17504 (if (equal (file-truename file) tcf)
17505 (when (car files)
17506 (find-file (car files))
17507 (throw 'exit t))))
17508 (find-file (car fs)))
17509 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17511 (defun org-agenda-file-to-front (&optional to-end)
17512 "Move/add the current file to the top of the agenda file list.
17513 If the file is not present in the list, it is added to the front. If it is
17514 present, it is moved there. With optional argument TO-END, add/move to the
17515 end of the list."
17516 (interactive "P")
17517 (let ((org-agenda-skip-unavailable-files nil)
17518 (file-alist (mapcar (lambda (x)
17519 (cons (file-truename x) x))
17520 (org-agenda-files t)))
17521 (ctf (file-truename
17522 (or buffer-file-name
17523 (error "Please save the current buffer to a file"))))
17524 x had)
17525 (setq x (assoc ctf file-alist) had x)
17527 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17528 (if to-end
17529 (setq file-alist (append (delq x file-alist) (list x)))
17530 (setq file-alist (cons x (delq x file-alist))))
17531 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17532 (org-install-agenda-files-menu)
17533 (message "File %s to %s of agenda file list"
17534 (if had "moved" "added") (if to-end "end" "front"))))
17536 (defun org-remove-file (&optional file)
17537 "Remove current file from the list of files in variable `org-agenda-files'.
17538 These are the files which are being checked for agenda entries.
17539 Optional argument FILE means use this file instead of the current."
17540 (interactive)
17541 (let* ((org-agenda-skip-unavailable-files nil)
17542 (file (or file buffer-file-name
17543 (error "Current buffer does not visit a file")))
17544 (true-file (file-truename file))
17545 (afile (abbreviate-file-name file))
17546 (files (delq nil (mapcar
17547 (lambda (x)
17548 (if (equal true-file
17549 (file-truename x))
17550 nil x))
17551 (org-agenda-files t)))))
17552 (if (not (= (length files) (length (org-agenda-files t))))
17553 (progn
17554 (org-store-new-agenda-file-list files)
17555 (org-install-agenda-files-menu)
17556 (message "Removed file: %s" afile))
17557 (message "File was not in list: %s (not removed)" afile))))
17559 (defun org-file-menu-entry (file)
17560 (vector file (list 'find-file file) t))
17562 (defun org-check-agenda-file (file)
17563 "Make sure FILE exists. If not, ask user what to do."
17564 (when (not (file-exists-p file))
17565 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17566 (abbreviate-file-name file))
17567 (let ((r (downcase (read-char-exclusive))))
17568 (cond
17569 ((equal r ?r)
17570 (org-remove-file file)
17571 (throw 'nextfile t))
17572 (t (error "Abort"))))))
17574 (defun org-get-agenda-file-buffer (file)
17575 "Get a buffer visiting FILE. If the buffer needs to be created, add
17576 it to the list of buffers which might be released later."
17577 (let ((buf (org-find-base-buffer-visiting file)))
17578 (if buf
17579 buf ; just return it
17580 ;; Make a new buffer and remember it
17581 (setq buf (find-file-noselect file))
17582 (if buf (push buf org-agenda-new-buffers))
17583 buf)))
17585 (defun org-release-buffers (blist)
17586 "Release all buffers in list, asking the user for confirmation when needed.
17587 When a buffer is unmodified, it is just killed. When modified, it is saved
17588 \(if the user agrees) and then killed."
17589 (let (buf file)
17590 (while (setq buf (pop blist))
17591 (setq file (buffer-file-name buf))
17592 (when (and (buffer-modified-p buf)
17593 file
17594 (y-or-n-p (format "Save file %s? " file)))
17595 (with-current-buffer buf (save-buffer)))
17596 (kill-buffer buf))))
17598 (defun org-agenda-prepare-buffers (files)
17599 "Create buffers for all agenda files, protect archived trees and comments."
17600 (interactive)
17601 (let ((pa '(:org-archived t))
17602 (pc '(:org-comment t))
17603 (pall '(:org-archived t :org-comment t))
17604 (inhibit-read-only t)
17605 (org-inhibit-startup org-agenda-inhibit-startup)
17606 (rea (concat ":" org-archive-tag ":"))
17607 file re)
17608 (save-excursion
17609 (save-restriction
17610 (while (setq file (pop files))
17611 (catch 'nextfile
17612 (if (bufferp file)
17613 (set-buffer file)
17614 (org-check-agenda-file file)
17615 (set-buffer (org-get-agenda-file-buffer file)))
17616 (widen)
17617 (org-refresh-category-properties)
17618 (org-refresh-properties org-effort-property 'org-effort)
17619 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17620 (setq org-todo-keywords-for-agenda
17621 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17622 (setq org-done-keywords-for-agenda
17623 (append org-done-keywords-for-agenda org-done-keywords))
17624 (setq org-todo-keyword-alist-for-agenda
17625 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17626 (setq org-drawers-for-agenda
17627 (append org-drawers-for-agenda org-drawers))
17628 (setq org-tag-alist-for-agenda
17629 (append org-tag-alist-for-agenda org-tag-alist))
17630 (org-with-silent-modifications
17631 (save-excursion
17632 (remove-text-properties (point-min) (point-max) pall)
17633 (when org-agenda-skip-archived-trees
17634 (goto-char (point-min))
17635 (while (re-search-forward rea nil t)
17636 (if (org-at-heading-p t)
17637 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17638 (goto-char (point-min))
17639 (setq re (format org-heading-keyword-regexp-format
17640 org-comment-string))
17641 (while (re-search-forward re nil t)
17642 (add-text-properties
17643 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17644 (setq org-todo-keywords-for-agenda
17645 (org-uniquify org-todo-keywords-for-agenda))
17646 (setq org-todo-keyword-alist-for-agenda
17647 (org-uniquify org-todo-keyword-alist-for-agenda)
17648 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17650 \f
17651 ;;;; CDLaTeX minor mode
17653 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17654 "Keymap for the minor `org-cdlatex-mode'.")
17656 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17657 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17658 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17659 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17660 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17662 (defvar org-cdlatex-texmathp-advice-is-done nil
17663 "Flag remembering if we have applied the advice to texmathp already.")
17665 (define-minor-mode org-cdlatex-mode
17666 "Toggle the minor `org-cdlatex-mode'.
17667 This mode supports entering LaTeX environment and math in LaTeX fragments
17668 in Org-mode.
17670 nil " OCDL" nil
17671 (when org-cdlatex-mode
17672 (require 'cdlatex)
17673 (run-hooks 'cdlatex-mode-hook)
17674 (cdlatex-compute-tables))
17675 (unless org-cdlatex-texmathp-advice-is-done
17676 (setq org-cdlatex-texmathp-advice-is-done t)
17677 (defadvice texmathp (around org-math-always-on activate)
17678 "Always return t in org-mode buffers.
17679 This is because we want to insert math symbols without dollars even outside
17680 the LaTeX math segments. If Orgmode thinks that point is actually inside
17681 an embedded LaTeX fragment, let texmathp do its job.
17683 (interactive)
17684 (let (p)
17685 (cond
17686 ((not (derived-mode-p 'org-mode)) ad-do-it)
17687 ((eq this-command 'cdlatex-math-symbol)
17688 (setq ad-return-value t
17689 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17690 (t
17691 (let ((p (org-inside-LaTeX-fragment-p)))
17692 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17693 (setq ad-return-value t
17694 texmathp-why '("Org-mode embedded math" . 0))
17695 (if p ad-do-it)))))))))
17697 (defun turn-on-org-cdlatex ()
17698 "Unconditionally turn on `org-cdlatex-mode'."
17699 (org-cdlatex-mode 1))
17701 (defun org-try-cdlatex-tab ()
17702 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17703 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17704 - inside a LaTeX fragment, or
17705 - after the first word in a line, where an abbreviation expansion could
17706 insert a LaTeX environment."
17707 (when org-cdlatex-mode
17708 (cond
17709 ;; Before any word on the line: No expansion possible.
17711 ;; Just after first word on the line: Expand it. Make sure it
17712 ;; cannot happen on headlines, though.
17713 ((save-excursion
17714 (skip-chars-backward "a-zA-Z0-9*")
17716 (and (bolp) (not (org-at-heading-p))))
17717 (cdlatex-tab) t)
17718 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17720 (defun org-cdlatex-underscore-caret (&optional arg)
17721 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17722 Revert to the normal definition outside of these fragments."
17723 (interactive "P")
17724 (if (org-inside-LaTeX-fragment-p)
17725 (call-interactively 'cdlatex-sub-superscript)
17726 (let (org-cdlatex-mode)
17727 (call-interactively (key-binding (vector last-input-event))))))
17729 (defun org-cdlatex-math-modify (&optional arg)
17730 "Execute `cdlatex-math-modify' in LaTeX fragments.
17731 Revert to the normal definition outside of these fragments."
17732 (interactive "P")
17733 (if (org-inside-LaTeX-fragment-p)
17734 (call-interactively 'cdlatex-math-modify)
17735 (let (org-cdlatex-mode)
17736 (call-interactively (key-binding (vector last-input-event))))))
17739 \f
17740 ;;;; LaTeX fragments
17742 (defvar org-latex-regexps
17744 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17747 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17751 "Regular expressions for matching embedded LaTeX.")
17753 (defun org-inside-LaTeX-fragment-p ()
17754 "Test if point is inside a LaTeX fragment.
17756 sequence appearing also before point.
17757 Even though the matchers for math are configurable, this function assumes
17759 delimiters are skipped when they have been removed by customization.
17760 The return value is nil, or a cons cell with the delimiter and the
17761 position of this delimiter.
17763 This function does a reasonably good job, but can locally be fooled by
17764 for example currency specifications. For example it will assume being in
17766 fragments that are properly closed, but during editing, we have to live
17767 with the uncertainty caused by missing closing delimiters. This function
17768 looks only before point, not after."
17769 (catch 'exit
17770 (let ((pos (point))
17771 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17772 (lim (progn
17774 (point)))
17775 dd-on str (start 0) m re)
17776 (goto-char pos)
17777 (when dodollar
17779 re (nth 1 (assoc "$" org-latex-regexps)))
17780 (while (string-match re str start)
17781 (cond
17782 ((= (match-end 0) (length str))
17783 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17784 ((= (match-end 0) (- (length str) 5))
17785 (throw 'exit nil))
17786 (t (setq start (match-end 0))))))
17787 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17788 (goto-char pos)
17789 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17790 (and (match-beginning 2) (throw 'exit nil))
17791 ;; count $$
17793 (setq dd-on (not dd-on)))
17794 (goto-char pos)
17795 (if dd-on (cons "$$" m))))))
17797 (defun org-inside-latex-macro-p ()
17798 "Is point inside a LaTeX macro or its arguments?"
17799 (save-match-data
17800 (org-in-regexp
17803 (defvar org-latex-fragment-image-overlays nil
17804 "List of overlays carrying the images of latex fragments.")
17805 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17807 (defun org-remove-latex-fragment-image-overlays ()
17808 "Remove all overlays with LaTeX fragment images in current buffer."
17809 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17810 (setq org-latex-fragment-image-overlays nil))
17812 (defun org-preview-latex-fragment (&optional subtree)
17813 "Preview the LaTeX fragment at point, or all locally or globally.
17814 If the cursor is in a LaTeX fragment, create the image and overlay
17815 it over the source code. If there is no fragment at point, display
17816 all fragments in the current text, from one headline to the next. With
17817 prefix SUBTREE, display all fragments in the current subtree. With a
17819 the cursor is before the first headline,
17820 display all fragments in the buffer.
17822 (interactive "P")
17823 (unless buffer-file-name
17824 (error "Can't preview LaTeX fragment in a non-file buffer"))
17825 (org-remove-latex-fragment-image-overlays)
17826 (save-excursion
17827 (save-restriction
17828 (let (beg end at msg)
17829 (cond
17830 ((or (equal subtree '(16))
17831 (not (save-excursion
17832 (re-search-backward org-outline-regexp-bol nil t))))
17833 (setq beg (point-min) end (point-max)
17834 msg "Creating images for buffer...%s"))
17835 ((equal subtree '(4))
17836 (org-back-to-heading)
17837 (setq beg (point) end (org-end-of-subtree t)
17838 msg "Creating images for subtree...%s"))
17839 (t
17840 (if (setq at (org-inside-LaTeX-fragment-p))
17841 (goto-char (max (point-min) (- (cdr at) 2)))
17842 (org-back-to-heading))
17843 (setq beg (point) end (progn (outline-next-heading) (point))
17844 msg (if at "Creating image...%s"
17845 "Creating images for entry...%s"))))
17846 (message msg "")
17847 (narrow-to-region beg end)
17848 (goto-char beg)
17849 (org-format-latex
17850 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17851 (file-name-nondirectory
17852 buffer-file-name)))
17853 default-directory 'overlays msg at 'forbuffer
17854 org-latex-create-formula-image-program)
17855 (message msg "done. Use `C-c C-c' to remove images.")))))
17857 (defun org-format-latex (prefix &optional dir overlays msg at
17858 forbuffer processing-type)
17859 "Replace LaTeX fragments with links to an image, and produce images.
17860 Some of the options can be changed using the variable
17861 `org-format-latex-options'."
17862 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17863 (let* ((prefixnodir (file-name-nondirectory prefix))
17864 (absprefix (expand-file-name prefix dir))
17865 (todir (file-name-directory absprefix))
17866 (opt org-format-latex-options)
17867 (optnew org-format-latex-options)
17868 (matchers (plist-get opt :matchers))
17869 (re-list org-latex-regexps)
17870 (cnt 0) txt hash link beg end re e checkdir
17871 string
17872 m n block-type block linkfile movefile ov)
17873 ;; Check the different regular expressions
17874 (while (setq e (pop re-list))
17875 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17877 (when (member m matchers)
17878 (goto-char (point-min))
17879 (while (re-search-forward re nil t)
17880 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17881 (or (not overlays)
17882 (not (eq (get-char-property (match-beginning n)
17883 'org-overlay-type)
17884 'org-latex-overlay))))
17885 (cond
17886 ((eq processing-type 'verbatim))
17887 ((eq processing-type 'mathjax)
17888 ;; Prepare for MathJax processing.
17889 (setq string (match-string n))
17890 (when (member m '("$" "$1"))
17891 (save-excursion
17892 (delete-region (match-beginning n) (match-end n))
17893 (goto-char (match-beginning n))
17895 ((or (eq processing-type 'dvipng)
17896 (eq processing-type 'imagemagick))
17897 ;; Process to an image.
17898 (setq txt (match-string n)
17899 beg (match-beginning n) end (match-end n)
17900 cnt (1+ cnt))
17901 (let ((face (face-at-point))
17902 (fg (plist-get opt :foreground))
17903 (bg (plist-get opt :background))
17904 ;; Ensure full list is printed.
17905 print-length print-level)
17906 (when forbuffer
17907 ;; Get the colors from the face at point.
17908 (goto-char beg)
17909 (when (eq fg 'auto)
17910 (setq fg (face-attribute face :foreground nil 'default)))
17911 (when (eq bg 'auto)
17912 (setq bg (face-attribute face :background nil 'default)))
17913 (setq optnew (copy-sequence opt))
17914 (plist-put optnew :foreground fg)
17915 (plist-put optnew :background bg))
17916 (setq hash (sha1 (prin1-to-string
17917 (list org-format-latex-header
17918 org-latex-default-packages-alist
17919 org-latex-packages-alist
17920 org-format-latex-options
17921 forbuffer txt fg bg)))
17922 linkfile (format "%s_%s.png" prefix hash)
17923 movefile (format "%s_%s.png" absprefix hash)))
17924 (setq link (concat block "[[file:" linkfile "]]" block))
17925 (if msg (message msg cnt))
17926 (goto-char beg)
17927 (unless checkdir ; Ensure the directory exists.
17928 (setq checkdir t)
17929 (or (file-directory-p todir) (make-directory todir t)))
17930 (unless (file-exists-p movefile)
17931 (org-create-formula-image
17932 txt movefile optnew forbuffer processing-type))
17933 (if overlays
17934 (progn
17935 (mapc (lambda (o)
17936 (if (eq (overlay-get o 'org-overlay-type)
17937 'org-latex-overlay)
17938 (delete-overlay o)))
17939 (overlays-in beg end))
17940 (setq ov (make-overlay beg end))
17941 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17942 (if (featurep 'xemacs)
17943 (progn
17944 (overlay-put ov 'invisible t)
17945 (overlay-put
17946 ov 'end-glyph
17947 (make-glyph (vector 'png :file movefile))))
17948 (overlay-put
17949 ov 'display
17950 (list 'image :type 'png :file movefile :ascent 'center)))
17951 (push ov org-latex-fragment-image-overlays)
17952 (goto-char end))
17953 (delete-region beg end)
17954 (insert (org-add-props link
17955 (list 'org-latex-src
17956 (replace-regexp-in-string
17958 'org-latex-src-embed-type
17959 (if block-type 'paragraph 'character))))))
17960 ((eq processing-type 'mathml)
17961 ;; Process to MathML
17962 (unless (save-match-data (org-format-latex-mathml-available-p))
17963 (error "LaTeX to MathML converter not configured"))
17964 (setq txt (match-string n)
17965 beg (match-beginning n) end (match-end n)
17966 cnt (1+ cnt))
17967 (if msg (message msg cnt))
17968 (goto-char beg)
17969 (delete-region beg end)
17970 (insert (org-format-latex-as-mathml
17971 txt block-type prefix dir)))
17972 (t
17973 (error "Unknown conversion type %s for latex fragments"
17974 processing-type)))))))))
17976 (defun org-create-math-formula (latex-frag &optional mathml-file)
17977 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17978 Use `org-latex-to-mathml-convert-command'. If the conversion is
17980 elements otherwise return nil. When MATHML-FILE is specified,
17981 write the results in to that file. When invoked as an
17982 interactive command, prompt for LATEX-FRAG, with initial value
17983 set to the current active region and echo the results for user
17984 inspection."
17985 (interactive (list (let ((frag (when (org-region-active-p)
17986 (buffer-substring-no-properties
17987 (region-beginning) (region-end)))))
17988 (read-string "LaTeX Fragment: " frag nil frag))))
17989 (unless latex-frag (error "Invalid latex-frag"))
17990 (let* ((tmp-in-file (file-relative-name
17991 (make-temp-name (expand-file-name "ltxmathml-in"))))
17992 (ignore (write-region latex-frag nil tmp-in-file))
17993 (tmp-out-file (file-relative-name
17994 (make-temp-name (expand-file-name "ltxmathml-out"))))
17995 (cmd (format-spec
17996 org-latex-to-mathml-convert-command
17997 `((?j . ,(shell-quote-argument
17998 (expand-file-name org-latex-to-mathml-jar-file)))
17999 (?I . ,(shell-quote-argument tmp-in-file))
18000 (?o . ,(shell-quote-argument tmp-out-file)))))
18001 mathml shell-command-output)
18002 (when (org-called-interactively-p 'any)
18003 (unless (org-format-latex-mathml-available-p)
18004 (error "LaTeX to MathML converter not configured")))
18005 (message "Running %s" cmd)
18006 (setq shell-command-output (shell-command-to-string cmd))
18007 (setq mathml
18008 (when (file-readable-p tmp-out-file)
18009 (with-current-buffer (find-file-noselect tmp-out-file t)
18010 (goto-char (point-min))
18011 (when (re-search-forward
18012 (concat
18013 (regexp-quote
18016 (regexp-quote "</math>")) nil t)
18017 (prog1 (match-string 0) (kill-buffer))))))
18018 (cond
18019 (mathml
18020 (setq mathml
18022 (when mathml-file
18023 (write-region mathml nil mathml-file))
18024 (when (org-called-interactively-p 'any)
18025 (message mathml)))
18026 ((message "LaTeX to MathML conversion failed")
18027 (message shell-command-output)))
18028 (delete-file tmp-in-file)
18029 (when (file-exists-p tmp-out-file)
18030 (delete-file tmp-out-file))
18031 mathml))
18033 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18034 prefix &optional dir)
18035 "Use `org-create-math-formula' but check local cache first."
18036 (let* ((absprefix (expand-file-name prefix dir))
18037 (print-length nil) (print-level nil)
18038 (formula-id (concat
18039 "formula-"
18040 (sha1
18041 (prin1-to-string
18042 (list latex-frag
18043 org-latex-to-mathml-convert-command)))))
18044 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18045 (formula-cache-dir (file-name-directory formula-cache)))
18047 (unless (file-directory-p formula-cache-dir)
18048 (make-directory formula-cache-dir t))
18050 (unless (file-exists-p formula-cache)
18051 (org-create-math-formula latex-frag formula-cache))
18053 (if (file-exists-p formula-cache)
18054 ;; Successful conversion. Return the link to MathML file.
18055 (org-add-props
18056 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18058 'org-latex-src-embed-type (if latex-frag-type
18059 'paragraph 'character)))
18060 ;; Failed conversion. Return the LaTeX fragment verbatim
18061 latex-frag)))
18063 (defun org-create-formula-image (string tofile options buffer &optional type)
18064 "Create an image from LaTeX source using dvipng or convert.
18065 This function calls either `org-create-formula-image-with-dvipng'
18066 or `org-create-formula-image-with-imagemagick' depending on the
18067 value of `org-latex-create-formula-image-program' or on the value
18068 of the optional TYPE variable.
18070 Note: ultimately these two function should be combined as they
18071 share a good deal of logic."
18072 (org-check-external-command
18073 "latex" "needed to convert LaTeX fragments to images")
18074 (funcall
18075 (case (or type org-latex-create-formula-image-program)
18076 ('dvipng
18077 (org-check-external-command
18078 "dvipng" "needed to convert LaTeX fragments to images")
18079 #'org-create-formula-image-with-dvipng)
18080 ('imagemagick
18081 (org-check-external-command
18082 "convert" "you need to install imagemagick")
18083 #'org-create-formula-image-with-imagemagick)
18084 (t (error
18085 "invalid value of `org-latex-create-formula-image-program'")))
18086 string tofile options buffer))
18088 ;; This function borrows from Ganesh Swami's latex2png.el
18089 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18090 "This calls dvipng."
18091 (let* ((tmpdir (if (featurep 'xemacs)
18092 (temp-directory)
18093 temporary-file-directory))
18094 (texfilebase (make-temp-name
18095 (expand-file-name "orgtex" tmpdir)))
18096 (texfile (concat texfilebase ".tex"))
18097 (dvifile (concat texfilebase ".dvi"))
18098 (pngfile (concat texfilebase ".png"))
18099 (fnh (if (featurep 'xemacs)
18100 (font-height (face-font 'default))
18101 (face-attribute 'default :height nil)))
18102 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18103 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18104 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18105 "Black"))
18106 (bg (or (plist-get options (if buffer :background :html-background))
18107 "Transparent")))
18108 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18109 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18110 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18111 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18112 (with-temp-file texfile
18113 (require 'ox-latex)
18114 (insert (org-latex-guess-inputenc
18115 (org-splice-latex-header
18116 org-format-latex-header
18117 org-latex-default-packages-alist
18118 org-latex-packages-alist t)))
18120 (let ((dir default-directory))
18121 (condition-case nil
18122 (progn
18123 (cd tmpdir)
18124 (call-process "latex" nil nil nil texfile))
18125 (error nil))
18126 (cd dir))
18127 (if (not (file-exists-p dvifile))
18128 (progn (message "Failed to create dvi file from %s" texfile) nil)
18129 (condition-case nil
18130 (if (featurep 'xemacs)
18131 (call-process "dvipng" nil nil nil
18132 "-fg" fg "-bg" bg
18133 "-T" "tight"
18134 "-o" pngfile
18135 dvifile)
18136 (call-process "dvipng" nil nil nil
18137 "-fg" fg "-bg" bg
18138 "-D" dpi
18139 ;;"-x" scale "-y" scale
18140 "-T" "tight"
18141 "-o" pngfile
18142 dvifile))
18143 (error nil))
18144 (if (not (file-exists-p pngfile))
18145 (if org-format-latex-signal-error
18146 (error "Failed to create png file from %s" texfile)
18147 (message "Failed to create png file from %s" texfile)
18148 nil)
18149 ;; Use the requested file name and clean up
18150 (copy-file pngfile tofile 'replace)
18151 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18152 (if (file-exists-p (concat texfilebase e))
18153 (delete-file (concat texfilebase e))))
18154 pngfile))))
18156 (defvar org-latex-pdf-process) ; From ox-latex.el
18157 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18158 "This calls convert, which is included into imagemagick."
18159 (let* ((tmpdir (if (featurep 'xemacs)
18160 (temp-directory)
18161 temporary-file-directory))
18162 (texfilebase (make-temp-name
18163 (expand-file-name "orgtex" tmpdir)))
18164 (texfile (concat texfilebase ".tex"))
18165 (pdffile (concat texfilebase ".pdf"))
18166 (pngfile (concat texfilebase ".png"))
18167 (fnh (if (featurep 'xemacs)
18168 (font-height (face-font 'default))
18169 (face-attribute 'default :height nil)))
18170 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18171 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18172 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18173 "black"))
18174 (bg (or (plist-get options (if buffer :background :html-background))
18175 "white")))
18176 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18177 (setq fg (org-latex-color-format fg)))
18178 (if (eq bg 'default) (setq bg (org-latex-color :background))
18179 (setq bg (org-latex-color-format
18180 (if (string= bg "Transparent") "white" bg))))
18181 (with-temp-file texfile
18182 (require 'ox-latex)
18183 (insert (org-latex-guess-inputenc
18184 (org-splice-latex-header
18185 org-format-latex-header
18186 org-latex-default-packages-alist
18187 org-latex-packages-alist t)))
18193 string
18196 (let ((dir default-directory) cmd cmds latex-frags-cmds)
18197 (condition-case nil
18198 (progn
18199 (cd tmpdir)
18200 (setq cmds org-latex-pdf-process)
18201 (while cmds
18202 (setq latex-frags-cmds (pop cmds))
18203 (if (listp latex-frags-cmds)
18204 (setq cmds nil)
18205 (setq latex-frags-cmds (list (car org-latex-pdf-process)))))
18206 (while latex-frags-cmds
18207 (setq cmd (pop latex-frags-cmds))
18208 (while (string-match "%b" cmd)
18209 (setq cmd (replace-match
18210 (save-match-data
18211 (shell-quote-argument texfile))
18212 t t cmd)))
18213 (while (string-match "%f" cmd)
18214 (setq cmd (replace-match
18215 (save-match-data
18216 (shell-quote-argument
18217 (file-name-nondirectory texfile)))
18218 t t cmd)))
18219 (while (string-match "%o" cmd)
18220 (setq cmd (replace-match
18221 (save-match-data
18222 (shell-quote-argument
18223 (file-name-directory texfile)))
18224 t t cmd)))
18225 (setq cmd (split-string cmd))
18226 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
18227 (error nil))
18228 (cd dir))
18229 (if (not (file-exists-p pdffile))
18230 (progn (message "Failed to create pdf file from %s" texfile) nil)
18231 (condition-case nil
18232 (if (featurep 'xemacs)
18233 (call-process "convert" nil nil nil
18234 "-density" "96"
18235 "-trim"
18236 "-antialias"
18237 pdffile
18238 "-quality" "100"
18239 ;; "-sharpen" "0x1.0"
18240 pngfile)
18241 (call-process "convert" nil nil nil
18242 "-density" dpi
18243 "-trim"
18244 "-antialias"
18245 pdffile
18246 "-quality" "100"
18247 ;; "-sharpen" "0x1.0"
18248 pngfile))
18249 (error nil))
18250 (if (not (file-exists-p pngfile))
18251 (if org-format-latex-signal-error
18252 (error "Failed to create png file from %s" texfile)
18253 (message "Failed to create png file from %s" texfile)
18254 nil)
18255 ;; Use the requested file name and clean up
18256 (copy-file pngfile tofile 'replace)
18257 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18258 (if (file-exists-p (concat texfilebase e))
18259 (delete-file (concat texfilebase e))))
18260 pngfile))))
18262 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18263 "Fill a LaTeX header template TPL.
18264 In the template, the following place holders will be recognized:
18267 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18269 [NO-PACKAGES] do not include PKG
18270 [EXTRA] the string EXTRA
18271 [NO-EXTRA] do not include EXTRA
18273 For backward compatibility, if both the positive and the negative place
18275 assumed to be present at the end of the template.
18276 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18277 EXTRA is a string.
18278 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18279 (let (rpl (end ""))
18281 (setq rpl (if (or (match-end 1) (not def-pkg))
18282 "" (org-latex-packages-to-string def-pkg snippets-p t))
18283 tpl (replace-match rpl t t tpl))
18284 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18287 (setq rpl (if (or (match-end 1) (not pkg))
18288 "" (org-latex-packages-to-string pkg snippets-p t))
18289 tpl (replace-match rpl t t tpl))
18290 (if pkg (setq end
18292 (org-latex-packages-to-string pkg snippets-p)))))
18295 (setq rpl (if (or (match-end 1) (not extra))
18297 tpl (replace-match rpl t t tpl))
18303 tpl)))
18305 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18307 (setq pkg (mapconcat (lambda(p)
18308 (cond
18309 ((stringp p) p)
18310 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18311 (format "%% Package %s omitted" (cadr p)))
18312 ((equal "" (car p))
18314 (t
18316 (car p) (cadr p)))))
18317 pkg
18321 (defun org-dvipng-color (attr)
18322 "Return a RGB color specification for dvipng."
18323 (apply 'format "rgb %s %s %s"
18324 (mapcar 'org-normalize-color
18325 (if (featurep 'xemacs)
18326 (color-rgb-components
18327 (face-property 'default
18328 (cond ((eq attr :foreground) 'foreground)
18329 ((eq attr :background) 'background))))
18330 (color-values (face-attribute 'default attr nil))))))
18332 (defun org-dvipng-color-format (color-name)
18333 "Convert COLOR-NAME to a RGB color value for dvipng."
18334 (apply 'format "rgb %s %s %s"
18335 (mapcar 'org-normalize-color
18336 (color-values color-name))))
18338 (defun org-latex-color (attr)
18339 "Return a RGB color for the LaTeX color package."
18340 (apply 'format "%s,%s,%s"
18341 (mapcar 'org-normalize-color
18342 (if (featurep 'xemacs)
18343 (color-rgb-components
18344 (face-property 'default
18345 (cond ((eq attr :foreground) 'foreground)
18346 ((eq attr :background) 'background))))
18347 (color-values (face-attribute 'default attr nil))))))
18349 (defun org-latex-color-format (color-name)
18350 "Convert COLOR-NAME to a RGB color value."
18351 (apply 'format "%s,%s,%s"
18352 (mapcar 'org-normalize-color
18353 (color-values color-name))))
18355 (defun org-normalize-color (value)
18356 "Return string to be used as color value for an RGB component."
18357 (format "%g" (/ value 65535.0)))
18360 \f
18361 ;; Image display
18363 (defvar org-inline-image-overlays nil)
18364 (make-variable-buffer-local 'org-inline-image-overlays)
18366 (defun org-toggle-inline-images (&optional include-linked)
18367 "Toggle the display of inline images.
18368 INCLUDE-LINKED is passed to `org-display-inline-images'."
18369 (interactive "P")
18370 (if org-inline-image-overlays
18371 (progn
18372 (org-remove-inline-images)
18373 (message "Inline image display turned off"))
18374 (org-display-inline-images include-linked)
18375 (if (and (org-called-interactively-p)
18376 org-inline-image-overlays)
18377 (message "%d images displayed inline"
18378 (length org-inline-image-overlays))
18379 (message "No images to display inline"))))
18381 (defun org-redisplay-inline-images ()
18382 "Refresh the display of inline images."
18383 (interactive)
18384 (if (not org-inline-image-overlays)
18385 (org-toggle-inline-images)
18386 (org-toggle-inline-images)
18387 (org-toggle-inline-images)))
18389 (defun org-display-inline-images (&optional include-linked refresh beg end)
18390 "Display inline images.
18391 Normally only links without a description part are inlined, because this
18392 is how it will work for export. When INCLUDE-LINKED is set, also links
18393 with a description part will be inlined. This can be nice for a quick
18394 look at those images, but it does not reflect what exported files will look
18395 like.
18396 When REFRESH is set, refresh existing images between BEG and END.
18397 This will create new image displays only if necessary.
18398 BEG and END default to the buffer boundaries."
18399 (interactive "P")
18400 (unless refresh
18401 (org-remove-inline-images)
18402 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18403 (save-excursion
18404 (save-restriction
18405 (widen)
18406 (setq beg (or beg (point-min)) end (or end (point-max)))
18407 (goto-char beg)
18409 (substring (org-image-file-name-regexp) 0 -2)
18411 old file ov img type attrwidth width)
18412 (while (re-search-forward re end t)
18413 (setq old (get-char-property-and-overlay (match-beginning 1)
18414 'org-image-overlay)
18415 file (expand-file-name
18416 (concat (or (match-string 3) "") (match-string 4))))
18417 (when (image-type-available-p 'imagemagick)
18418 (setq attrwidth (if (or (listp org-image-actual-width)
18419 (null org-image-actual-width))
18420 (save-excursion
18421 (save-match-data
18422 (when (re-search-backward
18424 (save-excursion
18426 (string-to-number (match-string 1))))))
18427 width (cond ((eq org-image-actual-width t) nil)
18428 ((null org-image-actual-width) attrwidth)
18429 ((numberp org-image-actual-width)
18430 org-image-actual-width)
18431 ((listp org-image-actual-width)
18432 (or attrwidth (car org-image-actual-width))))
18433 type (if width 'imagemagick)))
18434 (when (file-exists-p file)
18435 (if (and (car-safe old) refresh)
18436 (image-refresh (overlay-get (cdr old) 'display))
18437 (setq img (save-match-data (create-image file type nil :width width)))
18438 (when img
18439 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18440 (overlay-put ov 'display img)
18441 (overlay-put ov 'face 'default)
18442 (overlay-put ov 'org-image-overlay t)
18443 (overlay-put ov 'modification-hooks
18444 (list 'org-display-inline-remove-overlay))
18445 (push ov org-inline-image-overlays)))))))))
18447 (define-obsolete-function-alias
18448 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18450 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18451 "Remove inline-display overlay if a corresponding region is modified."
18452 (let ((inhibit-modification-hooks t))
18453 (when (and ov after)
18454 (delete ov org-inline-image-overlays)
18455 (delete-overlay ov))))
18457 (defun org-remove-inline-images ()
18458 "Remove inline display of images."
18459 (interactive)
18460 (mapc 'delete-overlay org-inline-image-overlays)
18461 (setq org-inline-image-overlays nil))
18463 ;;;; Key bindings
18465 ;; Outline functions from `outline-mode-prefix-map'
18466 ;; that can be remapped in Org:
18467 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18468 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18469 (define-key org-mode-map [remap outline-forward-same-level]
18470 'org-forward-heading-same-level)
18471 (define-key org-mode-map [remap outline-backward-same-level]
18472 'org-backward-heading-same-level)
18473 (define-key org-mode-map [remap show-branches]
18474 'org-kill-note-or-show-branches)
18475 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18476 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18477 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18479 ;; Outline functions from `outline-mode-prefix-map' that can not
18480 ;; be remapped in Org:
18481 ;;
18482 ;; - the column "key binding" shows whether the Outline function is still
18483 ;; available in Org mode on the same key that it has been bound to in
18484 ;; Outline mode:
18485 ;; - "overridden": key used for a different functionality in Org mode
18486 ;; - else: key still bound to the same Outline function in Org mode
18487 ;;
18488 ;; | Outline function | key binding | Org replacement |
18489 ;; |------------------------------------+-------------+-----------------------|
18490 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18491 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18492 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18493 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18494 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18495 ;; | `show-entry' | overridden | no replacement |
18496 ;; | `show-children' | `C-c C-i' | visibility cycling |
18497 ;; | `show-branches' | `C-c C-k' | still same function |
18498 ;; | `show-subtree' | overridden | visibility cycling |
18499 ;; | `show-all' | overridden | no replacement |
18500 ;; | `hide-subtree' | overridden | visibility cycling |
18501 ;; | `hide-body' | overridden | no replacement |
18502 ;; | `hide-entry' | overridden | visibility cycling |
18503 ;; | `hide-leaves' | overridden | no replacement |
18504 ;; | `hide-sublevels' | overridden | no replacement |
18505 ;; | `hide-other' | overridden | no replacement |
18507 ;; Make `C-c C-x' a prefix key
18508 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18510 ;; TAB key with modifiers
18511 (org-defkey org-mode-map "\C-i" 'org-cycle)
18512 (org-defkey org-mode-map [(tab)] 'org-cycle)
18513 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18515 ;; The following line is necessary under Suse GNU/Linux
18516 (unless (featurep 'xemacs)
18517 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18518 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18519 (define-key org-mode-map [backtab] 'org-shifttab)
18521 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18522 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18523 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18525 ;; Cursor keys with modifiers
18526 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18527 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18528 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18529 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18531 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18532 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18533 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18534 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18536 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18537 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18538 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18539 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18541 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18542 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18543 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18544 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18546 ;; Babel keys
18547 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18548 (mapc (lambda (pair)
18549 (define-key org-babel-map (car pair) (cdr pair)))
18550 org-babel-key-bindings)
18552 ;;; Extra keys for tty access.
18553 ;; We only set them when really needed because otherwise the
18554 ;; menus don't show the simple keys
18556 (when (or org-use-extra-keys
18557 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18558 (not window-system))
18559 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18560 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18561 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18562 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18563 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18564 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18565 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18566 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18567 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18568 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18569 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18570 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18571 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18572 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18573 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18574 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18575 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18576 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18577 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18578 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18579 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18580 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18581 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18582 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18583 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18584 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18585 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18586 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18588 ;; All the other keys
18590 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18591 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18592 (if (boundp 'narrow-map)
18593 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18594 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18595 (if (boundp 'narrow-map)
18596 (org-defkey narrow-map "b" 'org-narrow-to-block)
18597 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18598 (if (boundp 'narrow-map)
18599 (org-defkey narrow-map "e" 'org-narrow-to-element)
18600 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18601 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18602 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18603 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18604 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18605 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18606 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18607 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18608 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18609 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18610 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18611 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18612 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18613 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18614 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18615 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18616 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18617 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18618 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18619 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18620 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18621 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18622 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18623 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18624 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18625 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18627 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18628 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18629 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18630 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18631 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18632 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18633 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18634 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18635 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18636 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18637 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18638 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18639 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18640 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18641 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18642 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18643 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18644 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18645 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18646 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18647 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18649 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18650 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18651 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18652 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18653 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18654 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18655 (org-defkey org-mode-map "\C-c^" 'org-sort)
18656 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18657 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18658 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18659 (org-defkey org-mode-map "\C-m" 'org-return)
18660 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18661 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18662 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18663 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18664 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18665 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18666 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18667 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18668 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18669 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18670 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18671 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18672 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18673 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
18674 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
18675 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
18676 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
18677 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
18678 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
18679 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
18680 (org-defkey org-mode-map "\M-h" 'org-mark-element)
18681 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
18682 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18684 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18685 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18686 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18688 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18689 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18690 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18691 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18692 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18693 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18694 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18695 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18696 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18697 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18698 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18699 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18700 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18702 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18703 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18704 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
18705 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18706 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18707 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18708 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18709 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18710 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18712 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18713 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18714 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18715 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18716 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18718 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18720 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18722 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18723 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18725 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18728 (when (featurep 'xemacs)
18729 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18732 (defconst org-speed-commands-default
18733 '(
18734 ("Outline Navigation")
18735 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18736 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18737 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18738 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18739 ("F" . org-next-block)
18740 ("B" . org-previous-block)
18741 ("u" . (org-speed-move-safe 'outline-up-heading))
18742 ("j" . org-goto)
18743 ("g" . (org-refile t))
18744 ("Outline Visibility")
18745 ("c" . org-cycle)
18746 ("C" . org-shifttab)
18747 (" " . org-display-outline-path)
18748 ("=" . org-columns)
18749 ("Outline Structure Editing")
18750 ("U" . org-shiftmetaup)
18751 ("D" . org-shiftmetadown)
18752 ("r" . org-metaright)
18753 ("l" . org-metaleft)
18754 ("R" . org-shiftmetaright)
18755 ("L" . org-shiftmetaleft)
18756 ("i" . (progn (forward-char 1) (call-interactively
18757 'org-insert-heading-respect-content)))
18758 ("^" . org-sort)
18759 ("w" . org-refile)
18760 ("a" . org-archive-subtree-default-with-confirmation)
18761 ("@" . org-mark-subtree)
18762 ("#" . org-toggle-comment)
18763 ("Clock Commands")
18764 ("I" . org-clock-in)
18765 ("O" . org-clock-out)
18766 ("Meta Data Editing")
18767 ("t" . org-todo)
18768 ("," . (org-priority))
18769 ("0" . (org-priority ?\ ))
18770 ("1" . (org-priority ?A))
18771 ("2" . (org-priority ?B))
18772 ("3" . (org-priority ?C))
18773 (":" . org-set-tags-command)
18774 ("e" . org-set-effort)
18775 ("E" . org-inc-effort)
18776 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18777 (org-entry-put (point) "APPT_WARNTIME" m)))
18778 ("Agenda Views etc")
18779 ("v" . org-agenda)
18780 ("/" . org-sparse-tree)
18781 ("Misc")
18782 ("o" . org-open-at-point)
18783 ("?" . org-speed-command-help)
18784 ("<" . (org-agenda-set-restriction-lock 'subtree))
18785 (">" . (org-agenda-remove-restriction-lock))
18786 )
18787 "The default speed commands.")
18789 (defun org-print-speed-command (e)
18790 (if (> (length (car e)) 1)
18791 (progn
18793 (princ (car e))
18795 (princ (make-string (length (car e)) ?-))
18797 (princ (car e))
18798 (princ " ")
18799 (if (symbolp (cdr e))
18800 (princ (symbol-name (cdr e)))
18801 (prin1 (cdr e)))
18804 (defun org-speed-command-help ()
18805 "Show the available speed commands."
18806 (interactive)
18807 (if (not org-use-speed-commands)
18808 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18809 (with-output-to-temp-buffer "*Help*"
18811 (mapc 'org-print-speed-command org-speed-commands-user)
18814 (mapc 'org-print-speed-command org-speed-commands-default))
18815 (with-current-buffer "*Help*"
18816 (setq truncate-lines t))))
18818 (defun org-speed-move-safe (cmd)
18819 "Execute CMD, but make sure that the cursor always ends up in a headline.
18820 If not, return to the original position and throw an error."
18821 (interactive)
18822 (let ((pos (point)))
18823 (call-interactively cmd)
18824 (unless (and (bolp) (org-at-heading-p))
18825 (goto-char pos)
18826 (error "Boundary reached while executing %s" cmd))))
18828 (defvar org-self-insert-command-undo-counter 0)
18830 (defvar org-table-auto-blank-field) ; defined in org-table.el
18831 (defvar org-speed-command nil)
18833 (define-obsolete-function-alias
18834 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18836 (defun org-speed-command-activate (keys)
18837 "Hook for activating single-letter speed commands.
18838 `org-speed-commands-default' specifies a minimal command set.
18839 Use `org-speed-commands-user' for further customization."
18840 (when (or (and (bolp) (looking-at org-outline-regexp))
18841 (and (functionp org-use-speed-commands)
18842 (funcall org-use-speed-commands)))
18843 (cdr (assoc keys (append org-speed-commands-user
18844 org-speed-commands-default)))))
18846 (define-obsolete-function-alias
18847 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18849 (defun org-babel-speed-command-activate (keys)
18850 "Hook for activating single-letter code block commands."
18851 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18852 (cdr (assoc keys org-babel-key-bindings))))
18854 (defcustom org-speed-command-hook
18855 '(org-speed-command-default-hook org-babel-speed-command-hook)
18856 "Hook for activating speed commands at strategic locations.
18857 Hook functions are called in sequence until a valid handler is
18858 found.
18860 Each hook takes a single argument, a user-pressed command key
18861 which is also a `self-insert-command' from the global map.
18863 Within the hook, examine the cursor position and the command key
18864 and return nil or a valid handler as appropriate. Handler could
18865 be one of an interactive command, a function, or a form.
18867 Set `org-use-speed-commands' to non-nil value to enable this
18868 hook. The default setting is `org-speed-command-activate'."
18869 :group 'org-structure
18870 :version "24.1"
18871 :type 'hook)
18873 (defun org-self-insert-command (N)
18874 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18875 If the cursor is in a table looking at whitespace, the whitespace is
18876 overwritten, and the table is not marked as requiring realignment."
18877 (interactive "p")
18878 (org-check-before-invisible-edit 'insert)
18879 (cond
18880 ((and org-use-speed-commands
18881 (setq org-speed-command
18882 (run-hook-with-args-until-success
18883 'org-speed-command-hook (this-command-keys))))
18884 (cond
18885 ((commandp org-speed-command)
18886 (setq this-command org-speed-command)
18887 (call-interactively org-speed-command))
18888 ((functionp org-speed-command)
18889 (funcall org-speed-command))
18890 ((and org-speed-command (listp org-speed-command))
18891 (eval org-speed-command))
18892 (t (let (org-use-speed-commands)
18893 (call-interactively 'org-self-insert-command)))))
18894 ((and
18895 (org-table-p)
18896 (progn
18897 ;; check if we blank the field, and if that triggers align
18898 (and (featurep 'org-table) org-table-auto-blank-field
18899 (member last-command
18900 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18902 ;; got extra space, this field does not determine column width
18903 (let (org-table-may-need-update) (org-table-blank-field))
18904 ;; no extra space, this field may determine column width
18905 (org-table-blank-field)))
18906 t)
18907 (eq N 1)
18909 (let (org-table-may-need-update)
18910 (goto-char (1- (match-end 0)))
18911 (backward-delete-char 1)
18912 (goto-char (match-beginning 0))
18913 (self-insert-command N)))
18914 (t
18915 (setq org-table-may-need-update t)
18916 (self-insert-command N)
18917 (org-fix-tags-on-the-fly)
18918 (if org-self-insert-cluster-for-undo
18919 (if (not (eq last-command 'org-self-insert-command))
18920 (setq org-self-insert-command-undo-counter 1)
18921 (if (>= org-self-insert-command-undo-counter 20)
18922 (setq org-self-insert-command-undo-counter 1)
18923 (and (> org-self-insert-command-undo-counter 0)
18924 buffer-undo-list (listp buffer-undo-list)
18925 (not (cadr buffer-undo-list)) ; remove nil entry
18926 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18927 (setq org-self-insert-command-undo-counter
18928 (1+ org-self-insert-command-undo-counter))))))))
18930 (defun org-check-before-invisible-edit (kind)
18931 "Check is editing if kind KIND would be dangerous with invisible text around.
18932 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18933 ;; First, try to get out of here as quickly as possible, to reduce overhead
18934 (if (and org-catch-invisible-edits
18935 (or (not (boundp 'visible-mode)) (not visible-mode))
18936 (or (get-char-property (point) 'invisible)
18937 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18938 ;; OK, we need to take a closer look
18939 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18940 (invisible-before-point (if (bobp) nil (get-char-property
18941 (1- (point)) 'invisible)))
18942 (border-and-ok-direction
18943 (or
18944 ;; Check if we are acting predictably before invisible text
18945 (and invisible-at-point (not invisible-before-point)
18946 (memq kind '(insert delete-backward)))
18947 ;; Check if we are acting predictably after invisible text
18948 ;; This works not well, and I have turned it off. It seems
18949 ;; better to always show and stop after invisible text.
18950 ;; (and (not invisible-at-point) invisible-before-point
18951 ;; (memq kind '(insert delete)))
18952 )))
18953 (when (or (memq invisible-at-point '(outline org-hide-block t))
18954 (memq invisible-before-point '(outline org-hide-block t)))
18955 (if (eq org-catch-invisible-edits 'error)
18956 (error "Editing in invisible areas is prohibited - make visible first"))
18957 (if (and org-custom-properties-overlays
18958 (y-or-n-p "Display invisible properties in this buffer? "))
18959 (org-toggle-custom-properties-visibility)
18960 ;; Make the area visible
18961 (save-excursion
18962 (if invisible-before-point
18963 (goto-char (previous-single-char-property-change
18964 (point) 'invisible)))
18965 (org-cycle))
18966 (cond
18967 ((eq org-catch-invisible-edits 'show)
18968 ;; That's it, we do the edit after showing
18969 (message
18970 "Unfolding invisible region around point before editing")
18971 (sit-for 1))
18972 ((and (eq org-catch-invisible-edits 'smart)
18973 border-and-ok-direction)
18974 (message "Unfolding invisible region around point before editing"))
18975 (t
18976 ;; Don't do the edit, make the user repeat it in full visibility
18977 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18979 (defun org-fix-tags-on-the-fly ()
18980 (when (and (equal (char-after (point-at-bol)) ?*)
18981 (org-at-heading-p))
18982 (org-align-tags-here org-tags-column)))
18984 (defun org-delete-backward-char (N)
18985 "Like `delete-backward-char', insert whitespace at field end in tables.
18986 When deleting backwards, in tables this function will insert whitespace in
18988 still be marked for re-alignment if the field did fill the entire column,
18989 because, in this case the deletion might narrow the column."
18990 (interactive "p")
18991 (save-match-data
18992 (org-check-before-invisible-edit 'delete-backward)
18993 (if (and (org-table-p)
18994 (eq N 1)
18995 (string-match "|" (buffer-substring (point-at-bol) (point)))
18996 (looking-at ".*?|"))
18997 (let ((pos (point))
18999 (c org-table-may-need-update))
19000 (backward-delete-char N)
19001 (if (not overwrite-mode)
19002 (progn
19003 (skip-chars-forward "^|")
19004 (insert " ")
19005 (goto-char (1- pos))))
19006 ;; noalign: if there were two spaces at the end, this field
19007 ;; does not determine the width of the column.
19008 (if noalign (setq org-table-may-need-update c)))
19009 (backward-delete-char N)
19010 (org-fix-tags-on-the-fly))))
19012 (defun org-delete-char (N)
19013 "Like `delete-char', but insert whitespace at field end in tables.
19014 When deleting characters, in tables this function will insert whitespace in
19016 still be marked for re-alignment if the field did fill the entire column,
19017 because, in this case the deletion might narrow the column."
19018 (interactive "p")
19019 (save-match-data
19020 (org-check-before-invisible-edit 'delete)
19021 (if (and (org-table-p)
19022 (not (bolp))
19023 (not (= (char-after) ?|))
19024 (eq N 1))
19025 (if (looking-at ".*?|")
19026 (let ((pos (point))
19028 (c org-table-may-need-update))
19029 (replace-match (concat
19030 (substring (match-string 0) 1 -1)
19031 " |"))
19032 (goto-char pos)
19033 ;; noalign: if there were two spaces at the end, this field
19034 ;; does not determine the width of the column.
19035 (if noalign (setq org-table-may-need-update c)))
19036 (delete-char N))
19037 (delete-char N)
19038 (org-fix-tags-on-the-fly))))
19040 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19041 (put 'org-self-insert-command 'delete-selection t)
19042 (put 'orgtbl-self-insert-command 'delete-selection t)
19043 (put 'org-delete-char 'delete-selection 'supersede)
19044 (put 'org-delete-backward-char 'delete-selection 'supersede)
19045 (put 'org-yank 'delete-selection 'yank)
19047 ;; Make `flyspell-mode' delay after some commands
19048 (put 'org-self-insert-command 'flyspell-delayed t)
19049 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19050 (put 'org-delete-char 'flyspell-delayed t)
19051 (put 'org-delete-backward-char 'flyspell-delayed t)
19053 ;; Make pabbrev-mode expand after org-mode commands
19054 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19055 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19057 ;; How to do this: Measure non-white length of current string
19058 ;; If equal to column width, we should realign.
19060 (defun org-remap (map &rest commands)
19061 "In MAP, remap the functions given in COMMANDS.
19062 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19063 (let (new old)
19064 (while commands
19065 (setq old (pop commands) new (pop commands))
19066 (if (fboundp 'command-remapping)
19067 (org-defkey map (vector 'remap old) new)
19068 (substitute-key-definition old new map global-map)))))
19070 (defun org-transpose-words ()
19071 "Transpose words for Org.
19072 This uses the `org-mode-transpose-word-syntax-table' syntax
19073 table, which interprets characters in `org-emphasis-alist' as
19074 word constituants."
19075 (interactive)
19076 (with-syntax-table org-mode-transpose-word-syntax-table
19077 (call-interactively 'transpose-words)))
19078 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19080 (when (eq org-enable-table-editor 'optimized)
19081 ;; If the user wants maximum table support, we need to hijack
19082 ;; some standard editing functions
19083 (org-remap org-mode-map
19084 'self-insert-command 'org-self-insert-command
19085 'delete-char 'org-delete-char
19086 'delete-backward-char 'org-delete-backward-char)
19087 (org-defkey org-mode-map "|" 'org-force-self-insert))
19089 (defvar org-ctrl-c-ctrl-c-hook nil
19090 "Hook for functions attaching themselves to `C-c C-c'.
19092 This can be used to add additional functionality to the C-c C-c
19093 key which executes context-dependent commands. This hook is run
19094 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19095 run after the last test.
19097 Each function will be called with no arguments. The function
19098 must check if the context is appropriate for it to act. If yes,
19099 it should do its thing and then return a non-nil value. If the
19100 context is wrong, just do nothing and return nil.")
19102 (defvar org-ctrl-c-ctrl-c-final-hook nil
19103 "Hook for functions attaching themselves to `C-c C-c'.
19105 This can be used to add additional functionality to the C-c C-c
19106 key which executes context-dependent commands. This hook is run
19107 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19108 before the first test.
19110 Each function will be called with no arguments. The function
19111 must check if the context is appropriate for it to act. If yes,
19112 it should do its thing and then return a non-nil value. If the
19113 context is wrong, just do nothing and return nil.")
19115 (defvar org-tab-first-hook nil
19116 "Hook for functions to attach themselves to TAB.
19117 See `org-ctrl-c-ctrl-c-hook' for more information.
19118 This hook runs as the first action when TAB is pressed, even before
19119 `org-cycle' messes around with the `outline-regexp' to cater for
19120 inline tasks and plain list item folding.
19121 If any function in this hook returns t, any other actions that
19122 would have been caused by TAB (such as table field motion or visibility
19123 cycling) will not occur.")
19125 (defvar org-tab-after-check-for-table-hook nil
19126 "Hook for functions to attach themselves to TAB.
19127 See `org-ctrl-c-ctrl-c-hook' for more information.
19128 This hook runs after it has been established that the cursor is not in a
19129 table, but before checking if the cursor is in a headline or if global cycling
19130 should be done.
19131 If any function in this hook returns t, not other actions like visibility
19132 cycling will be done.")
19134 (defvar org-tab-after-check-for-cycling-hook nil
19135 "Hook for functions to attach themselves to TAB.
19136 See `org-ctrl-c-ctrl-c-hook' for more information.
19137 This hook runs after it has been established that not table field motion and
19138 not visibility should be done because of current context. This is probably
19139 the place where a package like yasnippets can hook in.")
19141 (defvar org-tab-before-tab-emulation-hook nil
19142 "Hook for functions to attach themselves to TAB.
19143 See `org-ctrl-c-ctrl-c-hook' for more information.
19144 This hook runs after every other options for TAB have been exhausted, but
19147 (defvar org-metaleft-hook nil
19148 "Hook for functions attaching themselves to `M-left'.
19149 See `org-ctrl-c-ctrl-c-hook' for more information.")
19150 (defvar org-metaright-hook nil
19151 "Hook for functions attaching themselves to `M-right'.
19152 See `org-ctrl-c-ctrl-c-hook' for more information.")
19153 (defvar org-metaup-hook nil
19154 "Hook for functions attaching themselves to `M-up'.
19155 See `org-ctrl-c-ctrl-c-hook' for more information.")
19156 (defvar org-metadown-hook nil
19157 "Hook for functions attaching themselves to `M-down'.
19158 See `org-ctrl-c-ctrl-c-hook' for more information.")
19159 (defvar org-shiftmetaleft-hook nil
19160 "Hook for functions attaching themselves to `M-S-left'.
19161 See `org-ctrl-c-ctrl-c-hook' for more information.")
19162 (defvar org-shiftmetaright-hook nil
19163 "Hook for functions attaching themselves to `M-S-right'.
19164 See `org-ctrl-c-ctrl-c-hook' for more information.")
19165 (defvar org-shiftmetaup-hook nil
19166 "Hook for functions attaching themselves to `M-S-up'.
19167 See `org-ctrl-c-ctrl-c-hook' for more information.")
19168 (defvar org-shiftmetadown-hook nil
19169 "Hook for functions attaching themselves to `M-S-down'.
19170 See `org-ctrl-c-ctrl-c-hook' for more information.")
19171 (defvar org-metareturn-hook nil
19172 "Hook for functions attaching themselves to `M-RET'.
19173 See `org-ctrl-c-ctrl-c-hook' for more information.")
19174 (defvar org-shiftup-hook nil
19175 "Hook for functions attaching themselves to `S-up'.
19176 See `org-ctrl-c-ctrl-c-hook' for more information.")
19177 (defvar org-shiftup-final-hook nil
19178 "Hook for functions attaching themselves to `S-up'.
19179 This one runs after all other options except shift-select have been excluded.
19180 See `org-ctrl-c-ctrl-c-hook' for more information.")
19181 (defvar org-shiftdown-hook nil
19182 "Hook for functions attaching themselves to `S-down'.
19183 See `org-ctrl-c-ctrl-c-hook' for more information.")
19184 (defvar org-shiftdown-final-hook nil
19185 "Hook for functions attaching themselves to `S-down'.
19186 This one runs after all other options except shift-select have been excluded.
19187 See `org-ctrl-c-ctrl-c-hook' for more information.")
19188 (defvar org-shiftleft-hook nil
19189 "Hook for functions attaching themselves to `S-left'.
19190 See `org-ctrl-c-ctrl-c-hook' for more information.")
19191 (defvar org-shiftleft-final-hook nil
19192 "Hook for functions attaching themselves to `S-left'.
19193 This one runs after all other options except shift-select have been excluded.
19194 See `org-ctrl-c-ctrl-c-hook' for more information.")
19195 (defvar org-shiftright-hook nil
19196 "Hook for functions attaching themselves to `S-right'.
19197 See `org-ctrl-c-ctrl-c-hook' for more information.")
19198 (defvar org-shiftright-final-hook nil
19199 "Hook for functions attaching themselves to `S-right'.
19200 This one runs after all other options except shift-select have been excluded.
19201 See `org-ctrl-c-ctrl-c-hook' for more information.")
19203 (defun org-modifier-cursor-error ()
19204 "Throw an error, a modified cursor command was applied in wrong context."
19205 (error "This command is active in special context like tables, headlines or items"))
19207 (defun org-shiftselect-error ()
19208 "Throw an error because Shift-Cursor command was applied in wrong context."
19209 (if (and (boundp 'shift-select-mode) shift-select-mode)
19210 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19211 (error "This command works only in special context like headlines or timestamps")))
19213 (defun org-call-for-shift-select (cmd)
19214 (let ((this-command-keys-shift-translated t))
19215 (call-interactively cmd)))
19217 (defun org-shifttab (&optional arg)
19218 "Global visibility cycling or move to previous table field.
19219 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
19220 on context.
19221 See the individual commands for more information."
19222 (interactive "P")
19223 (cond
19224 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19225 ((integerp arg)
19226 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19227 (message "Content view to level: %d" arg)
19228 (org-content (prefix-numeric-value arg2))
19229 (setq org-cycle-global-status 'overview)))
19230 (t (call-interactively 'org-global-cycle))))
19232 (defun org-shiftmetaleft ()
19233 "Promote subtree or delete table column.
19234 Calls `org-promote-subtree', `org-outdent-item-tree', or
19235 `org-table-delete-column', depending on context. See the
19236 individual commands for more information."
19237 (interactive)
19238 (cond
19239 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19240 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19241 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19242 ((if (not (org-region-active-p)) (org-at-item-p)
19243 (save-excursion (goto-char (region-beginning))
19244 (org-at-item-p)))
19245 (call-interactively 'org-outdent-item-tree))
19246 (t (org-modifier-cursor-error))))
19248 (defun org-shiftmetaright ()
19249 "Demote subtree or insert table column.
19250 Calls `org-demote-subtree', `org-indent-item-tree', or
19251 `org-table-insert-column', depending on context. See the
19252 individual commands for more information."
19253 (interactive)
19254 (cond
19255 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19256 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19257 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19258 ((if (not (org-region-active-p)) (org-at-item-p)
19259 (save-excursion (goto-char (region-beginning))
19260 (org-at-item-p)))
19261 (call-interactively 'org-indent-item-tree))
19262 (t (org-modifier-cursor-error))))
19264 (defun org-shiftmetaup (&optional arg)
19265 "Move subtree up or kill table row.
19266 Calls `org-move-subtree-up' or `org-table-kill-row' or
19267 `org-move-item-up' or `org-timestamp-up', depending on context.
19268 See the individual commands for more information."
19269 (interactive "P")
19270 (cond
19271 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19272 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19273 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19274 ((org-at-item-p) (call-interactively 'org-move-item-up))
19275 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19276 (call-interactively 'org-timestamp-up)))
19277 (t (call-interactively 'org-drag-line-backward))))
19279 (defun org-shiftmetadown (&optional arg)
19280 "Move subtree down or insert table row.
19281 Calls `org-move-subtree-down' or `org-table-insert-row' or
19282 `org-move-item-down' or `org-timestamp-up', depending on context.
19283 See the individual commands for more information."
19284 (interactive "P")
19285 (cond
19286 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19287 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19288 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19289 ((org-at-item-p) (call-interactively 'org-move-item-down))
19290 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19291 (call-interactively 'org-timestamp-down)))
19292 (t (call-interactively 'org-drag-line-forward))))
19294 (defsubst org-hidden-tree-error ()
19295 (error
19296 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19298 (defun org-metaleft (&optional arg)
19299 "Promote heading or move table column to left.
19300 Calls `org-do-promote' or `org-table-move-column', depending on context.
19301 With no specific context, calls the Emacs default `backward-word'.
19302 See the individual commands for more information."
19303 (interactive "P")
19304 (cond
19305 ((run-hook-with-args-until-success 'org-metaleft-hook))
19306 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19307 ((org-with-limited-levels
19308 (or (org-at-heading-p)
19309 (and (org-region-active-p)
19310 (save-excursion
19311 (goto-char (region-beginning))
19312 (org-at-heading-p)))))
19313 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19314 (call-interactively 'org-do-promote))
19315 ;; At an inline task.
19316 ((org-at-heading-p)
19317 (call-interactively 'org-inlinetask-promote))
19318 ((or (org-at-item-p)
19319 (and (org-region-active-p)
19320 (save-excursion
19321 (goto-char (region-beginning))
19322 (org-at-item-p))))
19323 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19324 (call-interactively 'org-outdent-item))
19325 (t (call-interactively 'backward-word))))
19327 (defun org-metaright (&optional arg)
19328 "Demote a subtree, a list item or move table column to right.
19329 In front of a drawer or a block keyword, indent it correctly.
19330 With no specific context, calls the Emacs default `forward-word'.
19331 See the individual commands for more information."
19332 (interactive "P")
19333 (cond
19334 ((run-hook-with-args-until-success 'org-metaright-hook))
19335 ((org-at-table-p) (call-interactively 'org-table-move-column))
19336 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19337 ((org-at-block-p) (call-interactively 'org-indent-block))
19338 ((org-with-limited-levels
19339 (or (org-at-heading-p)
19340 (and (org-region-active-p)
19341 (save-excursion
19342 (goto-char (region-beginning))
19343 (org-at-heading-p)))))
19344 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19345 (call-interactively 'org-do-demote))
19346 ;; At an inline task.
19347 ((org-at-heading-p)
19348 (call-interactively 'org-inlinetask-demote))
19349 ((or (org-at-item-p)
19350 (and (org-region-active-p)
19351 (save-excursion
19352 (goto-char (region-beginning))
19353 (org-at-item-p))))
19354 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19355 (call-interactively 'org-indent-item))
19356 (t (call-interactively 'forward-word))))
19358 (defun org-check-for-hidden (what)
19359 "Check if there are hidden headlines/items in the current visual line.
19360 WHAT can be either `headlines' or `items'. If the current line is
19361 an outline or item heading and it has a folded subtree below it,
19362 this function returns t, nil otherwise."
19363 (let ((re (cond
19364 ((eq what 'headlines) org-outline-regexp-bol)
19365 ((eq what 'items) (org-item-beginning-re))
19366 (t (error "This should not happen"))))
19367 beg end)
19368 (save-excursion
19369 (catch 'exit
19370 (unless (org-region-active-p)
19371 (setq beg (point-at-bol))
19372 (beginning-of-line 2)
19373 (while (and (not (eobp)) ;; this is like `next-line'
19374 (get-char-property (1- (point)) 'invisible))
19375 (beginning-of-line 2))
19376 (setq end (point))
19377 (goto-char beg)
19378 (goto-char (point-at-eol))
19379 (setq end (max end (point)))
19380 (while (re-search-forward re end t)
19381 (if (get-char-property (match-beginning 0) 'invisible)
19382 (throw 'exit t))))
19383 nil))))
19385 (defun org-metaup (&optional arg)
19386 "Move subtree up or move table row up.
19387 Calls `org-move-subtree-up' or `org-table-move-row' or
19388 `org-move-item-up', depending on context. See the individual commands
19389 for more information."
19390 (interactive "P")
19391 (cond
19392 ((run-hook-with-args-until-success 'org-metaup-hook))
19393 ((org-region-active-p)
19394 (let* ((a (min (region-beginning) (region-end)))
19395 (b (1- (max (region-beginning) (region-end))))
19396 (c (save-excursion (goto-char a)
19397 (move-beginning-of-line 0)))
19398 (d (save-excursion (goto-char a)
19399 (move-end-of-line 0) (point))))
19400 (transpose-regions a b c d)
19401 (goto-char c)))
19402 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19403 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19404 ((org-at-item-p) (call-interactively 'org-move-item-up))
19405 (t (org-drag-element-backward))))
19407 (defun org-metadown (&optional arg)
19408 "Move subtree down or move table row down.
19409 Calls `org-move-subtree-down' or `org-table-move-row' or
19410 `org-move-item-down', depending on context. See the individual
19411 commands for more information."
19412 (interactive "P")
19413 (cond
19414 ((run-hook-with-args-until-success 'org-metadown-hook))
19415 ((org-region-active-p)
19416 (let* ((a (min (region-beginning) (region-end)))
19417 (b (max (region-beginning) (region-end)))
19418 (c (save-excursion (goto-char b)
19419 (move-beginning-of-line 1)))
19420 (d (save-excursion (goto-char b)
19421 (move-end-of-line 1) (1+ (point)))))
19422 (transpose-regions a b c d)
19423 (goto-char d)))
19424 ((org-at-table-p) (call-interactively 'org-table-move-row))
19425 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19426 ((org-at-item-p) (call-interactively 'org-move-item-down))
19427 (t (org-drag-element-forward))))
19429 (defun org-shiftup (&optional arg)
19430 "Increase item in timestamp or increase priority of current headline.
19431 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19432 depending on context. See the individual commands for more information."
19433 (interactive "P")
19434 (cond
19435 ((run-hook-with-args-until-success 'org-shiftup-hook))
19436 ((and org-support-shift-select (org-region-active-p))
19437 (org-call-for-shift-select 'previous-line))
19438 ((org-at-timestamp-p t)
19439 (call-interactively (if org-edit-timestamp-down-means-later
19440 'org-timestamp-down 'org-timestamp-up)))
19441 ((and (not (eq org-support-shift-select 'always))
19442 org-enable-priority-commands
19443 (org-at-heading-p))
19444 (call-interactively 'org-priority-up))
19445 ((and (not org-support-shift-select) (org-at-item-p))
19446 (call-interactively 'org-previous-item))
19447 ((org-clocktable-try-shift 'up arg))
19448 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19449 (org-support-shift-select
19450 (org-call-for-shift-select 'previous-line))
19451 (t (org-shiftselect-error))))
19453 (defun org-shiftdown (&optional arg)
19454 "Decrease item in timestamp or decrease priority of current headline.
19455 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19456 depending on context. See the individual commands for more information."
19457 (interactive "P")
19458 (cond
19459 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19460 ((and org-support-shift-select (org-region-active-p))
19461 (org-call-for-shift-select 'next-line))
19462 ((org-at-timestamp-p t)
19463 (call-interactively (if org-edit-timestamp-down-means-later
19464 'org-timestamp-up 'org-timestamp-down)))
19465 ((and (not (eq org-support-shift-select 'always))
19466 org-enable-priority-commands
19467 (org-at-heading-p))
19468 (call-interactively 'org-priority-down))
19469 ((and (not org-support-shift-select) (org-at-item-p))
19470 (call-interactively 'org-next-item))
19471 ((org-clocktable-try-shift 'down arg))
19472 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19473 (org-support-shift-select
19474 (org-call-for-shift-select 'next-line))
19475 (t (org-shiftselect-error))))
19477 (defun org-shiftright (&optional arg)
19478 "Cycle the thing at point or in the current line, depending on context.
19479 Depending on context, this does one of the following:
19481 - switch a timestamp at point one day into the future
19482 - on a headline, switch to the next TODO keyword.
19483 - on an item, switch entire list to the next bullet type
19484 - on a property line, switch to the next allowed value
19485 - on a clocktable definition line, move time block into the future"
19486 (interactive "P")
19487 (cond
19488 ((run-hook-with-args-until-success 'org-shiftright-hook))
19489 ((and org-support-shift-select (org-region-active-p))
19490 (org-call-for-shift-select 'forward-char))
19491 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19492 ((and (not (eq org-support-shift-select 'always))
19493 (org-at-heading-p))
19494 (let ((org-inhibit-logging
19495 (not org-treat-S-cursor-todo-selection-as-state-change))
19496 (org-inhibit-blocking
19497 (not org-treat-S-cursor-todo-selection-as-state-change)))
19498 (org-call-with-arg 'org-todo 'right)))
19499 ((or (and org-support-shift-select
19500 (not (eq org-support-shift-select 'always))
19501 (org-at-item-bullet-p))
19502 (and (not org-support-shift-select) (org-at-item-p)))
19503 (org-call-with-arg 'org-cycle-list-bullet nil))
19504 ((and (not (eq org-support-shift-select 'always))
19505 (org-at-property-p))
19506 (call-interactively 'org-property-next-allowed-value))
19507 ((org-clocktable-try-shift 'right arg))
19508 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19509 (org-support-shift-select
19510 (org-call-for-shift-select 'forward-char))
19511 (t (org-shiftselect-error))))
19513 (defun org-shiftleft (&optional arg)
19514 "Cycle the thing at point or in the current line, depending on context.
19515 Depending on context, this does one of the following:
19517 - switch a timestamp at point one day into the past
19518 - on a headline, switch to the previous TODO keyword.
19519 - on an item, switch entire list to the previous bullet type
19520 - on a property line, switch to the previous allowed value
19521 - on a clocktable definition line, move time block into the past"
19522 (interactive "P")
19523 (cond
19524 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19525 ((and org-support-shift-select (org-region-active-p))
19526 (org-call-for-shift-select 'backward-char))
19527 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19528 ((and (not (eq org-support-shift-select 'always))
19529 (org-at-heading-p))
19530 (let ((org-inhibit-logging
19531 (not org-treat-S-cursor-todo-selection-as-state-change))
19532 (org-inhibit-blocking
19533 (not org-treat-S-cursor-todo-selection-as-state-change)))
19534 (org-call-with-arg 'org-todo 'left)))
19535 ((or (and org-support-shift-select
19536 (not (eq org-support-shift-select 'always))
19537 (org-at-item-bullet-p))
19538 (and (not org-support-shift-select) (org-at-item-p)))
19539 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19540 ((and (not (eq org-support-shift-select 'always))
19541 (org-at-property-p))
19542 (call-interactively 'org-property-previous-allowed-value))
19543 ((org-clocktable-try-shift 'left arg))
19544 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19545 (org-support-shift-select
19546 (org-call-for-shift-select 'backward-char))
19547 (t (org-shiftselect-error))))
19549 (defun org-shiftcontrolright ()
19550 "Switch to next TODO set."
19551 (interactive)
19552 (cond
19553 ((and org-support-shift-select (org-region-active-p))
19554 (org-call-for-shift-select 'forward-word))
19555 ((and (not (eq org-support-shift-select 'always))
19556 (org-at-heading-p))
19557 (org-call-with-arg 'org-todo 'nextset))
19558 (org-support-shift-select
19559 (org-call-for-shift-select 'forward-word))
19560 (t (org-shiftselect-error))))
19562 (defun org-shiftcontrolleft ()
19563 "Switch to previous TODO set."
19564 (interactive)
19565 (cond
19566 ((and org-support-shift-select (org-region-active-p))
19567 (org-call-for-shift-select 'backward-word))
19568 ((and (not (eq org-support-shift-select 'always))
19569 (org-at-heading-p))
19570 (org-call-with-arg 'org-todo 'previousset))
19571 (org-support-shift-select
19572 (org-call-for-shift-select 'backward-word))
19573 (t (org-shiftselect-error))))
19575 (defun org-shiftcontrolup (&optional n)
19576 "Change timestamps synchronously up in CLOCK log lines.
19577 Optional argument N tells to change by that many units."
19578 (interactive "P")
19579 (cond ((and (not org-support-shift-select)
19580 (org-at-clock-log-p)
19581 (org-at-timestamp-p t))
19582 (org-clock-timestamps-up n))
19583 (t (org-shiftselect-error))))
19585 (defun org-shiftcontroldown (&optional n)
19586 "Change timestamps synchronously down in CLOCK log lines.
19587 Optional argument N tells to change by that many units."
19588 (interactive "P")
19589 (cond ((and (not org-support-shift-select)
19590 (org-at-clock-log-p)
19591 (org-at-timestamp-p t))
19592 (org-clock-timestamps-down n))
19593 (t (org-shiftselect-error))))
19595 (defun org-ctrl-c-ret ()
19596 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19597 (interactive)
19598 (cond
19599 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19600 (t (call-interactively 'org-insert-heading))))
19602 (defun org-find-visible ()
19603 (let ((s (point)))
19604 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19605 (get-char-property s 'invisible)))
19606 s))
19607 (defun org-find-invisible ()
19608 (let ((s (point)))
19609 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19610 (not (get-char-property s 'invisible))))
19611 s))
19613 (defun org-copy-visible (beg end)
19614 "Copy the visible parts of the region."
19615 (interactive "r")
19616 (let (snippets s)
19617 (save-excursion
19618 (save-restriction
19619 (narrow-to-region beg end)
19620 (setq s (goto-char (point-min)))
19621 (while (not (= (point) (point-max)))
19622 (goto-char (org-find-invisible))
19623 (push (buffer-substring s (point)) snippets)
19624 (setq s (goto-char (org-find-visible))))))
19625 (kill-new (apply 'concat (nreverse snippets)))))
19627 (defun org-copy-special ()
19628 "Copy region in table or copy current subtree.
19629 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19630 See the individual commands for more information."
19631 (interactive)
19632 (call-interactively
19633 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19635 (defun org-cut-special ()
19636 "Cut region in table or cut current subtree.
19637 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19638 See the individual commands for more information."
19639 (interactive)
19640 (call-interactively
19641 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19643 (defun org-paste-special (arg)
19644 "Paste rectangular region into table, or past subtree relative to level.
19645 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19646 See the individual commands for more information."
19647 (interactive "P")
19648 (if (org-at-table-p)
19649 (org-table-paste-rectangle)
19650 (org-paste-subtree arg)))
19652 (defsubst org-in-fixed-width-region-p ()
19653 "Is point in a fixed-width region?"
19654 (save-match-data
19655 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19657 (defun org-edit-special (&optional arg)
19658 "Call a special editor for the element at point.
19659 When at a table, call the formula editor with `org-table-edit-formulas'.
19660 When in a source code block, call `org-edit-src-code'.
19661 When in a fixed-width region, call `org-edit-fixed-width-region'.
19662 When at an #+INCLUDE keyword, visit the included file.
19663 On a link, call `ffap' to visit the link at point.
19664 Otherwise, return a user error."
19665 (interactive)
19666 (let ((element (org-element-at-point)))
19667 (assert (not buffer-read-only) nil
19668 "Buffer is read-only: %s" (buffer-name))
19669 (case (org-element-type element)
19670 (src-block
19671 (if (not arg) (org-edit-src-code)
19672 (let* ((info (org-babel-get-src-block-info))
19673 (lang (nth 0 info))
19674 (params (nth 2 info))
19675 (session (cdr (assq :session params))))
19676 (if (not session) (org-edit-src-code)
19677 ;; At a src-block with a session and function called with
19678 ;; an ARG: switch to the buffer related to the inferior
19679 ;; process.
19680 (funcall (intern (concat "org-babel-prep-session:" lang))
19681 session params)))))
19682 (keyword
19683 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
19684 (find-file
19685 (org-remove-double-quotes
19686 (car (org-split-string (org-element-property :value element)))))
19687 (user-error "No special environment to edit here")))
19688 (table
19689 (if (eq (org-element-property :type element) 'table.el)
19690 (org-edit-src-code)
19691 (call-interactively 'org-table-edit-formulas)))
19692 ;; Only Org tables contain `table-row' type elements.
19693 (table-row (call-interactively 'org-table-edit-formulas))
19694 ((example-block export-block) (org-edit-src-code))
19695 (fixed-width (org-edit-fixed-width-region))
19696 (otherwise
19697 ;; No notable element at point. Though, we may be at a link,
19698 ;; which is an object. Thus, scan deeper.
19699 (if (eq (org-element-type (org-element-context element)) 'link)
19700 (call-interactively 'ffap)
19701 (user-error "No special environment to edit here"))))))
19703 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19704 (defun org-ctrl-c-ctrl-c (&optional arg)
19705 "Set tags in headline, or update according to changed information at point.
19707 This command does many different things, depending on context:
19709 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19710 this is what we do.
19712 - If the cursor is on a statistics cookie, update it.
19714 - If the cursor is in a headline, prompt for tags and insert them
19715 into the current line, aligned to `org-tags-column'. When called
19716 with prefix arg, realign all tags in the current buffer.
19718 - If the cursor is in one of the special #+KEYWORD lines, this
19719 triggers scanning the buffer for these lines and updating the
19720 information.
19722 - If the cursor is inside a table, realign the table. This command
19723 works even if the automatic table editor has been turned off.
19725 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19726 the entire table.
19728 - If the cursor is at a footnote reference or definition, jump to
19729 the corresponding definition or references, respectively.
19731 - If the cursor is a the beginning of a dynamic block, update it.
19733 - If the current buffer is a capture buffer, close note and file it.
19735 - If the cursor is on a <<<target>>>, update radio targets and
19736 corresponding links in this buffer.
19738 - If the cursor is on a numbered item in a plain list, renumber the
19739 ordered list.
19741 - If the cursor is on a checkbox, toggle it.
19743 - If the cursor is on a code block, evaluate it. The variable
19744 `org-confirm-babel-evaluate' can be used to control prompting
19745 before code block evaluation, by default every code block
19746 evaluation requires confirmation. Code block evaluation can be
19747 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19748 (interactive "P")
19749 (cond
19750 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19751 org-occur-highlights
19752 org-latex-fragment-image-overlays)
19753 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19754 (org-remove-occur-highlights)
19755 (org-remove-latex-fragment-image-overlays)
19756 (message "Temporary highlights/overlays removed from current buffer"))
19757 ((and (local-variable-p 'org-finish-function (current-buffer))
19758 (fboundp org-finish-function))
19759 (funcall org-finish-function))
19760 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19761 (t
19762 (let* ((context (org-element-context)) (type (org-element-type context)))
19763 ;; Test if point is within a blank line.
19765 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19766 (user-error "C-c C-c can do nothing useful at this location"))
19767 ;; For convenience: at the first line of a paragraph on the
19768 ;; same line as an item, apply function on that item instead.
19769 (when (eq type 'paragraph)
19770 (let ((parent (org-element-property :parent context)))
19771 (when (and (eq (org-element-type parent) 'item)
19772 (= (point-at-bol) (org-element-property :begin parent)))
19773 (setq context parent type 'item))))
19774 ;; Act according to type of element or object at point.
19775 (case type
19776 (clock (org-clock-update-time-maybe))
19777 (dynamic-block
19778 (save-excursion
19779 (goto-char (org-element-property :post-affiliated context))
19780 (org-update-dblock)))
19781 (footnote-definition
19782 (goto-char (org-element-property :post-affiliated context))
19783 (call-interactively 'org-footnote-action))
19784 (footnote-reference (call-interactively 'org-footnote-action))
19785 ((headline inlinetask)
19786 (save-excursion (goto-char (org-element-property :begin context))
19787 (call-interactively 'org-set-tags)))
19788 (item
19789 ;; At an item: a double C-u set checkbox to "[-]"
19790 ;; unconditionally, whereas a single one will toggle its
19791 ;; presence. Without an universal argument, if the item
19792 ;; has a checkbox, toggle it. Otherwise repair the list.
19793 (let* ((box (org-element-property :checkbox context))
19794 (struct (org-element-property :structure context))
19795 (old-struct (copy-tree struct))
19796 (parents (org-list-parents-alist struct))
19797 (prevs (org-list-prevs-alist struct))
19798 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
19799 (org-list-set-checkbox
19800 (org-element-property :begin context) struct
19801 (cond ((equal arg '(16)) "[-]")
19802 ((and (not box) (equal arg '(4))) "[ ]")
19803 ((or (not box) (equal arg '(4))) nil)
19804 ((eq box 'on) "[ ]")
19805 (t "[X]")))
19806 ;; Mimic `org-list-write-struct' but with grabbing
19807 ;; a return value from `org-list-struct-fix-box'.
19808 (org-list-struct-fix-ind struct parents 2)
19809 (org-list-struct-fix-item-end struct)
19810 (org-list-struct-fix-bul struct prevs)
19811 (org-list-struct-fix-ind struct parents)
19812 (let ((block-item
19813 (org-list-struct-fix-box struct parents prevs orderedp)))
19814 (if (and box (equal struct old-struct))
19815 (if (equal arg '(16))
19816 (message "Checkboxes already reset")
19817 (user-error "Cannot toggle this checkbox: %s"
19818 (if (eq box 'on)
19819 "all subitems checked"
19820 "unchecked subitems")))
19821 (org-list-struct-apply-struct struct old-struct)
19822 (org-update-checkbox-count-maybe))
19823 (when block-item
19824 (message "Checkboxes were removed due to empty box at line %d"
19825 (org-current-line block-item))))))
19826 (keyword
19827 (let ((org-inhibit-startup-visibility-stuff t)
19828 (org-startup-align-all-tables nil))
19829 (when (boundp 'org-table-coordinate-overlays)
19830 (mapc 'delete-overlay org-table-coordinate-overlays)
19831 (setq org-table-coordinate-overlays nil))
19832 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19833 (message "Local setup has been refreshed"))
19834 (plain-list
19835 ;; At a plain list, with a double C-u argument, set
19836 ;; checkboxes of each item to "[-]", whereas a single one
19837 ;; will toggle their presence according to the state of the
19838 ;; first item in the list. Without an argument, repair the
19839 ;; list.
19840 (let* ((begin (org-element-property :contents-begin context))
19841 (struct (org-element-property :structure context))
19842 (old-struct (copy-tree struct))
19843 (first-box (save-excursion
19844 (goto-char begin)
19845 (looking-at org-list-full-item-re)
19846 (match-string-no-properties 3)))
19847 (new-box (cond ((equal arg '(16)) "[-]")
19848 ((equal arg '(4)) (unless first-box "[ ]"))
19849 ((equal first-box "[X]") "[ ]")
19850 (t "[X]"))))
19851 (cond
19852 (arg
19853 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
19854 (org-list-get-all-items
19855 begin struct (org-list-prevs-alist struct))))
19856 ((and first-box (eq (point) begin))
19857 ;; For convenience, when point is at bol on the first
19858 ;; item of the list and no argument is provided, simply
19859 ;; toggle checkbox of that item, if any.
19860 (org-list-set-checkbox begin struct new-box)))
19861 (org-list-write-struct
19862 struct (org-list-parents-alist struct) old-struct)
19863 (org-update-checkbox-count-maybe)
19864 (save-excursion (goto-char begin) (org-list-send-list 'maybe))))
19865 ((property-drawer node-property)
19866 (call-interactively 'org-property-action))
19867 ((radio-target target)
19868 (call-interactively 'org-update-radio-target-regexp))
19869 (statistics-cookie
19870 (call-interactively 'org-update-statistics-cookies))
19871 ((table table-cell table-row)
19872 ;; At a table, recalculate every field and align it. Also
19873 ;; send the table if necessary. If the table has
19874 ;; a `table.el' type, just give up. At a table row or
19875 ;; cell, maybe recalculate line but always align table.
19876 (if (eq (org-element-property :type context) 'table.el)
19877 (message "Use C-c ' to edit table.el tables")
19878 (let ((org-enable-table-editor t))
19879 (if (or (eq type 'table)
19880 ;; Check if point is at a TBLFM line.
19881 (and (eq type 'table-row)
19882 (= (point) (org-element-property :end context))))
19883 (save-excursion
19884 (goto-char (org-element-property :contents-begin context))
19885 (org-call-with-arg 'org-table-recalculate (or arg t))
19886 (orgtbl-send-table 'maybe))
19887 (org-table-maybe-eval-formula)
19888 (cond (arg (call-interactively 'org-table-recalculate))
19889 ((org-table-maybe-recalculate-line))
19890 (t (org-table-align)))))))
19891 (timestamp (org-timestamp-change 0 'day))
19892 (otherwise
19893 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19894 (user-error
19895 "C-c C-c can do nothing useful at this location")))))))))
19897 (defun org-mode-restart ()
19898 "Restart Org-mode, to scan again for special lines.
19899 Also updates the keyword regular expressions."
19900 (interactive)
19901 (org-mode)
19902 (message "Org-mode restarted"))
19904 (defun org-kill-note-or-show-branches ()
19905 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19906 (interactive)
19907 (if (not org-finish-function)
19908 (progn
19909 (hide-subtree)
19910 (call-interactively 'show-branches))
19911 (let ((org-note-abort t))
19912 (funcall org-finish-function))))
19914 (defun org-return (&optional indent)
19915 "Goto next table row or insert a newline.
19916 Calls `org-table-next-row' or `newline', depending on context.
19917 See the individual commands for more information."
19918 (interactive)
19919 (let (org-ts-what)
19920 (cond
19921 ((or (bobp) (org-in-src-block-p))
19922 (if indent (newline-and-indent) (newline)))
19923 ((org-at-table-p)
19924 (org-table-justify-field-maybe)
19925 (call-interactively 'org-table-next-row))
19926 ;; when `newline-and-indent' is called within a list, make sure
19927 ;; text moved stays inside the item.
19928 ((and (org-in-item-p) indent)
19929 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19930 (progn
19931 (save-match-data (newline))
19932 (org-indent-line-to (length (match-string 0))))
19933 (let ((ind (org-get-indentation)))
19934 (newline)
19935 (if (org-looking-back org-list-end-re)
19936 (org-indent-line)
19937 (org-indent-line-to ind)))))
19938 ((and org-return-follows-link
19939 (org-at-timestamp-p t)
19940 (not (eq org-ts-what 'after)))
19941 (org-follow-timestamp-link))
19942 ((and org-return-follows-link
19943 (let ((tprop (get-text-property (point) 'face)))
19944 (or (eq tprop 'org-link)
19945 (and (listp tprop) (memq 'org-link tprop)))))
19946 (call-interactively 'org-open-at-point))
19947 ((and (org-at-heading-p)
19948 (looking-at
19950 (org-show-entry)
19951 (end-of-line 1)
19952 (newline))
19953 (t (if indent (newline-and-indent) (newline))))))
19955 (defun org-return-indent ()
19956 "Goto next table row or insert a newline and indent.
19957 Calls `org-table-next-row' or `newline-and-indent', depending on
19958 context. See the individual commands for more information."
19959 (interactive)
19960 (org-return t))
19962 (defun org-ctrl-c-star ()
19963 "Compute table, or change heading status of lines.
19964 Calls `org-table-recalculate' or `org-toggle-heading',
19965 depending on context."
19966 (interactive)
19967 (cond
19968 ((org-at-table-p)
19969 (call-interactively 'org-table-recalculate))
19970 (t
19971 ;; Convert all lines in region to list items
19972 (call-interactively 'org-toggle-heading))))
19974 (defun org-ctrl-c-minus ()
19975 "Insert separator line in table or modify bullet status of line.
19976 Also turns a plain line or a region of lines into list items.
19977 Calls `org-table-insert-hline', `org-toggle-item', or
19978 `org-cycle-list-bullet', depending on context."
19979 (interactive)
19980 (cond
19981 ((org-at-table-p)
19982 (call-interactively 'org-table-insert-hline))
19983 ((org-region-active-p)
19984 (call-interactively 'org-toggle-item))
19985 ((org-in-item-p)
19986 (call-interactively 'org-cycle-list-bullet))
19987 (t
19988 (call-interactively 'org-toggle-item))))
19990 (defun org-toggle-item (arg)
19991 "Convert headings or normal lines to items, items to normal lines.
19992 If there is no active region, only the current line is considered.
19994 If the first non blank line in the region is a headline, convert
19995 all headlines to items, shifting text accordingly.
19997 If it is an item, convert all items to normal lines.
19999 If it is normal text, change region into an item. With a prefix
20000 argument ARG, change each line in region into an item."
20001 (interactive "P")
20002 (let ((shift-text
20003 (function
20004 ;; Shift text in current section to IND, from point to END.
20005 ;; The function leaves point to END line.
20006 (lambda (ind end)
20007 (let ((min-i 1000) (end (copy-marker end)))
20008 ;; First determine the minimum indentation (MIN-I) of
20009 ;; the text.
20010 (save-excursion
20011 (catch 'exit
20012 (while (< (point) end)
20013 (let ((i (org-get-indentation)))
20014 (cond
20015 ;; Skip blank lines and inline tasks.
20017 ((looking-at org-outline-regexp-bol))
20018 ;; We can't find less than 0 indentation.
20019 ((zerop i) (throw 'exit (setq min-i 0)))
20020 ((< i min-i) (setq min-i i))))
20021 (forward-line))))
20022 ;; Then indent each line so that a line indented to
20023 ;; MIN-I becomes indented to IND. Ignore blank lines
20024 ;; and inline tasks in the process.
20025 (let ((delta (- ind min-i)))
20026 (while (< (point) end)
20028 (looking-at org-outline-regexp-bol))
20029 (org-indent-line-to (+ (org-get-indentation) delta)))
20030 (forward-line)))))))
20031 (skip-blanks
20032 (function
20033 ;; Return beginning of first non-blank line, starting from
20034 ;; line at POS.
20035 (lambda (pos)
20036 (save-excursion
20037 (goto-char pos)
20039 (point-at-bol)))))
20040 beg end)
20041 ;; Determine boundaries of changes.
20042 (if (org-region-active-p)
20043 (setq beg (funcall skip-blanks (region-beginning))
20044 end (copy-marker (region-end)))
20045 (setq beg (funcall skip-blanks (point-at-bol))
20046 end (copy-marker (point-at-eol))))
20047 ;; Depending on the starting line, choose an action on the text
20048 ;; between BEG and END.
20049 (org-with-limited-levels
20050 (save-excursion
20051 (goto-char beg)
20052 (cond
20053 ;; Case 1. Start at an item: de-itemize. Note that it only
20054 ;; happens when a region is active: `org-ctrl-c-minus'
20055 ;; would call `org-cycle-list-bullet' otherwise.
20056 ((org-at-item-p)
20057 (while (< (point) end)
20058 (when (org-at-item-p)
20060 (delete-region (point) (match-end 0)))
20061 (forward-line)))
20062 ;; Case 2. Start at an heading: convert to items.
20063 ((org-at-heading-p)
20064 (let* ((bul (org-list-bullet-string "-"))
20065 (bul-len (length bul))
20066 ;; Indentation of the first heading. It should be
20067 ;; relative to the indentation of its parent, if any.
20068 (start-ind (save-excursion
20069 (cond
20070 ((not org-adapt-indentation) 0)
20071 ((not (outline-previous-heading)) 0)
20072 (t (length (match-string 0))))))
20073 ;; Level of first heading. Further headings will be
20074 ;; compared to it to determine hierarchy in the list.
20075 (ref-level (org-reduced-level (org-outline-level))))
20076 (while (< (point) end)
20077 (let* ((level (org-reduced-level (org-outline-level)))
20078 (delta (max 0 (- level ref-level))))
20079 ;; If current headline is less indented than the first
20080 ;; one, set it as reference, in order to preserve
20081 ;; subtrees.
20082 (when (< level ref-level) (setq ref-level level))
20083 (replace-match bul t t)
20084 (org-indent-line-to (+ start-ind (* delta bul-len)))
20085 ;; Ensure all text down to END (or SECTION-END) belongs
20086 ;; to the newly created item.
20087 (let ((section-end (save-excursion
20088 (or (outline-next-heading) (point)))))
20089 (forward-line)
20090 (funcall shift-text
20091 (+ start-ind (* (1+ delta) bul-len))
20092 (min end section-end)))))))
20093 ;; Case 3. Normal line with ARG: turn each non-item line into
20094 ;; an item.
20095 (arg
20096 (while (< (point) end)
20097 (unless (or (org-at-heading-p) (org-at-item-p))
20099 (replace-match
20101 (forward-line)))
20102 ;; Case 4. Normal line without ARG: make the first line of
20103 ;; region an item, and shift indentation of others
20104 ;; lines to set them as item's body.
20105 (t (let* ((bul (org-list-bullet-string "-"))
20106 (bul-len (length bul))
20107 (ref-ind (org-get-indentation)))
20109 (insert bul)
20110 (forward-line)
20111 (while (< (point) end)
20112 ;; Ensure that lines less indented than first one
20113 ;; still get included in item body.
20114 (funcall shift-text
20115 (+ ref-ind bul-len)
20116 (min end (save-excursion (or (outline-next-heading)
20117 (point)))))
20118 (forward-line)))))))))
20120 (defun org-toggle-heading (&optional nstars)
20121 "Convert headings to normal text, or items or text to headings.
20122 If there is no active region, only the current line is considered.
20125 point into heading.
20127 In a region:
20129 - If the first non blank line is a headline, remove the stars
20130 from all headlines in the region.
20132 - If it is a normal line turn each and every normal line (i.e. not an
20133 heading or an item) in the region into a heading.
20135 - If it is a plain list item, turn all plain list items into headings.
20137 When converting a line into a heading, the number of stars is chosen
20138 such that the lines become children of the current entry. However,
20139 when a prefix argument is given, its value determines the number of
20140 stars to add."
20141 (interactive "P")
20142 (let ((skip-blanks
20143 (function
20144 ;; Return beginning of first non-blank line, starting from
20145 ;; line at POS.
20146 (lambda (pos)
20147 (save-excursion
20148 (goto-char pos)
20149 (while (org-at-comment-p) (forward-line))
20151 (point-at-bol)))))
20152 beg end toggled)
20153 ;; Determine boundaries of changes. If a universal prefix has
20154 ;; been given, put the list in a region. If region ends at a bol,
20155 ;; do not consider the last line to be in the region.
20157 (when (and current-prefix-arg (org-at-item-p))
20158 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
20159 (org-mark-element))
20161 (if (org-region-active-p)
20162 (setq beg (funcall skip-blanks (region-beginning))
20163 end (copy-marker (save-excursion
20164 (goto-char (region-end))
20165 (if (bolp) (point) (point-at-eol)))))
20166 (setq beg (funcall skip-blanks (point-at-bol))
20167 end (copy-marker (point-at-eol))))
20168 ;; Ensure inline tasks don't count as headings.
20169 (org-with-limited-levels
20170 (save-excursion
20171 (goto-char beg)
20172 (cond
20173 ;; Case 1. Started at an heading: de-star headings.
20174 ((org-at-heading-p)
20175 (while (< (point) end)
20176 (when (org-at-heading-p t)
20177 (looking-at org-outline-regexp) (replace-match "")
20178 (setq toggled t))
20179 (forward-line)))
20180 ;; Case 2. Started at an item: change items into headlines.
20181 ;; One star will be added by `org-list-to-subtree'.
20182 ((org-at-item-p)
20183 (let* ((stars (make-string
20184 (if nstars
20185 ;; subtract the star that will be added again by
20186 ;; `org-list-to-subtree'
20187 (1- (prefix-numeric-value current-prefix-arg))
20188 (or (org-current-level) 0))
20189 ?*))
20190 (add-stars
20191 (cond (nstars "") ; stars from prefix only
20192 ((equal stars "") "") ; before first heading
20193 (org-odd-levels-only "*") ; inside heading, odd
20194 (t "")))) ; inside heading, oddeven
20195 (while (< (point) end)
20196 (when (org-at-item-p)
20197 ;; Pay attention to cases when region ends before list.
20198 (let* ((struct (org-list-struct))
20199 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20200 (save-restriction
20201 (narrow-to-region (point) list-end)
20202 (insert
20203 (org-list-to-subtree
20204 (org-list-parse-list t)
20205 '(:istart (concat stars add-stars (funcall get-stars depth))
20206 :icount (concat stars add-stars (funcall get-stars depth)))))))
20207 (setq toggled t))
20208 (forward-line))))
20209 ;; Case 3. Started at normal text: make every line an heading,
20210 ;; skipping headlines and items.
20211 (t (let* ((stars (make-string
20212 (if nstars
20213 (prefix-numeric-value current-prefix-arg)
20214 (or (org-current-level) 0))
20215 ?*))
20216 (add-stars
20217 (cond (nstars "") ; stars from prefix only
20218 ((equal stars "") "*") ; before first heading
20219 (org-odd-levels-only "**") ; inside heading, odd
20220 (t "*"))) ; inside heading, oddeven
20221 (rpl (concat stars add-stars " ")))
20222 (while (< (point) end)
20223 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20225 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20226 (forward-line)))))))
20227 (unless toggled (message "Cannot toggle heading from here"))))
20229 (defun org-meta-return (&optional arg)
20230 "Insert a new heading or wrap a region in a table.
20231 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20232 See the individual commands for more information."
20233 (interactive "P")
20234 (cond
20235 ((run-hook-with-args-until-success 'org-metareturn-hook))
20236 ((or (org-at-drawer-p) (org-at-property-p))
20237 (newline-and-indent))
20238 ((org-at-table-p)
20239 (call-interactively 'org-table-wrap-region))
20240 (t (call-interactively 'org-insert-heading))))
20242 ;;; Menu entries
20244 (defsubst org-in-subtree-not-table-p ()
20245 "Are we in a subtree and not in a table?"
20246 (and (not (org-before-first-heading-p))
20247 (not (org-at-table-p))))
20249 ;; Define the Org-mode menus
20250 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20251 '("Tbl"
20252 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20253 ["Next Field" org-cycle (org-at-table-p)]
20254 ["Previous Field" org-shifttab (org-at-table-p)]
20255 ["Next Row" org-return (org-at-table-p)]
20256 "--"
20257 ["Blank Field" org-table-blank-field (org-at-table-p)]
20258 ["Edit Field" org-table-edit-field (org-at-table-p)]
20259 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20260 "--"
20261 ("Column"
20262 ["Move Column Left" org-metaleft (org-at-table-p)]
20263 ["Move Column Right" org-metaright (org-at-table-p)]
20264 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20265 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20266 ("Row"
20267 ["Move Row Up" org-metaup (org-at-table-p)]
20268 ["Move Row Down" org-metadown (org-at-table-p)]
20269 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20270 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20271 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20272 "--"
20273 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20274 ("Rectangle"
20275 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20276 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20277 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20278 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20279 "--"
20280 ("Calculate"
20281 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20282 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20283 ["Edit Formulas" org-edit-special (org-at-table-p)]
20284 "--"
20285 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20286 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20287 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20288 "--"
20289 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20290 "--"
20291 ["Sum Column/Rectangle" org-table-sum
20292 (or (org-at-table-p) (org-region-active-p))]
20293 ["Which Column?" org-table-current-column (org-at-table-p)])
20294 ["Debug Formulas"
20295 org-table-toggle-formula-debugger
20296 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20297 ["Show Col/Row Numbers"
20298 org-table-toggle-coordinate-overlays
20299 :style toggle
20300 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20301 "--"
20302 ["Create" org-table-create (and (not (org-at-table-p))
20303 org-enable-table-editor)]
20304 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20305 ["Import from File" org-table-import (not (org-at-table-p))]
20306 ["Export to File" org-table-export (org-at-table-p)]
20307 "--"
20308 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20310 (easy-menu-define org-org-menu org-mode-map "Org menu"
20311 '("Org"
20312 ("Show/Hide"
20313 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20314 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20315 ["Sparse Tree..." org-sparse-tree t]
20316 ["Reveal Context" org-reveal t]
20317 ["Show All" show-all t]
20318 "--"
20319 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20320 "--"
20321 ["New Heading" org-insert-heading t]
20322 ("Navigate Headings"
20323 ["Up" outline-up-heading t]
20324 ["Next" outline-next-visible-heading t]
20325 ["Previous" outline-previous-visible-heading t]
20326 ["Next Same Level" outline-forward-same-level t]
20327 ["Previous Same Level" outline-backward-same-level t]
20328 "--"
20329 ["Jump" org-goto t])
20330 ("Edit Structure"
20331 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20332 "--"
20333 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20334 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20335 "--"
20336 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20337 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20338 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20339 "--"
20340 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20341 "--"
20342 ["Copy visible text" org-copy-visible t]
20343 "--"
20344 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20345 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20346 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20347 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20348 "--"
20349 ["Sort Region/Children" org-sort t]
20350 "--"
20351 ["Convert to odd levels" org-convert-to-odd-levels t]
20352 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20353 ("Editing"
20354 ["Emphasis..." org-emphasize t]
20355 ["Edit Source Example" org-edit-special t]
20356 "--"
20357 ["Footnote new/jump" org-footnote-action t]
20358 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20359 ("Archive"
20360 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20361 "--"
20362 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20363 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20364 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20365 )
20366 "--"
20367 ("Hyperlinks"
20368 ["Store Link (Global)" org-store-link t]
20369 ["Find existing link to here" org-occur-link-in-agenda-files t]
20370 ["Insert Link" org-insert-link t]
20371 ["Follow Link" org-open-at-point t]
20372 "--"
20373 ["Next link" org-next-link t]
20374 ["Previous link" org-previous-link t]
20375 "--"
20376 ["Descriptive Links"
20377 org-toggle-link-display
20378 :style radio
20379 :selected org-descriptive-links
20380 ]
20381 ["Literal Links"
20382 org-toggle-link-display
20383 :style radio
20384 :selected (not org-descriptive-links)])
20385 "--"
20386 ("TODO Lists"
20387 ["TODO/DONE/-" org-todo t]
20388 ("Select keyword"
20389 ["Next keyword" org-shiftright (org-at-heading-p)]
20390 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20391 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20392 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20393 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20394 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20395 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20396 "--"
20397 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20398 :selected org-enforce-todo-dependencies :style toggle :active t]
20399 "Settings for tree at point"
20400 ["Do Children sequentially" org-toggle-ordered-property :style radio
20401 :selected (org-entry-get nil "ORDERED")
20402 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20403 ["Do Children parallel" org-toggle-ordered-property :style radio
20404 :selected (not (org-entry-get nil "ORDERED"))
20405 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20406 "--"
20407 ["Set Priority" org-priority t]
20408 ["Priority Up" org-shiftup t]
20409 ["Priority Down" org-shiftdown t]
20410 "--"
20411 ["Get news from all feeds" org-feed-update-all t]
20412 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20413 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20414 ("TAGS and Properties"
20415 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20416 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20417 "--"
20418 ["Set property" org-set-property (not (org-before-first-heading-p))]
20419 ["Column view of properties" org-columns t]
20420 ["Insert Column View DBlock" org-insert-columns-dblock t])
20421 ("Dates and Scheduling"
20422 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20423 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20424 ("Change Date"
20425 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20426 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20427 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20428 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20429 ["Compute Time Range" org-evaluate-time-range t]
20430 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20431 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20432 "--"
20433 ["Custom time format" org-toggle-time-stamp-overlays
20434 :style radio :selected org-display-custom-times]
20435 "--"
20436 ["Goto Calendar" org-goto-calendar t]
20437 ["Date from Calendar" org-date-from-calendar t]
20438 "--"
20439 ["Start/Restart Timer" org-timer-start t]
20440 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20441 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20442 ["Insert Timer String" org-timer t]
20443 ["Insert Timer Item" org-timer-item t])
20444 ("Logging work"
20445 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20446 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20447 ["Clock out" org-clock-out t]
20448 ["Clock cancel" org-clock-cancel t]
20449 "--"
20450 ["Mark as default task" org-clock-mark-default-task t]
20451 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20452 ["Goto running clock" org-clock-goto t]
20453 "--"
20454 ["Display times" org-clock-display t]
20455 ["Create clock table" org-clock-report t]
20456 "--"
20457 ["Record DONE time"
20458 (progn (setq org-log-done (not org-log-done))
20459 (message "Switching to %s will %s record a timestamp"
20460 (car org-done-keywords)
20461 (if org-log-done "automatically" "not")))
20462 :style toggle :selected org-log-done])
20463 "--"
20464 ["Agenda Command..." org-agenda t]
20465 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20466 ("File List for Agenda")
20467 ("Special views current file"
20468 ["TODO Tree" org-show-todo-tree t]
20469 ["Check Deadlines" org-check-deadlines t]
20470 ["Timeline" org-timeline t]
20471 ["Tags/Property tree" org-match-sparse-tree t])
20472 "--"
20473 ["Export/Publish..." org-export-dispatch t]
20474 ("LaTeX"
20475 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20476 :selected org-cdlatex-mode]
20477 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20478 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20479 ["Modify math symbol" org-cdlatex-math-modify
20480 (org-inside-LaTeX-fragment-p)]
20481 ["Insert citation" org-reftex-citation t]
20482 "--"
20483 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20484 "--"
20485 ("MobileOrg"
20486 ["Push Files and Views" org-mobile-push t]
20487 ["Get Captured and Flagged" org-mobile-pull t]
20488 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20489 "--"
20490 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20491 "--"
20492 ("Documentation"
20493 ["Show Version" org-version t]
20494 ["Info Documentation" org-info t])
20495 ("Customize"
20496 ["Browse Org Group" org-customize t]
20497 "--"
20498 ["Expand This Menu" org-create-customize-menu
20499 (fboundp 'customize-menu-create)])
20500 ["Send bug report" org-submit-bug-report t]
20501 "--"
20502 ("Refresh/Reload"
20503 ["Refresh setup current buffer" org-mode-restart t]
20504 ["Reload Org (after update)" org-reload t]
20505 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20506 ))
20508 (defun org-info (&optional node)
20509 "Read documentation for Org-mode in the info system.
20510 With optional NODE, go directly to that node."
20511 (interactive)
20512 (info (format "(org)%s" (or node ""))))
20514 ;;;###autoload
20515 (defun org-submit-bug-report ()
20516 "Submit a bug report on Org-mode via mail.
20518 Don't hesitate to report any problems or inaccurate documentation.
20520 If you don't have setup sending mail from (X)Emacs, please copy the
20521 output buffer into your mail program, as it gives us important
20522 information about your Org-mode version and configuration."
20523 (interactive)
20524 (require 'reporter)
20525 (org-load-modules-maybe)
20526 (org-require-autoloaded-modules)
20527 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20528 (reporter-submit-bug-report
20529 "emacs-orgmode@gnu.org"
20530 (org-version nil 'full)
20531 (let (list)
20532 (save-window-excursion
20533 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20534 (delete-other-windows)
20535 (erase-buffer)
20536 (insert "You are about to submit a bug report to the Org-mode mailing list.
20538 We would like to add your full Org-mode and Outline configuration to the
20539 bug report. This greatly simplifies the work of the maintainer and
20540 other experts on the mailing list.
20542 HOWEVER, some variables you have customized may contain private
20543 information. The names of customers, colleagues, or friends, might
20544 appear in the form of file names, tags, todo states, or search strings.
20545 If you answer yes to the prompt, you might want to check and remove
20546 such private information before sending the email.")
20547 (add-text-properties (point-min) (point-max) '(face org-warning))
20548 (when (yes-or-no-p "Include your Org-mode configuration ")
20549 (mapatoms
20550 (lambda (v)
20551 (and (boundp v)
20553 (or (and (symbol-value v)
20555 (and
20556 (get v 'custom-type) (get v 'standard-value)
20557 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20558 (push v list)))))
20559 (kill-buffer (get-buffer "*Warn about privacy*"))
20560 list))
20561 nil nil
20562 "Remember to cover the basics, that is, what you expected to happen and
20563 what in fact did happen. You don't know how to make a good report? See
20565 http://orgmode.org/manual/Feedback.html#Feedback
20567 Your bug report will be posted to the Org-mode mailing list.
20568 ------------------------------------------------------------------------")
20569 (save-excursion
20574 (defun org-install-agenda-files-menu ()
20575 (let ((bl (buffer-list)))
20576 (save-excursion
20577 (while bl
20578 (set-buffer (pop bl))
20579 (if (derived-mode-p 'org-mode) (setq bl nil)))
20580 (when (derived-mode-p 'org-mode)
20581 (easy-menu-change
20582 '("Org") "File List for Agenda"
20583 (append
20584 (list
20585 ["Edit File List" (org-edit-agenda-file-list) t]
20586 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20587 ["Remove Current File from List" org-remove-file t]
20588 ["Cycle through agenda files" org-cycle-agenda-files t]
20589 ["Occur in all agenda files" org-occur-in-agenda-files t]
20590 "--")
20591 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20593 ;;;; Documentation
20595 (defun org-require-autoloaded-modules ()
20596 (interactive)
20597 (mapc 'require
20598 '(org-agenda org-archive org-attach org-clock org-colview org-id
20599 org-remember org-table org-timer)))
20601 ;;;###autoload
20602 (defun org-reload (&optional uncompiled)
20603 "Reload all org lisp files.
20604 With prefix arg UNCOMPILED, load the uncompiled versions."
20605 (interactive "P")
20606 (require 'loadhist)
20607 (let* ((org-dir (org-find-library-dir "org"))
20608 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20610 (remove-re (mapconcat 'identity
20611 (mapcar (lambda (f) (concat "^" f "$"))
20612 (list (if (featurep 'xemacs)
20613 "org-colview"
20614 "org-colview-xemacs")
20615 "org" "org-loaddefs" "org-version"))
20617 (feats (delete-dups
20618 (mapcar 'file-name-sans-extension
20619 (mapcar 'file-name-nondirectory
20620 (delq nil
20621 (mapcar 'feature-file
20622 features))))))
20623 (lfeat (append
20624 (sort
20625 (setq feats
20626 (delq nil (mapcar
20627 (lambda (f)
20628 (if (and (string-match feature-re f)
20629 (not (string-match remove-re f)))
20630 f nil))
20631 feats)))
20632 'string-lessp)
20633 (list "org-version" "org")))
20634 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20635 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20636 load-uncore load-misses)
20637 (setq load-misses
20638 (delq 't
20639 (mapcar (lambda (f)
20640 (or (org-load-noerror-mustsuffix (concat org-dir f))
20641 (and (string= org-dir contrib-dir)
20642 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20643 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20644 (add-to-list 'load-uncore f 'append)
20645 't)
20646 f))
20647 lfeat)))
20648 (if load-uncore
20650 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20651 (if load-misses
20653 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20656 ;;;###autoload
20657 (defun org-customize ()
20658 "Call the customize function with org as argument."
20659 (interactive)
20660 (org-load-modules-maybe)
20661 (org-require-autoloaded-modules)
20662 (customize-browse 'org))
20664 (defun org-create-customize-menu ()
20665 "Create a full customization menu for Org-mode, insert it into the menu."
20666 (interactive)
20667 (org-load-modules-maybe)
20668 (org-require-autoloaded-modules)
20669 (if (fboundp 'customize-menu-create)
20670 (progn
20671 (easy-menu-change
20672 '("Org") "Customize"
20673 `(["Browse Org group" org-customize t]
20674 "--"
20675 ,(customize-menu-create 'org)
20676 ["Set" Custom-set t]
20677 ["Save" Custom-save t]
20678 ["Reset to Current" Custom-reset-current t]
20679 ["Reset to Saved" Custom-reset-saved t]
20680 ["Reset to Standard Settings" Custom-reset-standard t]))
20682 (error "Cannot expand menu (outdated version of cus-edit.el)")))
20684 ;;;; Miscellaneous stuff
20686 ;;; Generally useful functions
20688 (defun org-get-at-bol (property)
20689 "Get text property PROPERTY at beginning of line."
20690 (get-text-property (point-at-bol) property))
20692 (defun org-find-text-property-in-string (prop s)
20693 "Return the first non-nil value of property PROP in string S."
20694 (or (get-text-property 0 prop s)
20695 (get-text-property (or (next-single-property-change 0 prop s) 0)
20696 prop s)))
20698 (defun org-display-warning (message) ;; Copied from Emacs-Muse
20699 "Display the given MESSAGE as a warning."
20700 (if (fboundp 'display-warning)
20701 (display-warning 'org message
20702 (if (featurep 'xemacs) 'warning :warning))
20703 (let ((buf (get-buffer-create "*Org warnings*")))
20704 (with-current-buffer buf
20705 (goto-char (point-max))
20706 (insert "Warning (Org): " message)
20707 (unless (bolp)
20708 (newline)))
20709 (display-buffer buf)
20710 (sit-for 0))))
20712 (defun org-eval (form)
20713 "Eval FORM and return result."
20714 (condition-case error
20715 (eval form)
20716 (error (format "%%![Error: %s]" error))))
20718 (defun org-in-clocktable-p ()
20719 "Check if the cursor is in a clocktable."
20720 (let ((pos (point)) start)
20721 (save-excursion
20722 (end-of-line 1)
20724 (setq start (match-beginning 0))
20726 (>= (match-end 0) pos)
20727 start))))
20729 (defun org-in-commented-line ()
20730 "Is point in a line starting with `#'?"
20731 (equal (char-after (point-at-bol)) ?#))
20733 (defun org-in-indented-comment-line ()
20734 "Is point in a line starting with `#' after some white space?"
20735 (save-excursion
20736 (save-match-data
20737 (goto-char (point-at-bol))
20740 (defun org-in-verbatim-emphasis ()
20741 (save-match-data
20742 (and (org-in-regexp org-emph-re 2)
20743 (>= (point) (match-beginning 3))
20744 (<= (point) (match-end 4))
20745 (member (match-string 3) '("=" "~")))))
20747 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20748 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20749 (if (and marker (marker-buffer marker)
20750 (buffer-live-p (marker-buffer marker)))
20751 (progn
20752 (org-pop-to-buffer-same-window (marker-buffer marker))
20753 (if (or (> marker (point-max)) (< marker (point-min)))
20754 (widen))
20755 (goto-char marker)
20756 (org-show-context 'org-goto))
20757 (if bookmark
20758 (bookmark-jump bookmark)
20759 (error "Cannot find location"))))
20761 (defun org-quote-csv-field (s)
20762 "Quote field for inclusion in CSV material."
20765 s))
20767 (defun org-force-self-insert (N)
20768 "Needed to enforce self-insert under remapping."
20769 (interactive "p")
20770 (self-insert-command N))
20772 (defun org-string-width (s)
20773 "Compute width of string, ignoring invisible characters.
20774 This ignores character with invisibility property `org-link', and also
20775 characters with property `org-cwidth', because these will become invisible
20776 upon the next fontification round."
20777 (let (b l)
20778 (when (or (eq t buffer-invisibility-spec)
20779 (assq 'org-link buffer-invisibility-spec))
20780 (while (setq b (text-property-any 0 (length s)
20781 'invisible 'org-link s))
20782 (setq s (concat (substring s 0 b)
20783 (substring s (or (next-single-property-change
20784 b 'invisible s) (length s)))))))
20785 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20786 (setq s (concat (substring s 0 b)
20787 (substring s (or (next-single-property-change
20788 b 'org-cwidth s) (length s))))))
20789 (setq l (string-width s) b -1)
20790 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20791 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20792 l))
20794 (defun org-shorten-string (s maxlength)
20795 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20796 If the string is shorter or has length MAXLENGTH, just return the
20797 original string. If it is longer, the functions finds a space in the
20798 string, breaks this string off at that locations and adds three dots
20799 as ellipsis. Including the ellipsis, the string will not be longer
20800 than MAXLENGTH. If finding a good breaking point in the string does
20801 not work, the string is just chopped off in the middle of a word
20802 if necessary."
20803 (if (<= (length s) maxlength)
20804 s
20805 (let* ((n (max (- maxlength 4) 1))
20807 (if (string-match re s)
20808 (concat (match-string 1 s) "...")
20809 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20811 (defun org-get-indentation (&optional line)
20812 "Get the indentation of the current line, interpreting tabs.
20813 When LINE is given, assume it represents a line and compute its indentation."
20814 (if line
20815 (if (string-match "^ *" (org-remove-tabs line))
20816 (match-end 0))
20817 (save-excursion
20818 (beginning-of-line 1)
20820 (current-column))))
20822 (defun org-get-string-indentation (s)
20823 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20824 (let ((n -1) (i 0) (w tab-width) c)
20825 (catch 'exit
20826 (while (< (setq n (1+ n)) (length s))
20827 (setq c (aref s n))
20828 (cond ((= c ?\ ) (setq i (1+ i)))
20830 (t (throw 'exit t)))))
20831 i))
20833 (defun org-remove-tabs (s &optional width)
20834 "Replace tabulators in S with spaces.
20835 Assumes that s is a single line, starting in column 0."
20836 (setq width (or width tab-width))
20838 (setq s (replace-match
20839 (make-string
20840 (- (* width (/ (+ (match-beginning 0) width) width))
20841 (match-beginning 0)) ?\ )
20842 t t s)))
20843 s)
20845 (defun org-fix-indentation (line ind)
20846 "Fix indentation in LINE.
20847 IND is a cons cell with target and minimum indentation.
20848 If the current indentation in LINE is smaller than the minimum,
20849 leave it alone. If it is larger than ind, set it to the target."
20850 (let* ((l (org-remove-tabs line))
20851 (i (org-get-indentation l))
20852 (i1 (car ind)) (i2 (cdr ind)))
20853 (if (>= i i2) (setq l (substring line i2)))
20854 (if (> i1 0)
20855 (concat (make-string i1 ?\ ) l)
20856 l)))
20858 (defun org-remove-indentation (code &optional n)
20859 "Remove the maximum common indentation from the lines in CODE.
20860 N may optionally be the number of spaces to remove."
20861 (with-temp-buffer
20862 (insert code)
20863 (org-do-remove-indentation n)
20864 (buffer-string)))
20866 (defun org-do-remove-indentation (&optional n)
20867 "Remove the maximum common indentation from the buffer."
20868 (untabify (point-min) (point-max))
20869 (let ((min 10000) re)
20870 (if n
20871 (setq min n)
20872 (goto-char (point-min))
20874 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20875 (unless (or (= min 0) (= min 10000))
20877 (goto-char (point-min))
20878 (while (re-search-forward re nil t)
20879 (replace-match "")
20880 (end-of-line 1))
20881 min)))
20883 (defun org-fill-template (template alist)
20884 "Find each %key of ALIST in TEMPLATE and replace it."
20885 (let ((case-fold-search nil)
20886 entry key value)
20887 (setq alist (sort (copy-sequence alist)
20888 (lambda (a b) (< (length (car a)) (length (car b))))))
20889 (while (setq entry (pop alist))
20890 (setq template
20891 (replace-regexp-in-string
20892 (concat "%" (regexp-quote (car entry)))
20893 (or (cdr entry) "") template t t)))
20894 template))
20896 (defun org-base-buffer (buffer)
20897 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20898 (if (not buffer)
20899 buffer
20900 (or (buffer-base-buffer buffer)
20901 buffer)))
20903 (defun org-trim (s)
20904 "Remove whitespace at beginning and end of string."
20907 s)
20909 (defun org-wrap (string &optional width lines)
20910 "Wrap string to either a number of lines, or a width in characters.
20911 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20912 that costs. If there is a word longer than WIDTH, the text is actually
20913 wrapped to the length of that word.
20914 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20915 many lines, whatever width that takes.
20916 The return value is a list of lines, without newlines at the end."
20918 (maxword (apply 'max (mapcar 'org-string-width words)))
20919 w ll)
20920 (cond (width
20921 (org-do-wrap words (max maxword width)))
20922 (lines
20923 (setq w maxword)
20924 (setq ll (org-do-wrap words maxword))
20925 (if (<= (length ll) lines)
20926 ll
20927 (setq ll words)
20928 (while (> (length ll) lines)
20929 (setq w (1+ w))
20930 (setq ll (org-do-wrap words w)))
20931 ll))
20932 (t (error "Cannot wrap this")))))
20934 (defun org-do-wrap (words width)
20935 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20936 (let (lines line)
20937 (while words
20938 (setq line (pop words))
20939 (while (and words (< (+ (length line) (length (car words))) width))
20940 (setq line (concat line " " (pop words))))
20941 (setq lines (push line lines)))
20942 (nreverse lines)))
20944 (defun org-split-string (string &optional separators)
20945 "Splits STRING into substrings at SEPARATORS.
20946 No empty strings are returned if there are matches at the beginning
20947 and end of string."
20949 (start 0)
20950 notfirst
20951 (list nil))
20952 (while (and (string-match rexp string
20953 (if (and notfirst
20954 (= start (match-beginning 0))
20955 (< start (length string)))
20956 (1+ start) start))
20957 (< (match-beginning 0) (length string)))
20958 (setq notfirst t)
20959 (or (eq (match-beginning 0) 0)
20960 (and (eq (match-beginning 0) (match-end 0))
20961 (eq (match-beginning 0) start))
20962 (setq list
20963 (cons (substring string start (match-beginning 0))
20964 list)))
20965 (setq start (match-end 0)))
20966 (or (eq start (length string))
20967 (setq list
20968 (cons (substring string start)
20969 list)))
20970 (nreverse list)))
20972 (defun org-quote-vert (s)
20974 (while (string-match "|" s)
20976 s)
20978 (defun org-uuidgen-p (s)
20979 "Is S an ID created by UUIDGEN?"
20980 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20982 (defun org-in-src-block-p (&optional inside)
20983 "Whether point is in a code source block.
20984 When INSIDE is non-nil, don't consider we are within a src block
20985 when point is at #+BEGIN_SRC or #+END_SRC."
20986 (let ((case-fold-search t) ov)
20987 (or (and (setq ov (overlays-at (point)))
20988 (memq 'org-block-background
20989 (overlay-properties (car ov))))
20990 (and (not inside)
20991 (save-match-data
20992 (save-excursion
20993 (beginning-of-line)
20996 (defun org-context ()
20997 "Return a list of contexts of the current cursor position.
20998 If several contexts apply, all are returned.
20999 Each context entry is a list with a symbol naming the context, and
21000 two positions indicating start and end of the context. Possible
21001 contexts are:
21003 :headline anywhere in a headline
21004 :headline-stars on the leading stars in a headline
21005 :todo-keyword on a TODO keyword (including DONE) in a headline
21006 :tags on the TAGS in a headline
21007 :priority on the priority cookie in a headline
21008 :item on the first line of a plain list item
21009 :item-bullet on the bullet/number of a plain list item
21010 :checkbox on the checkbox in a plain list item
21011 :table in an org-mode table
21012 :table-special on a special filed in a table
21013 :table-table in a table.el table
21014 :clocktable in a clocktable
21015 :src-block in a source block
21016 :link on a hyperlink
21017 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21018 :target on a <<target>>
21019 :radio-target on a <<<radio-target>>>
21020 :latex-fragment on a LaTeX fragment
21021 :latex-preview on a LaTeX fragment with overlaid preview image
21023 This function expects the position to be visible because it uses font-lock
21024 faces as a help to recognize the following contexts: :table-special, :link,
21025 and :keyword."
21026 (let* ((f (get-text-property (point) 'face))
21027 (faces (if (listp f) f (list f)))
21028 (case-fold-search t)
21029 (p (point)) clist o)
21030 ;; First the large context
21031 (cond
21032 ((org-at-heading-p t)
21033 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21034 (when (progn
21035 (beginning-of-line 1)
21036 (looking-at org-todo-line-tags-regexp))
21037 (push (org-point-in-group p 1 :headline-stars) clist)
21038 (push (org-point-in-group p 2 :todo-keyword) clist)
21039 (push (org-point-in-group p 4 :tags) clist))
21040 (goto-char p)
21043 (push (org-point-in-group p 0 :priority) clist)))
21045 ((org-at-item-p)
21046 (push (org-point-in-group p 2 :item-bullet) clist)
21047 (push (list :item (point-at-bol)
21048 (save-excursion (org-end-of-item) (point)))
21049 clist)
21050 (and (org-at-item-checkbox-p)
21051 (push (org-point-in-group p 0 :checkbox) clist)))
21053 ((org-at-table-p)
21054 (push (list :table (org-table-begin) (org-table-end)) clist)
21055 (if (memq 'org-formula faces)
21056 (push (list :table-special
21057 (previous-single-property-change p 'face)
21058 (next-single-property-change p 'face)) clist)))
21059 ((org-at-table-p 'any)
21060 (push (list :table-table) clist)))
21061 (goto-char p)
21063 (let ((case-fold-search t))
21064 ;; New the "medium" contexts: clocktables, source blocks
21065 (cond ((org-in-clocktable-p)
21066 (push (list :clocktable
21068 (search-backward "#+BEGIN: clocktable" nil t))
21069 (match-beginning 0))
21071 (match-end 0))) clist))
21072 ((org-in-src-block-p)
21073 (push (list :src-block
21075 (search-backward "#+BEGIN_SRC" nil t))
21076 (match-beginning 0))
21077 (and (search-forward "#+END_SRC" nil t)
21078 (match-beginning 0))) clist))))
21079 (goto-char p)
21081 ;; Now the small context
21082 (cond
21083 ((org-at-timestamp-p)
21084 (push (org-point-in-group p 0 :timestamp) clist))
21085 ((memq 'org-link faces)
21086 (push (list :link
21087 (previous-single-property-change p 'face)
21088 (next-single-property-change p 'face)) clist))
21089 ((memq 'org-special-keyword faces)
21090 (push (list :keyword
21091 (previous-single-property-change p 'face)
21092 (next-single-property-change p 'face)) clist))
21093 ((org-at-target-p)
21094 (push (org-point-in-group p 0 :target) clist)
21095 (goto-char (1- (match-beginning 0)))
21096 (if (looking-at org-radio-target-regexp)
21097 (push (org-point-in-group p 0 :radio-target) clist))
21098 (goto-char p))
21099 ((setq o (car (delq nil
21100 (mapcar
21101 (lambda (x)
21102 (if (memq x org-latex-fragment-image-overlays) x))
21103 (overlays-at (point))))))
21104 (push (list :latex-fragment
21105 (overlay-start o) (overlay-end o)) clist)
21106 (push (list :latex-preview
21107 (overlay-start o) (overlay-end o)) clist))
21108 ((org-inside-LaTeX-fragment-p)
21109 ;; FIXME: positions wrong.
21110 (push (list :latex-fragment (point) (point)) clist)))
21112 (setq clist (nreverse (delq nil clist)))
21113 clist))
21115 ;; FIXME: Compare with at-regexp-p Do we need both?
21116 (defun org-in-regexp (re &optional nlines visually)
21117 "Check if point is inside a match of regexp.
21118 Normally only the current line is checked, but you can include NLINES extra
21119 lines both before and after point into the search.
21120 If VISUALLY is set, require that the cursor is not after the match but
21121 really on, so that the block visually is on the match."
21122 (catch 'exit
21123 (let ((pos (point))
21124 (eol (point-at-eol (+ 1 (or nlines 0))))
21125 (inc (if visually 1 0)))
21126 (save-excursion
21127 (beginning-of-line (- 1 (or nlines 0)))
21128 (while (re-search-forward re eol t)
21129 (if (and (<= (match-beginning 0) pos)
21130 (>= (+ inc (match-end 0)) pos))
21131 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21133 (defun org-at-regexp-p (regexp)
21134 "Is point inside a match of REGEXP in the current line?"
21135 (catch 'exit
21136 (save-excursion
21137 (let ((pos (point)) (end (point-at-eol)))
21138 (beginning-of-line 1)
21139 (while (re-search-forward regexp end t)
21140 (if (and (<= (match-beginning 0) pos)
21141 (>= (match-end 0) pos))
21142 (throw 'exit t)))
21143 nil))))
21145 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21146 "Non-nil when point is between matches of START-RE and END-RE.
21148 Also return a non-nil value when point is on one of the matches.
21150 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21151 buffer positions. Default values are the positions of headlines
21152 surrounding the point.
21154 The functions returns a cons cell whose car (resp. cdr) is the
21155 position before START-RE (resp. after END-RE)."
21156 (save-match-data
21157 (let ((pos (point))
21158 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21159 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21160 beg end)
21161 (save-excursion
21162 ;; Point is on a block when on START-RE or if START-RE can be
21163 ;; found before it...
21164 (and (or (org-at-regexp-p start-re)
21165 (re-search-backward start-re limit-up t))
21166 (setq beg (match-beginning 0))
21167 ;; ... and END-RE after it...
21168 (goto-char (match-end 0))
21169 (re-search-forward end-re limit-down t)
21170 (> (setq end (match-end 0)) pos)
21171 ;; ... without another START-RE in-between.
21172 (goto-char (match-beginning 0))
21173 (not (re-search-backward start-re (1+ beg) t))
21174 ;; Return value.
21175 (cons beg end))))))
21177 (defun org-in-block-p (names)
21178 "Non-nil when point belongs to a block whose name belongs to NAMES.
21180 NAMES is a list of strings containing names of blocks.
21182 Return first block name matched, or nil. Beware that in case of
21183 nested blocks, the returned name may not belong to the closest
21184 block from point."
21185 (save-match-data
21186 (catch 'exit
21187 (let ((case-fold-search t)
21188 (lim-up (save-excursion (outline-previous-heading)))
21189 (lim-down (save-excursion (outline-next-heading))))
21190 (mapc (lambda (name)
21191 (let ((n (regexp-quote name)))
21192 (when (org-between-regexps-p
21195 lim-up lim-down)
21196 (throw 'exit n))))
21197 names))
21198 nil)))
21200 (defun org-occur-in-agenda-files (regexp &optional nlines)
21201 "Call `multi-occur' with buffers for all agenda files."
21203 (let* ((files (org-agenda-files))
21204 (tnames (mapcar 'file-truename files))
21205 (extra org-agenda-text-search-extra-files)
21206 f)
21207 (when (eq (car extra) 'agenda-archives)
21208 (setq extra (cdr extra))
21209 (setq files (org-add-archive-files files)))
21210 (while (setq f (pop extra))
21211 (unless (member (file-truename f) tnames)
21212 (add-to-list 'files f 'append)
21213 (add-to-list 'tnames (file-truename f) 'append)))
21214 (multi-occur
21215 (mapcar (lambda (x)
21216 (with-current-buffer
21217 (or (get-file-buffer x) (find-file-noselect x))
21218 (widen)
21219 (current-buffer)))
21220 files)
21221 regexp)))
21223 (if (boundp 'occur-mode-find-occurrence-hook)
21224 ;; Emacs 23
21225 (add-hook 'occur-mode-find-occurrence-hook
21226 (lambda ()
21227 (when (derived-mode-p 'org-mode)
21228 (org-reveal))))
21229 ;; Emacs 22
21230 (defadvice occur-mode-goto-occurrence
21231 (after org-occur-reveal activate)
21232 (and (derived-mode-p 'org-mode) (org-reveal)))
21233 (defadvice occur-mode-goto-occurrence-other-window
21234 (after org-occur-reveal activate)
21235 (and (derived-mode-p 'org-mode) (org-reveal)))
21236 (defadvice occur-mode-display-occurrence
21237 (after org-occur-reveal activate)
21238 (when (derived-mode-p 'org-mode)
21239 (let ((pos (occur-mode-find-occurrence)))
21240 (with-current-buffer (marker-buffer pos)
21241 (save-excursion
21242 (goto-char pos)
21243 (org-reveal)))))))
21245 (defun org-occur-link-in-agenda-files ()
21246 "Create a link and search for it in the agendas.
21247 The link is not stored in `org-stored-links', it is just created
21248 for the search purpose."
21249 (interactive)
21250 (let ((link (condition-case nil
21251 (org-store-link nil)
21252 (error "Unable to create a link to here"))))
21253 (org-occur-in-agenda-files (regexp-quote link))))
21255 (defun org-reverse-string (string)
21256 "Return the reverse of STRING."
21257 (apply 'string (reverse (string-to-list string))))
21259 (defun org-uniquify (list)
21260 "Remove duplicate elements from LIST."
21261 (let (res)
21262 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
21263 res))
21265 (defun org-delete-all (elts list)
21266 "Remove all elements in ELTS from LIST."
21267 (while elts
21268 (setq list (delete (pop elts) list)))
21269 list)
21271 (defun org-count (cl-item cl-seq)
21272 "Count the number of occurrences of ITEM in SEQ.
21273 Taken from `count' in cl-seq.el with all keyword arguments removed."
21274 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21275 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21276 (while (< cl-start cl-end)
21277 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21278 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21279 (setq cl-start (1+ cl-start)))
21280 cl-count))
21282 (defun org-remove-if (predicate seq)
21283 "Remove everything from SEQ that fulfills PREDICATE."
21284 (let (res e)
21285 (while seq
21286 (setq e (pop seq))
21287 (if (not (funcall predicate e)) (push e res)))
21288 (nreverse res)))
21290 (defun org-remove-if-not (predicate seq)
21291 "Remove everything from SEQ that does not fulfill PREDICATE."
21292 (let (res e)
21293 (while seq
21294 (setq e (pop seq))
21295 (if (funcall predicate e) (push e res)))
21296 (nreverse res)))
21298 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21299 "Reduce two-argument FUNCTION across SEQ.
21300 Taken from `reduce' in cl-seq.el with all keyword arguments but
21302 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21303 (cadr (memq :initial-value cl-keys)))
21304 (cl-seq (pop cl-seq))
21305 (t (funcall cl-func)))))
21306 (while cl-seq
21307 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21308 cl-accum))
21310 (defun org-back-over-empty-lines ()
21311 "Move backwards over whitespace, to the beginning of the first empty line.
21312 Returns the number of empty lines passed."
21313 (let ((pos (point)))
21314 (if (cdr (assoc 'heading org-blank-before-new-entry))
21316 (unless (eobp)
21317 (forward-line -1)))
21318 (beginning-of-line 2)
21319 (goto-char (min (point) pos))
21320 (count-lines (point) pos)))
21322 (defun org-skip-whitespace ()
21325 (defun org-point-in-group (point group &optional context)
21326 "Check if POINT is in match-group GROUP.
21327 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21328 match. If the match group does not exist or point is not inside it,
21329 return nil."
21330 (and (match-beginning group)
21331 (>= point (match-beginning group))
21332 (<= point (match-end group))
21333 (if context
21334 (list context (match-beginning group) (match-end group))
21335 t)))
21337 (defun org-switch-to-buffer-other-window (&rest args)
21338 "Switch to buffer in a second window on the current frame.
21339 In particular, do not allow pop-up frames.
21340 Returns the newly created buffer."
21341 (org-no-popups
21342 (apply 'switch-to-buffer-other-window args)))
21344 (defun org-combine-plists (&rest plists)
21345 "Create a single property list from all plists in PLISTS.
21346 The process starts by copying the first list, and then setting properties
21347 from the other lists. Settings in the last list are the most significant
21348 ones and overrule settings in the other lists."
21349 (let ((rtn (copy-sequence (pop plists)))
21350 p v ls)
21351 (while plists
21352 (setq ls (pop plists))
21353 (while ls
21354 (setq p (pop ls) v (pop ls))
21355 (setq rtn (plist-put rtn p v))))
21356 rtn))
21358 (defun org-replace-escapes (string table)
21359 "Replace %-escapes in STRING with values in TABLE.
21361 The sequences in STRING may contain normal field width and padding information,
21363 so values can contain further %-escapes if they are define later in TABLE."
21364 (let ((tbl (copy-alist table))
21365 (case-fold-search nil)
21366 (pchg 0)
21367 e re rpl)
21368 (while (setq e (pop tbl))
21369 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21370 (when (and (cdr e) (string-match re (cdr e)))
21371 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21372 (safe "SREF"))
21373 (add-text-properties 0 3 (list 'sref sref) safe)
21374 (setcdr e (replace-match safe t t (cdr e)))))
21375 (while (string-match re string)
21376 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21377 (cdr e)))
21378 (setq string (replace-match rpl t t string))))
21379 (while (setq pchg (next-property-change pchg string))
21380 (let ((sref (get-text-property pchg 'sref string)))
21381 (when (and sref (string-match "SREF" string pchg))
21382 (setq string (replace-match sref t t string)))))
21383 string))
21385 (defun org-sublist (list start end)
21386 "Return a section of LIST, from START to END.
21387 Counting starts at 1."
21388 (let (rtn (c start))
21389 (setq list (nthcdr (1- start) list))
21390 (while (and list (<= c end))
21391 (push (pop list) rtn)
21392 (setq c (1+ c)))
21393 (nreverse rtn)))
21395 (defun org-find-base-buffer-visiting (file)
21396 "Like `find-buffer-visiting' but always return the base buffer and
21397 not an indirect buffer."
21398 (let ((buf (or (get-file-buffer file)
21399 (find-buffer-visiting file))))
21400 (if buf
21401 (or (buffer-base-buffer buf) buf)
21402 nil)))
21404 (defun org-image-file-name-regexp (&optional extensions)
21405 "Return regexp matching the file names of images.
21406 If EXTENSIONS is given, only match these."
21407 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21408 (image-file-name-regexp)
21409 (let ((image-file-name-extensions
21410 (or extensions
21411 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21412 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21414 (regexp-opt (nconc (mapcar 'upcase
21415 image-file-name-extensions)
21416 image-file-name-extensions)
21417 t)
21420 (defun org-file-image-p (file &optional extensions)
21421 "Return non-nil if FILE is an image."
21422 (save-match-data
21423 (string-match (org-image-file-name-regexp extensions) file)))
21425 (defun org-get-cursor-date (&optional with-time)
21426 "Return the date at cursor in as a time.
21427 This works in the calendar and in the agenda, anywhere else it just
21428 returns the current time.
21429 If WITH-TIME is non-nil, returns the time of the event at point (in
21430 the agenda) or the current time of the day."
21431 (let (date day defd tp tm hod mod)
21432 (when with-time
21433 (setq tp (get-text-property (point) 'time))
21435 (setq hod (string-to-number (match-string 1 tp))
21436 mod (string-to-number (match-string 2 tp))))
21437 (or tp (setq hod (nth 2 (decode-time (current-time)))
21438 mod (nth 1 (decode-time (current-time))))))
21439 (cond
21440 ((eq major-mode 'calendar-mode)
21441 (setq date (calendar-cursor-to-date)
21442 defd (encode-time 0 (or mod 0) (or hod 0)
21443 (nth 1 date) (nth 0 date) (nth 2 date))))
21444 ((eq major-mode 'org-agenda-mode)
21445 (setq day (get-text-property (point) 'day))
21446 (if day
21447 (setq date (calendar-gregorian-from-absolute day)
21448 defd (encode-time 0 (or mod 0) (or hod 0)
21449 (nth 1 date) (nth 0 date) (nth 2 date))))))
21450 (or defd (current-time))))
21452 (defun org-mark-subtree (&optional up)
21453 "Mark the current subtree.
21454 This puts point at the start of the current subtree, and mark at
21455 the end. If a numeric prefix UP is given, move up into the
21456 hierarchy of headlines by UP levels before marking the subtree."
21457 (interactive "P")
21458 (org-with-limited-levels
21459 (cond ((org-at-heading-p) (beginning-of-line))
21460 ((org-before-first-heading-p) (error "Not in a subtree"))
21461 (t (outline-previous-visible-heading 1))))
21462 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21463 (if (org-called-interactively-p 'any)
21464 (call-interactively 'org-mark-element)
21465 (org-mark-element)))
21468 ;;; Indentation
21470 (defun org-indent-line ()
21471 "Indent line depending on context."
21472 (interactive)
21473 (let* ((pos (point))
21474 (itemp (org-at-item-p))
21475 (case-fold-search t)
21477 (inline-task-p (and (featurep 'org-inlinetask)
21478 (org-inlinetask-in-task-p)))
21479 (inline-re (and inline-task-p
21480 (org-inlinetask-outline-regexp)))
21481 column)
21482 (if (and orgstruct-is-++ (eq pos (point)))
21483 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21484 (indent-according-to-mode))
21485 (beginning-of-line 1)
21486 (cond
21487 ;; Headings
21488 ((looking-at org-outline-regexp) (setq column 0))
21489 ;; Footnote definition
21490 ((looking-at org-footnote-definition-re) (setq column 0))
21491 ;; Literal examples
21493 (setq column (org-get-indentation))) ; do nothing
21494 ;; Lists
21495 ((ignore-errors (goto-char (org-in-item-p)))
21496 (setq column (if itemp
21497 (org-get-indentation)
21498 (org-list-item-body-column (point))))
21499 (goto-char pos))
21500 ;; Drawers
21502 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21503 (save-excursion
21504 (goto-char (1- (match-beginning 1)))
21505 (setq column (current-column))))
21506 ;; Special blocks
21508 (save-excursion
21509 (re-search-backward
21511 (setq column (org-get-indentation (match-string 0))))
21514 (save-excursion
21516 (setq column
21517 (cond ((equal (downcase (match-string 1)) "src")
21518 ;; src blocks: let `org-edit-src-exit' handle them
21519 (org-get-indentation))
21520 ((equal (downcase (match-string 1)) "example")
21521 (max (org-get-indentation)
21522 (org-get-indentation (match-string 0))))
21523 (t
21524 (org-get-indentation (match-string 0))))))
21525 ;; This line has nothing special, look at the previous relevant
21526 ;; line to compute indentation
21527 (t
21528 (beginning-of-line 0)
21529 (while (and (not (bobp))
21530 (not (looking-at org-table-line-regexp))
21531 (not (looking-at org-drawer-regexp))
21532 ;; When point started in an inline task, do not move
21533 ;; above task starting line.
21534 (not (and inline-task-p (looking-at inline-re)))
21535 ;; Skip drawers, blocks, empty lines, verbatim,
21536 ;; comments, tables, footnotes definitions, lists,
21537 ;; inline tasks.
21539 (re-search-backward org-drawer-regexp nil t))
21543 (looking-at org-footnote-definition-re)
21544 (and (ignore-errors (goto-char (org-in-item-p)))
21545 (goto-char
21546 (org-list-get-top-point (org-list-struct))))
21547 (and (not inline-task-p)
21548 (featurep 'org-inlinetask)
21549 (org-inlinetask-in-task-p)
21550 (or (org-inlinetask-goto-beginning) t))))
21551 (beginning-of-line 0))
21552 (cond
21553 ;; There was an heading above.
21555 (if (not org-adapt-indentation)
21556 (setq column 0)
21557 (goto-char (match-end 0))
21558 (setq column (current-column))))
21559 ;; A drawer had started and is unfinished
21560 ((looking-at org-drawer-regexp)
21561 (goto-char (1- (match-beginning 1)))
21562 (setq column (current-column)))
21563 ;; Else, nothing noticeable found: get indentation and go on.
21564 (t (setq column (org-get-indentation))))))
21565 ;; Now apply indentation and move cursor accordingly
21566 (goto-char pos)
21567 (if (<= (current-column) (current-indentation))
21568 (org-indent-line-to column)
21569 (save-excursion (org-indent-line-to column)))
21570 ;; Special polishing for properties, see `org-property-format'
21571 (setq column (current-column))
21572 (beginning-of-line 1)
21573 (if (looking-at
21575 (replace-match (concat (match-string 1)
21576 (format org-property-format
21577 (match-string 2) (match-string 3)))
21578 t t))
21579 (org-move-to-column column))))
21581 (defun org-indent-drawer ()
21582 "Indent the drawer at point."
21583 (interactive)
21584 (let ((p (point))
21585 (e (and (save-excursion (re-search-forward ":END:" nil t))
21586 (match-end 0)))
21587 (folded
21588 (save-excursion
21589 (end-of-line)
21590 (when (overlays-at (point))
21591 (member 'invisible (overlay-properties
21592 (car (overlays-at (point)))))))))
21593 (when folded (org-cycle))
21594 (indent-for-tab-command)
21595 (while (and (move-beginning-of-line 2) (< (point) e))
21596 (indent-for-tab-command))
21597 (goto-char p)
21598 (when folded (org-cycle)))
21599 (message "Drawer at point indented"))
21601 (defun org-indent-block ()
21602 "Indent the block at point."
21603 (interactive)
21604 (let ((p (point))
21605 (case-fold-search t)
21607 (match-end 0)))
21608 (folded
21609 (save-excursion
21610 (end-of-line)
21611 (when (overlays-at (point))
21612 (member 'invisible (overlay-properties
21613 (car (overlays-at (point)))))))))
21614 (when folded (org-cycle))
21615 (indent-for-tab-command)
21616 (while (and (move-beginning-of-line 2) (< (point) e))
21617 (indent-for-tab-command))
21618 (goto-char p)
21619 (when folded (org-cycle)))
21620 (message "Block at point indented"))
21622 (defun org-indent-region (start end)
21623 "Indent region."
21624 (interactive "r")
21625 (save-excursion
21626 (let ((line-end (org-current-line end)))
21627 (goto-char start)
21628 (while (< (org-current-line) line-end)
21629 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21630 (t (call-interactively 'org-indent-line)))
21631 (move-beginning-of-line 2)))))
21634 ;;; Filling
21636 ;; We use our own fill-paragraph and auto-fill functions.
21638 ;; `org-fill-paragraph' relies on adaptive filling and context
21639 ;; checking. Appropriate `fill-prefix' is computed with
21640 ;; `org-adaptive-fill-function'.
21642 ;; `org-auto-fill-function' takes care of auto-filling. It calls
21643 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
21644 ;; `org-adaptive-fill-function' value. Internally,
21645 ;; `org-comment-line-break-function' breaks the line.
21647 ;; `org-setup-filling' installs filling and auto-filling related
21648 ;; variables during `org-mode' initialization.
21650 (defun org-setup-filling ()
21651 (interactive)
21652 ;; Prevent auto-fill from inserting unwanted new items.
21653 (when (boundp 'fill-nobreak-predicate)
21654 (org-set-local
21655 'fill-nobreak-predicate
21656 (org-uniquify
21657 (append fill-nobreak-predicate
21658 '(org-fill-paragraph-separate-nobreak-p
21659 org-fill-line-break-nobreak-p
21660 org-fill-paragraph-with-timestamp-nobreak-p)))))
21661 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
21662 (org-set-local 'auto-fill-inhibit-regexp nil)
21663 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
21664 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
21665 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
21667 (defvar org-element-paragraph-separate) ; org-element.el
21668 (defun org-fill-paragraph-separate-nobreak-p ()
21669 "Non-nil when a line break at point would insert a new item."
21670 (looking-at (substring org-element-paragraph-separate 1)))
21672 (defun org-fill-line-break-nobreak-p ()
21673 "Non-nil when a line break at point would create an Org line break."
21674 (save-excursion
21679 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
21680 "Non-nil when a line break at point would insert a new item."
21681 (and (org-at-timestamp-p t)
21682 (not (looking-at org-ts-regexp-both))))
21684 (declare-function message-in-body-p "message" ())
21685 (defvar orgtbl-line-start-regexp) ; From org-table.el
21686 (defun org-adaptive-fill-function ()
21687 "Compute a fill prefix for the current line.
21688 Return fill prefix, as a string, or nil if current line isn't
21689 meant to be filled."
21690 (let (prefix)
21691 (catch 'exit
21692 (when (derived-mode-p 'message-mode)
21693 (save-excursion
21694 (beginning-of-line)
21695 (cond ((or (not (message-in-body-p))
21696 (looking-at orgtbl-line-start-regexp))
21697 (throw 'exit nil))
21698 ((looking-at message-cite-prefix-regexp)
21699 (throw 'exit (match-string-no-properties 0)))
21700 ((looking-at org-outline-regexp)
21701 (throw 'exit (make-string (length (match-string 0)) ? ))))))
21702 (org-with-wide-buffer
21703 (let* ((p (line-beginning-position))
21704 (element (save-excursion (beginning-of-line)
21705 (org-element-at-point)))
21706 (type (org-element-type element))
21707 (post-affiliated (org-element-property :post-affiliated element)))
21708 (unless (and post-affiliated (< p post-affiliated))
21709 (case type
21711 (footnote-definition "")
21712 ((item plain-list)
21713 (make-string (org-list-item-body-column
21714 (or post-affiliated
21715 (org-element-property :begin element)))
21716 ? ))
21717 (paragraph
21718 ;; Fill prefix is usually the same as the current line,
21719 ;; except if the paragraph is at the beginning of an item.
21720 (let ((parent (org-element-property :parent element)))
21721 (cond ((eq (org-element-type parent) 'item)
21722 (make-string (org-list-item-body-column
21723 (org-element-property :begin parent))
21724 ? ))
21726 (match-string 0))
21727 (t ""))))
21728 (comment-block
21729 ;; Only fill contents if P is within block boundaries.
21730 (let* ((cbeg (save-excursion (goto-char post-affiliated)
21731 (forward-line)
21732 (point)))
21733 (cend (save-excursion
21734 (goto-char (org-element-property :end element))
21736 (line-beginning-position))))
21737 (when (and (>= p cbeg) (< p cend))
21739 (match-string 0)
21740 "")))))))))))
21742 (declare-function message-goto-body "message" ())
21743 (defvar message-cite-prefix-regexp) ; From message.el
21744 (defvar org-element-all-successors) ; From org-element.el
21745 (defun org-fill-paragraph (&optional justify)
21746 "Fill element at point, when applicable.
21748 This function only applies to comment blocks, comments, example
21749 blocks and paragraphs. Also, as a special case, re-align table
21750 when point is at one.
21752 If JUSTIFY is non-nil (interactively, with prefix argument),
21753 justify as well. If `sentence-end-double-space' is non-nil, then
21754 period followed by one space does not end a sentence, so don't
21755 break a line there. The variable `fill-column' controls the
21756 width for filling.
21758 For convenience, when point is at a plain list, an item or
21759 a footnote definition, try to fill the first paragraph within."
21760 (interactive)
21761 (if (and (derived-mode-p 'message-mode)
21762 (or (not (message-in-body-p))
21763 (save-excursion (move-beginning-of-line 1)
21764 (looking-at message-cite-prefix-regexp))))
21765 ;; First ensure filling is correct in message-mode.
21766 (let ((fill-paragraph-function
21767 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21768 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21769 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21770 (paragraph-separate
21771 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21772 (fill-paragraph nil))
21773 (with-syntax-table org-mode-transpose-word-syntax-table
21774 ;; Move to end of line in order to get the first paragraph
21775 ;; within a plain list or a footnote definition.
21776 (let ((element (save-excursion (end-of-line) (org-element-at-point))))
21777 ;; First check if point is in a blank line at the beginning of
21778 ;; the buffer. In that case, ignore filling.
21779 (case (org-element-type element)
21780 ;; Use major mode filling function is src blocks.
21781 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21782 ;; Align Org tables, leave table.el tables as-is.
21783 (table-row (org-table-align) t)
21784 (table
21785 (when (eq (org-element-property :type element) 'org)
21786 (org-table-align))
21787 t)
21788 (paragraph
21789 ;; Paragraphs may contain `line-break' type objects.
21790 (let ((beg (max (point-min)
21791 (org-element-property :contents-begin element)))
21792 (end (min (point-max)
21793 (org-element-property :contents-end element))))
21794 ;; Do nothing if point is at an affiliated keyword.
21795 (if (< (line-end-position) beg) t
21796 (when (derived-mode-p 'message-mode)
21797 ;; In `message-mode', do not fill following citation
21798 ;; in current paragraph nor text before message body.
21799 (let ((body-start (save-excursion (message-goto-body))))
21800 (when body-start (setq beg (max body-start beg))))
21801 (when (save-excursion
21802 (re-search-forward
21803 (concat "^" message-cite-prefix-regexp) end t))
21804 (setq end (match-beginning 0))))
21805 ;; Fill paragraph, taking line breaks into account.
21806 ;; For that, slice the paragraph using line breaks as
21807 ;; separators, and fill the parts in reverse order to
21808 ;; avoid messing with markers.
21809 (save-excursion
21810 (goto-char end)
21811 (mapc
21812 (lambda (pos)
21813 (fill-region-as-paragraph pos (point) justify)
21814 (goto-char pos))
21815 ;; Find the list of ending positions for line breaks
21816 ;; in the current paragraph. Add paragraph
21817 ;; beginning to include first slice.
21818 (nreverse
21819 (cons beg
21820 (org-element-map
21821 (org-element--parse-objects
21822 beg end nil org-element-all-successors)
21823 'line-break
21824 (lambda (lb) (org-element-property :end lb)))))))
21825 t)))
21826 ;; Contents of `comment-block' type elements should be
21827 ;; filled as plain text, but only if point is within block
21828 ;; markers.
21829 (comment-block
21830 (let* ((case-fold-search t)
21831 (beg (save-excursion
21832 (goto-char (org-element-property :begin element))
21834 (forward-line)
21835 (point)))
21836 (end (save-excursion
21837 (goto-char (org-element-property :end element))
21839 (line-beginning-position))))
21840 (when (and (>= (point) beg) (< (point) end))
21841 (fill-region-as-paragraph
21842 (save-excursion
21843 (end-of-line)
21845 (line-beginning-position))
21846 (save-excursion
21847 (beginning-of-line)
21849 (line-beginning-position))
21850 justify)))
21851 t)
21852 ;; Fill comments.
21853 (comment (fill-comment-paragraph justify))
21854 ;; Ignore every other element.
21855 (otherwise t))))))
21857 (defun org-auto-fill-function ()
21858 "Auto-fill function."
21859 ;; Check if auto-filling is meaningful.
21860 (let ((fc (current-fill-column)))
21861 (when (and fc (> (current-column) fc))
21862 (let* ((fill-prefix (org-adaptive-fill-function))
21863 ;; Enforce empty fill prefix, if required. Otherwise, it
21864 ;; will be computed again.
21865 (adaptive-fill-mode (not (equal fill-prefix ""))))
21866 (when fill-prefix (do-auto-fill))))))
21868 (defun org-comment-line-break-function (&optional soft)
21869 "Break line at point and indent, continuing comment if within one.
21870 The inserted newline is marked hard if variable
21871 `use-hard-newlines' is true, unless optional argument SOFT is
21872 non-nil."
21874 (save-excursion (forward-char -1) (delete-horizontal-space))
21875 (delete-horizontal-space)
21876 (indent-to-left-margin)
21877 (insert-before-markers-and-inherit fill-prefix))
21880 ;;; Comments
21882 ;; Org comments syntax is quite complex. It requires the entire line
21883 ;; to be just a comment. Also, even with the right syntax at the
21884 ;; beginning of line, some some elements (i.e. verse-block or
21885 ;; example-block) don't accept comments. Usual Emacs comment commands
21886 ;; cannot cope with those requirements. Therefore, Org replaces them.
21888 ;; Org still relies on `comment-dwim', but cannot trust
21889 ;; `comment-only-p'. So, `comment-region-function' and
21890 ;; `uncomment-region-function' both point
21891 ;; to`org-comment-or-uncomment-region'. Eventually,
21892 ;; `org-insert-comment' takes care of insertion of comments at the
21893 ;; beginning of line.
21895 ;; `org-setup-comments-handling' install comments related variables
21896 ;; during `org-mode' initialization.
21898 (defun org-setup-comments-handling ()
21899 (interactive)
21900 (org-set-local 'comment-use-syntax nil)
21901 (org-set-local 'comment-start "# ")
21903 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21904 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21905 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21907 (defun org-insert-comment ()
21908 "Insert an empty comment above current line.
21909 If the line is empty, insert comment at its beginning."
21910 (beginning-of-line)
21912 (org-indent-line)
21913 (insert "# "))
21915 (defvar comment-empty-lines) ; From newcomment.el.
21916 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21917 "Comment or uncomment each non-blank line in the region.
21918 Uncomment each non-blank line between BEG and END if it only
21919 contains commented lines. Otherwise, comment them."
21920 (save-restriction
21921 ;; Restrict region
21922 (narrow-to-region (save-excursion (goto-char beg)
21924 (line-beginning-position))
21925 (save-excursion (goto-char end)
21927 (line-end-position)))
21928 (let ((uncommentp
21929 ;; UNCOMMENTP is non-nil when every non blank line between
21930 ;; BEG and END is a comment.
21931 (save-excursion
21932 (goto-char (point-min))
21933 (while (and (not (eobp))
21934 (let ((element (org-element-at-point)))
21935 (and (eq (org-element-type element) 'comment)
21936 (goto-char (min (point-max)
21937 (org-element-property
21938 :end element)))))))
21939 (eobp))))
21940 (if uncommentp
21941 ;; Only blank lines and comments in region: uncomment it.
21942 (save-excursion
21943 (goto-char (point-min))
21944 (while (not (eobp))
21946 (replace-match "" nil nil nil 1))
21947 (forward-line)))
21948 ;; Comment each line in region.
21949 (let ((min-indent (point-max)))
21950 ;; First find the minimum indentation across all lines.
21951 (save-excursion
21952 (goto-char (point-min))
21953 (while (and (not (eobp)) (not (zerop min-indent)))
21955 (setq min-indent (min min-indent (current-indentation))))
21956 (forward-line)))
21957 ;; Then loop over all lines.
21958 (save-excursion
21959 (goto-char (point-min))
21960 (while (not (eobp))
21962 (org-move-to-column min-indent t)
21963 (insert comment-start))
21964 (forward-line))))))))
21967 ;;; Planning
21969 ;; This section contains tools to operate on timestamp objects, as
21970 ;; returned by, e.g. `org-element-context'.
21972 (defun org-timestamp-has-time-p (timestamp)
21973 "Non-nil when TIMESTAMP has a time specified."
21974 (org-element-property :hour-start timestamp))
21976 (defun org-timestamp-format (timestamp format &optional end utc)
21977 "Format a TIMESTAMP element into a string.
21979 FORMAT is a format specifier to be passed to
21980 `format-time-string'.
21982 When optional argument END is non-nil, use end of date-range or
21983 time-range, if possible.
21985 When optional argument UTC is non-nil, time will be expressed as
21986 Universal Time."
21987 (format-time-string
21988 format
21989 (apply 'encode-time
21990 (cons 0
21991 (mapcar
21992 (lambda (prop) (or (org-element-property prop timestamp) 0))
21993 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
21994 '(:minute-start :hour-start :day-start :month-start
21995 :year-start)))))
21996 utc))
21998 (defun org-timestamp-split-range (timestamp &optional end)
21999 "Extract a timestamp object from a date or time range.
22001 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22002 the end of the range. Otherwise, extract its start.
22004 Return a new timestamp object sharing the same parent as
22005 TIMESTAMP."
22006 (let ((type (org-element-property :type timestamp)))
22007 (if (memq type '(active inactive diary)) timestamp
22008 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22009 ;; Set new type.
22010 (org-element-put-property
22011 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22012 ;; Copy start properties over end properties if END is
22013 ;; non-nil. Otherwise, copy end properties over `start' ones.
22014 (let ((p-alist '((:minute-start . :minute-end)
22015 (:hour-start . :hour-end)
22016 (:day-start . :day-end)
22017 (:month-start . :month-end)
22018 (:year-start . :year-end))))
22019 (dolist (p-cell p-alist)
22020 (org-element-put-property
22021 split-ts
22022 (funcall (if end 'car 'cdr) p-cell)
22023 (org-element-property
22024 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22025 ;; Eventually refresh `:raw-value'.
22026 (org-element-put-property split-ts :raw-value nil)
22027 (org-element-put-property
22028 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22030 (defun org-timestamp-translate (timestamp &optional boundary)
22031 "Apply `org-translate-time' on a TIMESTAMP object.
22032 When optional argument BOUNDARY is non-nil, it is either the
22033 symbol `start' or `end'. In this case, only translate the
22034 starting or ending part of TIMESTAMP if it is a date or time
22035 range. Otherwise, translate both parts."
22036 (if (and (not boundary)
22037 (memq (org-element-property :type timestamp)
22038 '(active-range inactive-range)))
22039 (concat
22040 (org-translate-time
22041 (org-element-property :raw-value
22042 (org-timestamp-split-range timestamp)))
22043 "--"
22044 (org-translate-time
22045 (org-element-property :raw-value
22046 (org-timestamp-split-range timestamp t))))
22047 (org-translate-time
22048 (org-element-property
22049 :raw-value
22050 (if (not boundary) timestamp
22051 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22055 ;;; Other stuff.
22057 (defun org-toggle-fixed-width-section (arg)
22058 "Toggle the fixed-width export.
22059 If there is no active region, the QUOTE keyword at the current headline is
22060 inserted or removed. When present, it causes the text between this headline
22061 and the next to be exported as fixed-width text, and unmodified.
22062 If there is an active region, this command adds or removes a colon as the
22063 first character of this line. If the first character of a line is a colon,
22064 this line is also exported in fixed-width font."
22065 (interactive "P")
22066 (let* ((cc 0)
22067 (regionp (org-region-active-p))
22068 (beg (if regionp (region-beginning) (point)))
22069 (end (if regionp (region-end)))
22070 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22071 (case-fold-search nil)
22073 off)
22074 (if regionp
22075 (save-excursion
22076 (goto-char beg)
22077 (setq cc (current-column))
22078 (beginning-of-line 1)
22079 (setq off (looking-at re))
22080 (while (> nlines 0)
22081 (setq nlines (1- nlines))
22082 (beginning-of-line 1)
22083 (cond
22084 (arg
22085 (org-move-to-column cc t)
22087 (forward-line -1))
22088 ((and off (looking-at re))
22089 (replace-match "" t t nil 1))
22090 ((not off) (org-move-to-column cc t) (insert ": ")))
22091 (forward-line 1)))
22092 (save-excursion
22093 (org-back-to-heading)
22094 (cond
22095 ((looking-at (format org-heading-keyword-regexp-format
22096 org-quote-string))
22097 (goto-char (match-end 1))
22098 (looking-at (concat " +" org-quote-string))
22099 (replace-match "" t t)
22100 (when (eolp) (insert " ")))
22101 ((looking-at org-outline-regexp)
22102 (goto-char (match-end 0))
22103 (insert org-quote-string " ")))))))
22105 (defun org-reftex-citation ()
22106 "Use reftex-citation to insert a citation into the buffer.
22107 This looks for a line like
22109 #+BIBLIOGRAPHY: foo plain option:-d
22111 and derives from it that foo.bib is the bibliography file relevant
22112 for this document. It then installs the necessary environment for RefTeX
22113 to work in this buffer and calls `reftex-citation' to insert a citation
22114 into the buffer.
22116 Export of such citations to both LaTeX and HTML is handled by the contributed
22117 package org-exp-bibtex by Taru Karttunen."
22118 (interactive)
22119 (let ((reftex-docstruct-symbol 'rds)
22121 rds bib)
22122 (save-excursion
22123 (save-restriction
22124 (widen)
22125 (let ((case-fold-search t)
22127 (if (not (save-excursion
22128 (or (re-search-forward re nil t)
22129 (re-search-backward re nil t))))
22130 (error "No bibliography defined in file")
22131 (setq bib (concat (match-string 1) ".bib")
22132 rds (list (list 'bib bib)))))))
22133 (call-interactively 'reftex-citation)))
22135 ;;;; Functions extending outline functionality
22137 (defun org-beginning-of-line (&optional arg)
22138 "Go to the beginning of the current line. If that is invisible, continue
22139 to a visible line beginning. This makes the function of C-a more intuitive.
22140 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22141 first attempt, and only move to after the tags when the cursor is already
22142 beyond the end of the headline."
22143 (interactive "P")
22144 (let ((pos (point))
22145 (special (if (consp org-special-ctrl-a/e)
22146 (car org-special-ctrl-a/e)
22147 org-special-ctrl-a/e))
22148 refpos)
22149 (if (org-bound-and-true-p visual-line-mode)
22150 (beginning-of-visual-line 1)
22151 (beginning-of-line 1))
22152 (if (and arg (fboundp 'move-beginning-of-line))
22153 (call-interactively 'move-beginning-of-line)
22154 (if (bobp)
22155 nil
22156 (backward-char 1)
22157 (if (org-truely-invisible-p)
22158 (while (and (not (bobp)) (org-truely-invisible-p))
22159 (backward-char 1)
22160 (beginning-of-line 1))
22161 (forward-char 1))))
22162 (when special
22163 (cond
22164 ((and (looking-at org-complex-heading-regexp)
22165 (= (char-after (match-end 1)) ?\ ))
22166 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22167 (point-at-eol)))
22168 (goto-char
22169 (if (eq special t)
22170 (cond ((> pos refpos) refpos)
22171 ((= pos (point)) refpos)
22172 (t (point)))
22173 (cond ((> pos (point)) (point))
22174 ((not (eq last-command this-command)) (point))
22175 (t refpos)))))
22176 ((org-at-item-p)
22177 ;; Being at an item and not looking at an the item means point
22178 ;; was previously moved to beginning of a visual line, which
22179 ;; doesn't contain the item. Therefore, do nothing special,
22180 ;; just stay here.
22181 (when (looking-at org-list-full-item-re)
22182 ;; Set special position at first white space character after
22183 ;; bullet, and check-box, if any.
22184 (let ((after-bullet
22185 (let ((box (match-end 3)))
22186 (if (not box) (match-end 1)
22187 (let ((after (char-after box)))
22188 (if (and after (= after ? )) (1+ box) box))))))
22189 ;; Special case: Move point to special position when
22190 ;; currently after it or at beginning of line.
22191 (if (eq special t)
22192 (when (or (> pos after-bullet) (= (point) pos))
22193 (goto-char after-bullet))
22194 ;; Reversed case: Move point to special position when
22195 ;; point was already at beginning of line and command is
22196 ;; repeated.
22197 (when (and (= (point) pos) (eq last-command this-command))
22198 (goto-char after-bullet))))))))
22199 (org-no-warnings
22200 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22202 (defun org-end-of-line (&optional arg)
22203 "Go to the end of the line.
22204 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22205 tags on the first attempt, and only move to after the tags when
22206 the cursor is already beyond the end of the headline."
22207 (interactive "P")
22208 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22209 org-special-ctrl-a/e))
22210 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22211 'end-of-visual-line)
22212 ((fboundp 'move-end-of-line) 'move-end-of-line)
22213 (t 'end-of-line))))
22214 (if (or (not special) arg) (call-interactively move-fun)
22215 (let* ((element (save-excursion (beginning-of-line)
22216 (org-element-at-point)))
22217 (type (org-element-type element)))
22218 (cond
22219 ((memq type '(headline inlinetask))
22220 (let ((pos (point)))
22221 (beginning-of-line 1)
22223 (if (eq special t)
22224 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22225 (goto-char (match-beginning 1))
22226 (goto-char (match-end 0)))
22227 (if (or (< pos (match-end 0))
22228 (not (eq this-command last-command)))
22229 (goto-char (match-end 0))
22230 (goto-char (match-beginning 1))))
22231 (call-interactively move-fun))))
22232 ((org-element-property :hiddenp element)
22233 ;; If element is hidden, `move-end-of-line' would put point
22234 ;; after it. Use `end-of-line' to stay on current line.
22235 (call-interactively 'end-of-line))
22236 (t (call-interactively move-fun)))))
22237 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22239 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22240 (define-key org-mode-map "\C-e" 'org-end-of-line)
22242 (defun org-backward-sentence (&optional arg)
22243 "Go to beginning of sentence, or beginning of table field.
22244 This will call `backward-sentence' or `org-table-beginning-of-field',
22245 depending on context."
22246 (interactive "P")
22247 (cond
22248 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22249 (t (call-interactively 'backward-sentence))))
22251 (defun org-forward-sentence (&optional arg)
22252 "Go to end of sentence, or end of table field.
22253 This will call `forward-sentence' or `org-table-end-of-field',
22254 depending on context."
22255 (interactive "P")
22256 (cond
22257 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22258 (t (call-interactively 'forward-sentence))))
22260 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22261 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22263 (defun org-kill-line (&optional arg)
22264 "Kill line, to tags or end of line."
22265 (interactive "P")
22266 (cond
22267 ((or (not org-special-ctrl-k)
22268 (bolp)
22269 (not (org-at-heading-p)))
22270 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22271 org-ctrl-k-protect-subtree)
22272 (if (or (eq org-ctrl-k-protect-subtree 'error)
22273 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22274 (error "C-k aborted - would kill hidden subtree")))
22275 (call-interactively
22276 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22278 (kill-region (point) (match-beginning 1))
22279 (org-set-tags nil t))
22280 (t (kill-region (point) (point-at-eol)))))
22282 (define-key org-mode-map "\C-k" 'org-kill-line)
22284 (defun org-yank (&optional arg)
22285 "Yank. If the kill is a subtree, treat it specially.
22286 This command will look at the current kill and check if is a single
22287 subtree, or a series of subtrees[1]. If it passes the test, and if the
22288 cursor is at the beginning of a line or after the stars of a currently
22289 empty headline, then the yank is handled specially. How exactly depends
22290 on the value of the following variables, both set by default.
22292 org-yank-folded-subtrees
22293 When set, the subtree(s) will be folded after insertion, but only
22294 if doing so would now swallow text after the yanked text.
22296 org-yank-adjusted-subtrees
22297 When set, the subtree will be promoted or demoted in order to
22298 fit into the local outline tree structure, which means that the level
22299 will be adjusted so that it becomes the smaller one of the two
22300 *visible* surrounding headings.
22302 Any prefix to this command will cause `yank' to be called directly with
22304 will just
22305 plainly yank the text as it is.
22307 \[1] The test checks if the first non-white line is a heading
22308 and if there are no other headings with fewer stars."
22309 (interactive "P")
22310 (org-yank-generic 'yank arg))
22312 (defun org-yank-generic (command arg)
22313 "Perform some yank-like command.
22315 This function implements the behavior described in the `org-yank'
22316 documentation. However, it has been generalized to work for any
22317 interactive command with similar behavior."
22319 ;; pretend to be command COMMAND
22320 (setq this-command command)
22322 (if arg
22323 (call-interactively command)
22325 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22326 (and (org-kill-is-subtree-p)
22327 (or (bolp)
22329 (string-match
22331 (buffer-substring (point-at-bol) (point)))))))
22332 swallowp)
22333 (cond
22334 ((and subtreep org-yank-folded-subtrees)
22335 (let ((beg (point))
22336 end)
22337 (if (and subtreep org-yank-adjusted-subtrees)
22338 (org-paste-subtree nil nil 'for-yank)
22339 (call-interactively command))
22341 (setq end (point))
22342 (goto-char beg)
22343 (when (and (bolp) subtreep
22344 (not (setq swallowp
22345 (org-yank-folding-would-swallow-text beg end))))
22346 (org-with-limited-levels
22347 (or (looking-at org-outline-regexp)
22348 (re-search-forward org-outline-regexp-bol end t))
22349 (while (and (< (point) end) (looking-at org-outline-regexp))
22350 (hide-subtree)
22351 (org-cycle-show-empty-lines 'folded)
22352 (condition-case nil
22353 (outline-forward-same-level 1)
22354 (error (goto-char end))))))
22355 (when swallowp
22356 (message
22357 "Inserted text not folded because that would swallow text"))
22359 (goto-char end)
22361 (beginning-of-line 1)
22362 (push-mark beg 'nomsg)))
22363 ((and subtreep org-yank-adjusted-subtrees)
22364 (let ((beg (point-at-bol)))
22365 (org-paste-subtree nil nil 'for-yank)
22366 (push-mark beg 'nomsg)))
22367 (t
22368 (call-interactively command))))))
22370 (defun org-yank-folding-would-swallow-text (beg end)
22371 "Would hide-subtree at BEG swallow any text after END?"
22372 (let (level)
22373 (org-with-limited-levels
22374 (save-excursion
22375 (goto-char beg)
22376 (when (or (looking-at org-outline-regexp)
22377 (re-search-forward org-outline-regexp-bol end t))
22378 (setq level (org-outline-level)))
22379 (goto-char end)
22381 (if (or (eobp)
22382 (and (bolp) (looking-at org-outline-regexp)
22383 (<= (org-outline-level) level)))
22384 nil ; Nothing would be swallowed
22385 t))))) ; something would swallow
22387 (define-key org-mode-map "\C-y" 'org-yank)
22389 (defun org-truely-invisible-p ()
22390 "Check if point is at a character currently not visible.
22391 This version does not only check the character property, but also
22392 `visible-mode'."
22393 ;; Early versions of noutline don't have `outline-invisible-p'.
22394 (if (org-bound-and-true-p visible-mode)
22395 nil
22396 (outline-invisible-p)))
22398 (defun org-invisible-p2 ()
22399 "Check if point is at a character currently not visible."
22400 (save-excursion
22401 (if (and (eolp) (not (bobp))) (backward-char 1))
22402 ;; Early versions of noutline don't have `outline-invisible-p'.
22403 (outline-invisible-p)))
22405 (defun org-back-to-heading (&optional invisible-ok)
22406 "Call `outline-back-to-heading', but provide a better error message."
22407 (condition-case nil
22408 (outline-back-to-heading invisible-ok)
22409 (error (error "Before first headline at position %d in buffer %s"
22410 (point) (current-buffer)))))
22412 (defun org-before-first-heading-p ()
22413 "Before first heading?"
22414 (save-excursion
22415 (end-of-line)
22416 (null (re-search-backward org-outline-regexp-bol nil t))))
22418 (defun org-at-heading-p (&optional ignored)
22419 (outline-on-heading-p t))
22420 ;; Compatibility alias with Org versions < 7.8.03
22421 (defalias 'org-on-heading-p 'org-at-heading-p)
22423 (defun org-at-comment-p nil
22424 "Is cursor in a line starting with a # character?"
22425 (save-excursion
22426 (beginning-of-line)
22427 (looking-at "^#")))
22429 (defun org-at-drawer-p nil
22430 "Is cursor at a drawer keyword?"
22431 (save-excursion
22432 (move-beginning-of-line 1)
22433 (looking-at org-drawer-regexp)))
22435 (defun org-at-block-p nil
22436 "Is cursor at a block keyword?"
22437 (save-excursion
22438 (move-beginning-of-line 1)
22439 (looking-at org-block-regexp)))
22441 (defun org-point-at-end-of-empty-headline ()
22442 "If point is at the end of an empty headline, return t, else nil.
22443 If the heading only contains a TODO keyword, it is still still considered
22444 empty."
22446 (when org-todo-line-regexp
22447 (save-excursion
22448 (beginning-of-line 1)
22449 (let ((case-fold-search nil))
22450 (looking-at org-todo-line-regexp)
22451 (string= (match-string 3) ""))))))
22453 (defun org-at-heading-or-item-p ()
22454 (or (org-at-heading-p) (org-at-item-p)))
22456 (defun org-at-target-p ()
22457 (or (org-in-regexp org-radio-target-regexp)
22458 (org-in-regexp org-target-regexp)))
22459 ;; Compatibility alias with Org versions < 7.8.03
22460 (defalias 'org-on-target-p 'org-at-target-p)
22462 (defun org-up-heading-all (arg)
22463 "Move to the heading line of which the present line is a subheading.
22464 This function considers both visible and invisible heading lines.
22465 With argument, move up ARG levels."
22466 (if (fboundp 'outline-up-heading-all)
22467 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22468 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22470 (defun org-up-heading-safe ()
22471 "Move to the heading line of which the present line is a subheading.
22472 This version will not throw an error. It will return the level of the
22473 headline found, or nil if no higher level is found.
22475 Also, this function will be a lot faster than `outline-up-heading',
22476 because it relies on stars being the outline starters. This can really
22477 make a significant difference in outlines with very many siblings."
22478 (let (start-level re)
22479 (org-back-to-heading t)
22480 (setq start-level (funcall outline-level))
22481 (if (equal start-level 1)
22482 nil
22484 (if (re-search-backward re nil t)
22485 (funcall outline-level)))))
22487 (defun org-first-sibling-p ()
22488 "Is this heading the first child of its parents?"
22489 (interactive)
22490 (let ((re org-outline-regexp-bol)
22491 level l)
22492 (unless (org-at-heading-p t)
22493 (error "Not at a heading"))
22494 (setq level (funcall outline-level))
22495 (save-excursion
22496 (if (not (re-search-backward re nil t))
22497 t
22498 (setq l (funcall outline-level))
22499 (< l level)))))
22501 (defun org-goto-sibling (&optional previous)
22502 "Goto the next sibling, even if it is invisible.
22503 When PREVIOUS is set, go to the previous sibling instead. Returns t
22504 when a sibling was found. When none is found, return nil and don't
22505 move point."
22506 (let ((fun (if previous 're-search-backward 're-search-forward))
22507 (pos (point))
22508 (re org-outline-regexp-bol)
22509 level l)
22510 (when (condition-case nil (org-back-to-heading t) (error nil))
22511 (setq level (funcall outline-level))
22512 (catch 'exit
22513 (or previous (forward-char 1))
22514 (while (funcall fun re nil t)
22515 (setq l (funcall outline-level))
22516 (when (< l level) (goto-char pos) (throw 'exit nil))
22517 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22518 (goto-char pos)
22519 nil))))
22521 (defun org-show-siblings ()
22522 "Show all siblings of the current headline."
22523 (save-excursion
22524 (while (org-goto-sibling) (org-flag-heading nil)))
22525 (save-excursion
22526 (while (org-goto-sibling 'previous)
22527 (org-flag-heading nil))))
22529 (defun org-goto-first-child ()
22530 "Goto the first child, even if it is invisible.
22531 Return t when a child was found. Otherwise don't move point and
22532 return nil."
22533 (let (level (pos (point)) (re org-outline-regexp-bol))
22534 (when (condition-case nil (org-back-to-heading t) (error nil))
22535 (setq level (outline-level))
22536 (forward-char 1)
22537 (if (and (re-search-forward re nil t) (> (outline-level) level))
22538 (progn (goto-char (match-beginning 0)) t)
22539 (goto-char pos) nil))))
22541 (defun org-show-hidden-entry ()
22542 "Show an entry where even the heading is hidden."
22543 (save-excursion
22544 (org-show-entry)))
22546 (defun org-flag-heading (flag &optional entry)
22547 "Flag the current heading. FLAG non-nil means make invisible.
22548 When ENTRY is non-nil, show the entire entry."
22549 (save-excursion
22550 (org-back-to-heading t)
22551 ;; Check if we should show the entire entry
22552 (if entry
22553 (progn
22554 (org-show-entry)
22555 (save-excursion
22556 (and (outline-next-heading)
22557 (org-flag-heading nil))))
22558 (outline-flag-region (max (point-min) (1- (point)))
22559 (save-excursion (outline-end-of-heading) (point))
22560 flag))))
22562 (defun org-get-next-sibling ()
22563 "Move to next heading of the same level, and return point.
22564 If there is no such heading, return nil.
22565 This is like outline-next-sibling, but invisible headings are ok."
22566 (let ((level (funcall outline-level)))
22567 (outline-next-heading)
22568 (while (and (not (eobp)) (> (funcall outline-level) level))
22569 (outline-next-heading))
22570 (if (or (eobp) (< (funcall outline-level) level))
22571 nil
22572 (point))))
22574 (defun org-get-last-sibling ()
22575 "Move to previous heading of the same level, and return point.
22576 If there is no such heading, return nil."
22577 (let ((opoint (point))
22578 (level (funcall outline-level)))
22579 (outline-previous-heading)
22580 (when (and (/= (point) opoint) (outline-on-heading-p t))
22581 (while (and (> (funcall outline-level) level)
22582 (not (bobp)))
22583 (outline-previous-heading))
22584 (if (< (funcall outline-level) level)
22585 nil
22586 (point)))))
22588 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22589 "Goto to the end of a subtree."
22590 ;; This contains an exact copy of the original function, but it uses
22591 ;; `org-back-to-heading', to make it work also in invisible
22592 ;; trees. And is uses an invisible-ok argument.
22593 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22594 ;; Furthermore, when used inside Org, finding the end of a large subtree
22595 ;; with many children and grandchildren etc, this can be much faster
22596 ;; than the outline version.
22597 (org-back-to-heading invisible-ok)
22598 (let ((first t)
22599 (level (funcall outline-level)))
22600 (if (and (derived-mode-p 'org-mode) (< level 1000))
22601 ;; A true heading (not a plain list item), in Org-mode
22602 ;; This means we can easily find the end by looking
22603 ;; only for the right number of stars. Using a regexp to do
22604 ;; this is so much faster than using a Lisp loop.
22606 (forward-char 1)
22607 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22608 ;; something else, do it the slow way
22609 (while (and (not (eobp))
22610 (or first (> (funcall outline-level) level)))
22611 (setq first nil)
22612 (outline-next-heading)))
22613 (unless to-heading
22615 (progn
22616 ;; Go to end of line before heading
22617 (forward-char -1)
22619 ;; leave blank line before heading
22620 (forward-char -1))))))
22621 (point))
22623 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22624 "Use Org version in org-mode, for dramatic speed-up."
22625 (if (derived-mode-p 'org-mode)
22626 (progn
22627 (org-end-of-subtree nil t)
22628 (unless (eobp) (backward-char 1)))
22629 ad-do-it))
22631 (defun org-end-of-meta-data-and-drawers ()
22632 "Jump to the first text after meta data and drawers in the current entry.
22633 This will move over empty lines, lines with planning time stamps,
22634 clocking lines, and drawers."
22635 (org-back-to-heading t)
22636 (let ((end (save-excursion (outline-next-heading) (point)))
22639 (forward-line 1)
22640 (while (re-search-forward re end t)
22641 (if (not (match-end 1))
22642 ;; empty or planning line
22643 (forward-line 1)
22644 ;; a drawer, find the end
22646 (forward-line 1)))
22648 (point)))
22650 (defun org-forward-heading-same-level (arg &optional invisible-ok)
22651 "Move forward to the ARG'th subheading at same level as this one.
22652 Stop at the first and last subheadings of a superior heading.
22653 Normally this only looks at visible headings, but when INVISIBLE-OK is
22654 non-nil it will also look at invisible ones."
22655 (interactive "p")
22656 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
22657 (if (and arg (< arg 0))
22658 (goto-char (point-min))
22659 (outline-next-heading))
22660 (org-at-heading-p)
22661 (let ((level (- (match-end 0) (match-beginning 0) 1))
22662 (f (if (and arg (< arg 0))
22663 're-search-backward
22664 're-search-forward))
22665 (count (if arg (abs arg) 1))
22666 (result (point)))
22667 (forward-char (if (and arg (< arg 0)) -1 1))
22668 (while (and (> count 0)
22669 (funcall f org-outline-regexp-bol nil 'move))
22670 (let ((l (- (match-end 0) (match-beginning 0) 1)))
22671 (cond ((< l level) (setq count 0))
22672 ((and (= l level)
22673 (or invisible-ok
22674 (progn
22675 (goto-char (line-beginning-position))
22676 (not (outline-invisible-p)))))
22677 (setq count (1- count))
22678 (when (eq l level)
22679 (setq result (point)))))))
22680 (goto-char result))
22681 (beginning-of-line 1)))
22683 (defun org-backward-heading-same-level (arg &optional invisible-ok)
22684 "Move backward to the ARG'th subheading at same level as this one.
22685 Stop at the first and last subheadings of a superior heading."
22686 (interactive "p")
22687 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
22689 (defun org-next-block (arg &optional backward block-regexp)
22690 "Jump to the next block.
22691 With a prefix argument ARG, jump forward ARG many source blocks.
22692 When BACKWARD is non-nil, jump to the previous block.
22693 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
22694 (interactive "p")
22695 (let ((re (or block-regexp org-block-regexp))
22696 (re-search-fn (or (and backward 're-search-backward)
22697 're-search-forward)))
22698 (if (looking-at re) (forward-char 1))
22699 (condition-case nil
22700 (funcall re-search-fn re nil nil arg)
22701 (error (error "No %s code blocks" (if backward "previous" "further" ))))
22702 (goto-char (match-beginning 0)) (org-show-context)))
22704 (defun org-previous-block (arg &optional block-regexp)
22705 "Jump to the previous block.
22706 With a prefix argument ARG, jump backward ARG many source blocks.
22707 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
22708 (interactive "p")
22709 (org-next-block arg t block-regexp))
22711 (defun org-forward-element ()
22712 "Move forward by one element.
22713 Move to the next element at the same level, when possible."
22714 (interactive)
22715 (cond ((eobp) (user-error "Cannot move further down"))
22716 ((org-with-limited-levels (org-at-heading-p))
22717 (let ((origin (point)))
22718 (goto-char (org-end-of-subtree nil t))
22719 (unless (org-with-limited-levels (org-at-heading-p))
22720 (goto-char origin)
22721 (user-error "Cannot move further down"))))
22722 (t
22723 (let* ((elem (org-element-at-point))
22724 (end (org-element-property :end elem))
22725 (parent (org-element-property :parent elem)))
22726 (if (and parent (= (org-element-property :contents-end parent) end))
22727 (goto-char (org-element-property :end parent))
22728 (goto-char end))))))
22730 (defun org-backward-element ()
22731 "Move backward by one element.
22732 Move to the previous element at the same level, when possible."
22733 (interactive)
22734 (cond ((bobp) (user-error "Cannot move further up"))
22735 ((org-with-limited-levels (org-at-heading-p))
22736 ;; At a headline, move to the previous one, if any, or stay
22737 ;; here.
22738 (let ((origin (point)))
22739 (org-with-limited-levels (org-backward-heading-same-level 1))
22740 ;; When current headline has no sibling above, move to its
22741 ;; parent.
22742 (when (= (point) origin)
22743 (or (org-with-limited-levels (org-up-heading-safe))
22744 (progn (goto-char origin)
22745 (user-error "Cannot move further up"))))))
22746 (t
22747 (let* ((trail (org-element-at-point 'keep-trail))
22748 (elem (car trail))
22749 (prev-elem (nth 1 trail))
22750 (beg (org-element-property :begin elem)))
22751 (cond
22752 ;; Move to beginning of current element if point isn't
22753 ;; there already.
22754 ((/= (point) beg) (goto-char beg))
22755 (prev-elem (goto-char (org-element-property :begin prev-elem)))
22756 ((org-before-first-heading-p) (goto-char (point-min)))
22757 (t (org-back-to-heading)))))))
22759 (defun org-up-element ()
22760 "Move to upper element."
22761 (interactive)
22762 (if (org-with-limited-levels (org-at-heading-p))
22763 (unless (org-up-heading-safe) (error "No surrounding element"))
22764 (let* ((elem (org-element-at-point))
22765 (parent (org-element-property :parent elem)))
22766 (if parent (goto-char (org-element-property :begin parent))
22767 (if (org-with-limited-levels (org-before-first-heading-p))
22768 (error "No surrounding element")
22769 (org-with-limited-levels (org-back-to-heading)))))))
22771 (defvar org-element-greater-elements)
22772 (defun org-down-element ()
22773 "Move to inner element."
22774 (interactive)
22775 (let ((element (org-element-at-point)))
22776 (cond
22777 ((memq (org-element-type element) '(plain-list table))
22778 (goto-char (org-element-property :contents-begin element))
22779 (forward-char))
22780 ((memq (org-element-type element) org-element-greater-elements)
22781 ;; If contents are hidden, first disclose them.
22782 (when (org-element-property :hiddenp element) (org-cycle))
22783 (goto-char (or (org-element-property :contents-begin element)
22784 (error "No content for this element"))))
22785 (t (error "No inner element")))))
22787 (defun org-drag-element-backward ()
22788 "Move backward element at point."
22789 (interactive)
22790 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
22791 (let* ((trail (org-element-at-point 'keep-trail))
22792 (elem (car trail))
22793 (prev-elem (nth 1 trail)))
22794 ;; Error out if no previous element or previous element is
22795 ;; a parent of the current one.
22796 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
22797 (error "Cannot drag element backward")
22798 (let ((pos (point)))
22799 (org-element-swap-A-B prev-elem elem)
22800 (goto-char (+ (org-element-property :begin prev-elem)
22801 (- pos (org-element-property :begin elem)))))))))
22803 (defun org-drag-element-forward ()
22804 "Move forward element at point."
22805 (interactive)
22806 (let* ((pos (point))
22807 (elem (org-element-at-point)))
22808 (when (= (point-max) (org-element-property :end elem))
22809 (error "Cannot drag element forward"))
22810 (goto-char (org-element-property :end elem))
22811 (let ((next-elem (org-element-at-point)))
22812 (when (or (org-element-nested-p elem next-elem)
22813 (and (eq (org-element-type next-elem) 'headline)
22814 (not (eq (org-element-type elem) 'headline))))
22815 (goto-char pos)
22816 (error "Cannot drag element forward"))
22817 ;; Compute new position of point: it's shifted by NEXT-ELEM
22818 ;; body's length (without final blanks) and by the length of
22819 ;; blanks between ELEM and NEXT-ELEM.
22820 (let ((size-next (- (save-excursion
22821 (goto-char (org-element-property :end next-elem))
22823 (forward-line)
22824 ;; Small correction if buffer doesn't end
22825 ;; with a newline character.
22826 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
22827 (org-element-property :begin next-elem)))
22828 (size-blank (- (org-element-property :end elem)
22829 (save-excursion
22830 (goto-char (org-element-property :end elem))
22832 (forward-line)
22833 (point)))))
22834 (org-element-swap-A-B elem next-elem)
22835 (goto-char (+ pos size-next size-blank))))))
22837 (defun org-drag-line-forward (arg)
22838 "Drag the line at point ARG lines forward."
22839 (interactive "p")
22840 (dotimes (n (abs arg))
22841 (let ((c (current-column)))
22842 (if (< 0 arg)
22843 (progn
22844 (beginning-of-line 2)
22845 (transpose-lines 1)
22846 (beginning-of-line 0))
22847 (transpose-lines 1)
22848 (beginning-of-line -1))
22849 (org-move-to-column c))))
22851 (defun org-drag-line-backward (arg)
22852 "Drag the line at point ARG lines backward."
22853 (interactive "p")
22854 (org-drag-line-forward (- arg)))
22856 (defun org-mark-element ()
22857 "Put point at beginning of this element, mark at end.
22859 Interactively, if this command is repeated or (in Transient Mark
22860 mode) if the mark is active, it marks the next element after the
22861 ones already marked."
22862 (interactive)
22863 (let (deactivate-mark)
22864 (if (and (org-called-interactively-p 'any)
22865 (or (and (eq last-command this-command) (mark t))
22866 (and transient-mark-mode mark-active)))
22867 (set-mark
22868 (save-excursion
22869 (goto-char (mark))
22870 (goto-char (org-element-property :end (org-element-at-point)))))
22871 (let ((element (org-element-at-point)))
22872 (end-of-line)
22873 (push-mark (org-element-property :end element) t t)
22874 (goto-char (org-element-property :begin element))))))
22876 (defun org-narrow-to-element ()
22877 "Narrow buffer to current element."
22878 (interactive)
22879 (let ((elem (org-element-at-point)))
22880 (cond
22881 ((eq (car elem) 'headline)
22882 (narrow-to-region
22883 (org-element-property :begin elem)
22884 (org-element-property :end elem)))
22885 ((memq (car elem) org-element-greater-elements)
22886 (narrow-to-region
22887 (org-element-property :contents-begin elem)
22888 (org-element-property :contents-end elem)))
22889 (t
22890 (narrow-to-region
22891 (org-element-property :begin elem)
22892 (org-element-property :end elem))))))
22894 (defun org-transpose-element ()
22895 "Transpose current and previous elements, keeping blank lines between.
22896 Point is moved after both elements."
22897 (interactive)
22898 (org-skip-whitespace)
22899 (let ((end (org-element-property :end (org-element-at-point))))
22900 (org-drag-element-backward)
22901 (goto-char end)))
22903 (defun org-unindent-buffer ()
22904 "Un-indent the visible part of the buffer.
22905 Relative indentation (between items, inside blocks, etc.) isn't
22906 modified."
22907 (interactive)
22908 (unless (eq major-mode 'org-mode)
22909 (error "Cannot un-indent a buffer not in Org mode"))
22910 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22911 unindent-tree ; For byte-compiler.
22912 (unindent-tree
22913 (function
22914 (lambda (contents)
22915 (mapc
22916 (lambda (element)
22917 (if (memq (org-element-type element) '(headline section))
22918 (funcall unindent-tree (org-element-contents element))
22919 (save-excursion
22920 (save-restriction
22921 (narrow-to-region
22922 (org-element-property :begin element)
22923 (org-element-property :end element))
22924 (org-do-remove-indentation)))))
22925 (reverse contents))))))
22926 (funcall unindent-tree (org-element-contents parse-tree))))
22928 (defun org-show-subtree ()
22929 "Show everything after this heading at deeper levels."
22930 (interactive)
22931 (outline-flag-region
22932 (point)
22933 (save-excursion
22934 (org-end-of-subtree t t))
22935 nil))
22937 (defun org-show-entry ()
22938 "Show the body directly following this heading.
22939 Show the heading too, if it is currently invisible."
22940 (interactive)
22941 (save-excursion
22942 (condition-case nil
22943 (progn
22944 (org-back-to-heading t)
22945 (outline-flag-region
22946 (max (point-min) (1- (point)))
22947 (save-excursion
22948 (if (re-search-forward
22950 (match-beginning 1)
22951 (point-max)))
22952 nil)
22953 (org-cycle-hide-drawers 'children))
22954 (error nil))))
22956 (defun org-make-options-regexp (kwds &optional extra)
22957 "Make a regular expression for keyword lines."
22958 (concat
22964 ;; Make isearch reveal the necessary context
22965 (defun org-isearch-end ()
22966 "Reveal context after isearch exits."
22967 (when isearch-success ; only if search was successful
22968 (if (featurep 'xemacs)
22969 ;; Under XEmacs, the hook is run in the correct place,
22970 ;; we directly show the context.
22971 (org-show-context 'isearch)
22972 ;; In Emacs the hook runs *before* restoring the overlays.
22973 ;; So we have to use a one-time post-command-hook to do this.
22974 ;; (Emacs 22 has a special variable, see function `org-mode')
22975 (unless (and (boundp 'isearch-mode-end-hook-quit)
22976 isearch-mode-end-hook-quit)
22977 ;; Only when the isearch was not quitted.
22978 (org-add-hook 'post-command-hook 'org-isearch-post-command
22979 'append 'local)))))
22981 (defun org-isearch-post-command ()
22982 "Remove self from hook, and show context."
22983 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22984 (org-show-context 'isearch))
22987 ;;;; Integration with and fixes for other packages
22989 ;;; Imenu support
22991 (defvar org-imenu-markers nil
22992 "All markers currently used by Imenu.")
22993 (make-variable-buffer-local 'org-imenu-markers)
22995 (defun org-imenu-new-marker (&optional pos)
22996 "Return a new marker for use by Imenu, and remember the marker."
22997 (let ((m (make-marker)))
22998 (move-marker m (or pos (point)))
22999 (push m org-imenu-markers)
23000 m))
23002 (defun org-imenu-get-tree ()
23003 "Produce the index for Imenu."
23004 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23005 (setq org-imenu-markers nil)
23006 (let* ((n org-imenu-depth)
23007 (re (concat "^" (org-get-limited-outline-regexp)))
23008 (subs (make-vector (1+ n) nil))
23009 (last-level 0)
23010 m level head)
23011 (save-excursion
23012 (save-restriction
23013 (widen)
23014 (goto-char (point-max))
23015 (while (re-search-backward re nil t)
23016 (setq level (org-reduced-level (funcall outline-level)))
23017 (when (and (<= level n)
23018 (looking-at org-complex-heading-regexp))
23019 (setq head (org-link-display-format
23020 (org-match-string-no-properties 4))
23021 m (org-imenu-new-marker))
23022 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23023 (if (>= level last-level)
23024 (push (cons head m) (aref subs level))
23025 (push (cons head (aref subs (1+ level))) (aref subs level))
23026 (loop for i from (1+ level) to n do (aset subs i nil)))
23027 (setq last-level level)))))
23028 (aref subs 1)))
23030 (eval-after-load "imenu"
23031 '(progn
23032 (add-hook 'imenu-after-jump-hook
23033 (lambda ()
23034 (if (derived-mode-p 'org-mode)
23035 (org-show-context 'org-goto))))))
23037 (defun org-link-display-format (link)
23038 "Replace a link with either the description, or the link target
23039 if no description is present"
23040 (save-match-data
23041 (if (string-match org-bracket-link-analytic-regexp link)
23042 (replace-match (if (match-end 5)
23043 (match-string 5 link)
23044 (concat (match-string 1 link)
23045 (match-string 3 link)))
23046 nil t link)
23047 link)))
23049 (defun org-toggle-link-display ()
23050 "Toggle the literal or descriptive display of links."
23051 (interactive)
23052 (if org-descriptive-links
23053 (progn (org-remove-from-invisibility-spec '(org-link))
23054 (org-restart-font-lock)
23055 (setq org-descriptive-links nil))
23056 (progn (add-to-invisibility-spec '(org-link))
23057 (org-restart-font-lock)
23058 (setq org-descriptive-links t))))
23060 ;; Speedbar support
23062 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23063 "Overlay marking the agenda restriction line in speedbar.")
23064 (overlay-put org-speedbar-restriction-lock-overlay
23065 'face 'org-agenda-restriction-lock)
23066 (overlay-put org-speedbar-restriction-lock-overlay
23067 'help-echo "Agendas are currently limited to this item.")
23068 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23070 (defun org-speedbar-set-agenda-restriction ()
23071 "Restrict future agenda commands to the location at point in speedbar.
23073 (interactive)
23074 (require 'org-agenda)
23075 (let (p m tp np dir txt)
23076 (cond
23077 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23078 'org-imenu t))
23079 (setq m (get-text-property p 'org-imenu-marker))
23080 (with-current-buffer (marker-buffer m)
23081 (goto-char m)
23082 (org-agenda-set-restriction-lock 'subtree)))
23083 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23084 'speedbar-function 'speedbar-find-file))
23085 (setq tp (previous-single-property-change
23086 (1+ p) 'speedbar-function)
23087 np (next-single-property-change
23088 tp 'speedbar-function)
23089 dir (speedbar-line-directory)
23090 txt (buffer-substring-no-properties (or tp (point-min))
23091 (or np (point-max))))
23092 (with-current-buffer (find-file-noselect
23093 (let ((default-directory dir))
23094 (expand-file-name txt)))
23095 (unless (derived-mode-p 'org-mode)
23096 (error "Cannot restrict to non-Org-mode file"))
23097 (org-agenda-set-restriction-lock 'file)))
23098 (t (error "Don't know how to restrict Org-mode's agenda")))
23099 (move-overlay org-speedbar-restriction-lock-overlay
23100 (point-at-bol) (point-at-eol))
23101 (setq current-prefix-arg nil)
23102 (org-agenda-maybe-redo)))
23104 (eval-after-load "speedbar"
23105 '(progn
23106 (speedbar-add-supported-extension ".org")
23107 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23108 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23109 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23110 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23111 (add-hook 'speedbar-visiting-tag-hook
23112 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23114 ;;; Fixes and Hacks for problems with other packages
23116 ;; Make flyspell not check words in links, to not mess up our keymap
23117 (defvar org-element-affiliated-keywords) ; From org-element.el
23118 (defvar org-element-block-name-alist) ; From org-element.el
23119 (defun org-mode-flyspell-verify ()
23120 "Don't let flyspell put overlays at active buttons, or on
23121 {todo,all-time,additional-option-like}-keywords."
23122 (let ((pos (max (1- (point)) (point-min)))
23123 (word (thing-at-point 'word)))
23124 (and (not (get-text-property pos 'keymap))
23125 (not (get-text-property pos 'org-no-flyspell))
23126 (not (member word org-todo-keywords-1))
23127 (not (member word org-all-time-keywords))
23128 (not (member word org-options-keywords))
23129 (not (member word (mapcar 'car org-startup-options)))
23130 (not (member-ignore-case word org-element-affiliated-keywords))
23131 (not (member-ignore-case word (org-get-export-keywords)))
23132 (not (member-ignore-case
23133 word (mapcar 'car org-element-block-name-alist)))
23134 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23136 (defun org-remove-flyspell-overlays-in (beg end)
23137 "Remove flyspell overlays in region."
23138 (and (org-bound-and-true-p flyspell-mode)
23139 (fboundp 'flyspell-delete-region-overlays)
23140 (flyspell-delete-region-overlays beg end))
23141 (add-text-properties beg end '(org-no-flyspell t)))
23143 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23144 (eval-after-load "bookmark"
23145 '(if (boundp 'bookmark-after-jump-hook)
23146 ;; We can use the hook
23147 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23148 ;; Hook not available, use advice
23149 (defadvice bookmark-jump (after org-make-visible activate)
23150 "Make the position visible."
23151 (org-bookmark-jump-unhide))))
23153 ;; Make sure saveplace shows the location if it was hidden
23154 (eval-after-load "saveplace"
23155 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23156 "Make the position visible."
23157 (org-bookmark-jump-unhide)))
23159 ;; Make sure ecb shows the location if it was hidden
23160 (eval-after-load "ecb"
23161 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23162 "Make hierarchy visible when jumping into location from ECB tree buffer."
23163 (if (derived-mode-p 'org-mode)
23164 (org-show-context))))
23166 (defun org-bookmark-jump-unhide ()
23167 "Unhide the current position, to show the bookmark location."
23168 (and (derived-mode-p 'org-mode)
23169 (or (outline-invisible-p)
23170 (save-excursion (goto-char (max (point-min) (1- (point))))
23171 (outline-invisible-p)))
23172 (org-show-context 'bookmark-jump)))
23174 ;; Make session.el ignore our circular variable
23175 (eval-after-load "session"
23176 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23178 ;;;; Experimental code
23180 (defun org-closed-in-range ()
23181 "Sparse tree of items closed in a certain time range.
23182 Still experimental, may disappear in the future."
23183 (interactive)
23184 ;; Get the time interval from the user.
23185 (let* ((time1 (org-float-time
23186 (org-read-date nil 'to-time nil "Starting date: ")))
23187 (time2 (org-float-time
23188 (org-read-date nil 'to-time nil "End date:")))
23189 ;; callback function
23190 (callback (lambda ()
23191 (let ((time
23192 (org-float-time
23193 (apply 'encode-time
23194 (org-parse-time-string
23195 (match-string 1))))))
23196 ;; check if time in interval
23197 (and (>= time time1) (<= time time2))))))
23198 ;; make tree, check each match with the callback
23201 ;;;; Finish up
23203 (provide 'org)
23205 (run-hooks 'org-load-hook)
23207 ;;; org.el ends here