| blob | 4c5aa2498e11237a7321f2de3b27c1976ace3ae6 |
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 (defsubst org-sort-remove-invisible (s)
8323 "Return the visible string from string S."
8324 (let (result)
8325 (dotimes (c (length s))
8326 (let ((st (substring s c (1+ c))))
8327 (unless (get-text-property 0 'invisible st) (push st result))))
8328 (mapconcat 'identity (reverse result) "")))
8330 (defvar org-priority-regexp) ; defined later in the file
8332 (defvar org-after-sorting-entries-or-items-hook nil
8333 "Hook that is run after a bunch of entries or items have been sorted.
8334 When children are sorted, the cursor is in the parent line when this
8335 hook gets called. When a region or a plain list is sorted, the cursor
8336 will be in the first entry of the sorted region/list.")
8338 (defun org-sort-entries
8339 (&optional with-case sorting-type getkey-func compare-func property)
8340 "Sort entries on a certain level of an outline tree.
8341 If there is an active region, the entries in the region are sorted.
8342 Else, if the cursor is before the first entry, sort the top-level items.
8343 Else, the children of the entry at point are sorted.
8345 Sorting can be alphabetically, numerically, by date/time as given by
8346 a time stamp, by a property, by priority order, or by a custom function.
8348 The command prompts for the sorting type unless it has been given to the
8349 function through the SORTING-TYPE argument, which needs to be a character,
8350 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8351 precise meaning of each character:
8353 n Numerically, by converting the beginning of the entry/item to a number.
8354 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8355 o By order of TODO keywords.
8356 t By date/time, either the first active time stamp in the entry, or, if
8357 none exist, by the first inactive one.
8358 s By the scheduled date/time.
8359 d By deadline date/time.
8360 c By creation time, which is assumed to be the first inactive time stamp
8361 at the beginning of a line.
8362 p By priority according to the cookie.
8363 r By the value of a property.
8365 Capital letters will reverse the sort order.
8367 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8368 called with point at the beginning of the record. It must return either
8369 a string or a number that should serve as the sorting key for that record.
8371 Comparing entries ignores case by default. However, with an optional argument
8372 WITH-CASE, the sorting considers case as well.
8374 Sorting is done against the visible part of the headlines, it ignores hidden
8375 links."
8376 (interactive "P")
8377 (let ((case-func (if with-case 'identity 'downcase))
8378 (cmstr
8379 ;; The clock marker is lost when using `sort-subr', let's
8380 ;; store the clocking string.
8381 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8382 (save-excursion
8383 (goto-char org-clock-marker)
8384 (looking-back "^.*") (match-string-no-properties 0))))
8385 start beg end stars re re2
8386 txt what tmp)
8387 ;; Find beginning and end of region to sort
8388 (cond
8389 ((org-region-active-p)
8390 ;; we will sort the region
8391 (setq end (region-end)
8392 what "region")
8393 (goto-char (region-beginning))
8394 (if (not (org-at-heading-p)) (outline-next-heading))
8395 (setq start (point)))
8396 ((or (org-at-heading-p)
8397 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8398 ;; we will sort the children of the current headline
8399 (org-back-to-heading)
8400 (setq start (point)
8401 end (progn (org-end-of-subtree t t)
8403 (org-back-over-empty-lines)
8404 (point))
8405 what "children")
8406 (goto-char start)
8407 (show-subtree)
8408 (outline-next-heading))
8409 (t
8410 ;; we will sort the top-level entries in this file
8411 (goto-char (point-min))
8412 (or (org-at-heading-p) (outline-next-heading))
8413 (setq start (point))
8414 (goto-char (point-max))
8415 (beginning-of-line 1)
8417 ;; File ends in a non-white line
8418 (end-of-line 1)
8420 (setq end (point-max))
8421 (setq what "top-level")
8422 (goto-char start)
8423 (show-all)))
8425 (setq beg (point))
8426 (if (>= beg end) (error "Nothing to sort"))
8429 (setq stars (match-string 1)
8430 re (concat "^" (regexp-quote stars) " +")
8432 txt (buffer-substring beg end))
8434 (if (and (not (equal stars "*")) (string-match re2 txt))
8435 (error "Region to sort contains a level above the first entry"))
8437 (unless sorting-type
8438 (message
8439 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8441 A/N/P/R/O/F/T/S/D/C means reversed:"
8442 what)
8443 (setq sorting-type (read-char-exclusive))
8445 (unless getkey-func
8446 (and (= (downcase sorting-type) ?f)
8447 (setq getkey-func
8448 (org-icompleting-read "Sort using function: "
8449 obarray 'fboundp t nil nil))
8450 (setq getkey-func (intern getkey-func))))
8452 (and (= (downcase sorting-type) ?r)
8453 (not property)
8454 (setq property
8455 (org-icompleting-read "Property: "
8456 (mapcar 'list (org-buffer-property-keys t))
8457 nil t))))
8459 (message "Sorting entries...")
8461 (save-restriction
8462 (narrow-to-region start end)
8463 (let ((dcst (downcase sorting-type))
8464 (case-fold-search nil)
8465 (now (current-time)))
8466 (sort-subr
8467 (/= dcst sorting-type)
8468 ;; This function moves to the beginning character of the "record" to
8469 ;; be sorted.
8470 (lambda nil
8471 (if (re-search-forward re nil t)
8472 (goto-char (match-beginning 0))
8473 (goto-char (point-max))))
8474 ;; This function moves to the last character of the "record" being
8475 ;; sorted.
8476 (lambda nil
8477 (save-match-data
8478 (condition-case nil
8479 (outline-forward-same-level 1)
8480 (error
8481 (goto-char (point-max))))))
8482 ;; This function returns the value that gets sorted against.
8483 (lambda nil
8484 (cond
8485 ((= dcst ?n)
8486 (if (looking-at org-complex-heading-regexp)
8487 (string-to-number (org-sort-remove-invisible (match-string 4)))
8488 nil))
8489 ((= dcst ?a)
8490 (if (looking-at org-complex-heading-regexp)
8491 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8492 nil))
8493 ((= dcst ?t)
8494 (let ((end (save-excursion (outline-next-heading) (point))))
8495 (if (or (re-search-forward org-ts-regexp end t)
8496 (re-search-forward org-ts-regexp-both end t))
8497 (org-time-string-to-seconds (match-string 0))
8498 (org-float-time now))))
8499 ((= dcst ?c)
8500 (let ((end (save-excursion (outline-next-heading) (point))))
8501 (if (re-search-forward
8503 end t)
8504 (org-time-string-to-seconds (match-string 0))
8505 (org-float-time now))))
8506 ((= dcst ?s)
8507 (let ((end (save-excursion (outline-next-heading) (point))))
8508 (if (re-search-forward org-scheduled-time-regexp end t)
8509 (org-time-string-to-seconds (match-string 1))
8510 (org-float-time now))))
8511 ((= dcst ?d)
8512 (let ((end (save-excursion (outline-next-heading) (point))))
8513 (if (re-search-forward org-deadline-time-regexp end t)
8514 (org-time-string-to-seconds (match-string 1))
8515 (org-float-time now))))
8516 ((= dcst ?p)
8517 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8518 (string-to-char (match-string 2))
8519 org-default-priority))
8520 ((= dcst ?r)
8521 (or (org-entry-get nil property) ""))
8522 ((= dcst ?o)
8523 (if (looking-at org-complex-heading-regexp)
8524 (- 9999 (length (member (match-string 2)
8525 org-todo-keywords-1)))))
8526 ((= dcst ?f)
8527 (if getkey-func
8528 (progn
8529 (setq tmp (funcall getkey-func))
8530 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8531 tmp)
8532 (error "Invalid key function `%s'" getkey-func)))
8533 (t (error "Invalid sorting type `%c'" sorting-type))))
8534 nil
8535 (cond
8536 ((= dcst ?a) 'string<)
8537 ((= dcst ?f) compare-func)
8538 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8539 (run-hooks 'org-after-sorting-entries-or-items-hook)
8540 ;; Reset the clock marker if needed
8541 (when cmstr
8542 (save-excursion
8543 (goto-char start)
8544 (search-forward cmstr nil t)
8545 (move-marker org-clock-marker (point))))
8546 (message "Sorting entries...done")))
8548 (defun org-do-sort (table what &optional with-case sorting-type)
8549 "Sort TABLE of WHAT according to SORTING-TYPE.
8550 The user will be prompted for the SORTING-TYPE if the call to this
8551 function does not specify it. WHAT is only for the prompt, to indicate
8552 what is being sorted. The sorting key will be extracted from
8553 the car of the elements of the table.
8554 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8555 (unless sorting-type
8556 (message
8557 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8558 what)
8559 (setq sorting-type (read-char-exclusive)))
8560 (let ((dcst (downcase sorting-type))
8561 extractfun comparefun)
8562 ;; Define the appropriate functions
8563 (cond
8564 ((= dcst ?n)
8565 (setq extractfun 'string-to-number
8566 comparefun (if (= dcst sorting-type) '< '>)))
8567 ((= dcst ?a)
8568 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8569 (lambda(x) (downcase (org-sort-remove-invisible x))))
8570 comparefun (if (= dcst sorting-type)
8571 'string<
8572 (lambda (a b) (and (not (string< a b))
8573 (not (string= a b)))))))
8574 ((= dcst ?t)
8575 (setq extractfun
8576 (lambda (x)
8577 (if (or (string-match org-ts-regexp x)
8578 (string-match org-ts-regexp-both x))
8579 (org-float-time
8580 (org-time-string-to-time (match-string 0 x)))
8581 0))
8582 comparefun (if (= dcst sorting-type) '< '>)))
8583 (t (error "Invalid sorting type `%c'" sorting-type)))
8585 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8586 table)
8587 (lambda (a b) (funcall comparefun (car a) (car b))))))
8590 ;;; The orgstruct minor mode
8592 ;; Define a minor mode which can be used in other modes in order to
8593 ;; integrate the org-mode structure editing commands.
8595 ;; This is really a hack, because the org-mode structure commands use
8596 ;; keys which normally belong to the major mode. Here is how it
8597 ;; works: The minor mode defines all the keys necessary to operate the
8598 ;; structure commands, but wraps the commands into a function which
8599 ;; tests if the cursor is currently at a headline or a plain list
8600 ;; item. If that is the case, the structure command is used,
8601 ;; temporarily setting many Org-mode variables like regular
8602 ;; expressions for filling etc. However, when any of those keys is
8603 ;; used at a different location, function uses `key-binding' to look
8604 ;; up if the key has an associated command in another currently active
8605 ;; keymap (minor modes, major mode, global), and executes that
8606 ;; command. There might be problems if any of the keys is otherwise
8607 ;; used as a prefix key.
8609 (defcustom orgstruct-heading-prefix-regexp ""
8610 "Regexp that matches the custom prefix of Org headlines in
8611 orgstruct(++)-mode."
8612 :group 'org
8613 :type 'string)
8614 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8616 (defcustom orgstruct-setup-hook nil
8617 "Hook run after orgstruct-mode-map is filled."
8618 :group 'org
8619 :type 'hook)
8621 (defvar orgstruct-initialized nil)
8623 (defvar org-local-vars nil
8624 "List of local variables, for use by `orgstruct-mode'.")
8626 ;;;###autoload
8627 (define-minor-mode orgstruct-mode
8628 "Toggle the minor mode `orgstruct-mode'.
8629 This mode is for using Org-mode structure commands in other
8630 modes. The following keys behave as if Org-mode were active, if
8631 the cursor is on a headline, or on a plain list item (both as
8632 defined by Org-mode)."
8633 nil " OrgStruct" (make-sparse-keymap)
8634 (when orgstruct-mode
8635 (org-load-modules-maybe)
8636 (unless orgstruct-initialized
8637 (orgstruct-setup)
8638 (setq orgstruct-initialized t))))
8640 ;;;###autoload
8641 (defun turn-on-orgstruct ()
8642 "Unconditionally turn on `orgstruct-mode'."
8643 (orgstruct-mode 1))
8645 (defvar org-fb-vars nil)
8646 (make-variable-buffer-local 'org-fb-vars)
8647 (defun orgstruct++-mode (&optional arg)
8648 "Toggle `orgstruct-mode', the enhanced version of it.
8649 In addition to setting orgstruct-mode, this also exports all
8650 indentation and autofilling variables from org-mode into the
8651 buffer. It will also recognize item context in multiline items."
8652 (interactive "P")
8653 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8654 (if (< arg 1)
8655 (progn (orgstruct-mode -1)
8656 (mapc (lambda(v)
8657 (org-set-local (car v)
8658 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8659 org-fb-vars))
8660 (orgstruct-mode 1)
8661 (setq org-fb-vars nil)
8662 (let (var val)
8663 (mapc
8664 (lambda (x)
8665 (when (string-match
8667 (symbol-name (car x)))
8668 (setq var (car x) val (nth 1 x))
8669 (push (list var `(quote ,(eval var))) org-fb-vars)
8670 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8671 org-local-vars)
8672 (org-set-local 'orgstruct-is-++ t))))
8674 (defvar orgstruct-is-++ nil
8675 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8676 (make-variable-buffer-local 'orgstruct-is-++)
8678 ;;;###autoload
8679 (defun turn-on-orgstruct++ ()
8680 "Unconditionally turn on `orgstruct++-mode'."
8681 (orgstruct++-mode 1))
8683 (defun orgstruct-error ()
8684 "Error when there is no default binding for a structure key."
8685 (interactive)
8686 (error "This key has no function outside structure elements"))
8688 (defun orgstruct-setup ()
8689 "Setup orgstruct keymap."
8690 (dolist (f
8691 '("org-meta"
8692 "org-shiftmeta"
8693 org-shifttab
8694 org-backward-element
8695 org-backward-heading-same-level
8696 org-ctrl-c-ret
8697 org-cycle
8698 org-forward-heading-same-level
8699 org-insert-heading
8700 org-insert-heading-respect-content
8701 org-kill-note-or-show-branches
8702 org-mark-subtree
8703 org-narrow-to-subtree
8704 org-promote-subtree
8705 org-reveal
8706 org-show-subtree
8707 org-sort
8708 org-up-element
8709 outline-demote
8710 outline-next-visible-heading
8711 outline-previous-visible-heading
8712 outline-promote
8713 outline-up-heading
8714 show-children))
8715 (dolist (f (if (stringp f)
8716 (let ((flist))
8717 (dolist (postfix
8718 '("-return" "tab" "left" "right" "up" "down")
8719 flist)
8720 (let ((f (intern (concat f postfix))))
8721 (when (fboundp f)
8722 (push f flist)))))
8723 (list f)))
8724 (dolist (binding (nconc (where-is-internal f org-mode-map)
8725 (where-is-internal f outline-mode-map)))
8726 ;; TODO use local-function-key-map
8727 (dolist (rep '(("<tab>" . "TAB")
8728 ("<return>" . "RET")
8729 ("<escape>" . "ESC")
8730 ("<delete>" . "DEL")))
8731 (setq binding (read-kbd-macro (replace-regexp-in-string
8732 (regexp-quote (car rep))
8733 (cdr rep)
8734 (key-description binding)))))
8735 (let ((key (lookup-key orgstruct-mode-map binding)))
8736 (when (or (not key) (numberp key))
8737 (condition-case nil
8738 (org-defkey orgstruct-mode-map
8739 binding
8740 (orgstruct-make-binding f binding))
8741 (error nil)))))))
8742 (run-hooks 'orgstruct-setup-hook))
8744 (defun orgstruct-make-binding (fun key)
8745 "Create a function for binding in the structure minor mode.
8746 FUN is the command to call inside a table. KEY is the key that
8747 should be checked in for a command to execute outside of tables."
8748 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8749 (let ((nname name)
8750 (i 0))
8751 (while (fboundp (intern nname))
8752 (setq nname (format "%s-%d" name (setq i (1+ i)))))
8753 (setq name (intern nname)))
8754 (eval
8755 `(defun ,name (arg)
8757 "Outside of structure, run the binding of `"
8758 (key-description key) "'.")
8759 (interactive "p")
8760 (unless
8761 (let* ((org-heading-regexp
8762 (concat "^"
8763 orgstruct-heading-prefix-regexp
8765 (org-outline-regexp
8767 (org-outline-regexp-bol
8768 (concat "^" org-outline-regexp))
8769 (outline-regexp org-outline-regexp)
8771 (outline-level 'outline-level)
8772 (outline-heading-alist))
8773 (when (org-context-p 'headline 'item
8774 ,(when (memq fun '(org-insert-heading))
8775 '(when orgstruct-is-++
8776 'item-body)))
8777 (org-run-like-in-org-mode ',fun)
8778 t))
8779 (let* ((orgstruct-mode)
8780 (binding (key-binding ,key)))
8781 (if (keymapp binding)
8782 (set-temporary-overlay-map binding)
8783 (call-interactively
8784 (or binding 'orgstruct-error)))))))
8785 name))
8787 (defun org-contextualize-keys (alist contexts)
8788 "Return valid elements in ALIST depending on CONTEXTS.
8790 `org-agenda-custom-commands' or `org-capture-templates' are the
8791 values used for ALIST, and `org-agenda-custom-commands-contexts'
8792 or `org-capture-templates-contexts' are the associated contexts
8793 definitions."
8794 (let ((contexts
8795 ;; normalize contexts
8796 (mapcar
8797 (lambda(c) (cond ((listp (cadr c))
8798 (list (car c) (car c) (cadr c)))
8799 ((string= "" (cadr c))
8800 (list (car c) (car c) (caddr c)))
8801 (t c))) contexts))
8802 (a alist) c r s)
8803 ;; loop over all commands or templates
8804 (while (setq c (pop a))
8805 (let (vrules repl)
8806 (cond
8807 ((not (assoc (car c) contexts))
8808 (push c r))
8809 ((and (assoc (car c) contexts)
8810 (setq vrules (org-contextualize-validate-key
8811 (car c) contexts)))
8812 (mapc (lambda (vr)
8813 (when (not (equal (car vr) (cadr vr)))
8814 (setq repl vr))) vrules)
8815 (if (not repl) (push c r)
8816 (push (cadr repl) s)
8817 (push
8818 (cons (car c)
8819 (cdr (or (assoc (cadr repl) alist)
8820 (error "Undefined key `%s' as contextual replacement for `%s'"
8821 (cadr repl) (car c)))))
8822 r))))))
8823 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8824 (delq
8825 nil
8826 (delete-dups
8827 (mapcar (lambda (x)
8828 (let ((tpl (car x)))
8829 (when (not (delq
8830 nil
8831 (mapcar (lambda(y)
8832 (equal y tpl)) s))) x)))
8833 (reverse r))))))
8835 (defun org-contextualize-validate-key (key contexts)
8836 "Check CONTEXTS for agenda or capture KEY."
8837 (let (r rr res)
8838 (while (setq r (pop contexts))
8839 (mapc
8840 (lambda (rr)
8841 (when
8842 (and (equal key (car r))
8843 (if (functionp rr) (funcall rr)
8844 (or (and (eq (car rr) 'in-file)
8845 (buffer-file-name)
8846 (string-match (cdr rr) (buffer-file-name)))
8847 (and (eq (car rr) 'in-mode)
8848 (string-match (cdr rr) (symbol-name major-mode)))
8849 (and (eq (car rr) 'in-buffer)
8850 (string-match (cdr rr) (buffer-name)))
8851 (when (and (eq (car rr) 'not-in-file)
8852 (buffer-file-name))
8853 (not (string-match (cdr rr) (buffer-file-name))))
8854 (when (eq (car rr) 'not-in-mode)
8855 (not (string-match (cdr rr) (symbol-name major-mode))))
8856 (when (eq (car rr) 'not-in-buffer)
8857 (not (string-match (cdr rr) (buffer-name)))))))
8858 (push r res)))
8859 (car (last r))))
8860 (delete-dups (delq nil res))))
8862 (defun org-context-p (&rest contexts)
8863 "Check if local context is any of CONTEXTS.
8864 Possible values in the list of contexts are `table', `headline', and `item'."
8865 (let ((pos (point)))
8866 (goto-char (point-at-bol))
8867 (prog1 (or (and (memq 'table contexts)
8869 (and (memq 'headline contexts)
8870 (looking-at org-outline-regexp))
8871 (and (memq 'item contexts)
8873 (and (memq 'item-body contexts)
8874 (org-in-item-p)))
8875 (goto-char pos))))
8877 (defun org-get-local-variables ()
8878 "Return a list of all local variables in an Org mode buffer."
8879 (let (varlist)
8880 (with-current-buffer (get-buffer-create "*Org tmp*")
8881 (erase-buffer)
8882 (org-mode)
8883 (setq varlist (buffer-local-variables)))
8884 (kill-buffer "*Org tmp*")
8885 (delq nil
8886 (mapcar
8887 (lambda (x)
8888 (setq x
8889 (if (symbolp x)
8890 (list x)
8891 (list (car x) (cdr x))))
8892 (if (and (not (get (car x) 'org-state))
8893 (string-match
8894 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8895 (symbol-name (car x))))
8896 x nil))
8897 varlist))))
8899 (defun org-clone-local-variables (from-buffer &optional regexp)
8900 "Clone local variables from FROM-BUFFER.
8901 Optional argument REGEXP selects variables to clone."
8902 (mapc
8903 (lambda (pair)
8904 (and (symbolp (car pair))
8905 (or (null regexp)
8906 (string-match regexp (symbol-name (car pair))))
8907 (set (make-local-variable (car pair))
8908 (cdr pair))))
8909 (buffer-local-variables from-buffer)))
8911 ;;;###autoload
8912 (defun org-run-like-in-org-mode (cmd)
8913 "Run a command, pretending that the current buffer is in Org-mode.
8914 This will temporarily bind local variables that are typically bound in
8915 Org-mode to the values they have in Org-mode, and then interactively
8916 call CMD."
8917 (org-load-modules-maybe)
8918 (unless org-local-vars
8919 (setq org-local-vars (org-get-local-variables)))
8920 (let (binds)
8921 (dolist (var org-local-vars)
8922 (when (or (not (boundp (car var)))
8923 (eq (symbol-value (car var))
8924 (default-value (car var))))
8925 (push (list (car var) `(quote ,(cadr var))) binds)))
8926 (eval `(let ,binds
8927 (call-interactively (quote ,cmd))))))
8929 ;;;; Archiving
8931 (defun org-get-category (&optional pos force-refresh)
8932 "Get the category applying to position POS."
8933 (save-match-data
8934 (if force-refresh (org-refresh-category-properties))
8935 (let ((pos (or pos (point))))
8936 (or (get-text-property pos 'org-category)
8937 (progn (org-refresh-category-properties)
8938 (get-text-property pos 'org-category))))))
8940 (defun org-refresh-category-properties ()
8941 "Refresh category text properties in the buffer."
8942 (let ((case-fold-search t)
8943 (inhibit-read-only t)
8944 (def-cat (cond
8945 ((null org-category)
8946 (if buffer-file-name
8947 (file-name-sans-extension
8948 (file-name-nondirectory buffer-file-name))
8949 "???"))
8950 ((symbolp org-category) (symbol-name org-category))
8951 (t org-category)))
8952 beg end cat pos optionp)
8953 (with-silent-modifications
8954 (save-excursion
8955 (save-restriction
8956 (widen)
8957 (goto-char (point-min))
8958 (put-text-property (point) (point-max) 'org-category def-cat)
8959 (while (re-search-forward
8961 (setq pos (match-end 0)
8962 optionp (equal (char-after (match-beginning 0)) ?#)
8963 cat (org-trim (match-string 2)))
8964 (if optionp
8965 (setq beg (point-at-bol) end (point-max))
8966 (org-back-to-heading t)
8967 (setq beg (point) end (org-end-of-subtree t t)))
8968 (put-text-property beg end 'org-category cat)
8969 (put-text-property beg end 'org-category-position beg)
8970 (goto-char pos)))))))
8972 (defun org-refresh-properties (dprop tprop)
8973 "Refresh buffer text properties.
8974 DPROP is the drawer property and TPROP is the corresponding text
8975 property to set."
8976 (let ((case-fold-search t)
8977 (inhibit-read-only t) p)
8978 (with-silent-modifications
8979 (save-excursion
8980 (save-restriction
8981 (widen)
8982 (goto-char (point-min))
8984 (setq p (org-match-string-no-properties 1))
8985 (save-excursion
8986 (org-back-to-heading t)
8987 (put-text-property
8988 (point-at-bol) (point-at-eol) tprop p))))))))
8991 ;;;; Link Stuff
8993 ;;; Link abbreviations
8995 (defun org-link-expand-abbrev (link)
8996 "Apply replacements as defined in `org-link-abbrev-alist'."
8998 (let* ((key (match-string 1 link))
8999 (as (or (assoc key org-link-abbrev-alist-local)
9000 (assoc key org-link-abbrev-alist)))
9001 (tag (and (match-end 2) (match-string 3 link)))
9002 rpl)
9003 (if (not as)
9004 link
9005 (setq rpl (cdr as))
9006 (cond
9007 ((symbolp rpl) (funcall rpl tag))
9009 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
9010 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9011 ((string-match "%h" rpl)
9012 (replace-match (url-hexify-string (or tag "")) t t rpl))
9013 (t (concat rpl tag)))))
9014 link))
9016 ;;; Storing and inserting links
9018 (defvar org-insert-link-history nil
9019 "Minibuffer history for links inserted with `org-insert-link'.")
9021 (defvar org-stored-links nil
9022 "Contains the links stored with `org-store-link'.")
9024 (defvar org-store-link-plist nil
9025 "Plist with info about the most recently link created with `org-store-link'.")
9027 (defvar org-link-protocols nil
9028 "Link protocols added to Org-mode using `org-add-link-type'.")
9030 (defvar org-store-link-functions nil
9031 "List of functions that are called to create and store a link.
9032 Each function will be called in turn until one returns a non-nil
9033 value. Each function should check if it is responsible for creating
9034 this link (for example by looking at the major mode).
9035 If not, it must exit and return nil.
9036 If yes, it should return a non-nil value after a calling
9037 `org-store-link-props' with a list of properties and values.
9038 Special properties are:
9042 This is obligatory as well.
9043 :description Optional default description for the second pair
9044 of brackets in an Org-mode link. The user can still change
9045 this when inserting this link into an Org-mode buffer.
9047 In addition to these, any additional properties can be specified
9048 and then used in capture templates.")
9050 (defun org-add-link-type (type &optional follow export)
9051 "Add TYPE to the list of `org-link-types'.
9052 Re-compute all regular expressions depending on `org-link-types'
9054 FOLLOW and EXPORT are two functions.
9056 FOLLOW should take the link path as the single argument and do whatever
9057 is necessary to follow the link, for example find a file or display
9058 a mail message.
9060 EXPORT should format the link path for export to one of the export formats.
9061 It should be a function accepting three arguments:
9064 desc the description of the link, if any, or a description added by
9065 org-export-normalize-links if there is none
9066 format the export format, a symbol like `html' or `latex' or `ascii'..
9068 The function may use the FORMAT information to return different values
9069 depending on the format. The return value will be put literally into
9070 the exported file. If the return value is nil, this means Org should
9071 do what it normally does with links which do not have EXPORT defined.
9073 Org-mode has a built-in default for exporting links. If you are happy with
9074 this default, there is no need to define an export function for the link
9075 type. For a simple example of an export function, see `org-bbdb.el'."
9076 (add-to-list 'org-link-types type t)
9077 (org-make-link-regexps)
9078 (if (assoc type org-link-protocols)
9079 (setcdr (assoc type org-link-protocols) (list follow export))
9080 (push (list type follow export) org-link-protocols)))
9082 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9083 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9085 ;;;###autoload
9086 (defun org-store-link (arg)
9088 This link is added to `org-stored-links' and can later be inserted
9091 For some link types, a prefix arg is interpreted.
9092 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9093 For file links, arg negates `org-context-in-file-links'.
9095 A double prefix arg force skipping storing functions that are not
9096 part of Org's core."
9097 (interactive "P")
9098 (org-load-modules-maybe)
9099 (setq org-store-link-plist nil) ; reset
9100 (org-with-limited-levels
9101 (let (link cpltxt desc description search txt custom-id agenda-link sfuns sfunsn)
9102 (cond
9103 ((and (not (equal arg '(16)))
9104 (setq sfuns
9105 (delq
9106 nil (mapcar (lambda (f) (let (fs) (if (funcall f) (push f fs))))
9107 org-store-link-functions))
9108 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9109 (or (and (cdr sfuns)
9110 (funcall (intern
9111 (completing-read "Which function for creating the link? "
9112 sfunsn t (car sfunsn)))))
9113 (funcall (caar sfuns)))
9114 (setq link (plist-get org-store-link-plist :link)
9115 desc (or (plist-get org-store-link-plist :description) link))))
9116 ((org-src-edit-buffer-p)
9117 (let (label gc)
9118 (while (or (not label)
9119 (save-excursion
9120 (save-restriction
9121 (widen)
9122 (goto-char (point-min))
9123 (re-search-forward
9124 (regexp-quote (format org-coderef-label-format label))
9125 nil t))))
9126 (when label (message "Label exists already") (sit-for 2))
9127 (setq label (read-string "Code line label: " label)))
9128 (end-of-line 1)
9129 (setq link (format org-coderef-label-format label))
9130 (setq gc (- 79 (length link)))
9131 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9132 (insert link)
9133 (setq link (concat "(" label ")") desc nil)))
9135 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9136 ;; We are in the agenda, link to referenced location
9137 (let ((m (or (get-text-property (point) 'org-hd-marker)
9138 (get-text-property (point) 'org-marker))))
9139 (when m
9140 (org-with-point-at m
9141 (setq agenda-link
9142 (if (org-called-interactively-p 'any)
9143 (call-interactively 'org-store-link)
9144 (org-store-link nil)))))))
9146 ((eq major-mode 'calendar-mode)
9147 (let ((cd (calendar-cursor-to-date)))
9148 (setq link
9149 (format-time-string
9150 (car org-time-stamp-formats)
9151 (apply 'encode-time
9152 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9153 nil nil nil))))
9154 (org-store-link-props :type "calendar" :date cd)))
9156 ((eq major-mode 'help-mode)
9157 (setq link (concat "help:" (save-excursion
9158 (goto-char (point-min))
9159 (looking-at "^[^ ]+")
9160 (match-string 0))))
9161 (org-store-link-props :type "help"))
9163 ((eq major-mode 'w3-mode)
9164 (setq cpltxt (if (and (buffer-name)
9165 (not (string-match "Untitled" (buffer-name))))
9166 (buffer-name)
9167 (url-view-url t))
9168 link (url-view-url t))
9169 (org-store-link-props :type "w3" :url (url-view-url t)))
9171 ((setq search (run-hook-with-args-until-success
9172 'org-create-file-search-functions))
9173 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9174 "::" search))
9175 (setq cpltxt (or description link)))
9177 ((eq major-mode 'image-mode)
9178 (setq cpltxt (concat "file:"
9179 (abbreviate-file-name buffer-file-name))
9180 link cpltxt)
9181 (org-store-link-props :type "image" :file buffer-file-name))
9183 ((eq major-mode 'dired-mode)
9184 ;; link to the file in the current line
9185 (let ((file (dired-get-filename nil t)))
9186 (setq file (if file
9187 (abbreviate-file-name
9188 (expand-file-name (dired-get-filename nil t)))
9189 ;; otherwise, no file so use current directory.
9190 default-directory))
9191 (setq cpltxt (concat "file:" file)
9192 link cpltxt)))
9194 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9195 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9196 (cond
9198 (setq cpltxt
9199 (concat "file:"
9200 (abbreviate-file-name
9201 (buffer-file-name (buffer-base-buffer)))
9202 "::" (match-string 1))
9203 link cpltxt))
9204 ((and (featurep 'org-id)
9205 (or (eq org-id-link-to-org-use-id t)
9206 (and (org-called-interactively-p 'any)
9207 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9208 (and (eq org-id-link-to-org-use-id
9209 'create-if-interactive-and-no-custom-id)
9210 (not custom-id))))
9211 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9212 ;; We can make a link using the ID.
9213 (setq link (condition-case nil
9214 (prog1 (org-id-store-link)
9215 (setq desc (plist-get org-store-link-plist :description)))
9216 (error
9217 ;; probably before first headline, link to file only
9218 (concat "file:"
9219 (abbreviate-file-name
9220 (buffer-file-name (buffer-base-buffer))))))))
9221 (t
9222 ;; Just link to current headline
9223 (setq cpltxt (concat "file:"
9224 (abbreviate-file-name
9225 (buffer-file-name (buffer-base-buffer)))))
9226 ;; Add a context search string
9227 (when (org-xor org-context-in-file-links arg)
9228 (let* ((ee (org-element-at-point))
9229 (et (org-element-type ee))
9230 (ev (plist-get (cadr ee) :value)))
9231 (setq txt (cond
9232 ((org-at-heading-p) nil)
9233 ((eq et 'keyword) ev)
9234 ((org-region-active-p)
9235 (buffer-substring (region-beginning) (region-end)))))
9237 (setq cpltxt
9238 (concat cpltxt "::"
9239 (condition-case nil
9240 (org-make-org-heading-search-string txt)
9241 (error "")))
9242 desc (or (and (eq et 'keyword) ev)
9243 (nth 4 (ignore-errors (org-heading-components)))
9244 "NONE")))))
9246 (setq cpltxt (substring cpltxt 0 -2)))
9247 (setq link cpltxt))))
9249 ((buffer-file-name (buffer-base-buffer))
9250 ;; Just link to this file here.
9251 (setq cpltxt (concat "file:"
9252 (abbreviate-file-name
9253 (buffer-file-name (buffer-base-buffer)))))
9254 ;; Add a context string
9255 (when (org-xor org-context-in-file-links arg)
9256 (setq txt (if (org-region-active-p)
9257 (buffer-substring (region-beginning) (region-end))
9258 (buffer-substring (point-at-bol) (point-at-eol))))
9259 ;; Only use search option if there is some text.
9261 (setq cpltxt
9262 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9263 desc "NONE")))
9264 (setq link cpltxt))
9266 ((org-called-interactively-p 'interactive)
9267 (user-error "No method for storing a link from this buffer"))
9269 (t (setq link nil)))
9271 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9272 (setq link (or link cpltxt)
9273 desc (or desc cpltxt))
9274 (cond ((equal desc "NONE") (setq desc nil))
9275 ((string-match org-bracket-link-regexp desc)
9276 (setq desc (replace-regexp-in-string
9277 org-bracket-link-regexp
9279 (length desc)) "*" "")) desc))))
9281 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
9282 (progn
9283 (setq org-stored-links
9284 (cons (list link desc) org-stored-links))
9285 (message "Stored: %s" (or desc link))
9286 (when custom-id
9287 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
9288 "::#" custom-id))
9289 (setq org-stored-links
9290 (cons (list link desc) org-stored-links))))
9291 (or agenda-link (and link (org-make-link-string link desc)))))))
9293 (defun org-store-link-props (&rest plist)
9294 "Store link properties, extract names and addresses."
9295 (let (x adr)
9296 (when (setq x (plist-get plist :from))
9297 (setq adr (mail-extract-address-components x))
9298 (setq plist (plist-put plist :fromname (car adr)))
9299 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9300 (when (setq x (plist-get plist :to))
9301 (setq adr (mail-extract-address-components x))
9302 (setq plist (plist-put plist :toname (car adr)))
9303 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9304 (let ((from (plist-get plist :from))
9305 (to (plist-get plist :to)))
9306 (when (and from to org-from-is-user-regexp)
9307 (setq plist
9308 (plist-put plist :fromto
9309 (if (string-match org-from-is-user-regexp from)
9310 (concat "to %t")
9311 (concat "from %f"))))))
9312 (setq org-store-link-plist plist))
9314 (defun org-add-link-props (&rest plist)
9315 "Add these properties to the link property list."
9316 (let (key value)
9317 (while plist
9318 (setq key (pop plist) value (pop plist))
9319 (setq org-store-link-plist
9320 (plist-put org-store-link-plist key value)))))
9322 (defun org-email-link-description (&optional fmt)
9323 "Return the description part of an email link.
9324 This takes information from `org-store-link-plist' and formats it
9325 according to FMT (default from `org-email-link-description-format')."
9326 (setq fmt (or fmt org-email-link-description-format))
9327 (let* ((p org-store-link-plist)
9328 (to (plist-get p :toaddress))
9329 (from (plist-get p :fromaddress))
9330 (table
9331 (list
9332 (cons "%c" (plist-get p :fromto))
9333 (cons "%F" (plist-get p :from))
9334 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9335 (cons "%T" (plist-get p :to))
9336 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9337 (cons "%s" (plist-get p :subject))
9338 (cons "%d" (plist-get p :date))
9339 (cons "%m" (plist-get p :message-id)))))
9340 (when (string-match "%c" fmt)
9341 ;; Check if the user wrote this message
9342 (if (and org-from-is-user-regexp from to
9343 (save-match-data (string-match org-from-is-user-regexp from)))
9344 (setq fmt (replace-match "to %t" t t fmt))
9345 (setq fmt (replace-match "from %f" t t fmt))))
9346 (org-replace-escapes fmt table)))
9348 (defun org-make-org-heading-search-string (&optional string)
9349 "Make search string for the current headline or STRING."
9350 (let ((s (or string
9351 (and (derived-mode-p 'org-mode)
9352 (save-excursion
9353 (org-back-to-heading t)
9354 (org-element-property :raw-value (org-element-at-point))))))
9355 (lines org-context-in-file-links))
9356 (or string (setq s (concat "*" s))) ; Add * for headlines
9358 (when (and string (integerp lines) (> lines 0))
9360 (when (< lines (length slines))
9361 (setq s (mapconcat
9362 'identity
9363 (reverse (nthcdr (- (length slines) lines)
9367 (defun org-make-link-string (link &optional description)
9368 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9370 (error "Empty link"))
9371 (when (and description
9372 (stringp description)
9374 (setq description nil))
9375 (when (stringp description)
9376 ;; Remove brackets from the description, they are fatal.
9378 (setq description (replace-match "{" t t description)))
9380 (setq description (replace-match "}" t t description))))
9381 (when (equal link description)
9382 ;; No description needed, it is identical
9383 (setq description nil))
9384 (when (and (not description)
9385 (not (string-match (org-image-file-name-regexp) link))
9386 (not (equal link (org-link-escape link))))
9387 (setq description (org-extract-attributes link)))
9388 (setq link
9389 (cond ((string-match (org-image-file-name-regexp) link) link)
9390 ((string-match org-link-types-re link)
9391 (concat (match-string 1 link)
9392 (org-link-escape (substring link (match-end 1)))))
9393 (t (org-link-escape link))))
9394 (concat "[[" link "]"
9395 (if description (concat "[" description "]") "")
9396 "]"))
9398 (defconst org-link-escape-chars
9399 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9400 "List of characters that should be escaped in link.
9401 This is the list that is used for internal purposes.")
9403 (defconst org-link-escape-chars-browser
9404 '(?\ )
9405 "List of escapes for characters that are problematic in links.
9406 This is the list that is used before handing over to the browser.")
9408 (defun org-link-escape (text &optional table merge)
9409 "Return percent escaped representation of TEXT.
9410 TEXT is a string with the text to escape.
9411 Optional argument TABLE is a list with characters that should be
9412 escaped. When nil, `org-link-escape-chars' is used.
9413 If optional argument MERGE is set, merge TABLE into
9414 `org-link-escape-chars'."
9415 (cond
9416 ((and table merge)
9417 (mapc (lambda (defchr)
9418 (unless (member defchr table)
9419 (setq table (cons defchr table)))) org-link-escape-chars))
9420 ((null table)
9421 (setq table org-link-escape-chars)))
9422 (mapconcat
9423 (lambda (char)
9424 (if (or (member char table)
9425 (and (or (< char 32) (= char 37) (> char 126))
9426 org-url-hexify-p))
9427 (mapconcat (lambda (sequence-element)
9428 (format "%%%.2X" sequence-element))
9429 (or (encode-coding-char char 'utf-8)
9430 (error "Unable to percent escape character: %s"
9431 (char-to-string char))) "")
9432 (char-to-string char))) text ""))
9434 (defun org-link-unescape (str)
9435 "Unhex hexified Unicode strings as returned from the JavaScript function
9436 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9437 (unless (and (null str) (string= "" str))
9438 (let ((pos 0) (case-fold-search t) unhexed)
9440 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9441 (setq str (replace-match unhexed t t str))
9442 (setq pos (+ pos (length unhexed))))))
9443 str)
9445 (defun org-link-unescape-compound (hex)
9446 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9447 Note: this function also decodes single byte encodings like
9448 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9449 (save-match-data
9450 (let* ((bytes (cdr (split-string hex "%")))
9451 (ret "")
9452 (eat 0)
9453 (sum 0))
9454 (while bytes
9455 (let* ((val (string-to-number (pop bytes) 16))
9456 (shift-xor
9457 (if (= 0 eat)
9458 (cond
9459 ((>= val 252) (cons 6 252))
9460 ((>= val 248) (cons 5 248))
9461 ((>= val 240) (cons 4 240))
9462 ((>= val 224) (cons 3 224))
9463 ((>= val 192) (cons 2 192))
9464 (t (cons 0 0)))
9465 (cons 6 128))))
9466 (if (>= val 192) (setq eat (car shift-xor)))
9467 (setq val (logxor val (cdr shift-xor)))
9468 (setq sum (+ (lsh sum (car shift-xor)) val))
9469 (if (> eat 0) (setq eat (- eat 1)))
9470 (cond
9471 ((= 0 eat) ;multi byte
9472 (setq ret (concat ret (org-char-to-string sum)))
9473 (setq sum 0))
9474 ((not bytes) ; single byte(s)
9475 (setq ret (org-link-unescape-single-byte-sequence hex))))
9476 )) ;; end (while bytes
9477 ret )))
9479 (defun org-link-unescape-single-byte-sequence (hex)
9480 "Unhexify hex-encoded single byte character sequences."
9481 (mapconcat (lambda (byte)
9482 (char-to-string (string-to-number byte 16)))
9483 (cdr (split-string hex "%")) ""))
9485 (defun org-xor (a b)
9486 "Exclusive or."
9487 (if a (not b) b))
9489 (defun org-fixup-message-id-for-http (s)
9490 "Replace special characters in a message id, so it can be used in an http query."
9491 (when (string-match "%" s)
9492 (setq s (mapconcat (lambda (c)
9493 (if (eq c ?%)
9494 "%25"
9495 (char-to-string c)))
9496 s "")))
9497 (while (string-match "<" s)
9498 (setq s (replace-match "%3C" t t s)))
9499 (while (string-match ">" s)
9500 (setq s (replace-match "%3E" t t s)))
9501 (while (string-match "@" s)
9502 (setq s (replace-match "%40" t t s)))
9503 s)
9505 (defun org-link-prettify (link)
9506 "Return a human-readable representation of LINK.
9507 The car of LINK must be a raw link the cdr of LINK must be either
9508 a link description or nil."
9509 (let ((desc (or (cadr link) "<no description>")))
9510 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9511 "<" (car link) ">")))
9513 ;;;###autoload
9514 (defun org-insert-link-global ()
9515 "Insert a link like Org-mode does.
9516 This command can be called in any mode to insert a link in Org-mode syntax."
9517 (interactive)
9518 (org-load-modules-maybe)
9519 (org-run-like-in-org-mode 'org-insert-link))
9521 (defun org-insert-all-links (&optional keep)
9522 "Insert all links in `org-stored-links'."
9523 (interactive "P")
9524 (let ((links (copy-sequence org-stored-links)) l)
9525 (while (setq l (if keep (pop links) (pop org-stored-links)))
9526 (insert "- ")
9527 (org-insert-link nil (car l) (cadr l))
9530 (defun org-link-fontify-links-to-this-file ()
9531 "Fontify links to the current file in `org-stored-links'."
9532 (let ((f (buffer-file-name)) a b)
9533 (setq a (mapcar (lambda(l)
9534 (let ((ll (car l)))
9536 (equal f (expand-file-name (match-string 1 ll))))
9537 ll)))
9538 org-stored-links))
9539 (when (featurep 'org-id)
9540 (setq b (mapcar (lambda(l)
9541 (let ((ll (car l)))
9543 (equal f (expand-file-name
9544 (or (org-id-find-id-file
9545 (match-string 1 ll)) ""))))
9546 ll)))
9547 org-stored-links)))
9548 (mapcar (lambda(l)
9549 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9550 (delq nil (append a b)))))
9552 (defvar org-link-links-in-this-file nil)
9553 (defun org-insert-link (&optional complete-file link-location default-description)
9554 "Insert a link. At the prompt, enter the link.
9556 Completion can be used to insert any of the link protocol prefixes like
9557 http or ftp in use.
9559 The history can be used to select a link previously stored with
9560 `org-store-link'. When the empty string is entered (i.e. if you just
9561 press RET at the prompt), the link defaults to the most recently
9562 stored link. As SPC triggers completion in the minibuffer, you need to
9563 use M-SPC or C-q SPC to force the insertion of a space character.
9565 You will also be prompted for a description, and if one is given, it will
9566 be displayed in the buffer instead of the link.
9568 If there is already a link at point, this command will allow you to edit link
9569 and description parts.
9572 be selected using completion. The path to the file will be relative to the
9573 current directory if the file is in the current directory or a subdirectory.
9574 Otherwise, the link will be the absolute path as completed in the minibuffer
9575 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9576 option `org-link-file-path-type'.
9579 the current directory or below.
9582 `org-keep-stored-link-after-insertion'.
9584 If `org-make-link-description-function' is non-nil, this function will be
9585 called with the link target, and the result will be the default
9586 link description.
9588 If the LINK-LOCATION parameter is non-nil, this value will be
9589 used as the link location instead of reading one interactively.
9591 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9592 be used as the default description."
9593 (interactive "P")
9594 (let* ((wcf (current-window-configuration))
9595 (origbuf (current-buffer))
9596 (region (if (org-region-active-p)
9597 (buffer-substring (region-beginning) (region-end))))
9598 (remove (and region (list (region-beginning) (region-end))))
9599 (desc region)
9600 tmphist ; byte-compile incorrectly complains about this
9601 (link link-location)
9602 (abbrevs org-link-abbrev-alist-local)
9603 entry file all-prefixes auto-desc)
9604 (cond
9605 (link-location) ; specified by arg, just use it.
9606 ((org-in-regexp org-bracket-link-regexp 1)
9607 ;; We do have a link at point, and we are going to edit it.
9608 (setq remove (list (match-beginning 0) (match-end 0)))
9609 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9610 (setq link (read-string "Link: "
9611 (org-link-unescape
9612 (org-match-string-no-properties 1)))))
9613 ((or (org-in-regexp org-angle-link-re)
9614 (org-in-regexp org-plain-link-re))
9615 ;; Convert to bracket link
9616 (setq remove (list (match-beginning 0) (match-end 0))
9617 link (read-string "Link: "
9618 (org-remove-angle-brackets (match-string 0)))))
9619 ((member complete-file '((4) (16)))
9620 ;; Completing read for file names.
9621 (setq link (org-file-complete-link complete-file)))
9622 (t
9623 ;; Read link, with completion for stored links.
9624 (org-link-fontify-links-to-this-file)
9625 (org-switch-to-buffer-other-window "*Org Links*")
9626 (with-current-buffer "*Org Links*"
9627 (erase-buffer)
9628 (insert "Insert a link.
9630 (when org-stored-links
9632 (insert (mapconcat 'org-link-prettify
9634 (goto-char (point-min)))
9635 (let ((cw (selected-window)))
9636 (select-window (get-buffer-window "*Org Links*" 'visible))
9637 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9638 (unless (pos-visible-in-window-p (point-max))
9639 (org-fit-window-to-buffer))
9640 (and (window-live-p cw) (select-window cw)))
9641 ;; Fake a link history, containing the stored links.
9642 (setq tmphist (append (mapcar 'car org-stored-links)
9643 org-insert-link-history))
9644 (setq all-prefixes (append (mapcar 'car abbrevs)
9645 (mapcar 'car org-link-abbrev-alist)
9646 org-link-types))
9647 (unwind-protect
9648 (progn
9649 (setq link
9650 (org-completing-read
9651 "Link: "
9652 (append
9653 (mapcar (lambda (x) (concat x ":"))
9654 all-prefixes)
9655 (mapcar 'car org-stored-links))
9656 nil nil nil
9657 'tmphist
9658 (caar org-stored-links)))
9660 (error "No link selected"))
9661 (mapc (lambda(l)
9662 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9663 org-stored-links)
9664 (if (or (member link all-prefixes)
9665 (and (equal ":" (substring link -1))
9666 (member (substring link 0 -1) all-prefixes)
9667 (setq link (substring link 0 -1))))
9668 (setq link (with-current-buffer origbuf
9669 (org-link-try-special-completion link)))))
9670 (set-window-configuration wcf)
9671 (kill-buffer "*Org Links*"))
9672 (setq entry (assoc link org-stored-links))
9673 (or entry (push link org-insert-link-history))
9674 (setq desc (or desc (nth 1 entry)))))
9676 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9677 (not org-keep-stored-link-after-insertion))
9678 (setq org-stored-links (delq (assoc link org-stored-links)
9679 org-stored-links)))
9681 (if (string-match org-plain-link-re link)
9682 ;; URL-like link, normalize the use of angular brackets.
9683 (setq link (org-remove-angle-brackets link)))
9685 ;; Check if we are linking to the current file with a search
9686 ;; option If yes, simplify the link by using only the search
9687 ;; option.
9688 (when (and buffer-file-name
9690 (let* ((path (match-string 1 link))
9691 (case-fold-search nil)
9692 (search (match-string 2 link)))
9693 (save-match-data
9694 (if (equal (file-truename buffer-file-name) (file-truename path))
9695 ;; We are linking to this same file, with a search option
9696 (setq link search)))))
9698 ;; Check if we can/should use a relative path. If yes, simplify the link
9700 (let* ((type (match-string 1 link))
9701 (path (match-string 2 link))
9702 (origpath path)
9703 (case-fold-search nil))
9704 (cond
9705 ((or (eq org-link-file-path-type 'absolute)
9706 (equal complete-file '(16)))
9707 (setq path (abbreviate-file-name (expand-file-name path))))
9708 ((eq org-link-file-path-type 'noabbrev)
9709 (setq path (expand-file-name path)))
9710 ((eq org-link-file-path-type 'relative)
9711 (setq path (file-relative-name path)))
9712 (t
9713 (save-match-data
9714 (if (string-match (concat "^" (regexp-quote
9715 (expand-file-name
9716 (file-name-as-directory
9717 default-directory))))
9718 (expand-file-name path))
9719 ;; We are linking a file with relative path name.
9720 (setq path (substring (expand-file-name path)
9721 (match-end 0)))
9722 (setq path (abbreviate-file-name (expand-file-name path)))))))
9723 (setq link (concat type path))
9724 (if (equal desc origpath)
9725 (setq desc path))))
9727 (if org-make-link-description-function
9728 (setq desc
9729 (or (condition-case nil
9730 (funcall org-make-link-description-function link desc)
9731 (error (progn (message "Can't get link description from `%s'"
9732 (symbol-name org-make-link-description-function))
9733 (sit-for 2) nil)))
9734 (read-string "Description: " default-description)))
9735 (if default-description (setq desc default-description)
9736 (setq desc (or (and auto-desc desc)
9737 (read-string "Description: " desc)))))
9740 (if remove (apply 'delete-region remove))
9741 (insert (org-make-link-string link desc))))
9743 (defun org-link-try-special-completion (type)
9744 "If there is completion support for link type TYPE, offer it."
9745 (let ((fun (intern (concat "org-" type "-complete-link"))))
9746 (if (functionp fun)
9747 (funcall fun)
9748 (read-string "Link (no completion support): " (concat type ":")))))
9750 (defun org-file-complete-link (&optional arg)
9751 "Create a file link using completion."
9752 (let (file link)
9753 (setq file (org-iread-file-name "File: "))
9754 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9755 (pwd1 (file-name-as-directory (abbreviate-file-name
9756 (expand-file-name ".")))))
9757 (cond
9758 ((equal arg '(16))
9759 (setq link (concat
9760 "file:"
9761 (abbreviate-file-name (expand-file-name file)))))
9763 (setq link (concat "file:" (match-string 1 file))))
9765 (expand-file-name file))
9766 (setq link (concat
9767 "file:" (match-string 1 (expand-file-name file)))))
9768 (t (setq link (concat "file:" file)))))
9769 link))
9771 (defun org-iread-file-name (&rest args)
9772 "Read-file-name using `ido-mode' speedup if available.
9773 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
9774 See `read-file-name' for a description of parameters."
9775 (org-without-partial-completion
9776 (if (and org-completion-use-ido
9777 (fboundp 'ido-read-file-name)
9778 (boundp 'ido-mode) ido-mode
9779 (listp (second args)))
9780 (let ((ido-enter-matching-directory nil))
9781 (apply 'ido-read-file-name args))
9782 (apply 'read-file-name args))))
9784 (defun org-completing-read (&rest args)
9785 "Completing-read with SPACE being a normal character."
9786 (let ((enable-recursive-minibuffers t)
9787 (minibuffer-local-completion-map
9788 (copy-keymap minibuffer-local-completion-map)))
9789 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9790 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9791 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9792 (apply 'org-icompleting-read args)))
9794 (defun org-completing-read-no-i (&rest args)
9795 (let (org-completion-use-ido org-completion-use-iswitchb)
9796 (apply 'org-completing-read args)))
9798 (defun org-iswitchb-completing-read (prompt choices &rest args)
9799 "Use iswitch as a completing-read replacement to choose from choices.
9800 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9801 from."
9802 (let* ((iswitchb-use-virtual-buffers nil)
9803 (iswitchb-make-buflist-hook
9804 (lambda ()
9805 (setq iswitchb-temp-buflist choices))))
9806 (iswitchb-read-buffer prompt)))
9808 (defun org-icompleting-read (&rest args)
9809 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9810 (org-without-partial-completion
9811 (if (and org-completion-use-ido
9812 (fboundp 'ido-completing-read)
9813 (boundp 'ido-mode) ido-mode
9814 (listp (second args)))
9815 (let ((ido-enter-matching-directory nil))
9816 (apply 'ido-completing-read (concat (car args))
9817 (if (consp (car (nth 1 args)))
9818 (mapcar 'car (nth 1 args))
9819 (nth 1 args))
9820 (cddr args)))
9821 (if (and org-completion-use-iswitchb
9822 (boundp 'iswitchb-mode) iswitchb-mode
9823 (listp (second args)))
9824 (apply 'org-iswitchb-completing-read (concat (car args))
9825 (if (consp (car (nth 1 args)))
9826 (mapcar 'car (nth 1 args))
9827 (nth 1 args))
9828 (cddr args))
9829 (apply 'completing-read args)))))
9831 (defun org-extract-attributes (s)
9832 "Extract the attributes cookie from a string and set as text property."
9833 (let (a attr (start 0) key value)
9834 (save-match-data
9836 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9838 (setq key (match-string 1 a) value (match-string 2 a)
9839 start (match-end 0)
9840 attr (plist-put attr (intern key) value))))
9841 (org-add-props s nil 'org-attr attr))
9842 s))
9844 (defun org-extract-attributes-from-string (tag)
9845 (let (key value attr)
9847 (setq key (match-string 1 tag) value (match-string 2 tag)
9848 tag (replace-match "" t t tag)
9849 attr (plist-put attr (intern key) value)))
9850 (cons tag attr)))
9852 (defun org-attributes-to-string (plist)
9853 "Format a property list into an HTML attribute list."
9854 (let ((s "") key value)
9855 (while plist
9856 (setq key (pop plist) value (pop plist))
9857 (and value
9859 s))
9861 ;;; Opening/following a link
9863 (defvar org-link-search-failed nil)
9865 (defvar org-open-link-functions nil
9866 "Hook for functions finding a plain text link.
9867 These functions must take a single argument, the link content.
9868 They will be called for links that look like [[link text][description]]
9872 These functions will be called *before* Org attempts to resolve the
9873 link by doing text searches in the current buffer - so if you want a
9875 handle this as a special case.
9877 When the function does handle the link, it must return a non-nil value.
9878 If it decides that it is not responsible for this link, it must return
9879 nil to indicate that that Org-mode can continue with other options
9880 like exact and fuzzy text search.")
9882 (defun org-next-link (&optional search-backward)
9883 "Move forward to the next link.
9884 If the link is in hidden text, expose it."
9885 (interactive "P")
9886 (when (and org-link-search-failed (eq this-command last-command))
9887 (goto-char (point-min))
9888 (message "Link search wrapped back to beginning of buffer"))
9889 (setq org-link-search-failed nil)
9890 (let* ((pos (point))
9891 (ct (org-context))
9892 (a (assoc :link ct))
9893 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
9894 (cond (a (goto-char (nth (if search-backward 1 2) a)))
9895 ((looking-at org-any-link-re)
9896 ;; Don't stay stuck at link without an org-link face
9897 (forward-char (if search-backward -1 1))))
9898 (if (funcall srch-fun org-any-link-re nil t)
9899 (progn
9900 (goto-char (match-beginning 0))
9901 (if (outline-invisible-p) (org-show-context)))
9902 (goto-char pos)
9903 (setq org-link-search-failed t)
9904 (message "No further link found"))))
9906 (defun org-previous-link ()
9907 "Move backward to the previous link.
9908 If the link is in hidden text, expose it."
9909 (interactive)
9910 (funcall 'org-next-link t))
9912 (defun org-translate-link (s)
9913 "Translate a link string if a translation function has been defined."
9914 (if (and org-link-translation-function
9915 (fboundp org-link-translation-function)
9917 (progn
9918 (setq s (funcall org-link-translation-function
9919 (match-string 1 s) (match-string 2 s)))
9920 (concat (car s) ":" (cdr s)))
9921 s))
9923 (defun org-translate-link-from-planner (type path)
9924 "Translate a link from Emacs Planner syntax so that Org can follow it.
9925 This is still an experimental function, your mileage may vary."
9926 (cond
9927 ((member type '("http" "https" "news" "ftp"))
9928 ;; standard Internet links are the same.
9929 nil)
9930 ((and (equal type "irc") (string-match "^//" path))
9931 ;; Planner has two / at the beginning of an irc link, we have 1.
9932 ;; We should have zero, actually....
9933 (setq path (substring path 1)))
9934 ((and (equal type "lisp") (string-match "^/" path))
9935 ;; Planner has a slash, we do not.
9936 (setq type "elisp" path (substring path 1)))
9938 ;; A typical message link. Planner has the id after the final slash,
9939 ;; we separate it with a hash mark
9940 (setq path (concat (match-string 1 path) "#"
9941 (org-remove-angle-brackets (match-string 2 path)))))
9942 )
9943 (cons type path))
9945 (defun org-find-file-at-mouse (ev)
9946 "Open file link or URL at mouse."
9947 (interactive "e")
9948 (mouse-set-point ev)
9949 (org-open-at-point 'in-emacs))
9951 (defun org-open-at-mouse (ev)
9952 "Open file link or URL at mouse.
9953 See the docstring of `org-open-file' for details."
9954 (interactive "e")
9955 (mouse-set-point ev)
9956 (if (eq major-mode 'org-agenda-mode)
9957 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9958 (org-open-at-point))
9960 (defvar org-window-config-before-follow-link nil
9961 "The window configuration before following a link.
9962 This is saved in case the need arises to restore it.")
9964 (defvar org-open-link-marker (make-marker)
9965 "Marker pointing to the location where `org-open-at-point; was called.")
9967 ;;;###autoload
9968 (defun org-open-at-point-global ()
9969 "Follow a link like Org-mode does.
9970 This command can be called in any mode to follow a link that has
9971 Org-mode syntax."
9972 (interactive)
9973 (org-run-like-in-org-mode 'org-open-at-point))
9975 ;;;###autoload
9976 (defun org-open-link-from-string (s &optional arg reference-buffer)
9977 "Open a link in the string S, as if it was in Org-mode."
9979 (let ((reference-buffer (or reference-buffer (current-buffer))))
9980 (with-temp-buffer
9981 (let ((org-inhibit-startup (not reference-buffer)))
9982 (org-mode)
9983 (insert s)
9984 (goto-char (point-min))
9985 (when reference-buffer
9986 (setq org-link-abbrev-alist-local
9987 (with-current-buffer reference-buffer
9988 org-link-abbrev-alist-local)))
9989 (org-open-at-point arg reference-buffer)))))
9991 (defvar org-open-at-point-functions nil
9992 "Hook that is run when following a link at point.
9994 Functions in this hook must return t if they identify and follow
9995 a link at point. If they don't find anything interesting at point,
9996 they must return nil.")
9998 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
9999 (defun org-open-at-point (&optional arg reference-buffer)
10000 "Open link at or after point.
10001 If there is no link at point, this function will search forward up to
10002 the end of the current line.
10003 Normally, files will be opened by an appropriate application. If the
10004 optional prefix argument ARG is non-nil, Emacs will visit the file.
10005 With a double prefix argument, try to open outside of Emacs, in the
10006 application the system uses for this file type."
10007 (interactive "P")
10008 ;; if in a code block, then open the block's results
10009 (unless (call-interactively #'org-babel-open-src-block-result)
10010 (org-load-modules-maybe)
10011 (move-marker org-open-link-marker (point))
10012 (setq org-window-config-before-follow-link (current-window-configuration))
10013 (org-remove-occur-highlights nil nil t)
10014 (cond
10015 ((and (org-at-heading-p)
10016 (not (org-at-timestamp-p t))
10017 (not (org-in-regexp
10022 (not (get-text-property (point) 'org-linked-text)))
10023 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10024 (lk0 (car lkall))
10025 (lk (if (stringp lk0) (list lk0) lk0))
10026 (lkend (cdr lkall)))
10027 (mapcar (lambda(l)
10028 (search-forward l nil lkend)
10029 (goto-char (match-beginning 0))
10030 (org-open-at-point))
10031 lk))
10032 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10033 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10034 ((and (org-at-timestamp-p t)
10035 (not (org-in-regexp org-bracket-link-regexp)))
10036 (org-follow-timestamp-link))
10037 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10038 (not (org-in-regexp org-any-link-re)))
10039 (org-footnote-action))
10040 (t
10041 (let (type path link line search (pos (point)))
10042 (catch 'match
10043 (save-excursion
10045 (when (org-in-regexp org-bracket-link-regexp 1)
10046 (setq link (org-extract-attributes
10047 (org-link-unescape (org-match-string-no-properties 1))))
10049 (setq link (replace-match " " t t link)))
10050 (setq link (org-link-expand-abbrev link))
10051 (cond
10052 ((or (file-name-absolute-p link)
10054 (setq type "file" path link))
10055 ((string-match org-link-re-with-space3 link)
10056 (setq type (match-string 1 link) path (match-string 2 link)))
10058 (setq type "help" path (match-string 1 link)))
10059 (t (setq type "thisfile" path link)))
10060 (throw 'match t)))
10062 (when (get-text-property (point) 'org-linked-text)
10063 (setq type "thisfile"
10064 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10065 (1+ (point)) (point))
10066 path (buffer-substring
10067 (or (previous-single-property-change pos 'org-linked-text)
10068 (point-min))
10069 (or (next-single-property-change pos 'org-linked-text)
10070 (point-max))))
10071 (throw 'match t))
10073 (save-excursion
10074 (when (or (org-in-regexp org-angle-link-re)
10075 (let ((match (org-in-regexp org-plain-link-re)))
10076 ;; Check a plain link is not within a bracket link
10077 (and match
10078 (save-excursion
10079 (progn
10080 (goto-char (car match))
10081 (not (org-in-regexp org-bracket-link-regexp))))))
10082 (let ((line_ending (save-excursion (end-of-line) (point))))
10083 ;; We are in a line before a plain or bracket link
10084 (or (re-search-forward org-plain-link-re line_ending t)
10085 (re-search-forward org-bracket-link-regexp line_ending t))))
10086 (setq type (match-string 1)
10087 path (org-link-unescape (match-string 2)))
10088 (throw 'match t)))
10089 (save-excursion
10091 (setq type "tags"
10092 path (match-string 1))
10093 (while (string-match ":" path)
10094 (setq path (replace-match "+" t t path)))
10095 (throw 'match t)))
10097 (setq type "tree-match"
10098 path (match-string 1))
10099 (throw 'match t)))
10100 (unless path
10101 (user-error "No link found"))
10103 ;; switch back to reference buffer
10104 ;; needed when if called in a temporary buffer through
10105 ;; org-open-link-from-string
10106 (with-current-buffer (or reference-buffer (current-buffer))
10108 ;; Remove any trailing spaces in path
10110 (setq path (replace-match "" t t path)))
10111 (if (and org-link-translation-function
10112 (fboundp org-link-translation-function))
10113 ;; Check if we need to translate the link
10114 (let ((tmp (funcall org-link-translation-function type path)))
10115 (setq type (car tmp) path (cdr tmp))))
10117 (cond
10119 ((assoc type org-link-protocols)
10120 (funcall (nth 1 (assoc type org-link-protocols)) path))
10122 ((equal type "help")
10123 (let ((f-or-v (intern path)))
10124 (cond ((fboundp f-or-v)
10125 (describe-function f-or-v))
10126 ((boundp f-or-v)
10127 (describe-variable f-or-v))
10128 (t (error "Not a known function or variable")))))
10130 ((equal type "mailto")
10131 (let ((cmd (car org-link-mailto-program))
10132 (args (cdr org-link-mailto-program)) args1
10133 (address path) (subject "") a)
10135 (setq address (match-string 1 path)
10136 subject (org-link-escape (match-string 2 path))))
10137 (while args
10138 (cond
10139 ((not (stringp (car args))) (push (pop args) args1))
10140 (t (setq a (pop args))
10141 (if (string-match "%a" a)
10142 (setq a (replace-match address t t a)))
10143 (if (string-match "%s" a)
10144 (setq a (replace-match subject t t a)))
10145 (push a args1))))
10146 (apply cmd (nreverse args1))))
10148 ((member type '("http" "https" "ftp" "news"))
10149 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10150 (org-link-escape
10151 path org-link-escape-chars-browser)
10152 path))))
10154 ((string= type "doi")
10155 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10156 (org-link-escape
10157 path org-link-escape-chars-browser)
10158 path))))
10160 ((member type '("message"))
10161 (browse-url (concat type ":" path)))
10163 ((string= type "tags")
10164 (org-tags-view arg path))
10166 ((string= type "tree-match")
10169 ((string= type "file")
10171 (setq line (string-to-number (match-string 1 path))
10172 path (substring path 0 (match-beginning 0)))
10174 (setq search (match-string 1 path)
10175 path (substring path 0 (match-beginning 0)))))
10176 (if (string-match "[*?{]" (file-name-nondirectory path))
10177 (dired path)
10178 (org-open-file path arg line search)))
10180 ((string= type "shell")
10181 (let ((buf (generate-new-buffer "*Org Shell Output"))
10182 (cmd path))
10183 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10184 (string-match org-confirm-shell-link-not-regexp cmd))
10185 (not org-confirm-shell-link-function)
10186 (funcall org-confirm-shell-link-function
10188 (org-add-props cmd nil
10189 'face 'org-warning))))
10190 (progn
10191 (message "Executing %s" cmd)
10192 (shell-command cmd buf)
10193 (if (featurep 'midnight)
10194 (setq clean-buffer-list-kill-buffer-names
10195 (cons buf clean-buffer-list-kill-buffer-names))))
10196 (error "Abort"))))
10198 ((string= type "elisp")
10199 (let ((cmd path))
10200 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10201 (string-match org-confirm-elisp-link-not-regexp cmd))
10202 (not org-confirm-elisp-link-function)
10203 (funcall org-confirm-elisp-link-function
10205 (org-add-props cmd nil
10206 'face 'org-warning))))
10207 (message "%s => %s" cmd
10208 (if (equal (string-to-char cmd) ?\()
10209 (eval (read cmd))
10210 (call-interactively (read cmd))))
10211 (error "Abort"))))
10213 ((and (string= type "thisfile")
10214 (run-hook-with-args-until-success
10215 'org-open-link-functions path)))
10217 ((string= type "thisfile")
10218 (if arg
10219 (switch-to-buffer-other-window
10220 (org-get-buffer-for-internal-link (current-buffer)))
10221 (org-mark-ring-push))
10222 (let ((cmd `(org-link-search
10223 ,path
10224 ,(cond ((equal arg '(4)) ''occur)
10225 ((equal arg '(16)) ''org-occur))
10226 ,pos)))
10227 (condition-case nil (let ((org-link-search-inhibit-query t))
10228 (eval cmd))
10229 (error (progn (widen) (eval cmd))))))
10231 (t (browse-url-at-point)))))))
10232 (move-marker org-open-link-marker nil)
10233 (run-hook-with-args 'org-follow-link-hook)))
10235 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10236 "Offer links in the current entry and return the selected link.
10237 If there is only one link, return it.
10238 If NTH is an integer, return the NTH link found.
10239 If ZERO is a string, check also this string for a link, and if
10240 there is one, return it."
10241 (with-current-buffer buffer
10242 (save-excursion
10243 (save-restriction
10244 (widen)
10245 (goto-char marker)
10249 (cnt ?0)
10250 (in-emacs (if (integerp nth) nil nth))
10251 have-zero end links link c)
10252 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10253 (push (match-string 0 zero) links)
10254 (setq cnt (1- cnt) have-zero t))
10255 (save-excursion
10256 (org-back-to-heading t)
10257 (setq end (save-excursion (outline-next-heading) (point)))
10258 (while (re-search-forward re end t)
10259 (push (match-string 0) links))
10260 (setq links (org-uniquify (reverse links))))
10261 (cond
10262 ((null links)
10263 (message "No links"))
10264 ((equal (length links) 1)
10265 (setq link (car links)))
10266 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10267 (setq link (nth (if have-zero nth (1- nth)) links)))
10268 (t ; we have to select a link
10269 (save-excursion
10270 (save-window-excursion
10271 (delete-other-windows)
10272 (with-output-to-temp-buffer "*Select Link*"
10273 (mapc (lambda (l)
10274 (if (not (string-match org-bracket-link-regexp l))
10276 (org-remove-angle-brackets l)))
10277 (if (match-end 3)
10279 (match-string 3 l) (match-string 1 l)))
10281 (match-string 1 l))))))
10282 links))
10283 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10284 (message "Select link to open, RET to open all:")
10285 (setq c (read-char-exclusive))
10286 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10287 (when (equal c ?q) (error "Abort"))
10288 (if (equal c ?\C-m)
10289 (setq link links)
10290 (setq nth (- c ?0))
10291 (if have-zero (setq nth (1+ nth)))
10292 (unless (and (integerp nth) (>= (length links) nth))
10293 (error "Invalid link selection"))
10294 (setq link (nth (1- nth) links)))))
10295 (cons link end))))))
10297 ;; Add special file links that specify the way of opening
10299 (org-add-link-type "file+sys" 'org-open-file-with-system)
10300 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10301 (defun org-open-file-with-system (path)
10302 "Open file at PATH using the system way of opening it."
10303 (org-open-file path 'system))
10304 (defun org-open-file-with-emacs (path)
10305 "Open file at PATH in Emacs."
10306 (org-open-file path 'emacs))
10309 ;;; File search
10311 (defvar org-create-file-search-functions nil
10312 "List of functions to construct the right search string for a file link.
10313 These functions are called in turn with point at the location to
10314 which the link should point.
10316 A function in the hook should first test if it would like to
10317 handle this file type, for example by checking the `major-mode'
10318 or the file extension. If it decides not to handle this file, it
10319 should just return nil to give other functions a chance. If it
10320 does handle the file, it must return the search string to be used
10321 when following the link. The search string will be part of the
10322 file link, given after a double colon, and `org-open-at-point'
10323 will automatically search for it. If special measures must be
10324 taken to make the search successful, another function should be
10325 added to the companion hook `org-execute-file-search-functions',
10326 which see.
10328 A function in this hook may also use `setq' to set the variable
10329 `description' to provide a suggestion for the descriptive text to
10330 be used for this link when it gets inserted into an Org-mode
10333 (defvar org-execute-file-search-functions nil
10334 "List of functions to execute a file search triggered by a link.
10336 Functions added to this hook must accept a single argument, the
10337 search string that was part of the file link, the part after the
10338 double colon. The function must first check if it would like to
10339 handle this search, for example by checking the `major-mode' or
10340 the file extension. If it decides not to handle this search, it
10341 should just return nil to give other functions a chance. If it
10342 does handle the search, it must return a non-nil value to keep
10343 other functions from trying.
10345 Each function can access the current prefix argument through the
10346 variable `current-prefix-argument'. Note that a single prefix is
10347 used to force opening a link in Emacs, so it may be good to only
10348 use a numeric or double prefix to guide the search function.
10350 In case this is needed, a function in this hook can also restore
10351 the window configuration before `org-open-at-point' was called using:
10353 (set-window-configuration org-window-config-before-follow-link)")
10355 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10356 (defun org-link-search (s &optional type avoid-pos stealth)
10357 "Search for a link search option.
10358 If S is surrounded by forward slashes, it is interpreted as a
10359 regular expression. In org-mode files, this will create an `org-occur'
10360 sparse tree. In ordinary files, `occur' will be used to list matches.
10361 If the current buffer is in `dired-mode', grep will be used to search
10362 in all files. If AVOID-POS is given, ignore matches near that position.
10364 When optional argument STEALTH is non-nil, do not modify
10365 visibility around point, thus ignoring
10366 `org-show-hierarchy-above', `org-show-following-heading' and
10367 `org-show-siblings' variables."
10368 (let ((case-fold-search t)
10372 org-emphasis-alist)
10374 (pos (point))
10375 (pre nil) (post nil)
10376 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10377 (cond
10378 ;; First check if there are any special search functions
10379 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10380 ;; Now try the builtin stuff
10381 ((and (equal (string-to-char s0) ?#)
10382 (> (length s0) 1)
10383 (save-excursion
10384 (goto-char (point-min))
10385 (and
10386 (re-search-forward
10388 (setq type 'dedicated
10389 pos (match-beginning 0))))
10390 ;; There is an exact target for this
10391 (goto-char pos)
10392 (org-back-to-heading t)))
10393 ((save-excursion
10394 (goto-char (point-min))
10395 (and
10396 (re-search-forward
10397 (concat "<<" (regexp-quote s0) ">>") nil t)
10398 (setq type 'dedicated
10399 pos (match-beginning 0))))
10400 ;; There is an exact target for this
10401 (goto-char pos))
10402 ((save-excursion
10403 (goto-char (point-min))
10404 (and
10405 (re-search-forward
10407 (setq type 'dedicated pos (match-beginning 0))))
10408 ;; Found an invisible target.
10409 (goto-char pos))
10410 ((save-excursion
10411 (goto-char (point-min))
10412 (and
10413 (re-search-forward
10415 (setq type 'dedicated pos (match-beginning 0))))
10416 ;; Found an element with a matching #+name affiliated keyword.
10417 (goto-char pos))
10419 (save-excursion
10420 (goto-char (point-min))
10421 (and
10422 (re-search-forward
10423 (concat "[^[]" (regexp-quote
10424 (format org-coderef-label-format
10425 (match-string 1 s0))))
10426 nil t)
10427 (setq type 'dedicated
10428 pos (1+ (match-beginning 0))))))
10429 ;; There is a coderef target for this
10430 (goto-char pos))
10432 ;; A regular expression
10433 (cond
10434 ((derived-mode-p 'org-mode)
10435 (org-occur (match-string 1 s)))
10436 (t (org-do-occur (match-string 1 s)))))
10437 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10438 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10439 (goto-char (point-min))
10440 (cond
10441 ((let (case-fold-search)
10442 (re-search-forward (format org-complex-heading-regexp-format
10443 (regexp-quote s))
10444 nil t))
10445 ;; OK, found a match
10446 (setq type 'dedicated)
10447 (goto-char (match-beginning 0)))
10448 ((and (not org-link-search-inhibit-query)
10449 (eq org-link-search-must-match-exact-headline 'query-to-create)
10450 (y-or-n-p "No match - create this as a new heading? "))
10451 (goto-char (point-max))
10452 (or (bolp) (newline))
10454 (beginning-of-line 0))
10455 (t
10456 (goto-char pos)
10457 (error "No match"))))
10458 (t
10459 ;; A normal search string
10460 (when (equal (string-to-char s) ?*)
10461 ;; Anchor on headlines, post may include tags.
10464 s (substring s 1)))
10465 (remove-text-properties
10466 0 (length s)
10467 '(face nil mouse-face nil keymap nil fontified nil) s)
10468 ;; Make a series of regular expressions to find a match
10477 re4 (concat "[^a-zA-Z_]" re4_)
10479 re1 (concat pre re2 post)
10480 re3 (concat pre (if pre re4_ re4) post)
10481 re5 (concat pre ".*" re4)
10482 re2 (concat pre re2)
10483 re2a (concat pre (if pre re2a_ re2a))
10484 re4 (concat pre (if pre re4_ re4))
10488 ))
10489 (cond
10490 ((eq type 'org-occur) (org-occur reall))
10491 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10492 (t (goto-char (point-min))
10493 (setq type 'fuzzy)
10494 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10495 (org-search-not-self 1 re1 nil t)
10496 (org-search-not-self 1 re2 nil t)
10497 (org-search-not-self 1 re2a nil t)
10498 (org-search-not-self 1 re3 nil t)
10499 (org-search-not-self 1 re4 nil t)
10500 (org-search-not-self 1 re5 nil t)
10501 )
10502 (goto-char (match-beginning 1))
10503 (goto-char pos)
10504 (error "No match"))))))
10505 (and (derived-mode-p 'org-mode)
10506 (not stealth)
10507 (org-show-context 'link-search))
10508 type))
10510 (defun org-search-not-self (group &rest args)
10511 "Execute `re-search-forward', but only accept matches that do not
10512 enclose the position of `org-open-link-marker'."
10513 (let ((m org-open-link-marker))
10514 (catch 'exit
10515 (while (apply 're-search-forward args)
10516 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10517 (goto-char (match-end group))
10518 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10519 (> (match-beginning 0) (marker-position m))
10520 (< (match-end 0) (marker-position m)))
10521 (save-match-data
10522 (or (not (org-in-regexp
10523 org-bracket-link-analytic-regexp 1))
10524 (not (match-end 4)) ; no description
10525 (and (<= (match-beginning 4) (point))
10526 (>= (match-end 4) (point))))))
10527 (throw 'exit (point))))))))
10529 (defun org-get-buffer-for-internal-link (buffer)
10530 "Return a buffer to be used for displaying the link target of internal links."
10531 (cond
10532 ((not org-display-internal-link-with-indirect-buffer)
10533 buffer)
10534 ((string-match "(Clone)$" (buffer-name buffer))
10535 (message "Buffer is already a clone, not making another one")
10536 ;; we also do not modify visibility in this case
10537 buffer)
10538 (t ; make a new indirect buffer for displaying the link
10539 (let* ((bn (buffer-name buffer))
10540 (ibn (concat bn "(Clone)"))
10541 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10542 (with-current-buffer ib (org-overview))
10543 ib))))
10545 (defun org-do-occur (regexp &optional cleanup)
10546 "Call the Emacs command `occur'.
10547 If CLEANUP is non-nil, remove the printout of the regular expression
10548 in the *Occur* buffer. This is useful if the regex is long and not useful
10549 to read."
10550 (occur regexp)
10551 (when cleanup
10552 (let ((cwin (selected-window)) win beg end)
10553 (when (setq win (get-buffer-window "*Occur*"))
10554 (select-window win))
10555 (goto-char (point-min))
10556 (when (re-search-forward "match[a-z]+" nil t)
10557 (setq beg (match-end 0))
10559 (setq end (1- (match-beginning 0)))))
10560 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10561 (goto-char (point-min))
10562 (select-window cwin))))
10564 ;;; The mark ring for links jumps
10566 (defvar org-mark-ring nil
10567 "Mark ring for positions before jumps in Org-mode.")
10568 (defvar org-mark-ring-last-goto nil
10569 "Last position in the mark ring used to go back.")
10570 ;; Fill and close the ring
10571 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10572 (loop for i from 1 to org-mark-ring-length do
10573 (push (make-marker) org-mark-ring))
10574 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10575 org-mark-ring)
10577 (defun org-mark-ring-push (&optional pos buffer)
10578 "Put the current position or POS into the mark ring and rotate it."
10579 (interactive)
10580 (setq pos (or pos (point)))
10581 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10582 (move-marker (car org-mark-ring)
10583 (or pos (point))
10584 (or buffer (current-buffer)))
10585 (message "%s"
10586 (substitute-command-keys
10589 (defun org-mark-ring-goto (&optional n)
10590 "Jump to the previous position in the mark ring.
10591 With prefix arg N, jump back that many stored positions. When
10592 called several times in succession, walk through the entire ring.
10593 Org-mode commands jumping to a different position in the current file,
10594 or to another Org-mode file, automatically push the old position
10595 onto the ring."
10596 (interactive "p")
10597 (let (p m)
10598 (if (eq last-command this-command)
10599 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10600 (setq p org-mark-ring))
10601 (setq org-mark-ring-last-goto p)
10602 (setq m (car p))
10603 (org-pop-to-buffer-same-window (marker-buffer m))
10604 (goto-char m)
10605 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10607 (defun org-remove-angle-brackets (s)
10608 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10609 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10610 s)
10611 (defun org-add-angle-brackets (s)
10612 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10613 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10614 s)
10615 (defun org-remove-double-quotes (s)
10618 s)
10620 ;;; Following specific links
10622 (defun org-follow-timestamp-link ()
10623 "Open an agenda view for the time-stamp date/range at point."
10624 (cond
10625 ((org-at-date-range-p t)
10626 (let ((org-agenda-start-on-weekday)
10627 (t1 (match-string 1))
10628 (t2 (match-string 2)) tt1 tt2)
10629 (setq tt1 (time-to-days (org-time-string-to-time t1))
10630 tt2 (time-to-days (org-time-string-to-time t2)))
10631 (let ((org-agenda-buffer-tmp-name
10632 (format "*Org Agenda(a:%s)"
10633 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10634 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10635 ((org-at-timestamp-p t)
10636 (let ((org-agenda-buffer-tmp-name
10637 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10638 (org-agenda-list nil (time-to-days (org-time-string-to-time
10639 (substring (match-string 1) 0 10)))
10640 1)))
10641 (t (error "This should not happen"))))
10644 ;;; Following file links
10645 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10646 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10647 (declare-function mailcap-mime-info
10648 "mailcap" (string &optional request no-decode))
10649 (defvar org-wait nil)
10650 (defun org-open-file (path &optional in-emacs line search)
10651 "Open the file at PATH.
10652 First, this expands any special file name abbreviations. Then the
10653 configuration variable `org-file-apps' is checked if it contains an
10654 entry for this file type, and if yes, the corresponding command is launched.
10656 If no application is found, Emacs simply visits the file.
10658 With optional prefix argument IN-EMACS, Emacs will visit the file.
10660 prefix arg, Org tries to avoid opening in Emacs
10661 and to use an external application to visit the file.
10663 Optional LINE specifies a line to go to, optional SEARCH a string
10664 to search for. If LINE or SEARCH is given, the file will be
10665 opened in Emacs, unless an entry from org-file-apps that makes
10666 use of groups in a regexp matches.
10668 If you want to change the way frames are used when following a
10669 link, please customize `org-link-frame-setup'.
10671 If the file does not exist, an error is thrown."
10672 (let* ((file (if (equal path "")
10673 buffer-file-name
10674 (substitute-in-file-name (expand-file-name path))))
10675 (file-apps (append org-file-apps (org-default-apps)))
10676 (apps (org-remove-if
10677 'org-file-apps-entry-match-against-dlink-p file-apps))
10678 (apps-dlink (org-remove-if-not
10679 'org-file-apps-entry-match-against-dlink-p file-apps))
10680 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10681 (dirp (if remp nil (file-directory-p file)))
10682 (file (if (and dirp org-open-directory-means-index-dot-org)
10683 (concat (file-name-as-directory file) "index.org")
10684 file))
10685 (a-m-a-p (assq 'auto-mode apps))
10686 (dfile (downcase file))
10687 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10688 (link (cond ((and (eq line nil)
10689 (eq search nil))
10690 file)
10691 (line
10692 (concat file "::" (number-to-string line)))
10693 (search
10694 (concat file "::" search))))
10695 (dlink (downcase link))
10696 (old-buffer (current-buffer))
10697 (old-pos (point))
10698 (old-mode major-mode)
10699 ext cmd link-match-data)
10701 (setq ext (match-string 1 dfile))
10703 (setq ext (match-string 1 dfile))))
10704 (cond
10705 ((member in-emacs '((16) system))
10706 (setq cmd (cdr (assoc 'system apps))))
10707 (in-emacs (setq cmd 'emacs))
10708 (t
10709 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10710 (and dirp (cdr (assoc 'directory apps)))
10711 ; first, try matching against apps-dlink
10712 ; if we get a match here, store the match data for later
10713 (let ((match (assoc-default dlink apps-dlink
10714 'string-match)))
10715 (if match
10716 (progn (setq link-match-data (match-data))
10717 match)
10718 (progn (setq in-emacs (or in-emacs line search))
10719 nil))) ; if we have no match in apps-dlink,
10720 ; always open the file in emacs if line or search
10721 ; is given (for backwards compatibility)
10722 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10723 'string-match)
10724 (cdr (assoc ext apps))
10725 (cdr (assoc t apps))))))
10726 (when (eq cmd 'system)
10727 (setq cmd (cdr (assoc 'system apps))))
10728 (when (eq cmd 'default)
10729 (setq cmd (cdr (assoc t apps))))
10730 (when (eq cmd 'mailcap)
10731 (require 'mailcap)
10732 (mailcap-parse-mailcaps)
10733 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10734 (command (mailcap-mime-info mime-type)))
10735 (if (stringp command)
10736 (setq cmd command)
10737 (setq cmd 'emacs))))
10738 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10739 (not (file-exists-p file))
10740 (not org-open-non-existing-files))
10741 (error "No such file: %s" file))
10742 (cond
10744 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10746 (setq cmd (replace-match "%s" t t cmd)))
10747 (while (string-match "%s" cmd)
10748 (setq cmd (replace-match
10749 (save-match-data
10750 (shell-quote-argument
10751 (convert-standard-filename file)))
10752 t t cmd)))
10754 ;; Replace "%1", "%2" etc. in command with group matches from regex
10755 (save-match-data
10756 (let ((match-index 1)
10757 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10758 (set-match-data link-match-data)
10759 (while (<= match-index number-of-groups)
10760 (let ((regex (concat "%" (number-to-string match-index)))
10761 (replace-with (match-string match-index dlink)))
10762 (while (string-match regex cmd)
10763 (setq cmd (replace-match replace-with t t cmd))))
10764 (setq match-index (+ match-index 1)))))
10766 (save-window-excursion
10767 (message "Running %s...done" cmd)
10768 (start-process-shell-command cmd nil cmd)
10769 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
10770 ((or (stringp cmd)
10771 (eq cmd 'emacs))
10772 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10773 (widen)
10774 (if line (org-goto-line line)
10775 (if search (org-link-search search))))
10776 ((consp cmd)
10777 (let ((file (convert-standard-filename file)))
10778 (save-match-data
10779 (set-match-data link-match-data)
10780 (eval cmd))))
10781 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10782 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10783 (or (not (equal old-buffer (current-buffer)))
10784 (not (equal old-pos (point))))
10785 (org-mark-ring-push old-pos old-buffer))))
10787 (defun org-file-apps-entry-match-against-dlink-p (entry)
10788 "This function returns non-nil if `entry' uses a regular
10789 expression which should be matched against the whole link by
10790 org-open-file.
10792 It assumes that is the case when the entry uses a regular
10793 expression which has at least one grouping construct and the
10794 action is either a lisp form or a command string containing
10795 '%1', i.e. using at least one subexpression match as a
10796 parameter."
10797 (let ((selector (car entry))
10798 (action (cdr entry)))
10799 (if (stringp selector)
10800 (and (> (regexp-opt-depth selector) 0)
10801 (or (and (stringp action)
10802 (string-match "%[0-9]" action))
10803 (consp action)))
10804 nil)))
10806 (defun org-default-apps ()
10807 "Return the default applications for this operating system."
10808 (cond
10809 ((eq system-type 'darwin)
10810 org-file-apps-defaults-macosx)
10811 ((eq system-type 'windows-nt)
10812 org-file-apps-defaults-windowsnt)
10813 (t org-file-apps-defaults-gnu)))
10815 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10816 "Convert extensions to regular expressions in the cars of LIST.
10817 Also, weed out any non-string entries, because the return value is used
10818 only for regexp matching.
10819 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10820 point to the symbol `emacs', indicating that the file should
10821 be opened in Emacs."
10822 (append
10823 (delq nil
10824 (mapcar (lambda (x)
10825 (if (not (stringp (car x)))
10826 nil
10828 x
10830 list))
10831 (if add-auto-mode
10832 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10834 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10835 (defun org-file-remote-p (file)
10836 "Test whether FILE specifies a location on a remote system.
10837 Return non-nil if the location is indeed remote.
10841 (cond ((fboundp 'file-remote-p)
10842 (file-remote-p file))
10843 ((fboundp 'tramp-handle-file-remote-p)
10844 (tramp-handle-file-remote-p file))
10845 ((and (boundp 'ange-ftp-name-format)
10846 (string-match (car ange-ftp-name-format) file))
10847 t)))
10850 ;;;; Refiling
10852 (defun org-get-org-file ()
10853 "Read a filename, with default directory `org-directory'."
10854 (let ((default (or org-default-notes-file remember-data-file)))
10855 (read-file-name (format "File name [%s]: " default)
10856 (file-name-as-directory org-directory)
10857 default)))
10859 (defun org-notes-order-reversed-p ()
10860 "Check if the current file should receive notes in reversed order."
10861 (cond
10862 ((not org-reverse-note-order) nil)
10863 ((eq t org-reverse-note-order) t)
10864 ((not (listp org-reverse-note-order)) nil)
10865 (t (catch 'exit
10866 (let ((all org-reverse-note-order)
10867 entry)
10868 (while (setq entry (pop all))
10869 (if (string-match (car entry) buffer-file-name)
10870 (throw 'exit (cdr entry))))
10871 nil)))))
10873 (defvar org-refile-target-table nil
10874 "The list of refile targets, created by `org-refile'.")
10876 (defvar org-agenda-new-buffers nil
10877 "Buffers created to visit agenda files.")
10879 (defvar org-refile-cache nil
10880 "Cache for refile targets.")
10882 (defvar org-refile-markers nil
10883 "All the markers used for caching refile locations.")
10885 (defun org-refile-marker (pos)
10886 "Get a new refile marker, but only if caching is in use."
10887 (if (not org-refile-use-cache)
10888 pos
10889 (let ((m (make-marker)))
10890 (move-marker m pos)
10891 (push m org-refile-markers)
10892 m)))
10894 (defun org-refile-cache-clear ()
10895 "Clear the refile cache and disable all the markers."
10896 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10897 (setq org-refile-markers nil)
10898 (setq org-refile-cache nil)
10899 (message "Refile cache has been cleared"))
10901 (defun org-refile-cache-check-set (set)
10902 "Check if all the markers in the cache still have live buffers."
10903 (let (marker)
10904 (catch 'exit
10905 (while (and set (setq marker (nth 3 (pop set))))
10906 ;; if org-refile-use-outline-path is 'file, marker may be nil
10907 (when (and marker (null (marker-buffer marker)))
10908 (message "not found") (sit-for 3)
10909 (throw 'exit nil)))
10910 t)))
10912 (defun org-refile-cache-put (set &rest identifiers)
10913 "Push the refile targets SET into the cache, under IDENTIFIERS."
10914 (let* ((key (sha1 (prin1-to-string identifiers)))
10915 (entry (assoc key org-refile-cache)))
10916 (if entry
10917 (setcdr entry set)
10918 (push (cons key set) org-refile-cache))))
10920 (defun org-refile-cache-get (&rest identifiers)
10921 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10922 (cond
10923 ((not org-refile-cache) nil)
10924 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10925 (t
10926 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10927 org-refile-cache))))
10928 (and set (org-refile-cache-check-set set) set)))))
10930 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10931 "Produce a table with refile targets."
10932 (let ((case-fold-search nil)
10933 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10934 (entries (or org-refile-targets '((nil . (:level . 1)))))
10935 targets tgs txt re files f desc descre fast-path-p level pos0)
10936 (message "Getting targets...")
10937 (with-current-buffer (or default-buffer (current-buffer))
10938 (while (setq entry (pop entries))
10939 (setq files (car entry) desc (cdr entry))
10940 (setq fast-path-p nil)
10941 (cond
10942 ((null files) (setq files (list (current-buffer))))
10943 ((eq files 'org-agenda-files)
10944 (setq files (org-agenda-files 'unrestricted)))
10945 ((and (symbolp files) (fboundp files))
10946 (setq files (funcall files)))
10947 ((and (symbolp files) (boundp files))
10948 (setq files (symbol-value files))))
10949 (if (stringp files) (setq files (list files)))
10950 (cond
10951 ((eq (car desc) :tag)
10953 ((eq (car desc) :todo)
10955 ((eq (car desc) :regexp)
10956 (setq descre (cdr desc)))
10957 ((eq (car desc) :level)
10959 (if org-odd-levels-only
10960 (1- (* 2 (cdr desc)))
10961 (cdr desc)))
10963 ((eq (car desc) :maxlevel)
10964 (setq fast-path-p t)
10966 (if org-odd-levels-only
10967 (1- (* 2 (cdr desc)))
10968 (cdr desc)))
10970 (t (error "Bad refiling target description %s" desc)))
10971 (while (setq f (pop files))
10972 (with-current-buffer
10973 (if (bufferp f) f (org-get-agenda-file-buffer f))
10974 (or
10975 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10976 (progn
10977 (if (bufferp f) (setq f (buffer-file-name
10978 (buffer-base-buffer f))))
10979 (setq f (and f (expand-file-name f)))
10980 (if (eq org-refile-use-outline-path 'file)
10981 (push (list (file-name-nondirectory f) f nil nil) tgs))
10982 (save-excursion
10983 (save-restriction
10984 (widen)
10985 (goto-char (point-min))
10986 (while (re-search-forward descre nil t)
10987 (goto-char (setq pos0 (point-at-bol)))
10988 (catch 'next
10989 (when org-refile-target-verify-function
10990 (save-match-data
10991 (or (funcall org-refile-target-verify-function)
10992 (throw 'next t))))
10993 (when (and (looking-at org-complex-heading-regexp)
10994 (not (member (match-string 4) excluded-entries))
10995 (match-string 4))
10996 (setq level (org-reduced-level
10997 (- (match-end 1) (match-beginning 1)))
10998 txt (org-link-display-format (match-string 4))
11000 re (format org-complex-heading-regexp-format
11001 (regexp-quote (match-string 4))))
11002 (when org-refile-use-outline-path
11003 (setq txt (mapconcat
11004 'org-protect-slash
11005 (append
11006 (if (eq org-refile-use-outline-path
11007 'file)
11008 (list (file-name-nondirectory
11009 (buffer-file-name
11010 (buffer-base-buffer))))
11011 (if (eq org-refile-use-outline-path
11012 'full-file-path)
11013 (list (buffer-file-name
11014 (buffer-base-buffer)))))
11015 (org-get-outline-path fast-path-p
11016 level txt)
11017 (list txt))
11018 "/")))
11019 (push (list txt f re (org-refile-marker (point)))
11020 tgs)))
11021 (when (= (point) pos0)
11022 ;; verification function has not moved point
11023 (goto-char (point-at-eol))))))))
11024 (when org-refile-use-cache
11025 (org-refile-cache-put tgs (buffer-file-name) descre))
11026 (setq targets (append tgs targets))
11027 ))))
11028 (message "Getting targets...done")
11029 (nreverse targets)))
11031 (defun org-protect-slash (s)
11032 (while (string-match "/" s)
11034 s)
11036 (defvar org-olpa (make-vector 20 nil))
11038 (defun org-get-outline-path (&optional fastp level heading)
11039 "Return the outline path to the current entry, as a list.
11041 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11042 routine which makes outline path derivations for an entire file,
11043 avoiding backtracing. Refile target collection makes use of that."
11044 (if fastp
11045 (progn
11046 (if (> level 19)
11047 (error "Outline path failure, more than 19 levels"))
11048 (loop for i from level upto 19 do
11049 (aset org-olpa i nil))
11050 (prog1
11051 (delq nil (append org-olpa nil))
11052 (aset org-olpa level heading)))
11053 (let (rtn case-fold-search)
11054 (save-excursion
11055 (save-restriction
11056 (widen)
11057 (while (org-up-heading-safe)
11058 (when (looking-at org-complex-heading-regexp)
11059 (push (org-match-string-no-properties 4) rtn)))
11060 rtn)))))
11062 (defun org-format-outline-path (path &optional width prefix separator)
11063 "Format the outline path PATH for display.
11064 WIDTH is the maximum number of characters that is available.
11065 PREFIX is a prefix to be included in the returned string,
11066 such as the file name.
11067 SEPARATOR is inserted between the different parts of the path,
11069 (setq width (or width 79))
11070 (if prefix (setq width (- width (length prefix))))
11071 (if (not path)
11072 (or prefix "")
11073 (let* ((nsteps (length path))
11074 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11075 (maxwidth (if (<= total-width width)
11076 10000 ;; everything fits
11077 ;; we need to shorten the level headings
11078 (/ (- width nsteps) nsteps)))
11079 (org-odd-levels-only nil)
11080 (n 0)
11081 (total (1+ (length prefix))))
11082 (setq maxwidth (max maxwidth 10))
11083 (concat prefix
11084 (if prefix (or separator "/"))
11085 (mapconcat
11086 (lambda (h)
11087 (setq n (1+ n))
11088 (if (and (= n nsteps) (< maxwidth 10000))
11089 (setq maxwidth (- total-width total)))
11090 (if (< (length h) maxwidth)
11091 (progn (setq total (+ total (length h) 1)) h)
11092 (setq h (substring h 0 (- maxwidth 2))
11093 total (+ total maxwidth 1))
11095 (setq h (substring h 0 (match-beginning 0))))
11096 (setq h (concat h "..")))
11097 (org-add-props h nil 'face
11098 (nth (% (1- n) org-n-level-faces)
11099 org-level-faces))
11100 h)
11101 path (or separator "/"))))))
11103 (defun org-display-outline-path (&optional file current separator just-return-string)
11104 "Display the current outline path in the echo area.
11106 If FILE is non-nil, prepend the output with the file name.
11107 If CURRENT is non-nil, append the current heading to the output.
11108 SEPARATOR is passed through to `org-format-outline-path'. It separates
11110 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11111 (interactive "P")
11112 (let* (case-fold-search
11113 message-log-max ; Don't populate the *Messages* buffer
11114 (bfn (buffer-file-name (buffer-base-buffer)))
11115 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11116 res)
11117 (if current (setq path (append path
11118 (save-excursion
11119 (org-back-to-heading t)
11120 (if (looking-at org-complex-heading-regexp)
11121 (list (match-string 4)))))))
11122 (setq res
11123 (org-format-outline-path
11124 path
11125 (1- (frame-width))
11126 (and file bfn (concat (file-name-nondirectory bfn) separator))
11127 separator))
11128 (if just-return-string
11129 (org-no-properties res)
11130 (message "%s" res))))
11132 (defvar org-refile-history nil
11133 "History for refiling operations.")
11135 (defvar org-after-refile-insert-hook nil
11136 "Hook run after `org-refile' has inserted its stuff at the new location.
11137 Note that this is still *before* the stuff will be removed from
11138 the *old* location.")
11140 (defvar org-capture-last-stored-marker)
11141 (defvar org-refile-keep nil
11142 "Non-nil means `org-refile' will copy instead of refile.")
11144 (defun org-copy ()
11145 "Like `org-refile', but copy."
11146 (interactive)
11147 (let ((org-refile-keep t))
11148 (funcall 'org-refile nil nil nil "Copy")))
11150 (defun org-refile (&optional goto default-buffer rfloc msg)
11151 "Move the entry or entries at point to another heading.
11152 The list of target headings is compiled using the information in
11153 `org-refile-targets', which see.
11155 At the target location, the entry is filed as a subitem of the target
11156 heading. Depending on `org-reverse-note-order', the new subitem will
11157 either be the first or the last subitem.
11159 If there is an active region, all entries in that region will be moved.
11160 However, the region must fulfill the requirement that the first heading
11161 is the first one sets the top-level of the moved text - at most siblings
11162 below it are allowed.
11164 With prefix arg GOTO, the command will only visit the target location
11165 and not actually move anything.
11168 go to the location where the last refiling operation has put the subtree.
11169 With a prefix argument of `2', refile to the running clock.
11171 RFLOC can be a refile location obtained in a different way.
11176 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11178 If you are using target caching (see `org-refile-use-cache'),
11179 you have to clear the target cache in order to find new targets.
11180 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11181 prefix argument (`C-u C-u C-u C-c C-w')."
11183 (interactive "P")
11184 (if (member goto '(0 (64)))
11185 (org-refile-cache-clear)
11186 (let* ((actionmsg (or msg "Refile"))
11187 (cbuf (current-buffer))
11188 (regionp (org-region-active-p))
11189 (region-start (and regionp (region-beginning)))
11190 (region-end (and regionp (region-end)))
11191 (region-length (and regionp (- region-end region-start)))
11192 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11193 pos it nbuf file re level reversed)
11194 (setq last-command nil)
11195 (when regionp
11196 (goto-char region-start)
11197 (or (bolp) (goto-char (point-at-bol)))
11198 (setq region-start (point))
11199 (unless (or (org-kill-is-subtree-p
11200 (buffer-substring region-start region-end))
11201 (prog1 org-refile-active-region-within-subtree
11202 (org-toggle-heading)))
11203 (error "The region is not a (sequence of) subtree(s)")))
11204 (if (equal goto '(16))
11205 (org-refile-goto-last-stored)
11206 (when (or
11207 (and (equal goto 2)
11208 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11209 (prog1
11210 (setq it (list (or org-clock-heading "running clock")
11211 (buffer-file-name
11212 (marker-buffer org-clock-hd-marker))
11213 ""
11214 (marker-position org-clock-hd-marker)))
11215 (setq goto nil)))
11216 (setq it (or rfloc
11217 (let (heading-text)
11218 (save-excursion
11219 (unless goto
11220 (org-back-to-heading t)
11221 (setq heading-text
11222 (nth 4 (org-heading-components))))
11224 (org-refile-get-location
11225 (cond (goto "Goto")
11226 (regionp (concat actionmsg " region to"))
11229 default-buffer
11230 (and (not (equal '(4) goto))
11231 org-refile-allow-creating-parent-nodes)
11232 goto))))))
11233 (setq file (nth 1 it)
11234 re (nth 2 it)
11235 pos (nth 3 it))
11236 (if (and (not goto)
11237 pos
11238 (equal (buffer-file-name) file)
11239 (if regionp
11240 (and (>= pos region-start)
11241 (<= pos region-end))
11242 (and (>= pos (point))
11243 (< pos (save-excursion
11244 (org-end-of-subtree t t))))))
11245 (error "Cannot refile to position inside the tree or region"))
11247 (setq nbuf (or (find-buffer-visiting file)
11248 (find-file-noselect file)))
11249 (if goto
11250 (progn
11251 (org-pop-to-buffer-same-window nbuf)
11252 (goto-char pos)
11253 (org-show-context 'org-goto))
11254 (if regionp
11255 (progn
11256 (org-kill-new (buffer-substring region-start region-end))
11257 (org-save-markers-in-region region-start region-end))
11258 (org-copy-subtree 1 nil t))
11259 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11260 (find-file-noselect file)))
11261 (setq reversed (org-notes-order-reversed-p))
11262 (save-excursion
11263 (save-restriction
11264 (widen)
11265 (if pos
11266 (progn
11267 (goto-char pos)
11268 (looking-at org-outline-regexp)
11269 (setq level (org-get-valid-level (funcall outline-level) 1))
11270 (goto-char
11271 (if reversed
11272 (or (outline-next-heading) (point-max))
11273 (or (save-excursion (org-get-next-sibling))
11274 (org-end-of-subtree t t)
11275 (point-max)))))
11276 (setq level 1)
11277 (if (not reversed)
11278 (goto-char (point-max))
11279 (goto-char (point-min))
11280 (or (outline-next-heading) (goto-char (point-max)))))
11281 (if (not (bolp)) (newline))
11282 (org-paste-subtree level)
11283 (when org-log-refile
11284 (org-add-log-setup 'refile nil nil 'findpos
11285 org-log-refile)
11286 (unless (eq org-log-refile 'note)
11287 (save-excursion (org-add-log-note))))
11288 (and org-auto-align-tags
11289 (let ((org-loop-over-headlines-in-active-region nil))
11290 (org-set-tags nil t)))
11291 (with-demoted-errors
11292 (bookmark-set "org-refile-last-stored"))
11293 ;; If we are refiling for capture, make sure that the
11294 ;; last-capture pointers point here
11295 (when (org-bound-and-true-p org-refile-for-capture)
11296 (with-demoted-errors
11297 (bookmark-set "org-capture-last-stored-marker"))
11298 (move-marker org-capture-last-stored-marker (point)))
11299 (if (fboundp 'deactivate-mark) (deactivate-mark))
11300 (run-hooks 'org-after-refile-insert-hook))))
11301 (unless org-refile-keep
11302 (if regionp
11303 (delete-region (point) (+ (point) region-length))
11304 (org-cut-subtree)))
11305 (when (featurep 'org-inlinetask)
11306 (org-inlinetask-remove-END-maybe))
11307 (setq org-markers-to-move nil)
11310 (defun org-refile-goto-last-stored ()
11311 "Go to the location where the last refile was stored."
11312 (interactive)
11313 (bookmark-jump "org-refile-last-stored")
11314 (message "This is the location of the last refile"))
11316 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11317 no-exclude)
11318 "Prompt the user for a refile location, using PROMPT.
11319 PROMPT should not be suffixed with a colon and a space, because
11320 this function appends the default value from
11321 `org-refile-history' automatically, if that is not empty.
11322 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11323 this is used for the GOTO interface."
11324 (let ((org-refile-targets org-refile-targets)
11325 (org-refile-use-outline-path org-refile-use-outline-path)
11326 excluded-entries)
11327 (when (and (derived-mode-p 'org-mode)
11328 (not org-refile-use-cache)
11329 (not no-exclude))
11330 (org-map-tree
11331 (lambda()
11332 (setq excluded-entries
11333 (append excluded-entries (list (org-get-heading t t)))))))
11334 (setq org-refile-target-table
11335 (org-refile-get-targets default-buffer excluded-entries)))
11336 (unless org-refile-target-table
11337 (error "No refile targets"))
11338 (let* ((cbuf (current-buffer))
11339 (partial-completion-mode nil)
11340 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11341 (cfunc (if (and org-refile-use-outline-path
11342 org-outline-path-complete-in-steps)
11343 'org-olpath-completing-read
11344 'org-icompleting-read))
11345 (extra (if org-refile-use-outline-path "/" ""))
11346 (cbnex (concat (buffer-name) extra))
11347 (filename (and cfn (expand-file-name cfn)))
11348 (tbl (mapcar
11349 (lambda (x)
11350 (if (and (not (member org-refile-use-outline-path
11351 '(file full-file-path)))
11352 (not (equal filename (nth 1 x))))
11353 (cons (concat (car x) extra " ("
11354 (file-name-nondirectory (nth 1 x)) ")")
11355 (cdr x))
11356 (cons (concat (car x) extra) (cdr x))))
11357 org-refile-target-table))
11358 (completion-ignore-case t)
11359 cdef
11360 (prompt (concat prompt
11361 (or (and (car org-refile-history)
11362 (concat " (default " (car org-refile-history) ")"))
11363 (and (assoc cbnex tbl) (setq cdef cbnex)
11364 (concat " (default " cbnex ")"))) ": "))
11365 pa answ parent-target child parent old-hist)
11366 (setq old-hist org-refile-history)
11367 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11368 nil 'org-refile-history (or cdef (car org-refile-history))))
11369 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11370 (org-refile-check-position pa)
11371 (if pa
11372 (progn
11373 (when (or (not org-refile-history)
11374 (not (eq old-hist org-refile-history))
11375 (not (equal (car pa) (car org-refile-history))))
11376 (setq org-refile-history
11377 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11378 org-refile-history
11379 (cdr org-refile-history))))
11380 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11381 (pop org-refile-history)))
11382 pa)
11384 (progn
11385 (setq parent (match-string 1 answ)
11386 child (match-string 2 answ))
11387 (setq parent-target (or (assoc parent tbl)
11388 (assoc (concat parent "/") tbl)))
11389 (when (and parent-target
11390 (or (eq new-nodes t)
11391 (and (eq new-nodes 'confirm)
11393 child)))))
11394 (org-refile-new-child parent-target child)))
11395 (error "Invalid target location")))))
11397 (declare-function org-string-nw-p "org-macs" (s))
11398 (defun org-refile-check-position (refile-pointer)
11399 "Check if the refile pointer matches the headline to which it points."
11400 (let* ((file (nth 1 refile-pointer))
11401 (re (nth 2 refile-pointer))
11402 (pos (nth 3 refile-pointer))
11403 buffer)
11404 (if (and (not (markerp pos)) (not file))
11405 (error "Please save the buffer to a file before refiling")
11406 (when (org-string-nw-p re)
11407 (setq buffer (if (markerp pos)
11408 (marker-buffer pos)
11409 (or (find-buffer-visiting file)
11410 (find-file-noselect file))))
11411 (with-current-buffer buffer
11412 (save-excursion
11413 (save-restriction
11414 (widen)
11415 (goto-char pos)
11416 (beginning-of-line 1)
11417 (unless (org-looking-at-p re)
11418 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11420 (defun org-refile-new-child (parent-target child)
11421 "Use refile target PARENT-TARGET to add new CHILD below it."
11422 (unless parent-target
11423 (error "Cannot find parent for new node"))
11424 (let ((file (nth 1 parent-target))
11425 (pos (nth 3 parent-target))
11426 level)
11427 (with-current-buffer (or (find-buffer-visiting file)
11428 (find-file-noselect file))
11429 (save-excursion
11430 (save-restriction
11431 (widen)
11432 (if pos
11433 (goto-char pos)
11434 (goto-char (point-max))
11435 (if (not (bolp)) (newline)))
11436 (when (looking-at org-outline-regexp)
11437 (setq level (funcall outline-level))
11438 (org-end-of-subtree t t))
11439 (org-back-over-empty-lines)
11441 (if pos (org-get-valid-level level 1) 1) ?*)
11443 (beginning-of-line 0)
11444 (list (concat (car parent-target) "/" child) file "" (point)))))))
11446 (defun org-olpath-completing-read (prompt collection &rest args)
11447 "Read an outline path like a file name."
11448 (let ((thetable collection)
11449 (org-completion-use-ido nil) ; does not work with ido.
11450 (org-completion-use-iswitchb nil)) ; or iswitchb
11451 (apply
11452 'org-icompleting-read prompt
11453 (lambda (string predicate &optional flag)
11454 (let (rtn r f (l (length string)))
11455 (cond
11456 ((eq flag nil)
11457 ;; try completion
11458 (try-completion string thetable))
11459 ((eq flag t)
11460 ;; all-completions
11461 (setq rtn (all-completions string thetable predicate))
11462 (mapcar
11463 (lambda (x)
11464 (setq r (substring x l))
11465 (if (string-match " ([^)]*)$" x)
11466 (setq f (match-string 0 x))
11467 (setq f ""))
11468 (if (string-match "/" r)
11469 (concat string (substring r 0 (match-end 0)) f)
11470 x))
11471 rtn))
11472 ((eq flag 'lambda)
11473 ;; exact match?
11474 (assoc string thetable)))))
11475 args)))
11477 ;;;; Dynamic blocks
11479 (defun org-find-dblock (name)
11480 "Find the first dynamic block with name NAME in the buffer.
11481 If not found, stay at current position and return nil."
11482 (let ((case-fold-search t) pos)
11483 (save-excursion
11484 (goto-char (point-min))
11485 (setq pos (and (re-search-forward
11487 (match-beginning 0))))
11488 (if pos (goto-char pos))
11489 pos))
11491 (defconst org-dblock-start-re
11493 "Matches the start line of a dynamic block, with parameters.")
11496 "Matches the end of a dynamic block.")
11498 (defun org-create-dblock (plist)
11499 "Create a dynamic block section, with parameters taken from PLIST.
11500 PLIST must contain a :name entry which is used as name of the block."
11502 (end-of-line 1)
11503 (newline))
11504 (let ((col (current-column))
11505 (name (plist-get plist :name)))
11506 (insert "#+BEGIN: " name)
11507 (while plist
11508 (if (eq (car plist) :name)
11509 (setq plist (cddr plist))
11510 (insert " " (prin1-to-string (pop plist)))))
11512 (beginning-of-line -2)))
11514 (defun org-prepare-dblock ()
11515 "Prepare dynamic block for refresh.
11516 This empties the block, puts the cursor at the insert position and returns
11517 the property list including an extra property :name with the block name."
11518 (unless (looking-at org-dblock-start-re)
11519 (error "Not at a dynamic block"))
11520 (let* ((begdel (1+ (match-end 0)))
11521 (name (org-no-properties (match-string 1)))
11522 (params (append (list :name name)
11523 (read (concat "(" (match-string 3) ")")))))
11524 (save-excursion
11525 (beginning-of-line 1)
11527 (setq params (plist-put params :indentation-column (current-column))))
11528 (unless (re-search-forward org-dblock-end-re nil t)
11529 (error "Dynamic block not terminated"))
11530 (setq params
11531 (append params
11532 (list :content (buffer-substring
11533 begdel (match-beginning 0)))))
11534 (delete-region begdel (match-beginning 0))
11535 (goto-char begdel)
11536 (open-line 1)
11537 params))
11539 (defun org-map-dblocks (&optional command)
11540 "Apply COMMAND to all dynamic blocks in the current buffer.
11541 If COMMAND is not given, use `org-update-dblock'."
11542 (let ((cmd (or command 'org-update-dblock)))
11543 (save-excursion
11544 (goto-char (point-min))
11545 (while (re-search-forward org-dblock-start-re nil t)
11546 (goto-char (match-beginning 0))
11547 (save-excursion
11548 (condition-case nil
11549 (funcall cmd)
11550 (error (message "Error during update of dynamic block"))))
11551 (unless (re-search-forward org-dblock-end-re nil t)
11552 (error "Dynamic block not terminated"))))))
11554 (defun org-dblock-update (&optional arg)
11555 "User command for updating dynamic blocks.
11556 Update the dynamic block at point. With prefix ARG, update all dynamic
11557 blocks in the buffer."
11558 (interactive "P")
11559 (if arg
11560 (org-update-all-dblocks)
11561 (or (looking-at org-dblock-start-re)
11562 (org-beginning-of-dblock))
11563 (org-update-dblock)))
11565 (defun org-update-dblock ()
11566 "Update the dynamic block at point.
11567 This means to empty the block, parse for parameters and then call
11568 the correct writing function."
11569 (interactive)
11570 (save-window-excursion
11571 (let* ((pos (point))
11572 (line (org-current-line))
11573 (params (org-prepare-dblock))
11574 (name (plist-get params :name))
11575 (indent (plist-get params :indentation-column))
11576 (cmd (intern (concat "org-dblock-write:" name))))
11577 (message "Updating dynamic block `%s' at line %d..." name line)
11578 (funcall cmd params)
11579 (message "Updating dynamic block `%s' at line %d...done" name line)
11580 (goto-char pos)
11581 (when (and indent (> indent 0))
11582 (setq indent (make-string indent ?\ ))
11583 (save-excursion
11584 (org-beginning-of-dblock)
11585 (forward-line 1)
11586 (while (not (looking-at org-dblock-end-re))
11587 (insert indent)
11588 (beginning-of-line 2))
11589 (when (looking-at org-dblock-end-re)
11591 (replace-match ""))
11592 (insert indent)))))))
11594 (defun org-beginning-of-dblock ()
11595 "Find the beginning of the dynamic block at point.
11596 Error if there is no such block at point."
11597 (let ((pos (point))
11598 beg)
11599 (end-of-line 1)
11600 (if (and (re-search-backward org-dblock-start-re nil t)
11601 (setq beg (match-beginning 0))
11602 (re-search-forward org-dblock-end-re nil t)
11603 (> (match-end 0) pos))
11604 (goto-char beg)
11605 (goto-char pos)
11606 (error "Not in a dynamic block"))))
11608 (defun org-update-all-dblocks ()
11609 "Update all dynamic blocks in the buffer.
11610 This function can be used in a hook."
11611 (interactive)
11612 (when (derived-mode-p 'org-mode)
11613 (org-map-dblocks 'org-update-dblock)))
11616 ;;;; Completion
11618 (defun org-get-export-keywords ()
11619 "Return a list of all currently understood export keywords.
11620 Export keywords include options, block names, attributes and
11621 keywords relative to each registered export back-end."
11622 (delq nil
11623 (let (keywords)
11624 (mapc
11625 (lambda (back-end)
11626 (let ((props (cdr back-end)))
11627 ;; Back-end name (for keywords, like #+LATEX:)
11628 (push (upcase (symbol-name (car back-end))) keywords)
11629 ;; Back-end options.
11630 (mapc (lambda (option) (push (cadr option) keywords))
11631 (plist-get (cdr back-end) :options-alist))))
11632 (org-bound-and-true-p org-export-registered-backends))
11633 keywords)))
11635 (defconst org-options-keywords
11636 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11637 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11638 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11639 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11640 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:" "INFOJS_OPT:"))
11642 (defcustom org-structure-template-alist
11657 ("L" "#+LaTeX: "
11661 ("H" "#+HTML: "
11664 ("A" "#+ASCII: ")
11665 ("i" "#+INDEX: ?"
11666 "#+INDEX: ?")
11667 ("I" "#+INCLUDE: %file ?"
11669 "Structure completion elements.
11670 This is a list of abbreviation keys and values. The value gets inserted
11671 if you type `<' followed by the key and then press the completion key,
11672 usually `M-TAB'. %file will be replaced by a file name after prompting
11673 for the file using completion. The cursor will be placed at the position
11674 of the `?` in the template.
11675 There are two templates for each key, the first uses the original Org syntax,
11676 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11677 the default when the /org-mtags.el/ module has been loaded. See also the
11678 variable `org-mtags-prefer-muse-templates'."
11679 :group 'org-completion
11680 :type '(repeat
11681 (string :tag "Key")
11682 (string :tag "Template")
11683 (string :tag "Muse Template")))
11685 (defun org-try-structure-completion ()
11686 "Try to complete a structure template before point.
11688 expands them."
11689 (let ((l (buffer-substring (point-at-bol) (point)))
11690 a)
11693 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11694 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11695 (match-beginning 1)) a)
11696 t)))
11698 (defun org-complete-expand-structure-template (start cell)
11699 "Expand a structure template."
11700 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11701 (rpl (nth (if musep 2 1) cell))
11702 (ind ""))
11703 (delete-region start (point))
11705 (cond
11706 ((bolp))
11708 (setq ind (buffer-substring (point-at-bol) (point))))
11709 (t (newline))))
11710 (setq start (point))
11711 (if (string-match "%file" rpl)
11712 (setq rpl (replace-match
11713 (concat
11715 (save-match-data
11716 (abbreviate-file-name (read-file-name "Include file: ")))
11718 t t rpl)))
11721 (insert rpl)
11724 ;;;; TODO, DEADLINE, Comments
11726 (defun org-toggle-comment ()
11727 "Change the COMMENT state of an entry."
11728 (interactive)
11729 (save-excursion
11730 (org-back-to-heading)
11731 (let (case-fold-search)
11732 (cond
11733 ((looking-at (format org-heading-keyword-regexp-format
11734 org-comment-string))
11735 (goto-char (match-end 1))
11736 (looking-at (concat " +" org-comment-string))
11737 (replace-match "" t t)
11738 (when (eolp) (insert " ")))
11739 ((looking-at org-outline-regexp)
11740 (goto-char (match-end 0))
11741 (insert org-comment-string " "))))))
11743 (defvar org-last-todo-state-is-todo nil
11744 "This is non-nil when the last TODO state change led to a TODO state.
11745 If the last change removed the TODO tag or switched to DONE, then
11746 this is nil.")
11748 (defvar org-setting-tags nil) ; dynamically skipped
11750 (defvar org-todo-setup-filter-hook nil
11751 "Hook for functions that pre-filter todo specs.
11752 Each function takes a todo spec and returns either nil or the spec
11753 transformed into canonical form." )
11755 (defvar org-todo-get-default-hook nil
11756 "Hook for functions that get a default item for todo.
11757 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11758 nil or a string to be used for the todo mark." )
11760 (defvar org-agenda-headline-snapshot-before-repeat)
11762 (defun org-current-effective-time ()
11763 "Return current time adjusted for `org-extend-today-until' variable."
11764 (let* ((ct (org-current-time))
11765 (dct (decode-time ct))
11766 (ct1
11767 (cond
11768 (org-use-last-clock-out-time-as-effective-time
11769 (or (org-clock-get-last-clock-out-time) ct))
11770 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
11771 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
11772 (t ct))))
11773 ct1))
11775 (defun org-todo-yesterday (&optional arg)
11776 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11777 (interactive "P")
11778 (if (eq major-mode 'org-agenda-mode)
11779 (apply 'org-agenda-todo-yesterday arg)
11780 (let* ((hour (third (decode-time
11781 (org-current-time))))
11782 (org-extend-today-until (1+ hour)))
11783 (org-todo arg))))
11785 (defvar org-block-entry-blocking ""
11786 "First entry preventing the TODO state change.")
11788 (defun org-todo (&optional arg)
11789 "Change the TODO state of an item.
11790 The state of an item is given by a keyword at the start of the heading,
11791 like
11792 *** TODO Write paper
11793 *** DONE Call mom
11795 The different keywords are specified in the variable `org-todo-keywords'.
11797 So for this example: when the item starts with TODO, it is changed to DONE.
11798 When it starts with DONE, the DONE is removed. And when neither TODO nor
11799 DONE are present, add TODO at the beginning of the heading.
11802 state.
11803 With numeric prefix arg, switch to that state.
11805 keywords (nextset).
11807 With a numeric prefix arg of 0, inhibit note taking for the change.
11809 For calling through lisp, arg is also interpreted in the following way:
11810 'none -> empty state
11812 'done -> switch to DONE
11813 'nextset -> switch to the next set of keywords
11814 'previousset -> switch to the previous set of keywords
11816 really is a member of `org-todo-keywords'."
11817 (interactive "P")
11818 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11819 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11820 'region-start-level 'region))
11821 org-loop-over-headlines-in-active-region)
11822 (org-map-entries
11823 `(org-todo ,arg)
11824 org-loop-over-headlines-in-active-region
11825 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11826 (if (equal arg '(16)) (setq arg 'nextset))
11827 (let ((org-blocker-hook org-blocker-hook)
11828 commentp
11829 case-fold-search)
11830 (when (equal arg '(64))
11831 (setq arg nil org-blocker-hook nil))
11832 (when (and org-blocker-hook
11833 (or org-inhibit-blocking
11834 (org-entry-get nil "NOBLOCKING")))
11835 (setq org-blocker-hook nil))
11836 (save-excursion
11837 (catch 'exit
11838 (org-back-to-heading t)
11840 (org-toggle-comment)
11841 (setq commentp t))
11842 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11845 (let* ((match-data (match-data))
11846 (startpos (point-at-bol))
11847 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11848 (org-log-done org-log-done)
11849 (org-log-repeat org-log-repeat)
11850 (org-todo-log-states org-todo-log-states)
11851 (org-inhibit-logging
11852 (if (equal arg 0)
11853 (progn (setq arg nil) 'note) org-inhibit-logging))
11854 (this (match-string 1))
11855 (hl-pos (match-beginning 0))
11856 (head (org-get-todo-sequence-head this))
11857 (ass (assoc head org-todo-kwd-alist))
11858 (interpret (nth 1 ass))
11859 (done-word (nth 3 ass))
11860 (final-done-word (nth 4 ass))
11861 (org-last-state (or this ""))
11862 (completion-ignore-case t)
11863 (member (member this org-todo-keywords-1))
11864 (tail (cdr member))
11865 (org-state (cond
11866 ((and org-todo-key-trigger
11867 (or (and (equal arg '(4))
11868 (eq org-use-fast-todo-selection 'prefix))
11869 (and (not arg) org-use-fast-todo-selection
11870 (not (eq org-use-fast-todo-selection
11871 'prefix)))))
11872 ;; Use fast selection
11873 (org-fast-todo-selection))
11874 ((and (equal arg '(4))
11875 (or (not org-use-fast-todo-selection)
11876 (not org-todo-key-trigger)))
11877 ;; Read a state with completion
11878 (org-icompleting-read
11879 "State: " (mapcar (lambda(x) (list x))
11880 org-todo-keywords-1)
11881 nil t))
11882 ((eq arg 'right)
11883 (if this
11884 (if tail (car tail) nil)
11885 (car org-todo-keywords-1)))
11886 ((eq arg 'left)
11887 (if (equal member org-todo-keywords-1)
11888 nil
11889 (if this
11890 (nth (- (length org-todo-keywords-1)
11891 (length tail) 2)
11892 org-todo-keywords-1)
11893 (org-last org-todo-keywords-1))))
11894 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11895 (setq arg nil))) ; hack to fall back to cycling
11896 (arg
11897 ;; user or caller requests a specific state
11898 (cond
11899 ((equal arg "") nil)
11900 ((eq arg 'none) nil)
11901 ((eq arg 'done) (or done-word (car org-done-keywords)))
11902 ((eq arg 'nextset)
11903 (or (car (cdr (member head org-todo-heads)))
11904 (car org-todo-heads)))
11905 ((eq arg 'previousset)
11906 (let ((org-todo-heads (reverse org-todo-heads)))
11907 (or (car (cdr (member head org-todo-heads)))
11908 (car org-todo-heads))))
11909 ((car (member arg org-todo-keywords-1)))
11910 ((stringp arg)
11911 (error "State `%s' not valid in this file" arg))
11912 ((nth (1- (prefix-numeric-value arg))
11913 org-todo-keywords-1))))
11914 ((null member) (or head (car org-todo-keywords-1)))
11915 ((equal this final-done-word) nil) ;; -> make empty
11916 ((null tail) nil) ;; -> first entry
11917 ((memq interpret '(type priority))
11918 (if (eq this-command last-command)
11919 (car tail)
11920 (if (> (length tail) 0)
11921 (or done-word (car org-done-keywords))
11922 nil)))
11923 (t
11924 (car tail))))
11925 (org-state (or
11926 (run-hook-with-args-until-success
11927 'org-todo-get-default-hook org-state org-last-state)
11928 org-state))
11929 (next (if org-state (concat " " org-state " ") " "))
11930 (change-plist (list :type 'todo-state-change :from this :to org-state
11931 :position startpos))
11932 dolog now-done-p)
11933 (when org-blocker-hook
11934 (setq org-last-todo-state-is-todo
11935 (not (member this org-done-keywords)))
11936 (unless (save-excursion
11937 (save-match-data
11938 (org-with-wide-buffer
11939 (run-hook-with-args-until-failure
11940 'org-blocker-hook change-plist))))
11941 (if (org-called-interactively-p 'interactive)
11943 this org-state org-block-entry-blocking)
11944 ;; fail silently
11946 this org-state org-block-entry-blocking)
11947 (throw 'exit nil))))
11948 (store-match-data match-data)
11949 (replace-match next t t)
11950 (unless (pos-visible-in-window-p hl-pos)
11951 (message "TODO state changed to %s" (org-trim next)))
11952 (unless head
11953 (setq head (org-get-todo-sequence-head org-state)
11954 ass (assoc head org-todo-kwd-alist)
11955 interpret (nth 1 ass)
11956 done-word (nth 3 ass)
11957 final-done-word (nth 4 ass)))
11958 (when (memq arg '(nextset previousset))
11959 (message "Keyword-Set %d/%d: %s"
11960 (- (length org-todo-sets) -1
11961 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11962 (length org-todo-sets)
11963 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11964 (setq org-last-todo-state-is-todo
11965 (not (member org-state org-done-keywords)))
11966 (setq now-done-p (and (member org-state org-done-keywords)
11967 (not (member this org-done-keywords))))
11968 (and logging (org-local-logging logging))
11969 (when (and (or org-todo-log-states org-log-done)
11970 (not (eq org-inhibit-logging t))
11971 (not (memq arg '(nextset previousset))))
11972 ;; we need to look at recording a time and note
11973 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11974 (nth 2 (assoc this org-todo-log-states))))
11975 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11976 (setq dolog 'time))
11977 (when (and org-state
11978 (member org-state org-not-done-keywords)
11979 (not (member this org-not-done-keywords)))
11980 ;; This is now a todo state and was not one before
11981 ;; If there was a CLOSED time stamp, get rid of it.
11982 (org-add-planning-info nil nil 'closed))
11983 (when (and now-done-p org-log-done)
11984 ;; It is now done, and it was not done before
11985 (org-add-planning-info 'closed (org-current-effective-time))
11986 (if (and (not dolog) (eq 'note org-log-done))
11987 (org-add-log-setup 'done org-state this 'findpos 'note)))
11988 (when (and org-state dolog)
11989 ;; This is a non-nil state, and we need to log it
11990 (org-add-log-setup 'state org-state this 'findpos dolog)))
11991 ;; Fixup tag positioning
11992 (org-todo-trigger-tag-changes org-state)
11993 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11994 (when org-provide-todo-statistics
11995 (org-update-parent-todo-statistics))
11996 (run-hooks 'org-after-todo-state-change-hook)
11997 (if (and arg (not (member org-state org-done-keywords)))
11998 (setq head (org-get-todo-sequence-head org-state)))
11999 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12000 ;; Do we need to trigger a repeat?
12001 (when now-done-p
12002 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12003 ;; This is for the agenda, take a snapshot of the headline.
12004 (save-match-data
12005 (setq org-agenda-headline-snapshot-before-repeat
12006 (org-get-heading))))
12007 (org-auto-repeat-maybe org-state))
12008 ;; Fixup cursor location if close to the keyword
12009 (if (and (outline-on-heading-p)
12010 (not (bolp))
12011 (save-excursion (beginning-of-line 1)
12012 (looking-at org-todo-line-regexp))
12013 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12014 (progn
12015 (goto-char (or (match-end 2) (match-end 1)))
12016 (and (looking-at " ") (just-one-space))))
12017 (when org-trigger-hook
12018 (save-excursion
12019 (run-hook-with-args 'org-trigger-hook change-plist)))
12020 (when commentp (org-toggle-comment))))))))
12022 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12023 "Block turning an entry into a TODO, using the hierarchy.
12024 This checks whether the current task should be blocked from state
12025 changes. Such blocking occurs when:
12027 1. The task has children which are not all in a completed state.
12029 2. A task has a parent with the property :ORDERED:, and there
12030 are siblings prior to the current task with incomplete
12031 status.
12033 3. The parent of the task is blocked because it has siblings that should
12034 be done first, or is child of a block grandparent TODO entry."
12036 (if (not org-enforce-todo-dependencies)
12037 t ; if locally turned off don't block
12038 (catch 'dont-block
12039 ;; If this is not a todo state change, or if this entry is already DONE,
12040 ;; do not block
12041 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12042 (member (plist-get change-plist :from)
12043 (cons 'done org-done-keywords))
12044 (member (plist-get change-plist :to)
12045 (cons 'todo org-not-done-keywords))
12046 (not (plist-get change-plist :to)))
12047 (throw 'dont-block t))
12048 ;; If this task has children, and any are undone, it's blocked
12049 (save-excursion
12050 (org-back-to-heading t)
12051 (let ((this-level (funcall outline-level)))
12052 (outline-next-heading)
12053 (let ((child-level (funcall outline-level)))
12054 (while (and (not (eobp))
12055 (> child-level this-level))
12056 ;; this todo has children, check whether they are all
12057 ;; completed
12058 (if (and (not (org-entry-is-done-p))
12059 (org-entry-is-todo-p))
12060 (progn (setq org-block-entry-blocking (org-get-heading))
12061 (throw 'dont-block nil)))
12062 (outline-next-heading)
12063 (setq child-level (funcall outline-level))))))
12064 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12065 ;; any previous siblings are undone, it's blocked
12066 (save-excursion
12067 (org-back-to-heading t)
12068 (let* ((pos (point))
12069 (parent-pos (and (org-up-heading-safe) (point))))
12070 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12071 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12072 (forward-line 1)
12073 (re-search-forward org-not-done-heading-regexp pos t))
12074 (setq org-block-entry-blocking (match-string 0))
12075 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12076 ;; Search further up the hierarchy, to see if an ancestor is blocked
12077 (while t
12078 (goto-char parent-pos)
12079 (if (not (looking-at org-not-done-heading-regexp))
12080 (throw 'dont-block t)) ; do not block, parent is not a TODO
12081 (setq pos (point))
12082 (setq parent-pos (and (org-up-heading-safe) (point)))
12083 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12084 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12085 (forward-line 1)
12086 (re-search-forward org-not-done-heading-regexp pos t)
12087 (setq org-block-entry-blocking (org-get-heading)))
12088 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12090 (defcustom org-track-ordered-property-with-tag nil
12091 "Should the ORDERED property also be shown as a tag?
12092 The ORDERED property decides if an entry should require subtasks to be
12093 completed in sequence. Since a property is not very visible, setting
12094 this option means that toggling the ORDERED property with the command
12095 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12096 not relevant for the behavior, but it makes things more visible.
12098 Note that toggling the tag with tags commands will not change the property
12099 and therefore not influence behavior!
12101 This can be t, meaning the tag ORDERED should be used, It can also be a
12102 string to select a different tag for this task."
12103 :group 'org-todo
12104 :type '(choice
12105 (const :tag "No tracking" nil)
12106 (const :tag "Track with ORDERED tag" t)
12107 (string :tag "Use other tag")))
12109 (defun org-toggle-ordered-property ()
12110 "Toggle the ORDERED property of the current entry.
12111 For better visibility, you can track the value of this property with a tag.
12112 See variable `org-track-ordered-property-with-tag'."
12113 (interactive)
12114 (let* ((t1 org-track-ordered-property-with-tag)
12115 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12116 (save-excursion
12117 (org-back-to-heading)
12118 (if (org-entry-get nil "ORDERED")
12119 (progn
12120 (org-delete-property "ORDERED" "PROPERTIES")
12121 (and tag (org-toggle-tag tag 'off))
12122 (message "Subtasks can be completed in arbitrary order"))
12123 (org-entry-put nil "ORDERED" "t")
12124 (and tag (org-toggle-tag tag 'on))
12125 (message "Subtasks must be completed in sequence")))))
12127 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12128 (defun org-block-todo-from-checkboxes (change-plist)
12129 "Block turning an entry into a TODO, using checkboxes.
12130 This checks whether the current task should be blocked from state
12131 changes because there are unchecked boxes in this entry."
12132 (if (not org-enforce-todo-checkbox-dependencies)
12133 t ; if locally turned off don't block
12134 (catch 'dont-block
12135 ;; If this is not a todo state change, or if this entry is already DONE,
12136 ;; do not block
12137 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12138 (member (plist-get change-plist :from)
12139 (cons 'done org-done-keywords))
12140 (member (plist-get change-plist :to)
12141 (cons 'todo org-not-done-keywords))
12142 (not (plist-get change-plist :to)))
12143 (throw 'dont-block t))
12144 ;; If this task has checkboxes that are not checked, it's blocked
12145 (save-excursion
12146 (org-back-to-heading t)
12147 (let ((beg (point)) end)
12148 (outline-next-heading)
12149 (setq end (point))
12150 (goto-char beg)
12151 (if (org-list-search-forward
12152 (concat (org-item-beginning-re)
12155 end t)
12156 (progn
12157 (if (boundp 'org-blocked-by-checkboxes)
12158 (setq org-blocked-by-checkboxes t))
12159 (throw 'dont-block nil)))))
12160 t))) ; do not block
12162 (defun org-entry-blocked-p ()
12163 "Is the current entry blocked?"
12164 (with-silent-modifications
12165 (if (org-entry-get nil "NOBLOCKING")
12166 nil ;; Never block this entry
12167 (not (run-hook-with-args-until-failure
12168 'org-blocker-hook
12169 (list :type 'todo-state-change
12170 :position (point)
12171 :from 'todo
12172 :to 'done))))))
12174 (defun org-update-statistics-cookies (all)
12175 "Update the statistics cookie, either from TODO or from checkboxes.
12176 This should be called with the cursor in a line with a statistics cookie."
12177 (interactive "P")
12178 (if all
12179 (progn
12180 (org-update-checkbox-count 'all)
12181 (org-map-entries 'org-update-parent-todo-statistics))
12182 (if (not (org-at-heading-p))
12183 (org-update-checkbox-count)
12184 (let ((pos (point-marker))
12185 end l1 l2)
12186 (ignore-errors (org-back-to-heading t))
12187 (if (not (org-at-heading-p))
12188 (org-update-checkbox-count)
12189 (setq l1 (org-outline-level))
12190 (setq end (save-excursion
12191 (outline-next-heading)
12192 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12193 (point)))
12194 (if (and (save-excursion
12195 (re-search-forward
12197 (not (save-excursion (re-search-forward
12199 (org-update-checkbox-count)
12200 (if (and l2 (> l2 l1))
12201 (progn
12202 (goto-char end)
12203 (org-update-parent-todo-statistics))
12204 (goto-char pos)
12205 (beginning-of-line 1)
12206 (while (re-search-forward
12208 (point-at-eol) t)
12209 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12210 (goto-char pos)
12211 (move-marker pos nil)))))
12213 (defvar org-entry-property-inherited-from) ;; defined below
12214 (defun org-update-parent-todo-statistics ()
12215 "Update any statistics cookie in the parent of the current headline.
12216 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12217 the entire subtree and this will travel up the hierarchy and update
12218 statistics everywhere."
12219 (let* ((prop (save-excursion (org-up-heading-safe)
12220 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12221 (recursive (or (not org-hierarchical-todo-statistics)
12223 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12224 0))
12225 (first t)
12227 level ltoggle l1 new ndel
12228 (cnt-all 0) (cnt-done 0) is-percent kwd
12229 checkbox-beg ov ovs ove cookie-present)
12230 (catch 'exit
12231 (save-excursion
12232 (beginning-of-line 1)
12233 (setq ltoggle (funcall outline-level))
12234 ;; Three situations are to consider:
12236 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12237 ;; to the top-level ancestor on the headline;
12239 ;; 2. If parent has "recursive" property, repeat up to the
12240 ;; headline setting that property, taking inheritance into
12241 ;; account;
12243 ;; 3. Else, move up to direct parent and proceed only once.
12244 (while (and (setq level (org-up-heading-safe))
12245 (or recursive first)
12246 (>= (point) lim))
12247 (setq first nil cookie-present nil)
12248 (unless (and level
12249 (not (string-match
12251 (downcase (or (org-entry-get nil "COOKIE_DATA")
12252 "")))))
12253 (throw 'exit nil))
12254 (while (re-search-forward box-re (point-at-eol) t)
12255 (setq cnt-all 0 cnt-done 0 cookie-present t)
12256 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12257 (save-match-data
12258 (unless (outline-next-heading) (throw 'exit nil))
12259 (while (and (looking-at org-complex-heading-regexp)
12260 (> (setq l1 (length (match-string 1))) level))
12261 (setq kwd (and (or recursive (= l1 ltoggle))
12262 (match-string 2)))
12263 (if (or (eq org-provide-todo-statistics 'all-headlines)
12264 (and (listp org-provide-todo-statistics)
12265 (or (member kwd org-provide-todo-statistics)
12266 (member kwd org-done-keywords))))
12267 (setq cnt-all (1+ cnt-all))
12268 (if (eq org-provide-todo-statistics t)
12269 (and kwd (setq cnt-all (1+ cnt-all)))))
12270 (and (member kwd org-done-keywords)
12271 (setq cnt-done (1+ cnt-done)))
12272 (outline-next-heading)))
12273 (setq new
12274 (if is-percent
12275 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12276 (format "[%d/%d]" cnt-done cnt-all))
12277 ndel (- (match-end 0) checkbox-beg))
12278 ;; handle overlays when updating cookie from column view
12279 (when (setq ov (car (overlays-at checkbox-beg)))
12280 (setq ovs (overlay-start ov) ove (overlay-end ov))
12281 (delete-overlay ov))
12282 (goto-char checkbox-beg)
12283 (insert new)
12284 (delete-region (point) (+ (point) ndel))
12285 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12286 (when ov (move-overlay ov ovs ove)))
12287 (when cookie-present
12288 (run-hook-with-args 'org-after-todo-statistics-hook
12289 cnt-done (- cnt-all cnt-done))))))
12290 (run-hooks 'org-todo-statistics-hook)))
12292 (defvar org-after-todo-statistics-hook nil
12293 "Hook that is called after a TODO statistics cookie has been updated.
12294 Each function is called with two arguments: the number of not-done entries
12295 and the number of done entries.
12297 For example, the following function, when added to this hook, will switch
12298 an entry to DONE when all children are done, and back to TODO when new
12299 entries are set to a TODO status. Note that this hook is only called
12300 when there is a statistics cookie in the headline!
12302 (defun org-summary-todo (n-done n-not-done)
12304 (let (org-log-done org-log-states) ; turn off logging
12306 ")
12308 (defvar org-todo-statistics-hook nil
12309 "Hook that is run whenever Org thinks TODO statistics should be updated.
12310 This hook runs even if there is no statistics cookie present, in which case
12311 `org-after-todo-statistics-hook' would not run.")
12313 (defun org-todo-trigger-tag-changes (state)
12314 "Apply the changes defined in `org-todo-state-tags-triggers'."
12315 (let ((l org-todo-state-tags-triggers)
12316 changes)
12317 (when (or (not state) (equal state ""))
12318 (setq changes (append changes (cdr (assoc "" l)))))
12319 (when (and (stringp state) (> (length state) 0))
12320 (setq changes (append changes (cdr (assoc state l)))))
12321 (when (member state org-not-done-keywords)
12322 (setq changes (append changes (cdr (assoc 'todo l)))))
12323 (when (member state org-done-keywords)
12324 (setq changes (append changes (cdr (assoc 'done l)))))
12325 (dolist (c changes)
12326 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12328 (defun org-local-logging (value)
12329 "Get logging settings from a property VALUE."
12330 (let* (words w a)
12331 ;; directly set the variables, they are already local.
12332 (setq org-log-done nil
12333 org-log-repeat nil
12334 org-todo-log-states nil)
12335 (setq words (org-split-string value))
12336 (while (setq w (pop words))
12337 (cond
12338 ((setq a (assoc w org-startup-options))
12339 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12340 (set (nth 1 a) (nth 2 a))))
12341 ((setq a (org-extract-log-state-settings w))
12342 (and (member (car a) org-todo-keywords-1)
12343 (push a org-todo-log-states)))))))
12345 (defun org-get-todo-sequence-head (kwd)
12346 "Return the head of the TODO sequence to which KWD belongs.
12347 If KWD is not set, check if there is a text property remembering the
12348 right sequence."
12349 (let (p)
12350 (cond
12351 ((not kwd)
12352 (or (get-text-property (point-at-bol) 'org-todo-head)
12353 (progn
12354 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12355 nil (point-at-eol)))
12356 (get-text-property p 'org-todo-head))))
12357 ((not (member kwd org-todo-keywords-1))
12358 (car org-todo-keywords-1))
12359 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12361 (defun org-fast-todo-selection ()
12362 "Fast TODO keyword selection with single keys.
12363 Returns the new TODO keyword, or nil if no state change should occur."
12364 (let* ((fulltable org-todo-key-alist)
12365 (done-keywords org-done-keywords) ;; needed for the faces.
12366 (maxlen (apply 'max (mapcar
12367 (lambda (x)
12368 (if (stringp (car x)) (string-width (car x)) 0))
12369 fulltable)))
12370 (expert nil)
12371 (fwidth (+ maxlen 3 1 3))
12372 (ncol (/ (- (window-width) 4) fwidth))
12373 tg cnt e c tbl
12374 groups ingroup)
12375 (save-excursion
12376 (save-window-excursion
12377 (if expert
12378 (set-buffer (get-buffer-create " *Org todo*"))
12379 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12380 (erase-buffer)
12381 (org-set-local 'org-done-keywords done-keywords)
12382 (setq tbl fulltable cnt 0)
12383 (while (setq e (pop tbl))
12384 (cond
12385 ((equal e '(:startgroup))
12386 (push '() groups) (setq ingroup t)
12387 (when (not (= cnt 0))
12388 (setq cnt 0)
12390 (insert "{ "))
12391 ((equal e '(:endgroup))
12392 (setq ingroup nil cnt 0)
12394 ((equal e '(:newline))
12395 (when (not (= cnt 0))
12396 (setq cnt 0)
12398 (setq e (car tbl))
12399 (while (equal (car tbl) '(:newline))
12401 (setq tbl (cdr tbl)))))
12402 (t
12403 (setq tg (car e) c (cdr e))
12404 (if ingroup (push tg (car groups)))
12405 (setq tg (org-add-props tg nil 'face
12406 (org-get-todo-face tg)))
12407 (if (and (= cnt 0) (not ingroup)) (insert " "))
12408 (insert "[" c "] " tg (make-string
12409 (- fwidth 4 (length tg)) ?\ ))
12410 (when (= (setq cnt (1+ cnt)) ncol)
12412 (if ingroup (insert " "))
12413 (setq cnt 0)))))
12415 (goto-char (point-min))
12416 (if (not expert) (org-fit-window-to-buffer))
12417 (message "[a-z..]:Set [SPC]:clear")
12418 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12419 (cond
12420 ((or (= c ?\C-g)
12421 (and (= c ?q) (not (rassoc c fulltable))))
12422 (setq quit-flag t))
12423 ((= c ?\ ) nil)
12424 ((setq e (rassoc c fulltable) tg (car e))
12425 tg)
12426 (t (setq quit-flag t)))))))
12428 (defun org-entry-is-todo-p ()
12429 (member (org-get-todo-state) org-not-done-keywords))
12431 (defun org-entry-is-done-p ()
12432 (member (org-get-todo-state) org-done-keywords))
12434 (defun org-get-todo-state ()
12435 (save-excursion
12436 (org-back-to-heading t)
12437 (and (looking-at org-todo-line-regexp)
12438 (match-end 2)
12439 (match-string 2))))
12441 (defun org-at-date-range-p (&optional inactive-ok)
12442 "Is the cursor inside a date range?"
12443 (interactive)
12444 (save-excursion
12445 (catch 'exit
12446 (let ((pos (point)))
12448 (skip-chars-backward "<[")
12449 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12450 (>= (match-end 0) pos)
12451 (throw 'exit t))
12453 (skip-chars-backward "<[")
12454 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12455 (>= (match-end 0) pos)
12456 (throw 'exit t)))
12457 nil)))
12459 (defun org-get-repeat (&optional tagline)
12460 "Check if there is a deadline/schedule with repeater in this entry."
12461 (save-match-data
12462 (save-excursion
12463 (org-back-to-heading t)
12464 (and (re-search-forward (if tagline
12466 org-repeat-re)
12467 (org-entry-end-position) t)
12468 (match-string-no-properties 1)))))
12470 (defvar org-last-changed-timestamp)
12471 (defvar org-last-inserted-timestamp)
12472 (defvar org-log-post-message)
12473 (defvar org-log-note-purpose)
12474 (defvar org-log-note-how)
12475 (defvar org-log-note-extra)
12476 (defun org-auto-repeat-maybe (done-word)
12477 "Check if the current headline contains a repeated deadline/schedule.
12478 If yes, set TODO state back to what it was and change the base date
12479 of repeating deadline/scheduled time stamps to new date.
12480 This function is run automatically after each state change to a DONE state."
12481 ;; last-state is dynamically scoped into this function
12482 (let* ((repeat (org-get-repeat))
12483 (aa (assoc org-last-state org-todo-kwd-alist))
12484 (interpret (nth 1 aa))
12485 (head (nth 2 aa))
12486 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12487 (msg "Entry repeats: ")
12488 (org-log-done nil)
12489 (org-todo-log-states nil)
12490 re type n what ts time to-state)
12491 (when repeat
12492 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12493 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12494 org-todo-repeat-to-state))
12495 (unless (and to-state (member to-state org-todo-keywords-1))
12496 (setq to-state (if (eq interpret 'type) org-last-state head)))
12497 (org-todo to-state)
12498 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12499 (org-entry-put nil "LAST_REPEAT" (format-time-string
12500 (org-time-stamp-format t t))))
12501 (when org-log-repeat
12502 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12503 (memq 'org-add-log-note post-command-hook))
12504 ;; OK, we are already setup for some record
12505 (if (eq org-log-repeat 'note)
12506 ;; make sure we take a note, not only a time stamp
12507 (setq org-log-note-how 'note))
12508 ;; Set up for taking a record
12509 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12510 org-last-state
12511 'findpos org-log-repeat)))
12512 (org-back-to-heading t)
12513 (org-add-planning-info nil nil 'closed)
12517 (while (re-search-forward
12518 re (save-excursion (outline-next-heading) (point)) t)
12519 (setq type (if (match-end 1) org-scheduled-string
12520 (if (match-end 3) org-deadline-string "Plain:"))
12521 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12523 (setq n (string-to-number (match-string 2 ts))
12524 what (match-string 3 ts))
12525 (if (equal what "w") (setq n (* n 7) what "d"))
12527 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12528 ;; Preparation, see if we need to modify the start date for the change
12529 (when (match-end 1)
12530 (setq time (save-match-data (org-time-string-to-time ts)))
12531 (cond
12532 ((equal (match-string 1 ts) ".")
12533 ;; Shift starting date to today
12534 (org-timestamp-change
12535 (- (org-today) (time-to-days time))
12536 'day))
12537 ((equal (match-string 1 ts) "+")
12538 (let ((nshiftmax 10) (nshift 0))
12539 (while (or (= nshift 0)
12540 (<= (time-to-days time)
12541 (time-to-days (current-time))))
12542 (when (= (incf nshift) nshiftmax)
12543 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12544 (error "Abort")))
12545 (org-timestamp-change n (cdr (assoc what whata)))
12546 (org-at-timestamp-p t)
12547 (setq ts (match-string 1))
12548 (setq time (save-match-data (org-time-string-to-time ts)))))
12549 (org-timestamp-change (- n) (cdr (assoc what whata)))
12550 ;; rematch, so that we have everything in place for the real shift
12551 (org-at-timestamp-p t)
12552 (setq ts (match-string 1))
12554 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12555 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12556 (setq org-log-post-message msg)
12557 (message "%s" msg))))
12559 (defun org-show-todo-tree (arg)
12560 "Make a compact tree which shows all headlines marked with TODO.
12561 The tree will show the lines where the regexp matches, and all higher
12562 headlines above the match.
12564 With a numeric prefix N, construct a sparse tree for the Nth element
12565 of `org-todo-keywords-1'."
12566 (interactive "P")
12567 (let ((case-fold-search nil)
12568 (kwd-re
12569 (cond ((null arg) org-not-done-regexp)
12570 ((equal arg '(4))
12571 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12572 (mapcar 'list org-todo-keywords-1))))
12576 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12577 (regexp-quote (nth (1- (prefix-numeric-value arg))
12578 org-todo-keywords-1)))
12579 (t (error "Invalid prefix argument: %s" arg)))))
12580 (message "%d TODO entries found"
12581 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12583 (defun org-deadline (&optional arg time)
12585 With one universal prefix argument, remove any deadline from the item.
12586 With two universal prefix arguments, prompt for a warning delay.
12587 With argument TIME, set the deadline at the corresponding date. TIME
12589 (interactive "P")
12590 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12591 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12592 'region-start-level 'region))
12593 org-loop-over-headlines-in-active-region)
12594 (org-map-entries
12595 `(org-deadline ',arg ,time)
12596 org-loop-over-headlines-in-active-region
12597 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12598 (let* ((old-date (org-entry-get nil "DEADLINE"))
12599 (repeater (and old-date
12600 (string-match
12602 old-date)
12603 (match-string 1 old-date))))
12604 (cond
12605 ((equal arg '(4))
12606 (when (and old-date org-log-redeadline)
12607 (org-add-log-setup 'deldeadline nil old-date 'findpos
12608 org-log-redeadline))
12609 (org-remove-timestamp-with-keyword org-deadline-string)
12610 (message "Item no longer has a deadline."))
12611 ((equal arg '(16))
12612 (save-excursion
12613 (if (re-search-forward
12614 org-deadline-time-regexp
12615 (save-excursion (outline-next-heading) (point)) t)
12616 (let* ((rpl0 (match-string 1))
12617 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12618 (replace-match
12619 (concat org-deadline-string
12620 " <" rpl
12621 (format " -%dd" (abs
12622 (- (time-to-days
12623 (save-match-data
12624 (org-read-date nil t nil "Warn starting from")))
12625 (time-to-days nil))))
12626 ">") t t))
12627 (user-error "No deadline information to update"))))
12628 (t
12629 (org-add-planning-info 'deadline time 'closed)
12630 (when (and old-date org-log-redeadline
12631 (not (equal old-date
12632 (substring org-last-inserted-timestamp 1 -1))))
12633 (org-add-log-setup 'redeadline nil old-date 'findpos
12634 org-log-redeadline))
12635 (when repeater
12636 (save-excursion
12637 (org-back-to-heading t)
12638 (when (re-search-forward (concat org-deadline-string " "
12639 org-last-inserted-timestamp)
12640 (save-excursion
12641 (outline-next-heading) (point)) t)
12642 (goto-char (1- (match-end 0)))
12643 (insert " " repeater)
12644 (setq org-last-inserted-timestamp
12645 (concat (substring org-last-inserted-timestamp 0 -1)
12646 " " repeater
12647 (substring org-last-inserted-timestamp -1))))))
12648 (message "Deadline on %s" org-last-inserted-timestamp))))))
12650 (defun org-schedule (&optional arg time)
12651 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12652 With one universal prefix argument, remove any scheduling date from the item.
12653 With two universal prefix arguments, prompt for a delay cookie.
12654 With argument TIME, scheduled at the corresponding date. TIME can
12656 (interactive "P")
12657 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12658 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12659 'region-start-level 'region))
12660 org-loop-over-headlines-in-active-region)
12661 (org-map-entries
12662 `(org-schedule ',arg ,time)
12663 org-loop-over-headlines-in-active-region
12664 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12665 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12666 (repeater (and old-date
12667 (string-match
12669 old-date)
12670 (match-string 1 old-date))))
12671 (cond
12672 ((equal arg '(4))
12673 (progn
12674 (when (and old-date org-log-reschedule)
12675 (org-add-log-setup 'delschedule nil old-date 'findpos
12676 org-log-reschedule))
12677 (org-remove-timestamp-with-keyword org-scheduled-string)
12678 (message "Item is no longer scheduled.")))
12679 ((equal arg '(16))
12680 (save-excursion
12681 (if (re-search-forward
12682 org-scheduled-time-regexp
12683 (save-excursion (outline-next-heading) (point)) t)
12684 (let* ((rpl0 (match-string 1))
12685 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12686 (replace-match
12687 (concat org-scheduled-string
12688 " <" rpl
12689 (format " -%dd" (abs
12690 (- (time-to-days
12691 (save-match-data
12692 (org-read-date nil t nil "Delay until")))
12693 (time-to-days nil))))
12694 ">") t t))
12695 (user-error "No scheduled information to update"))))
12696 (t
12697 (org-add-planning-info 'scheduled time 'closed)
12698 (when (and old-date org-log-reschedule
12699 (not (equal old-date
12700 (substring org-last-inserted-timestamp 1 -1))))
12701 (org-add-log-setup 'reschedule nil old-date 'findpos
12702 org-log-reschedule))
12703 (when repeater
12704 (save-excursion
12705 (org-back-to-heading t)
12706 (when (re-search-forward (concat org-scheduled-string " "
12707 org-last-inserted-timestamp)
12708 (save-excursion
12709 (outline-next-heading) (point)) t)
12710 (goto-char (1- (match-end 0)))
12711 (insert " " repeater)
12712 (setq org-last-inserted-timestamp
12713 (concat (substring org-last-inserted-timestamp 0 -1)
12714 " " repeater
12715 (substring org-last-inserted-timestamp -1))))))
12716 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12718 (defun org-get-scheduled-time (pom &optional inherit)
12719 "Get the scheduled time as a time tuple, of a format suitable
12720 for calling org-schedule with, or if there is no scheduling,
12721 returns nil."
12722 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12723 (when time
12724 (apply 'encode-time (org-parse-time-string time)))))
12726 (defun org-get-deadline-time (pom &optional inherit)
12727 "Get the deadline as a time tuple, of a format suitable for
12728 calling org-deadline with, or if there is no scheduling, returns
12729 nil."
12730 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12731 (when time
12732 (apply 'encode-time (org-parse-time-string time)))))
12734 (defun org-remove-timestamp-with-keyword (keyword)
12735 "Remove all time stamps with KEYWORD in the current entry."
12737 beg)
12738 (save-excursion
12739 (org-back-to-heading t)
12740 (setq beg (point))
12741 (outline-next-heading)
12742 (while (re-search-backward re beg t)
12743 (replace-match "")
12745 (equal (char-before) ?\ ))
12746 (backward-delete-char 1)
12748 (point-at-bol) (point-at-eol)))
12749 (delete-region (point-at-bol)
12750 (min (point-max) (1+ (point-at-eol))))))))))
12752 (defun org-add-planning-info (what &optional time &rest remove)
12753 "Insert new timestamp with keyword in the line directly after the headline.
12754 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12755 If non is given, the user is prompted for a date.
12756 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12757 be removed."
12758 (interactive)
12759 (let (org-time-was-given org-end-time-was-given ts
12760 end default-time default-input)
12762 (catch 'exit
12763 (when (and (memq what '(scheduled deadline))
12764 (or (not time)
12765 (and (stringp time)
12766 (string-match "^[-+]+[0-9]" time))))
12767 ;; Try to get a default date/time from existing timestamp
12768 (save-excursion
12769 (org-back-to-heading t)
12770 (setq end (save-excursion (outline-next-heading) (point)))
12771 (when (re-search-forward (if (eq what 'scheduled)
12772 org-scheduled-time-regexp
12773 org-deadline-time-regexp)
12774 end t)
12775 (setq ts (match-string 1)
12776 default-time
12777 (apply 'encode-time (org-parse-time-string ts))
12778 default-input (and ts (org-get-compact-tod ts))))))
12779 (when what
12780 (setq time
12781 (if (stringp time)
12782 ;; This is a string (relative or absolute), set proper date
12783 (apply 'encode-time
12784 (org-read-date-analyze
12785 time default-time (decode-time default-time)))
12786 ;; If necessary, get the time from the user
12787 (or time (org-read-date nil 'to-time nil nil
12788 default-time default-input)))))
12790 (when (and org-insert-labeled-timestamps-at-point
12791 (member what '(scheduled deadline)))
12792 (insert
12793 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12794 (org-insert-time-stamp time org-time-was-given
12795 nil nil nil (list org-end-time-was-given))
12796 (setq what nil))
12797 (save-excursion
12798 (save-restriction
12799 (let (col list elt ts buffer-invisibility-spec)
12800 (org-back-to-heading t)
12802 (goto-char (match-end 1))
12803 (setq col (current-column))
12804 (goto-char (match-end 0))
12806 (when (and (not what)
12807 (not (looking-at
12809 org-keyword-time-not-clock-regexp))))
12810 ;; Nothing to add, nothing to remove...... :-)
12811 (throw 'exit nil))
12812 (if (and (not (looking-at org-outline-regexp))
12815 (not (equal (match-string 1) org-clock-string)))
12816 (narrow-to-region (match-beginning 0) (match-end 0))
12818 (backward-char 1)
12819 (narrow-to-region (point) (point))
12820 (and org-adapt-indentation (org-indent-to-column col)))
12821 ;; Check if we have to remove something.
12822 (setq list (cons what remove))
12823 (while list
12824 (setq elt (pop list))
12825 (when (or (and (eq elt 'scheduled)
12826 (re-search-forward org-scheduled-time-regexp nil t))
12827 (and (eq elt 'deadline)
12828 (re-search-forward org-deadline-time-regexp nil t))
12829 (and (eq elt 'closed)
12830 (re-search-forward org-closed-time-regexp nil t)))
12831 (replace-match "")
12832 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12834 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12835 (when what
12836 (insert
12837 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12838 (cond ((eq what 'scheduled) org-scheduled-string)
12839 ((eq what 'deadline) org-deadline-string)
12840 ((eq what 'closed) org-closed-string))
12841 " ")
12842 (setq ts (org-insert-time-stamp
12843 time
12844 (or org-time-was-given
12845 (and (eq what 'closed) org-log-done-with-time))
12846 (eq what 'closed)
12847 nil nil (list org-end-time-was-given)))
12848 (insert
12849 (if (not (or (bolp) (eq (char-before) ?\ )
12850 (memq (char-after) '(32 10))
12851 (eobp))) " " ""))
12852 (end-of-line 1))
12853 (goto-char (point-min))
12854 (widen)
12857 (delete-region (1- (point)) (point-at-eol)))
12858 ts))))))
12860 (defvar org-log-note-marker (make-marker))
12861 (defvar org-log-note-purpose nil)
12862 (defvar org-log-note-state nil)
12863 (defvar org-log-note-previous-state nil)
12864 (defvar org-log-note-how nil)
12865 (defvar org-log-note-extra nil)
12866 (defvar org-log-note-window-configuration nil)
12867 (defvar org-log-note-return-to (make-marker))
12868 (defvar org-log-note-effective-time nil
12869 "Remembered current time so that dynamically scoped
12870 `org-extend-today-until' affects tha timestamps in state change
12871 log")
12873 (defvar org-log-post-message nil
12874 "Message to be displayed after a log note has been stored.
12875 The auto-repeater uses this.")
12877 (defun org-add-note ()
12878 "Add a note to the current entry.
12879 This is done in the same way as adding a state change note."
12880 (interactive)
12881 (org-add-log-setup 'note nil nil 'findpos nil))
12883 (defvar org-property-end-re)
12884 (defun org-add-log-setup (&optional purpose state prev-state
12885 findpos how extra)
12886 "Set up the post command hook to take a note.
12887 If this is about to TODO state change, the new state is expected in STATE.
12888 When FINDPOS is non-nil, find the correct position for the note in
12889 the current entry. If not, assume that it can be inserted at point.
12890 HOW is an indicator what kind of note should be created.
12891 EXTRA is additional text that will be inserted into the notes buffer."
12892 (let* ((org-log-into-drawer (org-log-into-drawer))
12893 (drawer (cond ((stringp org-log-into-drawer)
12894 org-log-into-drawer)
12895 (org-log-into-drawer "LOGBOOK"))))
12896 (save-restriction
12897 (save-excursion
12898 (when findpos
12899 (org-back-to-heading t)
12900 (narrow-to-region (point) (save-excursion
12901 (outline-next-heading) (point)))
12905 (goto-char (match-end 0))
12906 (cond
12907 (drawer
12909 nil t)
12910 (progn
12911 (goto-char (match-end 0))
12912 (or org-log-states-order-reversed
12913 (and (re-search-forward org-property-end-re nil t)
12914 (goto-char (1- (match-beginning 0))))))
12916 (beginning-of-line 0)
12917 (org-indent-line)
12918 (beginning-of-line 2)
12919 (org-indent-line)
12920 (end-of-line 0)))
12921 ((and org-log-state-notes-insert-after-drawers
12922 (save-excursion
12923 (forward-line) (looking-at org-drawer-regexp)))
12924 (forward-line)
12925 (while (looking-at org-drawer-regexp)
12926 (goto-char (match-end 0))
12927 (re-search-forward org-property-end-re (point-max) t)
12928 (forward-line))
12929 (forward-line -1)))
12930 (unless org-log-states-order-reversed
12932 (org-skip-over-state-notes)
12934 (move-marker org-log-note-marker (point))
12935 (setq org-log-note-purpose purpose
12936 org-log-note-state state
12937 org-log-note-previous-state prev-state
12938 org-log-note-how how
12939 org-log-note-extra extra
12940 org-log-note-effective-time (org-current-effective-time))
12941 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12943 (defun org-skip-over-state-notes ()
12944 "Skip past the list of State notes in an entry."
12946 (when (ignore-errors (goto-char (org-in-item-p)))
12947 (let* ((struct (org-list-struct))
12948 (prevs (org-list-prevs-alist struct)))
12950 (goto-char (or (org-list-get-next-item (point) struct prevs)
12951 (org-list-get-item-end (point) struct)))))))
12953 (defun org-add-log-note (&optional purpose)
12954 "Pop up a window for taking a note, and add this note later at point."
12955 (remove-hook 'post-command-hook 'org-add-log-note)
12956 (setq org-log-note-window-configuration (current-window-configuration))
12957 (delete-other-windows)
12958 (move-marker org-log-note-return-to (point))
12959 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12960 (goto-char org-log-note-marker)
12961 (org-switch-to-buffer-other-window "*Org Note*")
12962 (erase-buffer)
12963 (if (memq org-log-note-how '(time state))
12964 (let (current-prefix-arg) (org-store-log-note))
12965 (let ((org-inhibit-startup t)) (org-mode))
12966 (insert (format "# Insert note for %s.
12968 (cond
12969 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12970 ((eq org-log-note-purpose 'done) "closed todo item")
12971 ((eq org-log-note-purpose 'state)
12973 (or org-log-note-previous-state "")
12974 (or org-log-note-state "")))
12975 ((eq org-log-note-purpose 'reschedule)
12976 "rescheduling")
12977 ((eq org-log-note-purpose 'delschedule)
12978 "no longer scheduled")
12979 ((eq org-log-note-purpose 'redeadline)
12980 "changing deadline")
12981 ((eq org-log-note-purpose 'deldeadline)
12982 "removing deadline")
12983 ((eq org-log-note-purpose 'refile)
12984 "refiling")
12985 ((eq org-log-note-purpose 'note)
12986 "this entry")
12987 (t (error "This should not happen")))))
12988 (if org-log-note-extra (insert org-log-note-extra))
12989 (org-set-local 'org-finish-function 'org-store-log-note)
12990 (run-hooks 'org-log-buffer-setup-hook)))
12992 (defvar org-note-abort nil) ; dynamically scoped
12993 (defun org-store-log-note ()
12994 "Finish taking a log note, and insert it to where it belongs."
12995 (let ((txt (buffer-string)))
12996 (kill-buffer (current-buffer))
12997 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
12998 lines ind bul)
13000 (setq txt (replace-match "" t t txt)))
13002 (setq txt (replace-match "" t t txt)))
13005 (setq note
13006 (org-replace-escapes
13007 note
13008 (list (cons "%u" (user-login-name))
13009 (cons "%U" user-full-name)
13010 (cons "%t" (format-time-string
13011 (org-time-stamp-format 'long 'inactive)
13012 org-log-note-effective-time))
13013 (cons "%T" (format-time-string
13014 (org-time-stamp-format 'long nil)
13015 org-log-note-effective-time))
13016 (cons "%d" (format-time-string
13017 (org-time-stamp-format nil 'inactive)
13018 org-log-note-effective-time))
13019 (cons "%D" (format-time-string
13020 (org-time-stamp-format nil nil)
13021 org-log-note-effective-time))
13022 (cons "%s" (if org-log-note-state
13024 ""))
13025 (cons "%S" (if org-log-note-previous-state
13029 (push note lines))
13030 (when (or current-prefix-arg org-note-abort)
13031 (when org-log-into-drawer
13032 (org-remove-empty-drawer-at
13033 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13034 org-log-note-marker))
13035 (setq lines nil))
13036 (when lines
13037 (with-current-buffer (marker-buffer org-log-note-marker)
13038 (save-excursion
13039 (goto-char org-log-note-marker)
13040 (move-marker org-log-note-marker nil)
13041 (end-of-line 1)
13043 (setq ind (save-excursion
13044 (if (ignore-errors (goto-char (org-in-item-p)))
13045 (let ((struct (org-list-struct)))
13046 (org-list-get-ind
13047 (org-list-get-top-point struct) struct))
13049 (cond
13050 ((and (org-at-heading-p)
13051 org-adapt-indentation)
13052 (1+ (org-current-level)))
13053 ((org-at-heading-p) 0)
13054 (t (org-get-indentation))))))
13055 (setq bul (org-list-bullet-string "-"))
13056 (org-indent-line-to ind)
13057 (insert bul (pop lines))
13058 (let ((ind-body (+ (length bul) ind)))
13059 (while lines
13061 (org-indent-line-to ind-body)
13062 (insert (pop lines))))
13063 (message "Note stored")
13064 (org-back-to-heading t)
13065 (org-cycle-hide-drawers 'children))))))
13066 (set-window-configuration org-log-note-window-configuration)
13067 (with-current-buffer (marker-buffer org-log-note-return-to)
13068 (goto-char org-log-note-return-to))
13069 (move-marker org-log-note-return-to nil)
13070 (and org-log-post-message (message "%s" org-log-post-message)))
13072 (defun org-remove-empty-drawer-at (drawer pos)
13073 "Remove an empty drawer DRAWER at position POS.
13074 POS may also be a marker."
13075 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13076 (save-excursion
13077 (save-restriction
13078 (widen)
13079 (goto-char pos)
13080 (if (org-in-regexp
13082 (replace-match ""))))))
13084 (defvar org-ts-type nil)
13085 (defun org-sparse-tree (&optional arg type)
13086 "Create a sparse tree, prompt for the details.
13087 This command can create sparse trees. You first need to select the type
13088 of match used to create the tree:
13090 t Show all TODO entries.
13091 T Show entries with a specific TODO keyword.
13092 m Show entries selected by a tags/property match.
13093 p Enter a property name and its value (both with completion on existing
13094 names/values) and show entries with that property.
13095 r Show entries matching a regular expression (`/' can be used as well).
13096 b Show deadlines and scheduled items before a date.
13097 a Show deadlines and scheduled items after a date.
13098 d Show deadlines due within `org-deadline-warning-days'.
13099 D Show deadlines and scheduled items between a date range."
13100 (interactive "P")
13101 (let (ans kwd value ts-type)
13102 (setq type (or type org-sparse-tree-default-date-type))
13103 (setq org-ts-type type)
13104 (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"
13105 (cond ((eq type 'all) "all timestamps")
13106 ((eq type 'scheduled) "only scheduled")
13107 ((eq type 'deadline) "only deadline")
13108 ((eq type 'active) "only active timestamps")
13109 ((eq type 'inactive) "only inactive timestamps")
13110 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13111 (t "scheduled/deadline")))
13112 (setq ans (read-char-exclusive))
13113 (cond
13114 ((equal ans ?c)
13115 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
13116 ((equal ans ?d)
13117 (call-interactively 'org-check-deadlines))
13118 ((equal ans ?b)
13119 (call-interactively 'org-check-before-date))
13120 ((equal ans ?a)
13121 (call-interactively 'org-check-after-date))
13122 ((equal ans ?D)
13123 (call-interactively 'org-check-dates-range))
13124 ((equal ans ?t)
13125 (call-interactively 'org-show-todo-tree))
13126 ((equal ans ?T)
13127 (org-show-todo-tree '(4)))
13128 ((member ans '(?T ?m))
13129 (call-interactively 'org-match-sparse-tree))
13130 ((member ans '(?p ?P))
13131 (setq kwd (org-icompleting-read "Property: "
13132 (mapcar 'list (org-buffer-property-keys))))
13133 (setq value (org-icompleting-read "Value: "
13134 (mapcar 'list (org-property-values kwd))))
13137 (org-match-sparse-tree arg (concat kwd "=" value)))
13138 ((member ans '(?r ?R ?/))
13139 (call-interactively 'org-occur))
13142 (defvar org-occur-highlights nil
13143 "List of overlays used for occur matches.")
13144 (make-variable-buffer-local 'org-occur-highlights)
13145 (defvar org-occur-parameters nil
13146 "Parameters of the active org-occur calls.
13147 This is a list, each call to org-occur pushes as cons cell,
13148 containing the regular expression and the callback, onto the list.
13149 The list can contain several entries if `org-occur' has been called
13150 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13151 will only contain one set of parameters. When the highlights are
13152 removed (for example with `C-c C-c', or with the next edit (depending
13153 on `org-remove-highlights-with-change'), this variable is emptied
13154 as well.")
13155 (make-variable-buffer-local 'org-occur-parameters)
13157 (defun org-occur (regexp &optional keep-previous callback)
13158 "Make a compact tree which shows all matches of REGEXP.
13159 The tree will show the lines where the regexp matches, and all higher
13160 headlines above the match. It will also show the heading after the match,
13161 to make sure editing the matching entry is easy.
13162 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13163 call to `org-occur' will be kept, to allow stacking of calls to this
13164 command.
13165 If CALLBACK is non-nil, it is a function which is called to confirm
13166 that the match should indeed be shown."
13168 (when (equal regexp "")
13169 (error "Regexp cannot be empty"))
13170 (unless keep-previous
13171 (org-remove-occur-highlights nil nil t))
13172 (push (cons regexp callback) org-occur-parameters)
13173 (let ((cnt 0))
13174 (save-excursion
13175 (goto-char (point-min))
13176 (if (or (not keep-previous) ; do not want to keep
13177 (not org-occur-highlights)) ; no previous matches
13178 ;; hide everything
13179 (org-overview))
13180 (while (re-search-forward regexp nil t)
13181 (when (or (not callback)
13182 (save-match-data (funcall callback)))
13183 (setq cnt (1+ cnt))
13184 (when org-highlight-sparse-tree-matches
13185 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13186 (org-show-context 'occur-tree))))
13187 (when org-remove-highlights-with-change
13188 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13189 nil 'local))
13190 (unless org-sparse-tree-open-archived-trees
13191 (org-hide-archived-subtrees (point-min) (point-max)))
13192 (run-hooks 'org-occur-hook)
13193 (if (org-called-interactively-p 'interactive)
13194 (message "%d match(es) for regexp %s" cnt regexp))
13195 cnt))
13197 (defun org-occur-next-match (&optional n reset)
13198 "Function for `next-error-function' to find sparse tree matches.
13199 N is the number of matches to move, when negative move backwards.
13200 RESET is entirely ignored - this function always goes back to the
13201 starting point when no match is found."
13202 (let* ((limit (if (< n 0) (point-min) (point-max)))
13203 (search-func (if (< n 0)
13204 'previous-single-char-property-change
13205 'next-single-char-property-change))
13206 (n (abs n))
13207 (pos (point))
13208 p1)
13209 (catch 'exit
13210 (while (setq p1 (funcall search-func (point) 'org-type))
13211 (when (equal p1 limit)
13212 (goto-char pos)
13213 (error "No more matches"))
13214 (when (equal (get-char-property p1 'org-type) 'org-occur)
13215 (setq n (1- n))
13216 (when (= n 0)
13217 (goto-char p1)
13218 (throw 'exit (point))))
13219 (goto-char p1))
13220 (goto-char p1)
13221 (error "No more matches"))))
13223 (defun org-show-context (&optional key)
13224 "Make sure point and context are visible.
13225 How much context is shown depends upon the variables
13226 `org-show-hierarchy-above', `org-show-following-heading',
13227 `org-show-entry-below' and `org-show-siblings'."
13228 (let ((heading-p (org-at-heading-p t))
13229 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13230 (following-p (org-get-alist-option org-show-following-heading key))
13231 (entry-p (org-get-alist-option org-show-entry-below key))
13232 (siblings-p (org-get-alist-option org-show-siblings key)))
13233 (catch 'exit
13234 ;; Show heading or entry text
13235 (if (and heading-p (not entry-p))
13236 (org-flag-heading nil) ; only show the heading
13237 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13238 (org-show-hidden-entry))) ; show entire entry
13239 (when following-p
13240 ;; Show next sibling, or heading below text
13241 (save-excursion
13242 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13243 (org-flag-heading nil))))
13244 (when siblings-p (org-show-siblings))
13245 (when hierarchy-p
13246 ;; show all higher headings, possibly with siblings
13247 (save-excursion
13248 (while (and (condition-case nil
13249 (progn (org-up-heading-all 1) t)
13250 (error nil))
13251 (not (bobp)))
13252 (org-flag-heading nil)
13253 (when siblings-p (org-show-siblings))))))))
13255 (defvar org-reveal-start-hook nil
13256 "Hook run before revealing a location.")
13258 (defun org-reveal (&optional siblings)
13259 "Show current entry, hierarchy above it, and the following headline.
13260 This can be used to show a consistent set of context around locations
13261 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13262 not t for the search context.
13264 With optional argument SIBLINGS, on each level of the hierarchy all
13265 siblings are shown. This repairs the tree structure to what it would
13266 look like when opened with hierarchical calls to `org-cycle'.
13268 go to the parent and show the
13269 entire tree."
13270 (interactive "P")
13271 (run-hooks 'org-reveal-start-hook)
13272 (let ((org-show-hierarchy-above t)
13273 (org-show-following-heading t)
13274 (org-show-siblings (if siblings t org-show-siblings)))
13275 (org-show-context nil))
13276 (when (equal siblings '(16))
13277 (save-excursion
13278 (when (org-up-heading-safe)
13279 (org-show-subtree)
13280 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13282 (defun org-highlight-new-match (beg end)
13283 "Highlight from BEG to END and mark the highlight is an occur headline."
13284 (let ((ov (make-overlay beg end)))
13285 (overlay-put ov 'face 'secondary-selection)
13286 (overlay-put ov 'org-type 'org-occur)
13287 (push ov org-occur-highlights)))
13289 (defun org-remove-occur-highlights (&optional beg end noremove)
13290 "Remove the occur highlights from the buffer.
13291 BEG and END are ignored. If NOREMOVE is nil, remove this function
13292 from the `before-change-functions' in the current buffer."
13293 (interactive)
13294 (unless org-inhibit-highlight-removal
13295 (mapc 'delete-overlay org-occur-highlights)
13296 (setq org-occur-highlights nil)
13297 (setq org-occur-parameters nil)
13298 (unless noremove
13299 (remove-hook 'before-change-functions
13300 'org-remove-occur-highlights 'local))))
13302 ;;;; Priorities
13305 "Regular expression matching the priority indicator.")
13307 (defvar org-remove-priority-next-time nil)
13309 (defun org-priority-up ()
13310 "Increase the priority of the current item."
13311 (interactive)
13312 (org-priority 'up))
13314 (defun org-priority-down ()
13315 "Decrease the priority of the current item."
13316 (interactive)
13317 (org-priority 'down))
13319 (defun org-priority (&optional action show)
13320 "Change the priority of an item.
13321 ACTION can be `set', `up', `down', or a character."
13322 (interactive "P")
13323 (if (equal action '(4))
13324 (org-show-priority)
13325 (unless org-enable-priority-commands
13326 (error "Priority commands are disabled"))
13327 (setq action (or action 'set))
13328 (let (current new news have remove)
13329 (save-excursion
13330 (org-back-to-heading t)
13331 (if (looking-at org-priority-regexp)
13332 (setq current (string-to-char (match-string 2))
13333 have t))
13334 (cond
13335 ((eq action 'remove)
13336 (setq remove t new ?\ ))
13337 ((or (eq action 'set)
13338 (if (featurep 'xemacs) (characterp action) (integerp action)))
13339 (if (not (eq action 'set))
13340 (setq new action)
13341 (message "Priority %c-%c, SPC to remove: "
13342 org-highest-priority org-lowest-priority)
13343 (save-match-data
13344 (setq new (read-char-exclusive))))
13345 (if (and (= (upcase org-highest-priority) org-highest-priority)
13346 (= (upcase org-lowest-priority) org-lowest-priority))
13347 (setq new (upcase new)))
13348 (cond ((equal new ?\ ) (setq remove t))
13349 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13350 (error "Priority must be between `%c' and `%c'"
13351 org-highest-priority org-lowest-priority))))
13352 ((eq action 'up)
13353 (setq new (if have
13354 (1- current) ; normal cycling
13355 ;; last priority was empty
13356 (if (eq last-command this-command)
13357 org-lowest-priority ; wrap around empty to lowest
13358 ;; default
13359 (if org-priority-start-cycle-with-default
13360 org-default-priority
13361 (1- org-default-priority))))))
13362 ((eq action 'down)
13363 (setq new (if have
13364 (1+ current) ; normal cycling
13365 ;; last priority was empty
13366 (if (eq last-command this-command)
13367 org-highest-priority ; wrap around empty to highest
13368 ;; default
13369 (if org-priority-start-cycle-with-default
13370 org-default-priority
13371 (1+ org-default-priority))))))
13372 (t (error "Invalid action")))
13373 (if (or (< (upcase new) org-highest-priority)
13374 (> (upcase new) org-lowest-priority))
13375 (if (and (memq action '(up down))
13376 (not have) (not (eq last-command this-command)))
13377 ;; `new' is from default priority
13378 (error
13379 "The default can not be set, see `org-default-priority' why")
13380 ;; normal cycling: `new' is beyond highest/lowest priority
13381 ;; and is wrapped around to the empty priority
13382 (setq remove t)))
13383 (setq news (format "%c" new))
13384 (if have
13385 (if remove
13386 (replace-match "" t t nil 1)
13387 (replace-match news t t nil 2))
13388 (if remove
13389 (error "No priority cookie found in line")
13390 (let ((case-fold-search nil))
13391 (looking-at org-todo-line-regexp))
13392 (if (match-end 2)
13393 (progn
13394 (goto-char (match-end 2))
13395 (insert " [#" news "]"))
13396 (goto-char (match-beginning 3))
13397 (insert "[#" news "] "))))
13398 (org-preserve-lc (org-set-tags nil 'align)))
13399 (if remove
13400 (message "Priority removed")
13401 (message "Priority of current item set to %s" news)))))
13403 (defun org-show-priority ()
13404 "Show the priority of the current item.
13405 This priority is composed of the main priority given with the [#A] cookies,
13406 and by additional input from the age of a schedules or deadline entry."
13407 (interactive)
13408 (let ((pri (if (eq major-mode 'org-agenda-mode)
13409 (org-get-at-bol 'priority)
13410 (save-excursion
13411 (save-match-data
13412 (beginning-of-line)
13413 (and (looking-at org-heading-regexp)
13414 (org-get-priority (match-string 0))))))))
13415 (message "Priority is %d" (if pri pri -1000))))
13417 (defun org-get-priority (s)
13418 "Find priority cookie and return priority."
13419 (save-match-data
13420 (if (functionp org-get-priority-function)
13421 (funcall org-get-priority-function)
13422 (if (not (string-match org-priority-regexp s))
13423 (* 1000 (- org-lowest-priority org-default-priority))
13424 (* 1000 (- org-lowest-priority
13425 (string-to-char (match-string 2 s))))))))
13427 ;;;; Tags
13429 (defvar org-agenda-archives-mode)
13430 (defvar org-map-continue-from nil
13431 "Position from where mapping should continue.
13432 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13434 (defvar org-scanner-tags nil
13435 "The current tag list while the tags scanner is running.")
13436 (defvar org-trust-scanner-tags nil
13437 "Should `org-get-tags-at' use the tags for the scanner.
13438 This is for internal dynamical scoping only.
13439 When this is non-nil, the function `org-get-tags-at' will return the value
13440 of `org-scanner-tags' instead of building the list by itself. This
13441 can lead to large speed-ups when the tags scanner is used in a file with
13442 many entries, and when the list of tags is retrieved, for example to
13443 obtain a list of properties. Building the tags list for each entry in such
13444 a file becomes an N^2 operation - but with this variable set, it scales
13445 as N.")
13447 (defun org-scan-tags (action matcher todo-only &optional start-level)
13448 "Sca headline tags with inheritance and produce output ACTION.
13450 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13451 or `agenda' to produce an entry list for an agenda view. It can also be
13452 a Lisp form or a function that should be called at each matched headline, in
13453 this case the return value is a list of all return values from these calls.
13455 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13456 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13457 only lines with a not-done TODO keyword are included in the output.
13458 This should be the same variable that was scoped into
13459 and set by `org-make-tags-matcher' when it constructed MATCHER.
13461 START-LEVEL can be a string with asterisks, reducing the scope to
13462 headlines matching this string."
13463 (require 'org-agenda)
13464 (let* ((re (concat "^"
13465 (if start-level
13466 ;; Get the correct level to match
13468 org-outline-regexp)
13472 (props (list 'face 'default
13473 'done-face 'org-agenda-done
13474 'undone-face 'default
13475 'mouse-face 'highlight
13476 'org-not-done-regexp org-not-done-regexp
13477 'org-todo-regexp org-todo-regexp
13478 'org-complex-heading-regexp org-complex-heading-regexp
13479 'help-echo
13480 (format "mouse-2 or RET jump to org file %s"
13481 (abbreviate-file-name
13482 (or (buffer-file-name (buffer-base-buffer))
13483 (buffer-name (buffer-base-buffer)))))))
13484 (case-fold-search nil)
13485 (org-map-continue-from nil)
13486 lspos tags tags-list
13487 (tags-alist (list (cons 0 org-file-tags)))
13488 (llast 0) rtn rtn1 level category i txt
13489 todo marker entry priority)
13490 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13491 (setq action (list 'lambda nil action)))
13492 (save-excursion
13493 (goto-char (point-min))
13494 (when (eq action 'sparse-tree)
13495 (org-overview)
13496 (org-remove-occur-highlights))
13497 (while (re-search-forward re nil t)
13498 (setq org-map-continue-from nil)
13499 (catch :skip
13500 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13501 tags (if (match-end 4) (org-match-string-no-properties 4)))
13502 (goto-char (setq lspos (match-beginning 0)))
13503 (setq level (org-reduced-level (org-outline-level))
13504 category (org-get-category))
13505 (setq i llast llast level)
13506 ;; remove tag lists from same and sublevels
13507 (while (>= i level)
13508 (when (setq entry (assoc i tags-alist))
13509 (setq tags-alist (delete entry tags-alist)))
13510 (setq i (1- i)))
13511 ;; add the next tags
13512 (when tags
13513 (setq tags (org-split-string tags ":")
13514 tags-alist
13515 (cons (cons level tags) tags-alist)))
13516 ;; compile tags for current headline
13517 (setq tags-list
13518 (if org-use-tag-inheritance
13519 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13520 tags)
13521 org-scanner-tags tags-list)
13522 (when org-use-tag-inheritance
13523 (setcdr (car tags-alist)
13524 (mapcar (lambda (x)
13525 (setq x (copy-sequence x))
13526 (org-add-prop-inherited x))
13527 (cdar tags-alist))))
13528 (when (and tags org-use-tag-inheritance
13529 (or (not (eq t org-use-tag-inheritance))
13530 org-tags-exclude-from-inheritance))
13531 ;; selective inheritance, remove uninherited ones
13532 (setcdr (car tags-alist)
13533 (org-remove-uninherited-tags (cdar tags-alist))))
13534 (when (and
13536 ;; eval matcher only when the todo condition is OK
13537 (and (or (not todo-only) (member todo org-not-done-keywords))
13538 (let ((case-fold-search t) (org-trust-scanner-tags t))
13539 (eval matcher)))
13541 ;; Call the skipper, but return t if it does not skip,
13542 ;; so that the `and' form continues evaluating
13543 (progn
13544 (unless (eq action 'sparse-tree) (org-agenda-skip))
13545 t)
13547 ;; Check if timestamps are deselecting this entry
13548 (or (not todo-only)
13549 (and (member todo org-not-done-keywords)
13550 (or (not org-agenda-tags-todo-honor-ignore-options)
13551 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13553 ;; select this headline
13554 (cond
13555 ((eq action 'sparse-tree)
13556 (and org-highlight-sparse-tree-matches
13557 (org-get-heading) (match-end 0)
13558 (org-highlight-new-match
13559 (match-beginning 1) (match-end 1)))
13560 (org-show-context 'tags-tree))
13561 ((eq action 'agenda)
13562 (setq txt (org-agenda-format-item
13563 ""
13564 (concat
13565 (if (eq org-tags-match-list-sublevels 'indented)
13566 (make-string (1- level) ?.) "")
13567 (org-get-heading))
13568 level category
13569 tags-list)
13570 priority (org-get-priority txt))
13571 (goto-char lspos)
13572 (setq marker (org-agenda-new-marker))
13573 (org-add-props txt props
13574 'org-marker marker 'org-hd-marker marker 'org-category category
13575 'todo-state todo
13576 'priority priority 'type "tagsmatch")
13577 (push txt rtn))
13578 ((functionp action)
13579 (setq org-map-continue-from nil)
13580 (save-excursion
13581 (setq rtn1 (funcall action))
13582 (push rtn1 rtn)))
13583 (t (error "Invalid action")))
13585 ;; if we are to skip sublevels, jump to end of subtree
13586 (unless org-tags-match-list-sublevels
13587 (org-end-of-subtree t)
13588 (backward-char 1))))
13589 ;; Get the correct position from where to continue
13590 (if org-map-continue-from
13591 (goto-char org-map-continue-from)
13592 (and (= (point) lspos) (end-of-line 1)))))
13593 (when (and (eq action 'sparse-tree)
13594 (not org-sparse-tree-open-archived-trees))
13595 (org-hide-archived-subtrees (point-min) (point-max)))
13596 (nreverse rtn)))
13598 (defun org-remove-uninherited-tags (tags)
13599 "Remove all tags that are not inherited from the list TAGS."
13600 (cond
13601 ((eq org-use-tag-inheritance t)
13602 (if org-tags-exclude-from-inheritance
13603 (org-delete-all org-tags-exclude-from-inheritance tags)
13604 tags))
13605 ((not org-use-tag-inheritance) nil)
13606 ((stringp org-use-tag-inheritance)
13607 (delq nil (mapcar
13608 (lambda (x)
13609 (if (and (string-match org-use-tag-inheritance x)
13610 (not (member x org-tags-exclude-from-inheritance)))
13611 x nil))
13612 tags)))
13613 ((listp org-use-tag-inheritance)
13614 (delq nil (mapcar
13615 (lambda (x)
13616 (if (member x org-use-tag-inheritance) x nil))
13617 tags)))))
13619 (defun org-match-sparse-tree (&optional todo-only match)
13620 "Create a sparse tree according to tags string MATCH.
13621 MATCH can contain positive and negative selection of tags, like
13623 If optional argument TODO-ONLY is non-nil, only select lines that are
13624 also TODO lines."
13625 (interactive "P")
13626 (org-agenda-prepare-buffers (list (current-buffer)))
13627 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13629 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13631 (defvar org-cached-props nil)
13632 (defun org-cached-entry-get (pom property)
13633 (if (or (eq t org-use-property-inheritance)
13634 (and (stringp org-use-property-inheritance)
13635 (string-match org-use-property-inheritance property))
13636 (and (listp org-use-property-inheritance)
13637 (member property org-use-property-inheritance)))
13638 ;; Caching is not possible, check it directly
13639 (org-entry-get pom property 'inherit)
13640 ;; Get all properties, so that we can do complicated checks easily
13641 (cdr (assoc property (or org-cached-props
13642 (setq org-cached-props
13643 (org-entry-properties pom)))))))
13645 (defun org-global-tags-completion-table (&optional files)
13646 "Return the list of all tags in all agenda buffer/files.
13647 Optional FILES argument is a list of files which can be used
13648 instead of the agenda files."
13649 (save-excursion
13650 (org-uniquify
13651 (delq nil
13652 (apply 'append
13653 (mapcar
13654 (lambda (file)
13655 (set-buffer (find-file-noselect file))
13656 (append (org-get-buffer-tags)
13657 (mapcar (lambda (x) (if (stringp (car-safe x))
13658 (list (car-safe x)) nil))
13659 org-tag-alist)))
13660 (if (and files (car files))
13661 files
13662 (org-agenda-files))))))))
13664 (defun org-make-tags-matcher (match)
13665 "Create the TAGS/TODO matcher form for the selection string MATCH.
13667 The variable `todo-only' is scoped dynamically into this function.
13668 It will be set to t if the matcher restricts matching to TODO entries,
13669 otherwise will not be touched.
13671 Returns a cons of the selection string MATCH and the constructed
13672 lisp form implementing the matcher. The matcher is to be evaluated
13673 at an Org entry, with point on the headline, and returns t if the
13674 entry matches the selection string MATCH. The returned lisp form
13675 references two variables with information about the entry, which
13676 must be bound around the form's evaluation: todo, the TODO keyword
13677 at the entry (or nil of none); and tags-list, the list of all tags
13678 at the entry including inherited ones. Additionally, the category
13679 of the entry (if any) must be specified as the text property
13680 'org-category on the headline.
13682 See also `org-scan-tags'.
13683 "
13684 (declare (special todo-only))
13685 (unless (boundp 'todo-only)
13686 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13687 (unless match
13688 ;; Get a new match request, with completion
13689 (let ((org-last-tags-completion-table
13690 (org-global-tags-completion-table)))
13691 (setq match (org-completing-read-no-i
13692 "Match: " 'org-tags-completion-function nil nil nil
13693 'org-tags-history))))
13695 ;; Parse the string and create a lisp form
13696 (let ((match0 match)
13697 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13698 minus tag mm
13699 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13700 orterms term orlist re-p str-p level-p level-op time-p
13701 prop-p pn pv po gv rest)
13702 (if (string-match "/+" match)
13703 ;; match contains also a todo-matching request
13704 (progn
13705 (setq tagsmatch (substring match 0 (match-beginning 0))
13706 todomatch (substring match (match-end 0)))
13707 (if (string-match "^!" todomatch)
13708 (setq todo-only t todomatch (substring todomatch 1)))
13710 (setq todomatch nil)))
13711 ;; only matching tags
13712 (setq tagsmatch match todomatch nil))
13714 ;; Make the tags matcher
13716 (setq tagsmatcher t)
13717 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13718 (while (setq term (pop orterms))
13720 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13721 (while (string-match re term)
13722 (setq rest (substring term (match-end 0))
13723 minus (and (match-end 1)
13724 (equal (match-string 1 term) "-"))
13725 tag (save-match-data (replace-regexp-in-string
13727 (match-string 2 term)))
13728 re-p (equal (string-to-char tag) ?{)
13729 level-p (match-end 4)
13730 prop-p (match-end 5)
13731 mm (cond
13732 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13733 (level-p
13734 (setq level-op (org-op-to-function (match-string 3 term)))
13735 `(,level-op level ,(string-to-number
13736 (match-string 4 term))))
13737 (prop-p
13738 (setq pn (match-string 5 term)
13739 po (match-string 6 term)
13740 pv (match-string 7 term)
13741 re-p (equal (string-to-char pv) ?{)
13743 time-p (save-match-data
13745 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13746 (if time-p (setq pv (org-matcher-time pv)))
13747 (setq po (org-op-to-function po (if time-p 'time str-p)))
13748 (cond
13749 ((equal pn "CATEGORY")
13750 (setq gv '(get-text-property (point) 'org-category)))
13751 ((equal pn "TODO")
13752 (setq gv 'todo))
13753 (t
13754 (setq gv `(org-cached-entry-get nil ,pn))))
13755 (if re-p
13756 (if (eq po 'org<>)
13757 `(not (string-match ,pv (or ,gv "")))
13758 `(string-match ,pv (or ,gv "")))
13759 (if str-p
13760 `(,po (or ,gv "") ,pv)
13761 `(,po (string-to-number (or ,gv ""))
13762 ,(string-to-number pv) ))))
13763 (t `(member ,tag tags-list)))
13764 mm (if minus (list 'not mm) mm)
13765 term rest)
13766 (push mm tagsmatcher))
13767 (push (if (> (length tagsmatcher) 1)
13768 (cons 'and tagsmatcher)
13769 (car tagsmatcher))
13770 orlist)
13771 (setq tagsmatcher nil))
13772 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13773 (setq tagsmatcher
13774 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13775 ;; Make the todo matcher
13777 (setq todomatcher t)
13778 (setq orterms (org-split-string todomatch "|") orlist nil)
13779 (while (setq term (pop orterms))
13780 (while (string-match re term)
13781 (setq minus (and (match-end 1)
13782 (equal (match-string 1 term) "-"))
13783 kwd (match-string 2 term)
13784 re-p (equal (string-to-char kwd) ?{)
13785 term (substring term (match-end 0))
13786 mm (if re-p
13787 `(string-match ,(substring kwd 1 -1) todo)
13788 (list 'equal 'todo kwd))
13789 mm (if minus (list 'not mm) mm))
13790 (push mm todomatcher))
13791 (push (if (> (length todomatcher) 1)
13792 (cons 'and todomatcher)
13793 (car todomatcher))
13794 orlist)
13795 (setq todomatcher nil))
13796 (setq todomatcher (if (> (length orlist) 1)
13797 (cons 'or orlist) (car orlist))))
13799 ;; Return the string and lisp forms of the matcher
13800 (setq matcher (if todomatcher
13801 (list 'and tagsmatcher todomatcher)
13802 tagsmatcher))
13803 (when todo-only
13804 (setq matcher (list 'and '(member todo org-not-done-keywords)
13805 matcher)))
13806 (cons match0 matcher)))
13808 (defun org-op-to-function (op &optional stringp)
13809 "Turn an operator into the appropriate function."
13810 (setq op
13811 (cond
13812 ((equal op "<" ) '(< string< org-time<))
13813 ((equal op ">" ) '(> org-string> org-time>))
13814 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13815 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13816 ((member op '("=" "==")) '(= string= org-time=))
13817 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13818 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13820 (defun org<> (a b) (not (= a b)))
13821 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13822 (defun org-string>= (a b) (not (string< a b)))
13823 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13824 (defun org-string<> (a b) (not (string= a b)))
13825 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13826 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13827 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13828 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13829 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13830 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13831 (defun org-2ft (s)
13832 "Convert S to a floating point time.
13833 If S is already a number, just return it. If it is a string, parse
13834 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13835 (cond
13836 ((numberp s) s)
13837 ((stringp s)
13838 (condition-case nil
13839 (float-time (apply 'encode-time (org-parse-time-string s)))
13840 (error 0.)))
13841 (t 0.)))
13843 (defun org-time-today ()
13844 "Time in seconds today at 0:00.
13845 Returns the float number of seconds since the beginning of the
13846 epoch to the beginning of today (00:00)."
13847 (float-time (apply 'encode-time
13848 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13850 (defun org-matcher-time (s)
13851 "Interpret a time comparison value."
13852 (save-match-data
13853 (cond
13854 ((string= s "<now>") (float-time))
13855 ((string= s "<today>") (org-time-today))
13856 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13857 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13859 (+ (org-time-today)
13860 (* (string-to-number (match-string 1 s))
13861 (cdr (assoc (match-string 2 s)
13862 '(("d" . 86400.0) ("w" . 604800.0)
13863 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13864 (t (org-2ft s)))))
13866 (defun org-match-any-p (re list)
13867 "Does re match any element of list?"
13868 (setq list (mapcar (lambda (x) (string-match re x)) list))
13869 (delq nil list))
13871 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13872 (defvar org-tags-overlay (make-overlay 1 1))
13873 (org-detach-overlay org-tags-overlay)
13875 (defun org-get-local-tags-at (&optional pos)
13876 "Get a list of tags defined in the current headline."
13877 (org-get-tags-at pos 'local))
13879 (defun org-get-local-tags ()
13880 "Get a list of tags defined in the current headline."
13881 (org-get-tags-at nil 'local))
13883 (defun org-get-tags-at (&optional pos local)
13884 "Get a list of all headline tags applicable at POS.
13885 POS defaults to point. If tags are inherited, the list contains
13886 the targets in the same sequence as the headlines appear, i.e.
13887 the tags of the current headline come last.
13888 When LOCAL is non-nil, only return tags from the current headline,
13889 ignore inherited ones."
13890 (interactive)
13891 (if (and org-trust-scanner-tags
13892 (or (not pos) (equal pos (point)))
13893 (not local))
13894 org-scanner-tags
13895 (let (tags ltags lastpos parent)
13896 (save-excursion
13897 (save-restriction
13898 (widen)
13899 (goto-char (or pos (point)))
13900 (save-match-data
13901 (catch 'done
13902 (condition-case nil
13903 (progn
13904 (org-back-to-heading t)
13905 (while (not (equal lastpos (point)))
13906 (setq lastpos (point))
13907 (when (looking-at
13909 (setq ltags (org-split-string
13910 (org-match-string-no-properties 1) ":"))
13911 (when parent
13912 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13913 (setq tags (append
13914 (if parent
13915 (org-remove-uninherited-tags ltags)
13916 ltags)
13917 tags)))
13918 (or org-use-tag-inheritance (throw 'done t))
13919 (if local (throw 'done t))
13920 (or (org-up-heading-safe) (error nil))
13921 (setq parent t)))
13922 (error nil)))))
13923 (if local
13924 tags
13925 (reverse (delete-dups
13926 (reverse (append
13927 (org-remove-uninherited-tags
13928 org-file-tags) tags)))))))))
13930 (defun org-add-prop-inherited (s)
13931 (add-text-properties 0 (length s) '(inherited t) s)
13932 s)
13934 (defun org-toggle-tag (tag &optional onoff)
13935 "Toggle the tag TAG for the current line.
13936 If ONOFF is `on' or `off', don't toggle but set to this state."
13937 (let (res current)
13938 (save-excursion
13939 (org-back-to-heading t)
13941 (point-at-eol) t)
13942 (progn
13943 (setq current (match-string 1))
13944 (replace-match ""))
13945 (setq current ""))
13946 (setq current (nreverse (org-split-string current ":")))
13947 (cond
13948 ((eq onoff 'on)
13949 (setq res t)
13950 (or (member tag current) (push tag current)))
13951 ((eq onoff 'off)
13952 (or (not (member tag current)) (setq current (delete tag current))))
13953 (t (if (member tag current)
13954 (setq current (delete tag current))
13955 (setq res t)
13956 (push tag current))))
13957 (end-of-line 1)
13958 (if current
13959 (progn
13960 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13961 (org-set-tags nil t))
13962 (delete-horizontal-space))
13963 (run-hooks 'org-after-tags-change-hook))
13964 res))
13966 (defun org-align-tags-here (to-col)
13967 ;; Assumes that this is a headline
13968 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13969 (beginning-of-line 1)
13971 (< pos (match-beginning 2)))
13972 (progn
13973 (setq tags-l (- (match-end 2) (match-beginning 2)))
13974 (goto-char (match-beginning 1))
13975 (insert " ")
13976 (delete-region (point) (1+ (match-beginning 2)))
13977 (setq ncol (max (current-column)
13978 (1+ col)
13979 (if (> to-col 0)
13980 to-col
13981 (- (abs to-col) tags-l))))
13982 (setq p (point))
13983 (insert (make-string (- ncol (current-column)) ?\ ))
13984 (setq ncol (current-column))
13985 (when indent-tabs-mode (tabify p (point-at-eol)))
13986 (org-move-to-column (min ncol col) t))
13987 (goto-char pos))))
13989 (defun org-set-tags-command (&optional arg just-align)
13990 "Call the set-tags command for the current entry."
13991 (interactive "P")
13992 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13993 (org-set-tags arg just-align)
13994 (save-excursion
13995 (unless (and (org-region-active-p)
13996 org-loop-over-headlines-in-active-region)
13997 (org-back-to-heading t))
13998 (org-set-tags arg just-align))))
14000 (defun org-set-tags-to (data)
14001 "Set the tags of the current entry to DATA, replacing the current tags.
14002 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14003 If DATA is nil or the empty string, any tags will be removed."
14004 (interactive "sTags: ")
14005 (setq data
14006 (cond
14007 ((eq data nil) "")
14008 ((equal data "") "")
14009 ((stringp data)
14010 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14011 ":"))
14012 ((listp data)
14013 (concat ":" (mapconcat 'identity data ":") ":"))))
14014 (when data
14015 (save-excursion
14016 (org-back-to-heading t)
14017 (when (looking-at org-complex-heading-regexp)
14018 (if (match-end 5)
14019 (progn
14020 (goto-char (match-beginning 5))
14021 (insert data)
14022 (delete-region (point) (point-at-eol))
14023 (org-set-tags nil 'align))
14024 (goto-char (point-at-eol))
14025 (insert " " data)
14026 (org-set-tags nil 'align)))
14027 (beginning-of-line 1)
14029 (delete-region (match-beginning 1) (match-end 1))))))
14031 (defun org-align-all-tags ()
14032 "Align the tags i all headings."
14033 (interactive)
14034 (save-excursion
14035 (or (ignore-errors (org-back-to-heading t))
14036 (outline-next-heading))
14037 (if (org-at-heading-p)
14038 (org-set-tags t)
14039 (message "No headings"))))
14041 (defvar org-indent-indentation-per-level)
14042 (defun org-set-tags (&optional arg just-align)
14043 "Set the tags for the current headline.
14044 With prefix ARG, realign all tags in headings in the current buffer."
14045 (interactive "P")
14046 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14047 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14048 'region-start-level 'region))
14049 org-loop-over-headlines-in-active-region)
14050 (org-map-entries
14051 ;; We don't use ARG and JUST-ALIGN here these args are not
14052 ;; useful when looping over headlines
14053 `(org-set-tags)
14054 org-loop-over-headlines-in-active-region
14055 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14056 (let* ((re org-outline-regexp-bol)
14057 (current (unless arg (org-get-tags-string)))
14058 (col (current-column))
14059 (org-setting-tags t)
14060 table current-tags inherited-tags ; computed below when needed
14061 tags p0 c0 c1 rpl di tc level)
14062 (if arg
14063 (save-excursion
14064 (goto-char (point-min))
14065 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14066 (while (re-search-forward re nil t)
14067 (org-set-tags nil t)
14068 (end-of-line 1)))
14069 (message "All tags realigned to column %d" org-tags-column))
14070 (if just-align
14071 (setq tags current)
14072 ;; Get a new set of tags from the user
14073 (save-excursion
14074 (setq table (append org-tag-persistent-alist
14075 (or org-tag-alist (org-get-buffer-tags))
14076 (and
14077 org-complete-tags-always-offer-all-agenda-tags
14078 (org-global-tags-completion-table
14079 (org-agenda-files))))
14080 org-last-tags-completion-table table
14081 current-tags (org-split-string current ":")
14082 inherited-tags (nreverse
14083 (nthcdr (length current-tags)
14084 (nreverse (org-get-tags-at))))
14085 tags
14086 (if (or (eq t org-use-fast-tag-selection)
14087 (and org-use-fast-tag-selection
14088 (delq nil (mapcar 'cdr table))))
14089 (org-fast-tag-selection
14090 current-tags inherited-tags table
14091 (if org-fast-tag-selection-include-todo
14092 org-todo-key-alist))
14093 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14094 (org-trim
14095 (org-icompleting-read "Tags: "
14096 'org-tags-completion-function
14097 nil nil current 'org-tags-history))))))
14098 (while (string-match "[-+&]+" tags)
14099 ;; No boolean logic, just a list
14100 (setq tags (replace-match ":" t t tags))))
14102 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14104 (if org-tags-sort-function
14105 (setq tags (mapconcat 'identity
14106 (sort (org-split-string
14107 tags (org-re "[^[:alnum:]_@#%]+"))
14108 org-tags-sort-function) ":")))
14111 (setq tags "")
14112 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14113 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14115 ;; Insert new tags at the correct column
14116 (beginning-of-line 1)
14117 (setq level (or (and (looking-at org-outline-regexp)
14118 (- (match-end 0) (point) 1))
14119 1))
14120 (cond
14121 ((and (equal current "") (equal tags "")))
14122 ((re-search-forward
14124 (point-at-eol) t)
14125 (if (equal tags "")
14126 (setq rpl "")
14127 (goto-char (match-beginning 0))
14128 (setq c0 (current-column)
14129 ;; compute offset for the case of org-indent-mode active
14130 di (if org-indent-mode
14131 (* (1- org-indent-indentation-per-level) (1- level))
14132 0)
14133 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14134 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14135 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14136 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14137 (replace-match rpl t t)
14138 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14139 tags)
14140 (t (error "Tags alignment failed")))
14141 (org-move-to-column col)
14142 (unless just-align
14143 (run-hooks 'org-after-tags-change-hook))))))
14145 (defun org-change-tag-in-region (beg end tag off)
14146 "Add or remove TAG for each entry in the region.
14147 This works in the agenda, and also in an org-mode buffer."
14148 (interactive
14149 (list (region-beginning) (region-end)
14150 (let ((org-last-tags-completion-table
14151 (if (derived-mode-p 'org-mode)
14152 (org-get-buffer-tags)
14153 (org-global-tags-completion-table))))
14154 (org-icompleting-read
14155 "Tag: " 'org-tags-completion-function nil nil nil
14156 'org-tags-history))
14157 (progn
14159 (equal (read-char-exclusive) ?r))))
14160 (if (fboundp 'deactivate-mark) (deactivate-mark))
14161 (let ((agendap (equal major-mode 'org-agenda-mode))
14162 l1 l2 m buf pos newhead (cnt 0))
14163 (goto-char end)
14164 (setq l2 (1- (org-current-line)))
14165 (goto-char beg)
14166 (setq l1 (org-current-line))
14167 (loop for l from l1 to l2 do
14168 (org-goto-line l)
14169 (setq m (get-text-property (point) 'org-hd-marker))
14170 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14171 (and agendap m))
14172 (setq buf (if agendap (marker-buffer m) (current-buffer))
14173 pos (if agendap m (point)))
14174 (with-current-buffer buf
14175 (save-excursion
14176 (save-restriction
14177 (goto-char pos)
14178 (setq cnt (1+ cnt))
14179 (org-toggle-tag tag (if off 'off 'on))
14180 (setq newhead (org-get-heading)))))
14181 (and agendap (org-agenda-change-all-lines newhead m))))
14182 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14184 (defun org-tags-completion-function (string predicate &optional flag)
14185 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14186 (confirm (lambda (x) (stringp (car x)))))
14188 (setq s1 (match-string 1 string)
14189 s2 (match-string 2 string))
14190 (setq s1 "" s2 string))
14191 (cond
14192 ((eq flag nil)
14193 ;; try completion
14194 (setq rtn (try-completion s2 ctable confirm))
14195 (if (stringp rtn)
14196 (setq rtn
14197 (concat s1 s2 (substring rtn (length s2))
14198 (if (and org-add-colon-after-tag-completion
14199 (assoc rtn ctable))
14200 ":" ""))))
14201 rtn)
14202 ((eq flag t)
14203 ;; all-completions
14204 (all-completions s2 ctable confirm)
14205 )
14206 ((eq flag 'lambda)
14207 ;; exact match?
14208 (assoc s2 ctable)))
14209 ))
14211 (defun org-fast-tag-insert (kwd tags face &optional end)
14212 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
14213 (insert (format "%-12s" (concat kwd ":"))
14214 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14215 (or end "")))
14217 (defun org-fast-tag-show-exit (flag)
14218 (save-excursion
14219 (org-goto-line 3)
14221 (replace-match ""))
14222 (when flag
14223 (end-of-line 1)
14224 (org-move-to-column (- (window-width) 19) t)
14225 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14227 (defun org-set-current-tags-overlay (current prefix)
14228 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14229 (if (featurep 'xemacs)
14230 (org-overlay-display org-tags-overlay (concat prefix s)
14231 'secondary-selection)
14232 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14233 (org-overlay-display org-tags-overlay (concat prefix s)))))
14235 (defvar org-last-tag-selection-key nil)
14236 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14237 "Fast tag selection with single keys.
14238 CURRENT is the current list of tags in the headline, INHERITED is the
14239 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14240 possibly with grouping information. TODO-TABLE is a similar table with
14241 TODO keywords, should these have keys assigned to them.
14242 If the keys are nil, a-z are automatically assigned.
14243 Returns the new tags string, or nil to not change the current settings."
14244 (let* ((fulltable (append table todo-table))
14245 (maxlen (apply 'max (mapcar
14246 (lambda (x)
14247 (if (stringp (car x)) (string-width (car x)) 0))
14248 fulltable)))
14249 (buf (current-buffer))
14250 (expert (eq org-fast-tag-selection-single-key 'expert))
14251 (buffer-tags nil)
14252 (fwidth (+ maxlen 3 1 3))
14253 (ncol (/ (- (window-width) 4) fwidth))
14254 (i-face 'org-done)
14255 (c-face 'org-todo)
14256 tg cnt e c char c1 c2 ntable tbl rtn
14257 ov-start ov-end ov-prefix
14258 (exit-after-next org-fast-tag-selection-single-key)
14259 (done-keywords org-done-keywords)
14260 groups ingroup)
14261 (save-excursion
14262 (beginning-of-line 1)
14263 (if (looking-at
14265 (setq ov-start (match-beginning 1)
14266 ov-end (match-end 1)
14267 ov-prefix "")
14268 (setq ov-start (1- (point-at-eol))
14269 ov-end (1+ ov-start))
14271 (setq ov-prefix
14272 (concat
14273 (buffer-substring (1- (point)) (point))
14274 (if (> (current-column) org-tags-column)
14275 " "
14276 (make-string (- org-tags-column (current-column)) ?\ ))))))
14277 (move-overlay org-tags-overlay ov-start ov-end)
14278 (save-window-excursion
14279 (if expert
14280 (set-buffer (get-buffer-create " *Org tags*"))
14281 (delete-other-windows)
14282 (split-window-vertically)
14283 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14284 (erase-buffer)
14285 (org-set-local 'org-done-keywords done-keywords)
14288 (org-fast-tag-show-exit exit-after-next)
14289 (org-set-current-tags-overlay current ov-prefix)
14290 (setq tbl fulltable char ?a cnt 0)
14291 (while (setq e (pop tbl))
14292 (cond
14293 ((equal (car e) :startgroup)
14294 (push '() groups) (setq ingroup t)
14295 (when (not (= cnt 0))
14296 (setq cnt 0)
14298 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14299 ((equal (car e) :endgroup)
14300 (setq ingroup nil cnt 0)
14302 ((equal e '(:newline))
14303 (when (not (= cnt 0))
14304 (setq cnt 0)
14306 (setq e (car tbl))
14307 (while (equal (car tbl) '(:newline))
14309 (setq tbl (cdr tbl)))))
14310 (t
14311 (setq tg (copy-sequence (car e)) c2 nil)
14312 (if (cdr e)
14313 (setq c (cdr e))
14314 ;; automatically assign a character.
14315 (setq c1 (string-to-char
14316 (downcase (substring
14317 tg (if (= (string-to-char tg) ?@) 1 0)))))
14318 (if (or (rassoc c1 ntable) (rassoc c1 table))
14319 (while (or (rassoc char ntable) (rassoc char table))
14320 (setq char (1+ char)))
14321 (setq c2 c1))
14322 (setq c (or c2 char)))
14323 (if ingroup (push tg (car groups)))
14324 (setq tg (org-add-props tg nil 'face
14325 (cond
14326 ((not (assoc tg table))
14327 (org-get-todo-face tg))
14328 ((member tg current) c-face)
14329 ((member tg inherited) i-face))))
14330 (if (and (= cnt 0) (not ingroup)) (insert " "))
14331 (insert "[" c "] " tg (make-string
14332 (- fwidth 4 (length tg)) ?\ ))
14333 (push (cons tg c) ntable)
14334 (when (= (setq cnt (1+ cnt)) ncol)
14336 (if ingroup (insert " "))
14337 (setq cnt 0)))))
14338 (setq ntable (nreverse ntable))
14340 (goto-char (point-min))
14341 (if (not expert) (org-fit-window-to-buffer))
14342 (setq rtn
14343 (catch 'exit
14344 (while t
14345 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14346 (if (not groups) "no " "")
14347 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14348 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14349 (setq org-last-tag-selection-key c)
14350 (cond
14352 ((= c ?!)
14353 (setq groups (not groups))
14354 (goto-char (point-min))
14355 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14356 ((= c ?\C-c)
14357 (if (not expert)
14358 (org-fast-tag-show-exit
14359 (setq exit-after-next (not exit-after-next)))
14360 (setq expert nil)
14361 (delete-other-windows)
14362 (set-window-buffer (split-window-vertically) " *Org tags*")
14363 (org-switch-to-buffer-other-window " *Org tags*")
14364 (org-fit-window-to-buffer)))
14365 ((or (= c ?\C-g)
14366 (and (= c ?q) (not (rassoc c ntable))))
14367 (org-detach-overlay org-tags-overlay)
14368 (setq quit-flag t))
14369 ((= c ?\ )
14370 (setq current nil)
14371 (if exit-after-next (setq exit-after-next 'now)))
14373 (condition-case nil
14374 (setq tg (org-icompleting-read
14375 "Tag: "
14376 (or buffer-tags
14377 (with-current-buffer buf
14378 (org-get-buffer-tags)))))
14379 (quit (setq tg "")))
14381 (add-to-list 'buffer-tags (list tg))
14382 (if (member tg current)
14383 (setq current (delete tg current))
14384 (push tg current)))
14385 (if exit-after-next (setq exit-after-next 'now)))
14386 ((setq e (rassoc c todo-table) tg (car e))
14387 (with-current-buffer buf
14388 (save-excursion (org-todo tg)))
14389 (if exit-after-next (setq exit-after-next 'now)))
14390 ((setq e (rassoc c ntable) tg (car e))
14391 (if (member tg current)
14392 (setq current (delete tg current))
14393 (loop for g in groups do
14394 (if (member tg g)
14395 (mapc (lambda (x)
14396 (setq current (delete x current)))
14397 g)))
14398 (push tg current))
14399 (if exit-after-next (setq exit-after-next 'now))))
14401 ;; Create a sorted list
14402 (setq current
14403 (sort current
14404 (lambda (a b)
14405 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14406 (if (eq exit-after-next 'now) (throw 'exit t))
14407 (goto-char (point-min))
14408 (beginning-of-line 2)
14409 (delete-region (point) (point-at-eol))
14410 (org-fast-tag-insert "Current" current c-face)
14411 (org-set-current-tags-overlay current ov-prefix)
14412 (while (re-search-forward
14414 (setq tg (match-string 1))
14415 (add-text-properties
14416 (match-beginning 1) (match-end 1)
14417 (list 'face
14418 (cond
14419 ((member tg current) c-face)
14420 ((member tg inherited) i-face)
14421 (t (get-text-property (match-beginning 1) 'face))))))
14422 (goto-char (point-min)))))
14423 (org-detach-overlay org-tags-overlay)
14424 (if rtn
14425 (mapconcat 'identity current ":")
14426 nil))))
14428 (defun org-get-tags-string ()
14429 "Get the TAGS string in the current headline."
14430 (unless (org-at-heading-p t)
14431 (error "Not on a heading"))
14432 (save-excursion
14433 (beginning-of-line 1)
14435 (org-match-string-no-properties 1)
14436 "")))
14438 (defun org-get-tags ()
14439 "Get the list of tags specified in the current headline."
14440 (org-split-string (org-get-tags-string) ":"))
14442 (defun org-get-buffer-tags ()
14443 "Get a table of all tags used in the buffer, for completion."
14444 (let (tags)
14445 (save-excursion
14446 (goto-char (point-min))
14447 (while (re-search-forward
14449 (when (equal (char-after (point-at-bol 0)) ?*)
14450 (mapc (lambda (x) (add-to-list 'tags x))
14451 (org-split-string (org-match-string-no-properties 1) ":")))))
14452 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14453 (mapcar 'list tags)))
14455 ;;;; The mapping API
14457 (defun org-map-entries (func &optional match scope &rest skip)
14458 "Call FUNC at each headline selected by MATCH in SCOPE.
14460 FUNC is a function or a lisp form. The function will be called without
14461 arguments, with the cursor positioned at the beginning of the headline.
14462 The return values of all calls to the function will be collected and
14463 returned as a list.
14465 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14466 does not need to preserve point. After evaluation, the cursor will be
14467 moved to the end of the line (presumably of the headline of the
14468 processed entry) and search continues from there. Under some
14469 circumstances, this may not produce the wanted results. For example,
14470 if you have removed (e.g. archived) the current (sub)tree it could
14471 mean that the next entry will be skipped entirely. In such cases, you
14472 can specify the position from where search should continue by making
14473 FUNC set the variable `org-map-continue-from' to the desired buffer
14474 position.
14476 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14477 Only headlines that are matched by this query will be considered during
14478 the iteration. When MATCH is nil or t, all headlines will be
14479 visited by the iteration.
14481 SCOPE determines the scope of this command. It can be any of:
14483 nil The current buffer, respecting the restriction if any
14484 tree The subtree started with the entry at point
14485 region The entries within the active region, if any
14486 region-start-level
14487 The entries within the active region, but only those at
14488 the same level than the first one.
14489 file The current buffer, without restriction
14490 file-with-archives
14491 The current buffer, and any archives associated with it
14492 agenda All agenda files
14493 agenda-with-archives
14494 All agenda files with any archive files associated with them
14495 \(file1 file2 ...)
14496 If this is a list, all files in the list will be scanned
14498 The remaining args are treated as settings for the skipping facilities of
14499 the scanner. The following items can be given here:
14501 archive skip trees with the archive tag.
14502 comment skip trees with the COMMENT keyword
14503 function or Emacs Lisp form:
14504 will be used as value for `org-agenda-skip-function', so whenever
14505 the function returns t, FUNC will not be called for that
14506 entry and search will continue from the point where the
14507 function leaves it.
14509 If your function needs to retrieve the tags including inherited tags
14510 at the *current* entry, you can use the value of the variable
14511 `org-scanner-tags' which will be much faster than getting the value
14512 with `org-get-tags-at'. If your function gets properties with
14513 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14514 to t around the call to `org-entry-properties' to get the same speedup.
14515 Note that if your function moves around to retrieve tags and properties at
14516 a *different* entry, you cannot use these techniques."
14517 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14518 (not (org-region-active-p)))
14519 (let* ((org-agenda-archives-mode nil) ; just to make sure
14520 (org-agenda-skip-archived-trees (memq 'archive skip))
14521 (org-agenda-skip-comment-trees (memq 'comment skip))
14522 (org-agenda-skip-function
14523 (car (org-delete-all '(comment archive) skip)))
14524 (org-tags-match-list-sublevels t)
14525 (start-level (eq scope 'region-start-level))
14526 matcher file res
14527 org-todo-keywords-for-agenda
14528 org-done-keywords-for-agenda
14529 org-todo-keyword-alist-for-agenda
14530 org-drawers-for-agenda
14531 org-tag-alist-for-agenda
14532 todo-only)
14534 (cond
14535 ((eq match t) (setq matcher t))
14536 ((eq match nil) (setq matcher t))
14537 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14539 (save-excursion
14540 (save-restriction
14541 (cond ((eq scope 'tree)
14542 (org-back-to-heading t)
14543 (org-narrow-to-subtree)
14544 (setq scope nil))
14545 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14546 (org-region-active-p))
14547 ;; If needed, set start-level to a string like "2"
14548 (when start-level
14549 (save-excursion
14550 (goto-char (region-beginning))
14551 (unless (org-at-heading-p) (outline-next-heading))
14552 (setq start-level (org-current-level))))
14553 (narrow-to-region (region-beginning)
14554 (save-excursion
14555 (goto-char (region-end))
14556 (unless (and (bolp) (org-at-heading-p))
14557 (outline-next-heading))
14558 (point)))
14559 (setq scope nil)))
14561 (if (not scope)
14562 (progn
14563 (org-agenda-prepare-buffers
14564 (list (buffer-file-name (current-buffer))))
14565 (setq res (org-scan-tags func matcher todo-only start-level)))
14566 ;; Get the right scope
14567 (cond
14568 ((and scope (listp scope) (symbolp (car scope)))
14569 (setq scope (eval scope)))
14570 ((eq scope 'agenda)
14571 (setq scope (org-agenda-files t)))
14572 ((eq scope 'agenda-with-archives)
14573 (setq scope (org-agenda-files t))
14574 (setq scope (org-add-archive-files scope)))
14575 ((eq scope 'file)
14576 (setq scope (list (buffer-file-name))))
14577 ((eq scope 'file-with-archives)
14578 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14579 (org-agenda-prepare-buffers scope)
14580 (while (setq file (pop scope))
14581 (with-current-buffer (org-find-base-buffer-visiting file)
14582 (save-excursion
14583 (save-restriction
14584 (widen)
14585 (goto-char (point-min))
14586 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14587 res)))
14589 ;;;; Properties
14591 ;;; Setting and retrieving properties
14593 (defconst org-special-properties
14594 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14595 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14596 "The special properties valid in Org-mode.
14598 These are properties that are not defined in the property drawer,
14599 but in some other way.")
14601 (defconst org-default-properties
14602 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14603 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14604 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14605 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14606 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14607 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14608 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14609 "Some properties that are used by Org-mode for various purposes.
14610 Being in this list makes sure that they are offered for completion.")
14613 "Regular expression matching the first line of a property drawer.")
14616 "Regular expression matching the last line of a property drawer.")
14619 "Regular expression matching the first line of a property drawer.")
14622 "Regular expression matching the first line of a property drawer.")
14624 (defconst org-property-drawer-re
14627 "Matches an entire property drawer.")
14629 (defconst org-clock-drawer-re
14632 "Matches an entire clock drawer.")
14634 (defsubst org-re-property (property)
14635 "Return a regexp matching a PROPERTY line.
14636 Match group 1 will be set to the value."
14639 (defsubst org-re-property-keyword (property)
14640 "Return a regexp matching a PROPERTY line, possibly with no
14641 value for the property."
14644 (defun org-property-action ()
14645 "Do an action on properties."
14646 (interactive)
14647 (let (c)
14648 (org-at-property-p)
14649 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14650 (setq c (read-char-exclusive))
14651 (cond
14652 ((equal c ?s)
14653 (call-interactively 'org-set-property))
14654 ((equal c ?d)
14655 (call-interactively 'org-delete-property))
14656 ((equal c ?D)
14657 (call-interactively 'org-delete-property-globally))
14658 ((equal c ?c)
14659 (call-interactively 'org-compute-property-at-point))
14660 (t (error "No such property action %c" c)))))
14662 (defun org-inc-effort ()
14663 "Increment the value of the effort property in the current entry."
14664 (interactive)
14665 (org-set-effort nil t))
14667 (defvar org-clock-effort) ;; Defined in org-clock.el
14668 (defvar org-clock-current-task) ;; Defined in org-clock.el
14669 (defun org-set-effort (&optional value increment)
14670 "Set the effort property of the current entry.
14671 With numerical prefix arg, use the nth allowed value, 0 stands for the
14672 10th allowed value.
14674 When INCREMENT is non-nil, set the property to the next allowed value."
14675 (interactive "P")
14676 (if (equal value 0) (setq value 10))
14677 (let* ((completion-ignore-case t)
14678 (prop org-effort-property)
14679 (cur (org-entry-get nil prop))
14680 (allowed (org-property-get-allowed-values nil prop 'table))
14681 (existing (mapcar 'list (org-property-values prop)))
14682 (heading (nth 4 (org-heading-components)))
14683 rpl
14684 (val (cond
14685 ((stringp value) value)
14686 ((and allowed (integerp value))
14687 (or (car (nth (1- value) allowed))
14688 (car (org-last allowed))))
14689 ((and allowed increment)
14690 (or (caadr (member (list cur) allowed))
14691 (error "Allowed effort values are not set")))
14692 (allowed
14693 (message "Select 1-9,0, [RET%s]: %s"
14694 (if cur (concat "=" cur) "")
14695 (mapconcat 'car allowed " "))
14696 (setq rpl (read-char-exclusive))
14698 cur
14699 (setq rpl (- rpl ?0))
14700 (if (equal rpl 0) (setq rpl 10))
14701 (if (and (> rpl 0) (<= rpl (length allowed)))
14702 (car (nth (1- rpl) allowed))
14703 (org-completing-read "Effort: " allowed nil))))
14704 (t
14705 (let (org-completion-use-ido org-completion-use-iswitchb)
14706 (org-completing-read
14708 (concat "[" cur "]") "")
14709 ": ")
14710 existing nil nil "" nil cur))))))
14711 (unless (equal (org-entry-get nil prop) val)
14712 (org-entry-put nil prop val))
14713 (save-excursion
14714 (org-back-to-heading t)
14715 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
14716 (when (string= heading org-clock-current-task)
14717 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
14718 (org-clock-update-mode-line))
14719 (message "%s is now %s" prop val)))
14721 (defun org-at-property-p ()
14722 "Is cursor inside a property drawer?"
14723 (save-excursion
14724 (beginning-of-line 1)
14726 (save-match-data ;; Used by calling procedures
14727 (let ((p (point))
14728 (range (unless (org-before-first-heading-p)
14729 (org-get-property-block))))
14730 (and range (<= (car range) p) (< p (cdr range))))))))
14732 (defun org-get-property-block (&optional beg end force)
14733 "Return the (beg . end) range of the body of the property drawer.
14734 BEG and END are the beginning and end of the current subtree, or of
14735 the part before the first headline. If they are not given, they will
14736 be found. If the drawer does not exist and FORCE is non-nil, create
14737 the drawer."
14738 (catch 'exit
14739 (save-excursion
14740 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14741 (progn (org-back-to-heading t) (point))))
14742 (end (or end (and (not (outline-next-heading)) (point-max))
14743 (point))))
14744 (goto-char beg)
14745 (if (re-search-forward org-property-start-re end t)
14746 (setq beg (1+ (match-end 0)))
14747 (if force
14748 (save-excursion
14749 (org-insert-property-drawer)
14750 (setq end (progn (outline-next-heading) (point))))
14751 (throw 'exit nil))
14752 (goto-char beg)
14753 (if (re-search-forward org-property-start-re end t)
14754 (setq beg (1+ (match-end 0)))))
14755 (if (re-search-forward org-property-end-re end t)
14756 (setq end (match-beginning 0))
14757 (or force (throw 'exit nil))
14758 (goto-char beg)
14759 (setq end beg)
14760 (org-indent-line)
14762 (cons beg end)))))
14764 (defun org-entry-properties (&optional pom which specific)
14765 "Get all properties of the entry at point-or-marker POM.
14766 This includes the TODO keyword, the tags, time strings for deadline,
14767 scheduled, and clocking, and any additional properties defined in the
14768 entry. The return value is an alist, keys may occur multiple times
14769 if the property key was used several times.
14770 POM may also be nil, in which case the current entry is used.
14771 If WHICH is nil or `all', get all properties. If WHICH is
14772 `special' or `standard', only get that subclass. If WHICH
14773 is a string only get exactly this property. SPECIFIC can be a string, the
14774 specific property we are interested in. Specifying it can speed
14775 things up because then unnecessary parsing is avoided."
14776 (setq which (or which 'all))
14777 (org-with-point-at pom
14778 (let ((clockstr (substring org-clock-string 0 -1))
14779 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14780 (case-fold-search nil)
14781 beg end range props sum-props key key1 value string clocksum clocksumt)
14782 (save-excursion
14783 (when (condition-case nil
14784 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14785 (error nil))
14786 (setq beg (point))
14787 (setq sum-props (get-text-property (point) 'org-summaries))
14788 (setq clocksum (get-text-property (point) :org-clock-minutes)
14789 clocksumt (get-text-property (point) :org-clock-minutes-today))
14790 (outline-next-heading)
14791 (setq end (point))
14792 (when (memq which '(all special))
14793 ;; Get the special properties, like TODO and tags
14794 (goto-char beg)
14795 (when (and (or (not specific) (string= specific "TODO"))
14796 (looking-at org-todo-line-regexp) (match-end 2))
14797 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14798 (when (and (or (not specific) (string= specific "PRIORITY"))
14799 (looking-at org-priority-regexp))
14800 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14801 (when (or (not specific) (string= specific "FILE"))
14802 (push (cons "FILE" buffer-file-name) props))
14803 (when (and (or (not specific) (string= specific "TAGS"))
14804 (setq value (org-get-tags-string))
14806 (push (cons "TAGS" value) props))
14807 (when (and (or (not specific) (string= specific "ALLTAGS"))
14808 (setq value (org-get-tags-at)))
14809 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14810 ":"))
14811 props))
14812 (when (or (not specific) (string= specific "BLOCKED"))
14813 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14814 (when (or (not specific)
14815 (member specific
14816 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14817 "TIMESTAMP" "TIMESTAMP_IA")))
14818 (catch 'match
14819 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14820 (setq key (if (match-end 1)
14821 (substring (org-match-string-no-properties 1)
14822 0 -1))
14823 string (if (equal key clockstr)
14824 (org-trim
14825 (buffer-substring-no-properties
14826 (match-beginning 3) (goto-char
14827 (point-at-eol))))
14828 (substring (org-match-string-no-properties 3)
14829 1 -1)))
14830 ;; Get the correct property name from the key. This is
14831 ;; necessary if the user has configured time keywords.
14832 (setq key1 (concat key ":"))
14833 (cond
14834 ((not key)
14835 (setq key
14836 (if (= (char-after (match-beginning 3)) ?\[)
14837 "TIMESTAMP_IA" "TIMESTAMP")))
14838 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14839 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14840 ((equal key1 org-closed-string) (setq key "CLOSED"))
14841 ((equal key1 org-clock-string) (setq key "CLOCK")))
14842 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14843 (progn
14844 (push (cons key string) props)
14845 ;; no need to search further if match is found
14846 (throw 'match t))
14847 (when (or (equal key "CLOCK") (not (assoc key props)))
14848 (push (cons key string) props)))))))
14850 (when (memq which '(all standard))
14851 ;; Get the standard properties, like :PROP: ...
14852 (setq range (org-get-property-block beg end))
14853 (when range
14854 (goto-char (car range))
14855 (while (re-search-forward
14857 (cdr range) t)
14858 (setq key (org-match-string-no-properties 1)
14859 value (org-trim (or (org-match-string-no-properties 2) "")))
14860 (unless (member key excluded)
14861 (push (cons key (or value "")) props)))))
14862 (if clocksum
14863 (push (cons "CLOCKSUM"
14864 (org-columns-number-to-string (/ (float clocksum) 60.)
14865 'add_times))
14866 props))
14867 (if clocksumt
14868 (push (cons "CLOCKSUM_T"
14869 (org-columns-number-to-string (/ (float clocksumt) 60.)
14870 'add_times))
14871 props))
14872 (unless (assoc "CATEGORY" props)
14873 (push (cons "CATEGORY" (org-get-category)) props))
14874 (append sum-props (nreverse props)))))))
14876 (defun org-entry-get (pom property &optional inherit literal-nil)
14877 "Get value of PROPERTY for entry or content at point-or-marker POM.
14878 If INHERIT is non-nil and the entry does not have the property,
14879 then also check higher levels of the hierarchy.
14880 If INHERIT is the symbol `selective', use inheritance only if the setting
14881 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14882 If the property is present but empty, the return value is the empty string.
14883 If the property is not present at all, nil is returned.
14886 do not interpret it as the list atom nil. This is used for inheritance
14888 (org-with-point-at pom
14889 (if (and inherit (if (eq inherit 'selective)
14890 (org-property-inherit-p property)
14891 t))
14892 (org-entry-get-with-inheritance property literal-nil)
14893 (if (member property org-special-properties)
14894 ;; We need a special property. Use `org-entry-properties' to
14895 ;; retrieve it, but specify the wanted property
14896 (cdr (assoc property (org-entry-properties nil 'special property)))
14897 (let ((range (org-get-property-block)))
14898 (when (and range (not (eq (car range) (cdr range))))
14899 (let* ((props (list (or (assoc property org-file-properties)
14900 (assoc property org-global-properties)
14901 (assoc property org-global-properties-fixed))))
14902 (ap (lambda (key)
14903 (when (re-search-forward
14904 (org-re-property key) (cdr range) t)
14905 (setq props
14906 (org-update-property-plist
14907 key
14908 (if (match-end 1)
14909 (org-match-string-no-properties 1) "")
14910 props)))))
14911 val)
14912 (goto-char (car range))
14913 (funcall ap property)
14914 (goto-char (car range))
14915 (while (funcall ap (concat property "+")))
14916 (setq val (cdr (assoc property props)))
14917 (when val (if literal-nil val (org-not-nil val))))))))))
14919 (defun org-property-or-variable-value (var &optional inherit)
14920 "Check if there is a property fixing the value of VAR.
14921 If yes, return this value. If not, return the current value of the variable."
14922 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14924 (read prop)
14925 (symbol-value var))))
14927 (defun org-entry-delete (pom property &optional delete-empty-drawer)
14928 "Delete the property PROPERTY from entry at point-or-marker POM.
14929 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
14930 an empty drawer to delete."
14931 (org-with-point-at pom
14932 (if (member property org-special-properties)
14933 nil ; cannot delete these properties.
14934 (let ((range (org-get-property-block)))
14935 (if (and range
14936 (goto-char (car range))
14937 (re-search-forward
14938 (org-re-property property)
14939 (cdr range) t))
14940 (progn
14941 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14942 (and delete-empty-drawer
14943 (org-remove-empty-drawer-at
14944 delete-empty-drawer (car range)))
14945 t)
14946 nil)))))
14948 ;; Multi-values properties are properties that contain multiple values
14949 ;; These values are assumed to be single words, separated by whitespace.
14950 (defun org-entry-add-to-multivalued-property (pom property value)
14951 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14952 (let* ((old (org-entry-get pom property))
14954 (setq value (org-entry-protect-space value))
14955 (unless (member value values)
14956 (setq values (cons value values))
14957 (org-entry-put pom property
14958 (mapconcat 'identity values " ")))))
14960 (defun org-entry-remove-from-multivalued-property (pom property value)
14961 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14962 (let* ((old (org-entry-get pom property))
14964 (setq value (org-entry-protect-space value))
14965 (when (member value values)
14966 (setq values (delete value values))
14967 (org-entry-put pom property
14968 (mapconcat 'identity values " ")))))
14970 (defun org-entry-member-in-multivalued-property (pom property value)
14971 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14972 (let* ((old (org-entry-get pom property))
14974 (setq value (org-entry-protect-space value))
14975 (member value values)))
14977 (defun org-entry-get-multivalued-property (pom property)
14978 "Return a list of values in a multivalued property."
14979 (let* ((value (org-entry-get pom property))
14981 (mapcar 'org-entry-restore-space values)))
14983 (defun org-entry-put-multivalued-property (pom property &rest values)
14984 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14985 VALUES should be a list of strings. Spaces will be protected."
14986 (org-entry-put pom property
14987 (mapconcat 'org-entry-protect-space values " "))
14988 (let* ((value (org-entry-get pom property))
14990 (mapcar 'org-entry-restore-space values)))
14992 (defun org-entry-protect-space (s)
14993 "Protect spaces and newline in string S."
14994 (while (string-match " " s)
14995 (setq s (replace-match "%20" t t s)))
14997 (setq s (replace-match "%0A" t t s)))
14998 s)
15000 (defun org-entry-restore-space (s)
15001 "Restore spaces and newline in string S."
15002 (while (string-match "%20" s)
15003 (setq s (replace-match " " t t s)))
15004 (while (string-match "%0A" s)
15006 s)
15008 (defvar org-entry-property-inherited-from (make-marker)
15009 "Marker pointing to the entry from where a property was inherited.
15010 Each call to `org-entry-get-with-inheritance' will set this marker to the
15011 location of the entry where the inheritance search matched. If there was
15012 no match, the marker will point nowhere.
15013 Note that also `org-entry-get' calls this function, if the INHERIT flag
15014 is set.")
15016 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15017 "Get PROPERTY of entry or content at point, search higher levels if needed.
15018 The search will stop at the first ancestor which has the property defined.
15020 should be considered as undefined (this is the meaning of nil here).
15022 (move-marker org-entry-property-inherited-from nil)
15023 (let (tmp)
15024 (save-excursion
15025 (save-restriction
15026 (widen)
15027 (catch 'ex
15028 (while t
15029 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15030 (or (ignore-errors (org-back-to-heading t))
15031 (goto-char (point-min)))
15032 (move-marker org-entry-property-inherited-from (point))
15033 (throw 'ex tmp))
15034 (or (ignore-errors (org-up-heading-safe))
15035 (throw 'ex nil))))))
15036 (setq tmp (or tmp
15037 (cdr (assoc property org-file-properties))
15038 (cdr (assoc property org-global-properties))
15039 (cdr (assoc property org-global-properties-fixed))))
15040 (if literal-nil tmp (org-not-nil tmp))))
15042 (defvar org-property-changed-functions nil
15043 "Hook called when the value of a property has changed.
15044 Each hook function should accept two arguments, the name of the property
15045 and the new value.")
15047 (defun org-entry-put (pom property value)
15048 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15049 (org-with-point-at pom
15050 (org-back-to-heading t)
15051 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15052 range)
15053 (cond
15054 ((equal property "TODO")
15056 (not (member value org-todo-keywords-1)))
15058 (if (or (not value)
15060 (setq value 'none))
15061 (org-todo value)
15062 (org-set-tags nil 'align))
15063 ((equal property "PRIORITY")
15065 (string-to-char value) ?\ ))
15066 (org-set-tags nil 'align))
15067 ((equal property "CLOCKSUM")
15068 (if (not (re-search-forward
15070 (error "Cannot find a clock log")
15071 (goto-char (- (match-end 1) 2))
15072 (cond
15073 ((eq value 'earlier) (org-timestamp-down))
15074 ((eq value 'later) (org-timestamp-up)))
15075 (org-clock-sum-current-item)))
15076 ((equal property "SCHEDULED")
15077 (if (re-search-forward org-scheduled-time-regexp end t)
15078 (cond
15079 ((eq value 'earlier) (org-timestamp-change -1 'day))
15080 ((eq value 'later) (org-timestamp-change 1 'day))
15081 (t (call-interactively 'org-schedule)))
15082 (call-interactively 'org-schedule)))
15083 ((equal property "DEADLINE")
15084 (if (re-search-forward org-deadline-time-regexp end t)
15085 (cond
15086 ((eq value 'earlier) (org-timestamp-change -1 'day))
15087 ((eq value 'later) (org-timestamp-change 1 'day))
15088 (t (call-interactively 'org-deadline)))
15089 (call-interactively 'org-deadline)))
15090 ((member property org-special-properties)
15091 (error "The %s property can not yet be set with `org-entry-put'"
15092 property))
15093 (t ; a non-special property
15094 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15095 (setq range (org-get-property-block beg end 'force))
15096 (goto-char (car range))
15097 (if (re-search-forward
15098 (org-re-property-keyword property) (cdr range) t)
15099 (progn
15100 (delete-region (match-beginning 0) (match-end 0))
15101 (goto-char (match-beginning 0)))
15102 (goto-char (cdr range))
15104 (backward-char 1)
15105 (org-indent-line))
15106 (insert ":" property ":")
15107 (and value (insert " " value))
15108 (org-indent-line)))))
15109 (run-hook-with-args 'org-property-changed-functions property value)))
15111 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15112 "Get all property keys in the current buffer.
15113 With INCLUDE-SPECIALS, also list the special properties that reflect things
15114 like tags and TODO state.
15115 With INCLUDE-DEFAULTS, also include properties that has special meaning
15116 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15117 and others.
15118 With INCLUDE-COLUMNS, also include property names given in COLUMN
15119 formats in the current buffer."
15120 (let (rtn range cfmt s p)
15121 (save-excursion
15122 (save-restriction
15123 (widen)
15124 (goto-char (point-min))
15125 (while (re-search-forward org-property-start-re nil t)
15126 (setq range (org-get-property-block))
15127 (goto-char (car range))
15128 (while (re-search-forward
15130 (cdr range) t)
15131 (add-to-list 'rtn (org-match-string-no-properties 1)))
15132 (outline-next-heading))))
15134 (when include-specials
15135 (setq rtn (append org-special-properties rtn)))
15137 (when include-defaults
15138 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15139 (add-to-list 'rtn org-effort-property))
15141 (when include-columns
15142 (save-excursion
15143 (save-restriction
15144 (widen)
15145 (goto-char (point-min))
15146 (while (re-search-forward
15148 nil t)
15149 (setq cfmt (match-string 2) s 0)
15151 cfmt s)
15152 (setq s (match-end 0)
15153 p (match-string 1 cfmt))
15154 (unless (or (equal p "ITEM")
15155 (member p org-special-properties))
15156 (add-to-list 'rtn (match-string 1 cfmt))))))))
15158 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15160 (defun org-property-values (key)
15161 "Return a list of all values of property KEY in the current buffer."
15162 (save-excursion
15163 (save-restriction
15164 (widen)
15165 (goto-char (point-min))
15166 (let ((re (org-re-property key))
15167 values)
15168 (while (re-search-forward re nil t)
15169 (add-to-list 'values (org-trim (match-string 1))))
15170 (delete "" values)))))
15172 (defun org-insert-property-drawer ()
15173 "Insert a property drawer into the current entry."
15174 (org-back-to-heading t)
15175 (looking-at org-outline-regexp)
15176 (let ((indent (if org-adapt-indentation
15177 (- (match-end 0) (match-beginning 0))
15178 0))
15179 (beg (point))
15181 end hiddenp)
15182 (outline-next-heading)
15183 (setq end (point))
15184 (goto-char beg)
15185 (while (re-search-forward re end t))
15186 (setq hiddenp (outline-invisible-p))
15187 (end-of-line 1)
15190 (if (member (match-string 1) '("CLOCK:" ":END:"))
15191 ;; just skip this line
15192 (beginning-of-line 2)
15193 ;; Drawer start, find the end
15195 (beginning-of-line 1)))
15196 (org-skip-over-state-notes)
15198 (if (eq (char-before) ?*) (forward-char 1))
15200 (beginning-of-line 0)
15201 (org-indent-to-column indent)
15202 (beginning-of-line 2)
15203 (org-indent-to-column indent)
15204 (beginning-of-line 0)
15205 (if hiddenp
15206 (save-excursion
15207 (org-back-to-heading t)
15208 (hide-entry))
15209 (org-flag-drawer t))))
15211 (defun org-insert-drawer (&optional arg drawer)
15212 "Insert a drawer at point.
15214 Optional argument DRAWER, when non-nil, is a string representing
15215 drawer's name. Otherwise, the user is prompted for a name.
15217 If a region is active, insert the drawer around that region
15218 instead.
15220 Point is left between drawer's boundaries."
15221 (interactive "P")
15222 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15223 "LOGBOOK"))
15224 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15225 ;; internally by Org. They are meant to be inserted
15226 ;; automatically.
15227 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15228 ;; Remove system drawers from list. Note: For some reason,
15229 ;; `org-completing-read' ignores the predicate while
15230 ;; `completing-read' handles it fine.
15231 (drawer (if arg "PROPERTIES"
15232 (or drawer
15233 (completing-read
15234 "Drawer: " org-drawers
15235 (lambda (d) (not (member d system-drawers))))))))
15236 (cond
15237 ;; With C-u, fall back on `org-insert-property-drawer'
15238 (arg (org-insert-property-drawer))
15239 ;; With an active region, insert a drawer at point.
15240 ((not (org-region-active-p))
15241 (progn
15244 (forward-line -2)))
15245 ;; Otherwise, insert the drawer at point
15246 (t
15247 (let ((rbeg (region-beginning))
15248 (rend (copy-marker (region-end))))
15249 (unwind-protect
15250 (progn
15251 (goto-char rbeg)
15252 (beginning-of-line)
15253 (when (save-excursion
15254 (re-search-forward org-outline-regexp-bol rend t))
15255 (error "Drawers cannot contain headlines"))
15256 ;; Position point at the beginning of the first
15257 ;; non-blank line in region. Insert drawer's opening
15258 ;; there, then indent it.
15259 (org-skip-whitespace)
15260 (beginning-of-line)
15262 (forward-line -1)
15263 (indent-for-tab-command)
15264 ;; Move point to the beginning of the first blank line
15265 ;; after the last non-blank line in region. Insert
15266 ;; drawer's closing, then indent it.
15267 (goto-char rend)
15270 (deactivate-mark t)
15271 (indent-for-tab-command)
15273 ;; Clear marker, whatever the outcome of insertion is.
15274 (set-marker rend nil)))))))
15276 (defvar org-property-set-functions-alist nil
15277 "Property set function alist.
15278 Each entry should have the following format:
15280 (PROPERTY . READ-FUNCTION)
15282 The read function will be called with the same argument as
15283 `org-completing-read'.")
15285 (defun org-set-property-function (property)
15286 "Get the function that should be used to set PROPERTY.
15287 This is computed according to `org-property-set-functions-alist'."
15288 (or (cdr (assoc property org-property-set-functions-alist))
15289 'org-completing-read))
15291 (defun org-read-property-value (property)
15292 "Read PROPERTY value from user."
15293 (let* ((completion-ignore-case t)
15294 (allowed (org-property-get-allowed-values nil property 'table))
15295 (cur (org-entry-get nil property))
15296 (prompt (concat property " value"
15298 (concat " [" cur "]") "") ": "))
15299 (set-function (org-set-property-function property))
15300 (val (if allowed
15301 (funcall set-function prompt allowed nil
15302 (not (get-text-property 0 'org-unrestricted
15303 (caar allowed))))
15304 (let (org-completion-use-ido org-completion-use-iswitchb)
15305 (funcall set-function prompt
15306 (mapcar 'list (org-property-values property))
15307 nil nil "" nil cur)))))
15308 (if (equal val "")
15309 cur
15310 val)))
15312 (defvar org-last-set-property nil)
15313 (defvar org-last-set-property-value nil)
15314 (defun org-read-property-name ()
15315 "Read a property name."
15316 (let* ((completion-ignore-case t)
15317 (keys (org-buffer-property-keys nil t t))
15318 (default-prop (or (save-excursion
15319 (save-match-data
15320 (beginning-of-line)
15322 (null (string= (match-string 1) "END"))
15323 (match-string 1))))
15324 org-last-set-property))
15325 (property (org-icompleting-read
15326 (concat "Property"
15327 (if default-prop (concat " [" default-prop "]") "")
15328 ": ")
15329 (mapcar 'list keys)
15330 nil nil nil nil
15331 default-prop)))
15332 (if (member property keys)
15333 property
15334 (or (cdr (assoc (downcase property)
15335 (mapcar (lambda (x) (cons (downcase x) x))
15336 keys)))
15337 property))))
15339 (defun org-set-property-and-value (use-last)
15340 "Allow to set [PROPERTY]: [value] direction from prompt.
15341 When use-default, don't even ask, just use the last
15343 (interactive "P")
15344 (let* ((completion-ignore-case t)
15345 (pv (or (and use-last org-last-set-property-value)
15346 (org-completing-read
15348 nil nil nil nil nil
15349 org-last-set-property-value)))
15350 prop val)
15352 (setq prop (match-string 1 pv)
15353 val (match-string 2 pv))
15354 (org-set-property prop val))))
15356 (defun org-set-property (property value)
15357 "In the current entry, set PROPERTY to VALUE.
15358 When called interactively, this will prompt for a property name, offering
15359 completion on existing and default properties. And then it will prompt
15360 for a value, offering completion either on allowed values (via an inherited
15361 xxx_ALL property) or on existing values in other instances of this property
15362 in the current file."
15363 (interactive (list nil nil))
15364 (let* ((property (or property (org-read-property-name)))
15365 (value (or value (org-read-property-value property)))
15366 (fn (cdr (assoc property org-properties-postprocess-alist))))
15367 (setq org-last-set-property property)
15368 (setq org-last-set-property-value (concat property ": " value))
15369 ;; Possibly postprocess the inserted value:
15370 (when fn (setq value (funcall fn value)))
15371 (unless (equal (org-entry-get nil property) value)
15372 (org-entry-put nil property value))))
15374 (defun org-delete-property (property &optional delete-empty-drawer)
15375 "In the current entry, delete PROPERTY.
15376 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15377 an empty drawer to delete."
15378 (interactive
15379 (let* ((completion-ignore-case t)
15380 (prop (org-icompleting-read "Property: "
15381 (org-entry-properties nil 'standard))))
15382 (list prop)))
15383 (message "Property %s %s" property
15384 (if (org-entry-delete nil property delete-empty-drawer)
15385 "deleted"
15386 "was not present in the entry")))
15388 (defun org-delete-property-globally (property)
15389 "Remove PROPERTY globally, from all entries."
15390 (interactive
15391 (let* ((completion-ignore-case t)
15392 (prop (org-icompleting-read
15393 "Globally remove property: "
15394 (mapcar 'list (org-buffer-property-keys)))))
15395 (list prop)))
15396 (save-excursion
15397 (save-restriction
15398 (widen)
15399 (goto-char (point-min))
15400 (let ((cnt 0))
15401 (while (re-search-forward
15402 (org-re-property property)
15403 nil t)
15404 (setq cnt (1+ cnt))
15405 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15408 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15410 (defun org-compute-property-at-point ()
15411 "Compute the property at point.
15412 This looks for an enclosing column format, extracts the operator and
15413 then applies it to the property in the column format's scope."
15414 (interactive)
15415 (unless (org-at-property-p)
15416 (error "Not at a property"))
15417 (let ((prop (org-match-string-no-properties 2)))
15418 (org-columns-get-format-and-top-level)
15419 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15420 (error "No operator defined for property %s" prop))
15421 (org-columns-compute prop)))
15423 (defvar org-property-allowed-value-functions nil
15424 "Hook for functions supplying allowed values for a specific property.
15425 The functions must take a single argument, the name of the property, and
15427 the values, this means that these values are intended as defaults for
15428 completion, but that other values should be allowed too.
15429 The functions must return nil if they are not responsible for this
15430 property.")
15432 (defun org-property-get-allowed-values (pom property &optional table)
15433 "Get allowed values for the property PROPERTY.
15434 When TABLE is non-nil, return an alist that can directly be used for
15435 completion."
15436 (let (vals)
15437 (cond
15438 ((equal property "TODO")
15439 (setq vals (org-with-point-at pom
15440 (append org-todo-keywords-1 '("")))))
15441 ((equal property "PRIORITY")
15442 (let ((n org-lowest-priority))
15443 (while (>= n org-highest-priority)
15444 (push (char-to-string n) vals)
15445 (setq n (1- n)))))
15446 ((member property org-special-properties))
15447 ((setq vals (run-hook-with-args-until-success
15448 'org-property-allowed-value-functions property)))
15449 (t
15450 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15452 (setq vals (car (read-from-string (concat "(" vals ")"))))
15453 (setq vals (mapcar (lambda (x)
15454 (cond ((stringp x) x)
15455 ((numberp x) (number-to-string x))
15456 ((symbolp x) (symbol-name x))
15457 (t "???")))
15458 vals)))))
15459 (when (member ":ETC" vals)
15460 (setq vals (remove ":ETC" vals))
15461 (org-add-props (car vals) '(org-unrestricted t)))
15462 (if table (mapcar 'list vals) vals)))
15464 (defun org-property-previous-allowed-value (&optional previous)
15465 "Switch to the next allowed value for this property."
15466 (interactive)
15467 (org-property-next-allowed-value t))
15469 (defun org-property-next-allowed-value (&optional previous)
15470 "Switch to the next allowed value for this property."
15471 (interactive)
15472 (unless (org-at-property-p)
15473 (error "Not at a property"))
15474 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15475 (key (match-string 2))
15476 (value (match-string 3))
15477 (allowed (or (org-property-get-allowed-values (point) key)
15478 (and (member value '("[ ]" "[-]" "[X]"))
15479 '("[ ]" "[X]"))))
15480 (heading (save-match-data (nth 4 (org-heading-components))))
15481 nval)
15482 (unless allowed
15483 (error "Allowed values for this property have not been defined"))
15484 (if previous (setq allowed (reverse allowed)))
15485 (if (member value allowed)
15486 (setq nval (car (cdr (member value allowed)))))
15487 (setq nval (or nval (car allowed)))
15488 (if (equal nval value)
15489 (error "Only one allowed value for this property"))
15490 (org-at-property-p)
15491 (replace-match (concat " :" key ": " nval) t t)
15492 (org-indent-line)
15493 (beginning-of-line 1)
15495 (when (equal prop org-effort-property)
15496 (save-excursion
15497 (org-back-to-heading t)
15498 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15499 (when (string= org-clock-current-task heading)
15500 (setq org-clock-effort nval)
15501 (org-clock-update-mode-line)))
15502 (run-hook-with-args 'org-property-changed-functions key nval)))
15504 (defun org-find-olp (path &optional this-buffer)
15505 "Return a marker pointing to the entry at outline path OLP.
15506 If anything goes wrong, throw an error.
15507 You can wrap this call to catch the error like this:
15509 (condition-case msg
15510 (org-mobile-locate-entry (match-string 4))
15511 (error (nth 1 msg)))
15513 The return value will then be either a string with the error message,
15514 or a marker if everything is OK.
15516 If THIS-BUFFER is set, the outline path does not contain a file,
15517 only headings."
15518 (let* ((file (if this-buffer buffer-file-name (pop path)))
15519 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15520 (level 1)
15521 (lmin 1)
15522 (lmax 1)
15523 limit re end found pos heading cnt flevel)
15524 (unless buffer (error "File not found :%s" file))
15525 (with-current-buffer buffer
15526 (save-excursion
15527 (save-restriction
15528 (widen)
15529 (setq limit (point-max))
15530 (goto-char (point-min))
15531 (while (setq heading (pop path))
15532 (setq re (format org-complex-heading-regexp-format
15533 (regexp-quote heading)))
15534 (setq cnt 0 pos (point))
15535 (while (re-search-forward re end t)
15536 (setq level (- (match-end 1) (match-beginning 1)))
15537 (if (and (>= level lmin) (<= level lmax))
15538 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15539 (when (= cnt 0) (error "Heading not found on level %d: %s"
15540 lmax heading))
15541 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15542 lmax heading))
15543 (goto-char found)
15544 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15545 (setq end (save-excursion (org-end-of-subtree t t))))
15546 (when (org-at-heading-p)
15547 (point-marker)))))))
15549 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15550 "Find node HEADING in BUFFER.
15551 Return a marker to the heading if it was found, or nil if not.
15552 If POS-ONLY is set, return just the position instead of a marker.
15554 The heading text must match exact, but it may have a TODO keyword,
15555 a priority cookie and tags in the standard locations."
15556 (with-current-buffer (or buffer (current-buffer))
15557 (save-excursion
15558 (save-restriction
15559 (widen)
15560 (goto-char (point-min))
15561 (let (case-fold-search)
15562 (if (re-search-forward
15563 (format org-complex-heading-regexp-format
15564 (regexp-quote heading)) nil t)
15565 (if pos-only
15566 (match-beginning 0)
15567 (move-marker (make-marker) (match-beginning 0)))))))))
15569 (defun org-find-exact-heading-in-directory (heading &optional dir)
15570 "Find Org node headline HEADING in all .org files in directory DIR.
15571 When the target headline is found, return a marker to this location."
15572 (let ((files (directory-files (or dir default-directory)
15574 file visiting m buffer)
15575 (catch 'found
15576 (while (setq file (pop files))
15577 (message "trying %s" file)
15578 (setq visiting (org-find-base-buffer-visiting file))
15579 (setq buffer (or visiting (find-file-noselect file)))
15580 (setq m (org-find-exact-headline-in-buffer
15581 heading buffer))
15582 (when (and (not m) (not visiting)) (kill-buffer buffer))
15583 (and m (throw 'found m))))))
15585 (defun org-find-entry-with-id (ident)
15586 "Locate the entry that contains the ID property with exact value IDENT.
15587 IDENT can be a string, a symbol or a number, this function will search for
15588 the string representation of it.
15589 Return the position where this entry starts, or nil if there is no such entry."
15590 (interactive "sID: ")
15591 (let ((id (cond
15592 ((stringp ident) ident)
15593 ((symbol-name ident) (symbol-name ident))
15594 ((numberp ident) (number-to-string ident))
15595 (t (error "IDENT %s must be a string, symbol or number" ident))))
15596 (case-fold-search nil))
15597 (save-excursion
15598 (save-restriction
15599 (widen)
15600 (goto-char (point-min))
15601 (when (re-search-forward
15603 nil t)
15604 (org-back-to-heading t)
15605 (point))))))
15607 ;;;; Timestamps
15609 (defvar org-last-changed-timestamp nil)
15610 (defvar org-last-inserted-timestamp nil
15611 "The last time stamp inserted with `org-insert-time-stamp'.")
15612 (defvar org-time-was-given) ; dynamically scoped parameter
15613 (defvar org-end-time-was-given) ; dynamically scoped parameter
15614 (defvar org-ts-what) ; dynamically scoped parameter
15616 (defun org-time-stamp (arg &optional inactive)
15617 "Prompt for a date/time and insert a time stamp.
15618 If the user specifies a time like HH:MM or if this command is
15619 called with at least one prefix argument, the time stamp contains
15620 the date and the time. Otherwise, only the date is be included.
15622 All parts of a date not specified by the user is filled in from
15623 the current date/time. So if you just press return without
15624 typing anything, the time stamp will represent the current
15625 date/time.
15627 If there is already a timestamp at the cursor, it will be
15628 modified.
15630 With two universal prefix arguments, insert an active timestamp
15631 with the current time without prompting the user."
15632 (interactive "P")
15633 (let* ((ts nil)
15634 (default-time
15635 ;; Default time is either today, or, when entering a range,
15636 ;; the range start.
15637 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15638 (save-excursion
15639 (re-search-backward
15641 (- (point) 20) t)))
15642 (apply 'encode-time (org-parse-time-string (match-string 1)))
15643 (current-time)))
15644 (default-input (and ts (org-get-compact-tod ts)))
15645 (repeater (save-excursion
15646 (save-match-data
15647 (beginning-of-line)
15648 (when (re-search-forward
15650 (save-excursion (progn (end-of-line) (point))) t)
15651 (match-string 0)))))
15652 org-time-was-given org-end-time-was-given time)
15653 (cond
15654 ((and (org-at-timestamp-p t)
15655 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15656 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15657 (insert "--")
15658 (setq time (let ((this-command this-command))
15659 (org-read-date arg 'totime nil nil
15660 default-time default-input inactive)))
15661 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15662 ((org-at-timestamp-p t)
15663 (setq time (let ((this-command this-command))
15664 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15665 (when (org-at-timestamp-p t) ; just to get the match data
15666 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15667 (replace-match "")
15668 (setq org-last-changed-timestamp
15669 (org-insert-time-stamp
15670 time (or org-time-was-given arg)
15671 inactive nil nil (list org-end-time-was-given)))
15672 (when repeater (goto-char (1- (point))) (insert " " repeater)
15673 (setq org-last-changed-timestamp
15674 (concat (substring org-last-inserted-timestamp 0 -1)
15675 " " repeater ">"))))
15676 (message "Timestamp updated"))
15677 ((equal arg '(16))
15678 (org-insert-time-stamp (current-time) t))
15679 (t
15680 (setq time (let ((this-command this-command))
15681 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15682 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15683 nil nil (list org-end-time-was-given))))))
15685 ;; FIXME: can we use this for something else, like computing time differences?
15686 (defun org-get-compact-tod (s)
15687 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15688 (let* ((t1 (match-string 1 s))
15689 (h1 (string-to-number (match-string 2 s)))
15690 (m1 (string-to-number (match-string 3 s)))
15691 (t2 (and (match-end 4) (match-string 5 s)))
15692 (h2 (and t2 (string-to-number (match-string 6 s))))
15693 (m2 (and t2 (string-to-number (match-string 7 s))))
15694 dh dm)
15695 (if (not t2)
15696 t1
15697 (setq dh (- h2 h1) dm (- m2 m1))
15698 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15699 (concat t1 "+" (number-to-string dh)
15700 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15702 (defun org-time-stamp-inactive (&optional arg)
15703 "Insert an inactive time stamp.
15704 An inactive time stamp is enclosed in square brackets instead of angle
15705 brackets. It is inactive in the sense that it does not trigger agenda entries,
15706 does not link to the calendar and cannot be changed with the S-cursor keys.
15707 So these are more for recording a certain time/date."
15708 (interactive "P")
15709 (org-time-stamp arg 'inactive))
15711 (defvar org-date-ovl (make-overlay 1 1))
15712 (overlay-put org-date-ovl 'face 'org-date-selected)
15713 (org-detach-overlay org-date-ovl)
15715 (defvar org-ans1) ; dynamically scoped parameter
15716 (defvar org-ans2) ; dynamically scoped parameter
15718 (defvar org-plain-time-of-day-regexp) ; defined below
15720 (defvar org-overriding-default-time nil) ; dynamically scoped
15721 (defvar org-read-date-overlay nil)
15722 (defvar org-dcst nil) ; dynamically scoped
15723 (defvar org-read-date-history nil)
15724 (defvar org-read-date-final-answer nil)
15725 (defvar org-read-date-analyze-futurep nil)
15726 (defvar org-read-date-analyze-forced-year nil)
15727 (defvar org-read-date-inactive)
15729 (defvar org-read-date-minibuffer-local-map
15730 (let ((map (make-sparse-keymap)))
15731 (set-keymap-parent map minibuffer-local-map)
15732 (org-defkey map (kbd ".")
15733 (lambda () (interactive)
15734 (org-eval-in-calendar '(calendar-goto-today))))
15735 (org-defkey map [(meta shift left)]
15736 (lambda () (interactive)
15737 (org-eval-in-calendar '(calendar-backward-month 1))))
15738 (org-defkey map [(meta shift right)]
15739 (lambda () (interactive)
15740 (org-eval-in-calendar '(calendar-forward-month 1))))
15741 (org-defkey map [(meta shift up)]
15742 (lambda () (interactive)
15743 (org-eval-in-calendar '(calendar-backward-year 1))))
15744 (org-defkey map [(meta shift down)]
15745 (lambda () (interactive)
15746 (org-eval-in-calendar '(calendar-forward-year 1))))
15747 (org-defkey map [?\e (shift left)]
15748 (lambda () (interactive)
15749 (org-eval-in-calendar '(calendar-backward-month 1))))
15750 (org-defkey map [?\e (shift right)]
15751 (lambda () (interactive)
15752 (org-eval-in-calendar '(calendar-forward-month 1))))
15753 (org-defkey map [?\e (shift up)]
15754 (lambda () (interactive)
15755 (org-eval-in-calendar '(calendar-backward-year 1))))
15756 (org-defkey map [?\e (shift down)]
15757 (lambda () (interactive)
15758 (org-eval-in-calendar '(calendar-forward-year 1))))
15759 (org-defkey map [(shift up)]
15760 (lambda () (interactive)
15761 (org-eval-in-calendar '(calendar-backward-week 1))))
15762 (org-defkey map [(shift down)]
15763 (lambda () (interactive)
15764 (org-eval-in-calendar '(calendar-forward-week 1))))
15765 (org-defkey map [(shift left)]
15766 (lambda () (interactive)
15767 (org-eval-in-calendar '(calendar-backward-day 1))))
15768 (org-defkey map [(shift right)]
15769 (lambda () (interactive)
15770 (org-eval-in-calendar '(calendar-forward-day 1))))
15771 (org-defkey map "!"
15772 (lambda () (interactive)
15773 (org-eval-in-calendar '(diary-view-entries))
15774 (message "")))
15775 (org-defkey map ">"
15776 (lambda () (interactive)
15777 (org-eval-in-calendar '(scroll-calendar-left 1))))
15778 (org-defkey map "<"
15779 (lambda () (interactive)
15780 (org-eval-in-calendar '(scroll-calendar-right 1))))
15781 (org-defkey map "\C-v"
15782 (lambda () (interactive)
15783 (org-eval-in-calendar
15784 '(calendar-scroll-left-three-months 1))))
15785 (org-defkey map "\M-v"
15786 (lambda () (interactive)
15787 (org-eval-in-calendar
15788 '(calendar-scroll-right-three-months 1))))
15789 map)
15790 "Keymap for minibuffer commands when using `org-read-date'.")
15792 (defun org-read-date (&optional org-with-time to-time from-string prompt
15793 default-time default-input inactive)
15794 "Read a date, possibly a time, and make things smooth for the user.
15795 The prompt will suggest to enter an ISO date, but you can also enter anything
15796 which will at least partially be understood by `parse-time-string'.
15797 Unrecognized parts of the date will default to the current day, month, year,
15798 hour and minute. If this command is called to replace a timestamp at point,
15799 or to enter the second timestamp of a range, the default time is taken
15800 from the existing stamp. Furthermore, the command prefers the future,
15801 so if you are giving a date where the year is not given, and the day-month
15802 combination is already past in the current year, it will assume you
15803 mean next year. For details, see the manual. A few examples:
15805 3-2-5 --> 2003-02-05
15806 feb 15 --> currentyear-02-15
15807 2/15 --> currentyear-02-15
15808 sep 12 9 --> 2009-09-12
15809 12:45 --> today 12:45
15810 22 sept 0:34 --> currentyear-09-22 0:34
15811 12 --> currentyear-currentmonth-12
15812 Fri --> nearest Friday (today or later)
15813 etc.
15815 Furthermore you can specify a relative date by giving, as the *first* thing
15816 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15817 change in days weeks, months, years.
15818 With a single plus or minus, the date is relative to today. With a double
15819 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15820 +4d --> four days from today
15821 +4 --> same as above
15822 +2w --> two weeks from today
15823 ++5 --> five days from default date
15825 The function understands only English month and weekday abbreviations.
15827 While prompting, a calendar is popped up - you can also select the
15828 date with the mouse (button 1). The calendar shows a period of three
15829 months. To scroll it to other months, use the keys `>' and `<'.
15830 If you don't like the calendar, turn it off with
15831 \(setq org-read-date-popup-calendar nil)
15833 With optional argument TO-TIME, the date will immediately be converted
15834 to an internal time.
15835 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15836 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15837 still enter a time, and this function will inform the calling routine
15838 about this change. The calling routine may then choose to change the
15839 format used to insert the time stamp into the buffer to include the time.
15840 With optional argument FROM-STRING, read from this string instead from
15841 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15842 the time/date that is used for everything that is not specified by the
15843 user."
15844 (require 'parse-time)
15845 (let* ((org-time-stamp-rounding-minutes
15846 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15847 (org-dcst org-display-custom-times)
15848 (ct (org-current-time))
15849 (org-def (or org-overriding-default-time default-time ct))
15850 (org-defdecode (decode-time org-def))
15851 (dummy (progn
15852 (when (< (nth 2 org-defdecode) org-extend-today-until)
15853 (setcar (nthcdr 2 org-defdecode) -1)
15854 (setcar (nthcdr 1 org-defdecode) 59)
15855 (setq org-def (apply 'encode-time org-defdecode)
15856 org-defdecode (decode-time org-def)))))
15857 (mouse-autoselect-window nil) ; Don't let the mouse jump
15858 (calendar-frame-setup nil)
15859 (calendar-setup nil)
15860 (calendar-move-hook nil)
15861 (calendar-view-diary-initially-flag nil)
15862 (calendar-view-holidays-initially-flag nil)
15863 (timestr (format-time-string
15864 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15865 (prompt (concat (if prompt (concat prompt " ") "")
15866 (format "Date+time [%s]: " timestr)))
15867 ans (org-ans0 "") org-ans1 org-ans2 final)
15869 (cond
15870 (from-string (setq ans from-string))
15871 (org-read-date-popup-calendar
15872 (save-excursion
15873 (save-window-excursion
15874 (calendar)
15875 (org-eval-in-calendar '(setq cursor-type nil) t)
15876 (unwind-protect
15877 (progn
15878 (calendar-forward-day (- (time-to-days org-def)
15879 (calendar-absolute-from-gregorian
15880 (calendar-current-date))))
15881 (org-eval-in-calendar nil t)
15882 (let* ((old-map (current-local-map))
15883 (map (copy-keymap calendar-mode-map))
15884 (minibuffer-local-map
15885 (copy-keymap org-read-date-minibuffer-local-map)))
15886 (org-defkey map (kbd "RET") 'org-calendar-select)
15887 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15888 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15889 (unwind-protect
15890 (progn
15891 (use-local-map map)
15892 (setq org-read-date-inactive inactive)
15893 (add-hook 'post-command-hook 'org-read-date-display)
15894 (setq org-ans0 (read-string prompt default-input
15895 'org-read-date-history nil))
15896 ;; org-ans0: from prompt
15897 ;; org-ans1: from mouse click
15898 ;; org-ans2: from calendar motion
15899 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15900 (remove-hook 'post-command-hook 'org-read-date-display)
15901 (use-local-map old-map)
15902 (when org-read-date-overlay
15903 (delete-overlay org-read-date-overlay)
15904 (setq org-read-date-overlay nil)))))
15905 (bury-buffer "*Calendar*")))))
15907 (t ; Naked prompt only
15908 (unwind-protect
15909 (setq ans (read-string prompt default-input
15910 'org-read-date-history timestr))
15911 (when org-read-date-overlay
15912 (delete-overlay org-read-date-overlay)
15913 (setq org-read-date-overlay nil)))))
15915 (setq final (org-read-date-analyze ans org-def org-defdecode))
15917 (when org-read-date-analyze-forced-year
15918 (message "Year was forced into %s"
15919 (if org-read-date-force-compatible-dates
15920 "compatible range (1970-2037)"
15921 "range representable on this machine"))
15922 (ding))
15924 ;; One round trip to get rid of 34th of August and stuff like that....
15925 (setq final (decode-time (apply 'encode-time final)))
15927 (setq org-read-date-final-answer ans)
15929 (if to-time
15930 (apply 'encode-time final)
15931 (if (and (boundp 'org-time-was-given) org-time-was-given)
15932 (format "%04d-%02d-%02d %02d:%02d"
15933 (nth 5 final) (nth 4 final) (nth 3 final)
15934 (nth 2 final) (nth 1 final))
15935 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15937 (defvar org-def)
15938 (defvar org-defdecode)
15939 (defvar org-with-time)
15940 (defun org-read-date-display ()
15941 "Display the current date prompt interpretation in the minibuffer."
15942 (when org-read-date-display-live
15943 (when org-read-date-overlay
15944 (delete-overlay org-read-date-overlay))
15945 (when (minibufferp (current-buffer))
15946 (save-excursion
15947 (end-of-line 1)
15948 (while (not (equal (buffer-substring
15949 (max (point-min) (- (point) 4)) (point))
15950 " "))
15951 (insert " ")))
15952 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15953 " " (or org-ans1 org-ans2)))
15954 (org-end-time-was-given nil)
15955 (f (org-read-date-analyze ans org-def org-defdecode))
15956 (fmts (if org-dcst
15957 org-time-stamp-custom-formats
15958 org-time-stamp-formats))
15959 (fmt (if (or org-with-time
15960 (and (boundp 'org-time-was-given) org-time-was-given))
15961 (cdr fmts)
15962 (car fmts)))
15963 (txt (format-time-string fmt (apply 'encode-time f)))
15964 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15965 (txt (concat "=> " txt)))
15966 (when (and org-end-time-was-given
15967 (string-match org-plain-time-of-day-regexp txt))
15968 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15969 org-end-time-was-given
15970 (substring txt (match-end 0)))))
15971 (when org-read-date-analyze-futurep
15972 (setq txt (concat txt " (=>F)")))
15973 (setq org-read-date-overlay
15974 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15975 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15977 (defun org-read-date-analyze (ans org-def org-defdecode)
15978 "Analyze the combined answer of the date prompt."
15979 ;; FIXME: cleanup and comment
15980 (let ((nowdecode (decode-time (current-time)))
15981 delta deltan deltaw deltadef year month day
15982 hour minute second wday pm h2 m2 tl wday1
15983 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15984 (setq org-read-date-analyze-futurep nil
15985 org-read-date-analyze-forced-year nil)
15987 (setq ans "+0"))
15989 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15990 (setq ans (replace-match "" t t ans)
15991 deltan (car delta)
15992 deltaw (nth 1 delta)
15993 deltadef (nth 2 delta)))
15995 ;; Check if there is an iso week date in there. If yes, store the
15996 ;; info and postpone interpreting it until the rest of the parsing
15997 ;; is done.
15998 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15999 (setq iso-year (if (match-end 1)
16000 (org-small-year-to-year
16001 (string-to-number (match-string 1 ans))))
16002 iso-weekday (if (match-end 3)
16003 (string-to-number (match-string 3 ans)))
16004 iso-week (string-to-number (match-string 2 ans)))
16005 (setq ans (replace-match "" t t ans)))
16007 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16008 (when (string-match
16010 (setq year (if (match-end 2)
16011 (string-to-number (match-string 2 ans))
16012 (progn (setq kill-year t)
16013 (string-to-number (format-time-string "%Y"))))
16014 month (string-to-number (match-string 3 ans))
16015 day (string-to-number (match-string 4 ans)))
16016 (if (< year 100) (setq year (+ 2000 year)))
16018 t nil ans)))
16020 ;; Help matching dotted european dates
16021 (when (string-match
16022 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16023 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16024 (setq kill-year t)
16025 (string-to-number (format-time-string "%Y")))
16026 day (string-to-number (match-string 1 ans))
16027 month (string-to-number (match-string 2 ans))
16028 ans (replace-match (format "%04d-%02d-%02d" year month day)
16029 t nil ans)))
16031 ;; Help matching american dates, like 5/30 or 5/30/7
16032 (when (string-match
16033 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16034 (setq year (if (match-end 4)
16035 (string-to-number (match-string 4 ans))
16036 (progn (setq kill-year t)
16037 (string-to-number (format-time-string "%Y"))))
16038 month (string-to-number (match-string 1 ans))
16039 day (string-to-number (match-string 2 ans)))
16040 (if (< year 100) (setq year (+ 2000 year)))
16042 t nil ans)))
16043 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16044 ;; If there is a time with am/pm, and *no* time without it, we convert
16045 ;; so that matching will be successful.
16046 (loop for i from 1 to 2 do ; twice, for end time as well
16049 (setq hour (string-to-number (match-string 1 ans))
16050 minute (if (match-end 3)
16051 (string-to-number (match-string 3 ans))
16052 0)
16053 pm (equal ?p
16054 (string-to-char (downcase (match-string 4 ans)))))
16055 (if (and (= hour 12) (not pm))
16056 (setq hour 0)
16057 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16058 (setq ans (replace-match (format "%02d:%02d" hour minute)
16059 t t ans))))
16061 ;; Check if a time range is given as a duration
16062 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16063 (setq hour (string-to-number (match-string 1 ans))
16064 h2 (+ hour (string-to-number (match-string 3 ans)))
16065 minute (string-to-number (match-string 2 ans))
16066 m2 (+ minute (if (match-end 5) (string-to-number
16067 (match-string 5 ans))0)))
16068 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16069 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16070 t t ans)))
16072 ;; Check if there is a time range
16073 (when (boundp 'org-end-time-was-given)
16074 (setq org-time-was-given nil)
16075 (when (and (string-match org-plain-time-of-day-regexp ans)
16076 (match-end 8))
16077 (setq org-end-time-was-given (match-string 8 ans))
16078 (setq ans (concat (substring ans 0 (match-beginning 7))
16079 (substring ans (match-end 7))))))
16081 (setq tl (parse-time-string ans)
16082 day (or (nth 3 tl) (nth 3 org-defdecode))
16083 month (or (nth 4 tl)
16084 (if (and org-read-date-prefer-future
16085 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16086 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16087 (nth 4 org-defdecode)))
16088 year (or (and (not kill-year) (nth 5 tl))
16089 (if (and org-read-date-prefer-future
16090 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16091 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16092 (nth 5 org-defdecode)))
16093 hour (or (nth 2 tl) (nth 2 org-defdecode))
16094 minute (or (nth 1 tl) (nth 1 org-defdecode))
16095 second (or (nth 0 tl) 0)
16096 wday (nth 6 tl))
16098 (when (and (eq org-read-date-prefer-future 'time)
16099 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16100 (equal day (nth 3 nowdecode))
16101 (equal month (nth 4 nowdecode))
16102 (equal year (nth 5 nowdecode))
16103 (nth 2 tl)
16104 (or (< (nth 2 tl) (nth 2 nowdecode))
16105 (and (= (nth 2 tl) (nth 2 nowdecode))
16106 (nth 1 tl)
16107 (< (nth 1 tl) (nth 1 nowdecode)))))
16108 (setq day (1+ day)
16109 futurep t))
16111 ;; Special date definitions below
16112 (cond
16113 (iso-week
16114 ;; There was an iso week
16115 (require 'cal-iso)
16116 (setq futurep nil)
16117 (setq year (or iso-year year)
16118 day (or iso-weekday wday 1)
16119 wday nil ; to make sure that the trigger below does not match
16120 iso-date (calendar-gregorian-from-absolute
16121 (calendar-absolute-from-iso
16122 (list iso-week day year))))
16123 ; FIXME: Should we also push ISO weeks into the future?
16124 ; (when (and org-read-date-prefer-future
16125 ; (not iso-year)
16126 ; (< (calendar-absolute-from-gregorian iso-date)
16127 ; (time-to-days (current-time))))
16128 ; (setq year (1+ year)
16129 ; iso-date (calendar-gregorian-from-absolute
16130 ; (calendar-absolute-from-iso
16131 ; (list iso-week day year)))))
16132 (setq month (car iso-date)
16133 year (nth 2 iso-date)
16134 day (nth 1 iso-date)))
16135 (deltan
16136 (setq futurep nil)
16137 (unless deltadef
16138 (let ((now (decode-time (current-time))))
16139 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16140 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16141 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16142 ((equal deltaw "m") (setq month (+ month deltan)))
16143 ((equal deltaw "y") (setq year (+ year deltan)))))
16144 ((and wday (not (nth 3 tl)))
16145 ;; Weekday was given, but no day, so pick that day in the week
16146 ;; on or after the derived date.
16147 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16148 (unless (equal wday wday1)
16149 (setq day (+ day (% (- wday wday1 -7) 7))))))
16150 (if (and (boundp 'org-time-was-given)
16151 (nth 2 tl))
16152 (setq org-time-was-given t))
16153 (if (< year 100) (setq year (+ 2000 year)))
16154 ;; Check of the date is representable
16155 (if org-read-date-force-compatible-dates
16156 (progn
16157 (if (< year 1970)
16158 (setq year 1970 org-read-date-analyze-forced-year t))
16159 (if (> year 2037)
16160 (setq year 2037 org-read-date-analyze-forced-year t)))
16161 (condition-case nil
16162 (ignore (encode-time second minute hour day month year))
16163 (error
16164 (setq year (nth 5 org-defdecode))
16165 (setq org-read-date-analyze-forced-year t))))
16166 (setq org-read-date-analyze-futurep futurep)
16167 (list second minute hour day month year)))
16169 (defvar parse-time-weekdays)
16170 (defun org-read-date-get-relative (s today default)
16171 "Check string S for special relative date string.
16172 TODAY and DEFAULT are internal times, for today and for a default.
16173 Return shift list (N what def-flag)
16175 N is the number of WHATs to shift.
16176 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16177 the DEFAULT date rather than TODAY."
16178 (require 'parse-time)
16179 (when (and
16180 (string-match
16181 (concat
16186 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16187 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16188 (string-to-char (substring (match-string 1 s) -1))
16189 ?+))
16190 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16191 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16192 (what (if (match-end 3) (match-string 3 s) "d"))
16193 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16194 (date (if rel default today))
16195 (wday (nth 6 (decode-time date)))
16196 delta)
16197 (if wday1
16198 (progn
16199 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16200 (if (= dir ?-) (setq delta (- delta 7)))
16201 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16202 (list delta "d" rel))
16203 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16205 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16206 "Turn a user-specified date into the internal representation.
16207 The internal representation needed by the calendar is (month day year).
16208 This is a wrapper to handle the brain-dead convention in calendar that
16209 user function argument order change dependent on argument order."
16210 (if (boundp 'calendar-date-style)
16211 (cond
16212 ((eq calendar-date-style 'american)
16213 (list arg1 arg2 arg3))
16214 ((eq calendar-date-style 'european)
16215 (list arg2 arg1 arg3))
16216 ((eq calendar-date-style 'iso)
16217 (list arg2 arg3 arg1)))
16218 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16219 (if (org-bound-and-true-p european-calendar-style)
16220 (list arg2 arg1 arg3)
16221 (list arg1 arg2 arg3)))))
16223 (defun org-eval-in-calendar (form &optional keepdate)
16224 "Eval FORM in the calendar window and return to current window.
16225 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16226 otherwise stick to the current value of `org-ans2'."
16227 (let ((sf (selected-frame))
16228 (sw (selected-window)))
16229 (select-window (get-buffer-window "*Calendar*" t))
16230 (eval form)
16231 (when (and (not keepdate) (calendar-cursor-to-date))
16232 (let* ((date (calendar-cursor-to-date))
16233 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16234 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16235 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16236 (select-window sw)
16237 (org-select-frame-set-input-focus sf)))
16239 (defun org-calendar-select ()
16240 "Return to `org-read-date' with the date currently selected.
16241 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16242 (interactive)
16243 (when (calendar-cursor-to-date)
16244 (let* ((date (calendar-cursor-to-date))
16245 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16246 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16247 (if (active-minibuffer-window) (exit-minibuffer))))
16249 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16250 "Insert a date stamp for the date given by the internal TIME.
16251 WITH-HM means use the stamp format that includes the time of the day.
16252 INACTIVE means use square brackets instead of angular ones, so that the
16253 stamp will not contribute to the agenda.
16254 PRE and POST are optional strings to be inserted before and after the
16255 stamp.
16256 The command returns the inserted time stamp."
16257 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16258 stamp)
16259 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16260 (insert-before-markers (or pre ""))
16261 (when (listp extra)
16262 (setq extra (car extra))
16263 (if (and (stringp extra)
16265 (setq extra (format "-%02d:%02d"
16266 (string-to-number (match-string 1 extra))
16267 (string-to-number (match-string 2 extra))))
16268 (setq extra nil)))
16269 (when extra
16270 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16271 (insert-before-markers (setq stamp (format-time-string fmt time)))
16272 (insert-before-markers (or post ""))
16273 (setq org-last-inserted-timestamp stamp)))
16275 (defun org-toggle-time-stamp-overlays ()
16276 "Toggle the use of custom time stamp formats."
16277 (interactive)
16278 (setq org-display-custom-times (not org-display-custom-times))
16279 (unless org-display-custom-times
16280 (let ((p (point-min)) (bmp (buffer-modified-p)))
16281 (while (setq p (next-single-property-change p 'display))
16282 (if (and (get-text-property p 'display)
16283 (eq (get-text-property p 'face) 'org-date))
16284 (remove-text-properties
16285 p (setq p (next-single-property-change p 'display))
16286 '(display t))))
16287 (set-buffer-modified-p bmp)))
16288 (if (featurep 'xemacs)
16289 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16290 (org-restart-font-lock)
16291 (setq org-table-may-need-update t)
16292 (if org-display-custom-times
16293 (message "Time stamps are overlaid with custom format")
16294 (message "Time stamp overlays removed")))
16296 (defun org-display-custom-time (beg end)
16297 "Overlay modified time stamp format over timestamp between BEG and END."
16298 (let* ((ts (buffer-substring beg end))
16299 t1 w1 with-hm tf time str w2 (off 0))
16300 (save-match-data
16301 (setq t1 (org-parse-time-string ts t))
16302 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16303 (setq off (- (match-end 0) (match-beginning 0)))))
16304 (setq end (- end off))
16305 (setq w1 (- end beg)
16306 with-hm (and (nth 1 t1) (nth 2 t1))
16307 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16308 time (org-fix-decoded-time t1)
16309 str (org-add-props
16310 (format-time-string
16311 (substring tf 1 -1) (apply 'encode-time time))
16312 nil 'mouse-face 'highlight)
16313 w2 (length str))
16314 (if (not (= w2 w1))
16315 (add-text-properties (1+ beg) (+ 2 beg)
16316 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16317 (if (featurep 'xemacs)
16318 (progn
16319 (put-text-property beg end 'invisible t)
16320 (put-text-property beg end 'end-glyph (make-glyph str)))
16321 (put-text-property beg end 'display str))))
16323 (defun org-translate-time (string)
16324 "Translate all timestamps in STRING to custom format.
16325 But do this only if the variable `org-display-custom-times' is set."
16326 (when org-display-custom-times
16327 (save-match-data
16328 (let* ((start 0)
16329 (re org-ts-regexp-both)
16330 t1 with-hm inactive tf time str beg end)
16331 (while (setq start (string-match re string start))
16332 (setq beg (match-beginning 0)
16333 end (match-end 0)
16334 t1 (save-match-data
16335 (org-parse-time-string (substring string beg end) t))
16336 with-hm (and (nth 1 t1) (nth 2 t1))
16337 inactive (equal (substring string beg (1+ beg)) "[")
16338 tf (funcall (if with-hm 'cdr 'car)
16339 org-time-stamp-custom-formats)
16340 time (org-fix-decoded-time t1)
16341 str (format-time-string
16342 (concat
16343 (if inactive "[" "<") (substring tf 1 -1)
16344 (if inactive "]" ">"))
16345 (apply 'encode-time time))
16346 string (replace-match str t t string)
16347 start (+ start (length str)))))))
16348 string)
16350 (defun org-fix-decoded-time (time)
16351 "Set 0 instead of nil for the first 6 elements of time.
16352 Don't touch the rest."
16353 (let ((n 0))
16354 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16356 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.3")
16358 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16359 "Difference between TIMESTAMP-STRING and now in days.
16360 If SECONDS is non-nil, return the difference in seconds."
16361 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16362 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16363 (funcall fdiff (current-time)))))
16365 (defun org-deadline-close (timestamp-string &optional ndays)
16366 "Is the time in TIMESTAMP-STRING close to the current date?"
16367 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16368 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16369 (not (org-entry-is-done-p))))
16371 (defun org-get-wdays (ts &optional delay zero-delay)
16372 "Get the deadline lead time appropriate for timestring TS.
16373 When DELAY is non-nil, get the delay time for scheduled items
16374 instead of the deadline lead time. When ZERO-DELAY is non-nil
16375 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16376 don't try to find the delay cookie in the scheduled timestamp."
16377 (let ((tv (if delay org-scheduled-delay-days
16378 org-deadline-warning-days)))
16379 (cond
16380 ((or (and delay (< tv 0))
16381 (and delay zero-delay (<= tv 0))
16382 (and (not delay) (<= tv 0)))
16383 ;; Enforce this value no matter what
16384 (- tv))
16386 ;; lead time is specified.
16387 (floor (* (string-to-number (match-string 1 ts))
16388 (cdr (assoc (match-string 2 ts)
16389 '(("d" . 1) ("w" . 7)
16390 ("m" . 30.4) ("y" . 365.25)
16391 ("h" . 0.041667)))))))
16392 ;; go for the default.
16393 (t tv))))
16395 (defun org-calendar-select-mouse (ev)
16396 "Return to `org-read-date' with the date currently selected.
16397 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16398 (interactive "e")
16399 (mouse-set-point ev)
16400 (when (calendar-cursor-to-date)
16401 (let* ((date (calendar-cursor-to-date))
16402 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16403 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16404 (if (active-minibuffer-window) (exit-minibuffer))))
16406 (defun org-check-deadlines (ndays)
16407 "Check if there are any deadlines due or past due.
16408 A deadline is considered due if it happens within `org-deadline-warning-days'
16409 days from today's date. If the deadline appears in an entry marked DONE,
16410 it is not shown. The prefix arg NDAYS can be used to test that many
16412 (interactive "P")
16413 (let* ((org-warn-days
16414 (cond
16415 ((equal ndays '(4)) 100000)
16416 (ndays (prefix-numeric-value ndays))
16417 (t (abs org-deadline-warning-days))))
16418 (case-fold-search nil)
16420 (callback
16421 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16423 (message "%d deadlines past-due or due within %d days"
16424 (org-occur regexp nil callback)
16425 org-warn-days)))
16427 (defsubst org-re-timestamp (type)
16428 "Return a regexp for timestamp TYPE.
16429 Allowed values for TYPE are:
16431 all: all timestamps
16432 active: only active timestamps (<...>)
16433 inactive: only inactive timestamps ([...])
16434 scheduled: only scheduled timestamps
16435 deadline: only deadline timestamps
16437 When TYPE is nil, fall back on returning a regexp that matches
16438 both scheduled and deadline timestamps."
16439 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16440 ((eq type 'active) org-ts-regexp)
16444 ((eq type 'scheduled-or-deadline)
16447 (defun org-check-before-date (date)
16448 "Check if there are deadlines or scheduled entries before DATE."
16449 (interactive (list (org-read-date)))
16450 (let ((case-fold-search nil)
16451 (regexp (org-re-timestamp org-ts-type))
16452 (callback
16453 (lambda () (time-less-p
16454 (org-time-string-to-time (match-string 1))
16455 (org-time-string-to-time date)))))
16456 (message "%d entries before %s"
16457 (org-occur regexp nil callback) date)))
16459 (defun org-check-after-date (date)
16460 "Check if there are deadlines or scheduled entries after DATE."
16461 (interactive (list (org-read-date)))
16462 (let ((case-fold-search nil)
16463 (regexp (org-re-timestamp org-ts-type))
16464 (callback
16465 (lambda () (not
16466 (time-less-p
16467 (org-time-string-to-time (match-string 1))
16468 (org-time-string-to-time date))))))
16469 (message "%d entries after %s"
16470 (org-occur regexp nil callback) date)))
16472 (defun org-check-dates-range (start-date end-date)
16473 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16474 (interactive (list (org-read-date nil nil nil "Range starts")
16475 (org-read-date nil nil nil "Range end")))
16476 (let ((case-fold-search nil)
16477 (regexp (org-re-timestamp org-ts-type))
16478 (callback
16479 (lambda ()
16480 (let ((match (match-string 1)))
16481 (and
16482 (not (time-less-p
16483 (org-time-string-to-time match)
16484 (org-time-string-to-time start-date)))
16485 (time-less-p
16486 (org-time-string-to-time match)
16487 (org-time-string-to-time end-date)))))))
16488 (message "%d entries between %s and %s"
16489 (org-occur regexp nil callback) start-date end-date)))
16491 (defun org-evaluate-time-range (&optional to-buffer)
16492 "Evaluate a time range by computing the difference between start and end.
16493 Normally the result is just printed in the echo area, but with prefix arg
16494 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16495 If the time range is actually in a table, the result is inserted into the
16496 next column.
16497 For time difference computation, a year is assumed to be exactly 365
16498 days in order to avoid rounding problems."
16499 (interactive "P")
16500 (or
16501 (org-clock-update-time-maybe)
16502 (save-excursion
16503 (unless (org-at-date-range-p t)
16504 (goto-char (point-at-bol))
16505 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16506 (if (not (org-at-date-range-p t))
16507 (error "Not at a time-stamp range, and none found in current line")))
16508 (let* ((ts1 (match-string 1))
16509 (ts2 (match-string 2))
16510 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16511 (match-end (match-end 0))
16512 (time1 (org-time-string-to-time ts1))
16513 (time2 (org-time-string-to-time ts2))
16514 (t1 (org-float-time time1))
16515 (t2 (org-float-time time2))
16516 (diff (abs (- t2 t1)))
16517 (negative (< (- t2 t1) 0))
16518 ;; (ys (floor (* 365 24 60 60)))
16519 (ds (* 24 60 60))
16520 (hs (* 60 60))
16521 (fy "%dy %dd %02d:%02d")
16522 (fy1 "%dy %dd")
16523 (fd "%dd %02d:%02d")
16524 (fd1 "%dd")
16525 (fh "%02d:%02d")
16526 y d h m align)
16527 (if havetime
16528 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16529 y 0
16530 d (floor (/ diff ds)) diff (mod diff ds)
16531 h (floor (/ diff hs)) diff (mod diff hs)
16532 m (floor (/ diff 60)))
16533 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16534 y 0
16535 d (floor (+ (/ diff ds) 0.5))
16536 h 0 m 0))
16537 (if (not to-buffer)
16538 (message "%s" (org-make-tdiff-string y d h m))
16539 (if (org-at-table-p)
16540 (progn
16541 (goto-char match-end)
16542 (setq align t)
16543 (and (looking-at " *|") (goto-char (match-end 0))))
16544 (goto-char match-end))
16545 (if (looking-at
16547 (replace-match ""))
16548 (if negative (insert " -"))
16549 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16550 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16551 (insert " " (format fh h m))))
16552 (if align (org-table-align))
16553 (message "Time difference inserted")))))
16555 (defun org-make-tdiff-string (y d h m)
16556 (let ((fmt "")
16557 (l nil))
16558 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16559 l (push y l)))
16560 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16561 l (push d l)))
16562 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16563 l (push h l)))
16564 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16565 l (push m l)))
16566 (apply 'format fmt (nreverse l))))
16568 (defun org-time-string-to-time (s &optional buffer pos)
16569 "Convert a timestamp string into internal time."
16570 (condition-case errdata
16571 (apply 'encode-time (org-parse-time-string s))
16573 s (if (not (and buffer pos))
16574 ""
16575 (format " at %d in buffer `%s'" pos buffer))
16576 (cdr errdata)))))
16578 (defun org-time-string-to-seconds (s)
16579 "Convert a timestamp string to a number of seconds."
16580 (org-float-time (org-time-string-to-time s)))
16582 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16583 "Convert a time stamp to an absolute day number.
16584 If there is a specifier for a cyclic time stamp, get the closest
16585 date to DAYNR.
16586 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16587 The variable date is bound by the calendar when this is called."
16588 (cond
16590 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16591 daynr
16592 (+ daynr 1000)))
16594 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16595 (time-to-days (current-time))) (match-string 0 s)
16596 prefer show-all))
16597 (t (time-to-days
16598 (condition-case errdata
16599 (apply 'encode-time (org-parse-time-string s))
16601 s (if (not (and buffer pos))
16602 ""
16603 (format " at %d in buffer `%s'" pos buffer))
16604 (cdr errdata))))))))
16606 (defun org-days-to-iso-week (days)
16607 "Return the iso week number."
16608 (require 'cal-iso)
16609 (car (calendar-iso-from-absolute days)))
16611 (defun org-small-year-to-year (year)
16612 "Convert 2-digit years into 4-digit years.
16613 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16614 The year 2000 cannot be abbreviated. Any year larger than 99
16615 is returned unchanged."
16616 (if (< year 38)
16617 (setq year (+ 2000 year))
16618 (if (< year 100)
16619 (setq year (+ 1900 year))))
16620 year)
16622 (defun org-time-from-absolute (d)
16623 "Return the time corresponding to date D.
16624 D may be an absolute day number, or a calendar-type list (month day year)."
16625 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16626 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16628 (defun org-calendar-holiday ()
16629 "List of holidays, for Diary display in Org-mode."
16630 (require 'holidays)
16631 (let ((hl (funcall
16632 (if (fboundp 'calendar-check-holidays)
16633 'calendar-check-holidays 'check-calendar-holidays) date)))
16634 (if hl (mapconcat 'identity hl "; "))))
16636 (defun org-diary-sexp-entry (sexp entry date)
16637 "Process a SEXP diary ENTRY for DATE."
16638 (require 'diary-lib)
16639 (let ((result (if calendar-debug-sexp
16640 (let ((stack-trace-on-error t))
16641 (eval (car (read-from-string sexp))))
16642 (condition-case nil
16643 (eval (car (read-from-string sexp)))
16644 (error
16645 (beep)
16646 (message "Bad sexp at line %d in %s: %s"
16647 (org-current-line)
16648 (buffer-file-name) sexp)
16649 (sleep-for 2))))))
16650 (cond ((stringp result) (split-string result "; "))
16651 ((and (consp result)
16652 (not (consp (cdr result)))
16653 (stringp (cdr result))) (cdr result))
16654 ((and (consp result)
16655 (stringp (car result))) result)
16656 (result entry))))
16658 (defun org-diary-to-ical-string (frombuf)
16659 "Get iCalendar entries from diary entries in buffer FROMBUF.
16660 This uses the icalendar.el library."
16661 (let* ((tmpdir (if (featurep 'xemacs)
16662 (temp-directory)
16663 temporary-file-directory))
16664 (tmpfile (make-temp-name
16665 (expand-file-name "orgics" tmpdir)))
16666 buf rtn b e)
16667 (with-current-buffer frombuf
16668 (icalendar-export-region (point-min) (point-max) tmpfile)
16669 (setq buf (find-buffer-visiting tmpfile))
16670 (set-buffer buf)
16671 (goto-char (point-min))
16672 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16673 (setq b (match-beginning 0)))
16674 (goto-char (point-max))
16675 (if (re-search-backward "^END:VEVENT" nil t)
16676 (setq e (match-end 0)))
16678 (kill-buffer buf)
16679 (delete-file tmpfile)
16680 rtn))
16682 (defun org-closest-date (start current change prefer show-all)
16683 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16684 When PREFER is `past', return a date that is either CURRENT or past.
16685 When PREFER is `future', return a date that is either CURRENT or future.
16686 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16687 ;; Make the proper lists from the dates
16688 (catch 'exit
16689 (let ((a1 '(("h" . hour)
16690 ("d" . day)
16691 ("w" . week)
16692 ("m" . month)
16693 ("y" . year)))
16694 (shour (nth 2 (org-parse-time-string start)))
16695 dn dw sday cday n1 n2 n0
16696 d m y y1 y2 date1 date2 nmonths nm ny m2)
16698 (setq start (org-date-to-gregorian start)
16699 current (org-date-to-gregorian
16700 (if show-all
16701 current
16702 (time-to-days (current-time))))
16703 sday (calendar-absolute-from-gregorian start)
16704 cday (calendar-absolute-from-gregorian current))
16706 (if (<= cday sday) (throw 'exit sday))
16709 (setq dn (string-to-number (match-string 1 change))
16710 dw (cdr (assoc (match-string 2 change) a1)))
16711 (error "Invalid change specifier: %s" change))
16712 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16713 (cond
16714 ((eq dw 'hour)
16715 (let ((missing-hours
16716 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16717 dn)))
16718 (setq n1 (if (zerop missing-hours) cday
16719 (- cday (1+ (floor (/ missing-hours 24)))))
16720 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16721 ((eq dw 'day)
16722 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16723 n2 (+ n1 dn)))
16724 ((eq dw 'year)
16725 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16726 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16727 (setq date1 (list m d y1)
16728 n1 (calendar-absolute-from-gregorian date1)
16729 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16730 n2 (calendar-absolute-from-gregorian date2)))
16731 ((eq dw 'month)
16732 ;; approx number of month between the two dates
16733 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16734 ;; How often does dn fit in there?
16735 (setq d (nth 1 start) m (car start) y (nth 2 start)
16736 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16737 m (+ m nm)
16738 ny (floor (/ m 12))
16739 y (+ y ny)
16740 m (- m (* ny 12)))
16741 (while (> m 12) (setq m (- m 12) y (1+ y)))
16742 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16743 (setq m2 (+ m dn) y2 y)
16744 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16745 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16746 (while (<= n2 cday)
16747 (setq n1 n2 m m2 y y2)
16748 (setq m2 (+ m dn) y2 y)
16749 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16750 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16751 ;; Make sure n1 is the earlier date
16752 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16753 (if show-all
16754 (cond
16755 ((eq prefer 'past) (if (= cday n2) n2 n1))
16756 ((eq prefer 'future) (if (= cday n1) n1 n2))
16757 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16758 (cond
16759 ((eq prefer 'past) (if (= cday n2) n2 n1))
16760 ((eq prefer 'future) (if (= cday n1) n1 n2))
16761 (t (if (= cday n1) n1 n2)))))))
16763 (defun org-date-to-gregorian (date)
16764 "Turn any specification of DATE into a Gregorian date for the calendar."
16765 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16766 ((and (listp date) (= (length date) 3)) date)
16767 ((stringp date)
16768 (setq date (org-parse-time-string date))
16769 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16770 ((listp date)
16771 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16773 (defun org-parse-time-string (s &optional nodefault)
16774 "Parse the standard Org-mode time string.
16775 This should be a lot faster than the normal `parse-time-string'.
16776 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16777 hour and minute fields will be nil if not given."
16778 (cond ((string-match org-ts-regexp0 s)
16779 (list 0
16780 (if (or (match-beginning 8) (not nodefault))
16781 (string-to-number (or (match-string 8 s) "0")))
16782 (if (or (match-beginning 7) (not nodefault))
16783 (string-to-number (or (match-string 7 s) "0")))
16784 (string-to-number (match-string 4 s))
16785 (string-to-number (match-string 3 s))
16786 (string-to-number (match-string 2 s))
16787 nil nil nil))
16788 ((string-match "^<[^>]+>$" s)
16789 (decode-time (seconds-to-time (org-matcher-time s))))
16790 (t (error "Not a standard Org-mode time string: %s" s))))
16792 (defun org-timestamp-up (&optional arg)
16793 "Increase the date item at the cursor by one.
16794 If the cursor is on the year, change the year. If it is on the month,
16795 the day or the time, change that.
16796 With prefix ARG, change by that many units."
16797 (interactive "p")
16798 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16800 (defun org-timestamp-down (&optional arg)
16801 "Decrease the date item at the cursor by one.
16802 If the cursor is on the year, change the year. If it is on the month,
16803 the day or the time, change that.
16804 With prefix ARG, change by that many units."
16805 (interactive "p")
16806 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16808 (defun org-timestamp-up-day (&optional arg)
16809 "Increase the date in the time stamp by one day.
16810 With prefix ARG, change that many days."
16811 (interactive "p")
16812 (if (and (not (org-at-timestamp-p t))
16813 (org-at-heading-p))
16814 (org-todo 'up)
16815 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16817 (defun org-timestamp-down-day (&optional arg)
16818 "Decrease the date in the time stamp by one day.
16819 With prefix ARG, change that many days."
16820 (interactive "p")
16821 (if (and (not (org-at-timestamp-p t))
16822 (org-at-heading-p))
16823 (org-todo 'down)
16824 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16826 (defun org-at-timestamp-p (&optional inactive-ok)
16827 "Determine if the cursor is in or at a timestamp."
16828 (interactive)
16829 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16830 (pos (point))
16831 (ans (or (looking-at tsr)
16832 (save-excursion
16834 (if (> (point) (point-min)) (backward-char 1))
16835 (and (looking-at tsr)
16836 (> (- (match-end 0) pos) -1))))))
16837 (and ans
16838 (boundp 'org-ts-what)
16839 (setq org-ts-what
16840 (cond
16841 ((= pos (match-beginning 0)) 'bracket)
16842 ;; Point is considered to be "on the bracket" whether
16843 ;; it's really on it or right after it.
16844 ((= pos (1- (match-end 0))) 'bracket)
16845 ((= pos (match-end 0)) 'after)
16846 ((org-pos-in-match-range pos 2) 'year)
16847 ((org-pos-in-match-range pos 3) 'month)
16848 ((org-pos-in-match-range pos 7) 'hour)
16849 ((org-pos-in-match-range pos 8) 'minute)
16850 ((or (org-pos-in-match-range pos 4)
16851 (org-pos-in-match-range pos 5)) 'day)
16852 ((and (> pos (or (match-end 8) (match-end 5)))
16853 (< pos (match-end 0)))
16854 (- pos (or (match-end 8) (match-end 5))))
16855 (t 'day))))
16856 ans))
16858 (defun org-toggle-timestamp-type ()
16859 "Toggle the type (<active> or [inactive]) of a time stamp."
16860 (interactive)
16861 (when (org-at-timestamp-p t)
16862 (let ((beg (match-beginning 0)) (end (match-end 0))
16863 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16864 (save-excursion
16865 (goto-char beg)
16866 (while (re-search-forward "[][<>]" end t)
16867 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16868 t t)))
16869 (message "Timestamp is now %sactive"
16870 (if (equal (char-after beg) ?<) "" "in")))))
16872 (defun org-at-clock-log-p nil
16873 "Is the cursor on the clock log line?"
16874 (save-excursion
16875 (move-beginning-of-line 1)
16878 (defvar org-clock-history) ; defined in org-clock.el
16879 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16880 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
16881 "Change the date in the time stamp at point.
16882 The date will be changed by N times WHAT. WHAT can be `day', `month',
16883 `year', `minute', `second'. If WHAT is not given, the cursor position
16884 in the timestamp determines what will be changed.
16886 (let ((origin (point)) origin-cat
16887 with-hm inactive
16888 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16889 org-ts-what
16890 extra rem
16891 ts time time0 fixnext clrgx)
16892 (if (not (org-at-timestamp-p t))
16893 (error "Not at a timestamp"))
16894 (if (and (not what) (eq org-ts-what 'bracket))
16895 (org-toggle-timestamp-type)
16896 ;; Point isn't on brackets. Remember the part of the time-stamp
16897 ;; the point was in. Indeed, size of time-stamps may change,
16898 ;; but point must be kept in the same category nonetheless.
16899 (setq origin-cat org-ts-what)
16900 (if (and (not what) (not (eq org-ts-what 'day))
16901 org-display-custom-times
16902 (get-text-property (point) 'display)
16903 (not (get-text-property (1- (point)) 'display)))
16904 (setq org-ts-what 'day))
16905 (setq org-ts-what (or what org-ts-what)
16906 inactive (= (char-after (match-beginning 0)) ?\[)
16907 ts (match-string 0))
16908 (replace-match "")
16909 (when (string-match
16910 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
16911 ts)
16912 (setq extra (match-string 1 ts))
16913 (if suppress-tmp-delay
16914 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
16916 (setq with-hm t))
16917 (setq time0 (org-parse-time-string ts))
16918 (when (and updown
16919 (eq org-ts-what 'minute)
16920 (not current-prefix-arg))
16921 ;; This looks like s-up and s-down. Change by one rounding step.
16922 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16923 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16924 (setcar (cdr time0) (+ (nth 1 time0)
16925 (if (> n 0) (- rem) (- dm rem))))))
16926 (setq time
16927 (encode-time (or (car time0) 0)
16928 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16929 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16930 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16931 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16932 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16933 (nthcdr 6 time0)))
16934 (when (and (member org-ts-what '(hour minute))
16935 extra
16937 (setq extra (org-modify-ts-extra
16938 extra
16939 (if (eq org-ts-what 'hour) 2 5)
16940 n dm)))
16941 (when (integerp org-ts-what)
16942 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16943 (if (eq what 'calendar)
16944 (let ((cal-date (org-get-date-from-calendar)))
16945 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16946 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16947 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16948 (setcar time0 (or (car time0) 0))
16949 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16950 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16951 (setq time (apply 'encode-time time0))))
16952 ;; Insert the new time-stamp, and ensure point stays in the same
16953 ;; category as before (i.e. not after the last position in that
16954 ;; category).
16955 (let ((pos (point)))
16956 ;; Stay before inserted string. `save-excursion' is of no use.
16957 (setq org-last-changed-timestamp
16958 (org-insert-time-stamp time with-hm inactive nil nil extra))
16959 (goto-char pos))
16960 (save-match-data
16961 (looking-at org-ts-regexp3)
16962 (goto-char (cond
16963 ;; `day' category ends before `hour' if any, or at
16964 ;; the end of the day name.
16965 ((eq origin-cat 'day)
16966 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16967 ((eq origin-cat 'hour) (min (match-end 7) origin))
16968 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16969 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16970 ;; `year' and `month' have both fixed size: point
16971 ;; couldn't have moved into another part.
16972 (t origin))))
16973 ;; Update clock if on a CLOCK line.
16974 (org-clock-update-time-maybe)
16975 ;; Maybe adjust the closest clock in `org-clock-history'
16976 (when org-clock-adjust-closest
16977 (if (not (and (org-at-clock-log-p)
16978 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16979 org-clock-history))))))
16980 (message "No clock to adjust")
16981 (cond ((save-excursion ; fix previous clock?
16982 (re-search-backward org-ts-regexp0 nil t)
16985 ((save-excursion ; fix next clock?
16986 (re-search-backward org-ts-regexp0 nil t)
16989 (save-window-excursion
16990 ;; Find closest clock to point, adjust the previous/next one in history
16991 (let* ((p (save-excursion (org-back-to-heading t)))
16992 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16993 (clfixnth
16994 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16995 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16996 (if (not clfixpos)
16997 (message "No clock to adjust")
16998 (save-excursion
16999 (org-goto-marker-or-bmk clfixpos)
17000 (org-show-subtree)
17001 (when (re-search-forward clrgx nil t)
17002 (goto-char (match-beginning 1))
17003 (let (org-clock-adjust-closest)
17004 (org-timestamp-change n org-ts-what updown))
17005 (message "Clock adjusted in %s for heading: %s"
17006 (file-name-nondirectory (buffer-file-name))
17007 (org-get-heading t t)))))))))
17008 ;; Try to recenter the calendar window, if any.
17009 (if (and org-calendar-follow-timestamp-change
17010 (get-buffer-window "*Calendar*" t)
17011 (memq org-ts-what '(day month year)))
17012 (org-recenter-calendar (time-to-days time))))))
17014 (defun org-modify-ts-extra (s pos n dm)
17015 "Change the different parts of the lead-time and repeat fields in timestamp."
17016 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17017 ng h m new rem)
17018 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17019 (cond
17020 ((or (org-pos-in-match-range pos 2)
17021 (org-pos-in-match-range pos 3))
17022 (setq m (string-to-number (match-string 3 s))
17023 h (string-to-number (match-string 2 s)))
17024 (if (org-pos-in-match-range pos 2)
17025 (setq h (+ h n))
17026 (setq n (* dm (org-no-warnings (signum n))))
17027 (when (not (= 0 (setq rem (% m dm))))
17028 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17029 (setq m (+ m n)))
17030 (if (< m 0) (setq m (+ m 60) h (1- h)))
17031 (if (> m 59) (setq m (- m 60) h (1+ h)))
17032 (setq h (min 24 (max 0 h)))
17033 (setq ng 1 new (format "-%02d:%02d" h m)))
17034 ((org-pos-in-match-range pos 6)
17035 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17036 ((org-pos-in-match-range pos 5)
17037 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17039 ((org-pos-in-match-range pos 9)
17040 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17041 ((org-pos-in-match-range pos 8)
17042 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17044 (when ng
17045 (setq s (concat
17046 (substring s 0 (match-beginning ng))
17047 new
17048 (substring s (match-end ng))))))
17049 s))
17051 (defun org-recenter-calendar (date)
17052 "If the calendar is visible, recenter it to DATE."
17053 (let ((cwin (get-buffer-window "*Calendar*" t)))
17054 (when cwin
17055 (let ((calendar-move-hook nil))
17056 (with-selected-window cwin
17057 (calendar-goto-date (if (listp date) date
17058 (calendar-gregorian-from-absolute date))))))))
17060 (defun org-goto-calendar (&optional arg)
17061 "Go to the Emacs calendar at the current date.
17062 If there is a time stamp in the current line, go to that date.
17063 A prefix ARG can be used to force the current date."
17064 (interactive "P")
17065 (let ((tsr org-ts-regexp) diff
17066 (calendar-move-hook nil)
17067 (calendar-view-holidays-initially-flag nil)
17068 (calendar-view-diary-initially-flag nil))
17069 (if (or (org-at-timestamp-p)
17070 (save-excursion
17071 (beginning-of-line 1)
17072 (looking-at (concat ".*" tsr))))
17073 (let ((d1 (time-to-days (current-time)))
17074 (d2 (time-to-days
17075 (org-time-string-to-time (match-string 1)))))
17076 (setq diff (- d2 d1))))
17077 (calendar)
17078 (calendar-goto-today)
17079 (if (and diff (not arg)) (calendar-forward-day diff))))
17081 (defun org-get-date-from-calendar ()
17082 "Return a list (month day year) of date at point in calendar."
17083 (with-current-buffer "*Calendar*"
17084 (save-match-data
17085 (calendar-cursor-to-date))))
17087 (defun org-date-from-calendar ()
17088 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17089 If there is already a time stamp at the cursor position, update it."
17090 (interactive)
17091 (if (org-at-timestamp-p t)
17092 (org-timestamp-change 0 'calendar)
17093 (let ((cal-date (org-get-date-from-calendar)))
17094 (org-insert-time-stamp
17095 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17097 (defcustom org-effort-durations
17098 `(("h" . 60)
17099 ("d" . ,(* 60 8))
17100 ("w" . ,(* 60 8 5))
17101 ("m" . ,(* 60 8 5 4))
17102 ("y" . ,(* 60 8 5 40)))
17103 "Conversion factor to minutes for an effort modifier.
17105 Each entry has the form (MODIFIER . MINUTES).
17107 In an effort string, a number followed by MODIFIER is multiplied
17108 by the specified number of MINUTES to obtain an effort in
17109 minutes.
17113 :group 'org-agenda
17114 :version "24.1"
17115 :type '(alist :key-type (string :tag "Modifier")
17116 :value-type (number :tag "Minutes")))
17118 (defun org-minutes-to-clocksum-string (m)
17119 "Format number of minutes as a clocksum string.
17120 The format is determined by `org-time-clocksum-format',
17121 `org-time-clocksum-use-fractional' and
17122 `org-time-clocksum-fractional-format' and
17123 `org-time-clocksum-use-effort-durations'."
17124 (let ((clocksum "") h d w mo y fmt n)
17125 (setq h (if org-time-clocksum-use-effort-durations
17126 (cdr (assoc "h" org-effort-durations)) 60)
17127 d (if org-time-clocksum-use-effort-durations
17128 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17129 w (if org-time-clocksum-use-effort-durations
17130 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17131 mo (if org-time-clocksum-use-effort-durations
17132 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17133 y (if org-time-clocksum-use-effort-durations
17134 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17135 ;; fractional format
17136 (if org-time-clocksum-use-fractional
17137 (cond
17138 ;; single format string
17139 ((stringp org-time-clocksum-fractional-format)
17140 (format org-time-clocksum-fractional-format (/ m (float h))))
17141 ;; choice of fractional formats for different time units
17142 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17143 (> (/ (truncate m) (* y d h)) 0))
17144 (format fmt (/ m (* y d (float h)))))
17145 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17146 (> (/ (truncate m) (* mo d h)) 0))
17147 (format fmt (/ m (* mo d (float h)))))
17148 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17149 (> (/ (truncate m) (* w d h)) 0))
17150 (format fmt (/ m (* w d (float h)))))
17151 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17152 (> (/ (truncate m) (* d h)) 0))
17153 (format fmt (/ m (* d (float h)))))
17154 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17155 (> (/ (truncate m) h) 0))
17156 (format fmt (/ m (float h))))
17157 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17158 (format fmt m))
17159 ;; fall back to smallest time unit with a format
17160 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17161 (format fmt (/ m (float h))))
17162 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17163 (format fmt (/ m (* d (float h)))))
17164 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17165 (format fmt (/ m (* w d (float h)))))
17166 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17167 (format fmt (/ m (* mo d (float h)))))
17168 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17169 (format fmt (/ m (* y d (float h))))))
17170 ;; standard (non-fractional) format, with single format string
17171 (if (stringp org-time-clocksum-format)
17172 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17173 ;; separate formats components
17174 (and (setq fmt (plist-get org-time-clocksum-format :years))
17175 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17176 (plist-get org-time-clocksum-format :require-years))
17177 (setq clocksum (concat clocksum (format fmt n))
17178 m (- m (* n y d h))))
17179 (and (setq fmt (plist-get org-time-clocksum-format :months))
17180 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17181 (plist-get org-time-clocksum-format :require-months))
17182 (setq clocksum (concat clocksum (format fmt n))
17183 m (- m (* n mo d h))))
17184 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17185 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17186 (plist-get org-time-clocksum-format :require-weeks))
17187 (setq clocksum (concat clocksum (format fmt n))
17188 m (- m (* n w d h))))
17189 (and (setq fmt (plist-get org-time-clocksum-format :days))
17190 (or (> (setq n (/ (truncate m) (* d h))) 0)
17191 (plist-get org-time-clocksum-format :require-days))
17192 (setq clocksum (concat clocksum (format fmt n))
17193 m (- m (* n d h))))
17194 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17195 (or (> (setq n (/ (truncate m) h)) 0)
17196 (plist-get org-time-clocksum-format :require-hours))
17197 (setq clocksum (concat clocksum (format fmt n))
17198 m (- m (* n h))))
17199 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17200 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17201 (setq clocksum (concat clocksum (format fmt m))))
17202 ;; return formatted time duration
17203 clocksum))))
17205 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17206 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17207 "Org mode version 8.0")
17209 (defun org-hours-to-clocksum-string (n)
17210 (org-minutes-to-clocksum-string (* n 60)))
17212 (defun org-hh:mm-string-to-minutes (s)
17213 "Convert a string H:MM to a number of minutes.
17214 If the string is just a number, interpret it as minutes.
17215 In fact, the first hh:mm or number in the string will be taken,
17216 there can be extra stuff in the string.
17217 If no number is found, the return value is 0."
17218 (cond
17219 ((integerp s) s)
17221 (+ (* (string-to-number (match-string 1 s)) 60)
17222 (string-to-number (match-string 2 s))))
17224 (string-to-number (match-string 1 s)))
17225 (t 0)))
17227 (defcustom org-image-actual-width t
17228 "Should we use the actual width of images when inlining them?
17230 When set to `t', always use the image width.
17232 When set to a number, use imagemagick (when available) to set
17233 the image's width to this value.
17235 When set to a number in a list, try to get the width from the
17236 #+ATTR.* keyword if it matches a width specification like
17239 When set to nil, try to get the width from an #+ATTR.* keyword
17240 and fall back on the original width if none is found.
17242 This requires Emacs >= 24.1, build with imagemagick support."
17243 :group 'org-appearance
17244 :version "24.3"
17245 :type '(choice
17246 (const :tag "Use the image width" t)
17247 (integer :tag "Use a number of pixels")
17248 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17249 (const :tag "Use #+ATTR* or don't resize" nil)))
17251 (defcustom org-agenda-inhibit-startup t
17252 "Inhibit startup when preparing agenda buffers.
17253 When this variable is `t' (the default), the initialization of
17254 the Org agenda buffers is inhibited: e.g. the visibility state
17255 is not set, the tables are not re-aligned, etc."
17256 :type 'boolean
17257 :version "24.3"
17258 :group 'org-agenda)
17260 (defun org-duration-string-to-minutes (s &optional output-to-string)
17261 "Convert a duration string S to minutes.
17263 A bare number is interpreted as minutes, modifiers can be set by
17264 customizing `org-effort-durations' (which see).
17266 Entries containing a colon are interpreted as H:MM by
17267 `org-hh:mm-string-to-minutes'."
17268 (let ((result 0)
17270 (regexp-opt (mapcar 'car org-effort-durations))
17272 (while (string-match re s)
17273 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17274 (string-to-number (match-string 1 s))))
17275 (setq s (replace-match "" nil t s)))
17276 (setq result (floor result))
17277 (incf result (org-hh:mm-string-to-minutes s))
17278 (if output-to-string (number-to-string result) result)))
17280 ;;;; Files
17282 (defun org-save-all-org-buffers ()
17283 "Save all Org-mode buffers without user confirmation."
17284 (interactive)
17285 (message "Saving all Org-mode buffers...")
17286 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17287 (when (featurep 'org-id) (org-id-locations-save))
17288 (message "Saving all Org-mode buffers... done"))
17290 (defun org-revert-all-org-buffers ()
17291 "Revert all Org-mode buffers.
17292 Prompt for confirmation when there are unsaved changes.
17293 Be sure you know what you are doing before letting this function
17294 overwrite your changes.
17296 This function is useful in a setup where one tracks org files
17297 with a version control system, to revert on one machine after pulling
17298 changes from another. I believe the procedure must be like this:
17300 1. M-x org-save-all-org-buffers
17301 2. Pull changes from the other machine, resolve conflicts
17302 3. M-x org-revert-all-org-buffers"
17303 (interactive)
17304 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17305 (error "Abort"))
17306 (save-excursion
17307 (save-window-excursion
17308 (mapc
17309 (lambda (b)
17310 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17311 (with-current-buffer b buffer-file-name))
17312 (org-pop-to-buffer-same-window b)
17313 (revert-buffer t 'no-confirm)))
17314 (buffer-list))
17315 (when (and (featurep 'org-id) org-id-track-globally)
17316 (org-id-locations-load)))))
17318 ;;;; Agenda files
17320 ;;;###autoload
17321 (defun org-switchb (&optional arg)
17322 "Switch between Org buffers.
17323 With one prefix argument, restrict available buffers to files.
17324 With two prefix arguments, restrict available buffers to agenda files.
17326 Defaults to `iswitchb' for buffer name completion.
17327 Set `org-completion-use-ido' to make it use ido instead."
17328 (interactive "P")
17329 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17330 ((equal arg '(16)) (org-buffer-list 'agenda))
17331 (t (org-buffer-list))))
17332 (org-completion-use-iswitchb org-completion-use-iswitchb)
17333 (org-completion-use-ido org-completion-use-ido))
17334 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17335 (setq org-completion-use-iswitchb t))
17336 (org-pop-to-buffer-same-window
17337 (org-icompleting-read "Org buffer: "
17338 (mapcar 'list (mapcar 'buffer-name blist))
17339 nil t))))
17341 ;;; Define some older names previously used for this functionality
17342 ;;;###autoload
17343 (defalias 'org-ido-switchb 'org-switchb)
17344 ;;;###autoload
17345 (defalias 'org-iswitchb 'org-switchb)
17347 (defun org-buffer-list (&optional predicate exclude-tmp)
17348 "Return a list of Org buffers.
17349 PREDICATE can be `export', `files' or `agenda'.
17351 export restrict the list to Export buffers.
17352 files restrict the list to buffers visiting Org files.
17353 agenda restrict the list to buffers visiting agenda files.
17355 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17356 (let* ((bfn nil)
17357 (agenda-files (and (eq predicate 'agenda)
17358 (mapcar 'file-truename (org-agenda-files t))))
17359 (filter
17360 (cond
17361 ((eq predicate 'files)
17362 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17363 ((eq predicate 'export)
17364 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17365 ((eq predicate 'agenda)
17366 (lambda (b)
17367 (with-current-buffer b
17368 (and (derived-mode-p 'org-mode)
17369 (setq bfn (buffer-file-name b))
17370 (member (file-truename bfn) agenda-files)))))
17371 (t (lambda (b) (with-current-buffer b
17372 (or (derived-mode-p 'org-mode)
17373 (string-match "\*Org .*Export"
17374 (buffer-name b)))))))))
17375 (delq nil
17376 (mapcar
17377 (lambda(b)
17378 (if (and (funcall filter b)
17379 (or (not exclude-tmp)
17380 (not (string-match "tmp" (buffer-name b)))))
17381 b
17382 nil))
17383 (buffer-list)))))
17385 (defun org-agenda-files (&optional unrestricted archives)
17386 "Get the list of agenda files.
17387 Optional UNRESTRICTED means return the full list even if a restriction
17388 is currently in place.
17389 When ARCHIVES is t, include all archive files that are really being
17390 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17391 `org-agenda-archives-mode' is t."
17392 (let ((files
17393 (cond
17394 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17395 ((stringp org-agenda-files) (org-read-agenda-file-list))
17396 ((listp org-agenda-files) org-agenda-files)
17397 (t (error "Invalid value of `org-agenda-files'")))))
17398 (setq files (apply 'append
17399 (mapcar (lambda (f)
17400 (if (file-directory-p f)
17401 (directory-files
17402 f t org-agenda-file-regexp)
17403 (list f)))
17404 files)))
17405 (when org-agenda-skip-unavailable-files
17406 (setq files (delq nil
17407 (mapcar (function
17408 (lambda (file)
17409 (and (file-readable-p file) file)))
17410 files))))
17411 (when (or (eq archives t)
17412 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17413 (setq files (org-add-archive-files files)))
17414 files))
17416 (defun org-agenda-file-p (&optional file)
17417 "Return non-nil, if FILE is an agenda file.
17418 If FILE is omitted, use the file associated with the current
17419 buffer."
17420 (member (or file (buffer-file-name))
17421 (org-agenda-files t)))
17423 (defun org-edit-agenda-file-list ()
17424 "Edit the list of agenda files.
17425 Depending on setup, this either uses customize to edit the variable
17426 `org-agenda-files', or it visits the file that is holding the list. In the
17427 latter case, the buffer is set up in a way that saving it automatically kills
17428 the buffer and restores the previous window configuration."
17429 (interactive)
17430 (if (stringp org-agenda-files)
17431 (let ((cw (current-window-configuration)))
17432 (find-file org-agenda-files)
17433 (org-set-local 'org-window-configuration cw)
17434 (org-add-hook 'after-save-hook
17435 (lambda ()
17436 (set-window-configuration
17437 (prog1 org-window-configuration
17438 (kill-buffer (current-buffer))))
17439 (org-install-agenda-files-menu)
17440 (message "New agenda file list installed"))
17441 nil 'local)
17442 (message "%s" (substitute-command-keys
17444 (customize-variable 'org-agenda-files)))
17446 (defun org-store-new-agenda-file-list (list)
17447 "Set new value for the agenda file list and save it correctly."
17448 (if (stringp org-agenda-files)
17449 (let ((fe (org-read-agenda-file-list t)) b u)
17450 (while (setq b (find-buffer-visiting org-agenda-files))
17451 (kill-buffer b))
17452 (with-temp-file org-agenda-files
17453 (insert
17454 (mapconcat
17455 (lambda (f) ;; Keep un-expanded entries.
17456 (if (setq u (assoc f fe))
17457 (cdr u)
17458 f))
17461 (let ((org-mode-hook nil) (org-inhibit-startup t)
17462 (org-insert-mode-line-in-empty-file nil))
17463 (setq org-agenda-files list)
17464 (customize-save-variable 'org-agenda-files org-agenda-files))))
17466 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17467 "Read the list of agenda files from a file.
17468 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17469 filenames, used by `org-store-new-agenda-file-list' to write back
17470 un-expanded file names."
17471 (when (file-directory-p org-agenda-files)
17472 (error "`org-agenda-files' cannot be a single directory"))
17473 (when (stringp org-agenda-files)
17474 (with-temp-buffer
17475 (insert-file-contents org-agenda-files)
17476 (mapcar
17477 (lambda (f)
17478 (let ((e (expand-file-name (substitute-in-file-name f)
17479 org-directory)))
17480 (if pair-with-expansion
17481 (cons e f)
17482 e)))
17485 ;;;###autoload
17486 (defun org-cycle-agenda-files ()
17487 "Cycle through the files in `org-agenda-files'.
17488 If the current buffer visits an agenda file, find the next one in the list.
17489 If the current buffer does not, find the first agenda file."
17490 (interactive)
17491 (let* ((fs (org-agenda-files t))
17492 (files (append fs (list (car fs))))
17493 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17494 file)
17495 (unless files (error "No agenda files"))
17496 (catch 'exit
17497 (while (setq file (pop files))
17498 (if (equal (file-truename file) tcf)
17499 (when (car files)
17500 (find-file (car files))
17501 (throw 'exit t))))
17502 (find-file (car fs)))
17503 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17505 (defun org-agenda-file-to-front (&optional to-end)
17506 "Move/add the current file to the top of the agenda file list.
17507 If the file is not present in the list, it is added to the front. If it is
17508 present, it is moved there. With optional argument TO-END, add/move to the
17509 end of the list."
17510 (interactive "P")
17511 (let ((org-agenda-skip-unavailable-files nil)
17512 (file-alist (mapcar (lambda (x)
17513 (cons (file-truename x) x))
17514 (org-agenda-files t)))
17515 (ctf (file-truename
17516 (or buffer-file-name
17517 (error "Please save the current buffer to a file"))))
17518 x had)
17519 (setq x (assoc ctf file-alist) had x)
17521 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17522 (if to-end
17523 (setq file-alist (append (delq x file-alist) (list x)))
17524 (setq file-alist (cons x (delq x file-alist))))
17525 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17526 (org-install-agenda-files-menu)
17527 (message "File %s to %s of agenda file list"
17528 (if had "moved" "added") (if to-end "end" "front"))))
17530 (defun org-remove-file (&optional file)
17531 "Remove current file from the list of files in variable `org-agenda-files'.
17532 These are the files which are being checked for agenda entries.
17533 Optional argument FILE means use this file instead of the current."
17534 (interactive)
17535 (let* ((org-agenda-skip-unavailable-files nil)
17536 (file (or file buffer-file-name
17537 (error "Current buffer does not visit a file")))
17538 (true-file (file-truename file))
17539 (afile (abbreviate-file-name file))
17540 (files (delq nil (mapcar
17541 (lambda (x)
17542 (if (equal true-file
17543 (file-truename x))
17544 nil x))
17545 (org-agenda-files t)))))
17546 (if (not (= (length files) (length (org-agenda-files t))))
17547 (progn
17548 (org-store-new-agenda-file-list files)
17549 (org-install-agenda-files-menu)
17550 (message "Removed file: %s" afile))
17551 (message "File was not in list: %s (not removed)" afile))))
17553 (defun org-file-menu-entry (file)
17554 (vector file (list 'find-file file) t))
17556 (defun org-check-agenda-file (file)
17557 "Make sure FILE exists. If not, ask user what to do."
17558 (when (not (file-exists-p file))
17559 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17560 (abbreviate-file-name file))
17561 (let ((r (downcase (read-char-exclusive))))
17562 (cond
17563 ((equal r ?r)
17564 (org-remove-file file)
17565 (throw 'nextfile t))
17566 (t (error "Abort"))))))
17568 (defun org-get-agenda-file-buffer (file)
17569 "Get a buffer visiting FILE. If the buffer needs to be created, add
17570 it to the list of buffers which might be released later."
17571 (let ((buf (org-find-base-buffer-visiting file)))
17572 (if buf
17573 buf ; just return it
17574 ;; Make a new buffer and remember it
17575 (setq buf (find-file-noselect file))
17576 (if buf (push buf org-agenda-new-buffers))
17577 buf)))
17579 (defun org-release-buffers (blist)
17580 "Release all buffers in list, asking the user for confirmation when needed.
17581 When a buffer is unmodified, it is just killed. When modified, it is saved
17582 \(if the user agrees) and then killed."
17583 (let (buf file)
17584 (while (setq buf (pop blist))
17585 (setq file (buffer-file-name buf))
17586 (when (and (buffer-modified-p buf)
17587 file
17588 (y-or-n-p (format "Save file %s? " file)))
17589 (with-current-buffer buf (save-buffer)))
17590 (kill-buffer buf))))
17592 (defun org-agenda-prepare-buffers (files)
17593 "Create buffers for all agenda files, protect archived trees and comments."
17594 (interactive)
17595 (let ((pa '(:org-archived t))
17596 (pc '(:org-comment t))
17597 (pall '(:org-archived t :org-comment t))
17598 (inhibit-read-only t)
17599 (org-inhibit-startup org-agenda-inhibit-startup)
17600 (rea (concat ":" org-archive-tag ":"))
17601 file re)
17602 (save-excursion
17603 (save-restriction
17604 (while (setq file (pop files))
17605 (catch 'nextfile
17606 (if (bufferp file)
17607 (set-buffer file)
17608 (org-check-agenda-file file)
17609 (set-buffer (org-get-agenda-file-buffer file)))
17610 (widen)
17611 (org-refresh-category-properties)
17612 (org-refresh-properties org-effort-property 'org-effort)
17613 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17614 (setq org-todo-keywords-for-agenda
17615 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17616 (setq org-done-keywords-for-agenda
17617 (append org-done-keywords-for-agenda org-done-keywords))
17618 (setq org-todo-keyword-alist-for-agenda
17619 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17620 (setq org-drawers-for-agenda
17621 (append org-drawers-for-agenda org-drawers))
17622 (setq org-tag-alist-for-agenda
17623 (append org-tag-alist-for-agenda org-tag-alist))
17624 (with-silent-modifications
17625 (save-excursion
17626 (remove-text-properties (point-min) (point-max) pall)
17627 (when org-agenda-skip-archived-trees
17628 (goto-char (point-min))
17629 (while (re-search-forward rea nil t)
17630 (if (org-at-heading-p t)
17631 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17632 (goto-char (point-min))
17633 (setq re (format org-heading-keyword-regexp-format
17634 org-comment-string))
17635 (while (re-search-forward re nil t)
17636 (add-text-properties
17637 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17638 (setq org-todo-keywords-for-agenda
17639 (org-uniquify org-todo-keywords-for-agenda))
17640 (setq org-todo-keyword-alist-for-agenda
17641 (org-uniquify org-todo-keyword-alist-for-agenda)
17642 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17644 \f
17645 ;;;; CDLaTeX minor mode
17647 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17648 "Keymap for the minor `org-cdlatex-mode'.")
17650 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17651 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17652 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17653 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17654 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17656 (defvar org-cdlatex-texmathp-advice-is-done nil
17657 "Flag remembering if we have applied the advice to texmathp already.")
17659 (define-minor-mode org-cdlatex-mode
17660 "Toggle the minor `org-cdlatex-mode'.
17661 This mode supports entering LaTeX environment and math in LaTeX fragments
17662 in Org-mode.
17664 nil " OCDL" nil
17665 (when org-cdlatex-mode
17666 (require 'cdlatex)
17667 (run-hooks 'cdlatex-mode-hook)
17668 (cdlatex-compute-tables))
17669 (unless org-cdlatex-texmathp-advice-is-done
17670 (setq org-cdlatex-texmathp-advice-is-done t)
17671 (defadvice texmathp (around org-math-always-on activate)
17672 "Always return t in org-mode buffers.
17673 This is because we want to insert math symbols without dollars even outside
17674 the LaTeX math segments. If Orgmode thinks that point is actually inside
17675 an embedded LaTeX fragment, let texmathp do its job.
17677 (interactive)
17678 (let (p)
17679 (cond
17680 ((not (derived-mode-p 'org-mode)) ad-do-it)
17681 ((eq this-command 'cdlatex-math-symbol)
17682 (setq ad-return-value t
17683 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17684 (t
17685 (let ((p (org-inside-LaTeX-fragment-p)))
17686 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17687 (setq ad-return-value t
17688 texmathp-why '("Org-mode embedded math" . 0))
17689 (if p ad-do-it)))))))))
17691 (defun turn-on-org-cdlatex ()
17692 "Unconditionally turn on `org-cdlatex-mode'."
17693 (org-cdlatex-mode 1))
17695 (defun org-try-cdlatex-tab ()
17696 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17697 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17698 - inside a LaTeX fragment, or
17699 - after the first word in a line, where an abbreviation expansion could
17700 insert a LaTeX environment."
17701 (when org-cdlatex-mode
17702 (cond
17703 ;; Before any word on the line: No expansion possible.
17705 ;; Just after first word on the line: Expand it. Make sure it
17706 ;; cannot happen on headlines, though.
17707 ((save-excursion
17708 (skip-chars-backward "a-zA-Z0-9*")
17710 (and (bolp) (not (org-at-heading-p))))
17711 (cdlatex-tab) t)
17712 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17714 (defun org-cdlatex-underscore-caret (&optional arg)
17715 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17716 Revert to the normal definition outside of these fragments."
17717 (interactive "P")
17718 (if (org-inside-LaTeX-fragment-p)
17719 (call-interactively 'cdlatex-sub-superscript)
17720 (let (org-cdlatex-mode)
17721 (call-interactively (key-binding (vector last-input-event))))))
17723 (defun org-cdlatex-math-modify (&optional arg)
17724 "Execute `cdlatex-math-modify' in LaTeX fragments.
17725 Revert to the normal definition outside of these fragments."
17726 (interactive "P")
17727 (if (org-inside-LaTeX-fragment-p)
17728 (call-interactively 'cdlatex-math-modify)
17729 (let (org-cdlatex-mode)
17730 (call-interactively (key-binding (vector last-input-event))))))
17733 \f
17734 ;;;; LaTeX fragments
17736 (defvar org-latex-regexps
17738 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17741 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17745 "Regular expressions for matching embedded LaTeX.")
17747 (defun org-inside-LaTeX-fragment-p ()
17748 "Test if point is inside a LaTeX fragment.
17750 sequence appearing also before point.
17751 Even though the matchers for math are configurable, this function assumes
17753 delimiters are skipped when they have been removed by customization.
17754 The return value is nil, or a cons cell with the delimiter and the
17755 position of this delimiter.
17757 This function does a reasonably good job, but can locally be fooled by
17758 for example currency specifications. For example it will assume being in
17760 fragments that are properly closed, but during editing, we have to live
17761 with the uncertainty caused by missing closing delimiters. This function
17762 looks only before point, not after."
17763 (catch 'exit
17764 (let ((pos (point))
17765 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17766 (lim (progn
17768 (point)))
17769 dd-on str (start 0) m re)
17770 (goto-char pos)
17771 (when dodollar
17773 re (nth 1 (assoc "$" org-latex-regexps)))
17774 (while (string-match re str start)
17775 (cond
17776 ((= (match-end 0) (length str))
17777 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17778 ((= (match-end 0) (- (length str) 5))
17779 (throw 'exit nil))
17780 (t (setq start (match-end 0))))))
17781 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17782 (goto-char pos)
17783 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17784 (and (match-beginning 2) (throw 'exit nil))
17785 ;; count $$
17787 (setq dd-on (not dd-on)))
17788 (goto-char pos)
17789 (if dd-on (cons "$$" m))))))
17791 (defun org-inside-latex-macro-p ()
17792 "Is point inside a LaTeX macro or its arguments?"
17793 (save-match-data
17794 (org-in-regexp
17797 (defvar org-latex-fragment-image-overlays nil
17798 "List of overlays carrying the images of latex fragments.")
17799 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17801 (defun org-remove-latex-fragment-image-overlays ()
17802 "Remove all overlays with LaTeX fragment images in current buffer."
17803 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17804 (setq org-latex-fragment-image-overlays nil))
17806 (defun org-preview-latex-fragment (&optional subtree)
17807 "Preview the LaTeX fragment at point, or all locally or globally.
17808 If the cursor is in a LaTeX fragment, create the image and overlay
17809 it over the source code. If there is no fragment at point, display
17810 all fragments in the current text, from one headline to the next. With
17811 prefix SUBTREE, display all fragments in the current subtree. With a
17813 the cursor is before the first headline,
17814 display all fragments in the buffer.
17816 (interactive "P")
17817 (unless buffer-file-name
17818 (error "Can't preview LaTeX fragment in a non-file buffer"))
17819 (org-remove-latex-fragment-image-overlays)
17820 (save-excursion
17821 (save-restriction
17822 (let (beg end at msg)
17823 (cond
17824 ((or (equal subtree '(16))
17825 (not (save-excursion
17826 (re-search-backward org-outline-regexp-bol nil t))))
17827 (setq beg (point-min) end (point-max)
17828 msg "Creating images for buffer...%s"))
17829 ((equal subtree '(4))
17830 (org-back-to-heading)
17831 (setq beg (point) end (org-end-of-subtree t)
17832 msg "Creating images for subtree...%s"))
17833 (t
17834 (if (setq at (org-inside-LaTeX-fragment-p))
17835 (goto-char (max (point-min) (- (cdr at) 2)))
17836 (org-back-to-heading))
17837 (setq beg (point) end (progn (outline-next-heading) (point))
17838 msg (if at "Creating image...%s"
17839 "Creating images for entry...%s"))))
17840 (message msg "")
17841 (narrow-to-region beg end)
17842 (goto-char beg)
17843 (org-format-latex
17844 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17845 (file-name-nondirectory
17846 buffer-file-name)))
17847 default-directory 'overlays msg at 'forbuffer
17848 org-latex-create-formula-image-program)
17849 (message msg "done. Use `C-c C-c' to remove images.")))))
17851 (defun org-format-latex (prefix &optional dir overlays msg at
17852 forbuffer processing-type)
17853 "Replace LaTeX fragments with links to an image, and produce images.
17854 Some of the options can be changed using the variable
17855 `org-format-latex-options'."
17856 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17857 (let* ((prefixnodir (file-name-nondirectory prefix))
17858 (absprefix (expand-file-name prefix dir))
17859 (todir (file-name-directory absprefix))
17860 (opt org-format-latex-options)
17861 (optnew org-format-latex-options)
17862 (matchers (plist-get opt :matchers))
17863 (re-list org-latex-regexps)
17864 (cnt 0) txt hash link beg end re e checkdir
17865 string
17866 m n block-type block linkfile movefile ov)
17867 ;; Check the different regular expressions
17868 (while (setq e (pop re-list))
17869 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17871 (when (member m matchers)
17872 (goto-char (point-min))
17873 (while (re-search-forward re nil t)
17874 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17875 (or (not overlays)
17876 (not (eq (get-char-property (match-beginning n)
17877 'org-overlay-type)
17878 'org-latex-overlay))))
17879 (cond
17880 ((eq processing-type 'verbatim))
17881 ((eq processing-type 'mathjax)
17882 ;; Prepare for MathJax processing.
17883 (setq string (match-string n))
17884 (when (member m '("$" "$1"))
17885 (save-excursion
17886 (delete-region (match-beginning n) (match-end n))
17887 (goto-char (match-beginning n))
17889 ((or (eq processing-type 'dvipng)
17890 (eq processing-type 'imagemagick))
17891 ;; Process to an image.
17892 (setq txt (match-string n)
17893 beg (match-beginning n) end (match-end n)
17894 cnt (1+ cnt))
17895 (let ((face (face-at-point))
17896 (fg (plist-get opt :foreground))
17897 (bg (plist-get opt :background))
17898 ;; Ensure full list is printed.
17899 print-length print-level)
17900 (when forbuffer
17901 ;; Get the colors from the face at point.
17902 (goto-char beg)
17903 (when (eq fg 'auto)
17904 (setq fg (face-attribute face :foreground nil 'default)))
17905 (when (eq bg 'auto)
17906 (setq bg (face-attribute face :background nil 'default)))
17907 (setq optnew (copy-sequence opt))
17908 (plist-put optnew :foreground fg)
17909 (plist-put optnew :background bg))
17910 (setq hash (sha1 (prin1-to-string
17911 (list org-format-latex-header
17912 org-latex-default-packages-alist
17913 org-latex-packages-alist
17914 org-format-latex-options
17915 forbuffer txt fg bg)))
17916 linkfile (format "%s_%s.png" prefix hash)
17917 movefile (format "%s_%s.png" absprefix hash)))
17918 (setq link (concat block "[[file:" linkfile "]]" block))
17919 (if msg (message msg cnt))
17920 (goto-char beg)
17921 (unless checkdir ; Ensure the directory exists.
17922 (setq checkdir t)
17923 (or (file-directory-p todir) (make-directory todir t)))
17924 (unless (file-exists-p movefile)
17925 (org-create-formula-image
17926 txt movefile optnew forbuffer processing-type))
17927 (if overlays
17928 (progn
17929 (mapc (lambda (o)
17930 (if (eq (overlay-get o 'org-overlay-type)
17931 'org-latex-overlay)
17932 (delete-overlay o)))
17933 (overlays-in beg end))
17934 (setq ov (make-overlay beg end))
17935 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17936 (if (featurep 'xemacs)
17937 (progn
17938 (overlay-put ov 'invisible t)
17939 (overlay-put
17940 ov 'end-glyph
17941 (make-glyph (vector 'png :file movefile))))
17942 (overlay-put
17943 ov 'display
17944 (list 'image :type 'png :file movefile :ascent 'center)))
17945 (push ov org-latex-fragment-image-overlays)
17946 (goto-char end))
17947 (delete-region beg end)
17948 (insert (org-add-props link
17949 (list 'org-latex-src
17950 (replace-regexp-in-string
17952 'org-latex-src-embed-type
17953 (if block-type 'paragraph 'character))))))
17954 ((eq processing-type 'mathml)
17955 ;; Process to MathML
17956 (unless (save-match-data (org-format-latex-mathml-available-p))
17957 (error "LaTeX to MathML converter not configured"))
17958 (setq txt (match-string n)
17959 beg (match-beginning n) end (match-end n)
17960 cnt (1+ cnt))
17961 (if msg (message msg cnt))
17962 (goto-char beg)
17963 (delete-region beg end)
17964 (insert (org-format-latex-as-mathml
17965 txt block-type prefix dir)))
17966 (t
17967 (error "Unknown conversion type %s for latex fragments"
17968 processing-type)))))))))
17970 (defun org-create-math-formula (latex-frag &optional mathml-file)
17971 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17972 Use `org-latex-to-mathml-convert-command'. If the conversion is
17974 elements otherwise return nil. When MATHML-FILE is specified,
17975 write the results in to that file. When invoked as an
17976 interactive command, prompt for LATEX-FRAG, with initial value
17977 set to the current active region and echo the results for user
17978 inspection."
17979 (interactive (list (let ((frag (when (org-region-active-p)
17980 (buffer-substring-no-properties
17981 (region-beginning) (region-end)))))
17982 (read-string "LaTeX Fragment: " frag nil frag))))
17983 (unless latex-frag (error "Invalid latex-frag"))
17984 (let* ((tmp-in-file (file-relative-name
17985 (make-temp-name (expand-file-name "ltxmathml-in"))))
17986 (ignore (write-region latex-frag nil tmp-in-file))
17987 (tmp-out-file (file-relative-name
17988 (make-temp-name (expand-file-name "ltxmathml-out"))))
17989 (cmd (format-spec
17990 org-latex-to-mathml-convert-command
17991 `((?j . ,(shell-quote-argument
17992 (expand-file-name org-latex-to-mathml-jar-file)))
17993 (?I . ,(shell-quote-argument tmp-in-file))
17994 (?o . ,(shell-quote-argument tmp-out-file)))))
17995 mathml shell-command-output)
17996 (when (org-called-interactively-p 'any)
17997 (unless (org-format-latex-mathml-available-p)
17998 (error "LaTeX to MathML converter not configured")))
17999 (message "Running %s" cmd)
18000 (setq shell-command-output (shell-command-to-string cmd))
18001 (setq mathml
18002 (when (file-readable-p tmp-out-file)
18003 (with-current-buffer (find-file-noselect tmp-out-file t)
18004 (goto-char (point-min))
18005 (when (re-search-forward
18006 (concat
18007 (regexp-quote
18010 (regexp-quote "</math>")) nil t)
18011 (prog1 (match-string 0) (kill-buffer))))))
18012 (cond
18013 (mathml
18014 (setq mathml
18016 (when mathml-file
18017 (write-region mathml nil mathml-file))
18018 (when (org-called-interactively-p 'any)
18019 (message mathml)))
18020 ((message "LaTeX to MathML conversion failed")
18021 (message shell-command-output)))
18022 (delete-file tmp-in-file)
18023 (when (file-exists-p tmp-out-file)
18024 (delete-file tmp-out-file))
18025 mathml))
18027 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18028 prefix &optional dir)
18029 "Use `org-create-math-formula' but check local cache first."
18030 (let* ((absprefix (expand-file-name prefix dir))
18031 (print-length nil) (print-level nil)
18032 (formula-id (concat
18033 "formula-"
18034 (sha1
18035 (prin1-to-string
18036 (list latex-frag
18037 org-latex-to-mathml-convert-command)))))
18038 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18039 (formula-cache-dir (file-name-directory formula-cache)))
18041 (unless (file-directory-p formula-cache-dir)
18042 (make-directory formula-cache-dir t))
18044 (unless (file-exists-p formula-cache)
18045 (org-create-math-formula latex-frag formula-cache))
18047 (if (file-exists-p formula-cache)
18048 ;; Successful conversion. Return the link to MathML file.
18049 (org-add-props
18050 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18052 'org-latex-src-embed-type (if latex-frag-type
18053 'paragraph 'character)))
18054 ;; Failed conversion. Return the LaTeX fragment verbatim
18055 latex-frag)))
18057 (defun org-create-formula-image (string tofile options buffer &optional type)
18058 "Create an image from LaTeX source using dvipng or convert.
18059 This function calls either `org-create-formula-image-with-dvipng'
18060 or `org-create-formula-image-with-imagemagick' depending on the
18061 value of `org-latex-create-formula-image-program' or on the value
18062 of the optional TYPE variable.
18064 Note: ultimately these two function should be combined as they
18065 share a good deal of logic."
18066 (org-check-external-command
18067 "latex" "needed to convert LaTeX fragments to images")
18068 (funcall
18069 (case (or type org-latex-create-formula-image-program)
18070 ('dvipng
18071 (org-check-external-command
18072 "dvipng" "needed to convert LaTeX fragments to images")
18073 #'org-create-formula-image-with-dvipng)
18074 ('imagemagick
18075 (org-check-external-command
18076 "convert" "you need to install imagemagick")
18077 #'org-create-formula-image-with-imagemagick)
18078 (t (error
18079 "invalid value of `org-latex-create-formula-image-program'")))
18080 string tofile options buffer))
18082 ;; This function borrows from Ganesh Swami's latex2png.el
18083 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18084 "This calls dvipng."
18085 (let* ((tmpdir (if (featurep 'xemacs)
18086 (temp-directory)
18087 temporary-file-directory))
18088 (texfilebase (make-temp-name
18089 (expand-file-name "orgtex" tmpdir)))
18090 (texfile (concat texfilebase ".tex"))
18091 (dvifile (concat texfilebase ".dvi"))
18092 (pngfile (concat texfilebase ".png"))
18093 (fnh (if (featurep 'xemacs)
18094 (font-height (face-font 'default))
18095 (face-attribute 'default :height nil)))
18096 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18097 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18098 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18099 "Black"))
18100 (bg (or (plist-get options (if buffer :background :html-background))
18101 "Transparent")))
18102 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18103 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18104 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18105 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18106 (with-temp-file texfile
18107 (require 'ox-latex)
18108 (insert (org-latex-guess-inputenc
18109 (org-splice-latex-header
18110 org-format-latex-header
18111 org-latex-default-packages-alist
18112 org-latex-packages-alist t)))
18114 (let ((dir default-directory))
18115 (condition-case nil
18116 (progn
18117 (cd tmpdir)
18118 (call-process "latex" nil nil nil texfile))
18119 (error nil))
18120 (cd dir))
18121 (if (not (file-exists-p dvifile))
18122 (progn (message "Failed to create dvi file from %s" texfile) nil)
18123 (condition-case nil
18124 (if (featurep 'xemacs)
18125 (call-process "dvipng" nil nil nil
18126 "-fg" fg "-bg" bg
18127 "-T" "tight"
18128 "-o" pngfile
18129 dvifile)
18130 (call-process "dvipng" nil nil nil
18131 "-fg" fg "-bg" bg
18132 "-D" dpi
18133 ;;"-x" scale "-y" scale
18134 "-T" "tight"
18135 "-o" pngfile
18136 dvifile))
18137 (error nil))
18138 (if (not (file-exists-p pngfile))
18139 (if org-format-latex-signal-error
18140 (error "Failed to create png file from %s" texfile)
18141 (message "Failed to create png file from %s" texfile)
18142 nil)
18143 ;; Use the requested file name and clean up
18144 (copy-file pngfile tofile 'replace)
18145 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18146 (if (file-exists-p (concat texfilebase e))
18147 (delete-file (concat texfilebase e))))
18148 pngfile))))
18150 (defvar org-latex-pdf-process) ; From ox-latex.el
18151 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18152 "This calls convert, which is included into imagemagick."
18153 (let* ((tmpdir (if (featurep 'xemacs)
18154 (temp-directory)
18155 temporary-file-directory))
18156 (texfilebase (make-temp-name
18157 (expand-file-name "orgtex" tmpdir)))
18158 (texfile (concat texfilebase ".tex"))
18159 (pdffile (concat texfilebase ".pdf"))
18160 (pngfile (concat texfilebase ".png"))
18161 (fnh (if (featurep 'xemacs)
18162 (font-height (face-font 'default))
18163 (face-attribute 'default :height nil)))
18164 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18165 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18166 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18167 "black"))
18168 (bg (or (plist-get options (if buffer :background :html-background))
18169 "white")))
18170 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18171 (setq fg (org-latex-color-format fg)))
18172 (if (eq bg 'default) (setq bg (org-latex-color :background))
18173 (setq bg (org-latex-color-format
18174 (if (string= bg "Transparent") "white" bg))))
18175 (with-temp-file texfile
18176 (require 'ox-latex)
18177 (insert (org-latex-guess-inputenc
18178 (org-splice-latex-header
18179 org-format-latex-header
18180 org-latex-default-packages-alist
18181 org-latex-packages-alist t)))
18187 string
18190 (let ((dir default-directory) cmd cmds latex-frags-cmds)
18191 (condition-case nil
18192 (progn
18193 (cd tmpdir)
18194 (setq cmds org-latex-pdf-process)
18195 (while cmds
18196 (setq latex-frags-cmds (pop cmds))
18197 (if (listp latex-frags-cmds)
18198 (setq cmds nil)
18199 (setq latex-frags-cmds (list (car org-latex-pdf-process)))))
18200 (while latex-frags-cmds
18201 (setq cmd (pop latex-frags-cmds))
18202 (while (string-match "%b" cmd)
18203 (setq cmd (replace-match
18204 (save-match-data
18205 (shell-quote-argument texfile))
18206 t t cmd)))
18207 (while (string-match "%f" cmd)
18208 (setq cmd (replace-match
18209 (save-match-data
18210 (shell-quote-argument
18211 (file-name-nondirectory texfile)))
18212 t t cmd)))
18213 (while (string-match "%o" cmd)
18214 (setq cmd (replace-match
18215 (save-match-data
18216 (shell-quote-argument
18217 (file-name-directory texfile)))
18218 t t cmd)))
18219 (setq cmd (split-string cmd))
18220 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
18221 (error nil))
18222 (cd dir))
18223 (if (not (file-exists-p pdffile))
18224 (progn (message "Failed to create pdf file from %s" texfile) nil)
18225 (condition-case nil
18226 (if (featurep 'xemacs)
18227 (call-process "convert" nil nil nil
18228 "-density" "96"
18229 "-trim"
18230 "-antialias"
18231 pdffile
18232 "-quality" "100"
18233 ;; "-sharpen" "0x1.0"
18234 pngfile)
18235 (call-process "convert" nil nil nil
18236 "-density" dpi
18237 "-trim"
18238 "-antialias"
18239 pdffile
18240 "-quality" "100"
18241 ;; "-sharpen" "0x1.0"
18242 pngfile))
18243 (error nil))
18244 (if (not (file-exists-p pngfile))
18245 (if org-format-latex-signal-error
18246 (error "Failed to create png file from %s" texfile)
18247 (message "Failed to create png file from %s" texfile)
18248 nil)
18249 ;; Use the requested file name and clean up
18250 (copy-file pngfile tofile 'replace)
18251 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18252 (if (file-exists-p (concat texfilebase e))
18253 (delete-file (concat texfilebase e))))
18254 pngfile))))
18256 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18257 "Fill a LaTeX header template TPL.
18258 In the template, the following place holders will be recognized:
18261 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18263 [NO-PACKAGES] do not include PKG
18264 [EXTRA] the string EXTRA
18265 [NO-EXTRA] do not include EXTRA
18267 For backward compatibility, if both the positive and the negative place
18269 assumed to be present at the end of the template.
18270 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18271 EXTRA is a string.
18272 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18273 (let (rpl (end ""))
18275 (setq rpl (if (or (match-end 1) (not def-pkg))
18276 "" (org-latex-packages-to-string def-pkg snippets-p t))
18277 tpl (replace-match rpl t t tpl))
18278 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18281 (setq rpl (if (or (match-end 1) (not pkg))
18282 "" (org-latex-packages-to-string pkg snippets-p t))
18283 tpl (replace-match rpl t t tpl))
18284 (if pkg (setq end
18286 (org-latex-packages-to-string pkg snippets-p)))))
18289 (setq rpl (if (or (match-end 1) (not extra))
18291 tpl (replace-match rpl t t tpl))
18297 tpl)))
18299 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18301 (setq pkg (mapconcat (lambda(p)
18302 (cond
18303 ((stringp p) p)
18304 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18305 (format "%% Package %s omitted" (cadr p)))
18306 ((equal "" (car p))
18308 (t
18310 (car p) (cadr p)))))
18311 pkg
18315 (defun org-dvipng-color (attr)
18316 "Return a RGB color specification for dvipng."
18317 (apply 'format "rgb %s %s %s"
18318 (mapcar 'org-normalize-color
18319 (if (featurep 'xemacs)
18320 (color-rgb-components
18321 (face-property 'default
18322 (cond ((eq attr :foreground) 'foreground)
18323 ((eq attr :background) 'background))))
18324 (color-values (face-attribute 'default attr nil))))))
18326 (defun org-dvipng-color-format (color-name)
18327 "Convert COLOR-NAME to a RGB color value for dvipng."
18328 (apply 'format "rgb %s %s %s"
18329 (mapcar 'org-normalize-color
18330 (color-values color-name))))
18332 (defun org-latex-color (attr)
18333 "Return a RGB color for the LaTeX color package."
18334 (apply 'format "%s,%s,%s"
18335 (mapcar 'org-normalize-color
18336 (if (featurep 'xemacs)
18337 (color-rgb-components
18338 (face-property 'default
18339 (cond ((eq attr :foreground) 'foreground)
18340 ((eq attr :background) 'background))))
18341 (color-values (face-attribute 'default attr nil))))))
18343 (defun org-latex-color-format (color-name)
18344 "Convert COLOR-NAME to a RGB color value."
18345 (apply 'format "%s,%s,%s"
18346 (mapcar 'org-normalize-color
18347 (color-values color-name))))
18349 (defun org-normalize-color (value)
18350 "Return string to be used as color value for an RGB component."
18351 (format "%g" (/ value 65535.0)))
18354 \f
18355 ;; Image display
18357 (defvar org-inline-image-overlays nil)
18358 (make-variable-buffer-local 'org-inline-image-overlays)
18360 (defun org-toggle-inline-images (&optional include-linked)
18361 "Toggle the display of inline images.
18362 INCLUDE-LINKED is passed to `org-display-inline-images'."
18363 (interactive "P")
18364 (if org-inline-image-overlays
18365 (progn
18366 (org-remove-inline-images)
18367 (message "Inline image display turned off"))
18368 (org-display-inline-images include-linked)
18369 (if (and (org-called-interactively-p)
18370 org-inline-image-overlays)
18371 (message "%d images displayed inline"
18372 (length org-inline-image-overlays))
18373 (message "No images to display inline"))))
18375 (defun org-redisplay-inline-images ()
18376 "Refresh the display of inline images."
18377 (interactive)
18378 (if (not org-inline-image-overlays)
18379 (org-toggle-inline-images)
18380 (org-toggle-inline-images)
18381 (org-toggle-inline-images)))
18383 (defun org-display-inline-images (&optional include-linked refresh beg end)
18384 "Display inline images.
18385 Normally only links without a description part are inlined, because this
18386 is how it will work for export. When INCLUDE-LINKED is set, also links
18387 with a description part will be inlined. This can be nice for a quick
18388 look at those images, but it does not reflect what exported files will look
18389 like.
18390 When REFRESH is set, refresh existing images between BEG and END.
18391 This will create new image displays only if necessary.
18392 BEG and END default to the buffer boundaries."
18393 (interactive "P")
18394 (unless refresh
18395 (org-remove-inline-images)
18396 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18397 (save-excursion
18398 (save-restriction
18399 (widen)
18400 (setq beg (or beg (point-min)) end (or end (point-max)))
18401 (goto-char beg)
18403 (substring (org-image-file-name-regexp) 0 -2)
18405 old file ov img type attrwidth width)
18406 (while (re-search-forward re end t)
18407 (setq old (get-char-property-and-overlay (match-beginning 1)
18408 'org-image-overlay)
18409 file (expand-file-name
18410 (concat (or (match-string 3) "") (match-string 4))))
18411 (when (image-type-available-p 'imagemagick)
18412 (setq attrwidth (if (or (listp org-image-actual-width)
18413 (null org-image-actual-width))
18414 (save-excursion
18415 (save-match-data
18416 (when (re-search-backward
18418 (save-excursion
18420 (string-to-number (match-string 1))))))
18421 width (cond ((eq org-image-actual-width t) nil)
18422 ((null org-image-actual-width) attrwidth)
18423 ((numberp org-image-actual-width)
18424 org-image-actual-width)
18425 ((listp org-image-actual-width)
18426 (or attrwidth (car org-image-actual-width))))
18427 type (if width 'imagemagick)))
18428 (when (file-exists-p file)
18429 (if (and (car-safe old) refresh)
18430 (image-refresh (overlay-get (cdr old) 'display))
18431 (setq img (save-match-data (create-image file type nil :width width)))
18432 (when img
18433 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18434 (overlay-put ov 'display img)
18435 (overlay-put ov 'face 'default)
18436 (overlay-put ov 'org-image-overlay t)
18437 (overlay-put ov 'modification-hooks
18438 (list 'org-display-inline-remove-overlay))
18439 (push ov org-inline-image-overlays)))))))))
18441 (define-obsolete-function-alias
18442 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18444 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18445 "Remove inline-display overlay if a corresponding region is modified."
18446 (let ((inhibit-modification-hooks t))
18447 (when (and ov after)
18448 (delete ov org-inline-image-overlays)
18449 (delete-overlay ov))))
18451 (defun org-remove-inline-images ()
18452 "Remove inline display of images."
18453 (interactive)
18454 (mapc 'delete-overlay org-inline-image-overlays)
18455 (setq org-inline-image-overlays nil))
18457 ;;;; Key bindings
18459 ;; Outline functions from `outline-mode-prefix-map'
18460 ;; that can be remapped in Org:
18461 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18462 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18463 (define-key org-mode-map [remap outline-forward-same-level]
18464 'org-forward-heading-same-level)
18465 (define-key org-mode-map [remap outline-backward-same-level]
18466 'org-backward-heading-same-level)
18467 (define-key org-mode-map [remap show-branches]
18468 'org-kill-note-or-show-branches)
18469 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18470 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18471 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18473 ;; Outline functions from `outline-mode-prefix-map' that can not
18474 ;; be remapped in Org:
18475 ;;
18476 ;; - the column "key binding" shows whether the Outline function is still
18477 ;; available in Org mode on the same key that it has been bound to in
18478 ;; Outline mode:
18479 ;; - "overridden": key used for a different functionality in Org mode
18480 ;; - else: key still bound to the same Outline function in Org mode
18481 ;;
18482 ;; | Outline function | key binding | Org replacement |
18483 ;; |------------------------------------+-------------+-----------------------|
18484 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18485 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18486 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18487 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18488 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18489 ;; | `show-entry' | overridden | no replacement |
18490 ;; | `show-children' | `C-c C-i' | visibility cycling |
18491 ;; | `show-branches' | `C-c C-k' | still same function |
18492 ;; | `show-subtree' | overridden | visibility cycling |
18493 ;; | `show-all' | overridden | no replacement |
18494 ;; | `hide-subtree' | overridden | visibility cycling |
18495 ;; | `hide-body' | overridden | no replacement |
18496 ;; | `hide-entry' | overridden | visibility cycling |
18497 ;; | `hide-leaves' | overridden | no replacement |
18498 ;; | `hide-sublevels' | overridden | no replacement |
18499 ;; | `hide-other' | overridden | no replacement |
18501 ;; Make `C-c C-x' a prefix key
18502 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18504 ;; TAB key with modifiers
18505 (org-defkey org-mode-map "\C-i" 'org-cycle)
18506 (org-defkey org-mode-map [(tab)] 'org-cycle)
18507 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18509 ;; The following line is necessary under Suse GNU/Linux
18510 (unless (featurep 'xemacs)
18511 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18512 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18513 (define-key org-mode-map [backtab] 'org-shifttab)
18515 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18516 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18517 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18519 ;; Cursor keys with modifiers
18520 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18521 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18522 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18523 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18525 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18526 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18527 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18528 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18530 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18531 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18532 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18533 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18535 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18536 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18537 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18538 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18540 ;; Babel keys
18541 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18542 (mapc (lambda (pair)
18543 (define-key org-babel-map (car pair) (cdr pair)))
18544 org-babel-key-bindings)
18546 ;;; Extra keys for tty access.
18547 ;; We only set them when really needed because otherwise the
18548 ;; menus don't show the simple keys
18550 (when (or org-use-extra-keys
18551 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18552 (not window-system))
18553 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18554 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18555 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18556 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18557 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18558 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18559 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18560 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18561 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18562 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18563 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18564 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18565 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18566 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18567 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18568 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18569 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18570 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18571 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18572 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18573 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18574 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18575 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18576 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18577 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18578 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18579 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18580 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18582 ;; All the other keys
18584 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18585 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18586 (if (boundp 'narrow-map)
18587 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18588 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18589 (if (boundp 'narrow-map)
18590 (org-defkey narrow-map "b" 'org-narrow-to-block)
18591 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18592 (if (boundp 'narrow-map)
18593 (org-defkey narrow-map "e" 'org-narrow-to-element)
18594 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18595 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18596 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18597 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18598 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18599 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18600 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18601 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18602 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18603 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18604 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18605 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18606 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18607 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18608 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18609 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18610 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18611 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18612 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18613 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18614 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18615 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18616 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18617 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18618 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18619 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18621 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18622 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18623 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18624 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18625 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18626 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18627 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18628 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18629 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18630 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18631 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18632 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18633 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18634 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18635 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18636 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18637 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18638 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18639 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18640 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18641 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18643 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18644 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18645 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18646 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18647 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18648 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18649 (org-defkey org-mode-map "\C-c^" 'org-sort)
18650 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18651 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18652 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18653 (org-defkey org-mode-map "\C-m" 'org-return)
18654 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18655 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18656 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18657 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18658 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18659 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18660 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18661 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18662 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18663 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18664 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18665 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18666 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18667 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
18668 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
18669 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
18670 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
18671 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
18672 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
18673 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
18674 (org-defkey org-mode-map "\M-h" 'org-mark-element)
18675 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
18676 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18678 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18679 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18680 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18682 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18683 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18684 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18685 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18686 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18687 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18688 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18689 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18690 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18691 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18692 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18693 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18694 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18696 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18697 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18698 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
18699 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18700 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18701 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18702 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18703 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18704 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18706 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18707 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18708 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18709 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18710 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18712 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18714 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18716 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18717 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18719 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18722 (when (featurep 'xemacs)
18723 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18726 (defconst org-speed-commands-default
18727 '(
18728 ("Outline Navigation")
18729 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18730 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18731 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18732 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18733 ("F" . org-next-block)
18734 ("B" . org-previous-block)
18735 ("u" . (org-speed-move-safe 'outline-up-heading))
18736 ("j" . org-goto)
18737 ("g" . (org-refile t))
18738 ("Outline Visibility")
18739 ("c" . org-cycle)
18740 ("C" . org-shifttab)
18741 (" " . org-display-outline-path)
18742 ("=" . org-columns)
18743 ("Outline Structure Editing")
18744 ("U" . org-shiftmetaup)
18745 ("D" . org-shiftmetadown)
18746 ("r" . org-metaright)
18747 ("l" . org-metaleft)
18748 ("R" . org-shiftmetaright)
18749 ("L" . org-shiftmetaleft)
18750 ("i" . (progn (forward-char 1) (call-interactively
18751 'org-insert-heading-respect-content)))
18752 ("^" . org-sort)
18753 ("w" . org-refile)
18754 ("a" . org-archive-subtree-default-with-confirmation)
18755 ("@" . org-mark-subtree)
18756 ("#" . org-toggle-comment)
18757 ("Clock Commands")
18758 ("I" . org-clock-in)
18759 ("O" . org-clock-out)
18760 ("Meta Data Editing")
18761 ("t" . org-todo)
18762 ("," . (org-priority))
18763 ("0" . (org-priority ?\ ))
18764 ("1" . (org-priority ?A))
18765 ("2" . (org-priority ?B))
18766 ("3" . (org-priority ?C))
18767 (":" . org-set-tags-command)
18768 ("e" . org-set-effort)
18769 ("E" . org-inc-effort)
18770 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18771 (org-entry-put (point) "APPT_WARNTIME" m)))
18772 ("Agenda Views etc")
18773 ("v" . org-agenda)
18774 ("/" . org-sparse-tree)
18775 ("Misc")
18776 ("o" . org-open-at-point)
18777 ("?" . org-speed-command-help)
18778 ("<" . (org-agenda-set-restriction-lock 'subtree))
18779 (">" . (org-agenda-remove-restriction-lock))
18780 )
18781 "The default speed commands.")
18783 (defun org-print-speed-command (e)
18784 (if (> (length (car e)) 1)
18785 (progn
18787 (princ (car e))
18789 (princ (make-string (length (car e)) ?-))
18791 (princ (car e))
18792 (princ " ")
18793 (if (symbolp (cdr e))
18794 (princ (symbol-name (cdr e)))
18795 (prin1 (cdr e)))
18798 (defun org-speed-command-help ()
18799 "Show the available speed commands."
18800 (interactive)
18801 (if (not org-use-speed-commands)
18802 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18803 (with-output-to-temp-buffer "*Help*"
18805 (mapc 'org-print-speed-command org-speed-commands-user)
18808 (mapc 'org-print-speed-command org-speed-commands-default))
18809 (with-current-buffer "*Help*"
18810 (setq truncate-lines t))))
18812 (defun org-speed-move-safe (cmd)
18813 "Execute CMD, but make sure that the cursor always ends up in a headline.
18814 If not, return to the original position and throw an error."
18815 (interactive)
18816 (let ((pos (point)))
18817 (call-interactively cmd)
18818 (unless (and (bolp) (org-at-heading-p))
18819 (goto-char pos)
18820 (error "Boundary reached while executing %s" cmd))))
18822 (defvar org-self-insert-command-undo-counter 0)
18824 (defvar org-table-auto-blank-field) ; defined in org-table.el
18825 (defvar org-speed-command nil)
18827 (define-obsolete-function-alias
18828 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18830 (defun org-speed-command-activate (keys)
18831 "Hook for activating single-letter speed commands.
18832 `org-speed-commands-default' specifies a minimal command set.
18833 Use `org-speed-commands-user' for further customization."
18834 (when (or (and (bolp) (looking-at org-outline-regexp))
18835 (and (functionp org-use-speed-commands)
18836 (funcall org-use-speed-commands)))
18837 (cdr (assoc keys (append org-speed-commands-user
18838 org-speed-commands-default)))))
18840 (define-obsolete-function-alias
18841 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18843 (defun org-babel-speed-command-activate (keys)
18844 "Hook for activating single-letter code block commands."
18845 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18846 (cdr (assoc keys org-babel-key-bindings))))
18848 (defcustom org-speed-command-hook
18849 '(org-speed-command-default-hook org-babel-speed-command-hook)
18850 "Hook for activating speed commands at strategic locations.
18851 Hook functions are called in sequence until a valid handler is
18852 found.
18854 Each hook takes a single argument, a user-pressed command key
18855 which is also a `self-insert-command' from the global map.
18857 Within the hook, examine the cursor position and the command key
18858 and return nil or a valid handler as appropriate. Handler could
18859 be one of an interactive command, a function, or a form.
18861 Set `org-use-speed-commands' to non-nil value to enable this
18862 hook. The default setting is `org-speed-command-activate'."
18863 :group 'org-structure
18864 :version "24.1"
18865 :type 'hook)
18867 (defun org-self-insert-command (N)
18868 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18869 If the cursor is in a table looking at whitespace, the whitespace is
18870 overwritten, and the table is not marked as requiring realignment."
18871 (interactive "p")
18872 (org-check-before-invisible-edit 'insert)
18873 (cond
18874 ((and org-use-speed-commands
18875 (setq org-speed-command
18876 (run-hook-with-args-until-success
18877 'org-speed-command-hook (this-command-keys))))
18878 (cond
18879 ((commandp org-speed-command)
18880 (setq this-command org-speed-command)
18881 (call-interactively org-speed-command))
18882 ((functionp org-speed-command)
18883 (funcall org-speed-command))
18884 ((and org-speed-command (listp org-speed-command))
18885 (eval org-speed-command))
18886 (t (let (org-use-speed-commands)
18887 (call-interactively 'org-self-insert-command)))))
18888 ((and
18889 (org-table-p)
18890 (progn
18891 ;; check if we blank the field, and if that triggers align
18892 (and (featurep 'org-table) org-table-auto-blank-field
18893 (member last-command
18894 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18896 ;; got extra space, this field does not determine column width
18897 (let (org-table-may-need-update) (org-table-blank-field))
18898 ;; no extra space, this field may determine column width
18899 (org-table-blank-field)))
18900 t)
18901 (eq N 1)
18903 (let (org-table-may-need-update)
18904 (goto-char (1- (match-end 0)))
18905 (backward-delete-char 1)
18906 (goto-char (match-beginning 0))
18907 (self-insert-command N)))
18908 (t
18909 (setq org-table-may-need-update t)
18910 (self-insert-command N)
18911 (org-fix-tags-on-the-fly)
18912 (if org-self-insert-cluster-for-undo
18913 (if (not (eq last-command 'org-self-insert-command))
18914 (setq org-self-insert-command-undo-counter 1)
18915 (if (>= org-self-insert-command-undo-counter 20)
18916 (setq org-self-insert-command-undo-counter 1)
18917 (and (> org-self-insert-command-undo-counter 0)
18918 buffer-undo-list (listp buffer-undo-list)
18919 (not (cadr buffer-undo-list)) ; remove nil entry
18920 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18921 (setq org-self-insert-command-undo-counter
18922 (1+ org-self-insert-command-undo-counter))))))))
18924 (defun org-check-before-invisible-edit (kind)
18925 "Check is editing if kind KIND would be dangerous with invisible text around.
18926 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18927 ;; First, try to get out of here as quickly as possible, to reduce overhead
18928 (if (and org-catch-invisible-edits
18929 (or (not (boundp 'visible-mode)) (not visible-mode))
18930 (or (get-char-property (point) 'invisible)
18931 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18932 ;; OK, we need to take a closer look
18933 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18934 (invisible-before-point (if (bobp) nil (get-char-property
18935 (1- (point)) 'invisible)))
18936 (border-and-ok-direction
18937 (or
18938 ;; Check if we are acting predictably before invisible text
18939 (and invisible-at-point (not invisible-before-point)
18940 (memq kind '(insert delete-backward)))
18941 ;; Check if we are acting predictably after invisible text
18942 ;; This works not well, and I have turned it off. It seems
18943 ;; better to always show and stop after invisible text.
18944 ;; (and (not invisible-at-point) invisible-before-point
18945 ;; (memq kind '(insert delete)))
18946 )))
18947 (when (or (memq invisible-at-point '(outline org-hide-block t))
18948 (memq invisible-before-point '(outline org-hide-block t)))
18949 (if (eq org-catch-invisible-edits 'error)
18950 (error "Editing in invisible areas is prohibited - make visible first"))
18951 (if (and org-custom-properties-overlays
18952 (y-or-n-p "Display invisible properties in this buffer? "))
18953 (org-toggle-custom-properties-visibility)
18954 ;; Make the area visible
18955 (save-excursion
18956 (if invisible-before-point
18957 (goto-char (previous-single-char-property-change
18958 (point) 'invisible)))
18959 (org-cycle))
18960 (cond
18961 ((eq org-catch-invisible-edits 'show)
18962 ;; That's it, we do the edit after showing
18963 (message
18964 "Unfolding invisible region around point before editing")
18965 (sit-for 1))
18966 ((and (eq org-catch-invisible-edits 'smart)
18967 border-and-ok-direction)
18968 (message "Unfolding invisible region around point before editing"))
18969 (t
18970 ;; Don't do the edit, make the user repeat it in full visibility
18971 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18973 (defun org-fix-tags-on-the-fly ()
18974 (when (and (equal (char-after (point-at-bol)) ?*)
18975 (org-at-heading-p))
18976 (org-align-tags-here org-tags-column)))
18978 (defun org-delete-backward-char (N)
18979 "Like `delete-backward-char', insert whitespace at field end in tables.
18980 When deleting backwards, in tables this function will insert whitespace in
18982 still be marked for re-alignment if the field did fill the entire column,
18983 because, in this case the deletion might narrow the column."
18984 (interactive "p")
18985 (save-match-data
18986 (org-check-before-invisible-edit 'delete-backward)
18987 (if (and (org-table-p)
18988 (eq N 1)
18989 (string-match "|" (buffer-substring (point-at-bol) (point)))
18990 (looking-at ".*?|"))
18991 (let ((pos (point))
18993 (c org-table-may-need-update))
18994 (backward-delete-char N)
18995 (if (not overwrite-mode)
18996 (progn
18997 (skip-chars-forward "^|")
18998 (insert " ")
18999 (goto-char (1- pos))))
19000 ;; noalign: if there were two spaces at the end, this field
19001 ;; does not determine the width of the column.
19002 (if noalign (setq org-table-may-need-update c)))
19003 (backward-delete-char N)
19004 (org-fix-tags-on-the-fly))))
19006 (defun org-delete-char (N)
19007 "Like `delete-char', but insert whitespace at field end in tables.
19008 When deleting characters, in tables this function will insert whitespace in
19010 still be marked for re-alignment if the field did fill the entire column,
19011 because, in this case the deletion might narrow the column."
19012 (interactive "p")
19013 (save-match-data
19014 (org-check-before-invisible-edit 'delete)
19015 (if (and (org-table-p)
19016 (not (bolp))
19017 (not (= (char-after) ?|))
19018 (eq N 1))
19019 (if (looking-at ".*?|")
19020 (let ((pos (point))
19022 (c org-table-may-need-update))
19023 (replace-match (concat
19024 (substring (match-string 0) 1 -1)
19025 " |"))
19026 (goto-char pos)
19027 ;; noalign: if there were two spaces at the end, this field
19028 ;; does not determine the width of the column.
19029 (if noalign (setq org-table-may-need-update c)))
19030 (delete-char N))
19031 (delete-char N)
19032 (org-fix-tags-on-the-fly))))
19034 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19035 (put 'org-self-insert-command 'delete-selection t)
19036 (put 'orgtbl-self-insert-command 'delete-selection t)
19037 (put 'org-delete-char 'delete-selection 'supersede)
19038 (put 'org-delete-backward-char 'delete-selection 'supersede)
19039 (put 'org-yank 'delete-selection 'yank)
19041 ;; Make `flyspell-mode' delay after some commands
19042 (put 'org-self-insert-command 'flyspell-delayed t)
19043 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19044 (put 'org-delete-char 'flyspell-delayed t)
19045 (put 'org-delete-backward-char 'flyspell-delayed t)
19047 ;; Make pabbrev-mode expand after org-mode commands
19048 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19049 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19051 ;; How to do this: Measure non-white length of current string
19052 ;; If equal to column width, we should realign.
19054 (defun org-remap (map &rest commands)
19055 "In MAP, remap the functions given in COMMANDS.
19056 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19057 (let (new old)
19058 (while commands
19059 (setq old (pop commands) new (pop commands))
19060 (if (fboundp 'command-remapping)
19061 (org-defkey map (vector 'remap old) new)
19062 (substitute-key-definition old new map global-map)))))
19064 (defun org-transpose-words ()
19065 "Transpose words for Org.
19066 This uses the `org-mode-transpose-word-syntax-table' syntax
19067 table, which interprets characters in `org-emphasis-alist' as
19068 word constituants."
19069 (interactive)
19070 (with-syntax-table org-mode-transpose-word-syntax-table
19071 (call-interactively 'transpose-words)))
19072 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19074 (when (eq org-enable-table-editor 'optimized)
19075 ;; If the user wants maximum table support, we need to hijack
19076 ;; some standard editing functions
19077 (org-remap org-mode-map
19078 'self-insert-command 'org-self-insert-command
19079 'delete-char 'org-delete-char
19080 'delete-backward-char 'org-delete-backward-char)
19081 (org-defkey org-mode-map "|" 'org-force-self-insert))
19083 (defvar org-ctrl-c-ctrl-c-hook nil
19084 "Hook for functions attaching themselves to `C-c C-c'.
19086 This can be used to add additional functionality to the C-c C-c
19087 key which executes context-dependent commands. This hook is run
19088 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19089 run after the last test.
19091 Each function will be called with no arguments. The function
19092 must check if the context is appropriate for it to act. If yes,
19093 it should do its thing and then return a non-nil value. If the
19094 context is wrong, just do nothing and return nil.")
19096 (defvar org-ctrl-c-ctrl-c-final-hook nil
19097 "Hook for functions attaching themselves to `C-c C-c'.
19099 This can be used to add additional functionality to the C-c C-c
19100 key which executes context-dependent commands. This hook is run
19101 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19102 before the first test.
19104 Each function will be called with no arguments. The function
19105 must check if the context is appropriate for it to act. If yes,
19106 it should do its thing and then return a non-nil value. If the
19107 context is wrong, just do nothing and return nil.")
19109 (defvar org-tab-first-hook nil
19110 "Hook for functions to attach themselves to TAB.
19111 See `org-ctrl-c-ctrl-c-hook' for more information.
19112 This hook runs as the first action when TAB is pressed, even before
19113 `org-cycle' messes around with the `outline-regexp' to cater for
19114 inline tasks and plain list item folding.
19115 If any function in this hook returns t, any other actions that
19116 would have been caused by TAB (such as table field motion or visibility
19117 cycling) will not occur.")
19119 (defvar org-tab-after-check-for-table-hook nil
19120 "Hook for functions to attach themselves to TAB.
19121 See `org-ctrl-c-ctrl-c-hook' for more information.
19122 This hook runs after it has been established that the cursor is not in a
19123 table, but before checking if the cursor is in a headline or if global cycling
19124 should be done.
19125 If any function in this hook returns t, not other actions like visibility
19126 cycling will be done.")
19128 (defvar org-tab-after-check-for-cycling-hook nil
19129 "Hook for functions to attach themselves to TAB.
19130 See `org-ctrl-c-ctrl-c-hook' for more information.
19131 This hook runs after it has been established that not table field motion and
19132 not visibility should be done because of current context. This is probably
19133 the place where a package like yasnippets can hook in.")
19135 (defvar org-tab-before-tab-emulation-hook nil
19136 "Hook for functions to attach themselves to TAB.
19137 See `org-ctrl-c-ctrl-c-hook' for more information.
19138 This hook runs after every other options for TAB have been exhausted, but
19141 (defvar org-metaleft-hook nil
19142 "Hook for functions attaching themselves to `M-left'.
19143 See `org-ctrl-c-ctrl-c-hook' for more information.")
19144 (defvar org-metaright-hook nil
19145 "Hook for functions attaching themselves to `M-right'.
19146 See `org-ctrl-c-ctrl-c-hook' for more information.")
19147 (defvar org-metaup-hook nil
19148 "Hook for functions attaching themselves to `M-up'.
19149 See `org-ctrl-c-ctrl-c-hook' for more information.")
19150 (defvar org-metadown-hook nil
19151 "Hook for functions attaching themselves to `M-down'.
19152 See `org-ctrl-c-ctrl-c-hook' for more information.")
19153 (defvar org-shiftmetaleft-hook nil
19154 "Hook for functions attaching themselves to `M-S-left'.
19155 See `org-ctrl-c-ctrl-c-hook' for more information.")
19156 (defvar org-shiftmetaright-hook nil
19157 "Hook for functions attaching themselves to `M-S-right'.
19158 See `org-ctrl-c-ctrl-c-hook' for more information.")
19159 (defvar org-shiftmetaup-hook nil
19160 "Hook for functions attaching themselves to `M-S-up'.
19161 See `org-ctrl-c-ctrl-c-hook' for more information.")
19162 (defvar org-shiftmetadown-hook nil
19163 "Hook for functions attaching themselves to `M-S-down'.
19164 See `org-ctrl-c-ctrl-c-hook' for more information.")
19165 (defvar org-metareturn-hook nil
19166 "Hook for functions attaching themselves to `M-RET'.
19167 See `org-ctrl-c-ctrl-c-hook' for more information.")
19168 (defvar org-shiftup-hook nil
19169 "Hook for functions attaching themselves to `S-up'.
19170 See `org-ctrl-c-ctrl-c-hook' for more information.")
19171 (defvar org-shiftup-final-hook nil
19172 "Hook for functions attaching themselves to `S-up'.
19173 This one runs after all other options except shift-select have been excluded.
19174 See `org-ctrl-c-ctrl-c-hook' for more information.")
19175 (defvar org-shiftdown-hook nil
19176 "Hook for functions attaching themselves to `S-down'.
19177 See `org-ctrl-c-ctrl-c-hook' for more information.")
19178 (defvar org-shiftdown-final-hook nil
19179 "Hook for functions attaching themselves to `S-down'.
19180 This one runs after all other options except shift-select have been excluded.
19181 See `org-ctrl-c-ctrl-c-hook' for more information.")
19182 (defvar org-shiftleft-hook nil
19183 "Hook for functions attaching themselves to `S-left'.
19184 See `org-ctrl-c-ctrl-c-hook' for more information.")
19185 (defvar org-shiftleft-final-hook nil
19186 "Hook for functions attaching themselves to `S-left'.
19187 This one runs after all other options except shift-select have been excluded.
19188 See `org-ctrl-c-ctrl-c-hook' for more information.")
19189 (defvar org-shiftright-hook nil
19190 "Hook for functions attaching themselves to `S-right'.
19191 See `org-ctrl-c-ctrl-c-hook' for more information.")
19192 (defvar org-shiftright-final-hook nil
19193 "Hook for functions attaching themselves to `S-right'.
19194 This one runs after all other options except shift-select have been excluded.
19195 See `org-ctrl-c-ctrl-c-hook' for more information.")
19197 (defun org-modifier-cursor-error ()
19198 "Throw an error, a modified cursor command was applied in wrong context."
19199 (error "This command is active in special context like tables, headlines or items"))
19201 (defun org-shiftselect-error ()
19202 "Throw an error because Shift-Cursor command was applied in wrong context."
19203 (if (and (boundp 'shift-select-mode) shift-select-mode)
19204 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19205 (error "This command works only in special context like headlines or timestamps")))
19207 (defun org-call-for-shift-select (cmd)
19208 (let ((this-command-keys-shift-translated t))
19209 (call-interactively cmd)))
19211 (defun org-shifttab (&optional arg)
19212 "Global visibility cycling or move to previous table field.
19213 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
19214 on context.
19215 See the individual commands for more information."
19216 (interactive "P")
19217 (cond
19218 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19219 ((integerp arg)
19220 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19221 (message "Content view to level: %d" arg)
19222 (org-content (prefix-numeric-value arg2))
19223 (setq org-cycle-global-status 'overview)))
19224 (t (call-interactively 'org-global-cycle))))
19226 (defun org-shiftmetaleft ()
19227 "Promote subtree or delete table column.
19228 Calls `org-promote-subtree', `org-outdent-item-tree', or
19229 `org-table-delete-column', depending on context. See the
19230 individual commands for more information."
19231 (interactive)
19232 (cond
19233 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19234 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19235 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19236 ((if (not (org-region-active-p)) (org-at-item-p)
19237 (save-excursion (goto-char (region-beginning))
19238 (org-at-item-p)))
19239 (call-interactively 'org-outdent-item-tree))
19240 (t (org-modifier-cursor-error))))
19242 (defun org-shiftmetaright ()
19243 "Demote subtree or insert table column.
19244 Calls `org-demote-subtree', `org-indent-item-tree', or
19245 `org-table-insert-column', depending on context. See the
19246 individual commands for more information."
19247 (interactive)
19248 (cond
19249 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19250 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19251 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19252 ((if (not (org-region-active-p)) (org-at-item-p)
19253 (save-excursion (goto-char (region-beginning))
19254 (org-at-item-p)))
19255 (call-interactively 'org-indent-item-tree))
19256 (t (org-modifier-cursor-error))))
19258 (defun org-shiftmetaup (&optional arg)
19259 "Move subtree up or kill table row.
19260 Calls `org-move-subtree-up' or `org-table-kill-row' or
19261 `org-move-item-up' or `org-timestamp-up', depending on context.
19262 See the individual commands for more information."
19263 (interactive "P")
19264 (cond
19265 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19266 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19267 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19268 ((org-at-item-p) (call-interactively 'org-move-item-up))
19269 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19270 (call-interactively 'org-timestamp-up)))
19271 (t (call-interactively 'org-drag-line-backward))))
19273 (defun org-shiftmetadown (&optional arg)
19274 "Move subtree down or insert table row.
19275 Calls `org-move-subtree-down' or `org-table-insert-row' or
19276 `org-move-item-down' or `org-timestamp-up', depending on context.
19277 See the individual commands for more information."
19278 (interactive "P")
19279 (cond
19280 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19281 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19282 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19283 ((org-at-item-p) (call-interactively 'org-move-item-down))
19284 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19285 (call-interactively 'org-timestamp-down)))
19286 (t (call-interactively 'org-drag-line-forward))))
19288 (defsubst org-hidden-tree-error ()
19289 (error
19290 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19292 (defun org-metaleft (&optional arg)
19293 "Promote heading or move table column to left.
19294 Calls `org-do-promote' or `org-table-move-column', depending on context.
19295 With no specific context, calls the Emacs default `backward-word'.
19296 See the individual commands for more information."
19297 (interactive "P")
19298 (cond
19299 ((run-hook-with-args-until-success 'org-metaleft-hook))
19300 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19301 ((org-with-limited-levels
19302 (or (org-at-heading-p)
19303 (and (org-region-active-p)
19304 (save-excursion
19305 (goto-char (region-beginning))
19306 (org-at-heading-p)))))
19307 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19308 (call-interactively 'org-do-promote))
19309 ;; At an inline task.
19310 ((org-at-heading-p)
19311 (call-interactively 'org-inlinetask-promote))
19312 ((or (org-at-item-p)
19313 (and (org-region-active-p)
19314 (save-excursion
19315 (goto-char (region-beginning))
19316 (org-at-item-p))))
19317 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19318 (call-interactively 'org-outdent-item))
19319 (t (call-interactively 'backward-word))))
19321 (defun org-metaright (&optional arg)
19322 "Demote a subtree, a list item or move table column to right.
19323 In front of a drawer or a block keyword, indent it correctly.
19324 With no specific context, calls the Emacs default `forward-word'.
19325 See the individual commands for more information."
19326 (interactive "P")
19327 (cond
19328 ((run-hook-with-args-until-success 'org-metaright-hook))
19329 ((org-at-table-p) (call-interactively 'org-table-move-column))
19330 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19331 ((org-at-block-p) (call-interactively 'org-indent-block))
19332 ((org-with-limited-levels
19333 (or (org-at-heading-p)
19334 (and (org-region-active-p)
19335 (save-excursion
19336 (goto-char (region-beginning))
19337 (org-at-heading-p)))))
19338 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19339 (call-interactively 'org-do-demote))
19340 ;; At an inline task.
19341 ((org-at-heading-p)
19342 (call-interactively 'org-inlinetask-demote))
19343 ((or (org-at-item-p)
19344 (and (org-region-active-p)
19345 (save-excursion
19346 (goto-char (region-beginning))
19347 (org-at-item-p))))
19348 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19349 (call-interactively 'org-indent-item))
19350 (t (call-interactively 'forward-word))))
19352 (defun org-check-for-hidden (what)
19353 "Check if there are hidden headlines/items in the current visual line.
19354 WHAT can be either `headlines' or `items'. If the current line is
19355 an outline or item heading and it has a folded subtree below it,
19356 this function returns t, nil otherwise."
19357 (let ((re (cond
19358 ((eq what 'headlines) org-outline-regexp-bol)
19359 ((eq what 'items) (org-item-beginning-re))
19360 (t (error "This should not happen"))))
19361 beg end)
19362 (save-excursion
19363 (catch 'exit
19364 (unless (org-region-active-p)
19365 (setq beg (point-at-bol))
19366 (beginning-of-line 2)
19367 (while (and (not (eobp)) ;; this is like `next-line'
19368 (get-char-property (1- (point)) 'invisible))
19369 (beginning-of-line 2))
19370 (setq end (point))
19371 (goto-char beg)
19372 (goto-char (point-at-eol))
19373 (setq end (max end (point)))
19374 (while (re-search-forward re end t)
19375 (if (get-char-property (match-beginning 0) 'invisible)
19376 (throw 'exit t))))
19377 nil))))
19379 (defun org-metaup (&optional arg)
19380 "Move subtree up or move table row up.
19381 Calls `org-move-subtree-up' or `org-table-move-row' or
19382 `org-move-item-up', depending on context. See the individual commands
19383 for more information."
19384 (interactive "P")
19385 (cond
19386 ((run-hook-with-args-until-success 'org-metaup-hook))
19387 ((org-region-active-p)
19388 (let* ((a (min (region-beginning) (region-end)))
19389 (b (1- (max (region-beginning) (region-end))))
19390 (c (save-excursion (goto-char a)
19391 (move-beginning-of-line 0)))
19392 (d (save-excursion (goto-char a)
19393 (move-end-of-line 0) (point))))
19394 (transpose-regions a b c d)
19395 (goto-char c)))
19396 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19397 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19398 ((org-at-item-p) (call-interactively 'org-move-item-up))
19399 (t (org-drag-element-backward))))
19401 (defun org-metadown (&optional arg)
19402 "Move subtree down or move table row down.
19403 Calls `org-move-subtree-down' or `org-table-move-row' or
19404 `org-move-item-down', depending on context. See the individual
19405 commands for more information."
19406 (interactive "P")
19407 (cond
19408 ((run-hook-with-args-until-success 'org-metadown-hook))
19409 ((org-region-active-p)
19410 (let* ((a (min (region-beginning) (region-end)))
19411 (b (max (region-beginning) (region-end)))
19412 (c (save-excursion (goto-char b)
19413 (move-beginning-of-line 1)))
19414 (d (save-excursion (goto-char b)
19415 (move-end-of-line 1) (1+ (point)))))
19416 (transpose-regions a b c d)
19417 (goto-char d)))
19418 ((org-at-table-p) (call-interactively 'org-table-move-row))
19419 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19420 ((org-at-item-p) (call-interactively 'org-move-item-down))
19421 (t (org-drag-element-forward))))
19423 (defun org-shiftup (&optional arg)
19424 "Increase item in timestamp or increase priority of current headline.
19425 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19426 depending on context. See the individual commands for more information."
19427 (interactive "P")
19428 (cond
19429 ((run-hook-with-args-until-success 'org-shiftup-hook))
19430 ((and org-support-shift-select (org-region-active-p))
19431 (org-call-for-shift-select 'previous-line))
19432 ((org-at-timestamp-p t)
19433 (call-interactively (if org-edit-timestamp-down-means-later
19434 'org-timestamp-down 'org-timestamp-up)))
19435 ((and (not (eq org-support-shift-select 'always))
19436 org-enable-priority-commands
19437 (org-at-heading-p))
19438 (call-interactively 'org-priority-up))
19439 ((and (not org-support-shift-select) (org-at-item-p))
19440 (call-interactively 'org-previous-item))
19441 ((org-clocktable-try-shift 'up arg))
19442 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19443 (org-support-shift-select
19444 (org-call-for-shift-select 'previous-line))
19445 (t (org-shiftselect-error))))
19447 (defun org-shiftdown (&optional arg)
19448 "Decrease item in timestamp or decrease priority of current headline.
19449 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19450 depending on context. See the individual commands for more information."
19451 (interactive "P")
19452 (cond
19453 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19454 ((and org-support-shift-select (org-region-active-p))
19455 (org-call-for-shift-select 'next-line))
19456 ((org-at-timestamp-p t)
19457 (call-interactively (if org-edit-timestamp-down-means-later
19458 'org-timestamp-up 'org-timestamp-down)))
19459 ((and (not (eq org-support-shift-select 'always))
19460 org-enable-priority-commands
19461 (org-at-heading-p))
19462 (call-interactively 'org-priority-down))
19463 ((and (not org-support-shift-select) (org-at-item-p))
19464 (call-interactively 'org-next-item))
19465 ((org-clocktable-try-shift 'down arg))
19466 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19467 (org-support-shift-select
19468 (org-call-for-shift-select 'next-line))
19469 (t (org-shiftselect-error))))
19471 (defun org-shiftright (&optional arg)
19472 "Cycle the thing at point or in the current line, depending on context.
19473 Depending on context, this does one of the following:
19475 - switch a timestamp at point one day into the future
19476 - on a headline, switch to the next TODO keyword.
19477 - on an item, switch entire list to the next bullet type
19478 - on a property line, switch to the next allowed value
19479 - on a clocktable definition line, move time block into the future"
19480 (interactive "P")
19481 (cond
19482 ((run-hook-with-args-until-success 'org-shiftright-hook))
19483 ((and org-support-shift-select (org-region-active-p))
19484 (org-call-for-shift-select 'forward-char))
19485 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19486 ((and (not (eq org-support-shift-select 'always))
19487 (org-at-heading-p))
19488 (let ((org-inhibit-logging
19489 (not org-treat-S-cursor-todo-selection-as-state-change))
19490 (org-inhibit-blocking
19491 (not org-treat-S-cursor-todo-selection-as-state-change)))
19492 (org-call-with-arg 'org-todo 'right)))
19493 ((or (and org-support-shift-select
19494 (not (eq org-support-shift-select 'always))
19495 (org-at-item-bullet-p))
19496 (and (not org-support-shift-select) (org-at-item-p)))
19497 (org-call-with-arg 'org-cycle-list-bullet nil))
19498 ((and (not (eq org-support-shift-select 'always))
19499 (org-at-property-p))
19500 (call-interactively 'org-property-next-allowed-value))
19501 ((org-clocktable-try-shift 'right arg))
19502 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19503 (org-support-shift-select
19504 (org-call-for-shift-select 'forward-char))
19505 (t (org-shiftselect-error))))
19507 (defun org-shiftleft (&optional arg)
19508 "Cycle the thing at point or in the current line, depending on context.
19509 Depending on context, this does one of the following:
19511 - switch a timestamp at point one day into the past
19512 - on a headline, switch to the previous TODO keyword.
19513 - on an item, switch entire list to the previous bullet type
19514 - on a property line, switch to the previous allowed value
19515 - on a clocktable definition line, move time block into the past"
19516 (interactive "P")
19517 (cond
19518 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19519 ((and org-support-shift-select (org-region-active-p))
19520 (org-call-for-shift-select 'backward-char))
19521 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19522 ((and (not (eq org-support-shift-select 'always))
19523 (org-at-heading-p))
19524 (let ((org-inhibit-logging
19525 (not org-treat-S-cursor-todo-selection-as-state-change))
19526 (org-inhibit-blocking
19527 (not org-treat-S-cursor-todo-selection-as-state-change)))
19528 (org-call-with-arg 'org-todo 'left)))
19529 ((or (and org-support-shift-select
19530 (not (eq org-support-shift-select 'always))
19531 (org-at-item-bullet-p))
19532 (and (not org-support-shift-select) (org-at-item-p)))
19533 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19534 ((and (not (eq org-support-shift-select 'always))
19535 (org-at-property-p))
19536 (call-interactively 'org-property-previous-allowed-value))
19537 ((org-clocktable-try-shift 'left arg))
19538 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19539 (org-support-shift-select
19540 (org-call-for-shift-select 'backward-char))
19541 (t (org-shiftselect-error))))
19543 (defun org-shiftcontrolright ()
19544 "Switch to next TODO set."
19545 (interactive)
19546 (cond
19547 ((and org-support-shift-select (org-region-active-p))
19548 (org-call-for-shift-select 'forward-word))
19549 ((and (not (eq org-support-shift-select 'always))
19550 (org-at-heading-p))
19551 (org-call-with-arg 'org-todo 'nextset))
19552 (org-support-shift-select
19553 (org-call-for-shift-select 'forward-word))
19554 (t (org-shiftselect-error))))
19556 (defun org-shiftcontrolleft ()
19557 "Switch to previous TODO set."
19558 (interactive)
19559 (cond
19560 ((and org-support-shift-select (org-region-active-p))
19561 (org-call-for-shift-select 'backward-word))
19562 ((and (not (eq org-support-shift-select 'always))
19563 (org-at-heading-p))
19564 (org-call-with-arg 'org-todo 'previousset))
19565 (org-support-shift-select
19566 (org-call-for-shift-select 'backward-word))
19567 (t (org-shiftselect-error))))
19569 (defun org-shiftcontrolup (&optional n)
19570 "Change timestamps synchronously up in CLOCK log lines.
19571 Optional argument N tells to change by that many units."
19572 (interactive "P")
19573 (cond ((and (not org-support-shift-select)
19574 (org-at-clock-log-p)
19575 (org-at-timestamp-p t))
19576 (org-clock-timestamps-up n))
19577 (t (org-shiftselect-error))))
19579 (defun org-shiftcontroldown (&optional n)
19580 "Change timestamps synchronously down in CLOCK log lines.
19581 Optional argument N tells to change by that many units."
19582 (interactive "P")
19583 (cond ((and (not org-support-shift-select)
19584 (org-at-clock-log-p)
19585 (org-at-timestamp-p t))
19586 (org-clock-timestamps-down n))
19587 (t (org-shiftselect-error))))
19589 (defun org-ctrl-c-ret ()
19590 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19591 (interactive)
19592 (cond
19593 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19594 (t (call-interactively 'org-insert-heading))))
19596 (defun org-find-visible ()
19597 (let ((s (point)))
19598 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19599 (get-char-property s 'invisible)))
19600 s))
19601 (defun org-find-invisible ()
19602 (let ((s (point)))
19603 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19604 (not (get-char-property s 'invisible))))
19605 s))
19607 (defun org-copy-visible (beg end)
19608 "Copy the visible parts of the region."
19609 (interactive "r")
19610 (let (snippets s)
19611 (save-excursion
19612 (save-restriction
19613 (narrow-to-region beg end)
19614 (setq s (goto-char (point-min)))
19615 (while (not (= (point) (point-max)))
19616 (goto-char (org-find-invisible))
19617 (push (buffer-substring s (point)) snippets)
19618 (setq s (goto-char (org-find-visible))))))
19619 (kill-new (apply 'concat (nreverse snippets)))))
19621 (defun org-copy-special ()
19622 "Copy region in table or copy current subtree.
19623 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19624 See the individual commands for more information."
19625 (interactive)
19626 (call-interactively
19627 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19629 (defun org-cut-special ()
19630 "Cut region in table or cut current subtree.
19631 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19632 See the individual commands for more information."
19633 (interactive)
19634 (call-interactively
19635 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19637 (defun org-paste-special (arg)
19638 "Paste rectangular region into table, or past subtree relative to level.
19639 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19640 See the individual commands for more information."
19641 (interactive "P")
19642 (if (org-at-table-p)
19643 (org-table-paste-rectangle)
19644 (org-paste-subtree arg)))
19646 (defsubst org-in-fixed-width-region-p ()
19647 "Is point in a fixed-width region?"
19648 (save-match-data
19649 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19651 (defun org-edit-special (&optional arg)
19652 "Call a special editor for the element at point.
19653 When at a table, call the formula editor with `org-table-edit-formulas'.
19654 When in a source code block, call `org-edit-src-code'.
19655 When in a fixed-width region, call `org-edit-fixed-width-region'.
19656 When at an #+INCLUDE keyword, visit the included file.
19657 On a link, call `ffap' to visit the link at point.
19658 Otherwise, return a user error."
19659 (interactive)
19660 (let ((element (org-element-at-point)))
19661 (assert (not buffer-read-only) nil
19662 "Buffer is read-only: %s" (buffer-name))
19663 (case (org-element-type element)
19664 (src-block
19665 (if (not arg) (org-edit-src-code)
19666 (let* ((info (org-babel-get-src-block-info))
19667 (lang (nth 0 info))
19668 (params (nth 2 info))
19669 (session (cdr (assq :session params))))
19670 (if (not session) (org-edit-src-code)
19671 ;; At a src-block with a session and function called with
19672 ;; an ARG: switch to the buffer related to the inferior
19673 ;; process.
19674 (funcall (intern (concat "org-babel-prep-session:" lang))
19675 session params)))))
19676 (keyword
19677 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
19678 (find-file
19679 (org-remove-double-quotes
19680 (car (org-split-string (org-element-property :value element)))))
19681 (user-error "No special environment to edit here")))
19682 (table
19683 (if (eq (org-element-property :type element) 'table.el)
19684 (org-edit-src-code)
19685 (call-interactively 'org-table-edit-formulas)))
19686 ;; Only Org tables contain `table-row' type elements.
19687 (table-row (call-interactively 'org-table-edit-formulas))
19688 ((example-block export-block) (org-edit-src-code))
19689 (fixed-width (org-edit-fixed-width-region))
19690 (otherwise
19691 ;; No notable element at point. Though, we may be at a link,
19692 ;; which is an object. Thus, scan deeper.
19693 (if (eq (org-element-type (org-element-context element)) 'link)
19694 (call-interactively 'ffap)
19695 (user-error "No special environment to edit here"))))))
19697 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19698 (defun org-ctrl-c-ctrl-c (&optional arg)
19699 "Set tags in headline, or update according to changed information at point.
19701 This command does many different things, depending on context:
19703 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19704 this is what we do.
19706 - If the cursor is on a statistics cookie, update it.
19708 - If the cursor is in a headline, prompt for tags and insert them
19709 into the current line, aligned to `org-tags-column'. When called
19710 with prefix arg, realign all tags in the current buffer.
19712 - If the cursor is in one of the special #+KEYWORD lines, this
19713 triggers scanning the buffer for these lines and updating the
19714 information.
19716 - If the cursor is inside a table, realign the table. This command
19717 works even if the automatic table editor has been turned off.
19719 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19720 the entire table.
19722 - If the cursor is at a footnote reference or definition, jump to
19723 the corresponding definition or references, respectively.
19725 - If the cursor is a the beginning of a dynamic block, update it.
19727 - If the current buffer is a capture buffer, close note and file it.
19729 - If the cursor is on a <<<target>>>, update radio targets and
19730 corresponding links in this buffer.
19732 - If the cursor is on a numbered item in a plain list, renumber the
19733 ordered list.
19735 - If the cursor is on a checkbox, toggle it.
19737 - If the cursor is on a code block, evaluate it. The variable
19738 `org-confirm-babel-evaluate' can be used to control prompting
19739 before code block evaluation, by default every code block
19740 evaluation requires confirmation. Code block evaluation can be
19741 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19742 (interactive "P")
19743 (cond
19744 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19745 org-occur-highlights
19746 org-latex-fragment-image-overlays)
19747 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19748 (org-remove-occur-highlights)
19749 (org-remove-latex-fragment-image-overlays)
19750 (message "Temporary highlights/overlays removed from current buffer"))
19751 ((and (local-variable-p 'org-finish-function (current-buffer))
19752 (fboundp org-finish-function))
19753 (funcall org-finish-function))
19754 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19755 (t
19756 (let* ((context (org-element-context)) (type (org-element-type context)))
19757 ;; Test if point is within a blank line.
19759 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19760 (user-error "C-c C-c can do nothing useful at this location"))
19761 ;; For convenience: at the first line of a paragraph on the
19762 ;; same line as an item, apply function on that item instead.
19763 (when (eq type 'paragraph)
19764 (let ((parent (org-element-property :parent context)))
19765 (when (and (eq (org-element-type parent) 'item)
19766 (= (point-at-bol) (org-element-property :begin parent)))
19767 (setq context parent type 'item))))
19768 ;; Act according to type of element or object at point.
19769 (case type
19770 (clock (org-clock-update-time-maybe))
19771 (dynamic-block
19772 (save-excursion
19773 (goto-char (org-element-property :post-affiliated context))
19774 (org-update-dblock)))
19775 (footnote-definition
19776 (goto-char (org-element-property :post-affiliated context))
19777 (call-interactively 'org-footnote-action))
19778 (footnote-reference (call-interactively 'org-footnote-action))
19779 ((headline inlinetask)
19780 (save-excursion (goto-char (org-element-property :begin context))
19781 (call-interactively 'org-set-tags)))
19782 (item
19783 ;; At an item: a double C-u set checkbox to "[-]"
19784 ;; unconditionally, whereas a single one will toggle its
19785 ;; presence. Without an universal argument, if the item
19786 ;; has a checkbox, toggle it. Otherwise repair the list.
19787 (let* ((box (org-element-property :checkbox context))
19788 (struct (org-element-property :structure context))
19789 (old-struct (copy-tree struct))
19790 (parents (org-list-parents-alist struct))
19791 (prevs (org-list-prevs-alist struct))
19792 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
19793 (org-list-set-checkbox
19794 (org-element-property :begin context) struct
19795 (cond ((equal arg '(16)) "[-]")
19796 ((and (not box) (equal arg '(4))) "[ ]")
19797 ((or (not box) (equal arg '(4))) nil)
19798 ((eq box 'on) "[ ]")
19799 (t "[X]")))
19800 ;; Mimic `org-list-write-struct' but with grabbing
19801 ;; a return value from `org-list-struct-fix-box'.
19802 (org-list-struct-fix-ind struct parents 2)
19803 (org-list-struct-fix-item-end struct)
19804 (org-list-struct-fix-bul struct prevs)
19805 (org-list-struct-fix-ind struct parents)
19806 (let ((block-item
19807 (org-list-struct-fix-box struct parents prevs orderedp)))
19808 (if (and box (equal struct old-struct))
19809 (if (equal arg '(16))
19810 (message "Checkboxes already reset")
19811 (user-error "Cannot toggle this checkbox: %s"
19812 (if (eq box 'on)
19813 "all subitems checked"
19814 "unchecked subitems")))
19815 (org-list-struct-apply-struct struct old-struct)
19816 (org-update-checkbox-count-maybe))
19817 (when block-item
19818 (message "Checkboxes were removed due to empty box at line %d"
19819 (org-current-line block-item))))))
19820 (keyword
19821 (let ((org-inhibit-startup-visibility-stuff t)
19822 (org-startup-align-all-tables nil))
19823 (when (boundp 'org-table-coordinate-overlays)
19824 (mapc 'delete-overlay org-table-coordinate-overlays)
19825 (setq org-table-coordinate-overlays nil))
19826 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19827 (message "Local setup has been refreshed"))
19828 (plain-list
19829 ;; At a plain list, with a double C-u argument, set
19830 ;; checkboxes of each item to "[-]", whereas a single one
19831 ;; will toggle their presence according to the state of the
19832 ;; first item in the list. Without an argument, repair the
19833 ;; list.
19834 (let* ((begin (org-element-property :contents-begin context))
19835 (struct (org-element-property :structure context))
19836 (old-struct (copy-tree struct))
19837 (first-box (save-excursion
19838 (goto-char begin)
19839 (looking-at org-list-full-item-re)
19840 (match-string-no-properties 3)))
19841 (new-box (cond ((equal arg '(16)) "[-]")
19842 ((equal arg '(4)) (unless first-box "[ ]"))
19843 ((equal first-box "[X]") "[ ]")
19844 (t "[X]"))))
19845 (cond
19846 (arg
19847 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
19848 (org-list-get-all-items
19849 begin struct (org-list-prevs-alist struct))))
19850 ((and first-box (eq (point) begin))
19851 ;; For convenience, when point is at bol on the first
19852 ;; item of the list and no argument is provided, simply
19853 ;; toggle checkbox of that item, if any.
19854 (org-list-set-checkbox begin struct new-box)))
19855 (org-list-write-struct
19856 struct (org-list-parents-alist struct) old-struct)
19857 (org-update-checkbox-count-maybe)
19858 (save-excursion (goto-char begin) (org-list-send-list 'maybe))))
19859 ((property-drawer node-property)
19860 (call-interactively 'org-property-action))
19861 ((radio-target target)
19862 (call-interactively 'org-update-radio-target-regexp))
19863 (statistics-cookie
19864 (call-interactively 'org-update-statistics-cookies))
19865 ((table table-cell table-row)
19866 ;; At a table, recalculate every field and align it. Also
19867 ;; send the table if necessary. If the table has
19868 ;; a `table.el' type, just give up. At a table row or
19869 ;; cell, maybe recalculate line but always align table.
19870 (if (eq (org-element-property :type context) 'table.el)
19871 (message "Use C-c ' to edit table.el tables")
19872 (let ((org-enable-table-editor t))
19873 (if (or (eq type 'table)
19874 ;; Check if point is at a TBLFM line.
19875 (and (eq type 'table-row)
19876 (= (point) (org-element-property :end context))))
19877 (save-excursion
19878 (goto-char (org-element-property :contents-begin context))
19879 (org-call-with-arg 'org-table-recalculate (or arg t))
19880 (orgtbl-send-table 'maybe))
19881 (org-table-maybe-eval-formula)
19882 (cond (arg (call-interactively 'org-table-recalculate))
19883 ((org-table-maybe-recalculate-line))
19884 (t (org-table-align)))))))
19885 (timestamp (org-timestamp-change 0 'day))
19886 (otherwise
19887 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19888 (user-error
19889 "C-c C-c can do nothing useful at this location")))))))))
19891 (defun org-mode-restart ()
19892 "Restart Org-mode, to scan again for special lines.
19893 Also updates the keyword regular expressions."
19894 (interactive)
19895 (org-mode)
19896 (message "Org-mode restarted"))
19898 (defun org-kill-note-or-show-branches ()
19899 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19900 (interactive)
19901 (if (not org-finish-function)
19902 (progn
19903 (hide-subtree)
19904 (call-interactively 'show-branches))
19905 (let ((org-note-abort t))
19906 (funcall org-finish-function))))
19908 (defun org-return (&optional indent)
19909 "Goto next table row or insert a newline.
19910 Calls `org-table-next-row' or `newline', depending on context.
19911 See the individual commands for more information."
19912 (interactive)
19913 (let (org-ts-what)
19914 (cond
19915 ((or (bobp) (org-in-src-block-p))
19916 (if indent (newline-and-indent) (newline)))
19917 ((org-at-table-p)
19918 (org-table-justify-field-maybe)
19919 (call-interactively 'org-table-next-row))
19920 ;; when `newline-and-indent' is called within a list, make sure
19921 ;; text moved stays inside the item.
19922 ((and (org-in-item-p) indent)
19923 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19924 (progn
19925 (save-match-data (newline))
19926 (org-indent-line-to (length (match-string 0))))
19927 (let ((ind (org-get-indentation)))
19928 (newline)
19929 (if (org-looking-back org-list-end-re)
19930 (org-indent-line)
19931 (org-indent-line-to ind)))))
19932 ((and org-return-follows-link
19933 (org-at-timestamp-p t)
19934 (not (eq org-ts-what 'after)))
19935 (org-follow-timestamp-link))
19936 ((and org-return-follows-link
19937 (let ((tprop (get-text-property (point) 'face)))
19938 (or (eq tprop 'org-link)
19939 (and (listp tprop) (memq 'org-link tprop)))))
19940 (call-interactively 'org-open-at-point))
19941 ((and (org-at-heading-p)
19942 (looking-at
19944 (org-show-entry)
19945 (end-of-line 1)
19946 (newline))
19947 (t (if indent (newline-and-indent) (newline))))))
19949 (defun org-return-indent ()
19950 "Goto next table row or insert a newline and indent.
19951 Calls `org-table-next-row' or `newline-and-indent', depending on
19952 context. See the individual commands for more information."
19953 (interactive)
19954 (org-return t))
19956 (defun org-ctrl-c-star ()
19957 "Compute table, or change heading status of lines.
19958 Calls `org-table-recalculate' or `org-toggle-heading',
19959 depending on context."
19960 (interactive)
19961 (cond
19962 ((org-at-table-p)
19963 (call-interactively 'org-table-recalculate))
19964 (t
19965 ;; Convert all lines in region to list items
19966 (call-interactively 'org-toggle-heading))))
19968 (defun org-ctrl-c-minus ()
19969 "Insert separator line in table or modify bullet status of line.
19970 Also turns a plain line or a region of lines into list items.
19971 Calls `org-table-insert-hline', `org-toggle-item', or
19972 `org-cycle-list-bullet', depending on context."
19973 (interactive)
19974 (cond
19975 ((org-at-table-p)
19976 (call-interactively 'org-table-insert-hline))
19977 ((org-region-active-p)
19978 (call-interactively 'org-toggle-item))
19979 ((org-in-item-p)
19980 (call-interactively 'org-cycle-list-bullet))
19981 (t
19982 (call-interactively 'org-toggle-item))))
19984 (defun org-toggle-item (arg)
19985 "Convert headings or normal lines to items, items to normal lines.
19986 If there is no active region, only the current line is considered.
19988 If the first non blank line in the region is a headline, convert
19989 all headlines to items, shifting text accordingly.
19991 If it is an item, convert all items to normal lines.
19993 If it is normal text, change region into an item. With a prefix
19994 argument ARG, change each line in region into an item."
19995 (interactive "P")
19996 (let ((shift-text
19997 (function
19998 ;; Shift text in current section to IND, from point to END.
19999 ;; The function leaves point to END line.
20000 (lambda (ind end)
20001 (let ((min-i 1000) (end (copy-marker end)))
20002 ;; First determine the minimum indentation (MIN-I) of
20003 ;; the text.
20004 (save-excursion
20005 (catch 'exit
20006 (while (< (point) end)
20007 (let ((i (org-get-indentation)))
20008 (cond
20009 ;; Skip blank lines and inline tasks.
20011 ((looking-at org-outline-regexp-bol))
20012 ;; We can't find less than 0 indentation.
20013 ((zerop i) (throw 'exit (setq min-i 0)))
20014 ((< i min-i) (setq min-i i))))
20015 (forward-line))))
20016 ;; Then indent each line so that a line indented to
20017 ;; MIN-I becomes indented to IND. Ignore blank lines
20018 ;; and inline tasks in the process.
20019 (let ((delta (- ind min-i)))
20020 (while (< (point) end)
20022 (looking-at org-outline-regexp-bol))
20023 (org-indent-line-to (+ (org-get-indentation) delta)))
20024 (forward-line)))))))
20025 (skip-blanks
20026 (function
20027 ;; Return beginning of first non-blank line, starting from
20028 ;; line at POS.
20029 (lambda (pos)
20030 (save-excursion
20031 (goto-char pos)
20033 (point-at-bol)))))
20034 beg end)
20035 ;; Determine boundaries of changes.
20036 (if (org-region-active-p)
20037 (setq beg (funcall skip-blanks (region-beginning))
20038 end (copy-marker (region-end)))
20039 (setq beg (funcall skip-blanks (point-at-bol))
20040 end (copy-marker (point-at-eol))))
20041 ;; Depending on the starting line, choose an action on the text
20042 ;; between BEG and END.
20043 (org-with-limited-levels
20044 (save-excursion
20045 (goto-char beg)
20046 (cond
20047 ;; Case 1. Start at an item: de-itemize. Note that it only
20048 ;; happens when a region is active: `org-ctrl-c-minus'
20049 ;; would call `org-cycle-list-bullet' otherwise.
20050 ((org-at-item-p)
20051 (while (< (point) end)
20052 (when (org-at-item-p)
20054 (delete-region (point) (match-end 0)))
20055 (forward-line)))
20056 ;; Case 2. Start at an heading: convert to items.
20057 ((org-at-heading-p)
20058 (let* ((bul (org-list-bullet-string "-"))
20059 (bul-len (length bul))
20060 ;; Indentation of the first heading. It should be
20061 ;; relative to the indentation of its parent, if any.
20062 (start-ind (save-excursion
20063 (cond
20064 ((not org-adapt-indentation) 0)
20065 ((not (outline-previous-heading)) 0)
20066 (t (length (match-string 0))))))
20067 ;; Level of first heading. Further headings will be
20068 ;; compared to it to determine hierarchy in the list.
20069 (ref-level (org-reduced-level (org-outline-level))))
20070 (while (< (point) end)
20071 (let* ((level (org-reduced-level (org-outline-level)))
20072 (delta (max 0 (- level ref-level))))
20073 ;; If current headline is less indented than the first
20074 ;; one, set it as reference, in order to preserve
20075 ;; subtrees.
20076 (when (< level ref-level) (setq ref-level level))
20077 (replace-match bul t t)
20078 (org-indent-line-to (+ start-ind (* delta bul-len)))
20079 ;; Ensure all text down to END (or SECTION-END) belongs
20080 ;; to the newly created item.
20081 (let ((section-end (save-excursion
20082 (or (outline-next-heading) (point)))))
20083 (forward-line)
20084 (funcall shift-text
20085 (+ start-ind (* (1+ delta) bul-len))
20086 (min end section-end)))))))
20087 ;; Case 3. Normal line with ARG: turn each non-item line into
20088 ;; an item.
20089 (arg
20090 (while (< (point) end)
20091 (unless (or (org-at-heading-p) (org-at-item-p))
20093 (replace-match
20095 (forward-line)))
20096 ;; Case 4. Normal line without ARG: make the first line of
20097 ;; region an item, and shift indentation of others
20098 ;; lines to set them as item's body.
20099 (t (let* ((bul (org-list-bullet-string "-"))
20100 (bul-len (length bul))
20101 (ref-ind (org-get-indentation)))
20103 (insert bul)
20104 (forward-line)
20105 (while (< (point) end)
20106 ;; Ensure that lines less indented than first one
20107 ;; still get included in item body.
20108 (funcall shift-text
20109 (+ ref-ind bul-len)
20110 (min end (save-excursion (or (outline-next-heading)
20111 (point)))))
20112 (forward-line)))))))))
20114 (defun org-toggle-heading (&optional nstars)
20115 "Convert headings to normal text, or items or text to headings.
20116 If there is no active region, only the current line is considered.
20119 point into heading.
20121 In a region:
20123 - If the first non blank line is a headline, remove the stars
20124 from all headlines in the region.
20126 - If it is a normal line turn each and every normal line (i.e. not an
20127 heading or an item) in the region into a heading.
20129 - If it is a plain list item, turn all plain list items into headings.
20131 When converting a line into a heading, the number of stars is chosen
20132 such that the lines become children of the current entry. However,
20133 when a prefix argument is given, its value determines the number of
20134 stars to add."
20135 (interactive "P")
20136 (let ((skip-blanks
20137 (function
20138 ;; Return beginning of first non-blank line, starting from
20139 ;; line at POS.
20140 (lambda (pos)
20141 (save-excursion
20142 (goto-char pos)
20143 (while (org-at-comment-p) (forward-line))
20145 (point-at-bol)))))
20146 beg end toggled)
20147 ;; Determine boundaries of changes. If a universal prefix has
20148 ;; been given, put the list in a region. If region ends at a bol,
20149 ;; do not consider the last line to be in the region.
20151 (when (and current-prefix-arg (org-at-item-p))
20152 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
20153 (org-mark-element))
20155 (if (org-region-active-p)
20156 (setq beg (funcall skip-blanks (region-beginning))
20157 end (copy-marker (save-excursion
20158 (goto-char (region-end))
20159 (if (bolp) (point) (point-at-eol)))))
20160 (setq beg (funcall skip-blanks (point-at-bol))
20161 end (copy-marker (point-at-eol))))
20162 ;; Ensure inline tasks don't count as headings.
20163 (org-with-limited-levels
20164 (save-excursion
20165 (goto-char beg)
20166 (cond
20167 ;; Case 1. Started at an heading: de-star headings.
20168 ((org-at-heading-p)
20169 (while (< (point) end)
20170 (when (org-at-heading-p t)
20171 (looking-at org-outline-regexp) (replace-match "")
20172 (setq toggled t))
20173 (forward-line)))
20174 ;; Case 2. Started at an item: change items into headlines.
20175 ;; One star will be added by `org-list-to-subtree'.
20176 ((org-at-item-p)
20177 (let* ((stars (make-string
20178 (if nstars
20179 ;; subtract the star that will be added again by
20180 ;; `org-list-to-subtree'
20181 (1- (prefix-numeric-value current-prefix-arg))
20182 (or (org-current-level) 0))
20183 ?*))
20184 (add-stars
20185 (cond (nstars "") ; stars from prefix only
20186 ((equal stars "") "") ; before first heading
20187 (org-odd-levels-only "*") ; inside heading, odd
20188 (t "")))) ; inside heading, oddeven
20189 (while (< (point) end)
20190 (when (org-at-item-p)
20191 ;; Pay attention to cases when region ends before list.
20192 (let* ((struct (org-list-struct))
20193 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20194 (save-restriction
20195 (narrow-to-region (point) list-end)
20196 (insert
20197 (org-list-to-subtree
20198 (org-list-parse-list t)
20199 '(:istart (concat stars add-stars (funcall get-stars depth))
20200 :icount (concat stars add-stars (funcall get-stars depth)))))))
20201 (setq toggled t))
20202 (forward-line))))
20203 ;; Case 3. Started at normal text: make every line an heading,
20204 ;; skipping headlines and items.
20205 (t (let* ((stars (make-string
20206 (if nstars
20207 (prefix-numeric-value current-prefix-arg)
20208 (or (org-current-level) 0))
20209 ?*))
20210 (add-stars
20211 (cond (nstars "") ; stars from prefix only
20212 ((equal stars "") "*") ; before first heading
20213 (org-odd-levels-only "**") ; inside heading, odd
20214 (t "*"))) ; inside heading, oddeven
20215 (rpl (concat stars add-stars " ")))
20216 (while (< (point) end)
20217 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20219 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20220 (forward-line)))))))
20221 (unless toggled (message "Cannot toggle heading from here"))))
20223 (defun org-meta-return (&optional arg)
20224 "Insert a new heading or wrap a region in a table.
20225 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20226 See the individual commands for more information."
20227 (interactive "P")
20228 (cond
20229 ((run-hook-with-args-until-success 'org-metareturn-hook))
20230 ((or (org-at-drawer-p) (org-at-property-p))
20231 (newline-and-indent))
20232 ((org-at-table-p)
20233 (call-interactively 'org-table-wrap-region))
20234 (t (call-interactively 'org-insert-heading))))
20236 ;;; Menu entries
20238 (defsubst org-in-subtree-not-table-p ()
20239 "Are we in a subtree and not in a table?"
20240 (and (not (org-before-first-heading-p))
20241 (not (org-at-table-p))))
20243 ;; Define the Org-mode menus
20244 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20245 '("Tbl"
20246 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20247 ["Next Field" org-cycle (org-at-table-p)]
20248 ["Previous Field" org-shifttab (org-at-table-p)]
20249 ["Next Row" org-return (org-at-table-p)]
20250 "--"
20251 ["Blank Field" org-table-blank-field (org-at-table-p)]
20252 ["Edit Field" org-table-edit-field (org-at-table-p)]
20253 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20254 "--"
20255 ("Column"
20256 ["Move Column Left" org-metaleft (org-at-table-p)]
20257 ["Move Column Right" org-metaright (org-at-table-p)]
20258 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20259 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20260 ("Row"
20261 ["Move Row Up" org-metaup (org-at-table-p)]
20262 ["Move Row Down" org-metadown (org-at-table-p)]
20263 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20264 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20265 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20266 "--"
20267 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20268 ("Rectangle"
20269 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20270 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20271 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20272 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20273 "--"
20274 ("Calculate"
20275 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20276 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20277 ["Edit Formulas" org-edit-special (org-at-table-p)]
20278 "--"
20279 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20280 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20281 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20282 "--"
20283 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20284 "--"
20285 ["Sum Column/Rectangle" org-table-sum
20286 (or (org-at-table-p) (org-region-active-p))]
20287 ["Which Column?" org-table-current-column (org-at-table-p)])
20288 ["Debug Formulas"
20289 org-table-toggle-formula-debugger
20290 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20291 ["Show Col/Row Numbers"
20292 org-table-toggle-coordinate-overlays
20293 :style toggle
20294 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20295 "--"
20296 ["Create" org-table-create (and (not (org-at-table-p))
20297 org-enable-table-editor)]
20298 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20299 ["Import from File" org-table-import (not (org-at-table-p))]
20300 ["Export to File" org-table-export (org-at-table-p)]
20301 "--"
20302 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20304 (easy-menu-define org-org-menu org-mode-map "Org menu"
20305 '("Org"
20306 ("Show/Hide"
20307 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20308 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20309 ["Sparse Tree..." org-sparse-tree t]
20310 ["Reveal Context" org-reveal t]
20311 ["Show All" show-all t]
20312 "--"
20313 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20314 "--"
20315 ["New Heading" org-insert-heading t]
20316 ("Navigate Headings"
20317 ["Up" outline-up-heading t]
20318 ["Next" outline-next-visible-heading t]
20319 ["Previous" outline-previous-visible-heading t]
20320 ["Next Same Level" outline-forward-same-level t]
20321 ["Previous Same Level" outline-backward-same-level t]
20322 "--"
20323 ["Jump" org-goto t])
20324 ("Edit Structure"
20325 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20326 "--"
20327 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20328 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20329 "--"
20330 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20331 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20332 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20333 "--"
20334 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20335 "--"
20336 ["Copy visible text" org-copy-visible t]
20337 "--"
20338 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20339 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20340 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20341 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20342 "--"
20343 ["Sort Region/Children" org-sort t]
20344 "--"
20345 ["Convert to odd levels" org-convert-to-odd-levels t]
20346 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20347 ("Editing"
20348 ["Emphasis..." org-emphasize t]
20349 ["Edit Source Example" org-edit-special t]
20350 "--"
20351 ["Footnote new/jump" org-footnote-action t]
20352 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20353 ("Archive"
20354 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20355 "--"
20356 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20357 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20358 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20359 )
20360 "--"
20361 ("Hyperlinks"
20362 ["Store Link (Global)" org-store-link t]
20363 ["Find existing link to here" org-occur-link-in-agenda-files t]
20364 ["Insert Link" org-insert-link t]
20365 ["Follow Link" org-open-at-point t]
20366 "--"
20367 ["Next link" org-next-link t]
20368 ["Previous link" org-previous-link t]
20369 "--"
20370 ["Descriptive Links"
20371 org-toggle-link-display
20372 :style radio
20373 :selected org-descriptive-links
20374 ]
20375 ["Literal Links"
20376 org-toggle-link-display
20377 :style radio
20378 :selected (not org-descriptive-links)])
20379 "--"
20380 ("TODO Lists"
20381 ["TODO/DONE/-" org-todo t]
20382 ("Select keyword"
20383 ["Next keyword" org-shiftright (org-at-heading-p)]
20384 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20385 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20386 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20387 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20388 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20389 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20390 "--"
20391 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20392 :selected org-enforce-todo-dependencies :style toggle :active t]
20393 "Settings for tree at point"
20394 ["Do Children sequentially" org-toggle-ordered-property :style radio
20395 :selected (org-entry-get nil "ORDERED")
20396 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20397 ["Do Children parallel" org-toggle-ordered-property :style radio
20398 :selected (not (org-entry-get nil "ORDERED"))
20399 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20400 "--"
20401 ["Set Priority" org-priority t]
20402 ["Priority Up" org-shiftup t]
20403 ["Priority Down" org-shiftdown t]
20404 "--"
20405 ["Get news from all feeds" org-feed-update-all t]
20406 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20407 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20408 ("TAGS and Properties"
20409 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20410 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20411 "--"
20412 ["Set property" org-set-property (not (org-before-first-heading-p))]
20413 ["Column view of properties" org-columns t]
20414 ["Insert Column View DBlock" org-insert-columns-dblock t])
20415 ("Dates and Scheduling"
20416 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20417 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20418 ("Change Date"
20419 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20420 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20421 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20422 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20423 ["Compute Time Range" org-evaluate-time-range t]
20424 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20425 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20426 "--"
20427 ["Custom time format" org-toggle-time-stamp-overlays
20428 :style radio :selected org-display-custom-times]
20429 "--"
20430 ["Goto Calendar" org-goto-calendar t]
20431 ["Date from Calendar" org-date-from-calendar t]
20432 "--"
20433 ["Start/Restart Timer" org-timer-start t]
20434 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20435 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20436 ["Insert Timer String" org-timer t]
20437 ["Insert Timer Item" org-timer-item t])
20438 ("Logging work"
20439 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20440 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20441 ["Clock out" org-clock-out t]
20442 ["Clock cancel" org-clock-cancel t]
20443 "--"
20444 ["Mark as default task" org-clock-mark-default-task t]
20445 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20446 ["Goto running clock" org-clock-goto t]
20447 "--"
20448 ["Display times" org-clock-display t]
20449 ["Create clock table" org-clock-report t]
20450 "--"
20451 ["Record DONE time"
20452 (progn (setq org-log-done (not org-log-done))
20453 (message "Switching to %s will %s record a timestamp"
20454 (car org-done-keywords)
20455 (if org-log-done "automatically" "not")))
20456 :style toggle :selected org-log-done])
20457 "--"
20458 ["Agenda Command..." org-agenda t]
20459 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20460 ("File List for Agenda")
20461 ("Special views current file"
20462 ["TODO Tree" org-show-todo-tree t]
20463 ["Check Deadlines" org-check-deadlines t]
20464 ["Timeline" org-timeline t]
20465 ["Tags/Property tree" org-match-sparse-tree t])
20466 "--"
20467 ["Export/Publish..." org-export-dispatch t]
20468 ("LaTeX"
20469 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20470 :selected org-cdlatex-mode]
20471 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20472 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20473 ["Modify math symbol" org-cdlatex-math-modify
20474 (org-inside-LaTeX-fragment-p)]
20475 ["Insert citation" org-reftex-citation t]
20476 "--"
20477 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20478 "--"
20479 ("MobileOrg"
20480 ["Push Files and Views" org-mobile-push t]
20481 ["Get Captured and Flagged" org-mobile-pull t]
20482 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20483 "--"
20484 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20485 "--"
20486 ("Documentation"
20487 ["Show Version" org-version t]
20488 ["Info Documentation" org-info t])
20489 ("Customize"
20490 ["Browse Org Group" org-customize t]
20491 "--"
20492 ["Expand This Menu" org-create-customize-menu
20493 (fboundp 'customize-menu-create)])
20494 ["Send bug report" org-submit-bug-report t]
20495 "--"
20496 ("Refresh/Reload"
20497 ["Refresh setup current buffer" org-mode-restart t]
20498 ["Reload Org (after update)" org-reload t]
20499 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20500 ))
20502 (defun org-info (&optional node)
20503 "Read documentation for Org-mode in the info system.
20504 With optional NODE, go directly to that node."
20505 (interactive)
20506 (info (format "(org)%s" (or node ""))))
20508 ;;;###autoload
20509 (defun org-submit-bug-report ()
20510 "Submit a bug report on Org-mode via mail.
20512 Don't hesitate to report any problems or inaccurate documentation.
20514 If you don't have setup sending mail from (X)Emacs, please copy the
20515 output buffer into your mail program, as it gives us important
20516 information about your Org-mode version and configuration."
20517 (interactive)
20518 (require 'reporter)
20519 (org-load-modules-maybe)
20520 (org-require-autoloaded-modules)
20521 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20522 (reporter-submit-bug-report
20523 "emacs-orgmode@gnu.org"
20524 (org-version nil 'full)
20525 (let (list)
20526 (save-window-excursion
20527 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20528 (delete-other-windows)
20529 (erase-buffer)
20530 (insert "You are about to submit a bug report to the Org-mode mailing list.
20532 We would like to add your full Org-mode and Outline configuration to the
20533 bug report. This greatly simplifies the work of the maintainer and
20534 other experts on the mailing list.
20536 HOWEVER, some variables you have customized may contain private
20537 information. The names of customers, colleagues, or friends, might
20538 appear in the form of file names, tags, todo states, or search strings.
20539 If you answer yes to the prompt, you might want to check and remove
20540 such private information before sending the email.")
20541 (add-text-properties (point-min) (point-max) '(face org-warning))
20542 (when (yes-or-no-p "Include your Org-mode configuration ")
20543 (mapatoms
20544 (lambda (v)
20545 (and (boundp v)
20547 (or (and (symbol-value v)
20549 (and
20550 (get v 'custom-type) (get v 'standard-value)
20551 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20552 (push v list)))))
20553 (kill-buffer (get-buffer "*Warn about privacy*"))
20554 list))
20555 nil nil
20556 "Remember to cover the basics, that is, what you expected to happen and
20557 what in fact did happen. You don't know how to make a good report? See
20559 http://orgmode.org/manual/Feedback.html#Feedback
20561 Your bug report will be posted to the Org-mode mailing list.
20562 ------------------------------------------------------------------------")
20563 (save-excursion
20568 (defun org-install-agenda-files-menu ()
20569 (let ((bl (buffer-list)))
20570 (save-excursion
20571 (while bl
20572 (set-buffer (pop bl))
20573 (if (derived-mode-p 'org-mode) (setq bl nil)))
20574 (when (derived-mode-p 'org-mode)
20575 (easy-menu-change
20576 '("Org") "File List for Agenda"
20577 (append
20578 (list
20579 ["Edit File List" (org-edit-agenda-file-list) t]
20580 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20581 ["Remove Current File from List" org-remove-file t]
20582 ["Cycle through agenda files" org-cycle-agenda-files t]
20583 ["Occur in all agenda files" org-occur-in-agenda-files t]
20584 "--")
20585 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20587 ;;;; Documentation
20589 (defun org-require-autoloaded-modules ()
20590 (interactive)
20591 (mapc 'require
20592 '(org-agenda org-archive org-attach org-clock org-colview org-id
20593 org-remember org-table org-timer)))
20595 ;;;###autoload
20596 (defun org-reload (&optional uncompiled)
20597 "Reload all org lisp files.
20598 With prefix arg UNCOMPILED, load the uncompiled versions."
20599 (interactive "P")
20600 (require 'loadhist)
20601 (let* ((org-dir (org-find-library-dir "org"))
20602 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20604 (remove-re (mapconcat 'identity
20605 (mapcar (lambda (f) (concat "^" f "$"))
20606 (list (if (featurep 'xemacs)
20607 "org-colview"
20608 "org-colview-xemacs")
20609 "org" "org-loaddefs" "org-version"))
20611 (feats (delete-dups
20612 (mapcar 'file-name-sans-extension
20613 (mapcar 'file-name-nondirectory
20614 (delq nil
20615 (mapcar 'feature-file
20616 features))))))
20617 (lfeat (append
20618 (sort
20619 (setq feats
20620 (delq nil (mapcar
20621 (lambda (f)
20622 (if (and (string-match feature-re f)
20623 (not (string-match remove-re f)))
20624 f nil))
20625 feats)))
20626 'string-lessp)
20627 (list "org-version" "org")))
20628 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20629 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20630 load-uncore load-misses)
20631 (setq load-misses
20632 (delq 't
20633 (mapcar (lambda (f)
20634 (or (org-load-noerror-mustsuffix (concat org-dir f))
20635 (and (string= org-dir contrib-dir)
20636 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20637 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20638 (add-to-list 'load-uncore f 'append)
20639 't)
20640 f))
20641 lfeat)))
20642 (if load-uncore
20644 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20645 (if load-misses
20647 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20650 ;;;###autoload
20651 (defun org-customize ()
20652 "Call the customize function with org as argument."
20653 (interactive)
20654 (org-load-modules-maybe)
20655 (org-require-autoloaded-modules)
20656 (customize-browse 'org))
20658 (defun org-create-customize-menu ()
20659 "Create a full customization menu for Org-mode, insert it into the menu."
20660 (interactive)
20661 (org-load-modules-maybe)
20662 (org-require-autoloaded-modules)
20663 (if (fboundp 'customize-menu-create)
20664 (progn
20665 (easy-menu-change
20666 '("Org") "Customize"
20667 `(["Browse Org group" org-customize t]
20668 "--"
20669 ,(customize-menu-create 'org)
20670 ["Set" Custom-set t]
20671 ["Save" Custom-save t]
20672 ["Reset to Current" Custom-reset-current t]
20673 ["Reset to Saved" Custom-reset-saved t]
20674 ["Reset to Standard Settings" Custom-reset-standard t]))
20676 (error "Cannot expand menu (outdated version of cus-edit.el)")))
20678 ;;;; Miscellaneous stuff
20680 ;;; Generally useful functions
20682 (defun org-get-at-bol (property)
20683 "Get text property PROPERTY at beginning of line."
20684 (get-text-property (point-at-bol) property))
20686 (defun org-find-text-property-in-string (prop s)
20687 "Return the first non-nil value of property PROP in string S."
20688 (or (get-text-property 0 prop s)
20689 (get-text-property (or (next-single-property-change 0 prop s) 0)
20690 prop s)))
20692 (defun org-display-warning (message) ;; Copied from Emacs-Muse
20693 "Display the given MESSAGE as a warning."
20694 (if (fboundp 'display-warning)
20695 (display-warning 'org message
20696 (if (featurep 'xemacs) 'warning :warning))
20697 (let ((buf (get-buffer-create "*Org warnings*")))
20698 (with-current-buffer buf
20699 (goto-char (point-max))
20700 (insert "Warning (Org): " message)
20701 (unless (bolp)
20702 (newline)))
20703 (display-buffer buf)
20704 (sit-for 0))))
20706 (defun org-eval (form)
20707 "Eval FORM and return result."
20708 (condition-case error
20709 (eval form)
20710 (error (format "%%![Error: %s]" error))))
20712 (defun org-in-clocktable-p ()
20713 "Check if the cursor is in a clocktable."
20714 (let ((pos (point)) start)
20715 (save-excursion
20716 (end-of-line 1)
20718 (setq start (match-beginning 0))
20720 (>= (match-end 0) pos)
20721 start))))
20723 (defun org-in-commented-line ()
20724 "Is point in a line starting with `#'?"
20725 (equal (char-after (point-at-bol)) ?#))
20727 (defun org-in-indented-comment-line ()
20728 "Is point in a line starting with `#' after some white space?"
20729 (save-excursion
20730 (save-match-data
20731 (goto-char (point-at-bol))
20734 (defun org-in-verbatim-emphasis ()
20735 (save-match-data
20736 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
20738 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20739 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20740 (if (and marker (marker-buffer marker)
20741 (buffer-live-p (marker-buffer marker)))
20742 (progn
20743 (org-pop-to-buffer-same-window (marker-buffer marker))
20744 (if (or (> marker (point-max)) (< marker (point-min)))
20745 (widen))
20746 (goto-char marker)
20747 (org-show-context 'org-goto))
20748 (if bookmark
20749 (bookmark-jump bookmark)
20750 (error "Cannot find location"))))
20752 (defun org-quote-csv-field (s)
20753 "Quote field for inclusion in CSV material."
20756 s))
20758 (defun org-force-self-insert (N)
20759 "Needed to enforce self-insert under remapping."
20760 (interactive "p")
20761 (self-insert-command N))
20763 (defun org-string-width (s)
20764 "Compute width of string, ignoring invisible characters.
20765 This ignores character with invisibility property `org-link', and also
20766 characters with property `org-cwidth', because these will become invisible
20767 upon the next fontification round."
20768 (let (b l)
20769 (when (or (eq t buffer-invisibility-spec)
20770 (assq 'org-link buffer-invisibility-spec))
20771 (while (setq b (text-property-any 0 (length s)
20772 'invisible 'org-link s))
20773 (setq s (concat (substring s 0 b)
20774 (substring s (or (next-single-property-change
20775 b 'invisible s) (length s)))))))
20776 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20777 (setq s (concat (substring s 0 b)
20778 (substring s (or (next-single-property-change
20779 b 'org-cwidth s) (length s))))))
20780 (setq l (string-width s) b -1)
20781 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20782 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20783 l))
20785 (defun org-shorten-string (s maxlength)
20786 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20787 If the string is shorter or has length MAXLENGTH, just return the
20788 original string. If it is longer, the functions finds a space in the
20789 string, breaks this string off at that locations and adds three dots
20790 as ellipsis. Including the ellipsis, the string will not be longer
20791 than MAXLENGTH. If finding a good breaking point in the string does
20792 not work, the string is just chopped off in the middle of a word
20793 if necessary."
20794 (if (<= (length s) maxlength)
20795 s
20796 (let* ((n (max (- maxlength 4) 1))
20798 (if (string-match re s)
20799 (concat (match-string 1 s) "...")
20800 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20802 (defun org-get-indentation (&optional line)
20803 "Get the indentation of the current line, interpreting tabs.
20804 When LINE is given, assume it represents a line and compute its indentation."
20805 (if line
20806 (if (string-match "^ *" (org-remove-tabs line))
20807 (match-end 0))
20808 (save-excursion
20809 (beginning-of-line 1)
20811 (current-column))))
20813 (defun org-get-string-indentation (s)
20814 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20815 (let ((n -1) (i 0) (w tab-width) c)
20816 (catch 'exit
20817 (while (< (setq n (1+ n)) (length s))
20818 (setq c (aref s n))
20819 (cond ((= c ?\ ) (setq i (1+ i)))
20821 (t (throw 'exit t)))))
20822 i))
20824 (defun org-remove-tabs (s &optional width)
20825 "Replace tabulators in S with spaces.
20826 Assumes that s is a single line, starting in column 0."
20827 (setq width (or width tab-width))
20829 (setq s (replace-match
20830 (make-string
20831 (- (* width (/ (+ (match-beginning 0) width) width))
20832 (match-beginning 0)) ?\ )
20833 t t s)))
20834 s)
20836 (defun org-fix-indentation (line ind)
20837 "Fix indentation in LINE.
20838 IND is a cons cell with target and minimum indentation.
20839 If the current indentation in LINE is smaller than the minimum,
20840 leave it alone. If it is larger than ind, set it to the target."
20841 (let* ((l (org-remove-tabs line))
20842 (i (org-get-indentation l))
20843 (i1 (car ind)) (i2 (cdr ind)))
20844 (if (>= i i2) (setq l (substring line i2)))
20845 (if (> i1 0)
20846 (concat (make-string i1 ?\ ) l)
20847 l)))
20849 (defun org-remove-indentation (code &optional n)
20850 "Remove the maximum common indentation from the lines in CODE.
20851 N may optionally be the number of spaces to remove."
20852 (with-temp-buffer
20853 (insert code)
20854 (org-do-remove-indentation n)
20855 (buffer-string)))
20857 (defun org-do-remove-indentation (&optional n)
20858 "Remove the maximum common indentation from the buffer."
20859 (untabify (point-min) (point-max))
20860 (let ((min 10000) re)
20861 (if n
20862 (setq min n)
20863 (goto-char (point-min))
20865 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20866 (unless (or (= min 0) (= min 10000))
20868 (goto-char (point-min))
20869 (while (re-search-forward re nil t)
20870 (replace-match "")
20871 (end-of-line 1))
20872 min)))
20874 (defun org-fill-template (template alist)
20875 "Find each %key of ALIST in TEMPLATE and replace it."
20876 (let ((case-fold-search nil)
20877 entry key value)
20878 (setq alist (sort (copy-sequence alist)
20879 (lambda (a b) (< (length (car a)) (length (car b))))))
20880 (while (setq entry (pop alist))
20881 (setq template
20882 (replace-regexp-in-string
20883 (concat "%" (regexp-quote (car entry)))
20884 (or (cdr entry) "") template t t)))
20885 template))
20887 (defun org-base-buffer (buffer)
20888 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20889 (if (not buffer)
20890 buffer
20891 (or (buffer-base-buffer buffer)
20892 buffer)))
20894 (defun org-trim (s)
20895 "Remove whitespace at beginning and end of string."
20898 s)
20900 (defun org-wrap (string &optional width lines)
20901 "Wrap string to either a number of lines, or a width in characters.
20902 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20903 that costs. If there is a word longer than WIDTH, the text is actually
20904 wrapped to the length of that word.
20905 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20906 many lines, whatever width that takes.
20907 The return value is a list of lines, without newlines at the end."
20909 (maxword (apply 'max (mapcar 'org-string-width words)))
20910 w ll)
20911 (cond (width
20912 (org-do-wrap words (max maxword width)))
20913 (lines
20914 (setq w maxword)
20915 (setq ll (org-do-wrap words maxword))
20916 (if (<= (length ll) lines)
20917 ll
20918 (setq ll words)
20919 (while (> (length ll) lines)
20920 (setq w (1+ w))
20921 (setq ll (org-do-wrap words w)))
20922 ll))
20923 (t (error "Cannot wrap this")))))
20925 (defun org-do-wrap (words width)
20926 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20927 (let (lines line)
20928 (while words
20929 (setq line (pop words))
20930 (while (and words (< (+ (length line) (length (car words))) width))
20931 (setq line (concat line " " (pop words))))
20932 (setq lines (push line lines)))
20933 (nreverse lines)))
20935 (defun org-split-string (string &optional separators)
20936 "Splits STRING into substrings at SEPARATORS.
20937 No empty strings are returned if there are matches at the beginning
20938 and end of string."
20940 (start 0)
20941 notfirst
20942 (list nil))
20943 (while (and (string-match rexp string
20944 (if (and notfirst
20945 (= start (match-beginning 0))
20946 (< start (length string)))
20947 (1+ start) start))
20948 (< (match-beginning 0) (length string)))
20949 (setq notfirst t)
20950 (or (eq (match-beginning 0) 0)
20951 (and (eq (match-beginning 0) (match-end 0))
20952 (eq (match-beginning 0) start))
20953 (setq list
20954 (cons (substring string start (match-beginning 0))
20955 list)))
20956 (setq start (match-end 0)))
20957 (or (eq start (length string))
20958 (setq list
20959 (cons (substring string start)
20960 list)))
20961 (nreverse list)))
20963 (defun org-quote-vert (s)
20965 (while (string-match "|" s)
20967 s)
20969 (defun org-uuidgen-p (s)
20970 "Is S an ID created by UUIDGEN?"
20971 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20973 (defun org-in-src-block-p (&optional inside)
20974 "Whether point is in a code source block.
20975 When INSIDE is non-nil, don't consider we are within a src block
20976 when point is at #+BEGIN_SRC or #+END_SRC."
20977 (let ((case-fold-search t) ov)
20978 (or (and (setq ov (overlays-at (point)))
20979 (memq 'org-block-background
20980 (overlay-properties (car ov))))
20981 (and (not inside)
20982 (save-match-data
20983 (save-excursion
20984 (beginning-of-line)
20987 (defun org-context ()
20988 "Return a list of contexts of the current cursor position.
20989 If several contexts apply, all are returned.
20990 Each context entry is a list with a symbol naming the context, and
20991 two positions indicating start and end of the context. Possible
20992 contexts are:
20994 :headline anywhere in a headline
20995 :headline-stars on the leading stars in a headline
20996 :todo-keyword on a TODO keyword (including DONE) in a headline
20997 :tags on the TAGS in a headline
20998 :priority on the priority cookie in a headline
20999 :item on the first line of a plain list item
21000 :item-bullet on the bullet/number of a plain list item
21001 :checkbox on the checkbox in a plain list item
21002 :table in an org-mode table
21003 :table-special on a special filed in a table
21004 :table-table in a table.el table
21005 :clocktable in a clocktable
21006 :src-block in a source block
21007 :link on a hyperlink
21008 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21009 :target on a <<target>>
21010 :radio-target on a <<<radio-target>>>
21011 :latex-fragment on a LaTeX fragment
21012 :latex-preview on a LaTeX fragment with overlaid preview image
21014 This function expects the position to be visible because it uses font-lock
21015 faces as a help to recognize the following contexts: :table-special, :link,
21016 and :keyword."
21017 (let* ((f (get-text-property (point) 'face))
21018 (faces (if (listp f) f (list f)))
21019 (case-fold-search t)
21020 (p (point)) clist o)
21021 ;; First the large context
21022 (cond
21023 ((org-at-heading-p t)
21024 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21025 (when (progn
21026 (beginning-of-line 1)
21027 (looking-at org-todo-line-tags-regexp))
21028 (push (org-point-in-group p 1 :headline-stars) clist)
21029 (push (org-point-in-group p 2 :todo-keyword) clist)
21030 (push (org-point-in-group p 4 :tags) clist))
21031 (goto-char p)
21034 (push (org-point-in-group p 0 :priority) clist)))
21036 ((org-at-item-p)
21037 (push (org-point-in-group p 2 :item-bullet) clist)
21038 (push (list :item (point-at-bol)
21039 (save-excursion (org-end-of-item) (point)))
21040 clist)
21041 (and (org-at-item-checkbox-p)
21042 (push (org-point-in-group p 0 :checkbox) clist)))
21044 ((org-at-table-p)
21045 (push (list :table (org-table-begin) (org-table-end)) clist)
21046 (if (memq 'org-formula faces)
21047 (push (list :table-special
21048 (previous-single-property-change p 'face)
21049 (next-single-property-change p 'face)) clist)))
21050 ((org-at-table-p 'any)
21051 (push (list :table-table) clist)))
21052 (goto-char p)
21054 (let ((case-fold-search t))
21055 ;; New the "medium" contexts: clocktables, source blocks
21056 (cond ((org-in-clocktable-p)
21057 (push (list :clocktable
21059 (search-backward "#+BEGIN: clocktable" nil t))
21060 (match-beginning 0))
21062 (match-end 0))) clist))
21063 ((org-in-src-block-p)
21064 (push (list :src-block
21066 (search-backward "#+BEGIN_SRC" nil t))
21067 (match-beginning 0))
21068 (and (search-forward "#+END_SRC" nil t)
21069 (match-beginning 0))) clist))))
21070 (goto-char p)
21072 ;; Now the small context
21073 (cond
21074 ((org-at-timestamp-p)
21075 (push (org-point-in-group p 0 :timestamp) clist))
21076 ((memq 'org-link faces)
21077 (push (list :link
21078 (previous-single-property-change p 'face)
21079 (next-single-property-change p 'face)) clist))
21080 ((memq 'org-special-keyword faces)
21081 (push (list :keyword
21082 (previous-single-property-change p 'face)
21083 (next-single-property-change p 'face)) clist))
21084 ((org-at-target-p)
21085 (push (org-point-in-group p 0 :target) clist)
21086 (goto-char (1- (match-beginning 0)))
21087 (if (looking-at org-radio-target-regexp)
21088 (push (org-point-in-group p 0 :radio-target) clist))
21089 (goto-char p))
21090 ((setq o (car (delq nil
21091 (mapcar
21092 (lambda (x)
21093 (if (memq x org-latex-fragment-image-overlays) x))
21094 (overlays-at (point))))))
21095 (push (list :latex-fragment
21096 (overlay-start o) (overlay-end o)) clist)
21097 (push (list :latex-preview
21098 (overlay-start o) (overlay-end o)) clist))
21099 ((org-inside-LaTeX-fragment-p)
21100 ;; FIXME: positions wrong.
21101 (push (list :latex-fragment (point) (point)) clist)))
21103 (setq clist (nreverse (delq nil clist)))
21104 clist))
21106 ;; FIXME: Compare with at-regexp-p Do we need both?
21107 (defun org-in-regexp (re &optional nlines visually)
21108 "Check if point is inside a match of regexp.
21109 Normally only the current line is checked, but you can include NLINES extra
21110 lines both before and after point into the search.
21111 If VISUALLY is set, require that the cursor is not after the match but
21112 really on, so that the block visually is on the match."
21113 (catch 'exit
21114 (let ((pos (point))
21115 (eol (point-at-eol (+ 1 (or nlines 0))))
21116 (inc (if visually 1 0)))
21117 (save-excursion
21118 (beginning-of-line (- 1 (or nlines 0)))
21119 (while (re-search-forward re eol t)
21120 (if (and (<= (match-beginning 0) pos)
21121 (>= (+ inc (match-end 0)) pos))
21122 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21124 (defun org-at-regexp-p (regexp)
21125 "Is point inside a match of REGEXP in the current line?"
21126 (catch 'exit
21127 (save-excursion
21128 (let ((pos (point)) (end (point-at-eol)))
21129 (beginning-of-line 1)
21130 (while (re-search-forward regexp end t)
21131 (if (and (<= (match-beginning 0) pos)
21132 (>= (match-end 0) pos))
21133 (throw 'exit t)))
21134 nil))))
21136 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21137 "Non-nil when point is between matches of START-RE and END-RE.
21139 Also return a non-nil value when point is on one of the matches.
21141 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21142 buffer positions. Default values are the positions of headlines
21143 surrounding the point.
21145 The functions returns a cons cell whose car (resp. cdr) is the
21146 position before START-RE (resp. after END-RE)."
21147 (save-match-data
21148 (let ((pos (point))
21149 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21150 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21151 beg end)
21152 (save-excursion
21153 ;; Point is on a block when on START-RE or if START-RE can be
21154 ;; found before it...
21155 (and (or (org-at-regexp-p start-re)
21156 (re-search-backward start-re limit-up t))
21157 (setq beg (match-beginning 0))
21158 ;; ... and END-RE after it...
21159 (goto-char (match-end 0))
21160 (re-search-forward end-re limit-down t)
21161 (> (setq end (match-end 0)) pos)
21162 ;; ... without another START-RE in-between.
21163 (goto-char (match-beginning 0))
21164 (not (re-search-backward start-re (1+ beg) t))
21165 ;; Return value.
21166 (cons beg end))))))
21168 (defun org-in-block-p (names)
21169 "Non-nil when point belongs to a block whose name belongs to NAMES.
21171 NAMES is a list of strings containing names of blocks.
21173 Return first block name matched, or nil. Beware that in case of
21174 nested blocks, the returned name may not belong to the closest
21175 block from point."
21176 (save-match-data
21177 (catch 'exit
21178 (let ((case-fold-search t)
21179 (lim-up (save-excursion (outline-previous-heading)))
21180 (lim-down (save-excursion (outline-next-heading))))
21181 (mapc (lambda (name)
21182 (let ((n (regexp-quote name)))
21183 (when (org-between-regexps-p
21186 lim-up lim-down)
21187 (throw 'exit n))))
21188 names))
21189 nil)))
21191 (defun org-occur-in-agenda-files (regexp &optional nlines)
21192 "Call `multi-occur' with buffers for all agenda files."
21194 (let* ((files (org-agenda-files))
21195 (tnames (mapcar 'file-truename files))
21196 (extra org-agenda-text-search-extra-files)
21197 f)
21198 (when (eq (car extra) 'agenda-archives)
21199 (setq extra (cdr extra))
21200 (setq files (org-add-archive-files files)))
21201 (while (setq f (pop extra))
21202 (unless (member (file-truename f) tnames)
21203 (add-to-list 'files f 'append)
21204 (add-to-list 'tnames (file-truename f) 'append)))
21205 (multi-occur
21206 (mapcar (lambda (x)
21207 (with-current-buffer
21208 (or (get-file-buffer x) (find-file-noselect x))
21209 (widen)
21210 (current-buffer)))
21211 files)
21212 regexp)))
21214 (if (boundp 'occur-mode-find-occurrence-hook)
21215 ;; Emacs 23
21216 (add-hook 'occur-mode-find-occurrence-hook
21217 (lambda ()
21218 (when (derived-mode-p 'org-mode)
21219 (org-reveal))))
21220 ;; Emacs 22
21221 (defadvice occur-mode-goto-occurrence
21222 (after org-occur-reveal activate)
21223 (and (derived-mode-p 'org-mode) (org-reveal)))
21224 (defadvice occur-mode-goto-occurrence-other-window
21225 (after org-occur-reveal activate)
21226 (and (derived-mode-p 'org-mode) (org-reveal)))
21227 (defadvice occur-mode-display-occurrence
21228 (after org-occur-reveal activate)
21229 (when (derived-mode-p 'org-mode)
21230 (let ((pos (occur-mode-find-occurrence)))
21231 (with-current-buffer (marker-buffer pos)
21232 (save-excursion
21233 (goto-char pos)
21234 (org-reveal)))))))
21236 (defun org-occur-link-in-agenda-files ()
21237 "Create a link and search for it in the agendas.
21238 The link is not stored in `org-stored-links', it is just created
21239 for the search purpose."
21240 (interactive)
21241 (let ((link (condition-case nil
21242 (org-store-link nil)
21243 (error "Unable to create a link to here"))))
21244 (org-occur-in-agenda-files (regexp-quote link))))
21246 (defun org-reverse-string (string)
21247 "Return the reverse of STRING."
21248 (apply 'string (reverse (string-to-list string))))
21250 (defun org-uniquify (list)
21251 "Remove duplicate elements from LIST."
21252 (let (res)
21253 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
21254 res))
21256 (defun org-delete-all (elts list)
21257 "Remove all elements in ELTS from LIST."
21258 (while elts
21259 (setq list (delete (pop elts) list)))
21260 list)
21262 (defun org-count (cl-item cl-seq)
21263 "Count the number of occurrences of ITEM in SEQ.
21264 Taken from `count' in cl-seq.el with all keyword arguments removed."
21265 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21266 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21267 (while (< cl-start cl-end)
21268 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21269 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21270 (setq cl-start (1+ cl-start)))
21271 cl-count))
21273 (defun org-remove-if (predicate seq)
21274 "Remove everything from SEQ that fulfills PREDICATE."
21275 (let (res e)
21276 (while seq
21277 (setq e (pop seq))
21278 (if (not (funcall predicate e)) (push e res)))
21279 (nreverse res)))
21281 (defun org-remove-if-not (predicate seq)
21282 "Remove everything from SEQ that does not fulfill PREDICATE."
21283 (let (res e)
21284 (while seq
21285 (setq e (pop seq))
21286 (if (funcall predicate e) (push e res)))
21287 (nreverse res)))
21289 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21290 "Reduce two-argument FUNCTION across SEQ.
21291 Taken from `reduce' in cl-seq.el with all keyword arguments but
21293 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21294 (cadr (memq :initial-value cl-keys)))
21295 (cl-seq (pop cl-seq))
21296 (t (funcall cl-func)))))
21297 (while cl-seq
21298 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21299 cl-accum))
21301 (defun org-back-over-empty-lines ()
21302 "Move backwards over whitespace, to the beginning of the first empty line.
21303 Returns the number of empty lines passed."
21304 (let ((pos (point)))
21305 (if (cdr (assoc 'heading org-blank-before-new-entry))
21307 (unless (eobp)
21308 (forward-line -1)))
21309 (beginning-of-line 2)
21310 (goto-char (min (point) pos))
21311 (count-lines (point) pos)))
21313 (defun org-skip-whitespace ()
21316 (defun org-point-in-group (point group &optional context)
21317 "Check if POINT is in match-group GROUP.
21318 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21319 match. If the match group does not exist or point is not inside it,
21320 return nil."
21321 (and (match-beginning group)
21322 (>= point (match-beginning group))
21323 (<= point (match-end group))
21324 (if context
21325 (list context (match-beginning group) (match-end group))
21326 t)))
21328 (defun org-switch-to-buffer-other-window (&rest args)
21329 "Switch to buffer in a second window on the current frame.
21330 In particular, do not allow pop-up frames.
21331 Returns the newly created buffer."
21332 (org-no-popups
21333 (apply 'switch-to-buffer-other-window args)))
21335 (defun org-combine-plists (&rest plists)
21336 "Create a single property list from all plists in PLISTS.
21337 The process starts by copying the first list, and then setting properties
21338 from the other lists. Settings in the last list are the most significant
21339 ones and overrule settings in the other lists."
21340 (let ((rtn (copy-sequence (pop plists)))
21341 p v ls)
21342 (while plists
21343 (setq ls (pop plists))
21344 (while ls
21345 (setq p (pop ls) v (pop ls))
21346 (setq rtn (plist-put rtn p v))))
21347 rtn))
21349 (defun org-replace-escapes (string table)
21350 "Replace %-escapes in STRING with values in TABLE.
21352 The sequences in STRING may contain normal field width and padding information,
21354 so values can contain further %-escapes if they are define later in TABLE."
21355 (let ((tbl (copy-alist table))
21356 (case-fold-search nil)
21357 (pchg 0)
21358 e re rpl)
21359 (while (setq e (pop tbl))
21360 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21361 (when (and (cdr e) (string-match re (cdr e)))
21362 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21363 (safe "SREF"))
21364 (add-text-properties 0 3 (list 'sref sref) safe)
21365 (setcdr e (replace-match safe t t (cdr e)))))
21366 (while (string-match re string)
21367 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21368 (cdr e)))
21369 (setq string (replace-match rpl t t string))))
21370 (while (setq pchg (next-property-change pchg string))
21371 (let ((sref (get-text-property pchg 'sref string)))
21372 (when (and sref (string-match "SREF" string pchg))
21373 (setq string (replace-match sref t t string)))))
21374 string))
21376 (defun org-sublist (list start end)
21377 "Return a section of LIST, from START to END.
21378 Counting starts at 1."
21379 (let (rtn (c start))
21380 (setq list (nthcdr (1- start) list))
21381 (while (and list (<= c end))
21382 (push (pop list) rtn)
21383 (setq c (1+ c)))
21384 (nreverse rtn)))
21386 (defun org-find-base-buffer-visiting (file)
21387 "Like `find-buffer-visiting' but always return the base buffer and
21388 not an indirect buffer."
21389 (let ((buf (or (get-file-buffer file)
21390 (find-buffer-visiting file))))
21391 (if buf
21392 (or (buffer-base-buffer buf) buf)
21393 nil)))
21395 (defun org-image-file-name-regexp (&optional extensions)
21396 "Return regexp matching the file names of images.
21397 If EXTENSIONS is given, only match these."
21398 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21399 (image-file-name-regexp)
21400 (let ((image-file-name-extensions
21401 (or extensions
21402 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21403 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21405 (regexp-opt (nconc (mapcar 'upcase
21406 image-file-name-extensions)
21407 image-file-name-extensions)
21408 t)
21411 (defun org-file-image-p (file &optional extensions)
21412 "Return non-nil if FILE is an image."
21413 (save-match-data
21414 (string-match (org-image-file-name-regexp extensions) file)))
21416 (defun org-get-cursor-date (&optional with-time)
21417 "Return the date at cursor in as a time.
21418 This works in the calendar and in the agenda, anywhere else it just
21419 returns the current time.
21420 If WITH-TIME is non-nil, returns the time of the event at point (in
21421 the agenda) or the current time of the day."
21422 (let (date day defd tp tm hod mod)
21423 (when with-time
21424 (setq tp (get-text-property (point) 'time))
21426 (setq hod (string-to-number (match-string 1 tp))
21427 mod (string-to-number (match-string 2 tp))))
21428 (or tp (setq hod (nth 2 (decode-time (current-time)))
21429 mod (nth 1 (decode-time (current-time))))))
21430 (cond
21431 ((eq major-mode 'calendar-mode)
21432 (setq date (calendar-cursor-to-date)
21433 defd (encode-time 0 (or mod 0) (or hod 0)
21434 (nth 1 date) (nth 0 date) (nth 2 date))))
21435 ((eq major-mode 'org-agenda-mode)
21436 (setq day (get-text-property (point) 'day))
21437 (if day
21438 (setq date (calendar-gregorian-from-absolute day)
21439 defd (encode-time 0 (or mod 0) (or hod 0)
21440 (nth 1 date) (nth 0 date) (nth 2 date))))))
21441 (or defd (current-time))))
21443 (defun org-mark-subtree (&optional up)
21444 "Mark the current subtree.
21445 This puts point at the start of the current subtree, and mark at
21446 the end. If a numeric prefix UP is given, move up into the
21447 hierarchy of headlines by UP levels before marking the subtree."
21448 (interactive "P")
21449 (org-with-limited-levels
21450 (cond ((org-at-heading-p) (beginning-of-line))
21451 ((org-before-first-heading-p) (error "Not in a subtree"))
21452 (t (outline-previous-visible-heading 1))))
21453 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21454 (if (org-called-interactively-p 'any)
21455 (call-interactively 'org-mark-element)
21456 (org-mark-element)))
21459 ;;; Indentation
21461 (defun org-indent-line ()
21462 "Indent line depending on context."
21463 (interactive)
21464 (let* ((pos (point))
21465 (itemp (org-at-item-p))
21466 (case-fold-search t)
21468 (inline-task-p (and (featurep 'org-inlinetask)
21469 (org-inlinetask-in-task-p)))
21470 (inline-re (and inline-task-p
21471 (org-inlinetask-outline-regexp)))
21472 column)
21473 (if (and orgstruct-is-++ (eq pos (point)))
21474 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21475 (indent-according-to-mode))
21476 (beginning-of-line 1)
21477 (cond
21478 ;; Headings
21479 ((looking-at org-outline-regexp) (setq column 0))
21480 ;; Footnote definition
21481 ((looking-at org-footnote-definition-re) (setq column 0))
21482 ;; Literal examples
21484 (setq column (org-get-indentation))) ; do nothing
21485 ;; Lists
21486 ((ignore-errors (goto-char (org-in-item-p)))
21487 (setq column (if itemp
21488 (org-get-indentation)
21489 (org-list-item-body-column (point))))
21490 (goto-char pos))
21491 ;; Drawers
21493 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21494 (save-excursion
21495 (goto-char (1- (match-beginning 1)))
21496 (setq column (current-column))))
21497 ;; Special blocks
21499 (save-excursion
21500 (re-search-backward
21502 (setq column (org-get-indentation (match-string 0))))
21505 (save-excursion
21507 (setq column
21508 (cond ((equal (downcase (match-string 1)) "src")
21509 ;; src blocks: let `org-edit-src-exit' handle them
21510 (org-get-indentation))
21511 ((equal (downcase (match-string 1)) "example")
21512 (max (org-get-indentation)
21513 (org-get-indentation (match-string 0))))
21514 (t
21515 (org-get-indentation (match-string 0))))))
21516 ;; This line has nothing special, look at the previous relevant
21517 ;; line to compute indentation
21518 (t
21519 (beginning-of-line 0)
21520 (while (and (not (bobp))
21521 (not (looking-at org-table-line-regexp))
21522 (not (looking-at org-drawer-regexp))
21523 ;; When point started in an inline task, do not move
21524 ;; above task starting line.
21525 (not (and inline-task-p (looking-at inline-re)))
21526 ;; Skip drawers, blocks, empty lines, verbatim,
21527 ;; comments, tables, footnotes definitions, lists,
21528 ;; inline tasks.
21530 (re-search-backward org-drawer-regexp nil t))
21534 (looking-at org-footnote-definition-re)
21535 (and (ignore-errors (goto-char (org-in-item-p)))
21536 (goto-char
21537 (org-list-get-top-point (org-list-struct))))
21538 (and (not inline-task-p)
21539 (featurep 'org-inlinetask)
21540 (org-inlinetask-in-task-p)
21541 (or (org-inlinetask-goto-beginning) t))))
21542 (beginning-of-line 0))
21543 (cond
21544 ;; There was an heading above.
21546 (if (not org-adapt-indentation)
21547 (setq column 0)
21548 (goto-char (match-end 0))
21549 (setq column (current-column))))
21550 ;; A drawer had started and is unfinished
21551 ((looking-at org-drawer-regexp)
21552 (goto-char (1- (match-beginning 1)))
21553 (setq column (current-column)))
21554 ;; Else, nothing noticeable found: get indentation and go on.
21555 (t (setq column (org-get-indentation))))))
21556 ;; Now apply indentation and move cursor accordingly
21557 (goto-char pos)
21558 (if (<= (current-column) (current-indentation))
21559 (org-indent-line-to column)
21560 (save-excursion (org-indent-line-to column)))
21561 ;; Special polishing for properties, see `org-property-format'
21562 (setq column (current-column))
21563 (beginning-of-line 1)
21564 (if (looking-at
21566 (replace-match (concat (match-string 1)
21567 (format org-property-format
21568 (match-string 2) (match-string 3)))
21569 t t))
21570 (org-move-to-column column))))
21572 (defun org-indent-drawer ()
21573 "Indent the drawer at point."
21574 (interactive)
21575 (let ((p (point))
21576 (e (and (save-excursion (re-search-forward ":END:" nil t))
21577 (match-end 0)))
21578 (folded
21579 (save-excursion
21580 (end-of-line)
21581 (when (overlays-at (point))
21582 (member 'invisible (overlay-properties
21583 (car (overlays-at (point)))))))))
21584 (when folded (org-cycle))
21585 (indent-for-tab-command)
21586 (while (and (move-beginning-of-line 2) (< (point) e))
21587 (indent-for-tab-command))
21588 (goto-char p)
21589 (when folded (org-cycle)))
21590 (message "Drawer at point indented"))
21592 (defun org-indent-block ()
21593 "Indent the block at point."
21594 (interactive)
21595 (let ((p (point))
21596 (case-fold-search t)
21598 (match-end 0)))
21599 (folded
21600 (save-excursion
21601 (end-of-line)
21602 (when (overlays-at (point))
21603 (member 'invisible (overlay-properties
21604 (car (overlays-at (point)))))))))
21605 (when folded (org-cycle))
21606 (indent-for-tab-command)
21607 (while (and (move-beginning-of-line 2) (< (point) e))
21608 (indent-for-tab-command))
21609 (goto-char p)
21610 (when folded (org-cycle)))
21611 (message "Block at point indented"))
21613 (defun org-indent-region (start end)
21614 "Indent region."
21615 (interactive "r")
21616 (save-excursion
21617 (let ((line-end (org-current-line end)))
21618 (goto-char start)
21619 (while (< (org-current-line) line-end)
21620 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21621 (t (call-interactively 'org-indent-line)))
21622 (move-beginning-of-line 2)))))
21625 ;;; Filling
21627 ;; We use our own fill-paragraph and auto-fill functions.
21629 ;; `org-fill-paragraph' relies on adaptive filling and context
21630 ;; checking. Appropriate `fill-prefix' is computed with
21631 ;; `org-adaptive-fill-function'.
21633 ;; `org-auto-fill-function' takes care of auto-filling. It calls
21634 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
21635 ;; `org-adaptive-fill-function' value. Internally,
21636 ;; `org-comment-line-break-function' breaks the line.
21638 ;; `org-setup-filling' installs filling and auto-filling related
21639 ;; variables during `org-mode' initialization.
21641 (defun org-setup-filling ()
21642 (interactive)
21643 ;; Prevent auto-fill from inserting unwanted new items.
21644 (when (boundp 'fill-nobreak-predicate)
21645 (org-set-local
21646 'fill-nobreak-predicate
21647 (org-uniquify
21648 (append fill-nobreak-predicate
21649 '(org-fill-paragraph-separate-nobreak-p
21650 org-fill-line-break-nobreak-p
21651 org-fill-paragraph-with-timestamp-nobreak-p)))))
21652 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
21653 (org-set-local 'auto-fill-inhibit-regexp nil)
21654 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
21655 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
21656 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
21658 (defvar org-element-paragraph-separate) ; org-element.el
21659 (defun org-fill-paragraph-separate-nobreak-p ()
21660 "Non-nil when a line break at point would insert a new item."
21661 (looking-at (substring org-element-paragraph-separate 1)))
21663 (defun org-fill-line-break-nobreak-p ()
21664 "Non-nil when a line break at point would create an Org line break."
21665 (save-excursion
21670 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
21671 "Non-nil when a line break at point would insert a new item."
21672 (and (org-at-timestamp-p t)
21673 (not (looking-at org-ts-regexp-both))))
21675 (declare-function message-in-body-p "message" ())
21676 (defvar orgtbl-line-start-regexp) ; From org-table.el
21677 (defun org-adaptive-fill-function ()
21678 "Compute a fill prefix for the current line.
21679 Return fill prefix, as a string, or nil if current line isn't
21680 meant to be filled."
21681 (let (prefix)
21682 (catch 'exit
21683 (when (derived-mode-p 'message-mode)
21684 (save-excursion
21685 (beginning-of-line)
21686 (cond ((or (not (message-in-body-p))
21687 (looking-at orgtbl-line-start-regexp))
21688 (throw 'exit nil))
21689 ((looking-at message-cite-prefix-regexp)
21690 (throw 'exit (match-string-no-properties 0)))
21691 ((looking-at org-outline-regexp)
21692 (throw 'exit (make-string (length (match-string 0)) ? ))))))
21693 (org-with-wide-buffer
21694 (let* ((p (line-beginning-position))
21695 (element (save-excursion (beginning-of-line)
21696 (org-element-at-point)))
21697 (type (org-element-type element))
21698 (post-affiliated (org-element-property :post-affiliated element)))
21699 (unless (and post-affiliated (< p post-affiliated))
21700 (case type
21702 (footnote-definition "")
21703 ((item plain-list)
21704 (make-string (org-list-item-body-column
21705 (or post-affiliated
21706 (org-element-property :begin element)))
21707 ? ))
21708 (paragraph
21709 ;; Fill prefix is usually the same as the current line,
21710 ;; except if the paragraph is at the beginning of an item.
21711 (let ((parent (org-element-property :parent element)))
21712 (cond ((eq (org-element-type parent) 'item)
21713 (make-string (org-list-item-body-column
21714 (org-element-property :begin parent))
21715 ? ))
21717 (match-string 0))
21718 (t ""))))
21719 (comment-block
21720 ;; Only fill contents if P is within block boundaries.
21721 (let* ((cbeg (save-excursion (goto-char post-affiliated)
21722 (forward-line)
21723 (point)))
21724 (cend (save-excursion
21725 (goto-char (org-element-property :end element))
21727 (line-beginning-position))))
21728 (when (and (>= p cbeg) (< p cend))
21730 (match-string 0)
21731 "")))))))))))
21733 (declare-function message-goto-body "message" ())
21734 (defvar message-cite-prefix-regexp) ; From message.el
21735 (defvar org-element-all-objects) ; From org-element.el
21736 (defun org-fill-paragraph (&optional justify)
21737 "Fill element at point, when applicable.
21739 This function only applies to comment blocks, comments, example
21740 blocks and paragraphs. Also, as a special case, re-align table
21741 when point is at one.
21743 If JUSTIFY is non-nil (interactively, with prefix argument),
21744 justify as well. If `sentence-end-double-space' is non-nil, then
21745 period followed by one space does not end a sentence, so don't
21746 break a line there. The variable `fill-column' controls the
21747 width for filling.
21749 For convenience, when point is at a plain list, an item or
21750 a footnote definition, try to fill the first paragraph within."
21751 (interactive)
21752 (if (and (derived-mode-p 'message-mode)
21753 (or (not (message-in-body-p))
21754 (save-excursion (move-beginning-of-line 1)
21755 (looking-at message-cite-prefix-regexp))))
21756 ;; First ensure filling is correct in message-mode.
21757 (let ((fill-paragraph-function
21758 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21759 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21760 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21761 (paragraph-separate
21762 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21763 (fill-paragraph nil))
21764 (with-syntax-table org-mode-transpose-word-syntax-table
21765 ;; Move to end of line in order to get the first paragraph
21766 ;; within a plain list or a footnote definition.
21767 (let ((element (save-excursion (end-of-line) (org-element-at-point))))
21768 ;; First check if point is in a blank line at the beginning of
21769 ;; the buffer. In that case, ignore filling.
21770 (case (org-element-type element)
21771 ;; Use major mode filling function is src blocks.
21772 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21773 ;; Align Org tables, leave table.el tables as-is.
21774 (table-row (org-table-align) t)
21775 (table
21776 (when (eq (org-element-property :type element) 'org)
21777 (org-table-align))
21778 t)
21779 (paragraph
21780 ;; Paragraphs may contain `line-break' type objects.
21781 (let ((beg (max (point-min)
21782 (org-element-property :contents-begin element)))
21783 (end (min (point-max)
21784 (org-element-property :contents-end element))))
21785 ;; Do nothing if point is at an affiliated keyword.
21786 (if (< (line-end-position) beg) t
21787 (when (derived-mode-p 'message-mode)
21788 ;; In `message-mode', do not fill following citation
21789 ;; in current paragraph nor text before message body.
21790 (let ((body-start (save-excursion (message-goto-body))))
21791 (when body-start (setq beg (max body-start beg))))
21792 (when (save-excursion
21793 (re-search-forward
21794 (concat "^" message-cite-prefix-regexp) end t))
21795 (setq end (match-beginning 0))))
21796 ;; Fill paragraph, taking line breaks into account.
21797 ;; For that, slice the paragraph using line breaks as
21798 ;; separators, and fill the parts in reverse order to
21799 ;; avoid messing with markers.
21800 (save-excursion
21801 (goto-char end)
21802 (mapc
21803 (lambda (pos)
21804 (fill-region-as-paragraph pos (point) justify)
21805 (goto-char pos))
21806 ;; Find the list of ending positions for line breaks
21807 ;; in the current paragraph. Add paragraph
21808 ;; beginning to include first slice.
21809 (nreverse
21810 (cons beg
21811 (org-element-map
21812 (org-element--parse-objects
21813 beg end nil org-element-all-objects)
21814 'line-break
21815 (lambda (lb) (org-element-property :end lb)))))))
21816 t)))
21817 ;; Contents of `comment-block' type elements should be
21818 ;; filled as plain text, but only if point is within block
21819 ;; markers.
21820 (comment-block
21821 (let* ((case-fold-search t)
21822 (beg (save-excursion
21823 (goto-char (org-element-property :begin element))
21825 (forward-line)
21826 (point)))
21827 (end (save-excursion
21828 (goto-char (org-element-property :end element))
21830 (line-beginning-position))))
21831 (when (and (>= (point) beg) (< (point) end))
21832 (fill-region-as-paragraph
21833 (save-excursion
21834 (end-of-line)
21836 (line-beginning-position))
21837 (save-excursion
21838 (beginning-of-line)
21840 (line-beginning-position))
21841 justify)))
21842 t)
21843 ;; Fill comments.
21844 (comment (fill-comment-paragraph justify))
21845 ;; Ignore every other element.
21846 (otherwise t))))))
21848 (defun org-auto-fill-function ()
21849 "Auto-fill function."
21850 ;; Check if auto-filling is meaningful.
21851 (let ((fc (current-fill-column)))
21852 (when (and fc (> (current-column) fc))
21853 (let* ((fill-prefix (org-adaptive-fill-function))
21854 ;; Enforce empty fill prefix, if required. Otherwise, it
21855 ;; will be computed again.
21856 (adaptive-fill-mode (not (equal fill-prefix ""))))
21857 (when fill-prefix (do-auto-fill))))))
21859 (defun org-comment-line-break-function (&optional soft)
21860 "Break line at point and indent, continuing comment if within one.
21861 The inserted newline is marked hard if variable
21862 `use-hard-newlines' is true, unless optional argument SOFT is
21863 non-nil."
21865 (save-excursion (forward-char -1) (delete-horizontal-space))
21866 (delete-horizontal-space)
21867 (indent-to-left-margin)
21868 (insert-before-markers-and-inherit fill-prefix))
21871 ;;; Comments
21873 ;; Org comments syntax is quite complex. It requires the entire line
21874 ;; to be just a comment. Also, even with the right syntax at the
21875 ;; beginning of line, some some elements (i.e. verse-block or
21876 ;; example-block) don't accept comments. Usual Emacs comment commands
21877 ;; cannot cope with those requirements. Therefore, Org replaces them.
21879 ;; Org still relies on `comment-dwim', but cannot trust
21880 ;; `comment-only-p'. So, `comment-region-function' and
21881 ;; `uncomment-region-function' both point
21882 ;; to`org-comment-or-uncomment-region'. Eventually,
21883 ;; `org-insert-comment' takes care of insertion of comments at the
21884 ;; beginning of line.
21886 ;; `org-setup-comments-handling' install comments related variables
21887 ;; during `org-mode' initialization.
21889 (defun org-setup-comments-handling ()
21890 (interactive)
21891 (org-set-local 'comment-use-syntax nil)
21892 (org-set-local 'comment-start "# ")
21894 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21895 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21896 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21898 (defun org-insert-comment ()
21899 "Insert an empty comment above current line.
21900 If the line is empty, insert comment at its beginning."
21901 (beginning-of-line)
21903 (org-indent-line)
21904 (insert "# "))
21906 (defvar comment-empty-lines) ; From newcomment.el.
21907 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21908 "Comment or uncomment each non-blank line in the region.
21909 Uncomment each non-blank line between BEG and END if it only
21910 contains commented lines. Otherwise, comment them."
21911 (save-restriction
21912 ;; Restrict region
21913 (narrow-to-region (save-excursion (goto-char beg)
21915 (line-beginning-position))
21916 (save-excursion (goto-char end)
21918 (line-end-position)))
21919 (let ((uncommentp
21920 ;; UNCOMMENTP is non-nil when every non blank line between
21921 ;; BEG and END is a comment.
21922 (save-excursion
21923 (goto-char (point-min))
21924 (while (and (not (eobp))
21925 (let ((element (org-element-at-point)))
21926 (and (eq (org-element-type element) 'comment)
21927 (goto-char (min (point-max)
21928 (org-element-property
21929 :end element)))))))
21930 (eobp))))
21931 (if uncommentp
21932 ;; Only blank lines and comments in region: uncomment it.
21933 (save-excursion
21934 (goto-char (point-min))
21935 (while (not (eobp))
21937 (replace-match "" nil nil nil 1))
21938 (forward-line)))
21939 ;; Comment each line in region.
21940 (let ((min-indent (point-max)))
21941 ;; First find the minimum indentation across all lines.
21942 (save-excursion
21943 (goto-char (point-min))
21944 (while (and (not (eobp)) (not (zerop min-indent)))
21946 (setq min-indent (min min-indent (current-indentation))))
21947 (forward-line)))
21948 ;; Then loop over all lines.
21949 (save-excursion
21950 (goto-char (point-min))
21951 (while (not (eobp))
21953 (org-move-to-column min-indent t)
21954 (insert comment-start))
21955 (forward-line))))))))
21958 ;;; Planning
21960 ;; This section contains tools to operate on timestamp objects, as
21961 ;; returned by, e.g. `org-element-context'.
21963 (defun org-timestamp-has-time-p (timestamp)
21964 "Non-nil when TIMESTAMP has a time specified."
21965 (org-element-property :hour-start timestamp))
21967 (defun org-timestamp-format (timestamp format &optional end utc)
21968 "Format a TIMESTAMP element into a string.
21970 FORMAT is a format specifier to be passed to
21971 `format-time-string'.
21973 When optional argument END is non-nil, use end of date-range or
21974 time-range, if possible.
21976 When optional argument UTC is non-nil, time will be expressed as
21977 Universal Time."
21978 (format-time-string
21979 format
21980 (apply 'encode-time
21981 (cons 0
21982 (mapcar
21983 (lambda (prop) (or (org-element-property prop timestamp) 0))
21984 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
21985 '(:minute-start :hour-start :day-start :month-start
21986 :year-start)))))
21987 utc))
21989 (defun org-timestamp-split-range (timestamp &optional end)
21990 "Extract a timestamp object from a date or time range.
21992 TIMESTAMP is a timestamp object. END, when non-nil, means extract
21993 the end of the range. Otherwise, extract its start.
21995 Return a new timestamp object sharing the same parent as
21996 TIMESTAMP."
21997 (let ((type (org-element-property :type timestamp)))
21998 (if (memq type '(active inactive diary)) timestamp
21999 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22000 ;; Set new type.
22001 (org-element-put-property
22002 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22003 ;; Copy start properties over end properties if END is
22004 ;; non-nil. Otherwise, copy end properties over `start' ones.
22005 (let ((p-alist '((:minute-start . :minute-end)
22006 (:hour-start . :hour-end)
22007 (:day-start . :day-end)
22008 (:month-start . :month-end)
22009 (:year-start . :year-end))))
22010 (dolist (p-cell p-alist)
22011 (org-element-put-property
22012 split-ts
22013 (funcall (if end 'car 'cdr) p-cell)
22014 (org-element-property
22015 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22016 ;; Eventually refresh `:raw-value'.
22017 (org-element-put-property split-ts :raw-value nil)
22018 (org-element-put-property
22019 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22021 (defun org-timestamp-translate (timestamp &optional boundary)
22022 "Apply `org-translate-time' on a TIMESTAMP object.
22023 When optional argument BOUNDARY is non-nil, it is either the
22024 symbol `start' or `end'. In this case, only translate the
22025 starting or ending part of TIMESTAMP if it is a date or time
22026 range. Otherwise, translate both parts."
22027 (if (and (not boundary)
22028 (memq (org-element-property :type timestamp)
22029 '(active-range inactive-range)))
22030 (concat
22031 (org-translate-time
22032 (org-element-property :raw-value
22033 (org-timestamp-split-range timestamp)))
22034 "--"
22035 (org-translate-time
22036 (org-element-property :raw-value
22037 (org-timestamp-split-range timestamp t))))
22038 (org-translate-time
22039 (org-element-property
22040 :raw-value
22041 (if (not boundary) timestamp
22042 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22046 ;;; Other stuff.
22048 (defun org-toggle-fixed-width-section (arg)
22049 "Toggle the fixed-width export.
22050 If there is no active region, the QUOTE keyword at the current headline is
22051 inserted or removed. When present, it causes the text between this headline
22052 and the next to be exported as fixed-width text, and unmodified.
22053 If there is an active region, this command adds or removes a colon as the
22054 first character of this line. If the first character of a line is a colon,
22055 this line is also exported in fixed-width font."
22056 (interactive "P")
22057 (let* ((cc 0)
22058 (regionp (org-region-active-p))
22059 (beg (if regionp (region-beginning) (point)))
22060 (end (if regionp (region-end)))
22061 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22062 (case-fold-search nil)
22064 off)
22065 (if regionp
22066 (save-excursion
22067 (goto-char beg)
22068 (setq cc (current-column))
22069 (beginning-of-line 1)
22070 (setq off (looking-at re))
22071 (while (> nlines 0)
22072 (setq nlines (1- nlines))
22073 (beginning-of-line 1)
22074 (cond
22075 (arg
22076 (org-move-to-column cc t)
22078 (forward-line -1))
22079 ((and off (looking-at re))
22080 (replace-match "" t t nil 1))
22081 ((not off) (org-move-to-column cc t) (insert ": ")))
22082 (forward-line 1)))
22083 (save-excursion
22084 (org-back-to-heading)
22085 (cond
22086 ((looking-at (format org-heading-keyword-regexp-format
22087 org-quote-string))
22088 (goto-char (match-end 1))
22089 (looking-at (concat " +" org-quote-string))
22090 (replace-match "" t t)
22091 (when (eolp) (insert " ")))
22092 ((looking-at org-outline-regexp)
22093 (goto-char (match-end 0))
22094 (insert org-quote-string " ")))))))
22096 (defun org-reftex-citation ()
22097 "Use reftex-citation to insert a citation into the buffer.
22098 This looks for a line like
22100 #+BIBLIOGRAPHY: foo plain option:-d
22102 and derives from it that foo.bib is the bibliography file relevant
22103 for this document. It then installs the necessary environment for RefTeX
22104 to work in this buffer and calls `reftex-citation' to insert a citation
22105 into the buffer.
22107 Export of such citations to both LaTeX and HTML is handled by the contributed
22108 package org-exp-bibtex by Taru Karttunen."
22109 (interactive)
22110 (let ((reftex-docstruct-symbol 'rds)
22112 rds bib)
22113 (save-excursion
22114 (save-restriction
22115 (widen)
22116 (let ((case-fold-search t)
22118 (if (not (save-excursion
22119 (or (re-search-forward re nil t)
22120 (re-search-backward re nil t))))
22121 (error "No bibliography defined in file")
22122 (setq bib (concat (match-string 1) ".bib")
22123 rds (list (list 'bib bib)))))))
22124 (call-interactively 'reftex-citation)))
22126 ;;;; Functions extending outline functionality
22128 (defun org-beginning-of-line (&optional arg)
22129 "Go to the beginning of the current line. If that is invisible, continue
22130 to a visible line beginning. This makes the function of C-a more intuitive.
22131 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22132 first attempt, and only move to after the tags when the cursor is already
22133 beyond the end of the headline."
22134 (interactive "P")
22135 (let ((pos (point))
22136 (special (if (consp org-special-ctrl-a/e)
22137 (car org-special-ctrl-a/e)
22138 org-special-ctrl-a/e))
22139 refpos)
22140 (if (org-bound-and-true-p visual-line-mode)
22141 (beginning-of-visual-line 1)
22142 (beginning-of-line 1))
22143 (if (and arg (fboundp 'move-beginning-of-line))
22144 (call-interactively 'move-beginning-of-line)
22145 (if (bobp)
22146 nil
22147 (backward-char 1)
22148 (if (org-truely-invisible-p)
22149 (while (and (not (bobp)) (org-truely-invisible-p))
22150 (backward-char 1)
22151 (beginning-of-line 1))
22152 (forward-char 1))))
22153 (when special
22154 (cond
22155 ((and (looking-at org-complex-heading-regexp)
22156 (= (char-after (match-end 1)) ?\ ))
22157 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22158 (point-at-eol)))
22159 (goto-char
22160 (if (eq special t)
22161 (cond ((> pos refpos) refpos)
22162 ((= pos (point)) refpos)
22163 (t (point)))
22164 (cond ((> pos (point)) (point))
22165 ((not (eq last-command this-command)) (point))
22166 (t refpos)))))
22167 ((org-at-item-p)
22168 ;; Being at an item and not looking at an the item means point
22169 ;; was previously moved to beginning of a visual line, which
22170 ;; doesn't contain the item. Therefore, do nothing special,
22171 ;; just stay here.
22172 (when (looking-at org-list-full-item-re)
22173 ;; Set special position at first white space character after
22174 ;; bullet, and check-box, if any.
22175 (let ((after-bullet
22176 (let ((box (match-end 3)))
22177 (if (not box) (match-end 1)
22178 (let ((after (char-after box)))
22179 (if (and after (= after ? )) (1+ box) box))))))
22180 ;; Special case: Move point to special position when
22181 ;; currently after it or at beginning of line.
22182 (if (eq special t)
22183 (when (or (> pos after-bullet) (= (point) pos))
22184 (goto-char after-bullet))
22185 ;; Reversed case: Move point to special position when
22186 ;; point was already at beginning of line and command is
22187 ;; repeated.
22188 (when (and (= (point) pos) (eq last-command this-command))
22189 (goto-char after-bullet))))))))
22190 (org-no-warnings
22191 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22193 (defun org-end-of-line (&optional arg)
22194 "Go to the end of the line.
22195 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22196 tags on the first attempt, and only move to after the tags when
22197 the cursor is already beyond the end of the headline."
22198 (interactive "P")
22199 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22200 org-special-ctrl-a/e))
22201 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22202 'end-of-visual-line)
22203 ((fboundp 'move-end-of-line) 'move-end-of-line)
22204 (t 'end-of-line))))
22205 (if (or (not special) arg) (call-interactively move-fun)
22206 (let* ((element (save-excursion (beginning-of-line)
22207 (org-element-at-point)))
22208 (type (org-element-type element)))
22209 (cond
22210 ((memq type '(headline inlinetask))
22211 (let ((pos (point)))
22212 (beginning-of-line 1)
22214 (if (eq special t)
22215 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22216 (goto-char (match-beginning 1))
22217 (goto-char (match-end 0)))
22218 (if (or (< pos (match-end 0))
22219 (not (eq this-command last-command)))
22220 (goto-char (match-end 0))
22221 (goto-char (match-beginning 1))))
22222 (call-interactively move-fun))))
22223 ((org-element-property :hiddenp element)
22224 ;; If element is hidden, `move-end-of-line' would put point
22225 ;; after it. Use `end-of-line' to stay on current line.
22226 (call-interactively 'end-of-line))
22227 (t (call-interactively move-fun)))))
22228 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22230 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22231 (define-key org-mode-map "\C-e" 'org-end-of-line)
22233 (defun org-backward-sentence (&optional arg)
22234 "Go to beginning of sentence, or beginning of table field.
22235 This will call `backward-sentence' or `org-table-beginning-of-field',
22236 depending on context."
22237 (interactive "P")
22238 (cond
22239 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22240 (t (call-interactively 'backward-sentence))))
22242 (defun org-forward-sentence (&optional arg)
22243 "Go to end of sentence, or end of table field.
22244 This will call `forward-sentence' or `org-table-end-of-field',
22245 depending on context."
22246 (interactive "P")
22247 (cond
22248 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22249 (t (call-interactively 'forward-sentence))))
22251 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22252 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22254 (defun org-kill-line (&optional arg)
22255 "Kill line, to tags or end of line."
22256 (interactive "P")
22257 (cond
22258 ((or (not org-special-ctrl-k)
22259 (bolp)
22260 (not (org-at-heading-p)))
22261 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22262 org-ctrl-k-protect-subtree)
22263 (if (or (eq org-ctrl-k-protect-subtree 'error)
22264 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22265 (error "C-k aborted - would kill hidden subtree")))
22266 (call-interactively
22267 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22269 (kill-region (point) (match-beginning 1))
22270 (org-set-tags nil t))
22271 (t (kill-region (point) (point-at-eol)))))
22273 (define-key org-mode-map "\C-k" 'org-kill-line)
22275 (defun org-yank (&optional arg)
22276 "Yank. If the kill is a subtree, treat it specially.
22277 This command will look at the current kill and check if is a single
22278 subtree, or a series of subtrees[1]. If it passes the test, and if the
22279 cursor is at the beginning of a line or after the stars of a currently
22280 empty headline, then the yank is handled specially. How exactly depends
22281 on the value of the following variables, both set by default.
22283 org-yank-folded-subtrees
22284 When set, the subtree(s) will be folded after insertion, but only
22285 if doing so would now swallow text after the yanked text.
22287 org-yank-adjusted-subtrees
22288 When set, the subtree will be promoted or demoted in order to
22289 fit into the local outline tree structure, which means that the level
22290 will be adjusted so that it becomes the smaller one of the two
22291 *visible* surrounding headings.
22293 Any prefix to this command will cause `yank' to be called directly with
22295 will just
22296 plainly yank the text as it is.
22298 \[1] The test checks if the first non-white line is a heading
22299 and if there are no other headings with fewer stars."
22300 (interactive "P")
22301 (org-yank-generic 'yank arg))
22303 (defun org-yank-generic (command arg)
22304 "Perform some yank-like command.
22306 This function implements the behavior described in the `org-yank'
22307 documentation. However, it has been generalized to work for any
22308 interactive command with similar behavior."
22310 ;; pretend to be command COMMAND
22311 (setq this-command command)
22313 (if arg
22314 (call-interactively command)
22316 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22317 (and (org-kill-is-subtree-p)
22318 (or (bolp)
22320 (string-match
22322 (buffer-substring (point-at-bol) (point)))))))
22323 swallowp)
22324 (cond
22325 ((and subtreep org-yank-folded-subtrees)
22326 (let ((beg (point))
22327 end)
22328 (if (and subtreep org-yank-adjusted-subtrees)
22329 (org-paste-subtree nil nil 'for-yank)
22330 (call-interactively command))
22332 (setq end (point))
22333 (goto-char beg)
22334 (when (and (bolp) subtreep
22335 (not (setq swallowp
22336 (org-yank-folding-would-swallow-text beg end))))
22337 (org-with-limited-levels
22338 (or (looking-at org-outline-regexp)
22339 (re-search-forward org-outline-regexp-bol end t))
22340 (while (and (< (point) end) (looking-at org-outline-regexp))
22341 (hide-subtree)
22342 (org-cycle-show-empty-lines 'folded)
22343 (condition-case nil
22344 (outline-forward-same-level 1)
22345 (error (goto-char end))))))
22346 (when swallowp
22347 (message
22348 "Inserted text not folded because that would swallow text"))
22350 (goto-char end)
22352 (beginning-of-line 1)
22353 (push-mark beg 'nomsg)))
22354 ((and subtreep org-yank-adjusted-subtrees)
22355 (let ((beg (point-at-bol)))
22356 (org-paste-subtree nil nil 'for-yank)
22357 (push-mark beg 'nomsg)))
22358 (t
22359 (call-interactively command))))))
22361 (defun org-yank-folding-would-swallow-text (beg end)
22362 "Would hide-subtree at BEG swallow any text after END?"
22363 (let (level)
22364 (org-with-limited-levels
22365 (save-excursion
22366 (goto-char beg)
22367 (when (or (looking-at org-outline-regexp)
22368 (re-search-forward org-outline-regexp-bol end t))
22369 (setq level (org-outline-level)))
22370 (goto-char end)
22372 (if (or (eobp)
22373 (and (bolp) (looking-at org-outline-regexp)
22374 (<= (org-outline-level) level)))
22375 nil ; Nothing would be swallowed
22376 t))))) ; something would swallow
22378 (define-key org-mode-map "\C-y" 'org-yank)
22380 (defun org-truely-invisible-p ()
22381 "Check if point is at a character currently not visible.
22382 This version does not only check the character property, but also
22383 `visible-mode'."
22384 ;; Early versions of noutline don't have `outline-invisible-p'.
22385 (if (org-bound-and-true-p visible-mode)
22386 nil
22387 (outline-invisible-p)))
22389 (defun org-invisible-p2 ()
22390 "Check if point is at a character currently not visible."
22391 (save-excursion
22392 (if (and (eolp) (not (bobp))) (backward-char 1))
22393 ;; Early versions of noutline don't have `outline-invisible-p'.
22394 (outline-invisible-p)))
22396 (defun org-back-to-heading (&optional invisible-ok)
22397 "Call `outline-back-to-heading', but provide a better error message."
22398 (condition-case nil
22399 (outline-back-to-heading invisible-ok)
22400 (error (error "Before first headline at position %d in buffer %s"
22401 (point) (current-buffer)))))
22403 (defun org-before-first-heading-p ()
22404 "Before first heading?"
22405 (save-excursion
22406 (end-of-line)
22407 (null (re-search-backward org-outline-regexp-bol nil t))))
22409 (defun org-at-heading-p (&optional ignored)
22410 (outline-on-heading-p t))
22411 ;; Compatibility alias with Org versions < 7.8.03
22412 (defalias 'org-on-heading-p 'org-at-heading-p)
22414 (defun org-at-comment-p nil
22415 "Is cursor in a line starting with a # character?"
22416 (save-excursion
22417 (beginning-of-line)
22418 (looking-at "^#")))
22420 (defun org-at-drawer-p nil
22421 "Is cursor at a drawer keyword?"
22422 (save-excursion
22423 (move-beginning-of-line 1)
22424 (looking-at org-drawer-regexp)))
22426 (defun org-at-block-p nil
22427 "Is cursor at a block keyword?"
22428 (save-excursion
22429 (move-beginning-of-line 1)
22430 (looking-at org-block-regexp)))
22432 (defun org-point-at-end-of-empty-headline ()
22433 "If point is at the end of an empty headline, return t, else nil.
22434 If the heading only contains a TODO keyword, it is still still considered
22435 empty."
22437 (when org-todo-line-regexp
22438 (save-excursion
22439 (beginning-of-line 1)
22440 (let ((case-fold-search nil))
22441 (looking-at org-todo-line-regexp)
22442 (string= (match-string 3) ""))))))
22444 (defun org-at-heading-or-item-p ()
22445 (or (org-at-heading-p) (org-at-item-p)))
22447 (defun org-at-target-p ()
22448 (or (org-in-regexp org-radio-target-regexp)
22449 (org-in-regexp org-target-regexp)))
22450 ;; Compatibility alias with Org versions < 7.8.03
22451 (defalias 'org-on-target-p 'org-at-target-p)
22453 (defun org-up-heading-all (arg)
22454 "Move to the heading line of which the present line is a subheading.
22455 This function considers both visible and invisible heading lines.
22456 With argument, move up ARG levels."
22457 (if (fboundp 'outline-up-heading-all)
22458 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22459 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22461 (defun org-up-heading-safe ()
22462 "Move to the heading line of which the present line is a subheading.
22463 This version will not throw an error. It will return the level of the
22464 headline found, or nil if no higher level is found.
22466 Also, this function will be a lot faster than `outline-up-heading',
22467 because it relies on stars being the outline starters. This can really
22468 make a significant difference in outlines with very many siblings."
22469 (let (start-level re)
22470 (org-back-to-heading t)
22471 (setq start-level (funcall outline-level))
22472 (if (equal start-level 1)
22473 nil
22475 (if (re-search-backward re nil t)
22476 (funcall outline-level)))))
22478 (defun org-first-sibling-p ()
22479 "Is this heading the first child of its parents?"
22480 (interactive)
22481 (let ((re org-outline-regexp-bol)
22482 level l)
22483 (unless (org-at-heading-p t)
22484 (error "Not at a heading"))
22485 (setq level (funcall outline-level))
22486 (save-excursion
22487 (if (not (re-search-backward re nil t))
22488 t
22489 (setq l (funcall outline-level))
22490 (< l level)))))
22492 (defun org-goto-sibling (&optional previous)
22493 "Goto the next sibling, even if it is invisible.
22494 When PREVIOUS is set, go to the previous sibling instead. Returns t
22495 when a sibling was found. When none is found, return nil and don't
22496 move point."
22497 (let ((fun (if previous 're-search-backward 're-search-forward))
22498 (pos (point))
22499 (re org-outline-regexp-bol)
22500 level l)
22501 (when (condition-case nil (org-back-to-heading t) (error nil))
22502 (setq level (funcall outline-level))
22503 (catch 'exit
22504 (or previous (forward-char 1))
22505 (while (funcall fun re nil t)
22506 (setq l (funcall outline-level))
22507 (when (< l level) (goto-char pos) (throw 'exit nil))
22508 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22509 (goto-char pos)
22510 nil))))
22512 (defun org-show-siblings ()
22513 "Show all siblings of the current headline."
22514 (save-excursion
22515 (while (org-goto-sibling) (org-flag-heading nil)))
22516 (save-excursion
22517 (while (org-goto-sibling 'previous)
22518 (org-flag-heading nil))))
22520 (defun org-goto-first-child ()
22521 "Goto the first child, even if it is invisible.
22522 Return t when a child was found. Otherwise don't move point and
22523 return nil."
22524 (let (level (pos (point)) (re org-outline-regexp-bol))
22525 (when (condition-case nil (org-back-to-heading t) (error nil))
22526 (setq level (outline-level))
22527 (forward-char 1)
22528 (if (and (re-search-forward re nil t) (> (outline-level) level))
22529 (progn (goto-char (match-beginning 0)) t)
22530 (goto-char pos) nil))))
22532 (defun org-show-hidden-entry ()
22533 "Show an entry where even the heading is hidden."
22534 (save-excursion
22535 (org-show-entry)))
22537 (defun org-flag-heading (flag &optional entry)
22538 "Flag the current heading. FLAG non-nil means make invisible.
22539 When ENTRY is non-nil, show the entire entry."
22540 (save-excursion
22541 (org-back-to-heading t)
22542 ;; Check if we should show the entire entry
22543 (if entry
22544 (progn
22545 (org-show-entry)
22546 (save-excursion
22547 (and (outline-next-heading)
22548 (org-flag-heading nil))))
22549 (outline-flag-region (max (point-min) (1- (point)))
22550 (save-excursion (outline-end-of-heading) (point))
22551 flag))))
22553 (defun org-get-next-sibling ()
22554 "Move to next heading of the same level, and return point.
22555 If there is no such heading, return nil.
22556 This is like outline-next-sibling, but invisible headings are ok."
22557 (let ((level (funcall outline-level)))
22558 (outline-next-heading)
22559 (while (and (not (eobp)) (> (funcall outline-level) level))
22560 (outline-next-heading))
22561 (if (or (eobp) (< (funcall outline-level) level))
22562 nil
22563 (point))))
22565 (defun org-get-last-sibling ()
22566 "Move to previous heading of the same level, and return point.
22567 If there is no such heading, return nil."
22568 (let ((opoint (point))
22569 (level (funcall outline-level)))
22570 (outline-previous-heading)
22571 (when (and (/= (point) opoint) (outline-on-heading-p t))
22572 (while (and (> (funcall outline-level) level)
22573 (not (bobp)))
22574 (outline-previous-heading))
22575 (if (< (funcall outline-level) level)
22576 nil
22577 (point)))))
22579 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22580 "Goto to the end of a subtree."
22581 ;; This contains an exact copy of the original function, but it uses
22582 ;; `org-back-to-heading', to make it work also in invisible
22583 ;; trees. And is uses an invisible-ok argument.
22584 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22585 ;; Furthermore, when used inside Org, finding the end of a large subtree
22586 ;; with many children and grandchildren etc, this can be much faster
22587 ;; than the outline version.
22588 (org-back-to-heading invisible-ok)
22589 (let ((first t)
22590 (level (funcall outline-level)))
22591 (if (and (derived-mode-p 'org-mode) (< level 1000))
22592 ;; A true heading (not a plain list item), in Org-mode
22593 ;; This means we can easily find the end by looking
22594 ;; only for the right number of stars. Using a regexp to do
22595 ;; this is so much faster than using a Lisp loop.
22597 (forward-char 1)
22598 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22599 ;; something else, do it the slow way
22600 (while (and (not (eobp))
22601 (or first (> (funcall outline-level) level)))
22602 (setq first nil)
22603 (outline-next-heading)))
22604 (unless to-heading
22606 (progn
22607 ;; Go to end of line before heading
22608 (forward-char -1)
22610 ;; leave blank line before heading
22611 (forward-char -1))))))
22612 (point))
22614 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22615 "Use Org version in org-mode, for dramatic speed-up."
22616 (if (derived-mode-p 'org-mode)
22617 (progn
22618 (org-end-of-subtree nil t)
22619 (unless (eobp) (backward-char 1)))
22620 ad-do-it))
22622 (defun org-end-of-meta-data-and-drawers ()
22623 "Jump to the first text after meta data and drawers in the current entry.
22624 This will move over empty lines, lines with planning time stamps,
22625 clocking lines, and drawers."
22626 (org-back-to-heading t)
22627 (let ((end (save-excursion (outline-next-heading) (point)))
22630 (forward-line 1)
22631 (while (re-search-forward re end t)
22632 (if (not (match-end 1))
22633 ;; empty or planning line
22634 (forward-line 1)
22635 ;; a drawer, find the end
22637 (forward-line 1)))
22639 (point)))
22641 (defun org-forward-heading-same-level (arg &optional invisible-ok)
22642 "Move forward to the ARG'th subheading at same level as this one.
22643 Stop at the first and last subheadings of a superior heading.
22644 Normally this only looks at visible headings, but when INVISIBLE-OK is
22645 non-nil it will also look at invisible ones."
22646 (interactive "p")
22647 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
22648 (if (and arg (< arg 0))
22649 (goto-char (point-min))
22650 (outline-next-heading))
22651 (org-at-heading-p)
22652 (let ((level (- (match-end 0) (match-beginning 0) 1))
22653 (f (if (and arg (< arg 0))
22654 're-search-backward
22655 're-search-forward))
22656 (count (if arg (abs arg) 1))
22657 (result (point)))
22658 (forward-char (if (and arg (< arg 0)) -1 1))
22659 (while (and (> count 0)
22660 (funcall f org-outline-regexp-bol nil 'move))
22661 (let ((l (- (match-end 0) (match-beginning 0) 1)))
22662 (cond ((< l level) (setq count 0))
22663 ((and (= l level)
22664 (or invisible-ok
22665 (progn
22666 (goto-char (line-beginning-position))
22667 (not (outline-invisible-p)))))
22668 (setq count (1- count))
22669 (when (eq l level)
22670 (setq result (point)))))))
22671 (goto-char result))
22672 (beginning-of-line 1)))
22674 (defun org-backward-heading-same-level (arg &optional invisible-ok)
22675 "Move backward to the ARG'th subheading at same level as this one.
22676 Stop at the first and last subheadings of a superior heading."
22677 (interactive "p")
22678 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
22680 (defun org-next-block (arg &optional backward block-regexp)
22681 "Jump to the next block.
22682 With a prefix argument ARG, jump forward ARG many source blocks.
22683 When BACKWARD is non-nil, jump to the previous block.
22684 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
22685 (interactive "p")
22686 (let ((re (or block-regexp org-block-regexp))
22687 (re-search-fn (or (and backward 're-search-backward)
22688 're-search-forward)))
22689 (if (looking-at re) (forward-char 1))
22690 (condition-case nil
22691 (funcall re-search-fn re nil nil arg)
22692 (error (error "No %s code blocks" (if backward "previous" "further" ))))
22693 (goto-char (match-beginning 0)) (org-show-context)))
22695 (defun org-previous-block (arg &optional block-regexp)
22696 "Jump to the previous block.
22697 With a prefix argument ARG, jump backward ARG many source blocks.
22698 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
22699 (interactive "p")
22700 (org-next-block arg t block-regexp))
22702 (defun org-forward-element ()
22703 "Move forward by one element.
22704 Move to the next element at the same level, when possible."
22705 (interactive)
22706 (cond ((eobp) (user-error "Cannot move further down"))
22707 ((org-with-limited-levels (org-at-heading-p))
22708 (let ((origin (point)))
22709 (goto-char (org-end-of-subtree nil t))
22710 (unless (org-with-limited-levels (org-at-heading-p))
22711 (goto-char origin)
22712 (user-error "Cannot move further down"))))
22713 (t
22714 (let* ((elem (org-element-at-point))
22715 (end (org-element-property :end elem))
22716 (parent (org-element-property :parent elem)))
22717 (if (and parent (= (org-element-property :contents-end parent) end))
22718 (goto-char (org-element-property :end parent))
22719 (goto-char end))))))
22721 (defun org-backward-element ()
22722 "Move backward by one element.
22723 Move to the previous element at the same level, when possible."
22724 (interactive)
22725 (cond ((bobp) (user-error "Cannot move further up"))
22726 ((org-with-limited-levels (org-at-heading-p))
22727 ;; At a headline, move to the previous one, if any, or stay
22728 ;; here.
22729 (let ((origin (point)))
22730 (org-with-limited-levels (org-backward-heading-same-level 1))
22731 ;; When current headline has no sibling above, move to its
22732 ;; parent.
22733 (when (= (point) origin)
22734 (or (org-with-limited-levels (org-up-heading-safe))
22735 (progn (goto-char origin)
22736 (user-error "Cannot move further up"))))))
22737 (t
22738 (let* ((trail (org-element-at-point 'keep-trail))
22739 (elem (car trail))
22740 (prev-elem (nth 1 trail))
22741 (beg (org-element-property :begin elem)))
22742 (cond
22743 ;; Move to beginning of current element if point isn't
22744 ;; there already.
22745 ((/= (point) beg) (goto-char beg))
22746 (prev-elem (goto-char (org-element-property :begin prev-elem)))
22747 ((org-before-first-heading-p) (goto-char (point-min)))
22748 (t (org-back-to-heading)))))))
22750 (defun org-up-element ()
22751 "Move to upper element."
22752 (interactive)
22753 (if (org-with-limited-levels (org-at-heading-p))
22754 (unless (org-up-heading-safe) (error "No surrounding element"))
22755 (let* ((elem (org-element-at-point))
22756 (parent (org-element-property :parent elem)))
22757 (if parent (goto-char (org-element-property :begin parent))
22758 (if (org-with-limited-levels (org-before-first-heading-p))
22759 (error "No surrounding element")
22760 (org-with-limited-levels (org-back-to-heading)))))))
22762 (defvar org-element-greater-elements)
22763 (defun org-down-element ()
22764 "Move to inner element."
22765 (interactive)
22766 (let ((element (org-element-at-point)))
22767 (cond
22768 ((memq (org-element-type element) '(plain-list table))
22769 (goto-char (org-element-property :contents-begin element))
22770 (forward-char))
22771 ((memq (org-element-type element) org-element-greater-elements)
22772 ;; If contents are hidden, first disclose them.
22773 (when (org-element-property :hiddenp element) (org-cycle))
22774 (goto-char (or (org-element-property :contents-begin element)
22775 (error "No content for this element"))))
22776 (t (error "No inner element")))))
22778 (defun org-drag-element-backward ()
22779 "Move backward element at point."
22780 (interactive)
22781 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
22782 (let* ((trail (org-element-at-point 'keep-trail))
22783 (elem (car trail))
22784 (prev-elem (nth 1 trail)))
22785 ;; Error out if no previous element or previous element is
22786 ;; a parent of the current one.
22787 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
22788 (error "Cannot drag element backward")
22789 (let ((pos (point)))
22790 (org-element-swap-A-B prev-elem elem)
22791 (goto-char (+ (org-element-property :begin prev-elem)
22792 (- pos (org-element-property :begin elem)))))))))
22794 (defun org-drag-element-forward ()
22795 "Move forward element at point."
22796 (interactive)
22797 (let* ((pos (point))
22798 (elem (org-element-at-point)))
22799 (when (= (point-max) (org-element-property :end elem))
22800 (error "Cannot drag element forward"))
22801 (goto-char (org-element-property :end elem))
22802 (let ((next-elem (org-element-at-point)))
22803 (when (or (org-element-nested-p elem next-elem)
22804 (and (eq (org-element-type next-elem) 'headline)
22805 (not (eq (org-element-type elem) 'headline))))
22806 (goto-char pos)
22807 (error "Cannot drag element forward"))
22808 ;; Compute new position of point: it's shifted by NEXT-ELEM
22809 ;; body's length (without final blanks) and by the length of
22810 ;; blanks between ELEM and NEXT-ELEM.
22811 (let ((size-next (- (save-excursion
22812 (goto-char (org-element-property :end next-elem))
22814 (forward-line)
22815 ;; Small correction if buffer doesn't end
22816 ;; with a newline character.
22817 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
22818 (org-element-property :begin next-elem)))
22819 (size-blank (- (org-element-property :end elem)
22820 (save-excursion
22821 (goto-char (org-element-property :end elem))
22823 (forward-line)
22824 (point)))))
22825 (org-element-swap-A-B elem next-elem)
22826 (goto-char (+ pos size-next size-blank))))))
22828 (defun org-drag-line-forward (arg)
22829 "Drag the line at point ARG lines forward."
22830 (interactive "p")
22831 (dotimes (n (abs arg))
22832 (let ((c (current-column)))
22833 (if (< 0 arg)
22834 (progn
22835 (beginning-of-line 2)
22836 (transpose-lines 1)
22837 (beginning-of-line 0))
22838 (transpose-lines 1)
22839 (beginning-of-line -1))
22840 (org-move-to-column c))))
22842 (defun org-drag-line-backward (arg)
22843 "Drag the line at point ARG lines backward."
22844 (interactive "p")
22845 (org-drag-line-forward (- arg)))
22847 (defun org-mark-element ()
22848 "Put point at beginning of this element, mark at end.
22850 Interactively, if this command is repeated or (in Transient Mark
22851 mode) if the mark is active, it marks the next element after the
22852 ones already marked."
22853 (interactive)
22854 (let (deactivate-mark)
22855 (if (and (org-called-interactively-p 'any)
22856 (or (and (eq last-command this-command) (mark t))
22857 (and transient-mark-mode mark-active)))
22858 (set-mark
22859 (save-excursion
22860 (goto-char (mark))
22861 (goto-char (org-element-property :end (org-element-at-point)))))
22862 (let ((element (org-element-at-point)))
22863 (end-of-line)
22864 (push-mark (org-element-property :end element) t t)
22865 (goto-char (org-element-property :begin element))))))
22867 (defun org-narrow-to-element ()
22868 "Narrow buffer to current element."
22869 (interactive)
22870 (let ((elem (org-element-at-point)))
22871 (cond
22872 ((eq (car elem) 'headline)
22873 (narrow-to-region
22874 (org-element-property :begin elem)
22875 (org-element-property :end elem)))
22876 ((memq (car elem) org-element-greater-elements)
22877 (narrow-to-region
22878 (org-element-property :contents-begin elem)
22879 (org-element-property :contents-end elem)))
22880 (t
22881 (narrow-to-region
22882 (org-element-property :begin elem)
22883 (org-element-property :end elem))))))
22885 (defun org-transpose-element ()
22886 "Transpose current and previous elements, keeping blank lines between.
22887 Point is moved after both elements."
22888 (interactive)
22889 (org-skip-whitespace)
22890 (let ((end (org-element-property :end (org-element-at-point))))
22891 (org-drag-element-backward)
22892 (goto-char end)))
22894 (defun org-unindent-buffer ()
22895 "Un-indent the visible part of the buffer.
22896 Relative indentation (between items, inside blocks, etc.) isn't
22897 modified."
22898 (interactive)
22899 (unless (eq major-mode 'org-mode)
22900 (error "Cannot un-indent a buffer not in Org mode"))
22901 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22902 unindent-tree ; For byte-compiler.
22903 (unindent-tree
22904 (function
22905 (lambda (contents)
22906 (mapc
22907 (lambda (element)
22908 (if (memq (org-element-type element) '(headline section))
22909 (funcall unindent-tree (org-element-contents element))
22910 (save-excursion
22911 (save-restriction
22912 (narrow-to-region
22913 (org-element-property :begin element)
22914 (org-element-property :end element))
22915 (org-do-remove-indentation)))))
22916 (reverse contents))))))
22917 (funcall unindent-tree (org-element-contents parse-tree))))
22919 (defun org-show-subtree ()
22920 "Show everything after this heading at deeper levels."
22921 (interactive)
22922 (outline-flag-region
22923 (point)
22924 (save-excursion
22925 (org-end-of-subtree t t))
22926 nil))
22928 (defun org-show-entry ()
22929 "Show the body directly following this heading.
22930 Show the heading too, if it is currently invisible."
22931 (interactive)
22932 (save-excursion
22933 (condition-case nil
22934 (progn
22935 (org-back-to-heading t)
22936 (outline-flag-region
22937 (max (point-min) (1- (point)))
22938 (save-excursion
22939 (if (re-search-forward
22941 (match-beginning 1)
22942 (point-max)))
22943 nil)
22944 (org-cycle-hide-drawers 'children))
22945 (error nil))))
22947 (defun org-make-options-regexp (kwds &optional extra)
22948 "Make a regular expression for keyword lines."
22949 (concat
22955 ;; Make isearch reveal the necessary context
22956 (defun org-isearch-end ()
22957 "Reveal context after isearch exits."
22958 (when isearch-success ; only if search was successful
22959 (if (featurep 'xemacs)
22960 ;; Under XEmacs, the hook is run in the correct place,
22961 ;; we directly show the context.
22962 (org-show-context 'isearch)
22963 ;; In Emacs the hook runs *before* restoring the overlays.
22964 ;; So we have to use a one-time post-command-hook to do this.
22965 ;; (Emacs 22 has a special variable, see function `org-mode')
22966 (unless (and (boundp 'isearch-mode-end-hook-quit)
22967 isearch-mode-end-hook-quit)
22968 ;; Only when the isearch was not quitted.
22969 (org-add-hook 'post-command-hook 'org-isearch-post-command
22970 'append 'local)))))
22972 (defun org-isearch-post-command ()
22973 "Remove self from hook, and show context."
22974 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22975 (org-show-context 'isearch))
22978 ;;;; Integration with and fixes for other packages
22980 ;;; Imenu support
22982 (defvar org-imenu-markers nil
22983 "All markers currently used by Imenu.")
22984 (make-variable-buffer-local 'org-imenu-markers)
22986 (defun org-imenu-new-marker (&optional pos)
22987 "Return a new marker for use by Imenu, and remember the marker."
22988 (let ((m (make-marker)))
22989 (move-marker m (or pos (point)))
22990 (push m org-imenu-markers)
22991 m))
22993 (defun org-imenu-get-tree ()
22994 "Produce the index for Imenu."
22995 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22996 (setq org-imenu-markers nil)
22997 (let* ((n org-imenu-depth)
22998 (re (concat "^" (org-get-limited-outline-regexp)))
22999 (subs (make-vector (1+ n) nil))
23000 (last-level 0)
23001 m level head)
23002 (save-excursion
23003 (save-restriction
23004 (widen)
23005 (goto-char (point-max))
23006 (while (re-search-backward re nil t)
23007 (setq level (org-reduced-level (funcall outline-level)))
23008 (when (and (<= level n)
23009 (looking-at org-complex-heading-regexp))
23010 (setq head (org-link-display-format
23011 (org-match-string-no-properties 4))
23012 m (org-imenu-new-marker))
23013 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23014 (if (>= level last-level)
23015 (push (cons head m) (aref subs level))
23016 (push (cons head (aref subs (1+ level))) (aref subs level))
23017 (loop for i from (1+ level) to n do (aset subs i nil)))
23018 (setq last-level level)))))
23019 (aref subs 1)))
23021 (eval-after-load "imenu"
23022 '(progn
23023 (add-hook 'imenu-after-jump-hook
23024 (lambda ()
23025 (if (derived-mode-p 'org-mode)
23026 (org-show-context 'org-goto))))))
23028 (defun org-link-display-format (link)
23029 "Replace a link with either the description, or the link target
23030 if no description is present"
23031 (save-match-data
23032 (if (string-match org-bracket-link-analytic-regexp link)
23033 (replace-match (if (match-end 5)
23034 (match-string 5 link)
23035 (concat (match-string 1 link)
23036 (match-string 3 link)))
23037 nil t link)
23038 link)))
23040 (defun org-toggle-link-display ()
23041 "Toggle the literal or descriptive display of links."
23042 (interactive)
23043 (if org-descriptive-links
23044 (progn (org-remove-from-invisibility-spec '(org-link))
23045 (org-restart-font-lock)
23046 (setq org-descriptive-links nil))
23047 (progn (add-to-invisibility-spec '(org-link))
23048 (org-restart-font-lock)
23049 (setq org-descriptive-links t))))
23051 ;; Speedbar support
23053 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23054 "Overlay marking the agenda restriction line in speedbar.")
23055 (overlay-put org-speedbar-restriction-lock-overlay
23056 'face 'org-agenda-restriction-lock)
23057 (overlay-put org-speedbar-restriction-lock-overlay
23058 'help-echo "Agendas are currently limited to this item.")
23059 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23061 (defun org-speedbar-set-agenda-restriction ()
23062 "Restrict future agenda commands to the location at point in speedbar.
23064 (interactive)
23065 (require 'org-agenda)
23066 (let (p m tp np dir txt)
23067 (cond
23068 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23069 'org-imenu t))
23070 (setq m (get-text-property p 'org-imenu-marker))
23071 (with-current-buffer (marker-buffer m)
23072 (goto-char m)
23073 (org-agenda-set-restriction-lock 'subtree)))
23074 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23075 'speedbar-function 'speedbar-find-file))
23076 (setq tp (previous-single-property-change
23077 (1+ p) 'speedbar-function)
23078 np (next-single-property-change
23079 tp 'speedbar-function)
23080 dir (speedbar-line-directory)
23081 txt (buffer-substring-no-properties (or tp (point-min))
23082 (or np (point-max))))
23083 (with-current-buffer (find-file-noselect
23084 (let ((default-directory dir))
23085 (expand-file-name txt)))
23086 (unless (derived-mode-p 'org-mode)
23087 (error "Cannot restrict to non-Org-mode file"))
23088 (org-agenda-set-restriction-lock 'file)))
23089 (t (error "Don't know how to restrict Org-mode's agenda")))
23090 (move-overlay org-speedbar-restriction-lock-overlay
23091 (point-at-bol) (point-at-eol))
23092 (setq current-prefix-arg nil)
23093 (org-agenda-maybe-redo)))
23095 (eval-after-load "speedbar"
23096 '(progn
23097 (speedbar-add-supported-extension ".org")
23098 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23099 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23100 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23101 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23102 (add-hook 'speedbar-visiting-tag-hook
23103 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23105 ;;; Fixes and Hacks for problems with other packages
23107 ;; Make flyspell not check words in links, to not mess up our keymap
23108 (defvar org-element-affiliated-keywords) ; From org-element.el
23109 (defvar org-element-block-name-alist) ; From org-element.el
23110 (defun org-mode-flyspell-verify ()
23111 "Don't let flyspell put overlays at active buttons, or on
23112 {todo,all-time,additional-option-like}-keywords."
23113 (let ((pos (max (1- (point)) (point-min)))
23114 (word (thing-at-point 'word)))
23115 (and (not (get-text-property pos 'keymap))
23116 (not (get-text-property pos 'org-no-flyspell))
23117 (not (member word org-todo-keywords-1))
23118 (not (member word org-all-time-keywords))
23119 (not (member word org-options-keywords))
23120 (not (member word (mapcar 'car org-startup-options)))
23121 (not (member-ignore-case word org-element-affiliated-keywords))
23122 (not (member-ignore-case word (org-get-export-keywords)))
23123 (not (member-ignore-case
23124 word (mapcar 'car org-element-block-name-alist)))
23125 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23127 (defun org-remove-flyspell-overlays-in (beg end)
23128 "Remove flyspell overlays in region."
23129 (and (org-bound-and-true-p flyspell-mode)
23130 (fboundp 'flyspell-delete-region-overlays)
23131 (flyspell-delete-region-overlays beg end))
23132 (add-text-properties beg end '(org-no-flyspell t)))
23134 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23135 (eval-after-load "bookmark"
23136 '(if (boundp 'bookmark-after-jump-hook)
23137 ;; We can use the hook
23138 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23139 ;; Hook not available, use advice
23140 (defadvice bookmark-jump (after org-make-visible activate)
23141 "Make the position visible."
23142 (org-bookmark-jump-unhide))))
23144 ;; Make sure saveplace shows the location if it was hidden
23145 (eval-after-load "saveplace"
23146 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23147 "Make the position visible."
23148 (org-bookmark-jump-unhide)))
23150 ;; Make sure ecb shows the location if it was hidden
23151 (eval-after-load "ecb"
23152 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23153 "Make hierarchy visible when jumping into location from ECB tree buffer."
23154 (if (derived-mode-p 'org-mode)
23155 (org-show-context))))
23157 (defun org-bookmark-jump-unhide ()
23158 "Unhide the current position, to show the bookmark location."
23159 (and (derived-mode-p 'org-mode)
23160 (or (outline-invisible-p)
23161 (save-excursion (goto-char (max (point-min) (1- (point))))
23162 (outline-invisible-p)))
23163 (org-show-context 'bookmark-jump)))
23165 ;; Make session.el ignore our circular variable
23166 (eval-after-load "session"
23167 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23169 ;;;; Experimental code
23171 (defun org-closed-in-range ()
23172 "Sparse tree of items closed in a certain time range.
23173 Still experimental, may disappear in the future."
23174 (interactive)
23175 ;; Get the time interval from the user.
23176 (let* ((time1 (org-float-time
23177 (org-read-date nil 'to-time nil "Starting date: ")))
23178 (time2 (org-float-time
23179 (org-read-date nil 'to-time nil "End date:")))
23180 ;; callback function
23181 (callback (lambda ()
23182 (let ((time
23183 (org-float-time
23184 (apply 'encode-time
23185 (org-parse-time-string
23186 (match-string 1))))))
23187 ;; check if time in interval
23188 (and (>= time time1) (<= time time2))))))
23189 ;; make tree, check each match with the callback
23192 ;;;; Finish up
23194 (provide 'org)
23196 (run-hooks 'org-load-hook)
23198 ;;; org.el ends here