| blob | 8168a284d0d9e1b4204d854838d62565a1723fd2 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
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
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
106 ;; babel
115 ;; load languages based on value of `org-babel-load-languages'
117 ;;;###autoload
119 "Load the languages defined in `org-babel-load-languages'."
131 org-babel-load-languages))
134 "Languages which can be evaluated in Org-mode buffers.
135 This list can be used to load support for any of the languages
136 below, note that each language will depend on a different set of
137 system executables and/or Emacs modes. When a language is
139 with `org-babel-execute-src-block' bound by default to C-c
140 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
141 be set to remove code block evaluation from the C-c C-c
142 keybinding. By default only Emacs Lisp (which has no
143 requirements) is loaded."
147 :key-type
180 ;;;; Customization variables
182 "Remove ID property of clones of a subtree.
183 When non-nil, clones of a subtree don't inherit the ID property.
184 Otherwise they inherit the ID property with a new unique
185 identifier."
189 ;;; Version
195 "Show the org-mode version in the echo area.
196 With prefix arg HERE, insert it at point."
222 ;;; Compatibility constants
224 ;;; The custom variables
227 "Outline-based notes management and organizer."
233 "Mode hook for Org-mode, run after the mode was turned on."
238 "Hook that is run after org.el has been loaded."
247 "Load all extensions listed in `org-modules'."
252 org-modules)
256 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
265 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
266 "Modules that should always be loaded together with org.el.
267 If a description starts with <C>, the file is not part of Emacs
268 and loading it will require that you have downloaded and properly installed
269 the org-mode distribution.
271 You can also use this system to load external packages (i.e. neither Org
272 core modules, nor modules from the CONTRIB directory). Just add symbols
273 to the end of the list. If the package is called org-xyz.el, then you need
274 to add the symbol `xyz', and the package must have a call to
276 (provide 'org-xyz)"
279 :type
310 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
318 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
327 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
343 "Non-nil means make shift-cursor commands select text when possible.
345 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
346 selecting a region, or enlarge regions started in this way.
347 In Org-mode, in special contexts, these same keys are used for other
348 purposes, important enough to compete with shift selection. Org tries
349 to balance these needs by supporting `shift-select-mode' outside these
350 special contexts, under control of this variable.
352 The default of this variable is nil, to avoid confusing behavior. Shifted
353 cursor keys will then execute Org commands in the following contexts:
354 - on a headline, changing TODO state (left/right) and priority (up/down)
355 - on a time stamp, changing the time
356 - in a plain list item, changing the bullet type
357 - in a property definition line, switching between allowed values
358 - in the BEGIN line of a clock table (changing the time block).
359 Outside these contexts, the commands will throw an error.
361 When this variable is t and the cursor is not in a special context,
362 Org-mode will support shift-selection for making and enlarging regions.
363 To make this more effective, the bullet cycling will no longer happen
364 anywhere in an item line, but only if the cursor is exactly on the bullet.
366 If you set this variable to the symbol `always', then the keys
367 will not be special in headlines, property lines, and item lines, to make
368 shift selection work there as well. If this is what you want, you can
369 use the following alternative commands: `C-c C-t' and `C-c ,' to
370 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
371 TODO sets, `C-c -' to cycle item bullet types, and properties can be
372 edited by hand or in column view.
374 However, when the cursor is on a timestamp, shift-cursor commands
375 will still edit the time stamp - this is just too good to give up.
377 XEmacs user should have this variable set to nil, because shift-select-mode
378 is Emacs 23 only."
386 "Options concerning startup of Org-mode."
391 "Non-nil means entering Org-mode will switch to OVERVIEW.
392 This can also be configured on a per-file basis by adding one of
393 the following lines anywhere in the buffer:
395 #+STARTUP: fold (or `overview', this is equivalent)
396 #+STARTUP: nofold (or `showall', this is equivalent)
397 #+STARTUP: content
398 #+STARTUP: showeverything"
407 "Non-nil means entering Org-mode will set `truncate-lines'.
408 This is useful since some lines containing links can be very long and
409 uninteresting. Also tables look terrible when wrapped."
414 "Non-nil means turn on `org-indent-mode' on startup.
415 This can also be configured on a per-file basis by adding one of
416 the following lines anywhere in the buffer:
418 #+STARTUP: indent
419 #+STARTUP: noindent"
427 When this option is turned on, you can use TeX-like syntax for sub- and
429 considered as a single item - so grouping with {} is normally not
430 needed. For example, the following things will be parsed as single
431 sub- or superscripts.
433 10^24 or 10^tau several digits will be considered 1 item.
434 10^-12 or 10^-tau a leading sign with digits or a word
435 x^2-y^3 will be read as x^2 - y^3, because items are
436 terminated by almost any nonword/nondigit char.
437 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
439 Still, ambiguity is possible - so when in doubt use {} to enclose the
440 sub/superscript. If you set this variable to the symbol `{}',
441 the braces are *required* in order to trigger interpretations as
443 frequently in plain text.
445 Not all export backends support this, but HTML does.
460 "Non-nil means turn on `org-beamer-mode' on startup.
461 This can also be configured on a per-file basis by adding one of
462 the following lines anywhere in the buffer:
464 #+STARTUP: beamer"
469 "Non-nil means align all tables when visiting a file.
470 This is useful when the column width in tables is forced with <N> cookies
471 in table fields. Such tables will look correct only after the first re-align.
472 This can also be configured on a per-file basis by adding one of
473 the following lines anywhere in the buffer:
474 #+STARTUP: align
475 #+STARTUP: noalign"
480 "Non-nil means show inline images when loading a new Org file.
481 This can also be configured on a per-file basis by adding one of
482 the following lines anywhere in the buffer:
483 #+STARTUP: inlineimages
484 #+STARTUP: noinlineimages"
489 "Non-nil means insert the first line setting Org-mode in empty files.
490 When the function `org-mode' is called interactively in an empty file, this
491 normally means that the file name does not automatically trigger Org-mode.
492 To ensure that the file will always be in Org-mode in the future, a
493 line enforcing Org-mode will be inserted into the buffer, if this option
494 has been set."
499 "Non-nil means use alternative key bindings for some keys.
500 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
501 These keys are also used by other packages like shift-selection-mode'
502 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
503 If you want to use Org-mode together with one of these other modes,
504 or more generally if you would like to move some Org-mode commands to
505 other keys, set this variable and configure the keys with the variable
506 `org-disputed-keys'.
508 This option is only relevant at load-time of Org-mode, and must be set
509 *before* org.el is loaded. Changing it requires a restart of Emacs to
510 become effective."
515 "Non-nil means use extra key sequence definitions for certain commands.
516 This happens automatically if you run XEmacs or if `window-system'
517 is nil. This variable lets you do the same manually. You must
518 set it before loading org.
520 Example: on Carbon Emacs 22 running graphically, with an external
521 keyboard on a Powerbook, the default way of setting M-left might
522 not work for either Alt or ESC. Setting this variable will make
523 it work for ESC."
537 "Keys for which Org-mode and other modes compete.
538 This is an alist, cars are the default keys, second element specifies
539 the alternative to use when `org-replace-disputed-keys' is t.
541 Keys can be specified in any syntax supported by `define-key'.
542 The value of this option takes effect only at Org-mode's startup,
543 therefore you'll have to restart Emacs to apply it after changing."
548 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
549 Or return the original if not disputed.
550 Also apply the translations defined in `org-xemacs-key-equivalents'."
555 org-disputed-keys)))
559 key)
569 "Define a key, possibly translated, as returned by `org-key'."
573 "The ellipsis to use in the Org-mode outline.
574 When nil, just use the standard three dots. When a string, use that instead,
575 When a face, use the standard 3 dots, but with the specified face.
576 The change affects only Org-mode (which will then use its own display table).
577 Changing this requires executing `M-x org-mode' in a buffer to become
578 effective."
588 "Keywords in Org-mode."
593 "String to mark deadline entries.
594 A deadline is this string, followed by a time stamp. Should be a word,
595 terminated by a colon. You can insert a schedule keyword and
597 Changes become only effective after restarting Emacs."
602 "String to mark scheduled TODO entries.
603 A schedule is this string, followed by a time stamp. Should be a word,
604 terminated by a colon. You can insert a schedule keyword and
606 Changes become only effective after restarting Emacs."
611 "String used as the prefix for timestamps logging closing a TODO entry."
616 "String used as prefix for timestamps clocking work hours on an item."
621 "Entries starting with this keyword will never be exported.
622 An entry can be toggled between COMMENT and normal with
624 Changes become only effective after restarting Emacs."
629 "Entries starting with this keyword will be exported in fixed-width font.
630 Quoting applies only to the text in the entry following the headline, and does
631 not extend beyond the next headline, even if that is lower level.
632 An entry can be toggled between QUOTE and normal with
639 "Regular expression for specifying repeated events.
643 "Options concerning the general structure of Org-mode files."
648 "Options about how to make context of a location visible."
672 "Non-nil means show full hierarchy when revealing a location.
673 Org-mode often shows locations in an org-mode file which might have
674 been invisible before. When this is set, the hierarchy of headings
675 above the exposed location is shown.
676 Turning this off for example for sparse trees makes them very compact.
677 Instead of t, this can also be an alist specifying this option for different
678 contexts. Valid contexts are
679 agenda when exposing an entry from the agenda
680 org-goto when using the command `org-goto' on key C-c C-j
681 occur-tree when using the command `org-occur' on key C-c /
682 tags-tree when constructing a sparse tree based on tags matches
683 link-search when exposing search matches associated with a link
684 mark-goto when exposing the jump goal of a mark
685 bookmark-jump when exposing a bookmark location
686 isearch when exiting from an incremental search
687 default default for all contexts not set explicitly"
692 "Non-nil means show following heading when revealing a location.
693 Org-mode often shows locations in an org-mode file which might have
694 been invisible before. When this is set, the heading following the
695 match is shown.
696 Turning this off for example for sparse trees makes them very compact,
697 but makes it harder to edit the location of the match. In such a case,
699 Instead of t, this can also be an alist specifying this option for different
700 contexts. See `org-show-hierarchy-above' for valid contexts."
705 "Non-nil means show all sibling heading when revealing a location.
706 Org-mode often shows locations in an org-mode file which might have
707 been invisible before. When this is set, the sibling of the current entry
708 heading are all made visible. If `org-show-hierarchy-above' is t,
709 the same happens on each level of the hierarchy above the current entry.
711 By default this is on for the isearch context, off for all other contexts.
712 Turning this off for example for sparse trees makes them very compact,
713 but makes it harder to edit the location of the match. In such a case,
715 Instead of t, this can also be an alist specifying this option for different
716 contexts. See `org-show-hierarchy-above' for valid contexts."
721 "Non-nil means show the entry below a headline when revealing a location.
722 Org-mode often shows locations in an org-mode file which might have
723 been invisible before. When this is set, the text below the headline that is
724 exposed is also shown.
726 By default this is off for all contexts.
727 Instead of t, this can also be an alist specifying this option for different
728 contexts. See `org-show-hierarchy-above' for valid contexts."
733 "How should indirect tree buffers be displayed?
734 This applies to indirect buffers created with the commands
736 Valid values are:
737 current-window Display in the current window
738 other-window Just display in another window.
739 dedicated-frame Create one new frame, and re-use it each time.
740 new-frame Make a new frame each time. Note that in this case
741 previously-made indirect buffers are kept, and you need to
742 kill these buffers yourself."
752 "Non-nil means activate single letter commands at beginning of a headline.
753 This may also be a function to test for appropriate locations where speed
754 commands should be active."
762 "Alist of additional speed commands.
763 This list will be checked before `org-speed-commands-default'
764 when the variable `org-use-speed-commands' is non-nil
765 and when the cursor is at the beginning of a headline.
766 The car if each entry is a string with a single letter, which must
767 be assigned to `self-insert-command' in the global map.
768 The cdr is either a command to be called interactively, a function
769 to be called, or a form to be evaluated.
770 An entry that is just a list with a single string will be interpreted
771 as a descriptive headline that will be added when listing the speed
772 commands in the Help buffer using the `?' speed command."
784 "Options concerning visibility cycling in Org-mode."
789 "Non-nil means skip CHILDREN state in entries that don't have any."
794 "Maximum level which should still be subject to visibility cycling.
795 Levels higher than this will, for cycling, be treated as text, not a headline.
796 When `org-odd-levels-only' is set, a value of N in this variable actually
797 means 2N-1 stars as the limiting headline.
798 When nil, cycle all levels.
799 Note that the limiting level of cycling is also influenced by
800 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
801 `org-inlinetask-min-level' is, cycling will be limited to levels one less
802 than its value."
809 "Names of drawers. Drawers are not opened by cycling on the headline above.
810 Drawers only open with a TAB on the drawer line itself. A drawer looks like
811 this:
812 :DRAWERNAME:
813 .....
814 :END:
816 the property API.
818 Drawers can be defined on the per-file basis with a line like:
820 #+DRAWERS: HIDDEN STATE PROPERTIES"
826 "Non-nil means entering Org-mode will fold all blocks.
827 This can also be set in on a per-file basis with
829 #+STARTUP: hideblocks
830 #+STARTUP: showblocks"
836 "Cycle globally if cursor is at beginning of buffer and not at a headline.
837 This makes it possible to do global cycling without having to use S-TAB or
839 of the buffer
840 must not be a headline - it may be empty or some other text. When used in
841 this way, `org-cycle-hook' is disables temporarily, to make sure the
842 cursor stays at the beginning of the buffer.
843 When this option is nil, don't do anything special at the beginning
844 of the buffer."
849 "Non-nil means cycle entry level or item indentation in new empty entries.
851 When the cursor is at the end of an empty headline, i.e with only stars
852 and maybe a TODO keyword, TAB will then switch the entry to become a child,
853 and then all possible ancestor states, before returning to the original state.
854 This makes data entry extremely fast: M-RET to create a new headline,
855 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
857 When the cursor is at the end of an empty plain list item, one TAB will
858 make it a subitem, two or more tabs will back up to make this an item
859 higher up in the item hierarchy."
864 "Where should `org-cycle' emulate TAB.
865 nil Never
866 white Only in completely white lines
867 whitestart Only at the beginning of lines, before the first non-white char
868 t Everywhere except in headlines
869 exc-hl-bol Everywhere except at the start of a headline
870 If TAB is used in a place where it does not emulate TAB, the current subtree
871 visibility is cycled."
878 ))
881 "Number of empty lines needed to keep an empty line between collapsed trees.
882 If you leave an empty line between the end of a subtree and the following
883 headline, this empty line is hidden when the subtree is folded.
884 Org-mode will leave (exactly) one empty line visible if the number of
885 empty lines is equal or larger to the number given in this variable.
886 So the default 2 means at least 2 empty lines after the end of a subtree
887 are needed to produce free space between a collapsed subtree and the
888 following headline.
890 If the number is negative, and the number of empty lines is at least -N,
891 all empty lines are shown.
893 Special case: when 0, never leave empty lines in collapsed view."
899 "Hook that is run before visibility cycling is happening.
900 The function(s) in this hook must accept a single argument which indicates
901 the new state that will be set right after running this hook. The
902 argument is a symbol. Before a global state change, it can have the values
903 `overview', `content', or `all'. Before a local state change, it can have
904 the values `folded', `children', or `subtree'."
909 org-cycle-hide-drawers
910 org-cycle-show-empty-lines
911 org-optimize-window-after-visibility-change)
912 "Hook that is run after `org-cycle' has changed the buffer visibility.
913 The function(s) in this hook must accept a single argument which indicates
914 the new state that was set by the most recent `org-cycle' command. The
915 argument is a symbol. After a global state change, it can have the values
916 `overview', `content', or `all'. After a local state change, it can have
917 the values `folded', `children', or `subtree'."
922 "Options concerning structure editing in Org-mode."
927 "Non-nil means skip even levels and only use odd levels for the outline.
928 This has the effect that two stars are being added/taken away in
929 promotion/demotion commands. It also influences how levels are
930 handled by the exporters.
931 Changing it requires restart of `font-lock-mode' to become effective
932 for fontification also in regions already fontified.
933 You may also set this on a per-file basis by adding one of the following
934 lines to the buffer:
936 #+STARTUP: odd
937 #+STARTUP: oddeven"
943 "Non-nil means adapt indentation to outline node level.
945 When this variable is set, Org assumes that you write outlines by
946 indenting text in each node to align with the headline (after the stars).
947 The following issues are influenced by this variable:
949 - When this is set and the *entire* text in an entry is indented, the
950 indentation is increased by one space in a demotion command, and
951 decreased by one in a promotion command. If any line in the entry
952 body starts with text at column 0, indentation is not changed at all.
954 - Property drawers and planning information is inserted indented when
955 this variable s set. When nil, they will not be indented.
957 - TAB indents a line relative to context. The lines below a headline
958 will be indented when this variable is set.
960 Note that this is all about true indentation, by adding and removing
961 space characters. See also `org-indent.el' which does level-dependent
962 indentation in a virtual way, i.e. at display time in Emacs."
967 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
969 When t, `C-a' will bring back the cursor to the beginning of the
970 headline text, i.e. after the stars and after a possible TODO keyword.
971 In an item, this will be the position after the bullet.
972 When the cursor is already at that position, another `C-a' will bring
973 it to the beginning of the line.
975 `C-e' will jump to the end of the headline, ignoring the presence of tags
976 in the headline. A second `C-e' will then jump to the true end of the
977 line, after any tags. This also means that, when this variable is
978 non-nil, `C-e' also will never jump beyond the end of the heading of a
979 folded section, i.e. not after the ellipses.
981 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
982 going to the true line boundary first. Only a directly following, identical
983 keypress will bring the cursor to the special positions.
985 This may also be a cons cell where the behavior for `C-a' and `C-e' is
986 set separately."
1005 "Non-nil means `C-k' will behave specially in headlines.
1006 When nil, `C-k' will call the default `kill-line' command.
1007 When t, the following will happen while the cursor is in the headline:
1009 - When the cursor is at the beginning of a headline, kill the entire
1010 line and possible the folded subtree below the line.
1011 - When in the middle of the headline text, kill the headline up to the tags.
1012 - When after the headline text, kill the tags."
1017 "Non-nil means, do not delete a hidden subtree with C-k.
1018 When set to the symbol `error', simply throw an error when C-k is
1019 used to kill (part-of) a headline that has hidden text behind it.
1020 Any other non-nil value will result in a query to the user, if it is
1021 OK to kill that hidden subtree. When nil, kill without remorse."
1029 "Non-nil means when yanking subtrees, fold them.
1030 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1031 it starts with a heading and all other headings in it are either children
1032 or siblings, then fold all the subtrees. However, do this only if no
1033 text after the yank would be swallowed into a folded tree by this action."
1038 "Non-nil means when yanking subtrees, adjust the level.
1039 With this setting, `org-paste-subtree' is used to insert the subtree, see
1040 this function for details."
1045 "Non-nil means M-RET will split the line at the cursor position.
1046 When nil, it will go to the end of the line before making a
1047 new line.
1048 You may also set this option in a different way for different
1049 contexts. Valid contexts are:
1051 headline when creating a new headline
1052 item when creating a new item
1053 table in a table field
1054 default the value to be used for all contexts not explicitly
1055 customized"
1072 "Non-nil means insert new headings after the current subtree.
1073 When nil, the new heading is created directly after the current line.
1076 for the duration of the command."
1082 "Should `org-insert-heading' leave a blank line before new heading/item?
1083 The value is an alist, with `heading' and `plain-list-item' as car,
1084 and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
1085 Org will look at the surrounding headings/items and try to make an
1086 intelligent decision whether to insert a blank line or not.
1088 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1089 set, the setting here is ignored and no empty line is inserted, to avoid
1090 breaking the list structure."
1103 "Hook being run after inserting a new heading."
1109 This currently only means they are never auto-wrapped.
1110 When nil, such lines will be treated like ordinary lines.
1111 See also the QUOTE keyword."
1116 "Non-nil means typing characters in `org-goto' starts incremental search."
1121 "Options concerning sparse trees in Org-mode."
1126 "Non-nil means highlight all matches that define a sparse tree.
1127 The highlights will automatically disappear the next time the buffer is
1128 changed by an edit command."
1133 "Non-nil means any change to the buffer will remove temporary highlights.
1134 Such highlights are created by `org-occur' and `org-clock-display'.
1135 When nil, `C-c C-c needs to be used to get rid of the highlights.
1136 The highlights created by `org-preview-latex-fragment' always need
1137 `C-c C-c' to be removed."
1144 "Hook that is run after `org-occur' has constructed a sparse tree.
1145 This can be used to recenter the window to show as much of the structure
1146 as possible."
1151 "Options concerning imenu and speedbar in Org-mode."
1156 "The maximum level for Imenu access to Org-mode headlines.
1157 This also applied for speedbar access."
1162 "Options concerning tables in Org-mode."
1168 When nil, such lines will be treated like ordinary lines.
1170 When equal to the symbol `optimized', the table editor will be optimized to
1171 do the following:
1172 - Automatic overwrite mode in front of whitespace in table fields.
1173 This makes the structure of the table stay in tact as long as the edited
1174 field does not exceed the column width.
1175 - Minimize the number of realigns. Normally, the table is aligned each time
1176 TAB or RET are pressed to move to another field. With optimization this
1177 happens only if changes to a field might have changed the column width.
1178 Optimization requires replacing the functions `self-insert-command',
1179 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1180 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1181 very good at guessing when a re-align will be necessary, but you can always
1184 If you would like to use the optimized version in Org-mode, but the
1185 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1187 This variable can be used to turn on and off the table editor during a session,
1188 but in order to toggle optimization, a restart is required.
1190 See also the variable `org-table-auto-blank-field'."
1198 "Non-nil means cluster self-insert commands for undo when possible.
1199 If this is set, then, like in the Emacs command loop, 20 consecutive
1200 characters will be undone together.
1201 This is configurable, because there is some impact on typing performance."
1206 "Non-nil means TAB will automatically notice a table.el table.
1207 When it sees such a table, it moves point into it and - if necessary -
1208 calls `table-recognize-table'."
1213 "Options concerning links in Org-mode."
1218 "Buffer-local version of `org-link-abbrev-alist', which see.
1223 "Alist of link abbreviations.
1224 The car of each element is a string, to be replaced at the start of a link.
1226 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1228 [[linkkey:tag][description]]
1230 The 'linkkey' must be a word word, starting with a letter, followed
1231 by letters, numbers, '-' or '_'.
1233 If REPLACE is a string, the tag will simply be appended to create the link.
1236 be inserted at that point (see the function `url-hexify-string').
1238 REPLACE may also be a function that will be called with the tag as the
1239 only argument to create the link, which should be returned as a string.
1241 See the manual for examples."
1251 "Non-nil means hide link part and only show description of bracket links.
1252 Bracket links are like [[link][description]]. This variable sets the initial
1253 state in new org-mode buffers. The setting can then be toggled on a
1254 per-buffer basis from the Org->Hyperlinks menu."
1259 "How the path name in file links should be stored.
1260 Valid values are:
1262 relative Relative to the current directory, i.e. the directory of the file
1263 into which the link is being inserted.
1264 absolute Absolute path, if possible with ~ for home directory.
1265 noabbrev Absolute path, no abbreviation of home directory.
1266 adaptive Use relative path for files in the current directory and sub-
1267 directories of it. For other files, use an absolute path."
1276 "Types of links that should be activated in Org-mode files.
1277 This is a list of symbols, each leading to the activation of a certain link
1278 type. In principle, it does not hurt to turn on most link types - there may
1279 be a small gain when turning off unused link types. The types are:
1281 bracket The recommended [[link][description]] or [[link]] links with hiding.
1282 angle Links in angular brackets that may contain whitespace like
1283 <bbdb:Carsten Dominik>.
1284 plain Plain links in normal text, no whitespace, like http://google.com.
1285 radio Text that is matched by a radio target, see manual for details.
1286 tag Tag settings in a headline (link to tag search).
1287 date Time stamps (link to calendar).
1288 footnote Footnote labels.
1290 Changing this variable requires a restart of Emacs to become effective."
1302 "Function to use to generate link descriptions from links.
1303 If nil the link location will be used. This function must take
1304 two parameters; the first is the link and the second the
1305 description `org-insert-link' has generated, and should return the
1306 description to use."
1311 "Options concerning storing links in Org-mode."
1316 "Format of the description part of a link to an email or usenet message.
1317 The following %-escapes will be replaced by corresponding information:
1325 %s subject
1326 %d date
1327 %m message-id.
1329 You may use normal field width specification between the % and the letter.
1330 This is for example useful to limit the length of the subject.
1344 It should match if the message is from the user him/herself."
1349 "Non-nil means storing a link to an Org file will use entry IDs.
1351 Note that before this variable is even considered, org-id must be loaded,
1352 so please customize `org-modules' and turn it on.
1354 The variable can have the following values:
1356 t Create an ID if needed to make a link to the current entry.
1358 create-if-interactive
1359 If `org-store-link' is called directly (interactively, as a user
1360 command), do create an ID to support the link. But when doing the
1361 job for remember, only use the ID if it already exists. The
1362 purpose of this setting is to avoid proliferation of unwanted
1363 IDs, just because you happen to be in an Org file when you
1364 call `org-remember' that automatically and preemptively
1365 creates a link. If you do want to get an ID link in a remember
1366 template to an entry not having an ID, create it first by
1367 explicitly creating a link to it, using `C-c C-l' first.
1369 create-if-interactive-and-no-custom-id
1370 Like create-if-interactive, but do not create an ID if there is
1371 a CUSTOM_ID property defined in the entry. This is the default.
1373 use-existing
1374 Use existing ID, do not create one.
1376 nil Never use an ID to make a link, instead link using a text search for
1377 the headline text."
1382 create-if-interactive)
1384 create-if-interactive-and-no-custom-id)
1389 "Non-nil means file links from `org-store-link' contain context.
1390 A search string will be added to the file name with :: as separator and
1391 used to find the context when the link is activated by the command
1392 `org-open-at-point'. When this option is t, the entire active region
1393 will be placed in the search string of the file link. If set to a
1394 positive integer, only the first n lines of context will be stored.
1397 negates this setting for the duration of the command."
1402 "Non-nil means keep link in list for entire session.
1404 The command `org-store-link' adds a link pointing to the current
1405 location to an internal list. These links accumulate during a session.
1406 The command `org-insert-link' can be used to insert links into any
1407 Org-mode file (offering completion for all stored links). When this
1409 will be removed from the list, to make completing the unused links
1410 more efficient."
1415 "Options concerning following links in Org-mode."
1420 "Function to translate links with different syntax to Org syntax.
1421 This can be used to translate links created for example by the Planner
1422 or emacs-wiki packages to Org syntax.
1423 The function must accept two parameters, a TYPE containing the link
1425 which is everything after the link protocol. It should return a cons
1426 with possibly modified values of type and path.
1427 Org contains a function for this, so if you set this variable to
1428 `org-translate-link-from-planner', you should be able follow many
1429 links created by planner."
1434 "Hook that is run after a link has been followed."
1439 "Non-nil means on links TAB will follow the link.
1440 Needs to be set before org.el is loaded.
1441 This really should not be used, it does not make sense, and the
1442 implementation is bad."
1447 "Non-nil means on links RET will follow the link."
1453 "Non-nil means mouse-1 on a link will follow the link.
1454 A longer mouse click will still set point. Does not work on XEmacs.
1455 Needs to be set before org.el is loaded."
1460 "Number of different positions to be recorded in the ring.
1461 Changing this requires a restart of Emacs to work correctly."
1466 "Non-nil means internal links in Org files must exactly match a headline.
1467 When nil, the link search tries to match a phrase with all words
1468 in the search text."
1474 query-to-create)))
1481 "Setup the frame configuration for following links.
1482 When following a link with Emacs, it may often be useful to display
1483 this link in another window or frame. This variable can be used to
1484 set this up for the different types of links.
1485 For VM, use any of
1486 `vm-visit-folder'
1487 `vm-visit-folder-other-window'
1488 `vm-visit-folder-other-frame'
1489 For Gnus, use any of
1490 `gnus'
1491 `gnus-other-frame'
1492 `org-gnus-no-new-news'
1493 For FILE, use any of
1494 `find-file'
1495 `find-file-other-window'
1496 `find-file-other-frame'
1497 For Wanderlust use any of
1498 `wl'
1499 `wl-other-frame'
1500 For the calendar, use the variable `calendar-setup'.
1501 For BBDB, it is currently only possible to display the matches in
1502 another window."
1526 "Non-nil means use indirect buffer to display infile links.
1527 Activating internal links (from one location in a file to another location
1528 in the same file) normally just jumps to the location. When the link is
1530 is displayed in
1531 another window. When this option is set, the other window actually displays
1532 an indirect buffer clone of the current buffer, to avoid any visibility
1533 changes to the current buffer."
1538 "Non-nil means `org-open-file' will open non-existing files.
1539 When nil, an error will be generated.
1540 This variable applies only to external applications because they
1541 might choke on non-existing files. If the link is to a file that
1542 will be opened in Emacs, the variable is ignored."
1547 "Non-nil means a link to a directory really means to index.org.
1548 When nil, following a directory link will run dired or open a finder/explorer
1549 window on that directory."
1554 "Function and arguments to call for following mailto links.
1555 This is a list with the first element being a Lisp function, and the
1556 remaining elements being arguments to the function. In string arguments,
1557 %a will be replaced by the address, and %s will be replaced by the subject
1558 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1567 "Non-nil means ask for confirmation before executing shell links.
1568 Shell links can be dangerous: just think about a link
1570 [[shell:rm -rf ~/*][Google Search]]
1573 but really it would remove your entire home directory.
1574 Therefore we advise against setting this variable to nil.
1575 Just change it to `y-or-n-p' if you want to confirm with a
1583 'safe-local-variable
1587 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1588 Elisp links can be dangerous: just think about a link
1593 but really it would remove your entire home directory.
1594 Therefore we advise against setting this variable to nil.
1595 Just change it to `y-or-n-p' if you want to confirm with a
1603 'safe-local-variable
1610 "Default file applications on a UNIX or GNU/Linux system.
1621 "Default file applications on a MacOS X system.
1623 for some files for which the OS does not have a good default.
1631 'mswindows-shell-execute
1636 'mswindows-shell-execute
1639 "Default file applications on a Windows NT system.
1644 '(
1649 )
1650 "External applications for opening `file:path' items in a document.
1651 Org-mode uses system defaults for different file types, but
1652 you can use this variable to set the application for a given file
1653 extension. The entries in this list are cons cells where the car identifies
1654 files and the cdr the corresponding command. Possible values for the
1655 file identifier are
1657 ways, depending on its contents:
1659 - Alphanumeric characters only:
1660 Match links with this file extension.
1662 to open PDFs with evince.
1664 - Regular expression: Match links where the
1665 filename matches the regexp. If you want to
1666 use groups here, use shy groups.
1670 to open *.html and *.xhtml with firefox.
1672 - Regular expression which contains (non-shy) groups:
1674 anything after that, matches the regexp.
1675 In a custom command string, %1, %2, etc. are replaced with
1676 the parts of the link that were matched by the groups.
1677 For backwards compatibility, if a command string is given
1678 that does not use any of the group matches, this case is
1679 handled identically to the second one (i.e. match against
1680 file name only).
1681 In a custom lisp form, you can access the group matches with
1682 (match-string n link).
1685 to open [[file:document.pdf::5]] with evince at page 5.
1687 `directory' Matches a directory
1688 `remote' Matches a remote file, accessible through tramp or efs.
1689 Remote files most likely should be visited through Emacs
1690 because external applications cannot handle such paths.
1691 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1692 so all files Emacs knows how to handle. Using this with
1693 command `emacs' will open most files in Emacs. Beware that this
1694 will also open html files inside Emacs, unless you add
1696 t Default for files not matched by any of the other options.
1697 `system' The system command to open files, like `open' on Windows
1698 and Mac OS X, and mailcap under GNU/Linux. This is the command
1699 that will be selected if you call `C-c C-o' with a double
1702 Possible values for the command are:
1703 `emacs' The file will be visited by the current Emacs process.
1704 `default' Use the default application for this file type, which is the
1705 association for t in the list, most likely in the system-specific
1706 part.
1707 This can be used to overrule an unwanted setting in the
1708 system-specific variable.
1710 This command is specified by the entry whose car is `system'.
1711 Most likely, the system-specific version of this variable
1712 does define this command, but you can overrule/replace it
1713 here.
1714 string A command to be executed by a shell; %s will be replaced
1715 by the path to the file.
1716 sexp A Lisp form which will be evaluated. The file path will
1717 be available in the Lisp variable `file'.
1718 For more examples, see the system specific constants
1719 `org-file-apps-defaults-macosx'
1720 `org-file-apps-defaults-windowsnt'
1721 `org-file-apps-defaults-gnu'."
1731 auto-mode))
1742 "Options concerning refiling entries in Org-mode."
1747 "Directory with org files.
1748 This is just a default location to look for Org files. There is no need
1749 at all to put your files into this directory. It is only used in the
1750 following situations:
1752 1. When a remember template specifies a target file that is not an
1753 absolute path. The path will then be interpreted relative to
1754 `org-directory'
1755 2. When a remember note is filed away in an interactive way (when exiting the
1756 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1757 with `org-directory' as the default path."
1763 "Default target for storing notes.
1764 Used as a fall back file for org-remember.el and org-capture.el, for
1765 templates that do not specify a target file."
1770 file))
1773 "The default interface to be used for `org-goto'.
1774 Allowed values are:
1775 outline The interface shows an outline of the relevant file
1776 and the correct heading is found by moving through
1777 the outline or by searching with incremental search.
1778 outline-path-completion Headlines in the current buffer are offered via
1779 completion. This is the interface also used by
1780 the refile command."
1787 "Maximum target level when running `org-goto' with refile interface."
1792 "Non-nil means store new notes at the beginning of a file or entry.
1793 When nil, new notes will be filed to the end of a file or entry.
1794 This can also be a list with cons cells of regular expressions that
1795 are matched against file names, and values."
1805 "Information to record when a task is refiled.
1807 Possible values are:
1809 nil Don't add anything
1810 time Add a time stamp to the task
1811 note Prompt for a note and add it with template `org-log-note-headings'
1813 This option can also be set with on a per-file-basis with
1815 #+STARTUP: nologrefile
1816 #+STARTUP: logrefile
1817 #+STARTUP: lognoterefile
1819 You can have local logging settings for a subtree by setting the LOGGING
1820 property to one or more of these keywords.
1822 When bulk-refiling from the agenda, the value `note' is forbidden and
1823 will temporarily be changed to `time'."
1833 This is list of cons cells. Each cell contains:
1834 - a specification of the files to be considered, either a list of files,
1835 or a symbol whose function or variable value will be used to retrieve
1836 a file name or a list of file names. If you use `org-agenda-files' for
1837 that, all agenda files will be scanned for targets. Nil means consider
1838 headings in the current buffer.
1839 - A specification of how to find candidate refile targets. This may be
1840 any of:
1842 This tag has to be present in all target headlines, inheritance will
1843 not be considered.
1845 todo keyword.
1847 headlines that are refiling targets.
1848 - a cons cell (:level . N). Any headline of level N is considered a target.
1849 Note that, when `org-odd-levels-only' is set, level corresponds to
1850 order in hierarchy, not to the number of stars.
1851 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1852 Note that, when `org-odd-levels-only' is set, level corresponds to
1853 order in hierarchy, not to the number of stars.
1855 You can set the variable `org-refile-target-verify-function' to a function
1856 to verify each headline found by the simple criteria above.
1858 When this variable is nil, all top-level headlines in the current buffer
1859 are used, equivalent to the value `((nil . (:level . 1))'."
1875 "Function to verify if the headline at point should be a refile target.
1876 The function will be called without arguments, with point at the
1877 beginning of the headline. It should return t and leave point
1878 where it is if the headline is a valid target for refiling.
1880 If the target should not be selected, the function must return nil.
1881 In addition to this, it may move point to a place from where the search
1882 should be continued. For example, the function may decide that the entire
1883 subtree of the current entry should be excluded and move point to the end
1884 of the subtree."
1889 "Non-nil means cache refile targets to speed up the process.
1890 The cache for a particular file will be updated automatically when
1891 the buffer has been killed, or when any of the marker used for flagging
1892 refile targets no longer points at a live buffer.
1893 If you have added new entries to a buffer that might themselves be targets,
1894 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1895 find that easier, `C-u C-u C-u C-c C-w'."
1900 "Non-nil means provide refile targets as paths.
1901 So a level 3 headline will be available as level1/level2/level3.
1903 When the value is `file', also include the file name (without directory)
1904 into the path. In this case, you can also stop the completion after
1905 the file name, to get entries inserted as top level in the file.
1907 When `full-file-path', include the full file path."
1916 "Non-nil means complete the outline path in hierarchical steps.
1917 When Org-mode uses the refile interface to select an outline path
1918 \(see variable `org-refile-use-outline-path'), the completion of
1919 the path can be done is a single go, or if can be done in steps down
1920 the headline hierarchy. Going in steps is probably the best if you
1921 do not use a special completion package like `ido' or `icicles'.
1922 However, when using these packages, going in one step can be very
1923 fast, while still showing the whole path to the entry."
1928 "Non-nil means allow to create new nodes as refile targets.
1930 of an existing node. When the value of this variable is `confirm',
1931 new node creation must be confirmed by the user (recommended)
1932 When nil, the completion must match an existing entry.
1934 Note that, if the new heading is not seen by the criteria
1935 listed in `org-refile-targets', multiple instances of the same
1936 heading would be created by trying again to file under the new
1937 heading."
1945 "Options concerning TODO items in Org-mode."
1950 "Options concerning Progress logging in Org-mode."
1955 '(
1958 "The available interpretation symbols for customizing `org-todo-keywords'.
1962 "List of TODO entry keyword sequences and their interpretation.
1965 Each sequence starts with a symbol, either `sequence' or `type',
1966 indicating if the keywords should be interpreted as a sequence of
1967 action steps, or as different types of TODO items. The first
1968 keywords are states requiring action - these states will select a headline
1969 for inclusion into the global TODO list Org-mode produces. If one of
1972 the last keyword is treated as the only DONE state of the sequence.
1975 additional state where no keyword is present. For details about this
1976 cycling, see the manual.
1978 TODO keywords and interpretation can also be set on a per-file basis with
1979 the special #+SEQ_TODO and #+TYP_TODO lines.
1981 Each keyword can optionally specify a character for fast state selection
1982 \(in combination with the variable `org-use-fast-todo-selection')
1983 and specifiers for state change logging, using the same syntax
1986 indicates to record a time stamp each time this state is selected.
1988 Each keyword may also specify if a timestamp or a note should be
1989 recorded when entering or leaving the state, by adding additional
1990 characters in the parenthesis after the keyword. This looks like this:
1992 record only the time of the state change. With X and Y being either
1994 Y when leaving the state if and only if the *target* state does not
1995 define X. You may omit any of the fast-selection key or X or /Y,
1996 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1998 For backward compatibility, this variable may also be just a list
1999 of keywords - in this case the interpretation (sequence or type) will be
2000 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2010 ;;Quick and dirty way to see
2011 ;;`org-todo-interpretations'. This takes the
2012 ;;place of item arguments
2013 :convert-widget
2020 org-todo-interpretation-widgets))
2021 widget))
2052 "Controls how TODO keywords are interpreted.
2053 This variable is in principle obsolete and is only used for
2054 backward compatibility, if the interpretation of todo keywords is
2055 not given already in `org-todo-keywords'. See that variable for
2056 more information."
2063 "Non-nil means use the fast todo selection scheme with C-c C-t.
2064 This variable describes if and under what circumstances the cycling
2065 mechanism for TODO keywords will be replaced by a single-key, direct
2066 selection scheme.
2068 When nil, fast selection is never used.
2070 When the symbol `prefix', it will be used when `org-todo' is called with
2071 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2072 in an agenda buffer.
2074 When t, fast selection is used by default. In this case, the prefix
2075 argument forces cycling instead.
2077 In all cases, the special interface is only used if access keys have actually
2078 been assigned by the user, i.e. if keywords in the configuration are followed
2079 by a letter in parenthesis, like TODO(t)."
2087 "Non-nil means update todo statistics after insert and toggle.
2088 ALL-HEADLINES means update todo statistics by including headlines
2089 with no TODO keyword as well, counting them as not done.
2090 A list of TODO keywords means the same, but skip keywords that are
2091 not in this list.
2093 When this is set, todo statistics is updated in the parent of the
2094 current entry each time a todo state is changed."
2104 "Non-nil means TODO statistics covers just direct children.
2105 When nil, all entries in the subtree are considered.
2106 This has only an effect if `org-provide-todo-statistics' is set.
2107 To set this to nil for only a single subtree, use a COOKIE_DATA
2113 "Hook which is run after the state of a TODO item was changed.
2114 The new state (a string with a TODO keyword, or nil) is available in the
2115 Lisp variable `state'."
2120 "Hook for functions that are allowed to block a state change.
2122 Each function gets as its single argument a property list, see
2123 `org-trigger-hook' for more information about this list.
2125 If any of the functions in this hook returns nil, the state change
2129 "Hook for functions that are triggered by a state change.
2131 Each function gets as its single argument a property list with at least
2132 the following elements:
2134 (:type type-of-change :position pos-at-entry-start
2135 :from old-state :to new-state)
2137 Depending on the type, more properties may be present.
2139 This mechanism is currently implemented for:
2141 TODO state changes
2142 ------------------
2143 :type todo-state-change
2144 :from previous state (keyword as a string), or nil, or a symbol
2145 'todo' or 'done', to indicate the general type of state.
2149 "Non-nil means undone TODO entries will block switching the parent to DONE.
2150 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2151 be blocked if any prior sibling is not yet done.
2152 Finally, if the parent is blocked because of ordered siblings of its own,
2153 the child will also be blocked.
2154 This variable needs to be set before org.el is loaded, and you need to
2155 restart Emacs after a change to make the change effective. The only way
2156 to change is while Emacs is running is through the customize interface."
2168 "Non-nil means unchecked boxes will block switching the parent to DONE.
2169 When this is nil, checkboxes have no influence on switching TODO states.
2170 When non-nil, you first need to check off all check boxes before the TODO
2171 entry can be switched to DONE.
2172 This variable needs to be set before org.el is loaded, and you need to
2173 restart Emacs after a change to make the change effective. The only way
2174 to change is while Emacs is running is through the customize interface."
2186 "Non-nil means inserting a TODO heading is treated as state change.
2188 logging will apply if appropriate. When nil, the new TODO item will
2189 be inserted directly, and no logging will take place."
2194 "Non-nil means switching TODO states with S-cursor counts as state change.
2195 This is the default behavior. However, setting this to nil allows a
2196 convenient way to select a TODO state and bypass any logging associated
2197 with that."
2202 "Tag changes that should be triggered by TODO state changes.
2203 This is a list. Each entry is
2205 (state-change (tag . flag) .......)
2207 State-change can be a string with a state, and empty string to indicate the
2208 state that has no TODO keyword, or it can be one of the symbols `todo'
2209 or `done', meaning any not-done or done state, respectively."
2223 "Information to record when a task moves to the DONE state.
2225 Possible values are:
2227 nil Don't add anything, just change the keyword
2228 time Add a time stamp to the task
2229 note Prompt for a note and add it with template `org-log-note-headings'
2231 This option can also be set with on a per-file-basis with
2233 #+STARTUP: nologdone
2234 #+STARTUP: logdone
2235 #+STARTUP: lognotedone
2237 You can have local logging settings for a subtree by setting the LOGGING
2238 property to one or more of these keywords."
2246 ;; Normalize old uses of org-log-done.
2253 "Information to record when the scheduling date of a tasks is modified.
2255 Possible values are:
2257 nil Don't add anything, just change the date
2258 time Add a time stamp to the task
2259 note Prompt for a note and add it with template `org-log-note-headings'
2261 This option can also be set with on a per-file-basis with
2263 #+STARTUP: nologreschedule
2264 #+STARTUP: logreschedule
2265 #+STARTUP: lognotereschedule"
2274 "Information to record when the deadline date of a tasks is modified.
2276 Possible values are:
2278 nil Don't add anything, just change the date
2279 time Add a time stamp to the task
2280 note Prompt for a note and add it with template `org-log-note-headings'
2282 This option can also be set with on a per-file-basis with
2284 #+STARTUP: nologredeadline
2285 #+STARTUP: logredeadline
2286 #+STARTUP: lognoteredeadline
2288 You can have local logging settings for a subtree by setting the LOGGING
2289 property to one or more of these keywords."
2298 "Non-nil means record a note when clocking out of an item.
2299 This can also be configured on a per-file basis by adding one of
2300 the following lines anywhere in the buffer:
2302 #+STARTUP: lognoteclock-out
2303 #+STARTUP: nolognoteclock-out"
2309 "Non-nil means the CLOSED time stamp will contain date and time.
2310 When nil, only the date will be recorded."
2324 "Headings for notes added to entries.
2325 The value is an alist, with the car being a symbol indicating the note
2326 context, and the cdr is the heading to be used. The heading may also be the
2327 empty string.
2328 %t in the heading will be replaced by a time stamp.
2329 %T will be an active time stamp instead the default inactive one
2330 %s will be replaced by the new TODO state, in double quotes.
2331 %S will be replaced by the old TODO state, in double quotes.
2332 %u will be replaced by the user name.
2333 %U will be replaced by the full user name.
2335 In fact, it is not a good idea to change the `state' entry, because
2336 agenda log mode depends on the format of these entries."
2342 "Heading when changing todo state (todo sequence only)"
2356 "Non-nil means insert state change notes and time stamps into a drawer.
2357 When nil, state changes notes will be inserted after the headline and
2358 any scheduling and clock lines, but not inside a drawer.
2360 The value of this variable should be the name of the drawer to use.
2361 LOGBOOK is proposed at the default drawer for this purpose, you can
2362 also set this to a string to define the drawer of your choice.
2366 If this variable is set, `org-log-state-notes-insert-after-drawers'
2367 will be ignored.
2369 You can set the property LOG_INTO_DRAWER to overrule this setting for
2370 a subtree."
2382 "Return the value of `org-log-into-drawer', but let properties overrule.
2383 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2384 used instead of the default value."
2392 "Non-nil means insert state change notes after any drawers in entry.
2393 Only the drawers that *immediately* follow the headline and the
2394 deadline/scheduled line are skipped.
2395 When nil, insert notes right after the heading and perhaps the line
2396 with deadline/scheduling if present.
2398 This variable will have no effect if `org-log-into-drawer' is
2399 set."
2405 "Non-nil means the latest state note will be directly after heading.
2406 When nil, the state change notes will be ordered according to time."
2412 "The TODO state to which a repeater should return the repeating task.
2413 By default this is the first task in a TODO sequence, or the previous state
2414 in a TODO_TYP set. But you can specify another task here.
2415 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2421 "Non-nil means record moving through the DONE state when triggering repeat.
2422 An auto-repeating task is immediately switched back to TODO when
2425 record a closing note, there will be no record of the task moving
2426 through DONE. This variable forces taking a note anyway.
2428 nil Don't force a record
2429 time Record a time stamp
2430 note Record a note
2432 This option can also be set with on a per-file-basis with
2434 #+STARTUP: logrepeat
2435 #+STARTUP: lognoterepeat
2436 #+STARTUP: nologrepeat
2438 You can have local logging settings for a subtree by setting the LOGGING
2439 property to one or more of these keywords."
2449 "Priorities in Org-mode."
2454 "Non-nil means priority commands are active.
2455 When nil, these commands will be disabled, so that you never accidentally
2456 set a priority."
2461 "The highest priority of TODO items. A character like ?A, ?B etc.
2462 Must have a smaller ASCII number than `org-lowest-priority'."
2467 "The lowest priority of TODO items. A character like ?A, ?B etc.
2468 Must have a larger ASCII number than `org-highest-priority'."
2473 "The default priority of TODO items.
2474 This is the priority an item get if no explicit priority is given."
2479 "Non-nil means start with default priority when starting to cycle.
2480 When this is nil, the first step in the cycle will be (depending on the
2481 command used) one higher or lower that the default priority."
2486 "Function to extract the priority from a string.
2487 The string is normally the headline. If this is nil Org computes the
2488 priority from the priority cookie like [#A] in the headline. It returns
2489 an integer, increasing by 1000 for each priority level.
2490 The user can set a different function here, which should take a string
2491 as an argument and return the numeric priority."
2496 "Options concerning time stamps and deadlines in Org-mode."
2501 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2502 When nil, these labeled time stamps are forces into the second line of an
2503 entry, just after the headline. When scheduling from the global TODO list,
2504 the time stamp will always be forced into the second line."
2509 "Formats for `format-time-string' which are used for time stamps.
2513 "Number of minutes to round time stamps to.
2514 These are two values, the first applies when first creating a time stamp.
2515 The second applies when changing it with the commands `S-up' and `S-down'.
2516 When changing the time stamp, this means that it will change in steps
2517 of N minutes, as given by the second value.
2519 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2520 numbers should be factors of 60, so for example 5, 10, 15.
2522 When this is larger than 1, you can still force an exact time stamp by using
2523 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2524 and by using a prefix arg to `S-up/down' to specify the exact number
2525 of minutes to shift."
2535 ;; Normalize old customizations of this variable.
2539 org-time-stamp-rounding-minutes)))
2542 "Non-nil means overlay custom formats over all time stamps.
2543 The formats are defined through the variable `org-time-stamp-custom-formats'.
2544 To turn this on on a per-file basis, insert anywhere in the file:
2545 #+STARTUP: customtime"
2553 "Custom formats for time stamps. See `format-time-string' for the syntax.
2554 These are overlayed over the default ISO format if the variable
2555 `org-display-custom-times' is set. Time like %H:%M should be at the
2556 end of the second format. The custom formats are also honored by export
2557 commands, if custom time display is turned on at the time of export."
2562 "Get the right format for a time string."
2567 f)))
2570 "The format string used when creating CLOCKSUM lines.
2571 This is also used when org-mode generates a time duration."
2577 org-mode generates a time duration."
2582 "The format string used when creating CLOCKSUM lines, or when
2583 org-mode generates a time duration."
2588 "No. of days before expiration during which a deadline becomes active.
2589 This variable governs the display in sparse trees and in the agenda.
2590 When 0 or negative, it means use this number (the absolute value of it)
2591 even if a deadline has a different individual lead time specified.
2593 Custom commands can set this variable in the options section."
2599 "Non-nil means assume future for incomplete date input from user.
2600 This affects the following situations:
2601 1. The user gives a month but not a year.
2604 2. The user gives a day, but no month.
2607 it will be considered as *this* month.
2609 If you set this variable to the symbol `time', then also the following
2610 will work:
2612 3. If the user gives a time, but no day. If the time is before now,
2613 to will be interpreted as tomorrow.
2615 Currently none of this works for ISO week specifications.
2617 When this option is nil, the current day, month and year will always be
2618 used as defaults.
2620 See also `org-agenda-jump-prefer-future'."
2628 "Should the agenda jump command prefer the future for incomplete dates?
2629 The default is to do the same as configured in `org-read-date-prefer-future'.
2630 But you can also set a deviating value here.
2631 This may t or nil, or the symbol `org-read-date-prefer-future'."
2636 org-read-date-prefer-future)
2641 "Non-nil means display current interpretation of date prompt live.
2642 This display will be in an overlay, in the minibuffer."
2647 "Non-nil means pop up a calendar when prompting for a date.
2648 In the calendar, the date can be selected with mouse-1. However, the
2649 minibuffer will also be active, and you can simply enter the date as well.
2650 When nil, only the minibuffer will be available."
2658 "Hook to be used to set up keys for the date/time interface.
2659 Add key definitions to `minibuffer-local-map', which will be a temporary
2660 copy."
2665 "The hour when your day really ends. Must be an integer.
2666 This has influence for the following applications:
2668 the time given here, the day recognized as TODAY is actually yesterday.
2669 - When a date is read from the user and it is still before the time given
2670 here, the current date and time will be assumed to be yesterday, 23:59.
2671 Also, timestamps inserted in remember templates follow this rule.
2673 IMPORTANT: This is a feature whose implementation is and likely will
2674 remain incomplete. Really, it is only here because past midnight seems to
2675 be the favorite working time of John Wiegley :-)"
2680 "Non-nil means S-down will increase the time in a time stamp.
2681 When nil, S-up will increase."
2686 "Non-nil means make the calendar window follow timestamp changes.
2687 When a timestamp is modified and the calendar window is visible, it will be
2688 moved to the new date."
2693 "Options concerning tags in Org-mode."
2698 "List of tags allowed in Org-mode files.
2699 When this list is nil, Org-mode will base TAG input on what is already in the
2700 buffer.
2701 The value of this variable is an alist, the car of each entry must be a
2702 keyword as a string, the cdr may be a character that is used to select
2703 that tag through the fast-tag-selection interface.
2704 See the manual for details."
2719 "List of tags that will always appear in all Org-mode files.
2720 This is in addition to any in buffer settings or customizations
2721 of `org-tag-alist'.
2722 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2723 The value of this variable is an alist, the car of each entry must be a
2724 keyword as a string, the cdr may be a character that is used to select
2725 that tag through the fast-tag-selection interface.
2726 See the manual for details.
2727 To disable these tags on a per-file basis, insert anywhere in the file:
2728 #+STARTUP: noptag"
2739 "If non-nil, always offer completion for all tags of all agenda files.
2740 Instead of customizing this variable directly, you might want to
2741 set it locally for capture buffers, because there no list of
2742 tags in that file can be created dynamically (there are none).
2744 (add-hook 'org-capture-mode-hook
2745 (lambda ()
2746 (set (make-local-variable
2747 'org-complete-tags-always-offer-all-agenda-tags)
2748 t)))"
2753 "List of tags that can be inherited by all entries in the file.
2754 The tags will be inherited if the variable `org-use-tag-inheritance'
2755 says they should be.
2759 "Non-nil means use fast tag selection scheme.
2760 This is a special interface to select and deselect tags with single keys.
2761 When nil, fast selection is never used.
2762 When the symbol `auto', fast selection is used if and only if selection
2763 characters for tags have been configured, either through the variable
2764 `org-tag-alist' or through a #+TAGS line in the buffer.
2765 When t, fast selection is always used and selection keys are assigned
2766 automatically if necessary."
2774 "Non-nil means fast tag selection exits after first change.
2775 When nil, you have to press RET to exit it.
2776 During fast tag selection, you can toggle this flag with `C-c'.
2777 This variable can also have the value `expert'. In this case, the window
2778 displaying the tags menu is not even shown, until you press C-c again."
2786 "Non-nil means fast tags selection interface will also offer TODO states.
2790 "The column to which tags should be indented in a headline.
2791 If this number is positive, it specifies the column. If it is negative,
2792 it means that the tags should be flushright to that column. For example,
2793 -80 works well for a normal 80 character screen."
2798 "Non-nil means realign tags after pro/demotion of TODO state change.
2799 These operations change the length of a headline and therefore shift
2800 the tags around. With this options turned on, after each such operation
2801 the tags are again aligned to `org-tags-column'."
2806 "Non-nil means tags in levels apply also for sublevels.
2807 When nil, only the tags directly given in a specific line apply there.
2808 This may also be a list of tags that should be inherited, or a regexp that
2809 matches tags that should be inherited. Additional control is possible
2810 with the variable `org-tags-exclude-from-inheritance' which gives an
2811 explicit list of tags to be excluded from inheritance., even if the value of
2812 `org-use-tag-inheritance' would select it for inheritance.
2814 If this option is t, a match early-on in a tree can lead to a large
2815 number of matches in the subtree when constructing the agenda or creating
2816 a sparse tree. If you only want to see the first match in a tree during
2817 a search, check out the variable `org-tags-match-list-sublevels'."
2826 "List of tags that should never be inherited.
2827 This is a way to exclude a few tags from inheritance. For way to do
2828 the opposite, to actively allow inheritance for selected tags,
2829 see the variable `org-use-tag-inheritance'."
2834 "Check if TAG is one that should be inherited."
2846 "Non-nil means list also sublevels of headlines matching a search.
2847 This variable applies to tags/property searches, and also to stuck
2848 projects because this search is based on a tags match as well.
2850 When set to the symbol `indented', sublevels are indented with
2851 leading dots.
2853 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2854 the sublevels of a headline matching a tag search often also match
2855 the same search. Listing all of them can create very long lists.
2856 Setting this variable to nil causes subtrees of a match to be skipped.
2858 This variable is semi-obsolete and probably should always be true. It
2859 is better to limit inheritance to certain tags using the variables
2860 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2868 "When set, tags are sorted using this function as a comparator."
2884 "Options concerning properties in Org-mode."
2889 "How property key/value pairs should be formatted by `indent-line'.
2890 When `indent-line' hits a property definition, it will format the line
2891 according to this format, mainly to make sure that the values are
2892 lined-up with respect to each other."
2897 "Non-nil means properties apply also for sublevels.
2899 This setting is chiefly used during property searches. Turning it on can
2900 cause significant overhead when doing a search, which is why it is not
2901 on by default.
2903 When nil, only the properties directly given in the current entry count.
2904 When t, every property is inherited. The value may also be a list of
2905 properties that should have inheritance, or a regular expression matching
2906 properties that should be inherited.
2908 However, note that some special properties use inheritance under special
2909 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2911 for valid values of a property.
2913 Note for programmers:
2914 When querying an entry with `org-entry-get', you can control if inheritance
2915 should be used. By default, `org-entry-get' looks only at the local
2916 properties. You can request inheritance by setting the inherit argument
2917 to t (to force inheritance) or to `selective' (to respect the setting
2918 in this variable)."
2927 "Check if PROPERTY is one that should be inherited."
2938 "The default column format, if no other format has been defined.
2939 This variable can be set on the per-file basis by inserting a line
2941 #+COLUMNS: %25ITEM ....."
2946 "The ellipses to be used when a field in column view is truncated.
2947 When this is the empty string, as many characters as possible are shown,
2948 but then there will be no visual indication that the field has been truncated.
2949 When this is a string of length N, the last N characters of a truncated
2950 field are replaced by this string. If the column is narrower than the
2951 ellipses string, only part of the ellipses string will be shown."
2956 "Function that modifies values for display in column view.
2957 For example, it can be used to cut out a certain part from a time stamp.
2958 The function must take 2 arguments:
2960 column-title The title of the column (*not* the property name)
2961 value The value that should be modified.
2963 The function should return the value that should be displayed,
2964 or nil if the normal value should be used."
2969 "The property that is being used to keep track of effort estimates.
2970 Effort estimates given in this property need to have the format H:MM."
2978 "List of property/value pairs that can be inherited by any entry.
2980 These are fixed values, for the preset properties. The user variable
2981 that can be used to add to this list is `org-global-properties'.
2983 The entries in this list are cons cells where the car is a property
2984 name and cdr is a string with the value. If the value represents
2989 "List of property/value pairs that can be inherited by any entry.
2991 This list will be combined with the constant `org-global-properties-fixed'.
2993 The entries in this list are cons cells where the car is a property
2994 name and cdr is a string with the value.
2996 You can set buffer-local values for the same purpose in the variable
2997 `org-file-properties' this by adding lines like
2999 #+PROPERTY: NAME VALUE"
3006 "List of property/value pairs that can be inherited by any entry.
3007 Valid for the current buffer.
3012 "Options concerning agenda views in Org-mode."
3017 "Variable used by org files to set a category for agenda display.
3018 Such files should use a file variable to set it, for example
3022 or contain a special line
3024 #+CATEGORY: ELisp
3026 If the file does not specify a category, then file's base name
3032 "The files to be used for agenda display.
3036 If an entry is a directory, all files in that directory that are matched by
3037 `org-agenda-file-regexp' will be part of the file list.
3039 If the value of the variable is not a list but a single file name, then
3040 the list of agenda files is actually stored and maintained in that file, one
3041 agenda file per line. In this file paths can be given relative to
3042 `org-directory'. Tilde expansion and environment variable substitution
3043 are also made."
3050 "Regular expression to match files for `org-agenda-files'.
3051 If any element in the list in that variable contains a directory instead
3052 of a normal file, all files in that directory that are matched by this
3053 regular expression will be included."
3058 "List of extra files to be searched by text search commands.
3059 These files will be search in addition to the agenda files by the
3060 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3061 Note that these files will only be searched for text search commands,
3062 not for the other agenda views like todo lists, tag searches or the weekly
3063 agenda. This variable is intended to list notes and possibly archive files
3064 that should also be searched by these two commands.
3065 In fact, if the first element in the list is the symbol `agenda-archives',
3066 than all archive files of all agenda files will be added to the search
3067 scope."
3078 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3079 A nil value means to remove them, after a query, from the list."
3084 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3085 The command `org-calendar-goto-agenda' will be bound to this key. The
3086 default is the character `c' because then `c' can be used to switch back and
3087 forth between agenda and calendar."
3092 "The key to be installed in `calendar-mode-map' for agenda-action.
3093 The command `org-agenda-action' will be bound to this key. The
3094 default is the character `k' because we use the same key in the agenda."
3099 "The key to be installed in `calendar-mode-map' for adding diary entries.
3100 This option is irrelevant until `org-agenda-diary-file' has been configured
3101 to point to an Org-mode file. When that is the case, the command
3102 `org-agenda-diary-entry' will be bound to the key given here, by default
3103 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3104 if you want to continue doing this, you need to change this to a different
3105 key."
3110 "File to which to add new entries with the `i' key in agenda and calendar.
3111 When this is the symbol `diary-file', the functionality in the Emacs
3112 calendar will be used to add entries to the `diary-file'. But when this
3113 points to a file, `org-agenda-diary-entry' will be used instead."
3129 org-calendar-insert-diary-entry-key
3133 "Options for embedding LaTeX code into Org-mode."
3141 "Options for creating images from LaTeX fragments.
3142 This is a property list with the following properties:
3144 `default' means use the foreground of the default face.
3146 `default' means use the background of the default face.
3147 :scale a scaling factor for the size of the images, to get more pixels
3148 :html-foreground, :html-background, :html-scale
3149 the same numbers for HTML export.
3150 :matchers a list indicating which matchers should be used to
3151 find LaTeX fragments. Valid members of this list are:
3162 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3163 When nil, just push out a message."
3172 \[PACKAGES]
3173 \[DEFAULT-PACKAGES]
3174 % The settings below are copied from fullpage.sty
3187 "The document header used for processing LaTeX fragments.
3188 It is imperative that this header make sure that no page number
3189 appears on the page. The package defined in the variables
3190 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3192 will be appended."
3199 "Set the packages alist and make sure it has 3 elements per entry."
3203 x))
3204 val)))
3208 "Get the packages alist and make sure it has 3 elements per entry."
3212 x))
3215 ;; The following variables are defined here because is it also used
3216 ;; when formatting latex fragments. Originally it was part of the
3217 ;; LaTeX exporter, which is why the name includes "export".
3234 )
3235 "Alist of default packages to be inserted in the header.
3236 Change this only if one of the packages here causes an incompatibility
3237 with another package you are using.
3238 The packages in this list are needed by one part or another of Org-mode
3239 to function properly.
3241 - inputenc, fontenc: for basic font and character selection
3242 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3243 for interpreting the entities in `org-entities'. You can skip some of these
3244 packages if you don't use any of the symbols in it.
3245 - graphicx: for including images
3246 - float, wrapfig: for figure placement
3247 - longtable: for long tables
3248 - hyperref: for cross references
3250 Therefore you should not modify this variable unless you know what you
3251 are doing. The one reason to change it anyway is that you might be loading
3252 some other package that conflicts with one of the default packages.
3254 If SNIPPET-FLAG is t, the package also needs to be included when
3255 compiling LaTeX snippets into images for inclusion into HTML."
3268 "Alist of packages to be inserted in every LaTeX header.
3269 These will be inserted after `org-export-latex-default-packages-alist'.
3271 SNIPPET-FLAG, when t, indicates that this package is also needed when
3272 turning LaTeX snippets into images for inclusion into HTML.
3273 Make sure that you only list packages here which:
3274 - you want in every file
3275 - do not conflict with the default packages in
3276 `org-export-latex-default-packages-alist'
3277 - do not conflict with the setup in `org-format-latex-header'."
3291 "Settings for Org-mode appearance."
3296 "Non-nil means fontify only the stars in each headline.
3297 When nil, the entire headline is fontified.
3298 Changing it requires restart of `font-lock-mode' to become effective
3299 also in regions already fontified."
3304 "Non-nil means hide the first N-1 stars in a headline.
3305 This works by using the face `org-hide' for these stars. This
3306 face is white for a light background, and black for a dark
3307 background. You may have to customize the face `org-hide' to
3308 make this work.
3309 Changing it requires restart of `font-lock-mode' to become effective
3310 also in regions already fontified.
3311 You may also set this on a per-file basis by adding one of the following
3312 lines to the buffer:
3314 #+STARTUP: hidestars
3315 #+STARTUP: showstars"
3320 "List of symbols corresponding to keywords to be hidden the org buffer.
3321 For example, a value '(title) for this list will make the document's title
3322 appear in the buffer without the initial #+TITLE: keyword."
3330 "Non-nil means change the face of a headline if it is marked DONE.
3331 Normally, only the TODO/DONE keyword indicates the state of a headline.
3332 When this is non-nil, the headline after the keyword is set to the
3333 `org-headline-done' as an additional indication."
3338 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3339 Changing this variable requires a restart of Emacs to take effect."
3344 "Non-nil means fontify the whole line for headings.
3345 This is useful when setting a background color for the
3346 org-level-* faces."
3351 "Non-nil means fontify what is treated specially by the exporters."
3356 "Non-nil mean font-lock should hide the emphasis marker characters."
3361 "Non-nil means show entities as UTF8 characters.
3367 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3372 "Regular expression for matching emphasis.
3373 After a match, the match groups contain these elements:
3374 0 The match of the full regular expression, including the characters
3375 before and after the proper match
3376 1 The character before the proper match, or empty at beginning of line
3377 2 The proper match, including the leading and trailing markers
3378 3 The leading marker like * or /, indicating the type of highlighting
3379 4 The text between the emphasis markers, not including the markers
3386 "Set variable and compute the emphasis regular expression."
3390 org-emphasis-alist org-emphasis-regexp-components)
3402 ;; make sure special characters appear at the right position in the class
3414 ;; Make the regexp
3422 body1
3434 body1
3442 "Components used to build the regular expression for emphasis.
3443 This is a list with five entries. Terminology: In an emphasis string
3447 specify what is allowed/forbidden in each part:
3449 pre Chars allowed as prematch. Beginning of line will be allowed too.
3450 post Chars allowed as postmatch. End of line will be allowed too.
3451 border The chars *forbidden* as border characters.
3453 non-shy groups here, and don't allow newline here.
3454 newline The maximum number of newlines allowed in an emphasis exp.
3456 Use customize to modify this, or restart Emacs after changing it."
3475 )
3476 "Special syntax for emphasized text.
3477 Text starting and ending with a special character will be emphasized, for
3478 example *bold*, _underlined_ and /italic/. This variable sets the marker
3479 characters, the face to be used by font-lock for highlighting in Org-mode
3480 Emacs buffers, and the HTML tags to be used for this.
3481 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3482 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3483 Use customize to modify this, or restart Emacs after changing it."
3498 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3501 ;;; Miscellaneous options
3504 "Completion in Org-mode."
3509 "Non-nil means use ido completion wherever possible.
3510 Note that `ido-mode' must be active for this variable to be relevant.
3511 If you decide to turn this variable on, you might well want to turn off
3512 `org-outline-path-complete-in-steps'.
3513 See also `org-completion-use-iswitchb'."
3518 "Non-nil means use iswitchb completion wherever possible.
3519 Note that `iswitchb-mode' must be active for this variable to be relevant.
3520 If you decide to turn this variable on, you might well want to turn off
3521 `org-outline-path-complete-in-steps'.
3522 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3528 Normal means, no org-mode-specific context."
3532 ;;; Functions and variables from their packages
3533 ;; Declared here to avoid compiler warnings
3535 ;; XEmacs only
3541 ;; Emacs only
3544 ;; Various packages
3562 org-format-agenda-item "org-agenda"
3593 ;;; Autoload and prepare some org modules
3595 ;; Some table stuff that needs to be defined here, because it is used
3596 ;; by the functions setting up org-mode or checking for table context.
3609 "Detect the first line outside a table when searching from within it.
3612 ;; Autoload the functions in org-table.el that are needed by functions here.
3617 org-table-convert org-table-convert-region org-table-copy-down
3618 org-table-copy-region org-table-create
3619 org-table-create-or-convert-from-region
3620 org-table-create-with-table.el org-table-current-dline
3621 org-table-cut-region org-table-delete-column org-table-edit-field
3622 org-table-edit-formulas org-table-end org-table-eval-formula
3623 org-table-export org-table-field-info
3624 org-table-get-stored-formulas org-table-goto-column
3625 org-table-hline-and-move org-table-import org-table-insert-column
3626 org-table-insert-hline org-table-insert-row org-table-iterate
3627 org-table-justify-field-maybe org-table-kill-row
3628 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3629 org-table-move-column org-table-move-column-left
3630 org-table-move-column-right org-table-move-row
3631 org-table-move-row-down org-table-move-row-up
3632 org-table-next-field org-table-next-row org-table-paste-rectangle
3633 org-table-previous-field org-table-recalculate
3634 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3635 org-table-toggle-coordinate-overlays
3636 org-table-toggle-formula-debugger org-table-wrap-region
3637 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3638 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3639 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3642 "Return t if the cursor is inside an org-type table.
3643 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3648 org-table-line-regexp)))
3649 nil))
3653 "Return t if and only if we are at a table.el table."
3659 "If there is a table.el table nearby, recognize it and move into it."
3665 nil
3675 t
3680 t)
3681 nil)
3682 nil))
3685 "Return t if the cursor is inside a hline in a table."
3690 nil))
3695 "Apply FUNCTION to the start of all tables in the buffer."
3711 ;; Declare and autoload functions from org-exp.el & Co
3719 org-insert-export-options-template
3720 org-table-clean-before-export))
3723 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3724 org-export-region-as-ascii))
3727 org-replace-region-by-latex org-export-region-as-latex
3728 org-export-as-latex org-export-as-pdf
3729 org-export-as-pdf-and-open))
3732 org-export-as-html-batch org-export-as-html-to-buffer
3733 org-replace-region-by-html org-export-region-as-html
3734 org-export-as-html))
3737 org-replace-region-by-docbook org-export-region-as-docbook
3738 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3739 org-export-as-docbook))
3742 org-export-icalendar-all-agenda-files
3743 org-export-icalendar-combine-agenda-files))
3747 ;; Declare and autoload functions from org-agenda.el
3752 org-todo-list org-tags-view org-agenda-list-stuck-projects
3753 org-diary org-agenda-to-appt
3754 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3756 ;; Autoload org-remember
3761 org-remember-apply-template org-remember org-remember-handler)))
3766 org-capture-import-remember-templates)))
3768 ;; Autoload org-clock.el
3783 "Return non-nil if clock is currently running.
3784 The return value is actually the clock marker."
3789 "org-clock"
3791 org-clock-goto org-clock-sum org-clock-display
3792 org-clock-remove-overlays org-clock-report
3793 org-clocktable-shift org-dblock-write:clocktable
3794 org-get-clocktable org-resolve-clocks)))
3797 "If this is a CLOCK line, update it and return t.
3798 Otherwise, return nil."
3807 ts te h m s neg)
3810 nil)
3815 ;; The clock is running here
3836 t))))))
3839 "Check if the current buffer contains the running clock.
3840 If yes, offer to stop it and to save the buffer with the changes."
3849 "Check if this line starts a clock table, if yes, shift the time block."
3853 ;; Autoload org-timer.el
3857 "org-timer"
3859 org-timer-change-times-in-region
3860 org-timer-set-timer
3861 org-timer-reset-timers
3862 org-timer-show-remaining-time)))
3864 ;; Autoload org-feed.el
3868 "org-feed"
3872 ;; Autoload org-indent.el
3874 ;; Define the variable already here, to make sure we have it.
3876 "Non-nil if Org-Indent mode is enabled.
3881 "org-indent"
3884 ;; Autoload org-mobile.el
3888 "org-mobile"
3891 ;; Autoload archiving code
3892 ;; The stuff that is needed for cycling and tags has to be defined here.
3895 "Options concerning archiving in Org-mode."
3900 "The location where subtrees should be archived.
3902 The value of this variable is a string, consisting of two parts,
3903 separated by a double-colon. The first part is a filename and
3904 the second part is a headline.
3906 When the filename is omitted, archiving happens in the same file.
3907 %s in the filename will be replaced by the current file
3908 name (without the directory part). Archiving to a different file
3909 is useful to keep archived entries from contributing to the
3910 Org-mode Agenda.
3912 The archived entries will be filed as subtrees of the specified
3913 headline. When the headline is omitted, the subtrees are simply
3914 filed away at the end of the file, as top-level entries. Also in
3915 the heading you can use %s to represent the file name, this can be
3916 useful when using the same archive for a number of different files.
3918 Here are a few examples:
3920 If the current file is Projects.org, archive in file
3921 Projects.org_archive, as top-level trees. This is the default.
3924 Archive in the current file, under the top-level headline
3928 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3931 Archive in file ~/org/archive.org (absolute path), under headlines
3935 Archive in file ./basement (relative path), as level 3 trees
3938 You may set this option on a per-file basis by adding to the buffer a
3939 line like
3941 #+ARCHIVE: basement::** Finished Tasks
3943 You may also define it locally for a subtree by setting an ARCHIVE property
3944 in the entry. If such a property is found in an entry, or anywhere up
3945 the hierarchy, it will be used."
3950 "The tag that marks a subtree as archived.
3951 An archived subtree does not open during visibility cycling, and does
3952 not contribute to the agenda listings.
3953 After changing this, font-lock must be restarted in the relevant buffers to
3954 get the proper fontification."
3960 "Non-nil means the agenda will skip any items located in archived trees.
3961 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3962 variable is no longer recommended, you should leave it at the value t.
3963 Instead, use the key `v' to cycle the archives-mode in the agenda."
3969 "Non-nil means ignore archived trees when creating column view."
3975 "Non-nil means `org-cycle' will open archived trees.
3976 An archived tree is a tree marked with the tag ARCHIVE.
3977 When nil, archived trees will stay folded. You can still open them with
3978 normal outline commands like `show-all', but not with the cycling commands."
3984 "Non-nil means sparse tree construction shows matches in archived trees.
3985 When nil, matches in these trees are highlighted, but the trees are kept in
3986 collapsed state."
3992 "Re-hide all archived subtrees after a visibility state change."
4003 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4006 "Cycle subtree even if it is archived."
4013 "Re-hide all archived subtrees after a visibility state change."
4028 flag)))
4035 org-archive-to-archive-sibling org-toggle-archive-tag
4036 org-archive-subtree-default
4037 org-archive-subtree-default-with-confirmation)))
4039 ;; Autoload Column View Code
4047 org-columns-compute org-agenda-columns org-columns-remove-overlays
4050 ;; Autoload ID code
4058 org-id-get-with-outline-path-completion
4059 org-id-get-with-outline-drilling org-id-store-link
4060 org-id-goto org-id-find org-id-store-link))
4062 ;; Autoload Plotting Code
4067 ;;; Variables for pre-computed regular expressions, all buffer local
4085 "Matches a headline and puts everything into groups:
4086 group 1: the stars
4087 group 2: The todo keyword, maybe
4088 group 3: Priority cookie
4089 group 4: True headline
4093 "Printf format to make regexp to match an exact headline.
4094 This regexp will match the headline of any node which hase the exact
4095 headline text that is put into the format, but may have any TODO state,
4099 "Matches a headline and puts TODO state into group 2 if present.
4154 "Regular expression to match a plain time or time range.
4155 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4156 groups carry important information:
4157 0 the full match
4158 1 the first time, range or not
4166 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4167 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4168 groups carry important information:
4169 0 the full match
4170 7 hours of duration
4179 "Regular expression to match a timestamp time or time range.
4180 After a match, the following groups carry important information:
4181 0 the full match
4182 1 date plus weekday, for back referencing to make sure both times are on the same day
4183 2 the first time, range or not
4238 "Variable associated with STARTUP options for org-mode.
4239 Each element is a list of three items: The startup options as written
4240 in the #+STARTUP line, the corresponding variable, and the value to
4241 set this variable to if the option is found. An optional forth element PUSH
4245 "Precompute regular expressions for current buffer."
4265 kwds kws0 kwsa key log value cat arch tags const links hw dws
4266 tail sep kws1 prio props ftags drawers beamer-p
4288 ;; general TODO-like setup
4300 links)))
4306 props)))
4311 ftags
4321 l var val)
4351 ))))
4368 ;; Process the TODO keywords
4370 ;; Use the global values as if they had been given locally.
4382 kws)))
4385 kwsa nil
4388 ;; 1 2
4396 kw)
4398 kws0)
4415 ;; Process the constants
4423 ;; Process the tags.
4434 tgs))
4442 ;; Compute the regular expressions and other local variables
4450 org-drawer-regexp
4454 org-not-done-keywords
4456 org-todo-regexp
4459 org-not-done-regexp
4463 org-not-done-heading-regexp
4467 org-todo-line-regexp
4471 org-complex-heading-regexp
4476 org-complex-heading-regexp-format
4485 org-nl-done-regexp
4489 org-todo-line-tags-regexp
4494 org-looking-at-done-regexp
4499 org-deadline-time-regexp
4501 org-deadline-line-regexp
4503 org-scheduled-regexp
4505 org-scheduled-time-regexp
4507 org-closed-time-regexp
4509 org-keyword-time-regexp
4515 org-keyword-time-not-clock-regexp
4521 org-maybe-keyword-time-regexp
4527 org-planning-or-clock-line-re
4532 org-all-time-keywords
4535 org-clock-string org-closed-string))
4536 )
4541 "Return the contents of FILE, as a string."
4555 "Extract the log state setting from a TODO keyword string.
4569 "Remove a pair of parenthesis at the end of each string in LIST."
4573 x))
4574 list))
4577 "Assign fast keys to a keyword-key alist.
4578 Respect keys that are already there."
4596 ;;; Some variables used in various places
4603 "Function to be called when `C-c C-c' is used.
4607 ;; FIXME: Occasionally check by commenting these, to make sure
4608 ;; no other functions uses these, forgetting to let-bind them.
4613 ;; Defined somewhere in this file, but used before definition.
4619 ;;;; Define the Org-mode
4622 (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"))
4625 ;; We use a before-change function to check if a table might need
4626 ;; an update.
4628 "Indicates that a table might need an update.
4629 This variable is set by `org-before-change-function'.
4632 "Every change indicates that a table might need an update."
4643 ;;;###autoload
4645 "Outline-based notes management and organizer, alias
4648 Org-mode develops organizational tasks around a NOTES file which
4649 contains information about projects as plain text. Org-mode is
4650 implemented on top of outline-mode, which is ideal to keep the content
4651 of large files well structured. It supports ToDo items, deadlines and
4652 time stamps, which magically appear in the diary listing of the Emacs
4653 calendar. Tables are easily created with a built-in table editor.
4654 Plain text URL-like links connect to websites, emails (VM), Usenet
4655 messages (Gnus), BBDB entries, and any files related to the project.
4656 For printing and sharing of notes, an Org-mode file (or a part of it)
4657 can be exported as a structured ASCII or HTML file.
4659 The following commands are available:
4663 ;; Get rid of Outline menus, they are not needed
4664 ;; Need to do this here because define-derived-mode sets up
4665 ;; the keymap so late. Still, it is a waste to call this each time
4666 ;; we switch another buffer into org-mode.
4669 ;; Assume this is Greg's port, it uses easymenu
4694 org-display-table 4
4697 org-ellipsis)))
4702 ;; tag faces set outside customize.... force initialization.
4704 ;; Calc embedded
4710 ;; Activate before-change-function
4714 ;; Check for running clock before killing a buffer
4716 ;; Paragraphs and auto-filling
4720 ;; Beginning/end of defun
4723 ;; Next error for sparse trees
4725 ;; Make sure dependence stuff works reliably, even for users who set it
4726 ;; too late :-(
4738 ;; Comment characters
4742 ;; Align options lines
4744 'align-mode-rules-list
4749 ;; Imenu
4753 ;; Make isearch reveal context
4756 ;; Emacs 21 and XEmacs make use of the hook
4758 ;; Emacs 22 deals with this through a special variable
4762 ;; Turn on org-beamer-mode?
4765 ;; Setup the pcomplete hooks
4776 ;; If empty file that did not turn on org-mode automatically, make it to.
4801 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4811 "Return today date, considering `org-extend-today-until'."
4816 ;;;; Font-Lock stuff, including the activators
4847 "Regular expression used to analyze links.
4848 Here is what the match groups contain after a match:
4849 1: http:
4850 2: http
4851 3: path
4852 4: [desc]
4860 "Number of stacked braces for sub/superscript matching.
4861 This has to be set before loading org.el to be effective."
4866 "Create a regular expression which will match a balanced sexp.
4867 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4868 as single character strings.
4869 The regexp returned will match the entire expression including the
4870 delimiters. It will also define a single group which contains the
4871 match except for the outermost delimiters. The maximum depth of
4872 stacked delimiters is N. Escaping delimiters is not possible."
4901 "Update the link regular expressions.
4902 This should be called after the variable `org-link-types' has changed."
4906 org-link-re-with-space
4912 org-link-re-with-space2
4918 org-link-re-with-space3
4923 org-angle-link-re
4929 org-plain-link-re
4933 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4934 org-bracket-link-regexp
4936 org-bracket-link-analytic-regexp
4944 org-bracket-link-analytic-regexp++
4952 org-any-link-re
4963 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4964 "Regular expression matching time strings for analysis.
4965 This one does not require the space after the date, so it can be used
4967 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4983 "Regular expression matching a time stamp or time stamp range.
4989 "Run through the buffer and add overlays to links."
4998 'face
5011 rtn))
5014 "Insert or change an emphasis, i.e. a font like bold or italic.
5015 If there is an active region, change that region to a new emphasis.
5016 If there is no region, just insert the marker characters and position
5017 the cursor between them.
5018 CHAR should be either the marker character, or the first character of the
5019 HTML tag associated with that emphasis. If CHAR is a space, the means
5020 to remove the emphasis of the selected region.
5021 If char is not given (for example in an interactive call) it
5022 will be prompted for."
5073 "Run through the buffer and add overlays to links."
5082 nil
5088 t)))))
5096 t)))
5099 "When non-nil, fontify code in code blocks."
5105 "Fontify #+ lines and blocks, in the correct ways."
5108 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5109 limit t)
5117 end end1 quoting block-type)
5120 ;; a single line of backend-specific content
5128 ; for backend-specific code
5129 t)
5131 ;; Truly a block
5143 beg end
5147 ; for end_src
5155 ; end of source block
5163 t))
5176 ;; just any other in-buffer setting, but not indented
5180 t)
5188 t)
5196 "Run through the buffer and add overlays to links."
5204 t)))
5207 "Run through the buffer and add overlays to links."
5209 limit t)
5214 'keymap org-mouse-map
5215 'help-echo
5217 "Footnote definition"
5219 ))
5221 t)))
5224 "Run through the buffer and add overlays to bracketed links."
5228 ;; FIXME: above we should remove the escapes.
5229 ;; but that requires another match, protecting match data,
5230 ;; a lot of overhead for font-lock.
5237 ;; We need to remove the invisible property here. Table narrowing
5238 ;; may have made some of this invisible.
5256 t)))
5259 "Run through the buffer and add overlays to dates."
5271 t)))
5280 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5284 "Run through the buffer and add overlays to target matches."
5292 'keymap org-mouse-map
5296 t)))))
5299 "Find all radio targets in this file and update the regular expression."
5314 t)))
5321 ;; This should be with the exporter code, but we also use if for font-locking
5331 "Compute regular expression for stuff treated specially by exporters."
5338 org-latex-regexps)))
5366 org-entities)))
5370 org-latex-entities)
5371 nil))
5373 ))
5374 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5377 org-export-html-special-string-regexps)))
5382 ))))
5384 'org-latex-and-specials-regexp
5389 "Run through the buffer and add overlays to links."
5393 limit t))
5407 rtn)))
5410 "Restart `font-lock-mode', to force refontification."
5416 "Return a list of all targets in this file.
5417 With optional argument RADIO, only find radio targets."
5419 rtn)
5424 rtn)))
5427 "Make regular expression matching all strings in TARGETS.
5428 The regular expression finds the targets also if there is a line break
5429 between words."
5438 x)
5439 targets
5451 t)))
5454 "Compute the outline level of the heading at point.
5455 This function assumes that the cursor is at the beginning of a line matched
5456 by `outline-regexp'. Otherwise it returns garbage.
5457 If this is called at a normal headline, the level is the number of stars.
5458 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5459 For plain list items, if they are matched by `outline-regexp', this returns
5460 1000 plus the line indentation."
5469 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5476 "Functions that can manipulate `org-font-lock-extra-keywords'.
5477 This is calles after `org-font-lock-extra-keywords' is defined, but before
5478 it is installed to be used by font lock. This can be useful if something
5489 ;; Call the hook
5491 ;; Headlines
5498 ;; Table lines
5501 ;; Table internals
5506 ;; Drawers
5509 ;; Properties
5513 ;; Links
5524 ;; TODO lines
5527 ;; DONE
5533 nil)
5534 ;; Priorities
5536 ;; Tags
5538 ;; Special keywords
5543 ;; Emphasis
5548 ;; Checkboxes
5549 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5554 ;; Description list items
5557 ;; ARCHIVEd headings
5560 ;; Specials
5564 ;; Code
5566 ;; COMMENT
5571 ;; Blocks and meta lines
5573 )))
5576 ;; Now set the full font-lock-keywords
5583 "Toggle the composition display of entities as UTF8 characters."
5595 "Find an entity to fontify."
5601 limit t)
5613 nil))))
5616 "Fontify string S like in Org-mode."
5628 "Get the right face for match N in font-lock matching of headlines."
5641 "Get the right face for a TODO keyword KWD.
5642 If KWD is a number, get the corresponding match group."
5650 "Create a face list that inherits INHERIT, but sets the foreground color.
5651 When FACE-OR-COLOR is not a string, just return it."
5655 face-or-color)
5656 face-or-color))
5659 "Add the special tag faces."
5668 "Add the special priority faces."
5675 org-priority-faces)))
5680 "Get the right face for a TODO keyword KWD.
5681 If KWD is a number, get the corresponding match group."
5688 "Remove fontification and activation overlays from links."
5693 deactivate-mark buffer-file-name buffer-file-truename)
5696 beg end
5698 ;; also remove line-prefix and wrap-prefix properties
5700 invisible t intangible t
5701 line-prefix t wrap-prefix t
5702 org-no-flyspell t org-emphasis t)
5704 invisible t intangible t
5705 org-no-flyspell t org-emphasis t)))
5715 "Remove specific display properties that have been added by font lock.
5716 The will remove the raise properties that are used to show superscripts
5717 and subscripts."
5727 "Add raise properties to sub/superscripts."
5731 org-match-substring-regexp
5732 org-match-substring-with-braces-regexp)
5733 limit t)
5743 ;; FIXME: Should we go back one character here, for a_b^c
5744 ;; (goto-char (1- pos)) ;????????????????????
5746 t
5748 'display
5764 t)))))
5766 ;;;; Visibility cycling, including org-goto and indirect buffer
5768 ;;; Cycling
5775 ;;;###autoload
5780 "TAB-action and visibility cycling for Org-mode.
5782 This is the command invoked in Org-mode by the TAB key. Its main purpose
5783 is outline visibility cycling, but it also invokes other actions
5784 in special contexts.
5786 - When this function is called with a prefix argument, rotate the entire
5787 buffer through 3 states (global cycling)
5788 1. OVERVIEW: Show only top-level headlines.
5789 2. CONTENTS: Show all headlines of all levels, but no body text.
5790 3. SHOW ALL: Show everything.
5791 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5792 determined by the variable `org-startup-folded', and by any VISIBILITY
5793 properties in the buffer.
5794 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5795 including any drawers.
5797 - When inside a table, re-align the table and move to the next field.
5799 - When point is at the beginning of a headline, rotate the subtree started
5800 by this line through 3 different states (local cycling)
5801 1. FOLDED: Only the main headline is shown.
5802 2. CHILDREN: The main headline and the direct children are shown.
5803 From this state, you can move to one of the children
5804 and zoom in further.
5805 3. SUBTREE: Show the entire subtree, including body text.
5806 If there is no subtree, switch directly from CHILDREN to FOLDED.
5808 - When point is at the beginning of an empty headline and the variable
5809 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5810 of the headline by demoting and promoting it to likely levels. This
5811 speeds up creation document structure by pressing TAB once or several
5812 times right after creating a new headline.
5814 - When there is a numeric prefix, go up to a heading with level ARG, do
5815 a `show-subtree' and return to the previous cursor position. If ARG
5816 is negative, go up that many levels.
5818 - When point is not at the beginning of a headline, execute the global
5819 binding for TAB, which is re-indenting the line. See the option
5820 `org-cycle-emulate-tab' for details.
5822 - Special case: if point is at the beginning of the buffer and there is
5823 no headline in line 1, this function will act as if called with prefix arg
5824 (C-u TAB, same as S-TAB) also when called without prefix arg.
5825 But only if also the variable `org-cycle-global-at-bob' is t."
5835 org-inlinetask-min-level
5840 limit-level)))
5856 org-cycle-hook))
5860 ;; special case: use global cycling
5875 ;; Enter the table or move to the next field in the table
5892 ;; Toggle block visibility
5897 ;; Show-subtree, ARG levels up from here.
5909 ;; TAB emulation and template completion
5933 t
5942 "Do the global cycling action."
5946 ;; We just created the overview - now do table of contents
5947 ;; This can be slow in very large buffers, so indicate action
5957 ;; We just showed the table of contents - now show everything
5965 ;; Default action: go to overview
5973 "Do the local cycling action."
5975 ;; First, some boundaries
5982 ; XEmacs does not have `next-single-char-property-change'
5983 ; I'm not sure about Emacs 21.
5997 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
6006 ;; Find out what to do next and set `this-command'
6009 ;; Nothing is hidden behind this heading
6021 org-cycle-skip-children-state-if-no-children))))
6022 ;; Entire subtree is hidden in one line: children view
6036 ;; We just showed the children, or no children are there,
6037 ;; now show everything.
6044 ;; Default action: hide the subtree.
6051 ;;;###autoload
6053 "Cycle the global visibility. For details see `org-cycle'.
6055 With a numeric prefix, show all headlines up to that level."
6071 "Set the visibility required by startup options and properties."
6086 "Switch subtree visibilities according to :VISIBILITY: property."
6093 nil t)
6118 "Switch to overview mode, showing only top-level headlines.
6119 Really, this shows all headlines with level equal or greater than the level
6120 of the first headline in the buffer. This is important, because if the
6121 first headline is not level one, then (hide-sublevels 1) gives confusing
6122 results."
6133 "Show all headlines in the buffer, like a table of contents.
6134 With numerical argument N, show content up to level N."
6137 ;; Visit all headings and show their offspring
6144 t)
6153 "Adjust the window after a change in outline visibility.
6154 This function is the default value of the hook `org-cycle-hook'."
6164 "Remove outline overlays that do not contain non-white stuff."
6174 "Fix visibility issues after moving a subtree."
6175 ;; First, find a reasonable region to look at:
6176 ;; Start two siblings above, end three below
6194 ;; Properly fold already folded siblings
6205 "Show empty lines above all visible headlines.
6206 The region to be covered depends on STATE when called through
6207 `org-cycle-hook'. Lisp program can use t for STATE to get the
6208 entire buffer covered. Note that an empty line is only shown if there
6209 are at least `org-cycle-separator-lines' empty lines before the headline."
6219 beg end b e)
6243 ;; Never hide empty lines at the end of the file.
6253 "Move to the parent and re-show empty lines before visible headlines."
6259 "Return `org-agenda-files' list, plus all open org-mode files.
6260 This is useful for operations that need to scan all of a user's
6261 open and agenda-wise Org files."
6269 files))
6272 "Return the beginning position of the current entry."
6276 "Return the end position of the current entry."
6280 "Re-hide all drawers after a visibility state change."
6307 "Is the end of the current subtree visible?"
6312 "Move cursor to the first headline and recenter the headline.
6313 Optional argument N means put the headline into the Nth line of the window."
6319 ;;; Saving and restoring visibility
6322 "Return a list of the locations of all outline overlays.
6323 These are overlays with the `invisible' property value `outline'.
6324 The return value is a list of cons cells, with start and stop
6325 positions for each overlay.
6326 If USE-MARKERS is set, return the positions as markers."
6344 "Create visibility overlays for all positions in DATA.
6345 DATA should have been made by `org-outline-overlay-data'."
6354 data)))))
6356 ;;; Folding of blocks
6367 "Call FUNCTION at the head of all source blocks in the current buffer.
6368 Optional arguments START and END can be used to limit the range."
6380 "Toggle the visibility of all blocks in the current buffer."
6384 "Fold all blocks in the current buffer."
6390 "Unfold all blocks in the current buffer."
6396 "Toggle visibility of block at point."
6407 "Toggle the visibility of the current block."
6414 ov)
6430 ;; make the block accessible to isearch
6432 ov 'isearch-open-invisible
6443 ;; org-tab-after-check-for-cycling-hook
6445 ;; Remove overlays when changing major mode
6450 ;;; Org-goto
6456 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6472 nil)
6473 (org-defkey map "q" 'org-goto-quit)
6474 (org-defkey map "n" 'outline-next-visible-heading)
6475 (org-defkey map "p" 'outline-previous-visible-heading)
6476 (org-defkey map "f" 'outline-forward-same-level)
6477 (org-defkey map "b" 'outline-backward-same-level)
6478 (org-defkey map "u" 'outline-up-heading))
6479 (org-defkey map "/" 'org-occur)
6480 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6481 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6482 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6483 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6484 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6485 map))
6487 (defconst org-goto-help
6488 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6489 RET=jump to location [Q]uit and return to previous location
6490 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6492 (defvar org-goto-start-pos) ; dynamically scoped parameter
6494 ;; FIXME: Docstring does not mention both interfaces
6495 (defun org-goto (&optional alternative-interface)
6496 "Look up a different location in the current file, keeping current visibility.
6498 When you want look-up or go to a different location in a document, the
6499 fastest way is often to fold the entire buffer and then dive into the tree.
6500 This method has the disadvantage, that the previous location will be folded,
6501 which may not be what you want.
6503 This command works around this by showing a copy of the current buffer
6504 in an indirect buffer, in overview mode. You can dive into the tree in
6505 that copy, use org-occur and incremental search to find a location.
6506 When pressing RET or `Q', the command returns to the original buffer in
6507 which the visibility is still unchanged. After RET is will also jump to
6508 the location selected in the indirect buffer and expose the
6509 the headline hierarchy above."
6510 (interactive "P")
6511 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6512 (org-refile-use-outline-path t)
6513 (org-refile-target-verify-function nil)
6514 (interface
6515 (if (not alternative-interface)
6516 org-goto-interface
6517 (if (eq org-goto-interface 'outline)
6518 'outline-path-completion
6519 'outline)))
6520 (org-goto-start-pos (point))
6521 (selected-point
6522 (if (eq interface 'outline)
6523 (car (org-get-location (current-buffer) org-goto-help))
6524 (let ((pa (org-refile-get-location "Goto: ")))
6525 (org-refile-check-position pa)
6526 (nth 3 pa)))))
6527 (if selected-point
6528 (progn
6529 (org-mark-ring-push org-goto-start-pos)
6530 (goto-char selected-point)
6531 (if (or (outline-invisible-p) (org-invisible-p2))
6532 (org-show-context 'org-goto)))
6533 (message "Quit"))))
6535 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6536 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6537 (defvar org-goto-local-auto-isearch-map) ; defined below
6539 (defun org-get-location (buf help)
6540 "Let the user select a location in the Org-mode buffer BUF.
6541 This function uses a recursive edit. It returns the selected position
6542 or nil."
6543 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6544 (isearch-hide-immediately nil)
6545 (isearch-search-fun-function
6546 (lambda () 'org-goto-local-search-headings))
6547 (org-goto-selected-point org-goto-exit-command)
6548 (pop-up-frames nil)
6549 (special-display-buffer-names nil)
6550 (special-display-regexps nil)
6551 (special-display-function nil))
6552 (save-excursion
6553 (save-window-excursion
6554 (delete-other-windows)
6555 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6556 (switch-to-buffer
6557 (condition-case nil
6558 (make-indirect-buffer (current-buffer) "*org-goto*")
6559 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6560 (with-output-to-temp-buffer "*Help*"
6561 (princ help))
6562 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6563 (setq buffer-read-only nil)
6564 (let ((org-startup-truncated t)
6565 (org-startup-folded nil)
6566 (org-startup-align-all-tables nil))
6567 (org-mode)
6568 (org-overview))
6569 (setq buffer-read-only t)
6570 (if (and (boundp 'org-goto-start-pos)
6571 (integer-or-marker-p org-goto-start-pos))
6572 (let ((org-show-hierarchy-above t)
6573 (org-show-siblings t)
6574 (org-show-following-heading t))
6575 (goto-char org-goto-start-pos)
6576 (and (outline-invisible-p) (org-show-context)))
6577 (goto-char (point-min)))
6578 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6579 (message "Select location and press RET")
6580 (use-local-map org-goto-map)
6581 (recursive-edit)
6582 ))
6583 (kill-buffer "*org-goto*")
6584 (cons org-goto-selected-point org-goto-exit-command)))
6586 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6587 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6588 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6589 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6591 (defun org-goto-local-search-headings (string bound noerror)
6592 "Search and make sure that any matches are in headlines."
6593 (catch 'return
6594 (while (if isearch-forward
6595 (search-forward string bound noerror)
6596 (search-backward string bound noerror))
6597 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6598 (and (member :headline context)
6599 (not (member :tags context))))
6600 (throw 'return (point))))))
6602 (defun org-goto-local-auto-isearch ()
6603 "Start isearch."
6604 (interactive)
6605 (goto-char (point-min))
6606 (let ((keys (this-command-keys)))
6607 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6608 (isearch-mode t)
6609 (isearch-process-search-char (string-to-char keys)))))
6611 (defun org-goto-ret (&optional arg)
6612 "Finish `org-goto' by going to the new location."
6613 (interactive "P")
6614 (setq org-goto-selected-point (point)
6615 org-goto-exit-command 'return)
6616 (throw 'exit nil))
6618 (defun org-goto-left ()
6619 "Finish `org-goto' by going to the new location."
6620 (interactive)
6621 (if (org-on-heading-p)
6622 (progn
6623 (beginning-of-line 1)
6624 (setq org-goto-selected-point (point)
6625 org-goto-exit-command 'left)
6626 (throw 'exit nil))
6627 (error "Not on a heading")))
6629 (defun org-goto-right ()
6630 "Finish `org-goto' by going to the new location."
6631 (interactive)
6632 (if (org-on-heading-p)
6633 (progn
6634 (setq org-goto-selected-point (point)
6635 org-goto-exit-command 'right)
6636 (throw 'exit nil))
6637 (error "Not on a heading")))
6639 (defun org-goto-quit ()
6640 "Finish `org-goto' without cursor motion."
6641 (interactive)
6642 (setq org-goto-selected-point nil)
6643 (setq org-goto-exit-command 'quit)
6644 (throw 'exit nil))
6646 ;;; Indirect buffer display of subtrees
6648 (defvar org-indirect-dedicated-frame nil
6649 "This is the frame being used for indirect tree display.")
6650 (defvar org-last-indirect-buffer nil)
6652 (defun org-tree-to-indirect-buffer (&optional arg)
6653 "Create indirect buffer and narrow it to current subtree.
6654 With numerical prefix ARG, go up to this level and then take that tree.
6655 If ARG is negative, go up that many levels.
6656 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6657 indirect buffer previously made with this command, to avoid proliferation of
6658 indirect buffers. However, when you call the command with a \
6660 when `org-indirect-buffer-display' is `new-frame', the last buffer
6661 is kept so that you can work with several indirect buffers at the same time.
6662 If `org-indirect-buffer-display' is `dedicated-frame', the \
6664 requests that a new frame be made for the new buffer, so that the dedicated
6665 frame is not changed."
6666 (interactive "P")
6667 (let ((cbuf (current-buffer))
6668 (cwin (selected-window))
6669 (pos (point))
6670 beg end level heading ibuf)
6671 (save-excursion
6672 (org-back-to-heading t)
6673 (when (numberp arg)
6674 (setq level (org-outline-level))
6675 (if (< arg 0) (setq arg (+ level arg)))
6676 (while (> (setq level (org-outline-level)) arg)
6677 (outline-up-heading 1 t)))
6678 (setq beg (point)
6679 heading (org-get-heading))
6680 (org-end-of-subtree t t)
6681 (if (org-on-heading-p) (backward-char 1))
6682 (setq end (point)))
6683 (if (and (buffer-live-p org-last-indirect-buffer)
6684 (not (eq org-indirect-buffer-display 'new-frame))
6685 (not arg))
6686 (kill-buffer org-last-indirect-buffer))
6687 (setq ibuf (org-get-indirect-buffer cbuf)
6688 org-last-indirect-buffer ibuf)
6689 (cond
6690 ((or (eq org-indirect-buffer-display 'new-frame)
6691 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6692 (select-frame (make-frame))
6693 (delete-other-windows)
6694 (switch-to-buffer ibuf)
6695 (org-set-frame-title heading))
6696 ((eq org-indirect-buffer-display 'dedicated-frame)
6697 (raise-frame
6698 (select-frame (or (and org-indirect-dedicated-frame
6699 (frame-live-p org-indirect-dedicated-frame)
6700 org-indirect-dedicated-frame)
6701 (setq org-indirect-dedicated-frame (make-frame)))))
6702 (delete-other-windows)
6703 (switch-to-buffer ibuf)
6704 (org-set-frame-title (concat "Indirect: " heading)))
6705 ((eq org-indirect-buffer-display 'current-window)
6706 (switch-to-buffer ibuf))
6707 ((eq org-indirect-buffer-display 'other-window)
6708 (pop-to-buffer ibuf))
6709 (t (error "Invalid value")))
6710 (if (featurep 'xemacs)
6711 (save-excursion (org-mode) (turn-on-font-lock)))
6712 (narrow-to-region beg end)
6713 (show-all)
6714 (goto-char pos)
6715 (and (window-live-p cwin) (select-window cwin))))
6717 (defun org-get-indirect-buffer (&optional buffer)
6718 (setq buffer (or buffer (current-buffer)))
6719 (let ((n 1) (base (buffer-name buffer)) bname)
6720 (while (buffer-live-p
6721 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6722 (setq n (1+ n)))
6723 (condition-case nil
6724 (make-indirect-buffer buffer bname 'clone)
6725 (error (make-indirect-buffer buffer bname)))))
6727 (defun org-set-frame-title (title)
6728 "Set the title of the current frame to the string TITLE."
6729 ;; FIXME: how to name a single frame in XEmacs???
6730 (unless (featurep 'xemacs)
6731 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6733 ;;;; Structure editing
6735 ;;; Inserting headlines
6737 (defun org-previous-line-empty-p ()
6738 (save-excursion
6739 (and (not (bobp))
6740 (or (beginning-of-line 0) t)
6741 (save-match-data
6744 (defun org-insert-heading (&optional force-heading invisible-ok)
6745 "Insert a new heading or item with same depth at point.
6746 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6747 If point is at the beginning of a headline, insert a sibling before the
6748 current headline. If point is not at the beginning, split the line,
6749 create the new headline with the text in the current line after point
6750 \(but see also the variable `org-M-RET-may-split-line').
6752 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6753 This is important for non-interactive uses of the command."
6754 (interactive "P")
6755 (if (or (= (buffer-size) 0)
6756 (and (not (save-excursion
6757 (and (ignore-errors (org-back-to-heading invisible-ok))
6758 (org-on-heading-p))))
6759 (not (org-in-item-p))))
6760 (progn
6762 (run-hooks 'org-insert-heading-hook))
6763 (when (or force-heading (not (org-insert-item)))
6764 (let* ((empty-line-p nil)
6765 (level nil)
6766 (on-heading (org-on-heading-p))
6767 (head (save-excursion
6768 (condition-case nil
6769 (progn
6770 (org-back-to-heading invisible-ok)
6771 (when (and (not on-heading)
6772 (featurep 'org-inlinetask)
6773 (integerp org-inlinetask-min-level)
6774 (>= (length (match-string 0))
6775 org-inlinetask-min-level))
6776 ;; Find a heading level before the inline task
6777 (while (and (setq level (org-up-heading-safe))
6778 (>= level org-inlinetask-min-level)))
6779 (if (org-on-heading-p)
6780 (org-back-to-heading invisible-ok)
6781 (error "This should not happen")))
6782 (setq empty-line-p (org-previous-line-empty-p))
6783 (match-string 0))
6784 (error "*"))))
6785 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6786 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6787 pos hide-previous previous-pos)
6788 (cond
6789 ((and (org-on-heading-p) (bolp)
6790 (or (bobp)
6791 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6792 ;; insert before the current line
6793 (open-line (if blank 2 1)))
6794 ((and (bolp)
6795 (not org-insert-heading-respect-content)
6796 (or (bobp)
6797 (save-excursion
6798 (backward-char 1) (not (outline-invisible-p)))))
6799 ;; insert right here
6800 nil)
6801 (t
6802 ;; somewhere in the line
6803 (save-excursion
6804 (setq previous-pos (point-at-bol))
6805 (end-of-line)
6806 (setq hide-previous (outline-invisible-p)))
6807 (and org-insert-heading-respect-content (org-show-subtree))
6808 (let ((split
6809 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6810 (save-excursion
6811 (let ((p (point)))
6812 (goto-char (point-at-bol))
6813 (and (looking-at org-complex-heading-regexp)
6814 (> p (match-beginning 4)))))))
6815 tags pos)
6816 (cond
6817 (org-insert-heading-respect-content
6818 (org-end-of-subtree nil t)
6819 (when (featurep 'org-inlinetask)
6820 (while (and (not (eobp))
6822 (>= (length (match-string 1))
6823 org-inlinetask-min-level))
6824 (org-end-of-subtree nil t)))
6825 (or (bolp) (newline))
6826 (or (org-previous-line-empty-p)
6827 (and blank (newline)))
6828 (open-line 1))
6829 ((org-on-heading-p)
6830 (when hide-previous
6831 (show-children)
6832 (org-show-entry))
6834 (setq tags (and (match-end 2) (match-string 2)))
6835 (and (match-end 1)
6836 (delete-region (match-beginning 1) (match-end 1)))
6837 (setq pos (point-at-bol))
6838 (or split (end-of-line 1))
6839 (delete-horizontal-space)
6841 (buffer-substring (point-at-bol) (point)))
6842 (insert " "))
6843 (newline (if blank 2 1))
6844 (when tags
6845 (save-excursion
6846 (goto-char pos)
6847 (end-of-line 1)
6848 (insert " " tags)
6849 (org-set-tags nil 'align))))
6850 (t
6851 (or split (end-of-line 1))
6852 (newline (if blank 2 1)))))))
6853 (insert head) (just-one-space)
6854 (setq pos (point))
6855 (end-of-line 1)
6856 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6857 (when (and org-insert-heading-respect-content hide-previous)
6858 (save-excursion
6859 (goto-char previous-pos)
6860 (hide-subtree)))
6861 (run-hooks 'org-insert-heading-hook)))))
6863 (defun org-get-heading (&optional no-tags)
6864 "Return the heading of the current entry, without the stars."
6865 (save-excursion
6866 (org-back-to-heading t)
6867 (if (looking-at
6868 (if no-tags
6871 (match-string 1) "")))
6873 (defun org-heading-components ()
6874 "Return the components of the current heading.
6875 This is a list with the following elements:
6876 - the level as an integer
6877 - the reduced level, different if `org-odd-levels-only' is set.
6878 - the TODO keyword, or nil
6879 - the priority character, like ?A, or nil if no priority is given
6880 - the headline text itself, or the tags string if no headline text
6881 - the tags string, or nil."
6882 (save-excursion
6883 (org-back-to-heading t)
6884 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6885 (list (length (match-string 1))
6886 (org-reduced-level (length (match-string 1)))
6887 (org-match-string-no-properties 2)
6888 (and (match-end 3) (aref (match-string 3) 2))
6889 (org-match-string-no-properties 4)
6890 (org-match-string-no-properties 5)))))
6892 (defun org-get-entry ()
6893 "Get the entry text, after heading, entire subtree."
6894 (save-excursion
6895 (org-back-to-heading t)
6896 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6898 (defun org-insert-heading-after-current ()
6899 "Insert a new heading with same level as current, after current subtree."
6900 (interactive)
6901 (org-back-to-heading)
6902 (org-insert-heading)
6903 (org-move-subtree-down)
6904 (end-of-line 1))
6906 (defun org-insert-heading-respect-content ()
6907 (interactive)
6908 (let ((org-insert-heading-respect-content t))
6909 (org-insert-heading t)))
6911 (defun org-insert-todo-heading-respect-content (&optional force-state)
6912 (interactive "P")
6913 (let ((org-insert-heading-respect-content t))
6914 (org-insert-todo-heading force-state t)))
6916 (defun org-insert-todo-heading (arg &optional force-heading)
6917 "Insert a new heading with the same level and TODO state as current heading.
6918 If the heading has no TODO state, or if the state is DONE, use the first
6919 state (TODO by default). Also with prefix arg, force first state."
6920 (interactive "P")
6921 (when (or force-heading (not (org-insert-item 'checkbox)))
6922 (org-insert-heading force-heading)
6923 (save-excursion
6924 (org-back-to-heading)
6925 (outline-previous-heading)
6926 (looking-at org-todo-line-regexp))
6927 (let*
6928 ((new-mark-x
6929 (if (or arg
6930 (not (match-beginning 2))
6931 (member (match-string 2) org-done-keywords))
6932 (car org-todo-keywords-1)
6933 (match-string 2)))
6934 (new-mark
6935 (or
6936 (run-hook-with-args-until-success
6937 'org-todo-get-default-hook new-mark-x nil)
6938 new-mark-x)))
6939 (beginning-of-line 1)
6941 (if org-treat-insert-todo-heading-as-state-change
6942 (org-todo new-mark)
6943 (insert new-mark " "))))
6944 (when org-provide-todo-statistics
6945 (org-update-parent-todo-statistics))))
6947 (defun org-insert-subheading (arg)
6948 "Insert a new subheading and demote it.
6949 Works for outline headings and for plain lists alike."
6950 (interactive "P")
6951 (org-insert-heading arg)
6952 (cond
6953 ((org-on-heading-p) (org-do-demote))
6954 ((org-at-item-p) (org-indent-item))))
6956 (defun org-insert-todo-subheading (arg)
6957 "Insert a new subheading with TODO keyword or checkbox and demote it.
6958 Works for outline headings and for plain lists alike."
6959 (interactive "P")
6960 (org-insert-todo-heading arg)
6961 (cond
6962 ((org-on-heading-p) (org-do-demote))
6963 ((org-at-item-p) (org-indent-item))))
6965 ;;; Promotion and Demotion
6967 (defvar org-after-demote-entry-hook nil
6968 "Hook run after an entry has been demoted.
6969 The cursor will be at the beginning of the entry.
6970 When a subtree is being demoted, the hook will be called for each node.")
6972 (defvar org-after-promote-entry-hook nil
6973 "Hook run after an entry has been promoted.
6974 The cursor will be at the beginning of the entry.
6975 When a subtree is being promoted, the hook will be called for each node.")
6977 (defun org-promote-subtree ()
6978 "Promote the entire subtree.
6979 See also `org-promote'."
6980 (interactive)
6981 (save-excursion
6982 (org-map-tree 'org-promote))
6983 (org-fix-position-after-promote))
6985 (defun org-demote-subtree ()
6986 "Demote the entire subtree. See `org-demote'.
6987 See also `org-promote'."
6988 (interactive)
6989 (save-excursion
6990 (org-map-tree 'org-demote))
6991 (org-fix-position-after-promote))
6994 (defun org-do-promote ()
6995 "Promote the current heading higher up the tree.
6996 If the region is active in `transient-mark-mode', promote all headings
6997 in the region."
6998 (interactive)
6999 (save-excursion
7000 (if (org-region-active-p)
7001 (org-map-region 'org-promote (region-beginning) (region-end))
7002 (org-promote)))
7003 (org-fix-position-after-promote))
7005 (defun org-do-demote ()
7006 "Demote the current heading lower down the tree.
7007 If the region is active in `transient-mark-mode', demote all headings
7008 in the region."
7009 (interactive)
7010 (save-excursion
7011 (if (org-region-active-p)
7012 (org-map-region 'org-demote (region-beginning) (region-end))
7013 (org-demote)))
7014 (org-fix-position-after-promote))
7016 (defun org-fix-position-after-promote ()
7017 "Make sure that after pro/demotion cursor position is right."
7018 (let ((pos (point)))
7019 (when (save-excursion
7020 (beginning-of-line 1)
7021 (looking-at org-todo-line-regexp)
7022 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7023 (cond ((eobp) (insert " "))
7024 ((eolp) (insert " "))
7025 ((equal (char-after) ?\ ) (forward-char 1))))))
7027 (defun org-current-level ()
7028 "Return the level of the current entry, or nil if before the first headline.
7029 The level is the number of stars at the beginning of the headline."
7030 (save-excursion
7031 (org-with-limited-levels
7032 (ignore-errors
7033 (org-back-to-heading t)
7034 (funcall outline-level)))))
7036 (defun org-get-previous-line-level ()
7037 "Return the outline depth of the last headline before the current line.
7038 Returns 0 for the first headline in the buffer, and nil if before the
7039 first headline."
7040 (let ((current-level (org-current-level))
7041 (prev-level (when (> (line-number-at-pos) 1)
7042 (save-excursion
7043 (beginning-of-line 0)
7044 (org-current-level)))))
7045 (cond ((null current-level) nil) ; Before first headline
7046 ((null prev-level) 0) ; At first headline
7047 (prev-level))))
7049 (defun org-reduced-level (l)
7050 "Compute the effective level of a heading.
7051 This takes into account the setting of `org-odd-levels-only'."
7052 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7054 (defun org-level-increment ()
7055 "Return the number of stars that will be added or removed at a
7056 time to headlines when structure editing, based on the value of
7057 `org-odd-levels-only'."
7058 (if org-odd-levels-only 2 1))
7060 (defun org-get-valid-level (level &optional change)
7061 "Rectify a level change under the influence of `org-odd-levels-only'
7062 LEVEL is a current level, CHANGE is by how much the level should be
7063 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7064 even level numbers will become the next higher odd number."
7065 (if org-odd-levels-only
7066 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7067 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7068 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7069 (max 1 (+ level (or change 0)))))
7071 (if (boundp 'define-obsolete-function-alias)
7072 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7073 (define-obsolete-function-alias 'org-get-legal-level
7074 'org-get-valid-level)
7075 (define-obsolete-function-alias 'org-get-legal-level
7076 'org-get-valid-level "23.1")))
7078 (defun org-promote ()
7079 "Promote the current heading higher up the tree.
7080 If the region is active in `transient-mark-mode', promote all headings
7081 in the region."
7082 (org-back-to-heading t)
7083 (let* ((level (save-match-data (funcall outline-level)))
7084 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7085 (diff (abs (- level (length up-head) -1))))
7086 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7087 (replace-match up-head nil t)
7088 ;; Fixup tag positioning
7089 (and org-auto-align-tags (org-set-tags nil t))
7090 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7091 (run-hooks 'org-after-promote-entry-hook)))
7093 (defun org-demote ()
7094 "Demote the current heading lower down the tree.
7095 If the region is active in `transient-mark-mode', demote all headings
7096 in the region."
7097 (org-back-to-heading t)
7098 (let* ((level (save-match-data (funcall outline-level)))
7099 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7100 (diff (abs (- level (length down-head) -1))))
7101 (replace-match down-head nil t)
7102 ;; Fixup tag positioning
7103 (and org-auto-align-tags (org-set-tags nil t))
7104 (if org-adapt-indentation (org-fixup-indentation diff))
7105 (run-hooks 'org-after-demote-entry-hook)))
7107 (defun org-cycle-level ()
7108 "Cycle the level of an empty headline through possible states.
7109 This goes first to child, then to parent, level, then up the hierarchy.
7110 After top level, it switches back to sibling level."
7111 (interactive)
7112 (let ((org-adapt-indentation nil))
7113 (when (org-point-at-end-of-empty-headline)
7114 (setq this-command 'org-cycle-level) ; Only needed for caching
7115 (let ((cur-level (org-current-level))
7116 (prev-level (org-get-previous-line-level)))
7117 (cond
7118 ;; If first headline in file, promote to top-level.
7119 ((= prev-level 0)
7120 (loop repeat (/ (- cur-level 1) (org-level-increment))
7121 do (org-do-promote)))
7122 ;; If same level as prev, demote one.
7123 ((= prev-level cur-level)
7124 (org-do-demote))
7125 ;; If parent is top-level, promote to top level if not already.
7126 ((= prev-level 1)
7127 (loop repeat (/ (- cur-level 1) (org-level-increment))
7128 do (org-do-promote)))
7129 ;; If top-level, return to prev-level.
7130 ((= cur-level 1)
7131 (loop repeat (/ (- prev-level 1) (org-level-increment))
7132 do (org-do-demote)))
7133 ;; If less than prev-level, promote one.
7134 ((< cur-level prev-level)
7135 (org-do-promote))
7136 ;; If deeper than prev-level, promote until higher than
7137 ;; prev-level.
7138 ((> cur-level prev-level)
7139 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7140 do (org-do-promote))))
7141 t))))
7143 (defun org-map-tree (fun)
7144 "Call FUN for every heading underneath the current one."
7145 (org-back-to-heading)
7146 (let ((level (funcall outline-level)))
7147 (save-excursion
7148 (funcall fun)
7149 (while (and (progn
7150 (outline-next-heading)
7151 (> (funcall outline-level) level))
7152 (not (eobp)))
7153 (funcall fun)))))
7155 (defun org-map-region (fun beg end)
7156 "Call FUN for every heading between BEG and END."
7157 (let ((org-ignore-region t))
7158 (save-excursion
7159 (setq end (copy-marker end))
7160 (goto-char beg)
7161 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7162 (< (point) end))
7163 (funcall fun))
7164 (while (and (progn
7165 (outline-next-heading)
7166 (< (point) end))
7167 (not (eobp)))
7168 (funcall fun)))))
7170 (defun org-fixup-indentation (diff)
7171 "Change the indentation in the current entry by DIFF.
7172 However, if any line in the current entry has no indentation, or if it
7173 would end up with no indentation after the change, nothing at all is done."
7174 (save-excursion
7175 (let ((end (save-excursion (outline-next-heading)
7176 (point-marker)))
7177 (prohibit (if (> diff 0)
7180 col)
7181 (unless (save-excursion (end-of-line 1)
7182 (re-search-forward prohibit end t))
7183 (while (and (< (point) end)
7185 (goto-char (match-end 0))
7186 (setq col (current-column))
7187 (if (< diff 0) (replace-match ""))
7188 (org-indent-to-column (+ diff col))))
7189 (move-marker end nil))))
7191 (defun org-convert-to-odd-levels ()
7192 "Convert an org-mode file with all levels allowed to one with odd levels.
7193 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7194 level 5 etc."
7195 (interactive)
7196 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7197 (let ((outline-regexp org-outline-regexp)
7198 (outline-level 'org-outline-level)
7199 (org-odd-levels-only nil) n)
7200 (save-excursion
7201 (goto-char (point-min))
7203 (setq n (- (length (match-string 0)) 2))
7204 (while (>= (setq n (1- n)) 0)
7205 (org-demote))
7206 (end-of-line 1))))))
7208 (defun org-convert-to-oddeven-levels ()
7209 "Convert an org-mode file with only odd levels to one with odd/even levels.
7210 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7211 file contains a section with an even level, conversion would
7212 destroy the structure of the file. An error is signaled in this
7213 case."
7214 (interactive)
7215 (goto-char (point-min))
7216 ;; First check if there are no even levels
7218 (org-show-context t)
7219 (error "Not all levels are odd in this file. Conversion not possible"))
7220 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7221 (let ((outline-regexp org-outline-regexp)
7222 (outline-level 'org-outline-level)
7223 (org-odd-levels-only nil) n)
7224 (save-excursion
7225 (goto-char (point-min))
7227 (setq n (/ (1- (length (match-string 0))) 2))
7228 (while (>= (setq n (1- n)) 0)
7229 (org-promote))
7230 (end-of-line 1))))))
7232 (defun org-tr-level (n)
7233 "Make N odd if required."
7234 (if org-odd-levels-only (1+ (/ n 2)) n))
7236 ;;; Vertical tree motion, cutting and pasting of subtrees
7238 (defun org-move-subtree-up (&optional arg)
7239 "Move the current subtree up past ARG headlines of the same level."
7240 (interactive "p")
7241 (org-move-subtree-down (- (prefix-numeric-value arg))))
7243 (defun org-move-subtree-down (&optional arg)
7244 "Move the current subtree down past ARG headlines of the same level."
7245 (interactive "p")
7246 (setq arg (prefix-numeric-value arg))
7247 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7248 'org-get-last-sibling))
7249 (ins-point (make-marker))
7250 (cnt (abs arg))
7251 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7252 ;; Select the tree
7253 (org-back-to-heading)
7254 (setq beg0 (point))
7255 (save-excursion
7256 (setq ne-beg (org-back-over-empty-lines))
7257 (setq beg (point)))
7258 (save-match-data
7259 (save-excursion (outline-end-of-heading)
7260 (setq folded (outline-invisible-p)))
7261 (outline-end-of-subtree))
7262 (outline-next-heading)
7263 (setq ne-end (org-back-over-empty-lines))
7264 (setq end (point))
7265 (goto-char beg0)
7266 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7267 ;; include less whitespace
7268 (save-excursion
7269 (goto-char beg)
7270 (forward-line (- ne-beg ne-end))
7271 (setq beg (point))))
7272 ;; Find insertion point, with error handling
7273 (while (> cnt 0)
7274 (or (and (funcall movfunc) (looking-at outline-regexp))
7275 (progn (goto-char beg0)
7276 (error "Cannot move past superior level or buffer limit")))
7277 (setq cnt (1- cnt)))
7278 (if (> arg 0)
7279 ;; Moving forward - still need to move over subtree
7280 (progn (org-end-of-subtree t t)
7281 (save-excursion
7282 (org-back-over-empty-lines)
7283 (or (bolp) (newline)))))
7284 (setq ne-ins (org-back-over-empty-lines))
7285 (move-marker ins-point (point))
7286 (setq txt (buffer-substring beg end))
7287 (org-save-markers-in-region beg end)
7288 (delete-region beg end)
7289 (org-remove-empty-overlays-at beg)
7290 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7291 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7293 (let ((bbb (point)))
7294 (insert-before-markers txt)
7295 (org-reinstall-markers-in-region bbb)
7296 (move-marker ins-point bbb))
7298 (setq ins-end (point))
7299 (goto-char ins-point)
7300 (org-skip-whitespace)
7301 (when (and (< arg 0)
7302 (org-first-sibling-p)
7303 (> ne-ins ne-beg))
7304 ;; Move whitespace back to beginning
7305 (save-excursion
7306 (goto-char ins-end)
7307 (let ((kill-whole-line t))
7308 (kill-line (- ne-ins ne-beg)) (point)))
7310 (move-marker ins-point nil)
7311 (if folded
7312 (hide-subtree)
7313 (org-show-entry)
7314 (show-children)
7315 (org-cycle-hide-drawers 'children))
7316 (org-clean-visibility-after-subtree-move)))
7318 (defvar org-subtree-clip ""
7319 "Clipboard for cut and paste of subtrees.
7320 This is actually only a copy of the kill, because we use the normal kill
7321 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7323 (defvar org-subtree-clip-folded nil
7324 "Was the last copied subtree folded?
7325 This is used to fold the tree back after pasting.")
7327 (defun org-cut-subtree (&optional n)
7328 "Cut the current subtree into the clipboard.
7329 With prefix arg N, cut this many sequential subtrees.
7330 This is a short-hand for marking the subtree and then cutting it."
7331 (interactive "p")
7332 (org-copy-subtree n 'cut))
7334 (defun org-copy-subtree (&optional n cut force-store-markers)
7335 "Cut the current subtree into the clipboard.
7336 With prefix arg N, cut this many sequential subtrees.
7337 This is a short-hand for marking the subtree and then copying it.
7338 If CUT is non-nil, actually cut the subtree.
7339 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7340 of some markers in the region, even if CUT is non-nil. This is
7341 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7342 (interactive "p")
7343 (let (beg end folded (beg0 (point)))
7344 (if (interactive-p)
7345 (org-back-to-heading nil) ; take what looks like a subtree
7346 (org-back-to-heading t)) ; take what is really there
7347 (org-back-over-empty-lines)
7348 (setq beg (point))
7350 (save-match-data
7351 (save-excursion (outline-end-of-heading)
7352 (setq folded (outline-invisible-p)))
7353 (condition-case nil
7354 (org-forward-same-level (1- n) t)
7355 (error nil))
7356 (org-end-of-subtree t t))
7357 (org-back-over-empty-lines)
7358 (setq end (point))
7359 (goto-char beg0)
7360 (when (> end beg)
7361 (setq org-subtree-clip-folded folded)
7362 (when (or cut force-store-markers)
7363 (org-save-markers-in-region beg end))
7364 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7365 (setq org-subtree-clip (current-kill 0))
7366 (message "%s: Subtree(s) with %d characters"
7367 (if cut "Cut" "Copied")
7368 (length org-subtree-clip)))))
7370 (defun org-paste-subtree (&optional level tree for-yank)
7371 "Paste the clipboard as a subtree, with modification of headline level.
7372 The entire subtree is promoted or demoted in order to match a new headline
7373 level.
7375 If the cursor is at the beginning of a headline, the same level as
7376 that headline is used to paste the tree
7378 If not, the new level is derived from the *visible* headings
7379 before and after the insertion point, and taken to be the inferior headline
7380 level of the two. So if the previous visible heading is level 3 and the
7381 next is level 4 (or vice versa), level 4 will be used for insertion.
7382 This makes sure that the subtree remains an independent subtree and does
7383 not swallow low level entries.
7385 You can also force a different level, either by using a numeric prefix
7386 argument, or by inserting the heading marker by hand. For example, if the
7389 If optional TREE is given, use this text instead of the kill ring.
7391 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7392 move back over whitespace before inserting, and move point to the end of
7393 the inserted text when done."
7394 (interactive "P")
7395 (setq tree (or tree (and kill-ring (current-kill 0))))
7396 (unless (org-kill-is-subtree-p tree)
7397 (error "%s"
7398 (substitute-command-keys
7400 (let* ((visp (not (outline-invisible-p)))
7401 (txt tree)
7406 (old-level (if (string-match ^re txt)
7407 (- (match-end 0) (match-beginning 0) 1)
7408 -1))
7409 (force-level (cond (level (prefix-numeric-value level))
7411 (string-match
7412 ^re_ (buffer-substring
7413 (point-at-bol) (point))))
7414 (- (match-end 1) (match-beginning 1)))
7415 ((and (bolp)
7416 (looking-at org-outline-regexp))
7417 (- (match-end 0) (point) 1))
7418 (t nil)))
7419 (previous-level (save-excursion
7420 (condition-case nil
7421 (progn
7422 (outline-previous-visible-heading 1)
7423 (if (looking-at re)
7424 (- (match-end 0) (match-beginning 0) 1)
7425 1))
7426 (error 1))))
7427 (next-level (save-excursion
7428 (condition-case nil
7429 (progn
7430 (or (looking-at outline-regexp)
7431 (outline-next-visible-heading 1))
7432 (if (looking-at re)
7433 (- (match-end 0) (match-beginning 0) 1)
7434 1))
7435 (error 1))))
7436 (new-level (or force-level (max previous-level next-level)))
7437 (shift (if (or (= old-level -1)
7438 (= new-level -1)
7439 (= old-level new-level))
7440 0
7441 (- new-level old-level)))
7442 (delta (if (> shift 0) -1 1))
7443 (func (if (> shift 0) 'org-demote 'org-promote))
7444 (org-odd-levels-only nil)
7445 beg end newend)
7446 ;; Remove the forced level indicator
7447 (if force-level
7448 (delete-region (point-at-bol) (point)))
7449 ;; Paste
7450 (beginning-of-line 1)
7451 (unless for-yank (org-back-over-empty-lines))
7452 (setq beg (point))
7453 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7454 (insert-before-markers txt)
7456 (setq newend (point))
7457 (org-reinstall-markers-in-region beg)
7458 (setq end (point))
7459 (goto-char beg)
7461 (setq beg (point))
7462 (if (and (outline-invisible-p) visp)
7463 (save-excursion (outline-show-heading)))
7464 ;; Shift if necessary
7465 (unless (= shift 0)
7466 (save-restriction
7467 (narrow-to-region beg end)
7468 (while (not (= shift 0))
7469 (org-map-region func (point-min) (point-max))
7470 (setq shift (+ delta shift)))
7471 (goto-char (point-min))
7472 (setq newend (point-max))))
7473 (when (or (interactive-p) for-yank)
7474 (message "Clipboard pasted as level %d subtree" new-level))
7475 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7476 kill-ring
7477 (eq org-subtree-clip (current-kill 0))
7478 org-subtree-clip-folded)
7479 ;; The tree was folded before it was killed/copied
7480 (hide-subtree))
7481 (and for-yank (goto-char newend))))
7483 (defun org-kill-is-subtree-p (&optional txt)
7484 "Check if the current kill is an outline subtree, or a set of trees.
7485 Returns nil if kill does not start with a headline, or if the first
7486 headline level is not the largest headline level in the tree.
7487 So this will actually accept several entries of equal levels as well,
7488 which is OK for `org-paste-subtree'.
7489 If optional TXT is given, check this string instead of the current kill."
7490 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7491 (start-level (and kill
7494 kill)
7495 (- (match-end 2) (match-beginning 2) 1)))
7496 (re (concat "^" org-outline-regexp))
7497 (start (1+ (or (match-beginning 2) -1))))
7498 (if (not start-level)
7499 (progn
7500 nil) ;; does not even start with a heading
7501 (catch 'exit
7502 (while (setq start (string-match re kill (1+ start)))
7503 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7504 (throw 'exit nil)))
7505 t))))
7507 (defvar org-markers-to-move nil
7508 "Markers that should be moved with a cut-and-paste operation.
7509 Those markers are stored together with their positions relative to
7510 the start of the region.")
7512 (defun org-save-markers-in-region (beg end)
7513 "Check markers in region.
7514 If these markers are between BEG and END, record their position relative
7515 to BEG, so that after moving the block of text, we can put the markers back
7516 into place.
7517 This function gets called just before an entry or tree gets cut from the
7518 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7519 called immediately, to move the markers with the entries."
7520 (setq org-markers-to-move nil)
7521 (when (featurep 'org-clock)
7522 (org-clock-save-markers-for-cut-and-paste beg end))
7523 (when (featurep 'org-agenda)
7524 (org-agenda-save-markers-for-cut-and-paste beg end)))
7526 (defun org-check-and-save-marker (marker beg end)
7527 "Check if MARKER is between BEG and END.
7528 If yes, remember the marker and the distance to BEG."
7529 (when (and (marker-buffer marker)
7530 (equal (marker-buffer marker) (current-buffer)))
7531 (if (and (>= marker beg) (< marker end))
7532 (push (cons marker (- marker beg)) org-markers-to-move))))
7534 (defun org-reinstall-markers-in-region (beg)
7535 "Move all remembered markers to their position relative to BEG."
7536 (mapc (lambda (x)
7537 (move-marker (car x) (+ beg (cdr x))))
7538 org-markers-to-move)
7539 (setq org-markers-to-move nil))
7541 (defun org-narrow-to-subtree ()
7542 "Narrow buffer to the current subtree."
7543 (interactive)
7544 (save-excursion
7545 (save-match-data
7546 (narrow-to-region
7547 (progn (org-back-to-heading t) (point))
7548 (progn (org-end-of-subtree t t)
7549 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7550 (point))))))
7552 (defun org-narrow-to-block ()
7553 "Narrow buffer to the current block."
7554 (interactive)
7557 (case-fold-search t) ;; allow #+BEGIN
7558 b_start b_end)
7559 (if (org-in-regexps-block-p bstart bend)
7560 (progn
7561 (save-excursion (re-search-backward bstart nil t)
7562 (setq b_start (match-beginning 0)))
7563 (save-excursion (re-search-forward bend nil t)
7564 (setq b_end (match-end 0)))
7565 (narrow-to-region b_start b_end))
7566 (error "Not in a block"))))
7568 (eval-when-compile
7569 (defvar org-property-drawer-re))
7571 (defvar org-property-start-re) ;; defined below
7572 (defun org-clone-subtree-with-time-shift (n &optional shift)
7573 "Clone the task (subtree) at point N times.
7574 The clones will be inserted as siblings.
7576 In interactive use, the user will be prompted for the number of
7577 clones to be produced, and for a time SHIFT, which may be a
7578 repeater as used in time stamps, for example `+3d'.
7580 When a valid repeater is given and the entry contains any time
7581 stamps, the clones will become a sequence in time, with time
7582 stamps in the subtree shifted for each clone produced. If SHIFT
7583 is nil or the empty string, time stamps will be left alone. The
7584 ID property of the original subtree is removed.
7586 If the original subtree did contain time stamps with a repeater,
7587 the following will happen:
7588 - the repeater will be removed in each clone
7589 - an additional clone will be produced, with the current, unshifted
7590 date(s) in the entry.
7591 - the original entry will be placed *after* all the clones, with
7592 repeater intact.
7593 - the start days in the repeater in the original entry will be shifted
7594 to past the last clone.
7595 I this way you can spell out a number of instances of a repeating task,
7596 and still retain the repeater to cover future instances of the task."
7597 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7598 (let (beg end template task idprop
7599 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7600 (if (not (and (integerp n) (> n 0)))
7601 (error "Invalid number of replications %s" n))
7604 shift)))
7605 (error "Invalid shift specification %s" shift))
7606 (when doshift
7607 (setq shift-n (string-to-number (match-string 1 shift))
7608 shift-what (cdr (assoc (match-string 2 shift)
7609 '(("d" . day) ("w" . week)
7610 ("m" . month) ("y" . year))))))
7611 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7612 (setq nmin 1 nmax n)
7613 (org-back-to-heading t)
7614 (setq beg (point))
7615 (setq idprop (org-entry-get nil "ID"))
7616 (org-end-of-subtree t t)
7618 (setq end (point))
7619 (setq template (buffer-substring beg end))
7620 (when (and doshift
7622 (delete-region beg end)
7623 (setq end beg)
7624 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7625 (goto-char end)
7626 (loop for n from nmin to nmax do
7627 ;; prepare clone
7628 (with-temp-buffer
7629 (insert template)
7630 (org-mode)
7631 (goto-char (point-min))
7632 (and idprop (if org-clone-delete-id
7633 (org-entry-delete nil "ID")
7634 (org-id-get-create t)))
7635 (while (re-search-forward org-property-start-re nil t)
7636 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7637 (goto-char (point-min))
7638 (when doshift
7639 (while (re-search-forward org-ts-regexp-both nil t)
7640 (org-timestamp-change (* n shift-n) shift-what))
7641 (unless (= n n-no-remove)
7642 (goto-char (point-min))
7643 (while (re-search-forward org-ts-regexp nil t)
7644 (save-excursion
7645 (goto-char (match-beginning 0))
7647 (delete-region (match-beginning 1) (match-end 1)))))))
7648 (setq task (buffer-string)))
7649 (insert task))
7650 (goto-char beg)))
7652 ;;; Outline Sorting
7654 (defun org-sort (with-case)
7655 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7656 Optional argument WITH-CASE means sort case-sensitively.
7657 With a double prefix argument, also remove duplicate entries."
7658 (interactive "P")
7659 (cond
7660 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7661 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7662 (t
7663 (org-call-with-arg 'org-sort-entries with-case))))
7665 (defun org-sort-remove-invisible (s)
7666 (remove-text-properties 0 (length s) org-rm-props s)
7667 (while (string-match org-bracket-link-regexp s)
7668 (setq s (replace-match (if (match-end 2)
7669 (match-string 3 s)
7670 (match-string 1 s)) t t s)))
7671 s)
7673 (defvar org-priority-regexp) ; defined later in the file
7675 (defvar org-after-sorting-entries-or-items-hook nil
7676 "Hook that is run after a bunch of entries or items have been sorted.
7677 When children are sorted, the cursor is in the parent line when this
7678 hook gets called. When a region or a plain list is sorted, the cursor
7679 will be in the first entry of the sorted region/list.")
7681 (defun org-sort-entries
7682 (&optional with-case sorting-type getkey-func compare-func property)
7683 "Sort entries on a certain level of an outline tree.
7684 If there is an active region, the entries in the region are sorted.
7685 Else, if the cursor is before the first entry, sort the top-level items.
7686 Else, the children of the entry at point are sorted.
7688 Sorting can be alphabetically, numerically, by date/time as given by
7689 a time stamp, by a property or by priority.
7691 The command prompts for the sorting type unless it has been given to the
7692 function through the SORTING-TYPE argument, which needs to be a character,
7693 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7694 precise meaning of each character:
7696 n Numerically, by converting the beginning of the entry/item to a number.
7697 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7698 t By date/time, either the first active time stamp in the entry, or, if
7699 none exist, by the first inactive one.
7700 s By the scheduled date/time.
7701 d By deadline date/time.
7702 c By creation time, which is assumed to be the first inactive time stamp
7703 at the beginning of a line.
7704 p By priority according to the cookie.
7705 r By the value of a property.
7707 Capital letters will reverse the sort order.
7709 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7710 called with point at the beginning of the record. It must return either
7711 a string or a number that should serve as the sorting key for that record.
7713 Comparing entries ignores case by default. However, with an optional argument
7714 WITH-CASE, the sorting considers case as well."
7715 (interactive "P")
7716 (let ((case-func (if with-case 'identity 'downcase))
7717 start beg end stars re re2
7718 txt what tmp)
7719 ;; Find beginning and end of region to sort
7720 (cond
7721 ((org-region-active-p)
7722 ;; we will sort the region
7723 (setq end (region-end)
7724 what "region")
7725 (goto-char (region-beginning))
7726 (if (not (org-on-heading-p)) (outline-next-heading))
7727 (setq start (point)))
7728 ((or (org-on-heading-p)
7729 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7730 ;; we will sort the children of the current headline
7731 (org-back-to-heading)
7732 (setq start (point)
7733 end (progn (org-end-of-subtree t t)
7735 (org-back-over-empty-lines)
7736 (point))
7737 what "children")
7738 (goto-char start)
7739 (show-subtree)
7740 (outline-next-heading))
7741 (t
7742 ;; we will sort the top-level entries in this file
7743 (goto-char (point-min))
7744 (or (org-on-heading-p) (outline-next-heading))
7745 (setq start (point))
7746 (goto-char (point-max))
7747 (beginning-of-line 1)
7749 ;; File ends in a non-white line
7750 (end-of-line 1)
7752 (setq end (point-max))
7753 (setq what "top-level")
7754 (goto-char start)
7755 (show-all)))
7757 (setq beg (point))
7758 (if (>= beg end) (error "Nothing to sort"))
7761 (setq stars (match-string 1)
7762 re (concat "^" (regexp-quote stars) " +")
7764 txt (buffer-substring beg end))
7766 (if (and (not (equal stars "*")) (string-match re2 txt))
7767 (error "Region to sort contains a level above the first entry"))
7769 (unless sorting-type
7770 (message
7771 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7773 A/N/T/S/D/C/P/O/F means reversed:"
7774 what)
7775 (setq sorting-type (read-char-exclusive))
7777 (and (= (downcase sorting-type) ?f)
7778 (setq getkey-func
7779 (org-icompleting-read "Sort using function: "
7780 obarray 'fboundp t nil nil))
7781 (setq getkey-func (intern getkey-func)))
7783 (and (= (downcase sorting-type) ?r)
7784 (setq property
7785 (org-icompleting-read "Property: "
7786 (mapcar 'list (org-buffer-property-keys t))
7787 nil t))))
7789 (message "Sorting entries...")
7791 (save-restriction
7792 (narrow-to-region start end)
7793 (let ((dcst (downcase sorting-type))
7794 (case-fold-search nil)
7795 (now (current-time)))
7796 (sort-subr
7797 (/= dcst sorting-type)
7798 ;; This function moves to the beginning character of the "record" to
7799 ;; be sorted.
7800 (lambda nil
7801 (if (re-search-forward re nil t)
7802 (goto-char (match-beginning 0))
7803 (goto-char (point-max))))
7804 ;; This function moves to the last character of the "record" being
7805 ;; sorted.
7806 (lambda nil
7807 (save-match-data
7808 (condition-case nil
7809 (outline-forward-same-level 1)
7810 (error
7811 (goto-char (point-max))))))
7812 ;; This function returns the value that gets sorted against.
7813 (lambda nil
7814 (cond
7815 ((= dcst ?n)
7816 (if (looking-at org-complex-heading-regexp)
7817 (string-to-number (match-string 4))
7818 nil))
7819 ((= dcst ?a)
7820 (if (looking-at org-complex-heading-regexp)
7821 (funcall case-func (match-string 4))
7822 nil))
7823 ((= dcst ?t)
7824 (let ((end (save-excursion (outline-next-heading) (point))))
7825 (if (or (re-search-forward org-ts-regexp end t)
7826 (re-search-forward org-ts-regexp-both end t))
7827 (org-time-string-to-seconds (match-string 0))
7828 (org-float-time now))))
7829 ((= dcst ?c)
7830 (let ((end (save-excursion (outline-next-heading) (point))))
7831 (if (re-search-forward
7833 end t)
7834 (org-time-string-to-seconds (match-string 0))
7835 (org-float-time now))))
7836 ((= dcst ?s)
7837 (let ((end (save-excursion (outline-next-heading) (point))))
7838 (if (re-search-forward org-scheduled-time-regexp end t)
7839 (org-time-string-to-seconds (match-string 1))
7840 (org-float-time now))))
7841 ((= dcst ?d)
7842 (let ((end (save-excursion (outline-next-heading) (point))))
7843 (if (re-search-forward org-deadline-time-regexp end t)
7844 (org-time-string-to-seconds (match-string 1))
7845 (org-float-time now))))
7846 ((= dcst ?p)
7847 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7848 (string-to-char (match-string 2))
7849 org-default-priority))
7850 ((= dcst ?r)
7851 (or (org-entry-get nil property) ""))
7852 ((= dcst ?o)
7853 (if (looking-at org-complex-heading-regexp)
7854 (- 9999 (length (member (match-string 2)
7855 org-todo-keywords-1)))))
7856 ((= dcst ?f)
7857 (if getkey-func
7858 (progn
7859 (setq tmp (funcall getkey-func))
7860 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7861 tmp)
7862 (error "Invalid key function `%s'" getkey-func)))
7863 (t (error "Invalid sorting type `%c'" sorting-type))))
7864 nil
7865 (cond
7866 ((= dcst ?a) 'string<)
7867 ((= dcst ?f) compare-func)
7868 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7869 (t nil)))))
7870 (run-hooks 'org-after-sorting-entries-or-items-hook)
7871 (message "Sorting entries...done")))
7873 (defun org-do-sort (table what &optional with-case sorting-type)
7874 "Sort TABLE of WHAT according to SORTING-TYPE.
7875 The user will be prompted for the SORTING-TYPE if the call to this
7876 function does not specify it. WHAT is only for the prompt, to indicate
7877 what is being sorted. The sorting key will be extracted from
7878 the car of the elements of the table.
7879 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7880 (unless sorting-type
7881 (message
7882 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7883 what)
7884 (setq sorting-type (read-char-exclusive)))
7885 (let ((dcst (downcase sorting-type))
7886 extractfun comparefun)
7887 ;; Define the appropriate functions
7888 (cond
7889 ((= dcst ?n)
7890 (setq extractfun 'string-to-number
7891 comparefun (if (= dcst sorting-type) '< '>)))
7892 ((= dcst ?a)
7893 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7894 (lambda(x) (downcase (org-sort-remove-invisible x))))
7895 comparefun (if (= dcst sorting-type)
7896 'string<
7897 (lambda (a b) (and (not (string< a b))
7898 (not (string= a b)))))))
7899 ((= dcst ?t)
7900 (setq extractfun
7901 (lambda (x)
7902 (if (or (string-match org-ts-regexp x)
7903 (string-match org-ts-regexp-both x))
7904 (org-float-time
7905 (org-time-string-to-time (match-string 0 x)))
7906 0))
7907 comparefun (if (= dcst sorting-type) '< '>)))
7908 (t (error "Invalid sorting type `%c'" sorting-type)))
7910 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7911 table)
7912 (lambda (a b) (funcall comparefun (car a) (car b))))))
7915 ;;; The orgstruct minor mode
7917 ;; Define a minor mode which can be used in other modes in order to
7918 ;; integrate the org-mode structure editing commands.
7920 ;; This is really a hack, because the org-mode structure commands use
7921 ;; keys which normally belong to the major mode. Here is how it
7922 ;; works: The minor mode defines all the keys necessary to operate the
7923 ;; structure commands, but wraps the commands into a function which
7924 ;; tests if the cursor is currently at a headline or a plain list
7925 ;; item. If that is the case, the structure command is used,
7926 ;; temporarily setting many Org-mode variables like regular
7927 ;; expressions for filling etc. However, when any of those keys is
7928 ;; used at a different location, function uses `key-binding' to look
7929 ;; up if the key has an associated command in another currently active
7930 ;; keymap (minor modes, major mode, global), and executes that
7931 ;; command. There might be problems if any of the keys is otherwise
7932 ;; used as a prefix key.
7934 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7935 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7936 ;; addresses this by checking explicitly for both bindings.
7938 (defvar orgstruct-mode-map (make-sparse-keymap)
7939 "Keymap for the minor `orgstruct-mode'.")
7941 (defvar org-local-vars nil
7942 "List of local variables, for use by `orgstruct-mode'.")
7944 ;;;###autoload
7945 (define-minor-mode orgstruct-mode
7946 "Toggle the minor mode `orgstruct-mode'.
7947 This mode is for using Org-mode structure commands in other
7948 modes. The following keys behave as if Org-mode were active, if
7949 the cursor is on a headline, or on a plain list item (both as
7950 defined by Org-mode).
7952 M-up Move entry/item up
7953 M-down Move entry/item down
7954 M-left Promote
7955 M-right Demote
7956 M-S-up Move entry/item up
7957 M-S-down Move entry/item down
7958 M-S-left Promote subtree
7959 M-S-right Demote subtree
7960 M-q Fill paragraph and items like in Org-mode
7961 C-c ^ Sort entries
7962 C-c - Cycle list bullet
7963 TAB Cycle item visibility
7964 M-RET Insert new heading/item
7965 S-M-RET Insert new TODO heading / Checkbox item
7966 C-c C-c Set tags / toggle checkbox"
7967 nil " OrgStruct" nil
7968 (org-load-modules-maybe)
7969 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7971 ;;;###autoload
7972 (defun turn-on-orgstruct ()
7973 "Unconditionally turn on `orgstruct-mode'."
7974 (orgstruct-mode 1))
7976 (defun orgstruct++-mode (&optional arg)
7977 "Toggle `orgstruct-mode', the enhanced version of it.
7978 In addition to setting orgstruct-mode, this also exports all indentation
7979 and autofilling variables from org-mode into the buffer. It will also
7980 recognize item context in multiline items.
7981 Note that turning off orgstruct-mode will *not* remove the
7982 indentation/paragraph settings. This can only be done by refreshing the
7984 (interactive "P")
7985 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7986 (if (< arg 1)
7987 (orgstruct-mode -1)
7988 (orgstruct-mode 1)
7989 (let (var val)
7990 (mapc
7991 (lambda (x)
7992 (when (string-match
7994 (symbol-name (car x)))
7995 (setq var (car x) val (nth 1 x))
7996 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7997 org-local-vars)
7998 (org-set-local 'orgstruct-is-++ t))))
8000 (defvar orgstruct-is-++ nil
8001 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8002 (make-variable-buffer-local 'orgstruct-is-++)
8004 ;;;###autoload
8005 (defun turn-on-orgstruct++ ()
8006 "Unconditionally turn on `orgstruct++-mode'."
8007 (orgstruct++-mode 1))
8009 (defun orgstruct-error ()
8010 "Error when there is no default binding for a structure key."
8011 (interactive)
8012 (error "This key has no function outside structure elements"))
8014 (defun orgstruct-setup ()
8015 "Setup orgstruct keymaps."
8016 (let ((nfunc 0)
8017 (bindings
8018 (list
8019 '([(meta up)] org-metaup)
8020 '([(meta down)] org-metadown)
8021 '([(meta left)] org-metaleft)
8022 '([(meta right)] org-metaright)
8023 '([(meta shift up)] org-shiftmetaup)
8024 '([(meta shift down)] org-shiftmetadown)
8025 '([(meta shift left)] org-shiftmetaleft)
8026 '([(meta shift right)] org-shiftmetaright)
8027 '([?\e (up)] org-metaup)
8028 '([?\e (down)] org-metadown)
8029 '([?\e (left)] org-metaleft)
8030 '([?\e (right)] org-metaright)
8031 '([?\e (shift up)] org-shiftmetaup)
8032 '([?\e (shift down)] org-shiftmetadown)
8033 '([?\e (shift left)] org-shiftmetaleft)
8034 '([?\e (shift right)] org-shiftmetaright)
8035 '([(shift up)] org-shiftup)
8036 '([(shift down)] org-shiftdown)
8037 '([(shift left)] org-shiftleft)
8038 '([(shift right)] org-shiftright)
8039 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8040 '("\M-q" fill-paragraph)
8041 '("\C-c^" org-sort)
8042 '("\C-c-" org-cycle-list-bullet)))
8043 elt key fun cmd)
8044 (while (setq elt (pop bindings))
8045 (setq nfunc (1+ nfunc))
8046 (setq key (org-key (car elt))
8047 fun (nth 1 elt)
8048 cmd (orgstruct-make-binding fun nfunc key))
8049 (org-defkey orgstruct-mode-map key cmd))
8051 ;; Special treatment needed for TAB and RET
8052 (org-defkey orgstruct-mode-map [(tab)]
8053 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8054 (org-defkey orgstruct-mode-map "\C-i"
8055 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8057 (org-defkey orgstruct-mode-map "\M-\C-m"
8058 (orgstruct-make-binding 'org-insert-heading 105
8059 "\M-\C-m" [(meta return)]))
8060 (org-defkey orgstruct-mode-map [(meta return)]
8061 (orgstruct-make-binding 'org-insert-heading 106
8062 [(meta return)] "\M-\C-m"))
8064 (org-defkey orgstruct-mode-map [(shift meta return)]
8065 (orgstruct-make-binding 'org-insert-todo-heading 107
8066 [(meta return)] "\M-\C-m"))
8068 (org-defkey orgstruct-mode-map "\e\C-m"
8069 (orgstruct-make-binding 'org-insert-heading 108
8070 "\e\C-m" [?\e (return)]))
8071 (org-defkey orgstruct-mode-map [?\e (return)]
8072 (orgstruct-make-binding 'org-insert-heading 109
8073 [?\e (return)] "\e\C-m"))
8074 (org-defkey orgstruct-mode-map [?\e (shift return)]
8075 (orgstruct-make-binding 'org-insert-todo-heading 110
8076 [?\e (return)] "\e\C-m"))
8078 (unless org-local-vars
8079 (setq org-local-vars (org-get-local-variables)))
8081 t))
8083 (defun orgstruct-make-binding (fun n &rest keys)
8084 "Create a function for binding in the structure minor mode.
8085 FUN is the command to call inside a table. N is used to create a unique
8086 command name. KEYS are keys that should be checked in for a command
8087 to execute outside of tables."
8088 (eval
8089 (list 'defun
8090 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8091 '(arg)
8093 "Outside of structure, run the binding of `"
8094 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8095 "'.")
8096 '(interactive "p")
8097 (list 'if
8098 `(org-context-p 'headline 'item
8099 (and orgstruct-is-++
8100 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8101 'item-body))
8102 (list 'org-run-like-in-org-mode (list 'quote fun))
8103 (list 'let '(orgstruct-mode)
8104 (list 'call-interactively
8105 (append '(or)
8106 (mapcar (lambda (k)
8107 (list 'key-binding k))
8108 keys)
8109 '('orgstruct-error))))))))
8111 (defun org-context-p (&rest contexts)
8112 "Check if local context is any of CONTEXTS.
8113 Possible values in the list of contexts are `table', `headline', and `item'."
8114 (let ((pos (point)))
8115 (goto-char (point-at-bol))
8116 (prog1 (or (and (memq 'table contexts)
8118 (and (memq 'headline contexts)
8120 (looking-at outline-regexp))
8121 (and (memq 'item contexts)
8123 (and (memq 'item-body contexts)
8124 (org-in-item-p)))
8125 (goto-char pos))))
8127 (defun org-get-local-variables ()
8128 "Return a list of all local variables in an org-mode buffer."
8129 (let (varlist)
8130 (with-current-buffer (get-buffer-create "*Org tmp*")
8131 (erase-buffer)
8132 (org-mode)
8133 (setq varlist (buffer-local-variables)))
8134 (kill-buffer "*Org tmp*")
8135 (delq nil
8136 (mapcar
8137 (lambda (x)
8138 (setq x
8139 (if (symbolp x)
8140 (list x)
8141 (list (car x) (list 'quote (cdr x)))))
8142 (if (string-match
8143 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8144 (symbol-name (car x)))
8145 x nil))
8146 varlist))))
8148 ;;;###autoload
8149 (defun org-run-like-in-org-mode (cmd)
8150 "Run a command, pretending that the current buffer is in Org-mode.
8151 This will temporarily bind local variables that are typically bound in
8152 Org-mode to the values they have in Org-mode, and then interactively
8153 call CMD."
8154 (org-load-modules-maybe)
8155 (unless org-local-vars
8156 (setq org-local-vars (org-get-local-variables)))
8157 (eval (list 'let org-local-vars
8158 (list 'call-interactively (list 'quote cmd)))))
8160 ;;;; Archiving
8162 (defun org-get-category (&optional pos force-refresh)
8163 "Get the category applying to position POS."
8164 (if force-refresh (org-refresh-category-properties))
8165 (let ((pos (or pos (point))))
8166 (or (get-text-property pos 'org-category)
8167 (progn (org-refresh-category-properties)
8168 (get-text-property pos 'org-category)))))
8170 (defun org-refresh-category-properties ()
8171 "Refresh category text properties in the buffer."
8172 (let ((def-cat (cond
8173 ((null org-category)
8174 (if buffer-file-name
8175 (file-name-sans-extension
8176 (file-name-nondirectory buffer-file-name))
8177 "???"))
8178 ((symbolp org-category) (symbol-name org-category))
8179 (t org-category)))
8180 beg end cat pos optionp)
8181 (org-unmodified
8182 (save-excursion
8183 (save-restriction
8184 (widen)
8185 (goto-char (point-min))
8186 (put-text-property (point) (point-max) 'org-category def-cat)
8187 (while (re-search-forward
8189 (setq pos (match-end 0)
8190 optionp (equal (char-after (match-beginning 0)) ?#)
8191 cat (org-trim (match-string 2)))
8192 (if optionp
8193 (setq beg (point-at-bol) end (point-max))
8194 (org-back-to-heading t)
8195 (setq beg (point) end (org-end-of-subtree t t)))
8196 (put-text-property beg end 'org-category cat)
8197 (goto-char pos)))))))
8200 ;;;; Link Stuff
8202 ;;; Link abbreviations
8204 (defun org-link-expand-abbrev (link)
8205 "Apply replacements as defined in `org-link-abbrev-alist."
8207 (let* ((key (match-string 1 link))
8208 (as (or (assoc key org-link-abbrev-alist-local)
8209 (assoc key org-link-abbrev-alist)))
8210 (tag (and (match-end 2) (match-string 3 link)))
8211 rpl)
8212 (if (not as)
8213 link
8214 (setq rpl (cdr as))
8215 (cond
8216 ((symbolp rpl) (funcall rpl tag))
8217 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8218 ((string-match "%h" rpl)
8219 (replace-match (url-hexify-string (or tag "")) t t rpl))
8220 (t (concat rpl tag)))))
8221 link))
8223 ;;; Storing and inserting links
8225 (defvar org-insert-link-history nil
8226 "Minibuffer history for links inserted with `org-insert-link'.")
8228 (defvar org-stored-links nil
8229 "Contains the links stored with `org-store-link'.")
8231 (defvar org-store-link-plist nil
8232 "Plist with info about the most recently link created with `org-store-link'.")
8234 (defvar org-link-protocols nil
8235 "Link protocols added to Org-mode using `org-add-link-type'.")
8237 (defvar org-store-link-functions nil
8238 "List of functions that are called to create and store a link.
8239 Each function will be called in turn until one returns a non-nil
8240 value. Each function should check if it is responsible for creating
8241 this link (for example by looking at the major mode).
8242 If not, it must exit and return nil.
8243 If yes, it should return a non-nil value after a calling
8244 `org-store-link-props' with a list of properties and values.
8245 Special properties are:
8249 This is obligatory as well.
8250 :description Optional default description for the second pair
8251 of brackets in an Org-mode link. The user can still change
8252 this when inserting this link into an Org-mode buffer.
8254 In addition to these, any additional properties can be specified
8255 and then used in remember templates.")
8257 (defun org-add-link-type (type &optional follow export)
8258 "Add TYPE to the list of `org-link-types'.
8259 Re-compute all regular expressions depending on `org-link-types'
8261 FOLLOW and EXPORT are two functions.
8263 FOLLOW should take the link path as the single argument and do whatever
8264 is necessary to follow the link, for example find a file or display
8265 a mail message.
8267 EXPORT should format the link path for export to one of the export formats.
8268 It should be a function accepting three arguments:
8271 desc the description of the link, if any, or a description added by
8272 org-export-normalize-links if there is none
8273 format the export format, a symbol like `html' or `latex' or `ascii'..
8275 The function may use the FORMAT information to return different values
8276 depending on the format. The return value will be put literally into
8277 the exported file. If the return value is nil, this means Org should
8278 do what it normally does with links which do not have EXPORT defined.
8280 Org-mode has a built-in default for exporting links. If you are happy with
8281 this default, there is no need to define an export function for the link
8282 type. For a simple example of an export function, see `org-bbdb.el'."
8283 (add-to-list 'org-link-types type t)
8284 (org-make-link-regexps)
8285 (if (assoc type org-link-protocols)
8286 (setcdr (assoc type org-link-protocols) (list follow export))
8287 (push (list type follow export) org-link-protocols)))
8289 (defvar org-agenda-buffer-name)
8291 ;;;###autoload
8292 (defun org-store-link (arg)
8294 This link is added to `org-stored-links' and can later be inserted
8297 For some link types, a prefix arg is interpreted:
8298 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8299 For file links, arg negates `org-context-in-file-links'."
8300 (interactive "P")
8301 (org-load-modules-maybe)
8302 (setq org-store-link-plist nil) ; reset
8303 (org-with-limited-levels
8304 (let (link cpltxt desc description search txt custom-id agenda-link)
8305 (cond
8307 ((run-hook-with-args-until-success 'org-store-link-functions)
8308 (setq link (plist-get org-store-link-plist :link)
8309 desc (or (plist-get org-store-link-plist :description) link)))
8311 ((equal (buffer-name) "*Org Edit Src Example*")
8312 (let (label gc)
8313 (while (or (not label)
8314 (save-excursion
8315 (save-restriction
8316 (widen)
8317 (goto-char (point-min))
8318 (re-search-forward
8319 (regexp-quote (format org-coderef-label-format label))
8320 nil t))))
8321 (when label (message "Label exists already") (sit-for 2))
8322 (setq label (read-string "Code line label: " label)))
8323 (end-of-line 1)
8324 (setq link (format org-coderef-label-format label))
8325 (setq gc (- 79 (length link)))
8326 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8327 (insert link)
8328 (setq link (concat "(" label ")") desc nil)))
8330 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8331 ;; We are in the agenda, link to referenced location
8332 (let ((m (or (get-text-property (point) 'org-hd-marker)
8333 (get-text-property (point) 'org-marker))))
8334 (when m
8335 (org-with-point-at m
8336 (setq agenda-link
8337 (if (interactive-p)
8338 (call-interactively 'org-store-link)
8339 (org-store-link nil)))))))
8341 ((eq major-mode 'calendar-mode)
8342 (let ((cd (calendar-cursor-to-date)))
8343 (setq link
8344 (format-time-string
8345 (car org-time-stamp-formats)
8346 (apply 'encode-time
8347 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8348 nil nil nil))))
8349 (org-store-link-props :type "calendar" :date cd)))
8351 ((eq major-mode 'w3-mode)
8352 (setq cpltxt (if (and (buffer-name)
8353 (not (string-match "Untitled" (buffer-name))))
8354 (buffer-name)
8355 (url-view-url t))
8356 link (org-make-link (url-view-url t)))
8357 (org-store-link-props :type "w3" :url (url-view-url t)))
8359 ((eq major-mode 'w3m-mode)
8360 (setq cpltxt (or w3m-current-title w3m-current-url)
8361 link (org-make-link w3m-current-url))
8362 (org-store-link-props :type "w3m" :url (url-view-url t)))
8364 ((setq search (run-hook-with-args-until-success
8365 'org-create-file-search-functions))
8366 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8367 "::" search))
8368 (setq cpltxt (or description link)))
8370 ((eq major-mode 'image-mode)
8371 (setq cpltxt (concat "file:"
8372 (abbreviate-file-name buffer-file-name))
8373 link (org-make-link cpltxt))
8374 (org-store-link-props :type "image" :file buffer-file-name))
8376 ((eq major-mode 'dired-mode)
8377 ;; link to the file in the current line
8378 (let ((file (dired-get-filename nil t)))
8379 (setq file (if file
8380 (abbreviate-file-name
8381 (expand-file-name (dired-get-filename nil t)))
8382 ;; otherwise, no file so use current directory.
8383 default-directory))
8384 (setq cpltxt (concat "file:" file)
8385 link (org-make-link cpltxt))))
8387 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8388 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8389 (cond
8391 (setq cpltxt
8392 (concat "file:"
8393 (abbreviate-file-name
8394 (buffer-file-name (buffer-base-buffer)))
8395 "::" (match-string 1))
8396 link (org-make-link cpltxt)))
8397 ((and (featurep 'org-id)
8398 (or (eq org-link-to-org-use-id t)
8399 (and (eq org-link-to-org-use-id 'create-if-interactive)
8400 (interactive-p))
8401 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8402 (interactive-p)
8403 (not custom-id))
8404 (and org-link-to-org-use-id
8405 (org-entry-get nil "ID"))))
8406 ;; We can make a link using the ID.
8407 (setq link (condition-case nil
8408 (prog1 (org-id-store-link)
8409 (setq desc (plist-get org-store-link-plist
8410 :description)))
8411 (error
8412 ;; probably before first headline, link to file only
8413 (concat "file:"
8414 (abbreviate-file-name
8415 (buffer-file-name (buffer-base-buffer))))))))
8416 (t
8417 ;; Just link to current headline
8418 (setq cpltxt (concat "file:"
8419 (abbreviate-file-name
8420 (buffer-file-name (buffer-base-buffer)))))
8421 ;; Add a context search string
8422 (when (org-xor org-context-in-file-links arg)
8423 (setq txt (cond
8424 ((org-on-heading-p) nil)
8425 ((org-region-active-p)
8426 (buffer-substring (region-beginning) (region-end)))
8427 (t nil)))
8429 (setq cpltxt
8430 (concat cpltxt "::"
8431 (condition-case nil
8432 (org-make-org-heading-search-string txt)
8433 (error "")))
8434 desc (or (nth 4 (ignore-errors
8435 (org-heading-components))) "NONE"))))
8437 (setq cpltxt (substring cpltxt 0 -2)))
8438 (setq link (org-make-link cpltxt)))))
8440 ((buffer-file-name (buffer-base-buffer))
8441 ;; Just link to this file here.
8442 (setq cpltxt (concat "file:"
8443 (abbreviate-file-name
8444 (buffer-file-name (buffer-base-buffer)))))
8445 ;; Add a context string
8446 (when (org-xor org-context-in-file-links arg)
8447 (setq txt (if (org-region-active-p)
8448 (buffer-substring (region-beginning) (region-end))
8449 (buffer-substring (point-at-bol) (point-at-eol))))
8450 ;; Only use search option if there is some text.
8452 (setq cpltxt
8453 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8454 desc "NONE")))
8455 (setq link (org-make-link cpltxt)))
8457 ((interactive-p)
8458 (error "Cannot link to a buffer which is not visiting a file"))
8460 (t (setq link nil)))
8462 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8463 (setq link (or link cpltxt)
8464 desc (or desc cpltxt))
8465 (if (equal desc "NONE") (setq desc nil))
8467 (if (and (or (interactive-p) executing-kbd-macro) link)
8468 (progn
8469 (setq org-stored-links
8470 (cons (list link desc) org-stored-links))
8471 (message "Stored: %s" (or desc link))
8472 (when custom-id
8473 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8474 "::#" custom-id))
8475 (setq org-stored-links
8476 (cons (list link desc) org-stored-links))))
8477 (or agenda-link (and link (org-make-link-string link desc)))))))
8479 (defun org-store-link-props (&rest plist)
8480 "Store link properties, extract names and addresses."
8481 (let (x adr)
8482 (when (setq x (plist-get plist :from))
8483 (setq adr (mail-extract-address-components x))
8484 (setq plist (plist-put plist :fromname (car adr)))
8485 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8486 (when (setq x (plist-get plist :to))
8487 (setq adr (mail-extract-address-components x))
8488 (setq plist (plist-put plist :toname (car adr)))
8489 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8490 (let ((from (plist-get plist :from))
8491 (to (plist-get plist :to)))
8492 (when (and from to org-from-is-user-regexp)
8493 (setq plist
8494 (plist-put plist :fromto
8495 (if (string-match org-from-is-user-regexp from)
8496 (concat "to %t")
8497 (concat "from %f"))))))
8498 (setq org-store-link-plist plist))
8500 (defun org-add-link-props (&rest plist)
8501 "Add these properties to the link property list."
8502 (let (key value)
8503 (while plist
8504 (setq key (pop plist) value (pop plist))
8505 (setq org-store-link-plist
8506 (plist-put org-store-link-plist key value)))))
8508 (defun org-email-link-description (&optional fmt)
8509 "Return the description part of an email link.
8510 This takes information from `org-store-link-plist' and formats it
8511 according to FMT (default from `org-email-link-description-format')."
8512 (setq fmt (or fmt org-email-link-description-format))
8513 (let* ((p org-store-link-plist)
8514 (to (plist-get p :toaddress))
8515 (from (plist-get p :fromaddress))
8516 (table
8517 (list
8518 (cons "%c" (plist-get p :fromto))
8519 (cons "%F" (plist-get p :from))
8520 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8521 (cons "%T" (plist-get p :to))
8522 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8523 (cons "%s" (plist-get p :subject))
8524 (cons "%d" (plist-get p :date))
8525 (cons "%m" (plist-get p :message-id)))))
8526 (when (string-match "%c" fmt)
8527 ;; Check if the user wrote this message
8528 (if (and org-from-is-user-regexp from to
8529 (save-match-data (string-match org-from-is-user-regexp from)))
8530 (setq fmt (replace-match "to %t" t t fmt))
8531 (setq fmt (replace-match "from %f" t t fmt))))
8532 (org-replace-escapes fmt table)))
8534 (defun org-make-org-heading-search-string (&optional string heading)
8535 "Make search string for STRING or current headline."
8536 (interactive)
8537 (let ((s (or string (org-get-heading)))
8538 (lines org-context-in-file-links))
8539 (unless (and string (not heading))
8540 ;; We are using a headline, clean up garbage in there.
8541 (if (string-match org-todo-regexp s)
8542 (setq s (replace-match "" t t s)))
8544 (setq s (replace-match "" t t s)))
8545 (setq s (org-trim s))
8548 (setq s (replace-match "" t t s)))
8549 (while (string-match org-ts-regexp s)
8550 (setq s (replace-match "" t t s))))
8551 (or string (setq s (concat "*" s))) ; Add * for headlines
8552 (when (and string (integerp lines) (> lines 0))
8554 (when (< lines (length slines))
8555 (setq s (mapconcat
8556 'identity
8557 (reverse (nthcdr (- (length slines) lines)
8561 (defun org-make-link (&rest strings)
8562 "Concatenate STRINGS."
8563 (apply 'concat strings))
8565 (defun org-make-link-string (link &optional description)
8566 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8568 (error "Empty link"))
8569 (when (and description
8570 (stringp description)
8572 (setq description nil))
8573 (when (stringp description)
8574 ;; Remove brackets from the description, they are fatal.
8576 (setq description (replace-match "{" t t description)))
8578 (setq description (replace-match "}" t t description))))
8579 (when (equal (org-link-escape link) description)
8580 ;; No description needed, it is identical
8581 (setq description nil))
8582 (when (and (not description)
8583 (not (equal link (org-link-escape link))))
8584 (setq description (org-extract-attributes link)))
8585 (setq link (if (string-match org-link-types-re link)
8586 (concat (match-string 1 link)
8587 (org-link-escape (substring link (match-end 1))))
8588 (org-link-escape link)))
8589 (concat "[[" link "]"
8590 (if description (concat "[" description "]") "")
8591 "]"))
8593 (defconst org-link-escape-chars
8594 '((?\ . "%20")
8595 (?\[ . "%5B")
8596 (?\] . "%5D")
8607 (?\; . "%3B")
8608 ;; (?? . "%3F")
8609 (?= . "%3D")
8610 (?+ . "%2B")
8611 )
8612 "Association list of escapes for some characters problematic in links.
8613 This is the list that is used for internal purposes.")
8615 (defvar org-url-encoding-use-url-hexify nil)
8617 (defconst org-link-escape-chars-browser
8618 '((?\ . "%20")) ; 32 for the SPC char
8619 "Association list of escapes for some characters problematic in links.
8620 This is the list that is used before handing over to the browser.")
8622 (defun org-link-escape (text &optional table)
8623 "Escape characters in TEXT that are problematic for links."
8624 (if (and org-url-encoding-use-url-hexify (not table))
8625 (url-hexify-string text)
8626 (setq table (or table org-link-escape-chars))
8627 (when text
8628 (let ((re (mapconcat (lambda (x) (regexp-quote
8629 (char-to-string (car x))))
8631 (while (string-match re text)
8632 (setq text
8633 (replace-match
8634 (cdr (assoc (string-to-char (match-string 0 text))
8635 table))
8636 t t text)))
8637 text))))
8639 (defun org-link-unescape (text &optional table)
8640 "Reverse the action of `org-link-escape'."
8641 (if (and org-url-encoding-use-url-hexify (not table))
8642 (url-unhex-string text)
8643 (setq table (or table org-link-escape-chars))
8644 (when text
8645 (let ((case-fold-search t)
8646 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8648 (while (string-match re text)
8649 (setq text
8650 (replace-match
8651 (char-to-string (car (rassoc (upcase (match-string 0 text))
8652 table)))
8653 t t text)))
8654 text))))
8656 (defun org-xor (a b)
8657 "Exclusive or."
8658 (if a (not b) b))
8660 (defun org-fixup-message-id-for-http (s)
8661 "Replace special characters in a message id, so it can be used in an http query."
8662 (when (string-match "%" s)
8663 (setq s (mapconcat (lambda (c)
8664 (if (eq c ?%)
8665 "%25"
8666 (char-to-string c)))
8667 s "")))
8668 (while (string-match "<" s)
8669 (setq s (replace-match "%3C" t t s)))
8670 (while (string-match ">" s)
8671 (setq s (replace-match "%3E" t t s)))
8672 (while (string-match "@" s)
8673 (setq s (replace-match "%40" t t s)))
8674 s)
8676 ;;;###autoload
8677 (defun org-insert-link-global ()
8678 "Insert a link like Org-mode does.
8679 This command can be called in any mode to insert a link in Org-mode syntax."
8680 (interactive)
8681 (org-load-modules-maybe)
8682 (org-run-like-in-org-mode 'org-insert-link))
8684 (defun org-insert-link (&optional complete-file link-location)
8685 "Insert a link. At the prompt, enter the link.
8687 Completion can be used to insert any of the link protocol prefixes like
8688 http or ftp in use.
8690 The history can be used to select a link previously stored with
8691 `org-store-link'. When the empty string is entered (i.e. if you just
8692 press RET at the prompt), the link defaults to the most recently
8693 stored link. As SPC triggers completion in the minibuffer, you need to
8694 use M-SPC or C-q SPC to force the insertion of a space character.
8696 You will also be prompted for a description, and if one is given, it will
8697 be displayed in the buffer instead of the link.
8699 If there is already a link at point, this command will allow you to edit link
8700 and description parts.
8703 be selected using completion. The path to the file will be relative to the
8704 current directory if the file is in the current directory or a subdirectory.
8705 Otherwise, the link will be the absolute path as completed in the minibuffer
8706 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8707 option `org-link-file-path-type'.
8710 the current directory or below.
8713 `org-keep-stored-link-after-insertion'.
8715 If `org-make-link-description-function' is non-nil, this function will be
8716 called with the link target, and the result will be the default
8717 link description.
8719 If the LINK-LOCATION parameter is non-nil, this value will be
8720 used as the link location instead of reading one interactively."
8721 (interactive "P")
8722 (let* ((wcf (current-window-configuration))
8723 (region (if (org-region-active-p)
8724 (buffer-substring (region-beginning) (region-end))))
8725 (remove (and region (list (region-beginning) (region-end))))
8726 (desc region)
8727 tmphist ; byte-compile incorrectly complains about this
8728 (link link-location)
8729 entry file all-prefixes)
8730 (cond
8731 (link-location) ; specified by arg, just use it.
8732 ((org-in-regexp org-bracket-link-regexp 1)
8733 ;; We do have a link at point, and we are going to edit it.
8734 (setq remove (list (match-beginning 0) (match-end 0)))
8735 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8736 (setq link (read-string "Link: "
8737 (org-link-unescape
8738 (org-match-string-no-properties 1)))))
8739 ((or (org-in-regexp org-angle-link-re)
8740 (org-in-regexp org-plain-link-re))
8741 ;; Convert to bracket link
8742 (setq remove (list (match-beginning 0) (match-end 0))
8743 link (read-string "Link: "
8744 (org-remove-angle-brackets (match-string 0)))))
8745 ((member complete-file '((4) (16)))
8746 ;; Completing read for file names.
8747 (setq link (org-file-complete-link complete-file)))
8748 (t
8749 ;; Read link, with completion for stored links.
8750 (with-output-to-temp-buffer "*Org Links*"
8751 (princ "Insert a link.
8753 (when org-stored-links
8755 (princ (mapconcat
8756 (lambda (x)
8757 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8759 (let ((cw (selected-window)))
8760 (select-window (get-buffer-window "*Org Links*" 'visible))
8761 (setq truncate-lines t)
8762 (unless (pos-visible-in-window-p (point-max))
8763 (org-fit-window-to-buffer))
8764 (and (window-live-p cw) (select-window cw)))
8765 ;; Fake a link history, containing the stored links.
8766 (setq tmphist (append (mapcar 'car org-stored-links)
8767 org-insert-link-history))
8768 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8769 (mapcar 'car org-link-abbrev-alist)
8770 org-link-types))
8771 (unwind-protect
8772 (progn
8773 (setq link
8774 (let ((org-completion-use-ido nil)
8775 (org-completion-use-iswitchb nil))
8776 (org-completing-read
8777 "Link: "
8778 (append
8779 (mapcar (lambda (x) (list (concat x ":")))
8780 all-prefixes)
8781 (mapcar 'car org-stored-links))
8782 nil nil nil
8783 'tmphist
8784 (car (car org-stored-links)))))
8786 (error "No link selected"))
8787 (if (or (member link all-prefixes)
8788 (and (equal ":" (substring link -1))
8789 (member (substring link 0 -1) all-prefixes)
8790 (setq link (substring link 0 -1))))
8791 (setq link (org-link-try-special-completion link))))
8792 (set-window-configuration wcf)
8793 (kill-buffer "*Org Links*"))
8794 (setq entry (assoc link org-stored-links))
8795 (or entry (push link org-insert-link-history))
8796 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8797 (not org-keep-stored-link-after-insertion))
8798 (setq org-stored-links (delq (assoc link org-stored-links)
8799 org-stored-links)))
8800 (setq desc (or desc (nth 1 entry)))))
8802 (if (string-match org-plain-link-re link)
8803 ;; URL-like link, normalize the use of angular brackets.
8804 (setq link (org-make-link (org-remove-angle-brackets link))))
8806 ;; Check if we are linking to the current file with a search option
8807 ;; If yes, simplify the link by using only the search option.
8808 (when (and buffer-file-name
8810 (let* ((path (match-string 1 link))
8811 (case-fold-search nil)
8812 (search (match-string 2 link)))
8813 (save-match-data
8814 (if (equal (file-truename buffer-file-name) (file-truename path))
8815 ;; We are linking to this same file, with a search option
8816 (setq link search)))))
8818 ;; Check if we can/should use a relative path. If yes, simplify the link
8820 (let* ((type (match-string 1 link))
8821 (path (match-string 2 link))
8822 (origpath path)
8823 (case-fold-search nil))
8824 (cond
8825 ((or (eq org-link-file-path-type 'absolute)
8826 (equal complete-file '(16)))
8827 (setq path (abbreviate-file-name (expand-file-name path))))
8828 ((eq org-link-file-path-type 'noabbrev)
8829 (setq path (expand-file-name path)))
8830 ((eq org-link-file-path-type 'relative)
8831 (setq path (file-relative-name path)))
8832 (t
8833 (save-match-data
8834 (if (string-match (concat "^" (regexp-quote
8835 (expand-file-name
8836 (file-name-as-directory
8837 default-directory))))
8838 (expand-file-name path))
8839 ;; We are linking a file with relative path name.
8840 (setq path (substring (expand-file-name path)
8841 (match-end 0)))
8842 (setq path (abbreviate-file-name (expand-file-name path)))))))
8843 (setq link (concat type path))
8844 (if (equal desc origpath)
8845 (setq desc path))))
8847 (if org-make-link-description-function
8848 (setq desc (funcall org-make-link-description-function link desc)))
8850 (setq desc (read-string "Description: " desc))
8852 (if remove (apply 'delete-region remove))
8853 (insert (org-make-link-string link desc))))
8855 (defun org-link-try-special-completion (type)
8856 "If there is completion support for link type TYPE, offer it."
8857 (let ((fun (intern (concat "org-" type "-complete-link"))))
8858 (if (functionp fun)
8859 (funcall fun)
8860 (read-string "Link (no completion support): " (concat type ":")))))
8862 (defun org-file-complete-link (&optional arg)
8863 "Create a file link using completion."
8864 (let (file link)
8865 (setq file (read-file-name "File: "))
8866 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8867 (pwd1 (file-name-as-directory (abbreviate-file-name
8868 (expand-file-name ".")))))
8869 (cond
8870 ((equal arg '(16))
8871 (setq link (org-make-link
8872 "file:"
8873 (abbreviate-file-name (expand-file-name file)))))
8875 (setq link (org-make-link "file:" (match-string 1 file))))
8877 (expand-file-name file))
8878 (setq link (org-make-link
8879 "file:" (match-string 1 (expand-file-name file)))))
8880 (t (setq link (org-make-link "file:" file)))))
8881 link))
8883 (defun org-completing-read (&rest args)
8884 "Completing-read with SPACE being a normal character."
8885 (let ((minibuffer-local-completion-map
8886 (copy-keymap minibuffer-local-completion-map)))
8887 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8888 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8889 (apply 'org-icompleting-read args)))
8891 (defun org-completing-read-no-i (&rest args)
8892 (let (org-completion-use-ido org-completion-use-iswitchb)
8893 (apply 'org-completing-read args)))
8895 (defun org-iswitchb-completing-read (prompt choices &rest args)
8896 "Use iswitch as a completing-read replacement to choose from choices.
8897 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8898 from."
8899 (let* ((iswitchb-use-virtual-buffers nil)
8900 (iswitchb-make-buflist-hook
8901 (lambda ()
8902 (setq iswitchb-temp-buflist choices))))
8903 (iswitchb-read-buffer prompt)))
8905 (defun org-icompleting-read (&rest args)
8906 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8907 (org-without-partial-completion
8908 (if (and org-completion-use-ido
8909 (fboundp 'ido-completing-read)
8910 (boundp 'ido-mode) ido-mode
8911 (listp (second args)))
8912 (let ((ido-enter-matching-directory nil))
8913 (apply 'ido-completing-read (concat (car args))
8914 (if (consp (car (nth 1 args)))
8915 (mapcar (lambda (x) (car x)) (nth 1 args))
8916 (nth 1 args))
8917 (cddr args)))
8918 (if (and org-completion-use-iswitchb
8919 (boundp 'iswitchb-mode) iswitchb-mode
8920 (listp (second args)))
8921 (apply 'org-iswitchb-completing-read (concat (car args))
8922 (if (consp (car (nth 1 args)))
8923 (mapcar (lambda (x) (car x)) (nth 1 args))
8924 (nth 1 args))
8925 (cddr args))
8926 (apply 'completing-read args)))))
8928 (defun org-extract-attributes (s)
8929 "Extract the attributes cookie from a string and set as text property."
8930 (let (a attr (start 0) key value)
8931 (save-match-data
8933 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8935 (setq key (match-string 1 a) value (match-string 2 a)
8936 start (match-end 0)
8937 attr (plist-put attr (intern key) value))))
8938 (org-add-props s nil 'org-attr attr))
8939 s))
8941 (defun org-extract-attributes-from-string (tag)
8942 (let (key value attr)
8944 (setq key (match-string 1 tag) value (match-string 2 tag)
8945 tag (replace-match "" t t tag)
8946 attr (plist-put attr (intern key) value)))
8947 (cons tag attr)))
8949 (defun org-attributes-to-string (plist)
8950 "Format a property list into an HTML attribute list."
8951 (let ((s "") key value)
8952 (while plist
8953 (setq key (pop plist) value (pop plist))
8954 (and value
8956 s))
8958 ;;; Opening/following a link
8960 (defvar org-link-search-failed nil)
8962 (defvar org-open-link-functions nil
8963 "Hook for functions finding a plain text link.
8964 These functions must take a single argument, the link content.
8965 They will be called for links that look like [[link text][description]]
8969 These functions will be called *before* Org attempts to resolve the
8970 link by doing text searches in the current buffer - so if you want a
8972 handle this as a special case.
8974 When the function does handle the link, it must return a non-nil value.
8975 If it decides that it is not responsible for this link, it must return
8976 nil to indicate that that Org-mode can continue with other options
8977 like exact and fuzzy text search.")
8979 (defun org-next-link ()
8980 "Move forward to the next link.
8981 If the link is in hidden text, expose it."
8982 (interactive)
8983 (when (and org-link-search-failed (eq this-command last-command))
8984 (goto-char (point-min))
8985 (message "Link search wrapped back to beginning of buffer"))
8986 (setq org-link-search-failed nil)
8987 (let* ((pos (point))
8988 (ct (org-context))
8989 (a (assoc :link ct)))
8990 (if a (goto-char (nth 2 a)))
8991 (if (re-search-forward org-any-link-re nil t)
8992 (progn
8993 (goto-char (match-beginning 0))
8994 (if (outline-invisible-p) (org-show-context)))
8995 (goto-char pos)
8996 (setq org-link-search-failed t)
8997 (error "No further link found"))))
8999 (defun org-previous-link ()
9000 "Move backward to the previous link.
9001 If the link is in hidden text, expose it."
9002 (interactive)
9003 (when (and org-link-search-failed (eq this-command last-command))
9004 (goto-char (point-max))
9005 (message "Link search wrapped back to end of buffer"))
9006 (setq org-link-search-failed nil)
9007 (let* ((pos (point))
9008 (ct (org-context))
9009 (a (assoc :link ct)))
9010 (if a (goto-char (nth 1 a)))
9011 (if (re-search-backward org-any-link-re nil t)
9012 (progn
9013 (goto-char (match-beginning 0))
9014 (if (outline-invisible-p) (org-show-context)))
9015 (goto-char pos)
9016 (setq org-link-search-failed t)
9017 (error "No further link found"))))
9019 (defun org-translate-link (s)
9020 "Translate a link string if a translation function has been defined."
9021 (if (and org-link-translation-function
9022 (fboundp org-link-translation-function)
9024 (progn
9025 (setq s (funcall org-link-translation-function
9026 (match-string 1) (match-string 2)))
9027 (concat (car s) ":" (cdr s)))
9028 s))
9030 (defun org-translate-link-from-planner (type path)
9031 "Translate a link from Emacs Planner syntax so that Org can follow it.
9032 This is still an experimental function, your mileage may vary."
9033 (cond
9034 ((member type '("http" "https" "news" "ftp"))
9035 ;; standard Internet links are the same.
9036 nil)
9037 ((and (equal type "irc") (string-match "^//" path))
9038 ;; Planner has two / at the beginning of an irc link, we have 1.
9039 ;; We should have zero, actually....
9040 (setq path (substring path 1)))
9041 ((and (equal type "lisp") (string-match "^/" path))
9042 ;; Planner has a slash, we do not.
9043 (setq type "elisp" path (substring path 1)))
9045 ;; A typical message link. Planner has the id after the final slash,
9046 ;; we separate it with a hash mark
9047 (setq path (concat (match-string 1 path) "#"
9048 (org-remove-angle-brackets (match-string 2 path)))))
9049 )
9050 (cons type path))
9052 (defun org-find-file-at-mouse (ev)
9053 "Open file link or URL at mouse."
9054 (interactive "e")
9055 (mouse-set-point ev)
9056 (org-open-at-point 'in-emacs))
9058 (defun org-open-at-mouse (ev)
9059 "Open file link or URL at mouse."
9060 (interactive "e")
9061 (mouse-set-point ev)
9062 (if (eq major-mode 'org-agenda-mode)
9063 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9064 (org-open-at-point))
9066 (defvar org-window-config-before-follow-link nil
9067 "The window configuration before following a link.
9068 This is saved in case the need arises to restore it.")
9070 (defvar org-open-link-marker (make-marker)
9071 "Marker pointing to the location where `org-open-at-point; was called.")
9073 ;;;###autoload
9074 (defun org-open-at-point-global ()
9075 "Follow a link like Org-mode does.
9076 This command can be called in any mode to follow a link that has
9077 Org-mode syntax."
9078 (interactive)
9079 (org-run-like-in-org-mode 'org-open-at-point))
9081 ;;;###autoload
9082 (defun org-open-link-from-string (s &optional arg reference-buffer)
9083 "Open a link in the string S, as if it was in Org-mode."
9085 (let ((reference-buffer (or reference-buffer (current-buffer))))
9086 (with-temp-buffer
9087 (let ((org-inhibit-startup t))
9088 (org-mode)
9089 (insert s)
9090 (goto-char (point-min))
9091 (when reference-buffer
9092 (setq org-link-abbrev-alist-local
9093 (with-current-buffer reference-buffer
9094 org-link-abbrev-alist-local)))
9095 (org-open-at-point arg reference-buffer)))))
9097 (defvar org-open-at-point-functions nil
9098 "Hook that is run when following a link at point.
9100 Functions in this hook must return t if they identify and follow
9101 a link at point. If they don't find anything interesting at point,
9102 they must return nil.")
9104 (defun org-open-at-point (&optional arg reference-buffer)
9105 "Open link at or after point.
9106 If there is no link at point, this function will search forward up to
9107 the end of the current line.
9108 Normally, files will be opened by an appropriate application. If the
9109 optional prefix argument ARG is non-nil, Emacs will visit the file.
9110 With a double prefix argument, try to open outside of Emacs, in the
9111 application the system uses for this file type."
9112 (interactive "P")
9113 ;; if in a code block, then open the block's results
9114 (unless (call-interactively #'org-babel-open-src-block-result)
9115 (org-load-modules-maybe)
9116 (move-marker org-open-link-marker (point))
9117 (setq org-window-config-before-follow-link (current-window-configuration))
9118 (org-remove-occur-highlights nil nil t)
9119 (cond
9120 ((and (org-on-heading-p)
9121 (not (org-in-regexp
9126 (not (get-text-property (point) 'org-linked-text)))
9127 (or (org-offer-links-in-entry arg)
9128 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9129 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9130 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9131 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9132 (not (org-in-regexp org-bracket-link-regexp)))
9133 (org-footnote-action))
9134 (t
9135 (let (type path link line search (pos (point)))
9136 (catch 'match
9137 (save-excursion
9139 (when (org-in-regexp org-bracket-link-regexp 1)
9140 (setq link (org-extract-attributes
9141 (org-link-unescape (org-match-string-no-properties 1))))
9143 (setq link (replace-match " " t t link)))
9144 (setq link (org-link-expand-abbrev link))
9145 (cond
9146 ((or (file-name-absolute-p link)
9148 (setq type "file" path link))
9149 ((string-match org-link-re-with-space3 link)
9150 (setq type (match-string 1 link) path (match-string 2 link)))
9151 (t (setq type "thisfile" path link)))
9152 (throw 'match t)))
9154 (when (get-text-property (point) 'org-linked-text)
9155 (setq type "thisfile"
9156 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9157 (1+ (point)) (point))
9158 path (buffer-substring
9159 (previous-single-property-change pos 'org-linked-text)
9160 (next-single-property-change pos 'org-linked-text)))
9161 (throw 'match t))
9163 (save-excursion
9164 (when (or (org-in-regexp org-angle-link-re)
9165 (org-in-regexp org-plain-link-re))
9166 (setq type (match-string 1) path (match-string 2))
9167 (throw 'match t)))
9168 (save-excursion
9170 (setq type "tags"
9171 path (match-string 1))
9172 (while (string-match ":" path)
9173 (setq path (replace-match "+" t t path)))
9174 (throw 'match t)))
9176 (setq type "tree-match"
9177 path (match-string 1))
9178 (throw 'match t)))
9179 (unless path
9180 (error "No link found"))
9182 ;; switch back to reference buffer
9183 ;; needed when if called in a temporary buffer through
9184 ;; org-open-link-from-string
9185 (with-current-buffer (or reference-buffer (current-buffer))
9187 ;; Remove any trailing spaces in path
9189 (setq path (replace-match "" t t path)))
9190 (if (and org-link-translation-function
9191 (fboundp org-link-translation-function))
9192 ;; Check if we need to translate the link
9193 (let ((tmp (funcall org-link-translation-function type path)))
9194 (setq type (car tmp) path (cdr tmp))))
9196 (cond
9198 ((assoc type org-link-protocols)
9199 (funcall (nth 1 (assoc type org-link-protocols)) path))
9201 ((equal type "mailto")
9202 (let ((cmd (car org-link-mailto-program))
9203 (args (cdr org-link-mailto-program)) args1
9204 (address path) (subject "") a)
9206 (setq address (match-string 1 path)
9207 subject (org-link-escape (match-string 2 path))))
9208 (while args
9209 (cond
9210 ((not (stringp (car args))) (push (pop args) args1))
9211 (t (setq a (pop args))
9212 (if (string-match "%a" a)
9213 (setq a (replace-match address t t a)))
9214 (if (string-match "%s" a)
9215 (setq a (replace-match subject t t a)))
9216 (push a args1))))
9217 (apply cmd (nreverse args1))))
9219 ((member type '("http" "https" "ftp" "news"))
9220 (browse-url (concat type ":" (org-link-escape
9221 path org-link-escape-chars-browser))))
9223 ((string= type "doi")
9224 (browse-url (concat "http://dx.doi.org/"
9225 (org-link-escape
9226 path org-link-escape-chars-browser))))
9228 ((member type '("message"))
9229 (browse-url (concat type ":" path)))
9231 ((string= type "tags")
9232 (org-tags-view arg path))
9234 ((string= type "tree-match")
9237 ((string= type "file")
9239 (setq line (string-to-number (match-string 1 path))
9240 path (substring path 0 (match-beginning 0)))
9242 (setq search (match-string 1 path)
9243 path (substring path 0 (match-beginning 0)))))
9244 (if (string-match "[*?{]" (file-name-nondirectory path))
9245 (dired path)
9246 (org-open-file path arg line search)))
9248 ((string= type "shell")
9249 (let ((cmd path))
9250 (if (or (not org-confirm-shell-link-function)
9251 (funcall org-confirm-shell-link-function
9253 (org-add-props cmd nil
9254 'face 'org-warning))))
9255 (progn
9256 (message "Executing %s" cmd)
9257 (shell-command cmd))
9258 (error "Abort"))))
9260 ((string= type "elisp")
9261 (let ((cmd path))
9262 (if (or (not org-confirm-elisp-link-function)
9263 (funcall org-confirm-elisp-link-function
9265 (org-add-props cmd nil
9266 'face 'org-warning))))
9267 (message "%s => %s" cmd
9268 (if (equal (string-to-char cmd) ?\()
9269 (eval (read cmd))
9270 (call-interactively (read cmd))))
9271 (error "Abort"))))
9273 ((and (string= type "thisfile")
9274 (run-hook-with-args-until-success
9275 'org-open-link-functions path)))
9277 ((string= type "thisfile")
9278 (if arg
9279 (switch-to-buffer-other-window
9280 (org-get-buffer-for-internal-link (current-buffer)))
9281 (org-mark-ring-push))
9282 (let ((cmd `(org-link-search
9283 ,path
9284 ,(cond ((equal arg '(4)) ''occur)
9285 ((equal arg '(16)) ''org-occur)
9286 (t nil))
9287 ,pos)))
9288 (condition-case nil (eval cmd)
9289 (error (progn (widen) (eval cmd))))))
9291 (t
9292 (browse-url-at-point)))))))
9293 (move-marker org-open-link-marker nil)
9294 (run-hook-with-args 'org-follow-link-hook)))
9296 (defun org-offer-links-in-entry (&optional nth zero)
9297 "Offer links in the current entry and follow the selected link.
9298 If there is only one link, follow it immediately as well.
9299 If NTH is an integer, immediately pick the NTH link found.
9300 If ZERO is a string, check also this string for a link, and if
9301 there is one, offer it as link number zero."
9305 (cnt ?0)
9306 (in-emacs (if (integerp nth) nil nth))
9307 have-zero end links link c)
9308 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9309 (push (match-string 0 zero) links)
9310 (setq cnt (1- cnt) have-zero t))
9311 (save-excursion
9312 (org-back-to-heading t)
9313 (setq end (save-excursion (outline-next-heading) (point)))
9314 (while (re-search-forward re end t)
9315 (push (match-string 0) links))
9316 (setq links (org-uniquify (reverse links))))
9318 (cond
9319 ((null links)
9320 (message "No links"))
9321 ((equal (length links) 1)
9322 (setq link (list (car links))))
9323 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9324 (setq link (nth (if have-zero nth (1- nth)) links)))
9325 (t ; we have to select a link
9326 (save-excursion
9327 (save-window-excursion
9328 (delete-other-windows)
9329 (with-output-to-temp-buffer "*Select Link*"
9330 (mapc (lambda (l)
9331 (if (not (string-match org-bracket-link-regexp l))
9333 (org-remove-angle-brackets l)))
9334 (if (match-end 3)
9336 (match-string 3 l) (match-string 1 l)))
9338 (match-string 1 l))))))
9339 links))
9340 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9341 (message "Select link to open, RET to open all:")
9342 (setq c (read-char-exclusive))
9343 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9344 (when (equal c ?q) (error "Abort"))
9345 (if (equal c ?\C-m)
9346 (setq link links)
9347 (setq nth (- c ?0))
9348 (if have-zero (setq nth (1+ nth)))
9349 (unless (and (integerp nth) (>= (length links) nth))
9350 (error "Invalid link selection"))
9351 (setq link (list (nth (1- nth) links))))))
9352 (if link
9353 (let ((buf (current-buffer)))
9354 (dolist (l link)
9355 (org-open-link-from-string l in-emacs buf))
9356 t)
9357 nil)))
9359 ;; Add special file links that specify the way of opening
9361 (org-add-link-type "file+sys" 'org-open-file-with-system)
9362 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9363 (defun org-open-file-with-system (path)
9364 "Open file at PATH using the system way of opening it."
9365 (org-open-file path 'system))
9366 (defun org-open-file-with-emacs (path)
9367 "Open file at PATH in Emacs."
9368 (org-open-file path 'emacs))
9369 (defun org-remove-file-link-modifiers ()
9370 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9371 (goto-char (point-min))
9373 (org-if-unprotected
9374 (replace-match "file:" t t))))
9375 (eval-after-load "org-exp"
9376 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9377 'org-remove-file-link-modifiers))
9379 ;;;; Time estimates
9381 (defun org-get-effort (&optional pom)
9382 "Get the effort estimate for the current entry."
9383 (org-entry-get pom org-effort-property))
9385 ;;; File search
9387 (defvar org-create-file-search-functions nil
9388 "List of functions to construct the right search string for a file link.
9389 These functions are called in turn with point at the location to
9390 which the link should point.
9392 A function in the hook should first test if it would like to
9393 handle this file type, for example by checking the `major-mode'
9394 or the file extension. If it decides not to handle this file, it
9395 should just return nil to give other functions a chance. If it
9396 does handle the file, it must return the search string to be used
9397 when following the link. The search string will be part of the
9398 file link, given after a double colon, and `org-open-at-point'
9399 will automatically search for it. If special measures must be
9400 taken to make the search successful, another function should be
9401 added to the companion hook `org-execute-file-search-functions',
9402 which see.
9404 A function in this hook may also use `setq' to set the variable
9405 `description' to provide a suggestion for the descriptive text to
9406 be used for this link when it gets inserted into an Org-mode
9409 (defvar org-execute-file-search-functions nil
9410 "List of functions to execute a file search triggered by a link.
9412 Functions added to this hook must accept a single argument, the
9413 search string that was part of the file link, the part after the
9414 double colon. The function must first check if it would like to
9415 handle this search, for example by checking the `major-mode' or
9416 the file extension. If it decides not to handle this search, it
9417 should just return nil to give other functions a chance. If it
9418 does handle the search, it must return a non-nil value to keep
9419 other functions from trying.
9421 Each function can access the current prefix argument through the
9422 variable `current-prefix-argument'. Note that a single prefix is
9423 used to force opening a link in Emacs, so it may be good to only
9424 use a numeric or double prefix to guide the search function.
9426 In case this is needed, a function in this hook can also restore
9427 the window configuration before `org-open-at-point' was called using:
9429 (set-window-configuration org-window-config-before-follow-link)")
9431 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9432 (defun org-link-search (s &optional type avoid-pos)
9433 "Search for a link search option.
9434 If S is surrounded by forward slashes, it is interpreted as a
9435 regular expression. In org-mode files, this will create an `org-occur'
9436 sparse tree. In ordinary files, `occur' will be used to list matches.
9437 If the current buffer is in `dired-mode', grep will be used to search
9438 in all files. If AVOID-POS is given, ignore matches near that position."
9439 (let ((case-fold-search t)
9443 org-emphasis-alist)
9445 (pos (point))
9446 (pre nil) (post nil)
9447 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9448 (cond
9449 ;; First check if there are any special search functions
9450 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9451 ;; Now try the builtin stuff
9452 ((and (equal (string-to-char s0) ?#)
9453 (> (length s0) 1)
9454 (save-excursion
9455 (goto-char (point-min))
9456 (and
9457 (re-search-forward
9459 (setq type 'dedicated
9460 pos (match-beginning 0))))
9461 ;; There is an exact target for this
9462 (goto-char pos)
9463 (org-back-to-heading t)))
9464 ((save-excursion
9465 (goto-char (point-min))
9466 (and
9467 (re-search-forward
9468 (concat "<<" (regexp-quote s0) ">>") nil t)
9469 (setq type 'dedicated
9470 pos (match-beginning 0))))
9471 ;; There is an exact target for this
9472 (goto-char pos))
9474 (save-excursion
9475 (goto-char (point-min))
9476 (and
9477 (re-search-forward
9478 (concat "[^[]" (regexp-quote
9479 (format org-coderef-label-format
9480 (match-string 1 s0))))
9481 nil t)
9482 (setq type 'dedicated
9483 pos (1+ (match-beginning 0))))))
9484 ;; There is a coderef target for this
9485 (goto-char pos))
9487 ;; A regular expression
9488 (cond
9489 ((org-mode-p)
9490 (org-occur (match-string 1 s)))
9491 ;;((eq major-mode 'dired-mode)
9492 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9493 (t (org-do-occur (match-string 1 s)))))
9494 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9495 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9496 (goto-char (point-min))
9497 (cond
9498 ((let (case-fold-search)
9499 (re-search-forward (format org-complex-heading-regexp-format
9500 (regexp-quote s))
9501 nil t))
9502 ;; OK, found a match
9503 (setq type 'dedicated)
9504 (goto-char (match-beginning 0)))
9505 ((and (not org-link-search-inhibit-query)
9506 (eq org-link-search-must-match-exact-headline 'query-to-create)
9507 (y-or-n-p "No match - create this as a new heading? "))
9508 (goto-char (point-max))
9509 (or (bolp) (newline))
9511 (beginning-of-line 0))
9512 (t
9513 (goto-char pos)
9514 (error "No match"))))
9515 (t
9516 ;; A normal search string
9517 (when (equal (string-to-char s) ?*)
9518 ;; Anchor on headlines, post may include tags.
9521 s (substring s 1)))
9522 (remove-text-properties
9523 0 (length s)
9524 '(face nil mouse-face nil keymap nil fontified nil) s)
9525 ;; Make a series of regular expressions to find a match
9534 re4 (concat "[^a-zA-Z_]" re4_)
9536 re1 (concat pre re2 post)
9537 re3 (concat pre (if pre re4_ re4) post)
9538 re5 (concat pre ".*" re4)
9539 re2 (concat pre re2)
9540 re2a (concat pre (if pre re2a_ re2a))
9541 re4 (concat pre (if pre re4_ re4))
9545 ))
9546 (cond
9547 ((eq type 'org-occur) (org-occur reall))
9548 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9549 (t (goto-char (point-min))
9550 (setq type 'fuzzy)
9551 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9552 (org-search-not-self 1 re1 nil t)
9553 (org-search-not-self 1 re2 nil t)
9554 (org-search-not-self 1 re2a nil t)
9555 (org-search-not-self 1 re3 nil t)
9556 (org-search-not-self 1 re4 nil t)
9557 (org-search-not-self 1 re5 nil t)
9558 )
9559 (goto-char (match-beginning 1))
9560 (goto-char pos)
9561 (error "No match"))))))
9562 (and (org-mode-p) (org-show-context 'link-search))
9563 type))
9565 (defun org-search-not-self (group &rest args)
9566 "Execute `re-search-forward', but only accept matches that do not
9567 enclose the position of `org-open-link-marker'."
9568 (let ((m org-open-link-marker))
9569 (catch 'exit
9570 (while (apply 're-search-forward args)
9571 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9572 (goto-char (match-end group))
9573 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9574 (> (match-beginning 0) (marker-position m))
9575 (< (match-end 0) (marker-position m)))
9576 (save-match-data
9577 (or (not (org-in-regexp
9578 org-bracket-link-analytic-regexp 1))
9579 (not (match-end 4)) ; no description
9580 (and (<= (match-beginning 4) (point))
9581 (>= (match-end 4) (point))))))
9582 (throw 'exit (point))))))))
9584 (defun org-get-buffer-for-internal-link (buffer)
9585 "Return a buffer to be used for displaying the link target of internal links."
9586 (cond
9587 ((not org-display-internal-link-with-indirect-buffer)
9588 buffer)
9589 ((string-match "(Clone)$" (buffer-name buffer))
9590 (message "Buffer is already a clone, not making another one")
9591 ;; we also do not modify visibility in this case
9592 buffer)
9593 (t ; make a new indirect buffer for displaying the link
9594 (let* ((bn (buffer-name buffer))
9595 (ibn (concat bn "(Clone)"))
9596 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9597 (with-current-buffer ib (org-overview))
9598 ib))))
9600 (defun org-do-occur (regexp &optional cleanup)
9601 "Call the Emacs command `occur'.
9602 If CLEANUP is non-nil, remove the printout of the regular expression
9603 in the *Occur* buffer. This is useful if the regex is long and not useful
9604 to read."
9605 (occur regexp)
9606 (when cleanup
9607 (let ((cwin (selected-window)) win beg end)
9608 (when (setq win (get-buffer-window "*Occur*"))
9609 (select-window win))
9610 (goto-char (point-min))
9611 (when (re-search-forward "match[a-z]+" nil t)
9612 (setq beg (match-end 0))
9614 (setq end (1- (match-beginning 0)))))
9615 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9616 (goto-char (point-min))
9617 (select-window cwin))))
9619 ;;; The mark ring for links jumps
9621 (defvar org-mark-ring nil
9622 "Mark ring for positions before jumps in Org-mode.")
9623 (defvar org-mark-ring-last-goto nil
9624 "Last position in the mark ring used to go back.")
9625 ;; Fill and close the ring
9626 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9627 (loop for i from 1 to org-mark-ring-length do
9628 (push (make-marker) org-mark-ring))
9629 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9630 org-mark-ring)
9632 (defun org-mark-ring-push (&optional pos buffer)
9633 "Put the current position or POS into the mark ring and rotate it."
9634 (interactive)
9635 (setq pos (or pos (point)))
9636 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9637 (move-marker (car org-mark-ring)
9638 (or pos (point))
9639 (or buffer (current-buffer)))
9640 (message "%s"
9641 (substitute-command-keys
9644 (defun org-mark-ring-goto (&optional n)
9645 "Jump to the previous position in the mark ring.
9646 With prefix arg N, jump back that many stored positions. When
9647 called several times in succession, walk through the entire ring.
9648 Org-mode commands jumping to a different position in the current file,
9649 or to another Org-mode file, automatically push the old position
9650 onto the ring."
9651 (interactive "p")
9652 (let (p m)
9653 (if (eq last-command this-command)
9654 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9655 (setq p org-mark-ring))
9656 (setq org-mark-ring-last-goto p)
9657 (setq m (car p))
9658 (switch-to-buffer (marker-buffer m))
9659 (goto-char m)
9660 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9662 (defun org-remove-angle-brackets (s)
9663 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9664 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9665 s)
9666 (defun org-add-angle-brackets (s)
9667 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9668 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9669 s)
9670 (defun org-remove-double-quotes (s)
9673 s)
9675 ;;; Following specific links
9677 (defun org-follow-timestamp-link ()
9678 (cond
9679 ((org-at-date-range-p t)
9680 (let ((org-agenda-start-on-weekday)
9681 (t1 (match-string 1))
9682 (t2 (match-string 2)))
9683 (setq t1 (time-to-days (org-time-string-to-time t1))
9684 t2 (time-to-days (org-time-string-to-time t2)))
9685 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9686 ((org-at-timestamp-p t)
9687 (org-agenda-list nil (time-to-days (org-time-string-to-time
9688 (substring (match-string 1) 0 10)))
9689 1))
9690 (t (error "This should not happen"))))
9693 ;;; Following file links
9694 (defvar org-wait nil)
9695 (defun org-open-file (path &optional in-emacs line search)
9696 "Open the file at PATH.
9697 First, this expands any special file name abbreviations. Then the
9698 configuration variable `org-file-apps' is checked if it contains an
9699 entry for this file type, and if yes, the corresponding command is launched.
9701 If no application is found, Emacs simply visits the file.
9703 With optional prefix argument IN-EMACS, Emacs will visit the file.
9705 prefix arg, Org tries to avoid opening in Emacs
9706 and to use an external application to visit the file.
9708 Optional LINE specifies a line to go to, optional SEARCH a string
9709 to search for. If LINE or SEARCH is given, the file will be
9710 opened in Emacs, unless an entry from org-file-apps that makes
9711 use of groups in a regexp matches.
9712 If the file does not exist, an error is thrown."
9713 (let* ((file (if (equal path "")
9714 buffer-file-name
9715 (substitute-in-file-name (expand-file-name path))))
9716 (file-apps (append org-file-apps (org-default-apps)))
9717 (apps (org-remove-if
9718 'org-file-apps-entry-match-against-dlink-p file-apps))
9719 (apps-dlink (org-remove-if-not
9720 'org-file-apps-entry-match-against-dlink-p file-apps))
9721 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9722 (dirp (if remp nil (file-directory-p file)))
9723 (file (if (and dirp org-open-directory-means-index-dot-org)
9724 (concat (file-name-as-directory file) "index.org")
9725 file))
9726 (a-m-a-p (assq 'auto-mode apps))
9727 (dfile (downcase file))
9728 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9729 (link (cond ((and (eq line nil)
9730 (eq search nil))
9731 file)
9732 (line
9733 (concat file "::" (number-to-string line)))
9734 (search
9735 (concat file "::" search))))
9736 (dlink (downcase link))
9737 (old-buffer (current-buffer))
9738 (old-pos (point))
9739 (old-mode major-mode)
9740 ext cmd link-match-data)
9742 (setq ext (match-string 1 dfile))
9744 (setq ext (match-string 1 dfile))))
9745 (cond
9746 ((member in-emacs '((16) system))
9747 (setq cmd (cdr (assoc 'system apps))))
9748 (in-emacs (setq cmd 'emacs))
9749 (t
9750 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9751 (and dirp (cdr (assoc 'directory apps)))
9752 ; first, try matching against apps-dlink
9753 ; if we get a match here, store the match data for later
9754 (let ((match (assoc-default dlink apps-dlink
9755 'string-match)))
9756 (if match
9757 (progn (setq link-match-data (match-data))
9758 match)
9759 (progn (setq in-emacs (or in-emacs line search))
9760 nil))) ; if we have no match in apps-dlink,
9761 ; always open the file in emacs if line or search
9762 ; is given (for backwards compatibility)
9763 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9764 'string-match)
9765 (cdr (assoc ext apps))
9766 (cdr (assoc t apps))))))
9767 (when (eq cmd 'system)
9768 (setq cmd (cdr (assoc 'system apps))))
9769 (when (eq cmd 'default)
9770 (setq cmd (cdr (assoc t apps))))
9771 (when (eq cmd 'mailcap)
9772 (require 'mailcap)
9773 (mailcap-parse-mailcaps)
9774 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9775 (command (mailcap-mime-info mime-type)))
9776 (if (stringp command)
9777 (setq cmd command)
9778 (setq cmd 'emacs))))
9779 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9780 (not (file-exists-p file))
9781 (not org-open-non-existing-files))
9782 (error "No such file: %s" file))
9783 (cond
9785 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9787 (setq cmd (replace-match "%s" t t cmd)))
9788 (while (string-match "%s" cmd)
9789 (setq cmd (replace-match
9790 (save-match-data
9791 (shell-quote-argument
9792 (convert-standard-filename file)))
9793 t t cmd)))
9795 ;; Replace "%1", "%2" etc. in command with group matches from regex
9796 (save-match-data
9797 (let ((match-index 1)
9798 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9799 (set-match-data link-match-data)
9800 (while (<= match-index number-of-groups)
9801 (let ((regex (concat "%" (number-to-string match-index)))
9802 (replace-with (match-string match-index dlink)))
9803 (while (string-match regex cmd)
9804 (setq cmd (replace-match replace-with t t cmd))))
9805 (setq match-index (+ match-index 1)))))
9807 (save-window-excursion
9808 (start-process-shell-command cmd nil cmd)
9809 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9810 ))
9811 ((or (stringp cmd)
9812 (eq cmd 'emacs))
9813 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9814 (widen)
9815 (if line (org-goto-line line)
9816 (if search (org-link-search search))))
9817 ((consp cmd)
9818 (let ((file (convert-standard-filename file)))
9819 (save-match-data
9820 (set-match-data link-match-data)
9821 (eval cmd))))
9822 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9823 (and (org-mode-p) (eq old-mode 'org-mode)
9824 (or (not (equal old-buffer (current-buffer)))
9825 (not (equal old-pos (point))))
9826 (org-mark-ring-push old-pos old-buffer))))
9828 (defun org-file-apps-entry-match-against-dlink-p (entry)
9829 "This function returns non-nil if `entry' uses a regular
9830 expression which should be matched against the whole link by
9831 org-open-file.
9833 It assumes that is the case when the entry uses a regular
9834 expression which has at least one grouping construct and the
9835 action is either a lisp form or a command string containing
9836 '%1', i.e. using at least one subexpression match as a
9837 parameter."
9838 (let ((selector (car entry))
9839 (action (cdr entry)))
9840 (if (stringp selector)
9841 (and (> (regexp-opt-depth selector) 0)
9842 (or (and (stringp action)
9843 (string-match "%[0-9]" action))
9844 (consp action)))
9845 nil)))
9847 (defun org-default-apps ()
9848 "Return the default applications for this operating system."
9849 (cond
9850 ((eq system-type 'darwin)
9851 org-file-apps-defaults-macosx)
9852 ((eq system-type 'windows-nt)
9853 org-file-apps-defaults-windowsnt)
9854 (t org-file-apps-defaults-gnu)))
9856 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9857 "Convert extensions to regular expressions in the cars of LIST.
9858 Also, weed out any non-string entries, because the return value is used
9859 only for regexp matching.
9860 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9861 point to the symbol `emacs', indicating that the file should
9862 be opened in Emacs."
9863 (append
9864 (delq nil
9865 (mapcar (lambda (x)
9866 (if (not (stringp (car x)))
9867 nil
9869 x
9871 list))
9872 (if add-auto-mode
9873 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9875 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9876 (defun org-file-remote-p (file)
9877 "Test whether FILE specifies a location on a remote system.
9878 Return non-nil if the location is indeed remote.
9882 (cond ((fboundp 'file-remote-p)
9883 (file-remote-p file))
9884 ((fboundp 'tramp-handle-file-remote-p)
9885 (tramp-handle-file-remote-p file))
9886 ((and (boundp 'ange-ftp-name-format)
9887 (string-match (car ange-ftp-name-format) file))
9888 t)
9889 (t nil)))
9892 ;;;; Refiling
9894 (defun org-get-org-file ()
9895 "Read a filename, with default directory `org-directory'."
9896 (let ((default (or org-default-notes-file remember-data-file)))
9897 (read-file-name (format "File name [%s]: " default)
9898 (file-name-as-directory org-directory)
9899 default)))
9901 (defun org-notes-order-reversed-p ()
9902 "Check if the current file should receive notes in reversed order."
9903 (cond
9904 ((not org-reverse-note-order) nil)
9905 ((eq t org-reverse-note-order) t)
9906 ((not (listp org-reverse-note-order)) nil)
9907 (t (catch 'exit
9908 (let ((all org-reverse-note-order)
9909 entry)
9910 (while (setq entry (pop all))
9911 (if (string-match (car entry) buffer-file-name)
9912 (throw 'exit (cdr entry))))
9913 nil)))))
9915 (defvar org-refile-target-table nil
9916 "The list of refile targets, created by `org-refile'.")
9918 (defvar org-agenda-new-buffers nil
9919 "Buffers created to visit agenda files.")
9921 (defvar org-refile-cache nil
9922 "Cache for refile targets.")
9925 (defvar org-refile-markers nil
9926 "All the markers used for caching refile locations.")
9928 (defun org-refile-marker (pos)
9929 "Get a new refile marker, but only if caching is in use."
9930 (if (not org-refile-use-cache)
9931 pos
9932 (let ((m (make-marker)))
9933 (move-marker m pos)
9934 (push m org-refile-markers)
9935 m)))
9937 (defun org-refile-cache-clear ()
9938 "Clear the refile cache and disable all the markers."
9939 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9940 (setq org-refile-markers nil)
9941 (setq org-refile-cache nil)
9942 (message "Refile cache has been cleared"))
9944 (defun org-refile-cache-check-set (set)
9945 "Check if all the markers in the cache still have live buffers."
9946 (let (marker)
9947 (catch 'exit
9948 (while (and set (setq marker (nth 3 (pop set))))
9949 ;; if org-refile-use-outline-path is 'file, marker may be nil
9950 (when (and marker (null (marker-buffer marker)))
9951 (message "not found") (sit-for 3)
9952 (throw 'exit nil)))
9953 t)))
9955 (defun org-refile-cache-put (set &rest identifiers)
9956 "Push the refile targets SET into the cache, under IDENTIFIERS."
9957 (let* ((key (sha1 (prin1-to-string identifiers)))
9958 (entry (assoc key org-refile-cache)))
9959 (if entry
9960 (setcdr entry set)
9961 (push (cons key set) org-refile-cache))))
9963 (defun org-refile-cache-get (&rest identifiers)
9964 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9965 (cond
9966 ((not org-refile-cache) nil)
9967 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9968 (t
9969 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9970 org-refile-cache))))
9971 (and set (org-refile-cache-check-set set) set)))))
9973 (defun org-get-refile-targets (&optional default-buffer)
9974 "Produce a table with refile targets."
9975 (let ((case-fold-search nil)
9976 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9977 (entries (or org-refile-targets '((nil . (:level . 1)))))
9978 targets tgs txt re files f desc descre fast-path-p level pos0)
9979 (message "Getting targets...")
9980 (with-current-buffer (or default-buffer (current-buffer))
9981 (while (setq entry (pop entries))
9982 (setq files (car entry) desc (cdr entry))
9983 (setq fast-path-p nil)
9984 (cond
9985 ((null files) (setq files (list (current-buffer))))
9986 ((eq files 'org-agenda-files)
9987 (setq files (org-agenda-files 'unrestricted)))
9988 ((and (symbolp files) (fboundp files))
9989 (setq files (funcall files)))
9990 ((and (symbolp files) (boundp files))
9991 (setq files (symbol-value files))))
9992 (if (stringp files) (setq files (list files)))
9993 (cond
9994 ((eq (car desc) :tag)
9996 ((eq (car desc) :todo)
9998 ((eq (car desc) :regexp)
9999 (setq descre (cdr desc)))
10000 ((eq (car desc) :level)
10002 (if org-odd-levels-only
10003 (1- (* 2 (cdr desc)))
10004 (cdr desc)))
10006 ((eq (car desc) :maxlevel)
10007 (setq fast-path-p t)
10009 (if org-odd-levels-only
10010 (1- (* 2 (cdr desc)))
10011 (cdr desc)))
10013 (t (error "Bad refiling target description %s" desc)))
10014 (while (setq f (pop files))
10015 (with-current-buffer
10016 (if (bufferp f) f (org-get-agenda-file-buffer f))
10017 (or
10018 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10019 (progn
10020 (if (bufferp f) (setq f (buffer-file-name
10021 (buffer-base-buffer f))))
10022 (setq f (and f (expand-file-name f)))
10023 (if (eq org-refile-use-outline-path 'file)
10024 (push (list (file-name-nondirectory f) f nil nil) tgs))
10025 (save-excursion
10026 (save-restriction
10027 (widen)
10028 (goto-char (point-min))
10029 (while (re-search-forward descre nil t)
10030 (goto-char (setq pos0 (point-at-bol)))
10031 (catch 'next
10032 (when org-refile-target-verify-function
10033 (save-match-data
10034 (or (funcall org-refile-target-verify-function)
10035 (throw 'next t))))
10036 (when (looking-at org-complex-heading-regexp)
10037 (setq level (org-reduced-level
10038 (- (match-end 1) (match-beginning 1)))
10039 txt (org-link-display-format (match-string 4))
10041 re (format org-complex-heading-regexp-format
10042 (regexp-quote (match-string 4))))
10043 (when org-refile-use-outline-path
10044 (setq txt (mapconcat
10045 'org-protect-slash
10046 (append
10047 (if (eq org-refile-use-outline-path
10048 'file)
10049 (list (file-name-nondirectory
10050 (buffer-file-name
10051 (buffer-base-buffer))))
10052 (if (eq org-refile-use-outline-path
10053 'full-file-path)
10054 (list (buffer-file-name
10055 (buffer-base-buffer)))))
10056 (org-get-outline-path fast-path-p
10057 level txt)
10058 (list txt))
10059 "/")))
10060 (push (list txt f re (org-refile-marker (point)))
10061 tgs)))
10062 (when (= (point) pos0)
10063 ;; verification function has not moved point
10064 (goto-char (point-at-eol))))))))
10065 (when org-refile-use-cache
10066 (org-refile-cache-put tgs (buffer-file-name) descre))
10067 (setq targets (append tgs targets))
10068 ))))
10069 (message "Getting targets...done")
10070 (nreverse targets)))
10072 (defun org-protect-slash (s)
10073 (while (string-match "/" s)
10075 s)
10077 (defvar org-olpa (make-vector 20 nil))
10079 (defun org-get-outline-path (&optional fastp level heading)
10080 "Return the outline path to the current entry, as a list.
10082 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10083 routine which makes outline path derivations for an entire file,
10084 avoiding backtracing. Refile target collection makes use of that."
10085 (if fastp
10086 (progn
10087 (if (> level 19)
10088 (error "Outline path failure, more than 19 levels"))
10089 (loop for i from level upto 19 do
10090 (aset org-olpa i nil))
10091 (prog1
10092 (delq nil (append org-olpa nil))
10093 (aset org-olpa level heading)))
10094 (let (rtn case-fold-search)
10095 (save-excursion
10096 (save-restriction
10097 (widen)
10098 (while (org-up-heading-safe)
10099 (when (looking-at org-complex-heading-regexp)
10100 (push (org-match-string-no-properties 4) rtn)))
10101 rtn)))))
10103 (defun org-format-outline-path (path &optional width prefix)
10104 "Format the outline path PATH for display.
10105 Width is the maximum number of characters that is available.
10106 Prefix is a prefix to be included in the returned string,
10107 such as the file name."
10108 (setq width (or width 79))
10109 (if prefix (setq width (- width (length prefix))))
10110 (if (not path)
10111 (or prefix "")
10112 (let* ((nsteps (length path))
10113 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10114 (maxwidth (if (<= total-width width)
10115 10000 ;; everything fits
10116 ;; we need to shorten the level headings
10117 (/ (- width nsteps) nsteps)))
10118 (org-odd-levels-only nil)
10119 (n 0)
10120 (total (1+ (length prefix))))
10121 (setq maxwidth (max maxwidth 10))
10122 (concat prefix
10123 (mapconcat
10124 (lambda (h)
10125 (setq n (1+ n))
10126 (if (and (= n nsteps) (< maxwidth 10000))
10127 (setq maxwidth (- total-width total)))
10128 (if (< (length h) maxwidth)
10129 (progn (setq total (+ total (length h) 1)) h)
10130 (setq h (substring h 0 (- maxwidth 2))
10131 total (+ total maxwidth 1))
10133 (setq h (substring h 0 (match-beginning 0))))
10134 (setq h (concat h "..")))
10135 (org-add-props h nil 'face
10136 (nth (% (1- n) org-n-level-faces)
10137 org-level-faces))
10138 h)
10139 path "/")))))
10141 (defun org-display-outline-path (&optional file current)
10142 "Display the current outline path in the echo area."
10143 (interactive "P")
10144 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10145 (case-fold-search nil)
10146 (path (and (org-mode-p) (org-get-outline-path))))
10147 (if current (setq path (append path
10148 (save-excursion
10149 (org-back-to-heading t)
10150 (if (looking-at org-complex-heading-regexp)
10151 (list (match-string 4)))))))
10152 (message "%s"
10153 (org-format-outline-path
10154 path
10155 (1- (frame-width))
10156 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10158 (defvar org-refile-history nil
10159 "History for refiling operations.")
10161 (defvar org-after-refile-insert-hook nil
10162 "Hook run after `org-refile' has inserted its stuff at the new location.
10163 Note that this is still *before* the stuff will be removed from
10164 the *old* location.")
10166 (defvar org-capture-last-stored-marker)
10167 (defun org-refile (&optional goto default-buffer rfloc)
10168 "Move the entry at point to another heading.
10169 The list of target headings is compiled using the information in
10170 `org-refile-targets', which see. This list is created before each use
10171 and will therefore always be up-to-date.
10173 At the target location, the entry is filed as a subitem of the target heading.
10174 Depending on `org-reverse-note-order', the new subitem will either be the
10175 first or the last subitem.
10177 If there is an active region, all entries in that region will be moved.
10178 However, the region must fulfill the requirement that the first heading
10179 is the first one sets the top-level of the moved text - at most siblings
10180 below it are allowed.
10182 With prefix arg GOTO, the command will only visit the target location,
10183 not actually move anything.
10185 go to the location where the last refiling
10186 operation has put the subtree.
10187 With a prefix argument of `2', refile to the running clock.
10189 RFLOC can be a refile location obtained in a different way.
10191 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10193 If you are using target caching (see `org-refile-use-cache'),
10194 You have to clear the target cache in order to find new targets.
10195 This can be done with a 0 prefix: `C-0 C-c C-w'"
10196 (interactive "P")
10197 (if (member goto '(0 (64)))
10198 (org-refile-cache-clear)
10199 (let* ((cbuf (current-buffer))
10200 (regionp (org-region-active-p))
10201 (region-start (and regionp (region-beginning)))
10202 (region-end (and regionp (region-end)))
10203 (region-length (and regionp (- region-end region-start)))
10204 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10205 pos it nbuf file re level reversed)
10206 (setq last-command nil)
10207 (when regionp
10208 (goto-char region-start)
10209 (or (bolp) (goto-char (point-at-bol)))
10210 (setq region-start (point))
10211 (unless (org-kill-is-subtree-p
10212 (buffer-substring region-start region-end))
10213 (error "The region is not a (sequence of) subtree(s)")))
10214 (if (equal goto '(16))
10215 (org-refile-goto-last-stored)
10216 (when (or
10217 (and (equal goto 2)
10218 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10219 (prog1
10220 (setq it (list (or org-clock-heading "running clock")
10221 (buffer-file-name
10222 (marker-buffer org-clock-hd-marker))
10223 ""
10224 (marker-position org-clock-hd-marker)))
10225 (setq goto nil)))
10226 (setq it (or rfloc
10227 (save-excursion
10228 (org-refile-get-location
10229 (if goto "Goto: " "Refile to: ") default-buffer
10230 org-refile-allow-creating-parent-nodes)))))
10231 (setq file (nth 1 it)
10232 re (nth 2 it)
10233 pos (nth 3 it))
10234 (if (and (not goto)
10235 pos
10236 (equal (buffer-file-name) file)
10237 (if regionp
10238 (and (>= pos region-start)
10239 (<= pos region-end))
10240 (and (>= pos (point))
10241 (< pos (save-excursion
10242 (org-end-of-subtree t t))))))
10243 (error "Cannot refile to position inside the tree or region"))
10245 (setq nbuf (or (find-buffer-visiting file)
10246 (find-file-noselect file)))
10247 (if goto
10248 (progn
10249 (switch-to-buffer nbuf)
10250 (goto-char pos)
10251 (org-show-context 'org-goto))
10252 (if regionp
10253 (progn
10254 (org-kill-new (buffer-substring region-start region-end))
10255 (org-save-markers-in-region region-start region-end))
10256 (org-copy-subtree 1 nil t))
10257 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10258 (find-file-noselect file)))
10259 (setq reversed (org-notes-order-reversed-p))
10260 (save-excursion
10261 (save-restriction
10262 (widen)
10263 (if pos
10264 (progn
10265 (goto-char pos)
10266 (looking-at outline-regexp)
10267 (setq level (org-get-valid-level (funcall outline-level) 1))
10268 (goto-char
10269 (if reversed
10270 (or (outline-next-heading) (point-max))
10271 (or (save-excursion (org-get-next-sibling))
10272 (org-end-of-subtree t t)
10273 (point-max)))))
10274 (setq level 1)
10275 (if (not reversed)
10276 (goto-char (point-max))
10277 (goto-char (point-min))
10278 (or (outline-next-heading) (goto-char (point-max)))))
10279 (if (not (bolp)) (newline))
10280 (org-paste-subtree level)
10281 (when org-log-refile
10282 (org-add-log-setup 'refile nil nil 'findpos
10283 org-log-refile)
10284 (unless (eq org-log-refile 'note)
10285 (save-excursion (org-add-log-note))))
10286 (and org-auto-align-tags (org-set-tags nil t))
10287 (bookmark-set "org-refile-last-stored")
10288 ;; If we are refiling for capture, make sure that the
10289 ;; last-capture pointers point here
10290 (when (org-bound-and-true-p org-refile-for-capture)
10291 (bookmark-set "org-capture-last-stored-marker")
10292 (move-marker org-capture-last-stored-marker (point)))
10293 (if (fboundp 'deactivate-mark) (deactivate-mark))
10294 (run-hooks 'org-after-refile-insert-hook))))
10295 (if regionp
10296 (delete-region (point) (+ (point) region-length))
10297 (org-cut-subtree))
10298 (when (featurep 'org-inlinetask)
10299 (org-inlinetask-remove-END-maybe))
10300 (setq org-markers-to-move nil)
10303 (defun org-refile-goto-last-stored ()
10304 "Go to the location where the last refile was stored."
10305 (interactive)
10306 (bookmark-jump "org-refile-last-stored")
10307 (message "This is the location of the last refile"))
10309 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10310 "Prompt the user for a refile location, using PROMPT."
10311 (let ((org-refile-targets org-refile-targets)
10312 (org-refile-use-outline-path org-refile-use-outline-path))
10313 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10314 (unless org-refile-target-table
10315 (error "No refile targets"))
10316 (let* ((cbuf (current-buffer))
10317 (partial-completion-mode nil)
10318 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10319 (cfunc (if (and org-refile-use-outline-path
10320 org-outline-path-complete-in-steps)
10321 'org-olpath-completing-read
10322 'org-icompleting-read))
10323 (extra (if org-refile-use-outline-path "/" ""))
10324 (filename (and cfn (expand-file-name cfn)))
10325 (tbl (mapcar
10326 (lambda (x)
10327 (if (and (not (member org-refile-use-outline-path
10328 '(file full-file-path)))
10329 (not (equal filename (nth 1 x))))
10330 (cons (concat (car x) extra " ("
10331 (file-name-nondirectory (nth 1 x)) ")")
10332 (cdr x))
10333 (cons (concat (car x) extra) (cdr x))))
10334 org-refile-target-table))
10335 (completion-ignore-case t)
10336 pa answ parent-target child parent old-hist)
10337 (setq old-hist org-refile-history)
10338 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10339 nil 'org-refile-history))
10340 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10341 (org-refile-check-position pa)
10342 (if pa
10343 (progn
10344 (when (or (not org-refile-history)
10345 (not (eq old-hist org-refile-history))
10346 (not (equal (car pa) (car org-refile-history))))
10347 (setq org-refile-history
10348 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10349 org-refile-history
10350 (cdr org-refile-history))))
10351 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10352 (pop org-refile-history)))
10353 pa)
10355 (progn
10356 (setq parent (match-string 1 answ)
10357 child (match-string 2 answ))
10358 (setq parent-target (or (assoc parent tbl)
10359 (assoc (concat parent "/") tbl)))
10360 (when (and parent-target
10361 (or (eq new-nodes t)
10362 (and (eq new-nodes 'confirm)
10364 child)))))
10365 (org-refile-new-child parent-target child)))
10366 (error "Invalid target location")))))
10368 (defun org-refile-check-position (refile-pointer)
10369 "Check if the refile pointer matches the readline to which it points."
10370 (let* ((file (nth 1 refile-pointer))
10371 (re (nth 2 refile-pointer))
10372 (pos (nth 3 refile-pointer))
10373 buffer)
10374 (when (org-string-nw-p re)
10375 (setq buffer (if (markerp pos)
10376 (marker-buffer pos)
10377 (or (find-buffer-visiting file)
10378 (find-file-noselect file))))
10379 (with-current-buffer buffer
10380 (save-excursion
10381 (save-restriction
10382 (widen)
10383 (goto-char pos)
10384 (beginning-of-line 1)
10385 (unless (org-looking-at-p re)
10386 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10388 (defun org-refile-new-child (parent-target child)
10389 "Use refile target PARENT-TARGET to add new CHILD below it."
10390 (unless parent-target
10391 (error "Cannot find parent for new node"))
10392 (let ((file (nth 1 parent-target))
10393 (pos (nth 3 parent-target))
10394 level)
10395 (with-current-buffer (or (find-buffer-visiting file)
10396 (find-file-noselect file))
10397 (save-excursion
10398 (save-restriction
10399 (widen)
10400 (if pos
10401 (goto-char pos)
10402 (goto-char (point-max))
10403 (if (not (bolp)) (newline)))
10404 (when (looking-at outline-regexp)
10405 (setq level (funcall outline-level))
10406 (org-end-of-subtree t t))
10407 (org-back-over-empty-lines)
10409 (if pos (org-get-valid-level level 1) 1) ?*)
10411 (beginning-of-line 0)
10412 (list (concat (car parent-target) "/" child) file "" (point)))))))
10414 (defun org-olpath-completing-read (prompt collection &rest args)
10415 "Read an outline path like a file name."
10416 (let ((thetable collection)
10417 (org-completion-use-ido nil) ; does not work with ido.
10418 (org-completion-use-iswitchb nil)) ; or iswitchb
10419 (apply
10420 'org-icompleting-read prompt
10421 (lambda (string predicate &optional flag)
10422 (let (rtn r f (l (length string)))
10423 (cond
10424 ((eq flag nil)
10425 ;; try completion
10426 (try-completion string thetable))
10427 ((eq flag t)
10428 ;; all-completions
10429 (setq rtn (all-completions string thetable predicate))
10430 (mapcar
10431 (lambda (x)
10432 (setq r (substring x l))
10433 (if (string-match " ([^)]*)$" x)
10434 (setq f (match-string 0 x))
10435 (setq f ""))
10436 (if (string-match "/" r)
10437 (concat string (substring r 0 (match-end 0)) f)
10438 x))
10439 rtn))
10440 ((eq flag 'lambda)
10441 ;; exact match?
10442 (assoc string thetable)))
10443 ))
10444 args)))
10446 ;;;; Dynamic blocks
10448 (defun org-find-dblock (name)
10449 "Find the first dynamic block with name NAME in the buffer.
10450 If not found, stay at current position and return nil."
10451 (let (pos)
10452 (save-excursion
10453 (goto-char (point-min))
10455 nil t)
10456 (match-beginning 0))))
10457 (if pos (goto-char pos))
10458 pos))
10460 (defconst org-dblock-start-re
10462 "Matches the start line of a dynamic block, with parameters.")
10465 "Matches the end of a dynamic block.")
10467 (defun org-create-dblock (plist)
10468 "Create a dynamic block section, with parameters taken from PLIST.
10469 PLIST must contain a :name entry which is used as name of the block."
10471 (end-of-line 1)
10472 (newline))
10473 (let ((col (current-column))
10474 (name (plist-get plist :name)))
10475 (insert "#+BEGIN: " name)
10476 (while plist
10477 (if (eq (car plist) :name)
10478 (setq plist (cddr plist))
10479 (insert " " (prin1-to-string (pop plist)))))
10481 (beginning-of-line -2)))
10483 (defun org-prepare-dblock ()
10484 "Prepare dynamic block for refresh.
10485 This empties the block, puts the cursor at the insert position and returns
10486 the property list including an extra property :name with the block name."
10487 (unless (looking-at org-dblock-start-re)
10488 (error "Not at a dynamic block"))
10489 (let* ((begdel (1+ (match-end 0)))
10490 (name (org-no-properties (match-string 1)))
10491 (params (append (list :name name)
10492 (read (concat "(" (match-string 3) ")")))))
10493 (save-excursion
10494 (beginning-of-line 1)
10496 (setq params (plist-put params :indentation-column (current-column))))
10497 (unless (re-search-forward org-dblock-end-re nil t)
10498 (error "Dynamic block not terminated"))
10499 (setq params
10500 (append params
10501 (list :content (buffer-substring
10502 begdel (match-beginning 0)))))
10503 (delete-region begdel (match-beginning 0))
10504 (goto-char begdel)
10505 (open-line 1)
10506 params))
10508 (defun org-map-dblocks (&optional command)
10509 "Apply COMMAND to all dynamic blocks in the current buffer.
10510 If COMMAND is not given, use `org-update-dblock'."
10511 (let ((cmd (or command 'org-update-dblock)))
10512 (save-excursion
10513 (goto-char (point-min))
10514 (while (re-search-forward org-dblock-start-re nil t)
10515 (goto-char (match-beginning 0))
10516 (save-excursion
10517 (condition-case nil
10518 (funcall cmd)
10519 (error (message "Error during update of dynamic block"))))
10520 (unless (re-search-forward org-dblock-end-re nil t)
10521 (error "Dynamic block not terminated"))))))
10523 (defun org-dblock-update (&optional arg)
10524 "User command for updating dynamic blocks.
10525 Update the dynamic block at point. With prefix ARG, update all dynamic
10526 blocks in the buffer."
10527 (interactive "P")
10528 (if arg
10529 (org-update-all-dblocks)
10530 (or (looking-at org-dblock-start-re)
10531 (org-beginning-of-dblock))
10532 (org-update-dblock)))
10534 (defun org-update-dblock ()
10535 "Update the dynamic block at point.
10536 This means to empty the block, parse for parameters and then call
10537 the correct writing function."
10538 (interactive)
10539 (save-window-excursion
10540 (let* ((pos (point))
10541 (line (org-current-line))
10542 (params (org-prepare-dblock))
10543 (name (plist-get params :name))
10544 (indent (plist-get params :indentation-column))
10545 (cmd (intern (concat "org-dblock-write:" name))))
10546 (message "Updating dynamic block `%s' at line %d..." name line)
10547 (funcall cmd params)
10548 (message "Updating dynamic block `%s' at line %d...done" name line)
10549 (goto-char pos)
10550 (when (and indent (> indent 0))
10551 (setq indent (make-string indent ?\ ))
10552 (save-excursion
10553 (org-beginning-of-dblock)
10554 (forward-line 1)
10555 (while (not (looking-at org-dblock-end-re))
10556 (insert indent)
10557 (beginning-of-line 2))
10558 (when (looking-at org-dblock-end-re)
10560 (replace-match ""))
10561 (insert indent)))))))
10563 (defun org-beginning-of-dblock ()
10564 "Find the beginning of the dynamic block at point.
10565 Error if there is no such block at point."
10566 (let ((pos (point))
10567 beg)
10568 (end-of-line 1)
10569 (if (and (re-search-backward org-dblock-start-re nil t)
10570 (setq beg (match-beginning 0))
10571 (re-search-forward org-dblock-end-re nil t)
10572 (> (match-end 0) pos))
10573 (goto-char beg)
10574 (goto-char pos)
10575 (error "Not in a dynamic block"))))
10577 (defun org-update-all-dblocks ()
10578 "Update all dynamic blocks in the buffer.
10579 This function can be used in a hook."
10580 (interactive)
10581 (when (org-mode-p)
10582 (org-map-dblocks 'org-update-dblock)))
10585 ;;;; Completion
10587 (defconst org-additional-option-like-keywords
10588 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10589 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10590 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10591 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10592 "BEGIN:" "END:"
10593 "ORGTBL" "TBLFM:" "TBLNAME:"
10594 "BEGIN_EXAMPLE" "END_EXAMPLE"
10595 "BEGIN_QUOTE" "END_QUOTE"
10596 "BEGIN_VERSE" "END_VERSE"
10597 "BEGIN_CENTER" "END_CENTER"
10598 "BEGIN_SRC" "END_SRC"
10599 "BEGIN_RESULT" "END_RESULT"
10600 "SOURCE:" "SRCNAME:" "FUNCTION:"
10601 "RESULTS:"
10602 "HEADER:" "HEADERS:"
10603 "BABEL:"
10604 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10605 "CAPTION:" "LABEL:"
10606 "SETUPFILE:"
10607 "INCLUDE:"
10608 "BIND:"
10609 "MACRO:"))
10611 (defcustom org-structure-template-alist
10612 '(
10625 ("L" "#+latex: "
10629 ("H" "#+html: "
10632 ("A" "#+ascii: ")
10633 ("i" "#+include %file ?"
10635 )
10636 "Structure completion elements.
10637 This is a list of abbreviation keys and values. The value gets inserted
10638 if you type `<' followed by the key and then press the completion key,
10639 usually `M-TAB'. %file will be replaced by a file name after prompting
10640 for the file using completion.
10641 There are two templates for each key, the first uses the original Org syntax,
10642 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10643 the default when the /org-mtags.el/ module has been loaded. See also the
10644 variable `org-mtags-prefer-muse-templates'.
10645 This is an experimental feature, it is undecided if it is going to stay in."
10646 :group 'org-completion
10647 :type '(repeat
10648 (string :tag "Key")
10649 (string :tag "Template")
10650 (string :tag "Muse Template")))
10652 (defun org-try-structure-completion ()
10653 "Try to complete a structure template before point.
10655 expands them."
10656 (let ((l (buffer-substring (point-at-bol) (point)))
10657 a)
10660 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10661 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10662 (match-beginning 1)) a)
10663 t)))
10665 (defun org-complete-expand-structure-template (start cell)
10666 "Expand a structure template."
10667 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10668 (rpl (nth (if musep 2 1) cell))
10669 (ind ""))
10670 (delete-region start (point))
10672 (cond
10673 ((bolp))
10675 (setq ind (buffer-substring (point-at-bol) (point))))
10676 (t (newline))))
10677 (setq start (point))
10678 (if (string-match "%file" rpl)
10679 (setq rpl (replace-match
10680 (concat
10682 (save-match-data
10683 (abbreviate-file-name (read-file-name "Include file: ")))
10685 t t rpl)))
10688 (insert rpl)
10691 ;;;; TODO, DEADLINE, Comments
10693 (defun org-toggle-comment ()
10694 "Change the COMMENT state of an entry."
10695 (interactive)
10696 (save-excursion
10697 (org-back-to-heading)
10698 (let (case-fold-search)
10699 (if (looking-at (concat outline-regexp
10701 (replace-match "" t t nil 1)
10702 (if (looking-at outline-regexp)
10703 (progn
10704 (goto-char (match-end 0))
10705 (insert org-comment-string " ")))))))
10707 (defvar org-last-todo-state-is-todo nil
10708 "This is non-nil when the last TODO state change led to a TODO state.
10709 If the last change removed the TODO tag or switched to DONE, then
10710 this is nil.")
10712 (defvar org-setting-tags nil) ; dynamically skipped
10714 (defvar org-todo-setup-filter-hook nil
10715 "Hook for functions that pre-filter todo specs.
10716 Each function takes a todo spec and returns either nil or the spec
10717 transformed into canonical form." )
10719 (defvar org-todo-get-default-hook nil
10720 "Hook for functions that get a default item for todo.
10721 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10722 nil or a string to be used for the todo mark." )
10724 (defvar org-agenda-headline-snapshot-before-repeat)
10726 (defun org-todo (&optional arg)
10727 "Change the TODO state of an item.
10728 The state of an item is given by a keyword at the start of the heading,
10729 like
10730 *** TODO Write paper
10731 *** DONE Call mom
10733 The different keywords are specified in the variable `org-todo-keywords'.
10735 So for this example: when the item starts with TODO, it is changed to DONE.
10736 When it starts with DONE, the DONE is removed. And when neither TODO nor
10737 DONE are present, add TODO at the beginning of the heading.
10740 state.
10741 With numeric prefix arg, switch to that state.
10743 keywords (nextset).
10746 For calling through lisp, arg is also interpreted in the following way:
10747 'none -> empty state
10749 'done -> switch to DONE
10750 'nextset -> switch to the next set of keywords
10751 'previousset -> switch to the previous set of keywords
10753 really is a member of `org-todo-keywords'."
10754 (interactive "P")
10755 (if (equal arg '(16)) (setq arg 'nextset))
10756 (let ((org-blocker-hook org-blocker-hook)
10757 (case-fold-search nil))
10758 (when (equal arg '(64))
10759 (setq arg nil org-blocker-hook nil))
10760 (when (and org-blocker-hook
10761 (or org-inhibit-blocking
10762 (org-entry-get nil "NOBLOCKING")))
10763 (setq org-blocker-hook nil))
10764 (save-excursion
10765 (catch 'exit
10766 (org-back-to-heading t)
10767 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10769 (looking-at " *"))
10770 (let* ((match-data (match-data))
10771 (startpos (point-at-bol))
10772 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10773 (org-log-done org-log-done)
10774 (org-log-repeat org-log-repeat)
10775 (org-todo-log-states org-todo-log-states)
10776 (this (match-string 1))
10777 (hl-pos (match-beginning 0))
10778 (head (org-get-todo-sequence-head this))
10779 (ass (assoc head org-todo-kwd-alist))
10780 (interpret (nth 1 ass))
10781 (done-word (nth 3 ass))
10782 (final-done-word (nth 4 ass))
10783 (last-state (or this ""))
10784 (completion-ignore-case t)
10785 (member (member this org-todo-keywords-1))
10786 (tail (cdr member))
10787 (state (cond
10788 ((and org-todo-key-trigger
10789 (or (and (equal arg '(4))
10790 (eq org-use-fast-todo-selection 'prefix))
10791 (and (not arg) org-use-fast-todo-selection
10792 (not (eq org-use-fast-todo-selection
10793 'prefix)))))
10794 ;; Use fast selection
10795 (org-fast-todo-selection))
10796 ((and (equal arg '(4))
10797 (or (not org-use-fast-todo-selection)
10798 (not org-todo-key-trigger)))
10799 ;; Read a state with completion
10800 (org-icompleting-read
10801 "State: " (mapcar (lambda(x) (list x))
10802 org-todo-keywords-1)
10803 nil t))
10804 ((eq arg 'right)
10805 (if this
10806 (if tail (car tail) nil)
10807 (car org-todo-keywords-1)))
10808 ((eq arg 'left)
10809 (if (equal member org-todo-keywords-1)
10810 nil
10811 (if this
10812 (nth (- (length org-todo-keywords-1)
10813 (length tail) 2)
10814 org-todo-keywords-1)
10815 (org-last org-todo-keywords-1))))
10816 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10817 (setq arg nil))) ; hack to fall back to cycling
10818 (arg
10819 ;; user or caller requests a specific state
10820 (cond
10821 ((equal arg "") nil)
10822 ((eq arg 'none) nil)
10823 ((eq arg 'done) (or done-word (car org-done-keywords)))
10824 ((eq arg 'nextset)
10825 (or (car (cdr (member head org-todo-heads)))
10826 (car org-todo-heads)))
10827 ((eq arg 'previousset)
10828 (let ((org-todo-heads (reverse org-todo-heads)))
10829 (or (car (cdr (member head org-todo-heads)))
10830 (car org-todo-heads))))
10831 ((car (member arg org-todo-keywords-1)))
10832 ((stringp arg)
10833 (error "State `%s' not valid in this file" arg))
10834 ((nth (1- (prefix-numeric-value arg))
10835 org-todo-keywords-1))))
10836 ((null member) (or head (car org-todo-keywords-1)))
10837 ((equal this final-done-word) nil) ;; -> make empty
10838 ((null tail) nil) ;; -> first entry
10839 ((memq interpret '(type priority))
10840 (if (eq this-command last-command)
10841 (car tail)
10842 (if (> (length tail) 0)
10843 (or done-word (car org-done-keywords))
10844 nil)))
10845 (t
10846 (car tail))))
10847 (state (or
10848 (run-hook-with-args-until-success
10849 'org-todo-get-default-hook state last-state)
10850 state))
10851 (next (if state (concat " " state " ") " "))
10852 (change-plist (list :type 'todo-state-change :from this :to state
10853 :position startpos))
10854 dolog now-done-p)
10855 (when org-blocker-hook
10856 (setq org-last-todo-state-is-todo
10857 (not (member this org-done-keywords)))
10858 (unless (save-excursion
10859 (save-match-data
10860 (run-hook-with-args-until-failure
10861 'org-blocker-hook change-plist)))
10862 (if (interactive-p)
10863 (error "TODO state change from %s to %s blocked" this state)
10864 ;; fail silently
10865 (message "TODO state change from %s to %s blocked" this state)
10866 (throw 'exit nil))))
10867 (store-match-data match-data)
10868 (replace-match next t t)
10869 (unless (pos-visible-in-window-p hl-pos)
10870 (message "TODO state changed to %s" (org-trim next)))
10871 (unless head
10872 (setq head (org-get-todo-sequence-head state)
10873 ass (assoc head org-todo-kwd-alist)
10874 interpret (nth 1 ass)
10875 done-word (nth 3 ass)
10876 final-done-word (nth 4 ass)))
10877 (when (memq arg '(nextset previousset))
10878 (message "Keyword-Set %d/%d: %s"
10879 (- (length org-todo-sets) -1
10880 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10881 (length org-todo-sets)
10882 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10883 (setq org-last-todo-state-is-todo
10884 (not (member state org-done-keywords)))
10885 (setq now-done-p (and (member state org-done-keywords)
10886 (not (member this org-done-keywords))))
10887 (and logging (org-local-logging logging))
10888 (when (and (or org-todo-log-states org-log-done)
10889 (not (eq org-inhibit-logging t))
10890 (not (memq arg '(nextset previousset))))
10891 ;; we need to look at recording a time and note
10892 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10893 (nth 2 (assoc this org-todo-log-states))))
10894 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10895 (setq dolog 'time))
10896 (when (and state
10897 (member state org-not-done-keywords)
10898 (not (member this org-not-done-keywords)))
10899 ;; This is now a todo state and was not one before
10900 ;; If there was a CLOSED time stamp, get rid of it.
10901 (org-add-planning-info nil nil 'closed))
10902 (when (and now-done-p org-log-done)
10903 ;; It is now done, and it was not done before
10904 (org-add-planning-info 'closed (org-current-time))
10905 (if (and (not dolog) (eq 'note org-log-done))
10906 (org-add-log-setup 'done state this 'findpos 'note)))
10907 (when (and state dolog)
10908 ;; This is a non-nil state, and we need to log it
10909 (org-add-log-setup 'state state this 'findpos dolog)))
10910 ;; Fixup tag positioning
10911 (org-todo-trigger-tag-changes state)
10912 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10913 (when org-provide-todo-statistics
10914 (org-update-parent-todo-statistics))
10915 (run-hooks 'org-after-todo-state-change-hook)
10916 (if (and arg (not (member state org-done-keywords)))
10917 (setq head (org-get-todo-sequence-head state)))
10918 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10919 ;; Do we need to trigger a repeat?
10920 (when now-done-p
10921 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10922 ;; This is for the agenda, take a snapshot of the headline.
10923 (save-match-data
10924 (setq org-agenda-headline-snapshot-before-repeat
10925 (org-get-heading))))
10926 (org-auto-repeat-maybe state))
10927 ;; Fixup cursor location if close to the keyword
10928 (if (and (outline-on-heading-p)
10929 (not (bolp))
10930 (save-excursion (beginning-of-line 1)
10931 (looking-at org-todo-line-regexp))
10932 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10933 (progn
10934 (goto-char (or (match-end 2) (match-end 1)))
10935 (and (looking-at " ") (just-one-space))))
10936 (when org-trigger-hook
10937 (save-excursion
10938 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10940 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10941 "Block turning an entry into a TODO, using the hierarchy.
10942 This checks whether the current task should be blocked from state
10943 changes. Such blocking occurs when:
10945 1. The task has children which are not all in a completed state.
10947 2. A task has a parent with the property :ORDERED:, and there
10948 are siblings prior to the current task with incomplete
10949 status.
10951 3. The parent of the task is blocked because it has siblings that should
10952 be done first, or is child of a block grandparent TODO entry."
10954 (if (not org-enforce-todo-dependencies)
10955 t ; if locally turned off don't block
10956 (catch 'dont-block
10957 ;; If this is not a todo state change, or if this entry is already DONE,
10958 ;; do not block
10959 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10960 (member (plist-get change-plist :from)
10961 (cons 'done org-done-keywords))
10962 (member (plist-get change-plist :to)
10963 (cons 'todo org-not-done-keywords))
10964 (not (plist-get change-plist :to)))
10965 (throw 'dont-block t))
10966 ;; If this task has children, and any are undone, it's blocked
10967 (save-excursion
10968 (org-back-to-heading t)
10969 (let ((this-level (funcall outline-level)))
10970 (outline-next-heading)
10971 (let ((child-level (funcall outline-level)))
10972 (while (and (not (eobp))
10973 (> child-level this-level))
10974 ;; this todo has children, check whether they are all
10975 ;; completed
10976 (if (and (not (org-entry-is-done-p))
10977 (org-entry-is-todo-p))
10978 (throw 'dont-block nil))
10979 (outline-next-heading)
10980 (setq child-level (funcall outline-level))))))
10981 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10982 ;; any previous siblings are undone, it's blocked
10983 (save-excursion
10984 (org-back-to-heading t)
10985 (let* ((pos (point))
10986 (parent-pos (and (org-up-heading-safe) (point))))
10987 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10988 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10989 (forward-line 1)
10990 (re-search-forward org-not-done-heading-regexp pos t))
10991 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10992 ;; Search further up the hierarchy, to see if an anchestor is blocked
10993 (while t
10994 (goto-char parent-pos)
10995 (if (not (looking-at org-not-done-heading-regexp))
10996 (throw 'dont-block t)) ; do not block, parent is not a TODO
10997 (setq pos (point))
10998 (setq parent-pos (and (org-up-heading-safe) (point)))
10999 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11000 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11001 (forward-line 1)
11002 (re-search-forward org-not-done-heading-regexp pos t))
11003 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11005 (defcustom org-track-ordered-property-with-tag nil
11006 "Should the ORDERED property also be shown as a tag?
11007 The ORDERED property decides if an entry should require subtasks to be
11008 completed in sequence. Since a property is not very visible, setting
11009 this option means that toggling the ORDERED property with the command
11010 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11011 not relevant for the behavior, but it makes things more visible.
11013 Note that toggling the tag with tags commands will not change the property
11014 and therefore not influence behavior!
11016 This can be t, meaning the tag ORDERED should be used, It can also be a
11017 string to select a different tag for this task."
11018 :group 'org-todo
11019 :type '(choice
11020 (const :tag "No tracking" nil)
11021 (const :tag "Track with ORDERED tag" t)
11022 (string :tag "Use other tag")))
11024 (defun org-toggle-ordered-property ()
11025 "Toggle the ORDERED property of the current entry.
11026 For better visibility, you can track the value of this property with a tag.
11027 See variable `org-track-ordered-property-with-tag'."
11028 (interactive)
11029 (let* ((t1 org-track-ordered-property-with-tag)
11030 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11031 (save-excursion
11032 (org-back-to-heading)
11033 (if (org-entry-get nil "ORDERED")
11034 (progn
11035 (org-delete-property "ORDERED")
11036 (and tag (org-toggle-tag tag 'off))
11037 (message "Subtasks can be completed in arbitrary order"))
11038 (org-entry-put nil "ORDERED" "t")
11039 (and tag (org-toggle-tag tag 'on))
11040 (message "Subtasks must be completed in sequence")))))
11042 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11043 (defun org-block-todo-from-checkboxes (change-plist)
11044 "Block turning an entry into a TODO, using checkboxes.
11045 This checks whether the current task should be blocked from state
11046 changes because there are unchecked boxes in this entry."
11047 (if (not org-enforce-todo-checkbox-dependencies)
11048 t ; if locally turned off don't block
11049 (catch 'dont-block
11050 ;; If this is not a todo state change, or if this entry is already DONE,
11051 ;; do not block
11052 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11053 (member (plist-get change-plist :from)
11054 (cons 'done org-done-keywords))
11055 (member (plist-get change-plist :to)
11056 (cons 'todo org-not-done-keywords))
11057 (not (plist-get change-plist :to)))
11058 (throw 'dont-block t))
11059 ;; If this task has checkboxes that are not checked, it's blocked
11060 (save-excursion
11061 (org-back-to-heading t)
11062 (let ((beg (point)) end)
11063 (outline-next-heading)
11064 (setq end (point))
11065 (goto-char beg)
11067 end t)
11068 (progn
11069 (if (boundp 'org-blocked-by-checkboxes)
11070 (setq org-blocked-by-checkboxes t))
11071 (throw 'dont-block nil)))))
11072 t))) ; do not block
11074 (defun org-entry-blocked-p ()
11075 "Is the current entry blocked?"
11076 (if (org-entry-get nil "NOBLOCKING")
11077 nil ;; Never block this entry
11078 (not
11079 (run-hook-with-args-until-failure
11080 'org-blocker-hook
11081 (list :type 'todo-state-change
11082 :position (point)
11083 :from 'todo
11084 :to 'done)))))
11086 (defun org-update-statistics-cookies (all)
11087 "Update the statistics cookie, either from TODO or from checkboxes.
11088 This should be called with the cursor in a line with a statistics cookie."
11089 (interactive "P")
11090 (if all
11091 (progn
11092 (org-update-checkbox-count 'all)
11093 (org-map-entries 'org-update-parent-todo-statistics))
11094 (if (not (org-on-heading-p))
11095 (org-update-checkbox-count)
11096 (let ((pos (move-marker (make-marker) (point)))
11097 end l1 l2)
11098 (ignore-errors (org-back-to-heading t))
11099 (if (not (org-on-heading-p))
11100 (org-update-checkbox-count)
11101 (setq l1 (org-outline-level))
11102 (setq end (save-excursion
11103 (outline-next-heading)
11104 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11105 (point)))
11106 (if (and (save-excursion
11107 (re-search-forward
11109 (not (save-excursion (re-search-forward
11111 (org-update-checkbox-count)
11112 (if (and l2 (> l2 l1))
11113 (progn
11114 (goto-char end)
11115 (org-update-parent-todo-statistics))
11116 (goto-char pos)
11117 (beginning-of-line 1)
11118 (while (re-search-forward
11120 (point-at-eol) t)
11121 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11122 (goto-char pos)
11123 (move-marker pos nil)))))
11125 (defvar org-entry-property-inherited-from) ;; defined below
11126 (defun org-update-parent-todo-statistics ()
11127 "Update any statistics cookie in the parent of the current headline.
11128 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11129 the entire subtree and this will travel up the hierarchy and update
11130 statistics everywhere."
11131 (interactive)
11132 (let* ((lim 0) prop
11133 (recursive (or (not org-hierarchical-todo-statistics)
11134 (string-match
11136 (or (setq prop (org-entry-get
11137 nil "COOKIE_DATA" 'inherit)) ""))))
11138 (lim (or (and prop (marker-position
11139 org-entry-property-inherited-from))
11140 lim))
11141 (first t)
11143 level ltoggle l1 new ndel
11144 (cnt-all 0) (cnt-done 0) is-percent kwd
11145 checkbox-beg ov ovs ove cookie-present)
11146 (catch 'exit
11147 (save-excursion
11148 (beginning-of-line 1)
11149 (if (org-at-heading-p)
11150 (setq ltoggle (funcall outline-level))
11151 (error "This should not happen"))
11152 (while (and (setq level (org-up-heading-safe))
11153 (or recursive first)
11154 (>= (point) lim))
11155 (setq first nil cookie-present nil)
11156 (unless (and level
11157 (not (string-match
11159 (downcase
11160 (or (org-entry-get
11161 nil "COOKIE_DATA")
11162 "")))))
11163 (throw 'exit nil))
11164 (while (re-search-forward box-re (point-at-eol) t)
11165 (setq cnt-all 0 cnt-done 0 cookie-present t)
11166 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11167 (save-match-data
11168 (unless (outline-next-heading) (throw 'exit nil))
11169 (while (and (looking-at org-complex-heading-regexp)
11170 (> (setq l1 (length (match-string 1))) level))
11171 (setq kwd (and (or recursive (= l1 ltoggle))
11172 (match-string 2)))
11173 (if (or (eq org-provide-todo-statistics 'all-headlines)
11174 (and (listp org-provide-todo-statistics)
11175 (or (member kwd org-provide-todo-statistics)
11176 (member kwd org-done-keywords))))
11177 (setq cnt-all (1+ cnt-all))
11178 (if (eq org-provide-todo-statistics t)
11179 (and kwd (setq cnt-all (1+ cnt-all)))))
11180 (and (member kwd org-done-keywords)
11181 (setq cnt-done (1+ cnt-done)))
11182 (outline-next-heading)))
11183 (setq new
11184 (if is-percent
11185 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11186 (format "[%d/%d]" cnt-done cnt-all))
11187 ndel (- (match-end 0) checkbox-beg))
11188 ;; handle overlays when updating cookie from column view
11189 (when (setq ov (car (overlays-at checkbox-beg)))
11190 (setq ovs (overlay-start ov) ove (overlay-end ov))
11191 (delete-overlay ov))
11192 (goto-char checkbox-beg)
11193 (insert new)
11194 (delete-region (point) (+ (point) ndel))
11195 (when ov (move-overlay ov ovs ove)))
11196 (when cookie-present
11197 (run-hook-with-args 'org-after-todo-statistics-hook
11198 cnt-done (- cnt-all cnt-done))))))
11199 (run-hooks 'org-todo-statistics-hook)))
11201 (defvar org-after-todo-statistics-hook nil
11202 "Hook that is called after a TODO statistics cookie has been updated.
11203 Each function is called with two arguments: the number of not-done entries
11204 and the number of done entries.
11206 For example, the following function, when added to this hook, will switch
11207 an entry to DONE when all children are done, and back to TODO when new
11208 entries are set to a TODO status. Note that this hook is only called
11209 when there is a statistics cookie in the headline!
11211 (defun org-summary-todo (n-done n-not-done)
11213 (let (org-log-done org-log-states) ; turn off logging
11215 ")
11217 (defvar org-todo-statistics-hook nil
11218 "Hook that is run whenever Org thinks TODO statistics should be updated.
11219 This hook runs even if there is no statistics cookie present, in which case
11220 `org-after-todo-statistics-hook' would not run.")
11222 (defun org-todo-trigger-tag-changes (state)
11223 "Apply the changes defined in `org-todo-state-tags-triggers'."
11224 (let ((l org-todo-state-tags-triggers)
11225 changes)
11226 (when (or (not state) (equal state ""))
11227 (setq changes (append changes (cdr (assoc "" l)))))
11228 (when (and (stringp state) (> (length state) 0))
11229 (setq changes (append changes (cdr (assoc state l)))))
11230 (when (member state org-not-done-keywords)
11231 (setq changes (append changes (cdr (assoc 'todo l)))))
11232 (when (member state org-done-keywords)
11233 (setq changes (append changes (cdr (assoc 'done l)))))
11234 (dolist (c changes)
11235 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11237 (defun org-local-logging (value)
11238 "Get logging settings from a property VALUE."
11239 (let* (words w a)
11240 ;; directly set the variables, they are already local.
11241 (setq org-log-done nil
11242 org-log-repeat nil
11243 org-todo-log-states nil)
11244 (setq words (org-split-string value))
11245 (while (setq w (pop words))
11246 (cond
11247 ((setq a (assoc w org-startup-options))
11248 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11249 (set (nth 1 a) (nth 2 a))))
11250 ((setq a (org-extract-log-state-settings w))
11251 (and (member (car a) org-todo-keywords-1)
11252 (push a org-todo-log-states)))))))
11254 (defun org-get-todo-sequence-head (kwd)
11255 "Return the head of the TODO sequence to which KWD belongs.
11256 If KWD is not set, check if there is a text property remembering the
11257 right sequence."
11258 (let (p)
11259 (cond
11260 ((not kwd)
11261 (or (get-text-property (point-at-bol) 'org-todo-head)
11262 (progn
11263 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11264 nil (point-at-eol)))
11265 (get-text-property p 'org-todo-head))))
11266 ((not (member kwd org-todo-keywords-1))
11267 (car org-todo-keywords-1))
11268 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11270 (defun org-fast-todo-selection ()
11271 "Fast TODO keyword selection with single keys.
11272 Returns the new TODO keyword, or nil if no state change should occur."
11273 (let* ((fulltable org-todo-key-alist)
11274 (done-keywords org-done-keywords) ;; needed for the faces.
11275 (maxlen (apply 'max (mapcar
11276 (lambda (x)
11277 (if (stringp (car x)) (string-width (car x)) 0))
11278 fulltable)))
11279 (expert nil)
11280 (fwidth (+ maxlen 3 1 3))
11281 (ncol (/ (- (window-width) 4) fwidth))
11282 tg cnt e c tbl
11283 groups ingroup)
11284 (save-excursion
11285 (save-window-excursion
11286 (if expert
11287 (set-buffer (get-buffer-create " *Org todo*"))
11288 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11289 (erase-buffer)
11290 (org-set-local 'org-done-keywords done-keywords)
11291 (setq tbl fulltable cnt 0)
11292 (while (setq e (pop tbl))
11293 (cond
11294 ((equal e '(:startgroup))
11295 (push '() groups) (setq ingroup t)
11296 (when (not (= cnt 0))
11297 (setq cnt 0)
11299 (insert "{ "))
11300 ((equal e '(:endgroup))
11301 (setq ingroup nil cnt 0)
11303 ((equal e '(:newline))
11304 (when (not (= cnt 0))
11305 (setq cnt 0)
11307 (setq e (car tbl))
11308 (while (equal (car tbl) '(:newline))
11310 (setq tbl (cdr tbl)))))
11311 (t
11312 (setq tg (car e) c (cdr e))
11313 (if ingroup (push tg (car groups)))
11314 (setq tg (org-add-props tg nil 'face
11315 (org-get-todo-face tg)))
11316 (if (and (= cnt 0) (not ingroup)) (insert " "))
11317 (insert "[" c "] " tg (make-string
11318 (- fwidth 4 (length tg)) ?\ ))
11319 (when (= (setq cnt (1+ cnt)) ncol)
11321 (if ingroup (insert " "))
11322 (setq cnt 0)))))
11324 (goto-char (point-min))
11325 (if (not expert) (org-fit-window-to-buffer))
11326 (message "[a-z..]:Set [SPC]:clear")
11327 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11328 (cond
11329 ((or (= c ?\C-g)
11330 (and (= c ?q) (not (rassoc c fulltable))))
11331 (setq quit-flag t))
11332 ((= c ?\ ) nil)
11333 ((setq e (rassoc c fulltable) tg (car e))
11334 tg)
11335 (t (setq quit-flag t)))))))
11337 (defun org-entry-is-todo-p ()
11338 (member (org-get-todo-state) org-not-done-keywords))
11340 (defun org-entry-is-done-p ()
11341 (member (org-get-todo-state) org-done-keywords))
11343 (defun org-get-todo-state ()
11344 (save-excursion
11345 (org-back-to-heading t)
11346 (and (looking-at org-todo-line-regexp)
11347 (match-end 2)
11348 (match-string 2))))
11350 (defun org-at-date-range-p (&optional inactive-ok)
11351 "Is the cursor inside a date range?"
11352 (interactive)
11353 (save-excursion
11354 (catch 'exit
11355 (let ((pos (point)))
11357 (skip-chars-backward "<[")
11358 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11359 (>= (match-end 0) pos)
11360 (throw 'exit t))
11362 (skip-chars-backward "<[")
11363 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11364 (>= (match-end 0) pos)
11365 (throw 'exit t)))
11366 nil)))
11368 (defun org-get-repeat (&optional tagline)
11369 "Check if there is a deadline/schedule with repeater in this entry."
11370 (save-match-data
11371 (save-excursion
11372 (org-back-to-heading t)
11373 (and (re-search-forward (if tagline
11375 org-repeat-re)
11376 (org-entry-end-position) t)
11377 (match-string-no-properties 1)))))
11379 (defvar org-last-changed-timestamp)
11380 (defvar org-last-inserted-timestamp)
11381 (defvar org-log-post-message)
11382 (defvar org-log-note-purpose)
11383 (defvar org-log-note-how)
11384 (defvar org-log-note-extra)
11385 (defun org-auto-repeat-maybe (done-word)
11386 "Check if the current headline contains a repeated deadline/schedule.
11387 If yes, set TODO state back to what it was and change the base date
11388 of repeating deadline/scheduled time stamps to new date.
11389 This function is run automatically after each state change to a DONE state."
11390 ;; last-state is dynamically scoped into this function
11391 (let* ((repeat (org-get-repeat))
11392 (aa (assoc last-state org-todo-kwd-alist))
11393 (interpret (nth 1 aa))
11394 (head (nth 2 aa))
11395 (whata '(("d" . day) ("m" . month) ("y" . year)))
11396 (msg "Entry repeats: ")
11397 (org-log-done nil)
11398 (org-todo-log-states nil)
11399 re type n what ts time to-state)
11400 (when repeat
11401 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11402 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11403 org-todo-repeat-to-state))
11404 (unless (and to-state (member to-state org-todo-keywords-1))
11405 (setq to-state (if (eq interpret 'type) last-state head)))
11406 (org-todo to-state)
11407 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11408 (org-entry-put nil "LAST_REPEAT" (format-time-string
11409 (org-time-stamp-format t t))))
11410 (when org-log-repeat
11411 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11412 (memq 'org-add-log-note post-command-hook))
11413 ;; OK, we are already setup for some record
11414 (if (eq org-log-repeat 'note)
11415 ;; make sure we take a note, not only a time stamp
11416 (setq org-log-note-how 'note))
11417 ;; Set up for taking a record
11418 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11419 last-state
11420 'findpos org-log-repeat)))
11421 (org-back-to-heading t)
11422 (org-add-planning-info nil nil 'closed)
11426 (while (re-search-forward
11427 re (save-excursion (outline-next-heading) (point)) t)
11428 (setq type (if (match-end 1) org-scheduled-string
11429 (if (match-end 3) org-deadline-string "Plain:"))
11430 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11432 (setq n (string-to-number (match-string 2 ts))
11433 what (match-string 3 ts))
11434 (if (equal what "w") (setq n (* n 7) what "d"))
11435 ;; Preparation, see if we need to modify the start date for the change
11436 (when (match-end 1)
11437 (setq time (save-match-data (org-time-string-to-time ts)))
11438 (cond
11439 ((equal (match-string 1 ts) ".")
11440 ;; Shift starting date to today
11441 (org-timestamp-change
11442 (- (time-to-days (current-time)) (time-to-days time))
11443 'day))
11444 ((equal (match-string 1 ts) "+")
11445 (let ((nshiftmax 10) (nshift 0))
11446 (while (or (= nshift 0)
11447 (<= (time-to-days time)
11448 (time-to-days (current-time))))
11449 (when (= (incf nshift) nshiftmax)
11450 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11451 (error "Abort")))
11452 (org-timestamp-change n (cdr (assoc what whata)))
11453 (org-at-timestamp-p t)
11454 (setq ts (match-string 1))
11455 (setq time (save-match-data (org-time-string-to-time ts)))))
11456 (org-timestamp-change (- n) (cdr (assoc what whata)))
11457 ;; rematch, so that we have everything in place for the real shift
11458 (org-at-timestamp-p t)
11459 (setq ts (match-string 1))
11461 (org-timestamp-change n (cdr (assoc what whata)))
11462 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11463 (setq org-log-post-message msg)
11464 (message "%s" msg))))
11466 (defun org-show-todo-tree (arg)
11467 "Make a compact tree which shows all headlines marked with TODO.
11468 The tree will show the lines where the regexp matches, and all higher
11469 headlines above the match.
11471 With a numeric prefix N, construct a sparse tree for the Nth element
11472 of `org-todo-keywords-1'."
11473 (interactive "P")
11474 (let ((case-fold-search nil)
11475 (kwd-re
11476 (cond ((null arg) org-not-done-regexp)
11477 ((equal arg '(4))
11478 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11479 (mapcar 'list org-todo-keywords-1))))
11483 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11484 (regexp-quote (nth (1- (prefix-numeric-value arg))
11485 org-todo-keywords-1)))
11486 (t (error "Invalid prefix argument: %s" arg)))))
11487 (message "%d TODO entries found"
11488 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11490 (defun org-deadline (&optional remove time)
11492 With argument REMOVE, remove any deadline from the item.
11493 When TIME is set, it should be an internal time specification, and the
11494 scheduling will use the corresponding date."
11495 (interactive "P")
11496 (let* ((old-date (org-entry-get nil "DEADLINE"))
11497 (repeater (and old-date
11498 (string-match
11500 old-date)
11501 (match-string 1 old-date))))
11502 (if remove
11503 (progn
11504 (when (and old-date org-log-redeadline)
11505 (org-add-log-setup 'deldeadline nil old-date 'findpos
11506 org-log-redeadline))
11507 (org-remove-timestamp-with-keyword org-deadline-string)
11508 (message "Item no longer has a deadline."))
11509 (org-add-planning-info 'deadline time 'closed)
11510 (when (and old-date org-log-redeadline
11511 (not (equal old-date
11512 (substring org-last-inserted-timestamp 1 -1))))
11513 (org-add-log-setup 'redeadline nil old-date 'findpos
11514 org-log-redeadline))
11515 (when repeater
11516 (save-excursion
11517 (org-back-to-heading t)
11518 (when (re-search-forward (concat org-deadline-string " "
11519 org-last-inserted-timestamp)
11520 (save-excursion
11521 (outline-next-heading) (point)) t)
11522 (goto-char (1- (match-end 0)))
11523 (insert " " repeater)
11524 (setq org-last-inserted-timestamp
11525 (concat (substring org-last-inserted-timestamp 0 -1)
11526 " " repeater
11527 (substring org-last-inserted-timestamp -1))))))
11528 (message "Deadline on %s" org-last-inserted-timestamp))))
11530 (defun org-schedule (&optional remove time)
11531 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11532 With argument REMOVE, remove any scheduling date from the item.
11533 When TIME is set, it should be an internal time specification, and the
11534 scheduling will use the corresponding date."
11535 (interactive "P")
11536 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11537 (repeater (and old-date
11538 (string-match
11540 old-date)
11541 (match-string 1 old-date))))
11542 (if remove
11543 (progn
11544 (when (and old-date org-log-reschedule)
11545 (org-add-log-setup 'delschedule nil old-date 'findpos
11546 org-log-reschedule))
11547 (org-remove-timestamp-with-keyword org-scheduled-string)
11548 (message "Item is no longer scheduled."))
11549 (org-add-planning-info 'scheduled time 'closed)
11550 (when (and old-date org-log-reschedule
11551 (not (equal old-date
11552 (substring org-last-inserted-timestamp 1 -1))))
11553 (org-add-log-setup 'reschedule nil old-date 'findpos
11554 org-log-reschedule))
11555 (when repeater
11556 (save-excursion
11557 (org-back-to-heading t)
11558 (when (re-search-forward (concat org-scheduled-string " "
11559 org-last-inserted-timestamp)
11560 (save-excursion
11561 (outline-next-heading) (point)) t)
11562 (goto-char (1- (match-end 0)))
11563 (insert " " repeater)
11564 (setq org-last-inserted-timestamp
11565 (concat (substring org-last-inserted-timestamp 0 -1)
11566 " " repeater
11567 (substring org-last-inserted-timestamp -1))))))
11568 (message "Scheduled to %s" org-last-inserted-timestamp))))
11570 (defun org-get-scheduled-time (pom &optional inherit)
11571 "Get the scheduled time as a time tuple, of a format suitable
11572 for calling org-schedule with, or if there is no scheduling,
11573 returns nil."
11574 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11575 (when time
11576 (apply 'encode-time (org-parse-time-string time)))))
11578 (defun org-get-deadline-time (pom &optional inherit)
11579 "Get the deadline as a time tuple, of a format suitable for
11580 calling org-deadline with, or if there is no scheduling, returns
11581 nil."
11582 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11583 (when time
11584 (apply 'encode-time (org-parse-time-string time)))))
11586 (defun org-remove-timestamp-with-keyword (keyword)
11587 "Remove all time stamps with KEYWORD in the current entry."
11589 beg)
11590 (save-excursion
11591 (org-back-to-heading t)
11592 (setq beg (point))
11593 (outline-next-heading)
11594 (while (re-search-backward re beg t)
11595 (replace-match "")
11597 (equal (char-before) ?\ ))
11598 (backward-delete-char 1)
11600 (point-at-bol) (point-at-eol)))
11601 (delete-region (point-at-bol)
11602 (min (point-max) (1+ (point-at-eol))))))))))
11604 (defun org-add-planning-info (what &optional time &rest remove)
11605 "Insert new timestamp with keyword in the line directly after the headline.
11606 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11607 If non is given, the user is prompted for a date.
11608 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11609 be removed."
11610 (interactive)
11611 (let (org-time-was-given org-end-time-was-given ts
11612 end default-time default-input)
11614 (catch 'exit
11615 (when (and (not time) (memq what '(scheduled deadline)))
11616 ;; Try to get a default date/time from existing timestamp
11617 (save-excursion
11618 (org-back-to-heading t)
11619 (setq end (save-excursion (outline-next-heading) (point)))
11620 (when (re-search-forward (if (eq what 'scheduled)
11621 org-scheduled-time-regexp
11622 org-deadline-time-regexp)
11623 end t)
11624 (setq ts (match-string 1)
11625 default-time
11626 (apply 'encode-time (org-parse-time-string ts))
11627 default-input (and ts (org-get-compact-tod ts))))))
11628 (when what
11629 ;; If necessary, get the time from the user
11630 (setq time (or time (org-read-date nil 'to-time nil nil
11631 default-time default-input))))
11633 (when (and org-insert-labeled-timestamps-at-point
11634 (member what '(scheduled deadline)))
11635 (insert
11636 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11637 (org-insert-time-stamp time org-time-was-given
11638 nil nil nil (list org-end-time-was-given))
11639 (setq what nil))
11640 (save-excursion
11641 (save-restriction
11642 (let (col list elt ts buffer-invisibility-spec)
11643 (org-back-to-heading t)
11645 (goto-char (match-end 1))
11646 (setq col (current-column))
11647 (goto-char (match-end 0))
11649 (when (and (not what)
11650 (not (looking-at
11652 org-keyword-time-not-clock-regexp))))
11653 ;; Nothing to add, nothing to remove...... :-)
11654 (throw 'exit nil))
11655 (if (and (not (looking-at outline-regexp))
11658 (not (equal (match-string 1) org-clock-string)))
11659 (narrow-to-region (match-beginning 0) (match-end 0))
11661 (backward-char 1)
11662 (narrow-to-region (point) (point))
11663 (and org-adapt-indentation (org-indent-to-column col)))
11664 ;; Check if we have to remove something.
11665 (setq list (cons what remove))
11666 (while list
11667 (setq elt (pop list))
11668 (goto-char (point-min))
11669 (when (or (and (eq elt 'scheduled)
11670 (re-search-forward org-scheduled-time-regexp nil t))
11671 (and (eq elt 'deadline)
11672 (re-search-forward org-deadline-time-regexp nil t))
11673 (and (eq elt 'closed)
11674 (re-search-forward org-closed-time-regexp nil t)))
11675 (replace-match "")
11676 (if (looking-at "--+<[^>]+>") (replace-match ""))
11677 (skip-chars-backward " ")
11678 (if (looking-at " +") (replace-match ""))))
11679 (goto-char (point-max))
11680 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11681 (when what
11682 (insert
11683 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11684 (cond ((eq what 'scheduled) org-scheduled-string)
11685 ((eq what 'deadline) org-deadline-string)
11686 ((eq what 'closed) org-closed-string))
11687 " ")
11688 (setq ts (org-insert-time-stamp
11689 time
11690 (or org-time-was-given
11691 (and (eq what 'closed) org-log-done-with-time))
11692 (eq what 'closed)
11693 nil nil (list org-end-time-was-given)))
11694 (end-of-line 1))
11695 (goto-char (point-min))
11696 (widen)
11699 (delete-region (1- (point)) (point-at-eol)))
11700 ts))))))
11702 (defvar org-log-note-marker (make-marker))
11703 (defvar org-log-note-purpose nil)
11704 (defvar org-log-note-state nil)
11705 (defvar org-log-note-previous-state nil)
11706 (defvar org-log-note-how nil)
11707 (defvar org-log-note-extra nil)
11708 (defvar org-log-note-window-configuration nil)
11709 (defvar org-log-note-return-to (make-marker))
11710 (defvar org-log-post-message nil
11711 "Message to be displayed after a log note has been stored.
11712 The auto-repeater uses this.")
11714 (defun org-add-note ()
11715 "Add a note to the current entry.
11716 This is done in the same way as adding a state change note."
11717 (interactive)
11718 (org-add-log-setup 'note nil nil 'findpos nil))
11720 (defvar org-property-end-re)
11721 (defun org-add-log-setup (&optional purpose state prev-state
11722 findpos how extra)
11723 "Set up the post command hook to take a note.
11724 If this is about to TODO state change, the new state is expected in STATE.
11725 When FINDPOS is non-nil, find the correct position for the note in
11726 the current entry. If not, assume that it can be inserted at point.
11727 HOW is an indicator what kind of note should be created.
11728 EXTRA is additional text that will be inserted into the notes buffer."
11729 (let* ((org-log-into-drawer (org-log-into-drawer))
11730 (drawer (cond ((stringp org-log-into-drawer)
11731 org-log-into-drawer)
11732 (org-log-into-drawer "LOGBOOK")
11733 (t nil))))
11734 (save-restriction
11735 (save-excursion
11736 (when findpos
11737 (org-back-to-heading t)
11738 (narrow-to-region (point) (save-excursion
11739 (outline-next-heading) (point)))
11743 (goto-char (match-end 0))
11744 (cond
11745 (drawer
11747 nil t)
11748 (progn
11749 (goto-char (match-end 0))
11750 (or org-log-states-order-reversed
11751 (and (re-search-forward org-property-end-re nil t)
11752 (goto-char (1- (match-beginning 0))))))
11754 (beginning-of-line 0)
11755 (org-indent-line-function)
11756 (beginning-of-line 2)
11757 (org-indent-line-function)
11758 (end-of-line 0)))
11759 ((and org-log-state-notes-insert-after-drawers
11760 (save-excursion
11761 (forward-line) (looking-at org-drawer-regexp)))
11762 (forward-line)
11763 (while (looking-at org-drawer-regexp)
11764 (goto-char (match-end 0))
11765 (re-search-forward org-property-end-re (point-max) t)
11766 (forward-line))
11767 (forward-line -1)))
11768 (unless org-log-states-order-reversed
11770 (org-skip-over-state-notes)
11772 (move-marker org-log-note-marker (point))
11773 (setq org-log-note-purpose purpose
11774 org-log-note-state state
11775 org-log-note-previous-state prev-state
11776 org-log-note-how how
11777 org-log-note-extra extra)
11778 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11780 (defun org-skip-over-state-notes ()
11781 "Skip past the list of State notes in an entry."
11783 (when (org-in-item-p)
11784 (let ((limit (org-list-bottom-point)))
11786 (goto-char (or (org-get-next-item (point) limit)
11787 (org-get-end-of-item limit)))))))
11789 (defun org-add-log-note (&optional purpose)
11790 "Pop up a window for taking a note, and add this note later at point."
11791 (remove-hook 'post-command-hook 'org-add-log-note)
11792 (setq org-log-note-window-configuration (current-window-configuration))
11793 (delete-other-windows)
11794 (move-marker org-log-note-return-to (point))
11795 (switch-to-buffer (marker-buffer org-log-note-marker))
11796 (goto-char org-log-note-marker)
11797 (org-switch-to-buffer-other-window "*Org Note*")
11798 (erase-buffer)
11799 (if (memq org-log-note-how '(time state))
11800 (let (current-prefix-arg) (org-store-log-note))
11801 (let ((org-inhibit-startup t)) (org-mode))
11802 (insert (format "# Insert note for %s.
11804 (cond
11805 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11806 ((eq org-log-note-purpose 'done) "closed todo item")
11807 ((eq org-log-note-purpose 'state)
11809 (or org-log-note-previous-state "")
11810 (or org-log-note-state "")))
11811 ((eq org-log-note-purpose 'reschedule)
11812 "rescheduling")
11813 ((eq org-log-note-purpose 'delschedule)
11814 "no longer scheduled")
11815 ((eq org-log-note-purpose 'redeadline)
11816 "changing deadline")
11817 ((eq org-log-note-purpose 'deldeadline)
11818 "removing deadline")
11819 ((eq org-log-note-purpose 'refile)
11820 "refiling")
11821 ((eq org-log-note-purpose 'note)
11822 "this entry")
11823 (t (error "This should not happen")))))
11824 (if org-log-note-extra (insert org-log-note-extra))
11825 (org-set-local 'org-finish-function 'org-store-log-note)))
11827 (defvar org-note-abort nil) ; dynamically scoped
11828 (defun org-store-log-note ()
11829 "Finish taking a log note, and insert it to where it belongs."
11830 (let ((txt (buffer-string))
11831 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11832 lines ind bul)
11833 (kill-buffer (current-buffer))
11835 (setq txt (replace-match "" t t txt)))
11837 (setq txt (replace-match "" t t txt)))
11840 (setq note
11841 (org-replace-escapes
11842 note
11843 (list (cons "%u" (user-login-name))
11844 (cons "%U" user-full-name)
11845 (cons "%t" (format-time-string
11846 (org-time-stamp-format 'long 'inactive)
11847 (current-time)))
11848 (cons "%T" (format-time-string
11849 (org-time-stamp-format 'long nil)
11850 (current-time)))
11851 (cons "%s" (if org-log-note-state
11853 ""))
11854 (cons "%S" (if org-log-note-previous-state
11858 (push note lines))
11859 (when (or current-prefix-arg org-note-abort)
11860 (when org-log-into-drawer
11861 (org-remove-empty-drawer-at
11862 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11863 org-log-note-marker))
11864 (setq lines nil))
11865 (when lines
11866 (with-current-buffer (marker-buffer org-log-note-marker)
11867 (save-excursion
11868 (goto-char org-log-note-marker)
11869 (move-marker org-log-note-marker nil)
11870 (end-of-line 1)
11872 (setq ind (save-excursion
11873 (if (org-in-item-p)
11874 (progn
11875 (goto-char (org-list-top-point))
11876 (org-get-indentation))
11878 (cond
11879 ((and (org-at-heading-p)
11880 org-adapt-indentation)
11881 (1+ (org-current-level)))
11882 ((org-at-heading-p) 0)
11883 (t (org-get-indentation))))))
11884 (setq bul (org-list-bullet-string "-"))
11885 (org-indent-line-to ind)
11886 (insert bul (pop lines))
11887 (let ((ind-body (+ (length bul) ind)))
11888 (while lines
11890 (org-indent-line-to ind-body)
11891 (insert (pop lines))))
11892 (message "Note stored")
11893 (org-back-to-heading t)
11894 (org-cycle-hide-drawers 'children)))))
11895 (set-window-configuration org-log-note-window-configuration)
11896 (with-current-buffer (marker-buffer org-log-note-return-to)
11897 (goto-char org-log-note-return-to))
11898 (move-marker org-log-note-return-to nil)
11899 (and org-log-post-message (message "%s" org-log-post-message)))
11901 (defun org-remove-empty-drawer-at (drawer pos)
11902 "Remove an empty drawer DRAWER at position POS.
11903 POS may also be a marker."
11904 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11905 (save-excursion
11906 (save-restriction
11907 (widen)
11908 (goto-char pos)
11909 (if (org-in-regexp
11911 (replace-match ""))))))
11913 (defun org-sparse-tree (&optional arg)
11914 "Create a sparse tree, prompt for the details.
11915 This command can create sparse trees. You first need to select the type
11916 of match used to create the tree:
11918 t Show all TODO entries.
11919 T Show entries with a specific TODO keyword.
11920 m Show entries selected by a tags/property match.
11921 p Enter a property name and its value (both with completion on existing
11922 names/values) and show entries with that property.
11923 r Show entries matching a regular expression (`/' can be used as well)
11924 d Show deadlines due within `org-deadline-warning-days'.
11925 b Show deadlines and scheduled items before a date.
11926 a Show deadlines and scheduled items after a date."
11927 (interactive "P")
11928 (let (ans kwd value)
11929 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11930 (setq ans (read-char-exclusive))
11931 (cond
11932 ((equal ans ?d)
11933 (call-interactively 'org-check-deadlines))
11934 ((equal ans ?b)
11935 (call-interactively 'org-check-before-date))
11936 ((equal ans ?a)
11937 (call-interactively 'org-check-after-date))
11938 ((equal ans ?t)
11939 (org-show-todo-tree nil))
11940 ((equal ans ?T)
11941 (org-show-todo-tree '(4)))
11942 ((member ans '(?T ?m))
11943 (call-interactively 'org-match-sparse-tree))
11944 ((member ans '(?p ?P))
11945 (setq kwd (org-icompleting-read "Property: "
11946 (mapcar 'list (org-buffer-property-keys))))
11947 (setq value (org-icompleting-read "Value: "
11948 (mapcar 'list (org-property-values kwd))))
11951 (org-match-sparse-tree arg (concat kwd "=" value)))
11952 ((member ans '(?r ?R ?/))
11953 (call-interactively 'org-occur))
11956 (defvar org-occur-highlights nil
11957 "List of overlays used for occur matches.")
11958 (make-variable-buffer-local 'org-occur-highlights)
11959 (defvar org-occur-parameters nil
11960 "Parameters of the active org-occur calls.
11961 This is a list, each call to org-occur pushes as cons cell,
11962 containing the regular expression and the callback, onto the list.
11963 The list can contain several entries if `org-occur' has been called
11964 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11965 will only contain one set of parameters. When the highlights are
11966 removed (for example with `C-c C-c', or with the next edit (depending
11967 on `org-remove-highlights-with-change'), this variable is emptied
11968 as well.")
11969 (make-variable-buffer-local 'org-occur-parameters)
11971 (defun org-occur (regexp &optional keep-previous callback)
11972 "Make a compact tree which shows all matches of REGEXP.
11973 The tree will show the lines where the regexp matches, and all higher
11974 headlines above the match. It will also show the heading after the match,
11975 to make sure editing the matching entry is easy.
11976 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11977 call to `org-occur' will be kept, to allow stacking of calls to this
11978 command.
11979 If CALLBACK is non-nil, it is a function which is called to confirm
11980 that the match should indeed be shown."
11982 (when (equal regexp "")
11983 (error "Regexp cannot be empty"))
11984 (unless keep-previous
11985 (org-remove-occur-highlights nil nil t))
11986 (push (cons regexp callback) org-occur-parameters)
11987 (let ((cnt 0))
11988 (save-excursion
11989 (goto-char (point-min))
11990 (if (or (not keep-previous) ; do not want to keep
11991 (not org-occur-highlights)) ; no previous matches
11992 ;; hide everything
11993 (org-overview))
11994 (while (re-search-forward regexp nil t)
11995 (when (or (not callback)
11996 (save-match-data (funcall callback)))
11997 (setq cnt (1+ cnt))
11998 (when org-highlight-sparse-tree-matches
11999 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12000 (org-show-context 'occur-tree))))
12001 (when org-remove-highlights-with-change
12002 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12003 nil 'local))
12004 (unless org-sparse-tree-open-archived-trees
12005 (org-hide-archived-subtrees (point-min) (point-max)))
12006 (run-hooks 'org-occur-hook)
12007 (if (interactive-p)
12008 (message "%d match(es) for regexp %s" cnt regexp))
12009 cnt))
12011 (defun org-occur-next-match (&optional n reset)
12012 "Function for `next-error-function' to find sparse tree matches.
12013 N is the number of matches to move, when negative move backwards.
12014 RESET is entirely ignored - this function always goes back to the
12015 starting point when no match is found."
12016 (let* ((limit (if (< n 0) (point-min) (point-max)))
12017 (search-func (if (< n 0)
12018 'previous-single-char-property-change
12019 'next-single-char-property-change))
12020 (n (abs n))
12021 (pos (point))
12022 p1)
12023 (catch 'exit
12024 (while (setq p1 (funcall search-func (point) 'org-type))
12025 (when (equal p1 limit)
12026 (goto-char pos)
12027 (error "No more matches"))
12028 (when (equal (get-char-property p1 'org-type) 'org-occur)
12029 (setq n (1- n))
12030 (when (= n 0)
12031 (goto-char p1)
12032 (throw 'exit (point))))
12033 (goto-char p1))
12034 (goto-char p1)
12035 (error "No more matches"))))
12037 (defun org-show-context (&optional key)
12038 "Make sure point and context are visible.
12039 How much context is shown depends upon the variables
12040 `org-show-hierarchy-above', `org-show-following-heading'. and
12041 `org-show-siblings'."
12042 (let ((heading-p (org-on-heading-p t))
12043 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12044 (following-p (org-get-alist-option org-show-following-heading key))
12045 (entry-p (org-get-alist-option org-show-entry-below key))
12046 (siblings-p (org-get-alist-option org-show-siblings key)))
12047 (catch 'exit
12048 ;; Show heading or entry text
12049 (if (and heading-p (not entry-p))
12050 (org-flag-heading nil) ; only show the heading
12051 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12052 (org-show-hidden-entry))) ; show entire entry
12053 (when following-p
12054 ;; Show next sibling, or heading below text
12055 (save-excursion
12056 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12057 (org-flag-heading nil))))
12058 (when siblings-p (org-show-siblings))
12059 (when hierarchy-p
12060 ;; show all higher headings, possibly with siblings
12061 (save-excursion
12062 (while (and (condition-case nil
12063 (progn (org-up-heading-all 1) t)
12064 (error nil))
12065 (not (bobp)))
12066 (org-flag-heading nil)
12067 (when siblings-p (org-show-siblings))))))))
12069 (defvar org-reveal-start-hook nil
12070 "Hook run before revealing a location.")
12072 (defun org-reveal (&optional siblings)
12073 "Show current entry, hierarchy above it, and the following headline.
12074 This can be used to show a consistent set of context around locations
12075 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12076 not t for the search context.
12078 With optional argument SIBLINGS, on each level of the hierarchy all
12079 siblings are shown. This repairs the tree structure to what it would
12080 look like when opened with hierarchical calls to `org-cycle'.
12082 go to the parent and show the
12083 entire tree."
12084 (interactive "P")
12085 (run-hooks 'org-reveal-start-hook)
12086 (let ((org-show-hierarchy-above t)
12087 (org-show-following-heading t)
12088 (org-show-siblings (if siblings t org-show-siblings)))
12089 (org-show-context nil))
12090 (when (equal siblings '(16))
12091 (save-excursion
12092 (when (org-up-heading-safe)
12093 (org-show-subtree)
12094 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12096 (defun org-highlight-new-match (beg end)
12097 "Highlight from BEG to END and mark the highlight is an occur headline."
12098 (let ((ov (make-overlay beg end)))
12099 (overlay-put ov 'face 'secondary-selection)
12100 (overlay-put ov 'org-type 'org-occur)
12101 (push ov org-occur-highlights)))
12103 (defun org-remove-occur-highlights (&optional beg end noremove)
12104 "Remove the occur highlights from the buffer.
12105 BEG and END are ignored. If NOREMOVE is nil, remove this function
12106 from the `before-change-functions' in the current buffer."
12107 (interactive)
12108 (unless org-inhibit-highlight-removal
12109 (mapc 'delete-overlay org-occur-highlights)
12110 (setq org-occur-highlights nil)
12111 (setq org-occur-parameters nil)
12112 (unless noremove
12113 (remove-hook 'before-change-functions
12114 'org-remove-occur-highlights 'local))))
12116 ;;;; Priorities
12119 "Regular expression matching the priority indicator.")
12121 (defvar org-remove-priority-next-time nil)
12123 (defun org-priority-up ()
12124 "Increase the priority of the current item."
12125 (interactive)
12126 (org-priority 'up))
12128 (defun org-priority-down ()
12129 "Decrease the priority of the current item."
12130 (interactive)
12131 (org-priority 'down))
12133 (defun org-priority (&optional action)
12134 "Change the priority of an item by ARG.
12135 ACTION can be `set', `up', `down', or a character."
12136 (interactive)
12137 (unless org-enable-priority-commands
12138 (error "Priority commands are disabled"))
12139 (setq action (or action 'set))
12140 (let (current new news have remove)
12141 (save-excursion
12142 (org-back-to-heading t)
12143 (if (looking-at org-priority-regexp)
12144 (setq current (string-to-char (match-string 2))
12145 have t)
12146 (setq current org-default-priority))
12147 (cond
12148 ((eq action 'remove)
12149 (setq remove t new ?\ ))
12150 ((or (eq action 'set)
12151 (if (featurep 'xemacs) (characterp action) (integerp action)))
12152 (if (not (eq action 'set))
12153 (setq new action)
12154 (message "Priority %c-%c, SPC to remove: "
12155 org-highest-priority org-lowest-priority)
12156 (save-match-data
12157 (setq new (read-char-exclusive))))
12158 (if (and (= (upcase org-highest-priority) org-highest-priority)
12159 (= (upcase org-lowest-priority) org-lowest-priority))
12160 (setq new (upcase new)))
12161 (cond ((equal new ?\ ) (setq remove t))
12162 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12163 (error "Priority must be between `%c' and `%c'"
12164 org-highest-priority org-lowest-priority))))
12165 ((eq action 'up)
12166 (if (and (not have) (eq last-command this-command))
12167 (setq new org-lowest-priority)
12168 (setq new (if (and org-priority-start-cycle-with-default (not have))
12169 org-default-priority (1- current)))))
12170 ((eq action 'down)
12171 (if (and (not have) (eq last-command this-command))
12172 (setq new org-highest-priority)
12173 (setq new (if (and org-priority-start-cycle-with-default (not have))
12174 org-default-priority (1+ current)))))
12175 (t (error "Invalid action")))
12176 (if (or (< (upcase new) org-highest-priority)
12177 (> (upcase new) org-lowest-priority))
12178 (setq remove t))
12179 (setq news (format "%c" new))
12180 (if have
12181 (if remove
12182 (replace-match "" t t nil 1)
12183 (replace-match news t t nil 2))
12184 (if remove
12185 (error "No priority cookie found in line")
12186 (let ((case-fold-search nil))
12187 (looking-at org-todo-line-regexp))
12188 (if (match-end 2)
12189 (progn
12190 (goto-char (match-end 2))
12191 (insert " [#" news "]"))
12192 (goto-char (match-beginning 3))
12193 (insert "[#" news "] "))))
12194 (org-preserve-lc (org-set-tags nil 'align)))
12195 (if remove
12196 (message "Priority removed")
12197 (message "Priority of current item set to %s" news))))
12199 (defun org-get-priority (s)
12200 "Find priority cookie and return priority."
12201 (if (functionp org-get-priority-function)
12202 (funcall org-get-priority-function)
12203 (save-match-data
12204 (if (not (string-match org-priority-regexp s))
12205 (* 1000 (- org-lowest-priority org-default-priority))
12206 (* 1000 (- org-lowest-priority
12207 (string-to-char (match-string 2 s))))))))
12209 ;;;; Tags
12211 (defvar org-agenda-archives-mode)
12212 (defvar org-map-continue-from nil
12213 "Position from where mapping should continue.
12214 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12216 (defvar org-scanner-tags nil
12217 "The current tag list while the tags scanner is running.")
12218 (defvar org-trust-scanner-tags nil
12219 "Should `org-get-tags-at' use the tags fro the scanner.
12220 This is for internal dynamical scoping only.
12221 When this is non-nil, the function `org-get-tags-at' will return the value
12222 of `org-scanner-tags' instead of building the list by itself. This
12223 can lead to large speed-ups when the tags scanner is used in a file with
12224 many entries, and when the list of tags is retrieved, for example to
12225 obtain a list of properties. Building the tags list for each entry in such
12226 a file becomes an N^2 operation - but with this variable set, it scales
12227 as N.")
12229 (defun org-scan-tags (action matcher &optional todo-only)
12230 "Scan headline tags with inheritance and produce output ACTION.
12232 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12233 or `agenda' to produce an entry list for an agenda view. It can also be
12234 a Lisp form or a function that should be called at each matched headline, in
12235 this case the return value is a list of all return values from these calls.
12237 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12238 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12239 only lines with a TODO keyword are included in the output."
12240 (require 'org-agenda)
12243 (org-re
12245 (props (list 'face 'default
12246 'done-face 'org-agenda-done
12247 'undone-face 'default
12248 'mouse-face 'highlight
12249 'org-not-done-regexp org-not-done-regexp
12250 'org-todo-regexp org-todo-regexp
12251 'help-echo
12252 (format "mouse-2 or RET jump to org file %s"
12253 (abbreviate-file-name
12254 (or (buffer-file-name (buffer-base-buffer))
12255 (buffer-name (buffer-base-buffer)))))))
12256 (case-fold-search nil)
12257 (org-map-continue-from nil)
12258 lspos tags tags-list
12259 (tags-alist (list (cons 0 org-file-tags)))
12260 (llast 0) rtn rtn1 level category i txt
12261 todo marker entry priority)
12262 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12263 (setq action (list 'lambda nil action)))
12264 (save-excursion
12265 (goto-char (point-min))
12266 (when (eq action 'sparse-tree)
12267 (org-overview)
12268 (org-remove-occur-highlights))
12269 (while (re-search-forward re nil t)
12270 (catch :skip
12271 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12272 tags (if (match-end 4) (org-match-string-no-properties 4)))
12273 (goto-char (setq lspos (match-beginning 0)))
12274 (setq level (org-reduced-level (funcall outline-level))
12275 category (org-get-category))
12276 (setq i llast llast level)
12277 ;; remove tag lists from same and sublevels
12278 (while (>= i level)
12279 (when (setq entry (assoc i tags-alist))
12280 (setq tags-alist (delete entry tags-alist)))
12281 (setq i (1- i)))
12282 ;; add the next tags
12283 (when tags
12284 (setq tags (org-split-string tags ":")
12285 tags-alist
12286 (cons (cons level tags) tags-alist)))
12287 ;; compile tags for current headline
12288 (setq tags-list
12289 (if org-use-tag-inheritance
12290 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12291 tags)
12292 org-scanner-tags tags-list)
12293 (when org-use-tag-inheritance
12294 (setcdr (car tags-alist)
12295 (mapcar (lambda (x)
12296 (setq x (copy-sequence x))
12297 (org-add-prop-inherited x))
12298 (cdar tags-alist))))
12299 (when (and tags org-use-tag-inheritance
12300 (or (not (eq t org-use-tag-inheritance))
12301 org-tags-exclude-from-inheritance))
12302 ;; selective inheritance, remove uninherited ones
12303 (setcdr (car tags-alist)
12304 (org-remove-uniherited-tags (cdar tags-alist))))
12305 (when (and (or (not todo-only)
12306 (and (member todo org-not-done-keywords)
12307 (or (not org-agenda-tags-todo-honor-ignore-options)
12308 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12309 (let ((case-fold-search t)) (eval matcher))
12310 (or
12311 (not (member org-archive-tag tags-list))
12312 ;; we have an archive tag, should we use this anyway?
12313 (or (not org-agenda-skip-archived-trees)
12314 (and (eq action 'agenda) org-agenda-archives-mode))))
12315 (unless (eq action 'sparse-tree) (org-agenda-skip))
12317 ;; select this headline
12319 (cond
12320 ((eq action 'sparse-tree)
12321 (and org-highlight-sparse-tree-matches
12322 (org-get-heading) (match-end 0)
12323 (org-highlight-new-match
12324 (match-beginning 0) (match-beginning 1)))
12325 (org-show-context 'tags-tree))
12326 ((eq action 'agenda)
12327 (setq txt (org-format-agenda-item
12328 ""
12329 (concat
12330 (if (eq org-tags-match-list-sublevels 'indented)
12331 (make-string (1- level) ?.) "")
12332 (org-get-heading))
12333 category
12334 tags-list
12335 )
12336 priority (org-get-priority txt))
12337 (goto-char lspos)
12338 (setq marker (org-agenda-new-marker))
12339 (org-add-props txt props
12340 'org-marker marker 'org-hd-marker marker 'org-category category
12341 'todo-state todo
12342 'priority priority 'type "tagsmatch")
12343 (push txt rtn))
12344 ((functionp action)
12345 (setq org-map-continue-from nil)
12346 (save-excursion
12347 (setq rtn1 (funcall action))
12348 (push rtn1 rtn)))
12349 (t (error "Invalid action")))
12351 ;; if we are to skip sublevels, jump to end of subtree
12352 (unless org-tags-match-list-sublevels
12353 (org-end-of-subtree t)
12354 (backward-char 1))))
12355 ;; Get the correct position from where to continue
12356 (if org-map-continue-from
12357 (goto-char org-map-continue-from)
12358 (and (= (point) lspos) (end-of-line 1)))))
12359 (when (and (eq action 'sparse-tree)
12360 (not org-sparse-tree-open-archived-trees))
12361 (org-hide-archived-subtrees (point-min) (point-max)))
12362 (nreverse rtn)))
12364 (defun org-remove-uniherited-tags (tags)
12365 "Remove all tags that are not inherited from the list TAGS."
12366 (cond
12367 ((eq org-use-tag-inheritance t)
12368 (if org-tags-exclude-from-inheritance
12369 (org-delete-all org-tags-exclude-from-inheritance tags)
12370 tags))
12371 ((not org-use-tag-inheritance) nil)
12372 ((stringp org-use-tag-inheritance)
12373 (delq nil (mapcar
12374 (lambda (x)
12375 (if (and (string-match org-use-tag-inheritance x)
12376 (not (member x org-tags-exclude-from-inheritance)))
12377 x nil))
12378 tags)))
12379 ((listp org-use-tag-inheritance)
12380 (delq nil (mapcar
12381 (lambda (x)
12382 (if (member x org-use-tag-inheritance) x nil))
12383 tags)))))
12385 (defvar todo-only) ;; dynamically scoped
12387 (defun org-match-sparse-tree (&optional todo-only match)
12388 "Create a sparse tree according to tags string MATCH.
12389 MATCH can contain positive and negative selection of tags, like
12391 If optional argument TODO-ONLY is non-nil, only select lines that are
12392 also TODO lines."
12393 (interactive "P")
12394 (org-prepare-agenda-buffers (list (current-buffer)))
12395 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12397 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12399 (defvar org-cached-props nil)
12400 (defun org-cached-entry-get (pom property)
12401 (if (or (eq t org-use-property-inheritance)
12402 (and (stringp org-use-property-inheritance)
12403 (string-match org-use-property-inheritance property))
12404 (and (listp org-use-property-inheritance)
12405 (member property org-use-property-inheritance)))
12406 ;; Caching is not possible, check it directly
12407 (org-entry-get pom property 'inherit)
12408 ;; Get all properties, so that we can do complicated checks easily
12409 (cdr (assoc property (or org-cached-props
12410 (setq org-cached-props
12411 (org-entry-properties pom)))))))
12413 (defun org-global-tags-completion-table (&optional files)
12414 "Return the list of all tags in all agenda buffer/files.
12415 Optional FILES argument is a list of files to which can be used
12416 instead of the agenda files."
12417 (save-excursion
12418 (org-uniquify
12419 (delq nil
12420 (apply 'append
12421 (mapcar
12422 (lambda (file)
12423 (set-buffer (find-file-noselect file))
12424 (append (org-get-buffer-tags)
12425 (mapcar (lambda (x) (if (stringp (car-safe x))
12426 (list (car-safe x)) nil))
12427 org-tag-alist)))
12428 (if (and files (car files))
12429 files
12430 (org-agenda-files))))))))
12432 (defun org-make-tags-matcher (match)
12433 "Create the TAGS//TODO matcher form for the selection string MATCH."
12434 ;; todo-only is scoped dynamically into this function, and the function
12435 ;; may change it if the matcher asks for it.
12436 (unless match
12437 ;; Get a new match request, with completion
12438 (let ((org-last-tags-completion-table
12439 (org-global-tags-completion-table)))
12440 (setq match (org-completing-read-no-i
12441 "Match: " 'org-tags-completion-function nil nil nil
12442 'org-tags-history))))
12444 ;; Parse the string and create a lisp form
12445 (let ((match0 match)
12446 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12447 minus tag mm
12448 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12449 orterms term orlist re-p str-p level-p level-op time-p
12450 prop-p pn pv po gv rest)
12451 (if (string-match "/+" match)
12452 ;; match contains also a todo-matching request
12453 (progn
12454 (setq tagsmatch (substring match 0 (match-beginning 0))
12455 todomatch (substring match (match-end 0)))
12456 (if (string-match "^!" todomatch)
12457 (setq todo-only t todomatch (substring todomatch 1)))
12459 (setq todomatch nil)))
12460 ;; only matching tags
12461 (setq tagsmatch match todomatch nil))
12463 ;; Make the tags matcher
12465 (setq tagsmatcher t)
12466 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12467 (while (setq term (pop orterms))
12469 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12470 (while (string-match re term)
12471 (setq rest (substring term (match-end 0))
12472 minus (and (match-end 1)
12473 (equal (match-string 1 term) "-"))
12474 tag (save-match-data (replace-regexp-in-string
12476 (match-string 2 term)))
12477 re-p (equal (string-to-char tag) ?{)
12478 level-p (match-end 4)
12479 prop-p (match-end 5)
12480 mm (cond
12481 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12482 (level-p
12483 (setq level-op (org-op-to-function (match-string 3 term)))
12484 `(,level-op level ,(string-to-number
12485 (match-string 4 term))))
12486 (prop-p
12487 (setq pn (match-string 5 term)
12488 po (match-string 6 term)
12489 pv (match-string 7 term)
12490 re-p (equal (string-to-char pv) ?{)
12492 time-p (save-match-data
12494 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12495 (if time-p (setq pv (org-matcher-time pv)))
12496 (setq po (org-op-to-function po (if time-p 'time str-p)))
12497 (cond
12498 ((equal pn "CATEGORY")
12499 (setq gv '(get-text-property (point) 'org-category)))
12500 ((equal pn "TODO")
12501 (setq gv 'todo))
12502 (t
12503 (setq gv `(org-cached-entry-get nil ,pn))))
12504 (if re-p
12505 (if (eq po 'org<>)
12506 `(not (string-match ,pv (or ,gv "")))
12507 `(string-match ,pv (or ,gv "")))
12508 (if str-p
12509 `(,po (or ,gv "") ,pv)
12510 `(,po (string-to-number (or ,gv ""))
12511 ,(string-to-number pv) ))))
12512 (t `(member ,tag tags-list)))
12513 mm (if minus (list 'not mm) mm)
12514 term rest)
12515 (push mm tagsmatcher))
12516 (push (if (> (length tagsmatcher) 1)
12517 (cons 'and tagsmatcher)
12518 (car tagsmatcher))
12519 orlist)
12520 (setq tagsmatcher nil))
12521 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12522 (setq tagsmatcher
12523 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12524 ;; Make the todo matcher
12526 (setq todomatcher t)
12527 (setq orterms (org-split-string todomatch "|") orlist nil)
12528 (while (setq term (pop orterms))
12529 (while (string-match re term)
12530 (setq minus (and (match-end 1)
12531 (equal (match-string 1 term) "-"))
12532 kwd (match-string 2 term)
12533 re-p (equal (string-to-char kwd) ?{)
12534 term (substring term (match-end 0))
12535 mm (if re-p
12536 `(string-match ,(substring kwd 1 -1) todo)
12537 (list 'equal 'todo kwd))
12538 mm (if minus (list 'not mm) mm))
12539 (push mm todomatcher))
12540 (push (if (> (length todomatcher) 1)
12541 (cons 'and todomatcher)
12542 (car todomatcher))
12543 orlist)
12544 (setq todomatcher nil))
12545 (setq todomatcher (if (> (length orlist) 1)
12546 (cons 'or orlist) (car orlist))))
12548 ;; Return the string and lisp forms of the matcher
12549 (setq matcher (if todomatcher
12550 (list 'and tagsmatcher todomatcher)
12551 tagsmatcher))
12552 (cons match0 matcher)))
12554 (defun org-op-to-function (op &optional stringp)
12555 "Turn an operator into the appropriate function."
12556 (setq op
12557 (cond
12558 ((equal op "<" ) '(< string< org-time<))
12559 ((equal op ">" ) '(> org-string> org-time>))
12560 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12561 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12562 ((member op '("=" "==")) '(= string= org-time=))
12563 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12564 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12566 (defun org<> (a b) (not (= a b)))
12567 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12568 (defun org-string>= (a b) (not (string< a b)))
12569 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12570 (defun org-string<> (a b) (not (string= a b)))
12571 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12572 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12573 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12574 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12575 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12576 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12577 (defun org-2ft (s)
12578 "Convert S to a floating point time.
12579 If S is already a number, just return it. If it is a string, parse
12580 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12581 (cond
12582 ((numberp s) s)
12583 ((stringp s)
12584 (condition-case nil
12585 (float-time (apply 'encode-time (org-parse-time-string s)))
12586 (error 0.)))
12587 (t 0.)))
12589 (defun org-time-today ()
12590 "Time in seconds today at 0:00.
12591 Returns the float number of seconds since the beginning of the
12592 epoch to the beginning of today (00:00)."
12593 (float-time (apply 'encode-time
12594 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12596 (defun org-matcher-time (s)
12597 "Interpret a time comparison value."
12598 (save-match-data
12599 (cond
12600 ((string= s "<now>") (float-time))
12601 ((string= s "<today>") (org-time-today))
12602 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12603 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12605 (+ (org-time-today)
12606 (* (string-to-number (match-string 1 s))
12607 (cdr (assoc (match-string 2 s)
12608 '(("d" . 86400.0) ("w" . 604800.0)
12609 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12610 (t (org-2ft s)))))
12612 (defun org-match-any-p (re list)
12613 "Does re match any element of list?"
12614 (setq list (mapcar (lambda (x) (string-match re x)) list))
12615 (delq nil list))
12617 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12618 (defvar org-tags-overlay (make-overlay 1 1))
12619 (org-detach-overlay org-tags-overlay)
12621 (defun org-get-local-tags-at (&optional pos)
12622 "Get a list of tags defined in the current headline."
12623 (org-get-tags-at pos 'local))
12625 (defun org-get-local-tags ()
12626 "Get a list of tags defined in the current headline."
12627 (org-get-tags-at nil 'local))
12629 (defun org-get-tags-at (&optional pos local)
12630 "Get a list of all headline tags applicable at POS.
12631 POS defaults to point. If tags are inherited, the list contains
12632 the targets in the same sequence as the headlines appear, i.e.
12633 the tags of the current headline come last.
12634 When LOCAL is non-nil, only return tags from the current headline,
12635 ignore inherited ones."
12636 (interactive)
12637 (if (and org-trust-scanner-tags
12638 (or (not pos) (equal pos (point)))
12639 (not local))
12640 org-scanner-tags
12641 (let (tags ltags lastpos parent)
12642 (save-excursion
12643 (save-restriction
12644 (widen)
12645 (goto-char (or pos (point)))
12646 (save-match-data
12647 (catch 'done
12648 (condition-case nil
12649 (progn
12650 (org-back-to-heading t)
12651 (while (not (equal lastpos (point)))
12652 (setq lastpos (point))
12653 (when (looking-at
12655 (setq ltags (org-split-string
12656 (org-match-string-no-properties 1) ":"))
12657 (when parent
12658 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12659 (setq tags (append
12660 (if parent
12661 (org-remove-uniherited-tags ltags)
12662 ltags)
12663 tags)))
12664 (or org-use-tag-inheritance (throw 'done t))
12665 (if local (throw 'done t))
12666 (or (org-up-heading-safe) (error nil))
12667 (setq parent t)))
12668 (error nil)))))
12669 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12671 (defun org-add-prop-inherited (s)
12672 (add-text-properties 0 (length s) '(inherited t) s)
12673 s)
12675 (defun org-toggle-tag (tag &optional onoff)
12676 "Toggle the tag TAG for the current line.
12677 If ONOFF is `on' or `off', don't toggle but set to this state."
12678 (let (res current)
12679 (save-excursion
12680 (org-back-to-heading t)
12682 (point-at-eol) t)
12683 (progn
12684 (setq current (match-string 1))
12685 (replace-match ""))
12686 (setq current ""))
12687 (setq current (nreverse (org-split-string current ":")))
12688 (cond
12689 ((eq onoff 'on)
12690 (setq res t)
12691 (or (member tag current) (push tag current)))
12692 ((eq onoff 'off)
12693 (or (not (member tag current)) (setq current (delete tag current))))
12694 (t (if (member tag current)
12695 (setq current (delete tag current))
12696 (setq res t)
12697 (push tag current))))
12698 (end-of-line 1)
12699 (if current
12700 (progn
12701 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12702 (org-set-tags nil t))
12703 (delete-horizontal-space))
12704 (run-hooks 'org-after-tags-change-hook))
12705 res))
12707 (defun org-align-tags-here (to-col)
12708 ;; Assumes that this is a headline
12709 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12710 (beginning-of-line 1)
12712 (< pos (match-beginning 2)))
12713 (progn
12714 (setq tags-l (- (match-end 2) (match-beginning 2)))
12715 (goto-char (match-beginning 1))
12716 (insert " ")
12717 (delete-region (point) (1+ (match-beginning 2)))
12718 (setq ncol (max (1+ (current-column))
12719 (1+ col)
12720 (if (> to-col 0)
12721 to-col
12722 (- (abs to-col) tags-l))))
12723 (setq p (point))
12724 (insert (make-string (- ncol (current-column)) ?\ ))
12725 (setq ncol (current-column))
12726 (when indent-tabs-mode (tabify p (point-at-eol)))
12727 (org-move-to-column (min ncol col) t))
12728 (goto-char pos))))
12730 (defun org-set-tags-command (&optional arg just-align)
12731 "Call the set-tags command for the current entry."
12732 (interactive "P")
12733 (if (org-on-heading-p)
12734 (org-set-tags arg just-align)
12735 (save-excursion
12736 (org-back-to-heading t)
12737 (org-set-tags arg just-align))))
12739 (defun org-set-tags-to (data)
12740 "Set the tags of the current entry to DATA, replacing the current tags.
12741 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12742 If DATA is nil or the empty string, any tags will be removed."
12743 (interactive "sTags: ")
12744 (setq data
12745 (cond
12746 ((eq data nil) "")
12747 ((equal data "") "")
12748 ((stringp data)
12749 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12750 ":"))
12751 ((listp data)
12752 (concat ":" (mapconcat 'identity data ":") ":"))
12753 (t nil)))
12754 (when data
12755 (save-excursion
12756 (org-back-to-heading t)
12757 (when (looking-at org-complex-heading-regexp)
12758 (if (match-end 5)
12759 (progn
12760 (goto-char (match-beginning 5))
12761 (insert data)
12762 (delete-region (point) (point-at-eol))
12763 (org-set-tags nil 'align))
12764 (goto-char (point-at-eol))
12765 (insert " " data)
12766 (org-set-tags nil 'align)))
12767 (beginning-of-line 1)
12769 (delete-region (match-beginning 1) (match-end 1))))))
12771 (defun org-align-all-tags ()
12772 "Align the tags i all headings."
12773 (interactive)
12774 (save-excursion
12775 (or (ignore-errors (org-back-to-heading t))
12776 (outline-next-heading))
12777 (if (org-on-heading-p)
12778 (org-set-tags t)
12779 (message "No headings"))))
12781 (defvar org-indent-indentation-per-level)
12782 (defun org-set-tags (&optional arg just-align)
12783 "Set the tags for the current headline.
12784 With prefix ARG, realign all tags in headings in the current buffer."
12785 (interactive "P")
12786 (let* ((re (concat "^" outline-regexp))
12787 (current (org-get-tags-string))
12788 (col (current-column))
12789 (org-setting-tags t)
12790 table current-tags inherited-tags ; computed below when needed
12791 tags p0 c0 c1 rpl di tc level)
12792 (if arg
12793 (save-excursion
12794 (goto-char (point-min))
12795 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12796 (while (re-search-forward re nil t)
12797 (org-set-tags nil t)
12798 (end-of-line 1)))
12799 (message "All tags realigned to column %d" org-tags-column))
12800 (if just-align
12801 (setq tags current)
12802 ;; Get a new set of tags from the user
12803 (save-excursion
12804 (setq table (append org-tag-persistent-alist
12805 (or org-tag-alist (org-get-buffer-tags))
12806 (and
12807 org-complete-tags-always-offer-all-agenda-tags
12808 (org-global-tags-completion-table
12809 (org-agenda-files))))
12810 org-last-tags-completion-table table
12811 current-tags (org-split-string current ":")
12812 inherited-tags (nreverse
12813 (nthcdr (length current-tags)
12814 (nreverse (org-get-tags-at))))
12815 tags
12816 (if (or (eq t org-use-fast-tag-selection)
12817 (and org-use-fast-tag-selection
12818 (delq nil (mapcar 'cdr table))))
12819 (org-fast-tag-selection
12820 current-tags inherited-tags table
12821 (if org-fast-tag-selection-include-todo
12822 org-todo-key-alist))
12823 (let ((org-add-colon-after-tag-completion t))
12824 (org-trim
12825 (org-without-partial-completion
12826 (org-icompleting-read "Tags: "
12827 'org-tags-completion-function
12828 nil nil current 'org-tags-history)))))))
12829 (while (string-match "[-+&]+" tags)
12830 ;; No boolean logic, just a list
12831 (setq tags (replace-match ":" t t tags))))
12833 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12835 (if org-tags-sort-function
12836 (setq tags (mapconcat 'identity
12837 (sort (org-split-string
12838 tags (org-re "[^[:alnum:]_@#%]+"))
12839 org-tags-sort-function) ":")))
12842 (setq tags "")
12843 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12844 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12846 ;; Insert new tags at the correct column
12847 (beginning-of-line 1)
12848 (setq level (or (and (looking-at org-outline-regexp)
12849 (- (match-end 0) (point) 1))
12850 1))
12851 (cond
12852 ((and (equal current "") (equal tags "")))
12853 ((re-search-forward
12855 (point-at-eol) t)
12856 (if (equal tags "")
12857 (setq rpl "")
12858 (goto-char (match-beginning 0))
12859 (setq c0 (current-column)
12860 ;; compute offset for the case of org-indent-mode active
12861 di (if org-indent-mode
12862 (* (1- org-indent-indentation-per-level) (1- level))
12863 0)
12864 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12865 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12866 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12867 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12868 (replace-match rpl t t)
12869 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12870 tags)
12871 (t (error "Tags alignment failed")))
12872 (org-move-to-column col)
12873 (unless just-align
12874 (run-hooks 'org-after-tags-change-hook)))))
12876 (defun org-change-tag-in-region (beg end tag off)
12877 "Add or remove TAG for each entry in the region.
12878 This works in the agenda, and also in an org-mode buffer."
12879 (interactive
12880 (list (region-beginning) (region-end)
12881 (let ((org-last-tags-completion-table
12882 (if (org-mode-p)
12883 (org-get-buffer-tags)
12884 (org-global-tags-completion-table))))
12885 (org-icompleting-read
12886 "Tag: " 'org-tags-completion-function nil nil nil
12887 'org-tags-history))
12888 (progn
12890 (equal (read-char-exclusive) ?r))))
12891 (if (fboundp 'deactivate-mark) (deactivate-mark))
12892 (let ((agendap (equal major-mode 'org-agenda-mode))
12893 l1 l2 m buf pos newhead (cnt 0))
12894 (goto-char end)
12895 (setq l2 (1- (org-current-line)))
12896 (goto-char beg)
12897 (setq l1 (org-current-line))
12898 (loop for l from l1 to l2 do
12899 (org-goto-line l)
12900 (setq m (get-text-property (point) 'org-hd-marker))
12901 (when (or (and (org-mode-p) (org-on-heading-p))
12902 (and agendap m))
12903 (setq buf (if agendap (marker-buffer m) (current-buffer))
12904 pos (if agendap m (point)))
12905 (with-current-buffer buf
12906 (save-excursion
12907 (save-restriction
12908 (goto-char pos)
12909 (setq cnt (1+ cnt))
12910 (org-toggle-tag tag (if off 'off 'on))
12911 (setq newhead (org-get-heading)))))
12912 (and agendap (org-agenda-change-all-lines newhead m))))
12913 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12915 (defun org-tags-completion-function (string predicate &optional flag)
12916 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12917 (confirm (lambda (x) (stringp (car x)))))
12919 (setq s1 (match-string 1 string)
12920 s2 (match-string 2 string))
12921 (setq s1 "" s2 string))
12922 (cond
12923 ((eq flag nil)
12924 ;; try completion
12925 (setq rtn (try-completion s2 ctable confirm))
12926 (if (stringp rtn)
12927 (setq rtn
12928 (concat s1 s2 (substring rtn (length s2))
12929 (if (and org-add-colon-after-tag-completion
12930 (assoc rtn ctable))
12931 ":" ""))))
12932 rtn)
12933 ((eq flag t)
12934 ;; all-completions
12935 (all-completions s2 ctable confirm)
12936 )
12937 ((eq flag 'lambda)
12938 ;; exact match?
12939 (assoc s2 ctable)))
12940 ))
12942 (defun org-fast-tag-insert (kwd tags face &optional end)
12943 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12944 (insert (format "%-12s" (concat kwd ":"))
12945 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12946 (or end "")))
12948 (defun org-fast-tag-show-exit (flag)
12949 (save-excursion
12950 (org-goto-line 3)
12952 (replace-match ""))
12953 (when flag
12954 (end-of-line 1)
12955 (org-move-to-column (- (window-width) 19) t)
12956 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12958 (defun org-set-current-tags-overlay (current prefix)
12959 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12960 (if (featurep 'xemacs)
12961 (org-overlay-display org-tags-overlay (concat prefix s)
12962 'secondary-selection)
12963 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12964 (org-overlay-display org-tags-overlay (concat prefix s)))))
12966 (defvar org-last-tag-selection-key nil)
12967 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12968 "Fast tag selection with single keys.
12969 CURRENT is the current list of tags in the headline, INHERITED is the
12970 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12971 possibly with grouping information. TODO-TABLE is a similar table with
12972 TODO keywords, should these have keys assigned to them.
12973 If the keys are nil, a-z are automatically assigned.
12974 Returns the new tags string, or nil to not change the current settings."
12975 (let* ((fulltable (append table todo-table))
12976 (maxlen (apply 'max (mapcar
12977 (lambda (x)
12978 (if (stringp (car x)) (string-width (car x)) 0))
12979 fulltable)))
12980 (buf (current-buffer))
12981 (expert (eq org-fast-tag-selection-single-key 'expert))
12982 (buffer-tags nil)
12983 (fwidth (+ maxlen 3 1 3))
12984 (ncol (/ (- (window-width) 4) fwidth))
12985 (i-face 'org-done)
12986 (c-face 'org-todo)
12987 tg cnt e c char c1 c2 ntable tbl rtn
12988 ov-start ov-end ov-prefix
12989 (exit-after-next org-fast-tag-selection-single-key)
12990 (done-keywords org-done-keywords)
12991 groups ingroup)
12992 (save-excursion
12993 (beginning-of-line 1)
12994 (if (looking-at
12996 (setq ov-start (match-beginning 1)
12997 ov-end (match-end 1)
12998 ov-prefix "")
12999 (setq ov-start (1- (point-at-eol))
13000 ov-end (1+ ov-start))
13002 (setq ov-prefix
13003 (concat
13004 (buffer-substring (1- (point)) (point))
13005 (if (> (current-column) org-tags-column)
13006 " "
13007 (make-string (- org-tags-column (current-column)) ?\ ))))))
13008 (move-overlay org-tags-overlay ov-start ov-end)
13009 (save-window-excursion
13010 (if expert
13011 (set-buffer (get-buffer-create " *Org tags*"))
13012 (delete-other-windows)
13013 (split-window-vertically)
13014 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13015 (erase-buffer)
13016 (org-set-local 'org-done-keywords done-keywords)
13019 (org-fast-tag-show-exit exit-after-next)
13020 (org-set-current-tags-overlay current ov-prefix)
13021 (setq tbl fulltable char ?a cnt 0)
13022 (while (setq e (pop tbl))
13023 (cond
13024 ((equal (car e) :startgroup)
13025 (push '() groups) (setq ingroup t)
13026 (when (not (= cnt 0))
13027 (setq cnt 0)
13029 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13030 ((equal (car e) :endgroup)
13031 (setq ingroup nil cnt 0)
13033 ((equal e '(:newline))
13034 (when (not (= cnt 0))
13035 (setq cnt 0)
13037 (setq e (car tbl))
13038 (while (equal (car tbl) '(:newline))
13040 (setq tbl (cdr tbl)))))
13041 (t
13042 (setq tg (copy-sequence (car e)) c2 nil)
13043 (if (cdr e)
13044 (setq c (cdr e))
13045 ;; automatically assign a character.
13046 (setq c1 (string-to-char
13047 (downcase (substring
13048 tg (if (= (string-to-char tg) ?@) 1 0)))))
13049 (if (or (rassoc c1 ntable) (rassoc c1 table))
13050 (while (or (rassoc char ntable) (rassoc char table))
13051 (setq char (1+ char)))
13052 (setq c2 c1))
13053 (setq c (or c2 char)))
13054 (if ingroup (push tg (car groups)))
13055 (setq tg (org-add-props tg nil 'face
13056 (cond
13057 ((not (assoc tg table))
13058 (org-get-todo-face tg))
13059 ((member tg current) c-face)
13060 ((member tg inherited) i-face)
13061 (t nil))))
13062 (if (and (= cnt 0) (not ingroup)) (insert " "))
13063 (insert "[" c "] " tg (make-string
13064 (- fwidth 4 (length tg)) ?\ ))
13065 (push (cons tg c) ntable)
13066 (when (= (setq cnt (1+ cnt)) ncol)
13068 (if ingroup (insert " "))
13069 (setq cnt 0)))))
13070 (setq ntable (nreverse ntable))
13072 (goto-char (point-min))
13073 (if (not expert) (org-fit-window-to-buffer))
13074 (setq rtn
13075 (catch 'exit
13076 (while t
13077 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13078 (if (not groups) "no " "")
13079 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13080 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13081 (setq org-last-tag-selection-key c)
13082 (cond
13084 ((= c ?!)
13085 (setq groups (not groups))
13086 (goto-char (point-min))
13087 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13088 ((= c ?\C-c)
13089 (if (not expert)
13090 (org-fast-tag-show-exit
13091 (setq exit-after-next (not exit-after-next)))
13092 (setq expert nil)
13093 (delete-other-windows)
13094 (set-window-buffer (split-window-vertically) " *Org tags*")
13095 (org-switch-to-buffer-other-window " *Org tags*")
13096 (org-fit-window-to-buffer)))
13097 ((or (= c ?\C-g)
13098 (and (= c ?q) (not (rassoc c ntable))))
13099 (org-detach-overlay org-tags-overlay)
13100 (setq quit-flag t))
13101 ((= c ?\ )
13102 (setq current nil)
13103 (if exit-after-next (setq exit-after-next 'now)))
13105 (condition-case nil
13106 (setq tg (org-icompleting-read
13107 "Tag: "
13108 (or buffer-tags
13109 (with-current-buffer buf
13110 (org-get-buffer-tags)))))
13111 (quit (setq tg "")))
13113 (add-to-list 'buffer-tags (list tg))
13114 (if (member tg current)
13115 (setq current (delete tg current))
13116 (push tg current)))
13117 (if exit-after-next (setq exit-after-next 'now)))
13118 ((setq e (rassoc c todo-table) tg (car e))
13119 (with-current-buffer buf
13120 (save-excursion (org-todo tg)))
13121 (if exit-after-next (setq exit-after-next 'now)))
13122 ((setq e (rassoc c ntable) tg (car e))
13123 (if (member tg current)
13124 (setq current (delete tg current))
13125 (loop for g in groups do
13126 (if (member tg g)
13127 (mapc (lambda (x)
13128 (setq current (delete x current)))
13129 g)))
13130 (push tg current))
13131 (if exit-after-next (setq exit-after-next 'now))))
13133 ;; Create a sorted list
13134 (setq current
13135 (sort current
13136 (lambda (a b)
13137 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13138 (if (eq exit-after-next 'now) (throw 'exit t))
13139 (goto-char (point-min))
13140 (beginning-of-line 2)
13141 (delete-region (point) (point-at-eol))
13142 (org-fast-tag-insert "Current" current c-face)
13143 (org-set-current-tags-overlay current ov-prefix)
13144 (while (re-search-forward
13146 (setq tg (match-string 1))
13147 (add-text-properties
13148 (match-beginning 1) (match-end 1)
13149 (list 'face
13150 (cond
13151 ((member tg current) c-face)
13152 ((member tg inherited) i-face)
13153 (t (get-text-property (match-beginning 1) 'face))))))
13154 (goto-char (point-min)))))
13155 (org-detach-overlay org-tags-overlay)
13156 (if rtn
13157 (mapconcat 'identity current ":")
13158 nil))))
13160 (defun org-get-tags-string ()
13161 "Get the TAGS string in the current headline."
13162 (unless (org-on-heading-p t)
13163 (error "Not on a heading"))
13164 (save-excursion
13165 (beginning-of-line 1)
13167 (org-match-string-no-properties 1)
13168 "")))
13170 (defun org-get-tags ()
13171 "Get the list of tags specified in the current headline."
13172 (org-split-string (org-get-tags-string) ":"))
13174 (defun org-get-buffer-tags ()
13175 "Get a table of all tags used in the buffer, for completion."
13176 (let (tags)
13177 (save-excursion
13178 (goto-char (point-min))
13179 (while (re-search-forward
13181 (when (equal (char-after (point-at-bol 0)) ?*)
13182 (mapc (lambda (x) (add-to-list 'tags x))
13183 (org-split-string (org-match-string-no-properties 1) ":")))))
13184 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13185 (mapcar 'list tags)))
13187 ;;;; The mapping API
13189 ;;;###autoload
13190 (defun org-map-entries (func &optional match scope &rest skip)
13191 "Call FUNC at each headline selected by MATCH in SCOPE.
13193 FUNC is a function or a lisp form. The function will be called without
13194 arguments, with the cursor positioned at the beginning of the headline.
13195 The return values of all calls to the function will be collected and
13196 returned as a list.
13198 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13199 does not need to preserve point. After evaluation, the cursor will be
13200 moved to the end of the line (presumably of the headline of the
13201 processed entry) and search continues from there. Under some
13202 circumstances, this may not produce the wanted results. For example,
13203 if you have removed (e.g. archived) the current (sub)tree it could
13204 mean that the next entry will be skipped entirely. In such cases, you
13205 can specify the position from where search should continue by making
13206 FUNC set the variable `org-map-continue-from' to the desired buffer
13207 position.
13209 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13210 Only headlines that are matched by this query will be considered during
13211 the iteration. When MATCH is nil or t, all headlines will be
13212 visited by the iteration.
13214 SCOPE determines the scope of this command. It can be any of:
13216 nil The current buffer, respecting the restriction if any
13217 tree The subtree started with the entry at point
13218 file The current buffer, without restriction
13219 file-with-archives
13220 The current buffer, and any archives associated with it
13221 agenda All agenda files
13222 agenda-with-archives
13223 All agenda files with any archive files associated with them
13224 \(file1 file2 ...)
13225 If this is a list, all files in the list will be scanned
13227 The remaining args are treated as settings for the skipping facilities of
13228 the scanner. The following items can be given here:
13230 archive skip trees with the archive tag.
13231 comment skip trees with the COMMENT keyword
13232 function or Emacs Lisp form:
13233 will be used as value for `org-agenda-skip-function', so whenever
13234 the function returns t, FUNC will not be called for that
13235 entry and search will continue from the point where the
13236 function leaves it.
13238 If your function needs to retrieve the tags including inherited tags
13239 at the *current* entry, you can use the value of the variable
13240 `org-scanner-tags' which will be much faster than getting the value
13241 with `org-get-tags-at'. If your function gets properties with
13242 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13243 to t around the call to `org-entry-properties' to get the same speedup.
13244 Note that if your function moves around to retrieve tags and properties at
13245 a *different* entry, you cannot use these techniques."
13246 (let* ((org-agenda-archives-mode nil) ; just to make sure
13247 (org-agenda-skip-archived-trees (memq 'archive skip))
13248 (org-agenda-skip-comment-trees (memq 'comment skip))
13249 (org-agenda-skip-function
13250 (car (org-delete-all '(comment archive) skip)))
13251 (org-tags-match-list-sublevels t)
13252 matcher file res
13253 org-todo-keywords-for-agenda
13254 org-done-keywords-for-agenda
13255 org-todo-keyword-alist-for-agenda
13256 org-drawers-for-agenda
13257 org-tag-alist-for-agenda)
13259 (cond
13260 ((eq match t) (setq matcher t))
13261 ((eq match nil) (setq matcher t))
13262 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13264 (save-excursion
13265 (save-restriction
13266 (when (eq scope 'tree)
13267 (org-back-to-heading t)
13268 (org-narrow-to-subtree)
13269 (setq scope nil))
13271 (if (not scope)
13272 (progn
13273 (org-prepare-agenda-buffers
13274 (list (buffer-file-name (current-buffer))))
13275 (setq res (org-scan-tags func matcher)))
13276 ;; Get the right scope
13277 (cond
13278 ((and scope (listp scope) (symbolp (car scope)))
13279 (setq scope (eval scope)))
13280 ((eq scope 'agenda)
13281 (setq scope (org-agenda-files t)))
13282 ((eq scope 'agenda-with-archives)
13283 (setq scope (org-agenda-files t))
13284 (setq scope (org-add-archive-files scope)))
13285 ((eq scope 'file)
13286 (setq scope (list (buffer-file-name))))
13287 ((eq scope 'file-with-archives)
13288 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13289 (org-prepare-agenda-buffers scope)
13290 (while (setq file (pop scope))
13291 (with-current-buffer (org-find-base-buffer-visiting file)
13292 (save-excursion
13293 (save-restriction
13294 (widen)
13295 (goto-char (point-min))
13296 (setq res (append res (org-scan-tags func matcher))))))))))
13297 res))
13299 ;;;; Properties
13301 ;;; Setting and retrieving properties
13303 (defconst org-special-properties
13304 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13305 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13306 "The special properties valid in Org-mode.
13308 These are properties that are not defined in the property drawer,
13309 but in some other way.")
13311 (defconst org-default-properties
13312 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13313 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13314 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13315 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13316 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13317 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13318 "Some properties that are used by Org-mode for various purposes.
13319 Being in this list makes sure that they are offered for completion.")
13322 "Regular expression matching the first line of a property drawer.")
13325 "Regular expression matching the last line of a property drawer.")
13328 "Regular expression matching the first line of a property drawer.")
13331 "Regular expression matching the first line of a property drawer.")
13333 (defconst org-property-drawer-re
13336 "Matches an entire property drawer.")
13338 (defconst org-clock-drawer-re
13341 "Matches an entire clock drawer.")
13343 (defun org-property-action ()
13344 "Do an action on properties."
13345 (interactive)
13346 (let (c)
13347 (org-at-property-p)
13348 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13349 (setq c (read-char-exclusive))
13350 (cond
13351 ((equal c ?s)
13352 (call-interactively 'org-set-property))
13353 ((equal c ?d)
13354 (call-interactively 'org-delete-property))
13355 ((equal c ?D)
13356 (call-interactively 'org-delete-property-globally))
13357 ((equal c ?c)
13358 (call-interactively 'org-compute-property-at-point))
13359 (t (error "No such property action %c" c)))))
13361 (defun org-set-effort (&optional value)
13362 "Set the effort property of the current entry.
13363 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13364 allowed value."
13365 (interactive "P")
13366 (if (equal value 0) (setq value 10))
13367 (let* ((completion-ignore-case t)
13368 (prop org-effort-property)
13369 (cur (org-entry-get nil prop))
13370 (allowed (org-property-get-allowed-values nil prop 'table))
13371 (existing (mapcar 'list (org-property-values prop)))
13372 rpl
13373 (val (cond
13374 ((stringp value) value)
13375 ((and allowed (integerp value))
13376 (or (car (nth (1- value) allowed))
13377 (car (org-last allowed))))
13378 (allowed
13379 (message "Select 1-9,0, [RET%s]: %s"
13380 (if cur (concat "=" cur) "")
13381 (mapconcat 'car allowed " "))
13382 (setq rpl (read-char-exclusive))
13384 cur
13385 (setq rpl (- rpl ?0))
13386 (if (equal rpl 0) (setq rpl 10))
13387 (if (and (> rpl 0) (<= rpl (length allowed)))
13388 (car (nth (1- rpl) allowed))
13389 (org-completing-read "Effort: " allowed nil))))
13390 (t
13391 (let (org-completion-use-ido org-completion-use-iswitchb)
13392 (org-completing-read
13394 (concat "[" cur "]") "")
13395 ": ")
13396 existing nil nil "" nil cur))))))
13397 (unless (equal (org-entry-get nil prop) val)
13398 (org-entry-put nil prop val))
13399 (message "%s is now %s" prop val)))
13401 (defun org-at-property-p ()
13402 "Is cursor inside a property drawer?"
13403 (save-excursion
13404 (beginning-of-line 1)
13406 (save-match-data ;; Used by calling procedures
13407 (let ((p (point))
13408 (range (unless (org-before-first-heading-p)
13409 (org-get-property-block))))
13410 (and range (<= (car range) p) (< p (cdr range))))))))
13412 (defun org-get-property-block (&optional beg end force)
13413 "Return the (beg . end) range of the body of the property drawer.
13414 BEG and END can be beginning and end of subtree, if not given
13415 they will be found.
13416 If the drawer does not exist and FORCE is non-nil, create the drawer."
13417 (catch 'exit
13418 (save-excursion
13419 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13420 (end (or end (progn (outline-next-heading) (point)))))
13421 (goto-char beg)
13422 (if (re-search-forward org-property-start-re end t)
13423 (setq beg (1+ (match-end 0)))
13424 (if force
13425 (save-excursion
13426 (org-insert-property-drawer)
13427 (setq end (progn (outline-next-heading) (point))))
13428 (throw 'exit nil))
13429 (goto-char beg)
13430 (if (re-search-forward org-property-start-re end t)
13431 (setq beg (1+ (match-end 0)))))
13432 (if (re-search-forward org-property-end-re end t)
13433 (setq end (match-beginning 0))
13434 (or force (throw 'exit nil))
13435 (goto-char beg)
13436 (setq end beg)
13437 (org-indent-line-function)
13439 (cons beg end)))))
13441 (defun org-entry-properties (&optional pom which specific)
13442 "Get all properties of the entry at point-or-marker POM.
13443 This includes the TODO keyword, the tags, time strings for deadline,
13444 scheduled, and clocking, and any additional properties defined in the
13445 entry. The return value is an alist, keys may occur multiple times
13446 if the property key was used several times.
13447 POM may also be nil, in which case the current entry is used.
13448 If WHICH is nil or `all', get all properties. If WHICH is
13449 `special' or `standard', only get that subclass. If WHICH
13450 is a string only get exactly this property. SPECIFIC can be a string, the
13451 specific property we are interested in. Specifying it can speed
13452 things up because then unnecessary parsing is avoided."
13453 (setq which (or which 'all))
13454 (org-with-point-at pom
13455 (let ((clockstr (substring org-clock-string 0 -1))
13456 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13457 (case-fold-search nil)
13458 beg end range props sum-props key key1 value string clocksum)
13459 (save-excursion
13460 (when (condition-case nil
13461 (and (org-mode-p) (org-back-to-heading t))
13462 (error nil))
13463 (setq beg (point))
13464 (setq sum-props (get-text-property (point) 'org-summaries))
13465 (setq clocksum (get-text-property (point) :org-clock-minutes))
13466 (outline-next-heading)
13467 (setq end (point))
13468 (when (memq which '(all special))
13469 ;; Get the special properties, like TODO and tags
13470 (goto-char beg)
13471 (when (and (or (not specific) (string= specific "TODO"))
13472 (looking-at org-todo-line-regexp) (match-end 2))
13473 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13474 (when (and (or (not specific) (string= specific "PRIORITY"))
13475 (looking-at org-priority-regexp))
13476 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13477 (when (or (not specific) (string= specific "FILE"))
13478 (push (cons "FILE" buffer-file-name) props))
13479 (when (and (or (not specific) (string= specific "TAGS"))
13480 (setq value (org-get-tags-string))
13482 (push (cons "TAGS" value) props))
13483 (when (and (or (not specific) (string= specific "ALLTAGS"))
13484 (setq value (org-get-tags-at)))
13485 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13486 ":"))
13487 props))
13488 (when (or (not specific) (string= specific "BLOCKED"))
13489 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13490 (when (or (not specific)
13491 (member specific
13492 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13493 "TIMESTAMP" "TIMESTAMP_IA")))
13494 (catch 'match
13495 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13496 (setq key (if (match-end 1)
13497 (substring (org-match-string-no-properties 1)
13498 0 -1))
13499 string (if (equal key clockstr)
13500 (org-no-properties
13501 (org-trim
13502 (buffer-substring
13503 (match-beginning 3) (goto-char
13504 (point-at-eol)))))
13505 (substring (org-match-string-no-properties 3)
13506 1 -1)))
13507 ;; Get the correct property name from the key. This is
13508 ;; necessary if the user has configured time keywords.
13509 (setq key1 (concat key ":"))
13510 (cond
13511 ((not key)
13512 (setq key
13513 (if (= (char-after (match-beginning 3)) ?\[)
13514 "TIMESTAMP_IA" "TIMESTAMP")))
13515 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13516 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13517 ((equal key1 org-closed-string) (setq key "CLOSED"))
13518 ((equal key1 org-clock-string) (setq key "CLOCK")))
13519 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13520 (progn
13521 (push (cons key string) props)
13522 ;; no need to search further if match is found
13523 (throw 'match t))
13524 (when (or (equal key "CLOCK") (not (assoc key props)))
13525 (push (cons key string) props))))))
13526 )
13528 (when (memq which '(all standard))
13529 ;; Get the standard properties, like :PROP: ...
13530 (setq range (org-get-property-block beg end))
13531 (when range
13532 (goto-char (car range))
13533 (while (re-search-forward
13535 (cdr range) t)
13536 (setq key (org-match-string-no-properties 1)
13537 value (org-trim (or (org-match-string-no-properties 2) "")))
13538 (unless (member key excluded)
13539 (push (cons key (or value "")) props)))))
13540 (if clocksum
13541 (push (cons "CLOCKSUM"
13542 (org-columns-number-to-string (/ (float clocksum) 60.)
13543 'add_times))
13544 props))
13545 (unless (assoc "CATEGORY" props)
13546 (push (cons "CATEGORY" (org-get-category)) props))
13547 (append sum-props (nreverse props)))))))
13549 (defun org-entry-get (pom property &optional inherit literal-nil)
13550 "Get value of PROPERTY for entry at point-or-marker POM.
13551 If INHERIT is non-nil and the entry does not have the property,
13552 then also check higher levels of the hierarchy.
13553 If INHERIT is the symbol `selective', use inheritance only if the setting
13554 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13555 If the property is present but empty, the return value is the empty string.
13556 If the property is not present at all, nil is returned.
13559 do not interpret it as the list atom nil. This is used for inheritance
13561 (org-with-point-at pom
13562 (if (and inherit (if (eq inherit 'selective)
13563 (org-property-inherit-p property)
13564 t))
13565 (org-entry-get-with-inheritance property literal-nil)
13566 (if (member property org-special-properties)
13567 ;; We need a special property. Use `org-entry-properties' to
13568 ;; retrieve it, but specify the wanted property
13569 (cdr (assoc property (org-entry-properties nil 'special property)))
13570 (let ((range (unless (org-before-first-heading-p)
13571 (org-get-property-block))))
13572 (if (and range
13573 (goto-char (car range))
13574 (re-search-forward
13576 (cdr range) t))
13577 ;; Found the property, return it.
13578 (if (match-end 1)
13579 (if literal-nil
13580 (org-match-string-no-properties 1)
13581 (org-not-nil (org-match-string-no-properties 1)))
13582 "")))))))
13584 (defun org-property-or-variable-value (var &optional inherit)
13585 "Check if there is a property fixing the value of VAR.
13586 If yes, return this value. If not, return the current value of the variable."
13587 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13589 (read prop)
13590 (symbol-value var))))
13592 (defun org-entry-delete (pom property)
13593 "Delete the property PROPERTY from entry at point-or-marker POM."
13594 (org-with-point-at pom
13595 (if (member property org-special-properties)
13596 nil ; cannot delete these properties.
13597 (let ((range (org-get-property-block)))
13598 (if (and range
13599 (goto-char (car range))
13600 (re-search-forward
13602 (cdr range) t))
13603 (progn
13604 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13605 t)
13606 nil)))))
13608 ;; Multi-values properties are properties that contain multiple values
13609 ;; These values are assumed to be single words, separated by whitespace.
13610 (defun org-entry-add-to-multivalued-property (pom property value)
13611 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13612 (let* ((old (org-entry-get pom property))
13614 (setq value (org-entry-protect-space value))
13615 (unless (member value values)
13616 (setq values (cons value values))
13617 (org-entry-put pom property
13618 (mapconcat 'identity values " ")))))
13620 (defun org-entry-remove-from-multivalued-property (pom property value)
13621 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13622 (let* ((old (org-entry-get pom property))
13624 (setq value (org-entry-protect-space value))
13625 (when (member value values)
13626 (setq values (delete value values))
13627 (org-entry-put pom property
13628 (mapconcat 'identity values " ")))))
13630 (defun org-entry-member-in-multivalued-property (pom property value)
13631 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13632 (let* ((old (org-entry-get pom property))
13634 (setq value (org-entry-protect-space value))
13635 (member value values)))
13637 (defun org-entry-get-multivalued-property (pom property)
13638 "Return a list of values in a multivalued property."
13639 (let* ((value (org-entry-get pom property))
13641 (mapcar 'org-entry-restore-space values)))
13643 (defun org-entry-put-multivalued-property (pom property &rest values)
13644 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13645 VALUES should be a list of strings. Spaces will be protected."
13646 (org-entry-put pom property
13647 (mapconcat 'org-entry-protect-space values " "))
13648 (let* ((value (org-entry-get pom property))
13650 (mapcar 'org-entry-restore-space values)))
13652 (defun org-entry-protect-space (s)
13653 "Protect spaces and newline in string S."
13654 (while (string-match " " s)
13655 (setq s (replace-match "%20" t t s)))
13657 (setq s (replace-match "%0A" t t s)))
13658 s)
13660 (defun org-entry-restore-space (s)
13661 "Restore spaces and newline in string S."
13662 (while (string-match "%20" s)
13663 (setq s (replace-match " " t t s)))
13664 (while (string-match "%0A" s)
13666 s)
13668 (defvar org-entry-property-inherited-from (make-marker)
13669 "Marker pointing to the entry from where a property was inherited.
13670 Each call to `org-entry-get-with-inheritance' will set this marker to the
13671 location of the entry where the inheritance search matched. If there was
13672 no match, the marker will point nowhere.
13673 Note that also `org-entry-get' calls this function, if the INHERIT flag
13674 is set.")
13676 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13677 "Get entry property, and search higher levels if not present.
13678 The search will stop at the first ancestor which has the property defined.
13680 should be considered as undefined (this is the meaning of nil here).
13682 (move-marker org-entry-property-inherited-from nil)
13683 (let (tmp)
13684 (unless (org-before-first-heading-p)
13685 (save-excursion
13686 (save-restriction
13687 (widen)
13688 (catch 'ex
13689 (while t
13690 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13691 (org-back-to-heading t)
13692 (move-marker org-entry-property-inherited-from (point))
13693 (throw 'ex tmp))
13694 (or (org-up-heading-safe) (throw 'ex nil)))))))
13695 (setq tmp (or tmp
13696 (cdr (assoc property org-file-properties))
13697 (cdr (assoc property org-global-properties))
13698 (cdr (assoc property org-global-properties-fixed))))
13699 (if literal-nil tmp (org-not-nil tmp))))
13701 (defvar org-property-changed-functions nil
13702 "Hook called when the value of a property has changed.
13703 Each hook function should accept two arguments, the name of the property
13704 and the new value.")
13706 (defun org-entry-put (pom property value)
13707 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13708 (org-with-point-at pom
13709 (org-back-to-heading t)
13710 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13711 range)
13712 (cond
13713 ((equal property "TODO")
13715 (not (member value org-todo-keywords-1)))
13717 (if (or (not value)
13719 (setq value 'none))
13720 (org-todo value)
13721 (org-set-tags nil 'align))
13722 ((equal property "PRIORITY")
13724 (string-to-char value) ?\ ))
13725 (org-set-tags nil 'align))
13726 ((equal property "SCHEDULED")
13727 (if (re-search-forward org-scheduled-time-regexp end t)
13728 (cond
13729 ((eq value 'earlier) (org-timestamp-change -1 'day))
13730 ((eq value 'later) (org-timestamp-change 1 'day))
13731 (t (call-interactively 'org-schedule)))
13732 (call-interactively 'org-schedule)))
13733 ((equal property "DEADLINE")
13734 (if (re-search-forward org-deadline-time-regexp end t)
13735 (cond
13736 ((eq value 'earlier) (org-timestamp-change -1 'day))
13737 ((eq value 'later) (org-timestamp-change 1 'day))
13738 (t (call-interactively 'org-deadline)))
13739 (call-interactively 'org-deadline)))
13740 ((member property org-special-properties)
13741 (error "The %s property can not yet be set with `org-entry-put'"
13742 property))
13743 (t ; a non-special property
13744 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13745 (setq range (org-get-property-block beg end 'force))
13746 (goto-char (car range))
13747 (if (re-search-forward
13749 (progn
13750 (delete-region (match-beginning 1) (match-end 1))
13751 (goto-char (match-beginning 1)))
13752 (goto-char (cdr range))
13754 (backward-char 1)
13755 (org-indent-line-function)
13756 (insert ":" property ":"))
13757 (and value (insert " " value))
13758 (org-indent-line-function)))))
13759 (run-hook-with-args 'org-property-changed-functions property value)))
13761 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13762 "Get all property keys in the current buffer.
13763 With INCLUDE-SPECIALS, also list the special properties that reflect things
13764 like tags and TODO state.
13765 With INCLUDE-DEFAULTS, also include properties that has special meaning
13766 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13767 With INCLUDE-COLUMNS, also include property names given in COLUMN
13768 formats in the current buffer."
13769 (let (rtn range cfmt s p)
13770 (save-excursion
13771 (save-restriction
13772 (widen)
13773 (goto-char (point-min))
13774 (while (re-search-forward org-property-start-re nil t)
13775 (setq range (org-get-property-block))
13776 (goto-char (car range))
13777 (while (re-search-forward
13779 (cdr range) t)
13780 (add-to-list 'rtn (org-match-string-no-properties 1)))
13781 (outline-next-heading))))
13783 (when include-specials
13784 (setq rtn (append org-special-properties rtn)))
13786 (when include-defaults
13787 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13788 (add-to-list 'rtn org-effort-property))
13790 (when include-columns
13791 (save-excursion
13792 (save-restriction
13793 (widen)
13794 (goto-char (point-min))
13795 (while (re-search-forward
13797 nil t)
13798 (setq cfmt (match-string 2) s 0)
13800 cfmt s)
13801 (setq s (match-end 0)
13802 p (match-string 1 cfmt))
13803 (unless (or (equal p "ITEM")
13804 (member p org-special-properties))
13805 (add-to-list 'rtn (match-string 1 cfmt))))))))
13807 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13809 (defun org-property-values (key)
13810 "Return a list of all values of property KEY."
13811 (save-excursion
13812 (save-restriction
13813 (widen)
13814 (goto-char (point-min))
13816 values)
13817 (while (re-search-forward re nil t)
13818 (add-to-list 'values (org-trim (match-string 1))))
13819 (delete "" values)))))
13821 (defun org-insert-property-drawer ()
13822 "Insert a property drawer into the current entry."
13823 (interactive)
13824 (org-back-to-heading t)
13825 (looking-at outline-regexp)
13826 (let ((indent (if org-adapt-indentation
13827 (- (match-end 0)(match-beginning 0))
13828 0))
13829 (beg (point))
13831 end hiddenp)
13832 (outline-next-heading)
13833 (setq end (point))
13834 (goto-char beg)
13835 (while (re-search-forward re end t))
13836 (setq hiddenp (outline-invisible-p))
13837 (end-of-line 1)
13840 (if (member (match-string 1) '("CLOCK:" ":END:"))
13841 ;; just skip this line
13842 (beginning-of-line 2)
13843 ;; Drawer start, find the end
13845 (beginning-of-line 1)))
13846 (org-skip-over-state-notes)
13848 (if (eq (char-before) ?*) (forward-char 1))
13850 (beginning-of-line 0)
13851 (org-indent-to-column indent)
13852 (beginning-of-line 2)
13853 (org-indent-to-column indent)
13854 (beginning-of-line 0)
13855 (if hiddenp
13856 (save-excursion
13857 (org-back-to-heading t)
13858 (hide-entry))
13859 (org-flag-drawer t))))
13861 (defvar org-property-set-functions-alist nil
13862 "Property set function alist.
13863 Each entry should have the following format:
13865 (PROPERTY . READ-FUNCTION)
13867 The read function will be called with the same argument as
13868 `org-completing-read.")
13870 (defun org-set-property-function (property)
13871 "Get the function that should be used to set PROPERTY.
13872 This is computed according to `org-property-set-functions-alist'."
13873 (or (cdr (assoc property org-property-set-functions-alist))
13874 'org-completing-read))
13876 (defun org-read-property-value (property)
13877 "Read PROPERTY value from user."
13878 (let* ((completion-ignore-case t)
13879 (allowed (org-property-get-allowed-values nil property 'table))
13880 (cur (org-entry-get nil property))
13881 (prompt (concat property " value"
13883 (concat " [" cur "]") "") ": "))
13884 (set-function (org-set-property-function property))
13885 (val (if allowed
13886 (funcall set-function prompt allowed nil
13887 (not (get-text-property 0 'org-unrestricted
13888 (caar allowed))))
13889 (let (org-completion-use-ido org-completion-use-iswitchb)
13890 (funcall set-function prompt
13891 (mapcar 'list (org-property-values property))
13892 nil nil "" nil cur)))))
13893 (if (equal val "")
13894 cur
13895 val)))
13897 (defun org-read-property-name ()
13898 "Read a property name."
13899 (let* ((completion-ignore-case t)
13900 (keys (org-buffer-property-keys nil t t))
13901 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
13902 (if (member property keys)
13903 property
13904 (or (cdr (assoc (downcase property)
13905 (mapcar (lambda (x) (cons (downcase x) x))
13906 keys)))
13907 property))))
13909 (defun org-set-property (property value)
13910 "In the current entry, set PROPERTY to VALUE.
13911 When called interactively, this will prompt for a property name, offering
13912 completion on existing and default properties. And then it will prompt
13913 for a value, offering completion either on allowed values (via an inherited
13914 xxx_ALL property) or on existing values in other instances of this property
13915 in the current file."
13916 (interactive (list nil nil))
13917 (let* ((property (or property (org-read-property-name)))
13918 (value (or value (org-read-property-value property))))
13919 (unless (equal (org-entry-get nil property) value)
13920 (org-entry-put nil property value))))
13922 (defun org-delete-property (property)
13923 "In the current entry, delete PROPERTY."
13924 (interactive
13925 (let* ((completion-ignore-case t)
13926 (prop (org-icompleting-read "Property: "
13927 (org-entry-properties nil 'standard))))
13928 (list prop)))
13929 (message "Property %s %s" property
13930 (if (org-entry-delete nil property)
13931 "deleted"
13932 "was not present in the entry")))
13934 (defun org-delete-property-globally (property)
13935 "Remove PROPERTY globally, from all entries."
13936 (interactive
13937 (let* ((completion-ignore-case t)
13938 (prop (org-icompleting-read
13939 "Globally remove property: "
13940 (mapcar 'list (org-buffer-property-keys)))))
13941 (list prop)))
13942 (save-excursion
13943 (save-restriction
13944 (widen)
13945 (goto-char (point-min))
13946 (let ((cnt 0))
13947 (while (re-search-forward
13949 nil t)
13950 (setq cnt (1+ cnt))
13951 (replace-match ""))
13954 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13956 (defun org-compute-property-at-point ()
13957 "Compute the property at point.
13958 This looks for an enclosing column format, extracts the operator and
13959 then applies it to the property in the column format's scope."
13960 (interactive)
13961 (unless (org-at-property-p)
13962 (error "Not at a property"))
13963 (let ((prop (org-match-string-no-properties 2)))
13964 (org-columns-get-format-and-top-level)
13965 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13966 (error "No operator defined for property %s" prop))
13967 (org-columns-compute prop)))
13969 (defvar org-property-allowed-value-functions nil
13970 "Hook for functions supplying allowed values for a specific property.
13971 The functions must take a single argument, the name of the property, and
13973 the values, this means that these values are intended as defaults for
13974 completion, but that other values should be allowed too.
13975 The functions must return nil if they are not responsible for this
13976 property.")
13978 (defun org-property-get-allowed-values (pom property &optional table)
13979 "Get allowed values for the property PROPERTY.
13980 When TABLE is non-nil, return an alist that can directly be used for
13981 completion."
13982 (let (vals)
13983 (cond
13984 ((equal property "TODO")
13985 (setq vals (org-with-point-at pom
13986 (append org-todo-keywords-1 '("")))))
13987 ((equal property "PRIORITY")
13988 (let ((n org-lowest-priority))
13989 (while (>= n org-highest-priority)
13990 (push (char-to-string n) vals)
13991 (setq n (1- n)))))
13992 ((member property org-special-properties))
13993 ((setq vals (run-hook-with-args-until-success
13994 'org-property-allowed-value-functions property)))
13995 (t
13996 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13998 (setq vals (car (read-from-string (concat "(" vals ")"))))
13999 (setq vals (mapcar (lambda (x)
14000 (cond ((stringp x) x)
14001 ((numberp x) (number-to-string x))
14002 ((symbolp x) (symbol-name x))
14003 (t "???")))
14004 vals)))))
14005 (when (member ":ETC" vals)
14006 (setq vals (remove ":ETC" vals))
14007 (org-add-props (car vals) '(org-unrestricted t)))
14008 (if table (mapcar 'list vals) vals)))
14010 (defun org-property-previous-allowed-value (&optional previous)
14011 "Switch to the next allowed value for this property."
14012 (interactive)
14013 (org-property-next-allowed-value t))
14015 (defun org-property-next-allowed-value (&optional previous)
14016 "Switch to the next allowed value for this property."
14017 (interactive)
14018 (unless (org-at-property-p)
14019 (error "Not at a property"))
14020 (let* ((key (match-string 2))
14021 (value (match-string 3))
14022 (allowed (or (org-property-get-allowed-values (point) key)
14023 (and (member value '("[ ]" "[-]" "[X]"))
14024 '("[ ]" "[X]"))))
14025 nval)
14026 (unless allowed
14027 (error "Allowed values for this property have not been defined"))
14028 (if previous (setq allowed (reverse allowed)))
14029 (if (member value allowed)
14030 (setq nval (car (cdr (member value allowed)))))
14031 (setq nval (or nval (car allowed)))
14032 (if (equal nval value)
14033 (error "Only one allowed value for this property"))
14034 (org-at-property-p)
14035 (replace-match (concat " :" key ": " nval) t t)
14036 (org-indent-line-function)
14037 (beginning-of-line 1)
14039 (run-hook-with-args 'org-property-changed-functions key nval)))
14041 (defun org-find-olp (path &optional this-buffer)
14042 "Return a marker pointing to the entry at outline path OLP.
14043 If anything goes wrong, throw an error.
14044 You can wrap this call to catch the error like this:
14046 (condition-case msg
14047 (org-mobile-locate-entry (match-string 4))
14048 (error (nth 1 msg)))
14050 The return value will then be either a string with the error message,
14051 or a marker if everything is OK.
14053 If THIS-BUFFER is set, the outline path does not contain a file,
14054 only headings."
14055 (let* ((file (if this-buffer buffer-file-name (pop path)))
14056 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14057 (level 1)
14058 (lmin 1)
14059 (lmax 1)
14060 limit re end found pos heading cnt)
14061 (unless buffer (error "File not found :%s" file))
14062 (with-current-buffer buffer
14063 (save-excursion
14064 (save-restriction
14065 (widen)
14066 (setq limit (point-max))
14067 (goto-char (point-min))
14068 (while (setq heading (pop path))
14069 (setq re (format org-complex-heading-regexp-format
14070 (regexp-quote heading)))
14071 (setq cnt 0 pos (point))
14072 (while (re-search-forward re end t)
14073 (setq level (- (match-end 1) (match-beginning 1)))
14074 (if (and (>= level lmin) (<= level lmax))
14075 (setq found (match-beginning 0) cnt (1+ cnt))))
14076 (when (= cnt 0) (error "Heading not found on level %d: %s"
14077 lmax heading))
14078 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14079 lmax heading))
14080 (goto-char found)
14081 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14082 (setq end (save-excursion (org-end-of-subtree t t))))
14083 (when (org-on-heading-p)
14084 (move-marker (make-marker) (point))))))))
14086 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14087 "Find node HEADING in BUFFER.
14088 Return a marker to the heading if it was found, or nil if not.
14089 If POS-ONLY is set, return just the position instead of a marker.
14091 The heading text must match exact, but it may have a TODO keyword,
14092 a priority cookie and tags in the standard locations."
14093 (with-current-buffer (or buffer (current-buffer))
14094 (save-excursion
14095 (save-restriction
14096 (widen)
14097 (goto-char (point-min))
14098 (let (case-fold-search)
14099 (if (re-search-forward
14100 (format org-complex-heading-regexp-format
14101 (regexp-quote heading)) nil t)
14102 (if pos-only
14103 (match-beginning 0)
14104 (move-marker (make-marker) (match-beginning 0)))))))))
14106 (defun org-find-exact-heading-in-directory (heading &optional dir)
14107 "Find Org node headline HEADING in all .org files in directory DIR.
14108 When the target headline is found, return a marker to this location."
14109 (let ((files (directory-files (or dir default-directory)
14111 file visiting m buffer)
14112 (catch 'found
14113 (while (setq file (pop files))
14114 (message "trying %s" file)
14115 (setq visiting (org-find-base-buffer-visiting file))
14116 (setq buffer (or visiting (find-file-noselect file)))
14117 (setq m (org-find-exact-headline-in-buffer
14118 heading buffer))
14119 (when (and (not m) (not visiting)) (kill-buffer buffer))
14120 (and m (throw 'found m))))))
14122 (defun org-find-entry-with-id (ident)
14123 "Locate the entry that contains the ID property with exact value IDENT.
14124 IDENT can be a string, a symbol or a number, this function will search for
14125 the string representation of it.
14126 Return the position where this entry starts, or nil if there is no such entry."
14127 (interactive "sID: ")
14128 (let ((id (cond
14129 ((stringp ident) ident)
14130 ((symbol-name ident) (symbol-name ident))
14131 ((numberp ident) (number-to-string ident))
14132 (t (error "IDENT %s must be a string, symbol or number" ident))))
14133 (case-fold-search nil))
14134 (save-excursion
14135 (save-restriction
14136 (widen)
14137 (goto-char (point-min))
14138 (when (re-search-forward
14140 nil t)
14141 (org-back-to-heading t)
14142 (point))))))
14144 ;;;; Timestamps
14146 (defvar org-last-changed-timestamp nil)
14147 (defvar org-last-inserted-timestamp nil
14148 "The last time stamp inserted with `org-insert-time-stamp'.")
14149 (defvar org-time-was-given) ; dynamically scoped parameter
14150 (defvar org-end-time-was-given) ; dynamically scoped parameter
14151 (defvar org-ts-what) ; dynamically scoped parameter
14153 (defun org-time-stamp (arg &optional inactive)
14154 "Prompt for a date/time and insert a time stamp.
14155 If the user specifies a time like HH:MM, or if this command is called
14156 with a prefix argument, the time stamp will contain date and time.
14157 Otherwise, only the date will be included. All parts of a date not
14158 specified by the user will be filled in from the current date/time.
14159 So if you press just return without typing anything, the time stamp
14160 will represent the current date/time. If there is already a timestamp
14161 at the cursor, it will be modified."
14162 (interactive "P")
14163 (let* ((ts nil)
14164 (default-time
14165 ;; Default time is either today, or, when entering a range,
14166 ;; the range start.
14167 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14168 (save-excursion
14169 (re-search-backward
14171 (- (point) 20) t)))
14172 (apply 'encode-time (org-parse-time-string (match-string 1)))
14173 (current-time)))
14174 (default-input (and ts (org-get-compact-tod ts)))
14175 org-time-was-given org-end-time-was-given time)
14176 (cond
14177 ((and (org-at-timestamp-p t)
14178 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14179 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14180 (insert "--")
14181 (setq time (let ((this-command this-command))
14182 (org-read-date arg 'totime nil nil
14183 default-time default-input)))
14184 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14185 ((org-at-timestamp-p t)
14186 (setq time (let ((this-command this-command))
14187 (org-read-date arg 'totime nil nil default-time default-input)))
14188 (when (org-at-timestamp-p t) ; just to get the match data
14189 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14190 (replace-match "")
14191 (setq org-last-changed-timestamp
14192 (org-insert-time-stamp
14193 time (or org-time-was-given arg)
14194 inactive nil nil (list org-end-time-was-given))))
14195 (message "Timestamp updated"))
14196 (t
14197 (setq time (let ((this-command this-command))
14198 (org-read-date arg 'totime nil nil default-time default-input)))
14199 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14200 nil nil (list org-end-time-was-given))))))
14202 ;; FIXME: can we use this for something else, like computing time differences?
14203 (defun org-get-compact-tod (s)
14204 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14205 (let* ((t1 (match-string 1 s))
14206 (h1 (string-to-number (match-string 2 s)))
14207 (m1 (string-to-number (match-string 3 s)))
14208 (t2 (and (match-end 4) (match-string 5 s)))
14209 (h2 (and t2 (string-to-number (match-string 6 s))))
14210 (m2 (and t2 (string-to-number (match-string 7 s))))
14211 dh dm)
14212 (if (not t2)
14213 t1
14214 (setq dh (- h2 h1) dm (- m2 m1))
14215 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14216 (concat t1 "+" (number-to-string dh)
14217 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14219 (defun org-time-stamp-inactive (&optional arg)
14220 "Insert an inactive time stamp.
14221 An inactive time stamp is enclosed in square brackets instead of angle
14222 brackets. It is inactive in the sense that it does not trigger agenda entries,
14223 does not link to the calendar and cannot be changed with the S-cursor keys.
14224 So these are more for recording a certain time/date."
14225 (interactive "P")
14226 (org-time-stamp arg 'inactive))
14228 (defvar org-date-ovl (make-overlay 1 1))
14229 (overlay-put org-date-ovl 'face 'org-warning)
14230 (org-detach-overlay org-date-ovl)
14232 (defvar org-ans1) ; dynamically scoped parameter
14233 (defvar org-ans2) ; dynamically scoped parameter
14235 (defvar org-plain-time-of-day-regexp) ; defined below
14237 (defvar org-overriding-default-time nil) ; dynamically scoped
14238 (defvar org-read-date-overlay nil)
14239 (defvar org-dcst nil) ; dynamically scoped
14240 (defvar org-read-date-history nil)
14241 (defvar org-read-date-final-answer nil)
14243 (defun org-read-date (&optional with-time to-time from-string prompt
14244 default-time default-input)
14245 "Read a date, possibly a time, and make things smooth for the user.
14246 The prompt will suggest to enter an ISO date, but you can also enter anything
14247 which will at least partially be understood by `parse-time-string'.
14248 Unrecognized parts of the date will default to the current day, month, year,
14249 hour and minute. If this command is called to replace a timestamp at point,
14250 of to enter the second timestamp of a range, the default time is taken
14251 from the existing stamp. Furthermore, the command prefers the future,
14252 so if you are giving a date where the year is not given, and the day-month
14253 combination is already past in the current year, it will assume you
14254 mean next year. For details, see the manual. A few examples:
14256 3-2-5 --> 2003-02-05
14257 feb 15 --> currentyear-02-15
14258 2/15 --> currentyear-02-15
14259 sep 12 9 --> 2009-09-12
14260 12:45 --> today 12:45
14261 22 sept 0:34 --> currentyear-09-22 0:34
14262 12 --> currentyear-currentmonth-12
14263 Fri --> nearest Friday (today or later)
14264 etc.
14266 Furthermore you can specify a relative date by giving, as the *first* thing
14267 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14268 change in days weeks, months, years.
14269 With a single plus or minus, the date is relative to today. With a double
14270 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14271 +4d --> four days from today
14272 +4 --> same as above
14273 +2w --> two weeks from today
14274 ++5 --> five days from default date
14276 The function understands only English month and weekday abbreviations,
14277 but this can be configured with the variables `parse-time-months' and
14278 `parse-time-weekdays'.
14280 While prompting, a calendar is popped up - you can also select the
14281 date with the mouse (button 1). The calendar shows a period of three
14282 months. To scroll it to other months, use the keys `>' and `<'.
14283 If you don't like the calendar, turn it off with
14284 \(setq org-read-date-popup-calendar nil)
14286 With optional argument TO-TIME, the date will immediately be converted
14287 to an internal time.
14288 With an optional argument WITH-TIME, the prompt will suggest to also
14289 insert a time. Note that when WITH-TIME is not set, you can still
14290 enter a time, and this function will inform the calling routine about
14291 this change. The calling routine may then choose to change the format
14292 used to insert the time stamp into the buffer to include the time.
14293 With optional argument FROM-STRING, read from this string instead from
14294 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14295 the time/date that is used for everything that is not specified by the
14296 user."
14297 (require 'parse-time)
14298 (let* ((org-time-stamp-rounding-minutes
14299 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14300 (org-dcst org-display-custom-times)
14301 (ct (org-current-time))
14302 (def (or org-overriding-default-time default-time ct))
14303 (defdecode (decode-time def))
14304 (dummy (progn
14305 (when (< (nth 2 defdecode) org-extend-today-until)
14306 (setcar (nthcdr 2 defdecode) -1)
14307 (setcar (nthcdr 1 defdecode) 59)
14308 (setq def (apply 'encode-time defdecode)
14309 defdecode (decode-time def)))))
14310 (calendar-frame-setup nil)
14311 (calendar-setup nil)
14312 (calendar-move-hook nil)
14313 (calendar-view-diary-initially-flag nil)
14314 (calendar-view-holidays-initially-flag nil)
14315 (timestr (format-time-string
14316 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14317 (prompt (concat (if prompt (concat prompt " ") "")
14318 (format "Date+time [%s]: " timestr)))
14319 ans (org-ans0 "") org-ans1 org-ans2 final)
14321 (cond
14322 (from-string (setq ans from-string))
14323 (org-read-date-popup-calendar
14324 (save-excursion
14325 (save-window-excursion
14326 (calendar)
14327 (calendar-forward-day (- (time-to-days def)
14328 (calendar-absolute-from-gregorian
14329 (calendar-current-date))))
14330 (org-eval-in-calendar nil t)
14331 (let* ((old-map (current-local-map))
14332 (map (copy-keymap calendar-mode-map))
14333 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14334 (org-defkey map (kbd "RET") 'org-calendar-select)
14335 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14336 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14337 (org-defkey minibuffer-local-map [(meta shift left)]
14338 (lambda () (interactive)
14339 (org-eval-in-calendar '(calendar-backward-month 1))))
14340 (org-defkey minibuffer-local-map [(meta shift right)]
14341 (lambda () (interactive)
14342 (org-eval-in-calendar '(calendar-forward-month 1))))
14343 (org-defkey minibuffer-local-map [(meta shift up)]
14344 (lambda () (interactive)
14345 (org-eval-in-calendar '(calendar-backward-year 1))))
14346 (org-defkey minibuffer-local-map [(meta shift down)]
14347 (lambda () (interactive)
14348 (org-eval-in-calendar '(calendar-forward-year 1))))
14349 (org-defkey minibuffer-local-map [?\e (shift left)]
14350 (lambda () (interactive)
14351 (org-eval-in-calendar '(calendar-backward-month 1))))
14352 (org-defkey minibuffer-local-map [?\e (shift right)]
14353 (lambda () (interactive)
14354 (org-eval-in-calendar '(calendar-forward-month 1))))
14355 (org-defkey minibuffer-local-map [?\e (shift up)]
14356 (lambda () (interactive)
14357 (org-eval-in-calendar '(calendar-backward-year 1))))
14358 (org-defkey minibuffer-local-map [?\e (shift down)]
14359 (lambda () (interactive)
14360 (org-eval-in-calendar '(calendar-forward-year 1))))
14361 (org-defkey minibuffer-local-map [(shift up)]
14362 (lambda () (interactive)
14363 (org-eval-in-calendar '(calendar-backward-week 1))))
14364 (org-defkey minibuffer-local-map [(shift down)]
14365 (lambda () (interactive)
14366 (org-eval-in-calendar '(calendar-forward-week 1))))
14367 (org-defkey minibuffer-local-map [(shift left)]
14368 (lambda () (interactive)
14369 (org-eval-in-calendar '(calendar-backward-day 1))))
14370 (org-defkey minibuffer-local-map [(shift right)]
14371 (lambda () (interactive)
14372 (org-eval-in-calendar '(calendar-forward-day 1))))
14373 (org-defkey minibuffer-local-map ">"
14374 (lambda () (interactive)
14375 (org-eval-in-calendar '(scroll-calendar-left 1))))
14376 (org-defkey minibuffer-local-map "<"
14377 (lambda () (interactive)
14378 (org-eval-in-calendar '(scroll-calendar-right 1))))
14379 (org-defkey minibuffer-local-map "\C-v"
14380 (lambda () (interactive)
14381 (org-eval-in-calendar
14382 '(calendar-scroll-left-three-months 1))))
14383 (org-defkey minibuffer-local-map "\M-v"
14384 (lambda () (interactive)
14385 (org-eval-in-calendar
14386 '(calendar-scroll-right-three-months 1))))
14387 (run-hooks 'org-read-date-minibuffer-setup-hook)
14388 (unwind-protect
14389 (progn
14390 (use-local-map map)
14391 (add-hook 'post-command-hook 'org-read-date-display)
14392 (setq org-ans0 (read-string prompt default-input
14393 'org-read-date-history nil))
14394 ;; org-ans0: from prompt
14395 ;; org-ans1: from mouse click
14396 ;; org-ans2: from calendar motion
14397 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14398 (remove-hook 'post-command-hook 'org-read-date-display)
14399 (use-local-map old-map)
14400 (when org-read-date-overlay
14401 (delete-overlay org-read-date-overlay)
14402 (setq org-read-date-overlay nil)))))))
14404 (t ; Naked prompt only
14405 (unwind-protect
14406 (setq ans (read-string prompt default-input
14407 'org-read-date-history timestr))
14408 (when org-read-date-overlay
14409 (delete-overlay org-read-date-overlay)
14410 (setq org-read-date-overlay nil)))))
14412 (setq final (org-read-date-analyze ans def defdecode))
14414 ;; One round trip to get rid of 34th of August and stuff like that....
14415 (setq final (decode-time (apply 'encode-time final)))
14417 (setq org-read-date-final-answer ans)
14419 (if to-time
14420 (apply 'encode-time final)
14421 (if (and (boundp 'org-time-was-given) org-time-was-given)
14422 (format "%04d-%02d-%02d %02d:%02d"
14423 (nth 5 final) (nth 4 final) (nth 3 final)
14424 (nth 2 final) (nth 1 final))
14425 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14427 (defvar def)
14428 (defvar defdecode)
14429 (defvar with-time)
14430 (defvar org-read-date-analyze-futurep nil)
14431 (defun org-read-date-display ()
14432 "Display the current date prompt interpretation in the minibuffer."
14433 (when org-read-date-display-live
14434 (when org-read-date-overlay
14435 (delete-overlay org-read-date-overlay))
14436 (let ((p (point)))
14437 (end-of-line 1)
14438 (while (not (equal (buffer-substring
14439 (max (point-min) (- (point) 4)) (point))
14440 " "))
14441 (insert " "))
14442 (goto-char p))
14443 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14444 " " (or org-ans1 org-ans2)))
14445 (org-end-time-was-given nil)
14446 (f (org-read-date-analyze ans def defdecode))
14447 (fmts (if org-dcst
14448 org-time-stamp-custom-formats
14449 org-time-stamp-formats))
14450 (fmt (if (or with-time
14451 (and (boundp 'org-time-was-given) org-time-was-given))
14452 (cdr fmts)
14453 (car fmts)))
14454 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14455 (when (and org-end-time-was-given
14456 (string-match org-plain-time-of-day-regexp txt))
14457 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14458 org-end-time-was-given
14459 (substring txt (match-end 0)))))
14460 (when org-read-date-analyze-futurep
14461 (setq txt (concat txt " (=>F)")))
14462 (setq org-read-date-overlay
14463 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14464 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14466 (defun org-read-date-analyze (ans def defdecode)
14467 "Analyze the combined answer of the date prompt."
14468 ;; FIXME: cleanup and comment
14469 (let ((nowdecode (decode-time (current-time)))
14470 delta deltan deltaw deltadef year month day
14471 hour minute second wday pm h2 m2 tl wday1
14472 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14473 (setq org-read-date-analyze-futurep nil)
14475 (setq ans "+0"))
14477 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14478 (setq ans (replace-match "" t t ans)
14479 deltan (car delta)
14480 deltaw (nth 1 delta)
14481 deltadef (nth 2 delta)))
14483 ;; Check if there is an iso week date in there
14484 ;; If yes, store the info and postpone interpreting it until the rest
14485 ;; of the parsing is done
14486 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14487 (setq iso-year (if (match-end 1)
14488 (org-small-year-to-year
14489 (string-to-number (match-string 1 ans))))
14490 iso-weekday (if (match-end 3)
14491 (string-to-number (match-string 3 ans)))
14492 iso-week (string-to-number (match-string 2 ans)))
14493 (setq ans (replace-match "" t t ans)))
14495 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14496 (when (string-match
14498 (setq year (if (match-end 2)
14499 (string-to-number (match-string 2 ans))
14500 (progn (setq kill-year t)
14501 (string-to-number (format-time-string "%Y"))))
14502 month (string-to-number (match-string 3 ans))
14503 day (string-to-number (match-string 4 ans)))
14504 (if (< year 100) (setq year (+ 2000 year)))
14506 t nil ans)))
14507 ;; Help matching american dates, like 5/30 or 5/30/7
14508 (when (string-match
14509 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14510 (setq year (if (match-end 4)
14511 (string-to-number (match-string 4 ans))
14512 (progn (setq kill-year t)
14513 (string-to-number (format-time-string "%Y"))))
14514 month (string-to-number (match-string 1 ans))
14515 day (string-to-number (match-string 2 ans)))
14516 (if (< year 100) (setq year (+ 2000 year)))
14518 t nil ans)))
14519 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14520 ;; If there is a time with am/pm, and *no* time without it, we convert
14521 ;; so that matching will be successful.
14522 (loop for i from 1 to 2 do ; twice, for end time as well
14525 (setq hour (string-to-number (match-string 1 ans))
14526 minute (if (match-end 3)
14527 (string-to-number (match-string 3 ans))
14528 0)
14529 pm (equal ?p
14530 (string-to-char (downcase (match-string 4 ans)))))
14531 (if (and (= hour 12) (not pm))
14532 (setq hour 0)
14533 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14534 (setq ans (replace-match (format "%02d:%02d" hour minute)
14535 t t ans))))
14537 ;; Check if a time range is given as a duration
14538 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14539 (setq hour (string-to-number (match-string 1 ans))
14540 h2 (+ hour (string-to-number (match-string 3 ans)))
14541 minute (string-to-number (match-string 2 ans))
14542 m2 (+ minute (if (match-end 5) (string-to-number
14543 (match-string 5 ans))0)))
14544 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14545 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14546 t t ans)))
14548 ;; Check if there is a time range
14549 (when (boundp 'org-end-time-was-given)
14550 (setq org-time-was-given nil)
14551 (when (and (string-match org-plain-time-of-day-regexp ans)
14552 (match-end 8))
14553 (setq org-end-time-was-given (match-string 8 ans))
14554 (setq ans (concat (substring ans 0 (match-beginning 7))
14555 (substring ans (match-end 7))))))
14557 (setq tl (parse-time-string ans)
14558 day (or (nth 3 tl) (nth 3 defdecode))
14559 month (or (nth 4 tl)
14560 (if (and org-read-date-prefer-future
14561 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14562 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14563 (nth 4 defdecode)))
14564 year (or (and (not kill-year) (nth 5 tl))
14565 (if (and org-read-date-prefer-future
14566 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14567 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14568 (nth 5 defdecode)))
14569 hour (or (nth 2 tl) (nth 2 defdecode))
14570 minute (or (nth 1 tl) (nth 1 defdecode))
14571 second (or (nth 0 tl) 0)
14572 wday (nth 6 tl))
14574 (when (and (eq org-read-date-prefer-future 'time)
14575 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14576 (equal day (nth 3 nowdecode))
14577 (equal month (nth 4 nowdecode))
14578 (equal year (nth 5 nowdecode))
14579 (nth 2 tl)
14580 (or (< (nth 2 tl) (nth 2 nowdecode))
14581 (and (= (nth 2 tl) (nth 2 nowdecode))
14582 (nth 1 tl)
14583 (< (nth 1 tl) (nth 1 nowdecode)))))
14584 (setq day (1+ day)
14585 futurep t))
14587 ;; Special date definitions below
14588 (cond
14589 (iso-week
14590 ;; There was an iso week
14591 (require 'cal-iso)
14592 (setq futurep nil)
14593 (setq year (or iso-year year)
14594 day (or iso-weekday wday 1)
14595 wday nil ; to make sure that the trigger below does not match
14596 iso-date (calendar-gregorian-from-absolute
14597 (calendar-absolute-from-iso
14598 (list iso-week day year))))
14599 ; FIXME: Should we also push ISO weeks into the future?
14600 ; (when (and org-read-date-prefer-future
14601 ; (not iso-year)
14602 ; (< (calendar-absolute-from-gregorian iso-date)
14603 ; (time-to-days (current-time))))
14604 ; (setq year (1+ year)
14605 ; iso-date (calendar-gregorian-from-absolute
14606 ; (calendar-absolute-from-iso
14607 ; (list iso-week day year)))))
14608 (setq month (car iso-date)
14609 year (nth 2 iso-date)
14610 day (nth 1 iso-date)))
14611 (deltan
14612 (setq futurep nil)
14613 (unless deltadef
14614 (let ((now (decode-time (current-time))))
14615 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14616 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14617 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14618 ((equal deltaw "m") (setq month (+ month deltan)))
14619 ((equal deltaw "y") (setq year (+ year deltan)))))
14620 ((and wday (not (nth 3 tl)))
14621 (setq futurep nil)
14622 ;; Weekday was given, but no day, so pick that day in the week
14623 ;; on or after the derived date.
14624 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14625 (unless (equal wday wday1)
14626 (setq day (+ day (% (- wday wday1 -7) 7))))))
14627 (if (and (boundp 'org-time-was-given)
14628 (nth 2 tl))
14629 (setq org-time-was-given t))
14630 (if (< year 100) (setq year (+ 2000 year)))
14631 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14632 (setq org-read-date-analyze-futurep futurep)
14633 (list second minute hour day month year)))
14635 (defvar parse-time-weekdays)
14637 (defun org-read-date-get-relative (s today default)
14638 "Check string S for special relative date string.
14639 TODAY and DEFAULT are internal times, for today and for a default.
14640 Return shift list (N what def-flag)
14642 N is the number of WHATs to shift.
14643 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14644 the DEFAULT date rather than TODAY."
14645 (when (and
14646 (string-match
14647 (concat
14652 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14653 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14654 (string-to-char (substring (match-string 1 s) -1))
14655 ?+))
14656 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14657 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14658 (what (if (match-end 3) (match-string 3 s) "d"))
14659 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14660 (date (if rel default today))
14661 (wday (nth 6 (decode-time date)))
14662 delta)
14663 (if wday1
14664 (progn
14665 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14666 (if (= dir ?-) (setq delta (- delta 7)))
14667 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14668 (list delta "d" rel))
14669 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14671 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14672 "Turn a user-specified date into the internal representation.
14673 The internal representation needed by the calendar is (month day year).
14674 This is a wrapper to handle the brain-dead convention in calendar that
14675 user function argument order change dependent on argument order."
14676 (if (boundp 'calendar-date-style)
14677 (cond
14678 ((eq calendar-date-style 'american)
14679 (list arg1 arg2 arg3))
14680 ((eq calendar-date-style 'european)
14681 (list arg2 arg1 arg3))
14682 ((eq calendar-date-style 'iso)
14683 (list arg2 arg3 arg1)))
14684 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14685 (if (org-bound-and-true-p european-calendar-style)
14686 (list arg2 arg1 arg3)
14687 (list arg1 arg2 arg3)))))
14689 (defun org-eval-in-calendar (form &optional keepdate)
14690 "Eval FORM in the calendar window and return to current window.
14691 Also, store the cursor date in variable org-ans2."
14692 (let ((sf (selected-frame))
14693 (sw (selected-window)))
14694 (select-window (get-buffer-window "*Calendar*" t))
14695 (eval form)
14696 (when (and (not keepdate) (calendar-cursor-to-date))
14697 (let* ((date (calendar-cursor-to-date))
14698 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14699 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14700 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14701 (select-window sw)
14702 (org-select-frame-set-input-focus sf)))
14704 (defun org-calendar-select ()
14705 "Return to `org-read-date' with the date currently selected.
14706 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14707 (interactive)
14708 (when (calendar-cursor-to-date)
14709 (let* ((date (calendar-cursor-to-date))
14710 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14711 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14712 (if (active-minibuffer-window) (exit-minibuffer))))
14714 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14715 "Insert a date stamp for the date given by the internal TIME.
14716 WITH-HM means use the stamp format that includes the time of the day.
14717 INACTIVE means use square brackets instead of angular ones, so that the
14718 stamp will not contribute to the agenda.
14719 PRE and POST are optional strings to be inserted before and after the
14720 stamp.
14721 The command returns the inserted time stamp."
14722 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14723 stamp)
14724 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14725 (insert-before-markers (or pre ""))
14726 (when (listp extra)
14727 (setq extra (car extra))
14728 (if (and (stringp extra)
14730 (setq extra (format "-%02d:%02d"
14731 (string-to-number (match-string 1 extra))
14732 (string-to-number (match-string 2 extra))))
14733 (setq extra nil)))
14734 (when extra
14735 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14736 (insert-before-markers (setq stamp (format-time-string fmt time)))
14737 (insert-before-markers (or post ""))
14738 (setq org-last-inserted-timestamp stamp)))
14740 (defun org-toggle-time-stamp-overlays ()
14741 "Toggle the use of custom time stamp formats."
14742 (interactive)
14743 (setq org-display-custom-times (not org-display-custom-times))
14744 (unless org-display-custom-times
14745 (let ((p (point-min)) (bmp (buffer-modified-p)))
14746 (while (setq p (next-single-property-change p 'display))
14747 (if (and (get-text-property p 'display)
14748 (eq (get-text-property p 'face) 'org-date))
14749 (remove-text-properties
14750 p (setq p (next-single-property-change p 'display))
14751 '(display t))))
14752 (set-buffer-modified-p bmp)))
14753 (if (featurep 'xemacs)
14754 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14755 (org-restart-font-lock)
14756 (setq org-table-may-need-update t)
14757 (if org-display-custom-times
14758 (message "Time stamps are overlayed with custom format")
14759 (message "Time stamp overlays removed")))
14761 (defun org-display-custom-time (beg end)
14762 "Overlay modified time stamp format over timestamp between BEG and END."
14763 (let* ((ts (buffer-substring beg end))
14764 t1 w1 with-hm tf time str w2 (off 0))
14765 (save-match-data
14766 (setq t1 (org-parse-time-string ts t))
14767 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14768 (setq off (- (match-end 0) (match-beginning 0)))))
14769 (setq end (- end off))
14770 (setq w1 (- end beg)
14771 with-hm (and (nth 1 t1) (nth 2 t1))
14772 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14773 time (org-fix-decoded-time t1)
14774 str (org-add-props
14775 (format-time-string
14776 (substring tf 1 -1) (apply 'encode-time time))
14777 nil 'mouse-face 'highlight)
14778 w2 (length str))
14779 (if (not (= w2 w1))
14780 (add-text-properties (1+ beg) (+ 2 beg)
14781 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14782 (if (featurep 'xemacs)
14783 (progn
14784 (put-text-property beg end 'invisible t)
14785 (put-text-property beg end 'end-glyph (make-glyph str)))
14786 (put-text-property beg end 'display str))))
14788 (defun org-translate-time (string)
14789 "Translate all timestamps in STRING to custom format.
14790 But do this only if the variable `org-display-custom-times' is set."
14791 (when org-display-custom-times
14792 (save-match-data
14793 (let* ((start 0)
14794 (re org-ts-regexp-both)
14795 t1 with-hm inactive tf time str beg end)
14796 (while (setq start (string-match re string start))
14797 (setq beg (match-beginning 0)
14798 end (match-end 0)
14799 t1 (save-match-data
14800 (org-parse-time-string (substring string beg end) t))
14801 with-hm (and (nth 1 t1) (nth 2 t1))
14802 inactive (equal (substring string beg (1+ beg)) "[")
14803 tf (funcall (if with-hm 'cdr 'car)
14804 org-time-stamp-custom-formats)
14805 time (org-fix-decoded-time t1)
14806 str (format-time-string
14807 (concat
14808 (if inactive "[" "<") (substring tf 1 -1)
14809 (if inactive "]" ">"))
14810 (apply 'encode-time time))
14811 string (replace-match str t t string)
14812 start (+ start (length str)))))))
14813 string)
14815 (defun org-fix-decoded-time (time)
14816 "Set 0 instead of nil for the first 6 elements of time.
14817 Don't touch the rest."
14818 (let ((n 0))
14819 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14821 (defun org-days-to-time (timestamp-string)
14822 "Difference between TIMESTAMP-STRING and now in days."
14823 (- (time-to-days (org-time-string-to-time timestamp-string))
14824 (time-to-days (current-time))))
14826 (defun org-deadline-close (timestamp-string &optional ndays)
14827 "Is the time in TIMESTAMP-STRING close to the current date?"
14828 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14829 (and (< (org-days-to-time timestamp-string) ndays)
14830 (not (org-entry-is-done-p))))
14832 (defun org-get-wdays (ts)
14833 "Get the deadline lead time appropriate for timestring TS."
14834 (cond
14835 ((<= org-deadline-warning-days 0)
14836 ;; 0 or negative, enforce this value no matter what
14837 (- org-deadline-warning-days))
14839 ;; lead time is specified.
14840 (floor (* (string-to-number (match-string 1 ts))
14841 (cdr (assoc (match-string 2 ts)
14842 '(("d" . 1) ("w" . 7)
14843 ("m" . 30.4) ("y" . 365.25)))))))
14844 ;; go for the default.
14845 (t org-deadline-warning-days)))
14847 (defun org-calendar-select-mouse (ev)
14848 "Return to `org-read-date' with the date currently selected.
14849 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14850 (interactive "e")
14851 (mouse-set-point ev)
14852 (when (calendar-cursor-to-date)
14853 (let* ((date (calendar-cursor-to-date))
14854 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14855 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14856 (if (active-minibuffer-window) (exit-minibuffer))))
14858 (defun org-check-deadlines (ndays)
14859 "Check if there are any deadlines due or past due.
14860 A deadline is considered due if it happens within `org-deadline-warning-days'
14861 days from today's date. If the deadline appears in an entry marked DONE,
14862 it is not shown. The prefix arg NDAYS can be used to test that many
14864 (interactive "P")
14865 (let* ((org-warn-days
14866 (cond
14867 ((equal ndays '(4)) 100000)
14868 (ndays (prefix-numeric-value ndays))
14869 (t (abs org-deadline-warning-days))))
14870 (case-fold-search nil)
14872 (callback
14873 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14875 (message "%d deadlines past-due or due within %d days"
14876 (org-occur regexp nil callback)
14877 org-warn-days)))
14879 (defun org-check-before-date (date)
14880 "Check if there are deadlines or scheduled entries before DATE."
14881 (interactive (list (org-read-date)))
14882 (let ((case-fold-search nil)
14886 (callback
14887 (lambda () (time-less-p
14888 (org-time-string-to-time (match-string 2))
14889 (org-time-string-to-time date)))))
14890 (message "%d entries before %s"
14891 (org-occur regexp nil callback) date)))
14893 (defun org-check-after-date (date)
14894 "Check if there are deadlines or scheduled entries after DATE."
14895 (interactive (list (org-read-date)))
14896 (let ((case-fold-search nil)
14900 (callback
14901 (lambda () (not
14902 (time-less-p
14903 (org-time-string-to-time (match-string 2))
14904 (org-time-string-to-time date))))))
14905 (message "%d entries after %s"
14906 (org-occur regexp nil callback) date)))
14908 (defun org-evaluate-time-range (&optional to-buffer)
14909 "Evaluate a time range by computing the difference between start and end.
14910 Normally the result is just printed in the echo area, but with prefix arg
14911 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14912 If the time range is actually in a table, the result is inserted into the
14913 next column.
14914 For time difference computation, a year is assumed to be exactly 365
14915 days in order to avoid rounding problems."
14916 (interactive "P")
14917 (or
14918 (org-clock-update-time-maybe)
14919 (save-excursion
14920 (unless (org-at-date-range-p t)
14921 (goto-char (point-at-bol))
14922 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14923 (if (not (org-at-date-range-p t))
14924 (error "Not at a time-stamp range, and none found in current line")))
14925 (let* ((ts1 (match-string 1))
14926 (ts2 (match-string 2))
14927 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14928 (match-end (match-end 0))
14929 (time1 (org-time-string-to-time ts1))
14930 (time2 (org-time-string-to-time ts2))
14931 (t1 (org-float-time time1))
14932 (t2 (org-float-time time2))
14933 (diff (abs (- t2 t1)))
14934 (negative (< (- t2 t1) 0))
14935 ;; (ys (floor (* 365 24 60 60)))
14936 (ds (* 24 60 60))
14937 (hs (* 60 60))
14938 (fy "%dy %dd %02d:%02d")
14939 (fy1 "%dy %dd")
14940 (fd "%dd %02d:%02d")
14941 (fd1 "%dd")
14942 (fh "%02d:%02d")
14943 y d h m align)
14944 (if havetime
14945 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14946 y 0
14947 d (floor (/ diff ds)) diff (mod diff ds)
14948 h (floor (/ diff hs)) diff (mod diff hs)
14949 m (floor (/ diff 60)))
14950 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14951 y 0
14952 d (floor (+ (/ diff ds) 0.5))
14953 h 0 m 0))
14954 (if (not to-buffer)
14955 (message "%s" (org-make-tdiff-string y d h m))
14956 (if (org-at-table-p)
14957 (progn
14958 (goto-char match-end)
14959 (setq align t)
14960 (and (looking-at " *|") (goto-char (match-end 0))))
14961 (goto-char match-end))
14962 (if (looking-at
14964 (replace-match ""))
14965 (if negative (insert " -"))
14966 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14967 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14968 (insert " " (format fh h m))))
14969 (if align (org-table-align))
14970 (message "Time difference inserted")))))
14972 (defun org-make-tdiff-string (y d h m)
14973 (let ((fmt "")
14974 (l nil))
14975 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14976 l (push y l)))
14977 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14978 l (push d l)))
14979 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14980 l (push h l)))
14981 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14982 l (push m l)))
14983 (apply 'format fmt (nreverse l))))
14985 (defun org-time-string-to-time (s)
14986 (apply 'encode-time (org-parse-time-string s)))
14987 (defun org-time-string-to-seconds (s)
14988 (org-float-time (org-time-string-to-time s)))
14990 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14991 "Convert a time stamp to an absolute day number.
14992 If there is a specifier for a cyclic time stamp, get the closest date to
14993 DAYNR.
14994 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14995 The variable date is bound by the calendar when this is called."
14996 (cond
14998 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14999 daynr
15000 (+ daynr 1000)))
15002 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15003 (time-to-days (current-time))) (match-string 0 s)
15004 prefer show-all))
15005 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15007 (defun org-days-to-iso-week (days)
15008 "Return the iso week number."
15009 (require 'cal-iso)
15010 (car (calendar-iso-from-absolute days)))
15012 (defun org-small-year-to-year (year)
15013 "Convert 2-digit years into 4-digit years.
15014 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15015 The year 2000 cannot be abbreviated. Any year larger than 99
15016 is returned unchanged."
15017 (if (< year 38)
15018 (setq year (+ 2000 year))
15019 (if (< year 100)
15020 (setq year (+ 1900 year))))
15021 year)
15023 (defun org-time-from-absolute (d)
15024 "Return the time corresponding to date D.
15025 D may be an absolute day number, or a calendar-type list (month day year)."
15026 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15027 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15029 (defun org-calendar-holiday ()
15030 "List of holidays, for Diary display in Org-mode."
15031 (require 'holidays)
15032 (let ((hl (funcall
15033 (if (fboundp 'calendar-check-holidays)
15034 'calendar-check-holidays 'check-calendar-holidays) date)))
15035 (if hl (mapconcat 'identity hl "; "))))
15037 (defun org-diary-sexp-entry (sexp entry date)
15038 "Process a SEXP diary ENTRY for DATE."
15039 (require 'diary-lib)
15040 (let ((result (if calendar-debug-sexp
15041 (let ((stack-trace-on-error t))
15042 (eval (car (read-from-string sexp))))
15043 (condition-case nil
15044 (eval (car (read-from-string sexp)))
15045 (error
15046 (beep)
15047 (message "Bad sexp at line %d in %s: %s"
15048 (org-current-line)
15049 (buffer-file-name) sexp)
15050 (sleep-for 2))))))
15051 (cond ((stringp result) (split-string result "; "))
15052 ((and (consp result)
15053 (not (consp (cdr result)))
15054 (stringp (cdr result))) (cdr result))
15055 ((and (consp result)
15056 (stringp (car result))) result)
15057 (result entry)
15058 (t nil))))
15060 (defun org-diary-to-ical-string (frombuf)
15061 "Get iCalendar entries from diary entries in buffer FROMBUF.
15062 This uses the icalendar.el library."
15063 (let* ((tmpdir (if (featurep 'xemacs)
15064 (temp-directory)
15065 temporary-file-directory))
15066 (tmpfile (make-temp-name
15067 (expand-file-name "orgics" tmpdir)))
15068 buf rtn b e)
15069 (with-current-buffer frombuf
15070 (icalendar-export-region (point-min) (point-max) tmpfile)
15071 (setq buf (find-buffer-visiting tmpfile))
15072 (set-buffer buf)
15073 (goto-char (point-min))
15074 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15075 (setq b (match-beginning 0)))
15076 (goto-char (point-max))
15077 (if (re-search-backward "^END:VEVENT" nil t)
15078 (setq e (match-end 0)))
15080 (kill-buffer buf)
15081 (delete-file tmpfile)
15082 rtn))
15084 (defun org-closest-date (start current change prefer show-all)
15085 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15086 When PREFER is `past', return a date that is either CURRENT or past.
15087 When PREFER is `future', return a date that is either CURRENT or future.
15088 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15089 ;; Make the proper lists from the dates
15090 (catch 'exit
15091 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15092 dn dw sday cday n1 n2 n0
15093 d m y y1 y2 date1 date2 nmonths nm ny m2)
15095 (setq start (org-date-to-gregorian start)
15096 current (org-date-to-gregorian
15097 (if show-all
15098 current
15099 (time-to-days (current-time))))
15100 sday (calendar-absolute-from-gregorian start)
15101 cday (calendar-absolute-from-gregorian current))
15103 (if (<= cday sday) (throw 'exit sday))
15106 (setq dn (string-to-number (match-string 1 change))
15107 dw (cdr (assoc (match-string 2 change) a1)))
15108 (error "Invalid change specifier: %s" change))
15109 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15110 (cond
15111 ((eq dw 'day)
15112 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15113 n2 (+ n1 dn)))
15114 ((eq dw 'year)
15115 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15116 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15117 (setq date1 (list m d y1)
15118 n1 (calendar-absolute-from-gregorian date1)
15119 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15120 n2 (calendar-absolute-from-gregorian date2)))
15121 ((eq dw 'month)
15122 ;; approx number of month between the two dates
15123 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15124 ;; How often does dn fit in there?
15125 (setq d (nth 1 start) m (car start) y (nth 2 start)
15126 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15127 m (+ m nm)
15128 ny (floor (/ m 12))
15129 y (+ y ny)
15130 m (- m (* ny 12)))
15131 (while (> m 12) (setq m (- m 12) y (1+ y)))
15132 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15133 (setq m2 (+ m dn) y2 y)
15134 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15135 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15136 (while (<= n2 cday)
15137 (setq n1 n2 m m2 y y2)
15138 (setq m2 (+ m dn) y2 y)
15139 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15140 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15141 ;; Make sure n1 is the earlier date
15142 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15143 (if show-all
15144 (cond
15145 ((eq prefer 'past) (if (= cday n2) n2 n1))
15146 ((eq prefer 'future) (if (= cday n1) n1 n2))
15147 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15148 (cond
15149 ((eq prefer 'past) (if (= cday n2) n2 n1))
15150 ((eq prefer 'future) (if (= cday n1) n1 n2))
15151 (t (if (= cday n1) n1 n2)))))))
15153 (defun org-date-to-gregorian (date)
15154 "Turn any specification of DATE into a Gregorian date for the calendar."
15155 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15156 ((and (listp date) (= (length date) 3)) date)
15157 ((stringp date)
15158 (setq date (org-parse-time-string date))
15159 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15160 ((listp date)
15161 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15163 (defun org-parse-time-string (s &optional nodefault)
15164 "Parse the standard Org-mode time string.
15165 This should be a lot faster than the normal `parse-time-string'.
15166 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15167 hour and minute fields will be nil if not given."
15168 (if (string-match org-ts-regexp0 s)
15169 (list 0
15170 (if (or (match-beginning 8) (not nodefault))
15171 (string-to-number (or (match-string 8 s) "0")))
15172 (if (or (match-beginning 7) (not nodefault))
15173 (string-to-number (or (match-string 7 s) "0")))
15174 (string-to-number (match-string 4 s))
15175 (string-to-number (match-string 3 s))
15176 (string-to-number (match-string 2 s))
15177 nil nil nil)
15178 (error "Not a standard Org-mode time string: %s" s)))
15180 (defun org-timestamp-up (&optional arg)
15181 "Increase the date item at the cursor by one.
15182 If the cursor is on the year, change the year. If it is on the month or
15183 the day, change that.
15184 With prefix ARG, change by that many units."
15185 (interactive "p")
15186 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15188 (defun org-timestamp-down (&optional arg)
15189 "Decrease the date item at the cursor by one.
15190 If the cursor is on the year, change the year. If it is on the month or
15191 the day, change that.
15192 With prefix ARG, change by that many units."
15193 (interactive "p")
15194 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15196 (defun org-timestamp-up-day (&optional arg)
15197 "Increase the date in the time stamp by one day.
15198 With prefix ARG, change that many days."
15199 (interactive "p")
15200 (if (and (not (org-at-timestamp-p t))
15201 (org-on-heading-p))
15202 (org-todo 'up)
15203 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15205 (defun org-timestamp-down-day (&optional arg)
15206 "Decrease the date in the time stamp by one day.
15207 With prefix ARG, change that many days."
15208 (interactive "p")
15209 (if (and (not (org-at-timestamp-p t))
15210 (org-on-heading-p))
15211 (org-todo 'down)
15212 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15214 (defun org-at-timestamp-p (&optional inactive-ok)
15215 "Determine if the cursor is in or at a timestamp."
15216 (interactive)
15217 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15218 (pos (point))
15219 (ans (or (looking-at tsr)
15220 (save-excursion
15222 (if (> (point) (point-min)) (backward-char 1))
15223 (and (looking-at tsr)
15224 (> (- (match-end 0) pos) -1))))))
15225 (and ans
15226 (boundp 'org-ts-what)
15227 (setq org-ts-what
15228 (cond
15229 ((= pos (match-beginning 0)) 'bracket)
15230 ((= pos (1- (match-end 0))) 'bracket)
15231 ((org-pos-in-match-range pos 2) 'year)
15232 ((org-pos-in-match-range pos 3) 'month)
15233 ((org-pos-in-match-range pos 7) 'hour)
15234 ((org-pos-in-match-range pos 8) 'minute)
15235 ((or (org-pos-in-match-range pos 4)
15236 (org-pos-in-match-range pos 5)) 'day)
15237 ((and (> pos (or (match-end 8) (match-end 5)))
15238 (< pos (match-end 0)))
15239 (- pos (or (match-end 8) (match-end 5))))
15240 (t 'day))))
15241 ans))
15243 (defun org-toggle-timestamp-type ()
15244 "Toggle the type (<active> or [inactive]) of a time stamp."
15245 (interactive)
15246 (when (org-at-timestamp-p t)
15247 (let ((beg (match-beginning 0)) (end (match-end 0))
15248 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15249 (save-excursion
15250 (goto-char beg)
15251 (while (re-search-forward "[][<>]" end t)
15252 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15253 t t)))
15254 (message "Timestamp is now %sactive"
15255 (if (equal (char-after beg) ?<) "" "in")))))
15257 (defun org-timestamp-change (n &optional what updown)
15258 "Change the date in the time stamp at point.
15259 The date will be changed by N times WHAT. WHAT can be `day', `month',
15260 `year', `minute', `second'. If WHAT is not given, the cursor position
15261 in the timestamp determines what will be changed."
15262 (let ((pos (point))
15263 with-hm inactive
15264 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15265 org-ts-what
15266 extra rem
15267 ts time time0)
15268 (if (not (org-at-timestamp-p t))
15269 (error "Not at a timestamp"))
15270 (if (and (not what) (eq org-ts-what 'bracket))
15271 (org-toggle-timestamp-type)
15272 (if (and (not what) (not (eq org-ts-what 'day))
15273 org-display-custom-times
15274 (get-text-property (point) 'display)
15275 (not (get-text-property (1- (point)) 'display)))
15276 (setq org-ts-what 'day))
15277 (setq org-ts-what (or what org-ts-what)
15278 inactive (= (char-after (match-beginning 0)) ?\[)
15279 ts (match-string 0))
15280 (replace-match "")
15281 (if (string-match
15283 ts)
15284 (setq extra (match-string 1 ts)))
15286 (setq with-hm t))
15287 (setq time0 (org-parse-time-string ts))
15288 (when (and updown
15289 (eq org-ts-what 'minute)
15290 (not current-prefix-arg))
15291 ;; This looks like s-up and s-down. Change by one rounding step.
15292 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15293 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15294 (setcar (cdr time0) (+ (nth 1 time0)
15295 (if (> n 0) (- rem) (- dm rem))))))
15296 (setq time
15297 (encode-time (or (car time0) 0)
15298 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15299 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15300 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15301 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15302 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15303 (nthcdr 6 time0)))
15304 (when (and (member org-ts-what '(hour minute))
15305 extra
15307 (setq extra (org-modify-ts-extra
15308 extra
15309 (if (eq org-ts-what 'hour) 2 5)
15310 n dm)))
15311 (when (integerp org-ts-what)
15312 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15313 (if (eq what 'calendar)
15314 (let ((cal-date (org-get-date-from-calendar)))
15315 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15316 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15317 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15318 (setcar time0 (or (car time0) 0))
15319 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15320 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15321 (setq time (apply 'encode-time time0))))
15322 (setq org-last-changed-timestamp
15323 (org-insert-time-stamp time with-hm inactive nil nil extra))
15324 (org-clock-update-time-maybe)
15325 (goto-char pos)
15326 ;; Try to recenter the calendar window, if any
15327 (if (and org-calendar-follow-timestamp-change
15328 (get-buffer-window "*Calendar*" t)
15329 (memq org-ts-what '(day month year)))
15330 (org-recenter-calendar (time-to-days time))))))
15332 (defun org-modify-ts-extra (s pos n dm)
15333 "Change the different parts of the lead-time and repeat fields in timestamp."
15334 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15335 ng h m new rem)
15336 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15337 (cond
15338 ((or (org-pos-in-match-range pos 2)
15339 (org-pos-in-match-range pos 3))
15340 (setq m (string-to-number (match-string 3 s))
15341 h (string-to-number (match-string 2 s)))
15342 (if (org-pos-in-match-range pos 2)
15343 (setq h (+ h n))
15344 (setq n (* dm (org-no-warnings (signum n))))
15345 (when (not (= 0 (setq rem (% m dm))))
15346 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15347 (setq m (+ m n)))
15348 (if (< m 0) (setq m (+ m 60) h (1- h)))
15349 (if (> m 59) (setq m (- m 60) h (1+ h)))
15350 (setq h (min 24 (max 0 h)))
15351 (setq ng 1 new (format "-%02d:%02d" h m)))
15352 ((org-pos-in-match-range pos 6)
15353 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15354 ((org-pos-in-match-range pos 5)
15355 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15357 ((org-pos-in-match-range pos 9)
15358 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15359 ((org-pos-in-match-range pos 8)
15360 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15362 (when ng
15363 (setq s (concat
15364 (substring s 0 (match-beginning ng))
15365 new
15366 (substring s (match-end ng))))))
15367 s))
15369 (defun org-recenter-calendar (date)
15370 "If the calendar is visible, recenter it to DATE."
15371 (let* ((win (selected-window))
15372 (cwin (get-buffer-window "*Calendar*" t))
15373 (calendar-move-hook nil))
15374 (when cwin
15375 (select-window cwin)
15376 (calendar-goto-date (if (listp date) date
15377 (calendar-gregorian-from-absolute date)))
15378 (select-window win))))
15380 (defun org-goto-calendar (&optional arg)
15381 "Go to the Emacs calendar at the current date.
15382 If there is a time stamp in the current line, go to that date.
15383 A prefix ARG can be used to force the current date."
15384 (interactive "P")
15385 (let ((tsr org-ts-regexp) diff
15386 (calendar-move-hook nil)
15387 (calendar-view-holidays-initially-flag nil)
15388 (calendar-view-diary-initially-flag nil))
15389 (if (or (org-at-timestamp-p)
15390 (save-excursion
15391 (beginning-of-line 1)
15392 (looking-at (concat ".*" tsr))))
15393 (let ((d1 (time-to-days (current-time)))
15394 (d2 (time-to-days
15395 (org-time-string-to-time (match-string 1)))))
15396 (setq diff (- d2 d1))))
15397 (calendar)
15398 (calendar-goto-today)
15399 (if (and diff (not arg)) (calendar-forward-day diff))))
15401 (defun org-get-date-from-calendar ()
15402 "Return a list (month day year) of date at point in calendar."
15403 (with-current-buffer "*Calendar*"
15404 (save-match-data
15405 (calendar-cursor-to-date))))
15407 (defun org-date-from-calendar ()
15408 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15409 If there is already a time stamp at the cursor position, update it."
15410 (interactive)
15411 (if (org-at-timestamp-p t)
15412 (org-timestamp-change 0 'calendar)
15413 (let ((cal-date (org-get-date-from-calendar)))
15414 (org-insert-time-stamp
15415 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15417 (defun org-minutes-to-hh:mm-string (m)
15418 "Compute H:MM from a number of minutes."
15419 (let ((h (/ m 60)))
15420 (setq m (- m (* 60 h)))
15421 (format org-time-clocksum-format h m)))
15423 (defun org-hh:mm-string-to-minutes (s)
15424 "Convert a string H:MM to a number of minutes.
15425 If the string is just a number, interpret it as minutes.
15426 In fact, the first hh:mm or number in the string will be taken,
15427 there can be extra stuff in the string.
15428 If no number is found, the return value is 0."
15429 (cond
15431 (+ (* (string-to-number (match-string 1 s)) 60)
15432 (string-to-number (match-string 2 s))))
15434 (string-to-number (match-string 1 s)))
15435 (t 0)))
15437 ;;;; Files
15439 (defun org-save-all-org-buffers ()
15440 "Save all Org-mode buffers without user confirmation."
15441 (interactive)
15442 (message "Saving all Org-mode buffers...")
15443 (save-some-buffers t 'org-mode-p)
15444 (when (featurep 'org-id) (org-id-locations-save))
15445 (message "Saving all Org-mode buffers... done"))
15447 (defun org-revert-all-org-buffers ()
15448 "Revert all Org-mode buffers.
15449 Prompt for confirmation when there are unsaved changes.
15450 Be sure you know what you are doing before letting this function
15451 overwrite your changes.
15453 This function is useful in a setup where one tracks org files
15454 with a version control system, to revert on one machine after pulling
15455 changes from another. I believe the procedure must be like this:
15457 1. M-x org-save-all-org-buffers
15458 2. Pull changes from the other machine, resolve conflicts
15459 3. M-x org-revert-all-org-buffers"
15460 (interactive)
15461 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15462 (error "Abort"))
15463 (save-excursion
15464 (save-window-excursion
15465 (mapc
15466 (lambda (b)
15467 (when (and (with-current-buffer b (org-mode-p))
15468 (with-current-buffer b buffer-file-name))
15469 (switch-to-buffer b)
15470 (revert-buffer t 'no-confirm)))
15471 (buffer-list))
15472 (when (and (featurep 'org-id) org-id-track-globally)
15473 (org-id-locations-load)))))
15475 ;;;; Agenda files
15477 ;;;###autoload
15478 (defun org-switchb (&optional arg)
15479 "Switch between Org buffers.
15480 With a prefix argument, restrict available to files.
15481 With two prefix arguments, restrict available buffers to agenda files.
15483 Defaults to `iswitchb' for buffer name completion.
15484 Set `org-completion-use-ido' to make it use ido instead."
15485 (interactive "P")
15486 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15487 ((equal arg '(16)) (org-buffer-list 'agenda))
15488 (t (org-buffer-list))))
15489 (org-completion-use-iswitchb org-completion-use-iswitchb)
15490 (org-completion-use-ido org-completion-use-ido))
15491 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15492 (setq org-completion-use-iswitchb t))
15493 (switch-to-buffer
15494 (org-icompleting-read "Org buffer: "
15495 (mapcar 'list (mapcar 'buffer-name blist))
15496 nil t))))
15498 ;;; Define some older names previously used for this functionality
15499 ;;;###autoload
15500 (defalias 'org-ido-switchb 'org-switchb)
15501 ;;;###autoload
15502 (defalias 'org-iswitchb 'org-switchb)
15504 (defun org-buffer-list (&optional predicate exclude-tmp)
15505 "Return a list of Org buffers.
15506 PREDICATE can be `export', `files' or `agenda'.
15508 export restrict the list to Export buffers.
15509 files restrict the list to buffers visiting Org files.
15510 agenda restrict the list to buffers visiting agenda files.
15512 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15513 (let* ((bfn nil)
15514 (agenda-files (and (eq predicate 'agenda)
15515 (mapcar 'file-truename (org-agenda-files t))))
15516 (filter
15517 (cond
15518 ((eq predicate 'files)
15519 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15520 ((eq predicate 'export)
15521 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15522 ((eq predicate 'agenda)
15523 (lambda (b)
15524 (with-current-buffer b
15525 (and (eq major-mode 'org-mode)
15526 (setq bfn (buffer-file-name b))
15527 (member (file-truename bfn) agenda-files)))))
15528 (t (lambda (b) (with-current-buffer b
15529 (or (eq major-mode 'org-mode)
15530 (string-match "\*Org .*Export"
15531 (buffer-name b)))))))))
15532 (delq nil
15533 (mapcar
15534 (lambda(b)
15535 (if (and (funcall filter b)
15536 (or (not exclude-tmp)
15537 (not (string-match "tmp" (buffer-name b)))))
15538 b
15539 nil))
15540 (buffer-list)))))
15542 (defun org-agenda-files (&optional unrestricted archives)
15543 "Get the list of agenda files.
15544 Optional UNRESTRICTED means return the full list even if a restriction
15545 is currently in place.
15546 When ARCHIVES is t, include all archive files that are really being
15547 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15548 `org-agenda-archives-mode' is t."
15549 (let ((files
15550 (cond
15551 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15552 ((stringp org-agenda-files) (org-read-agenda-file-list))
15553 ((listp org-agenda-files) org-agenda-files)
15554 (t (error "Invalid value of `org-agenda-files'")))))
15555 (setq files (apply 'append
15556 (mapcar (lambda (f)
15557 (if (file-directory-p f)
15558 (directory-files
15559 f t org-agenda-file-regexp)
15560 (list f)))
15561 files)))
15562 (when org-agenda-skip-unavailable-files
15563 (setq files (delq nil
15564 (mapcar (function
15565 (lambda (file)
15566 (and (file-readable-p file) file)))
15567 files))))
15568 (when (or (eq archives t)
15569 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15570 (setq files (org-add-archive-files files)))
15571 files))
15573 (defun org-agenda-file-p (&optional file)
15574 "Return non-nil, if FILE is an agenda file.
15575 If FILE is omitted, use the file associated with the current
15576 buffer."
15577 (member (or file (buffer-file-name))
15578 (org-agenda-files t)))
15580 (defun org-edit-agenda-file-list ()
15581 "Edit the list of agenda files.
15582 Depending on setup, this either uses customize to edit the variable
15583 `org-agenda-files', or it visits the file that is holding the list. In the
15584 latter case, the buffer is set up in a way that saving it automatically kills
15585 the buffer and restores the previous window configuration."
15586 (interactive)
15587 (if (stringp org-agenda-files)
15588 (let ((cw (current-window-configuration)))
15589 (find-file org-agenda-files)
15590 (org-set-local 'org-window-configuration cw)
15591 (org-add-hook 'after-save-hook
15592 (lambda ()
15593 (set-window-configuration
15594 (prog1 org-window-configuration
15595 (kill-buffer (current-buffer))))
15596 (org-install-agenda-files-menu)
15597 (message "New agenda file list installed"))
15598 nil 'local)
15599 (message "%s" (substitute-command-keys
15601 (customize-variable 'org-agenda-files)))
15603 (defun org-store-new-agenda-file-list (list)
15604 "Set new value for the agenda file list and save it correctly."
15605 (if (stringp org-agenda-files)
15606 (let ((fe (org-read-agenda-file-list t)) b u)
15607 (while (setq b (find-buffer-visiting org-agenda-files))
15608 (kill-buffer b))
15609 (with-temp-file org-agenda-files
15610 (insert
15611 (mapconcat
15612 (lambda (f) ;; Keep un-expanded entries.
15613 (if (setq u (assoc f fe))
15614 (cdr u)
15615 f))
15618 (let ((org-mode-hook nil) (org-inhibit-startup t)
15619 (org-insert-mode-line-in-empty-file nil))
15620 (setq org-agenda-files list)
15621 (customize-save-variable 'org-agenda-files org-agenda-files))))
15623 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15624 "Read the list of agenda files from a file.
15625 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15626 filenames, used by `org-store-new-agenda-file-list' to write back
15627 un-expanded file names."
15628 (when (file-directory-p org-agenda-files)
15629 (error "`org-agenda-files' cannot be a single directory"))
15630 (when (stringp org-agenda-files)
15631 (with-temp-buffer
15632 (insert-file-contents org-agenda-files)
15633 (mapcar
15634 (lambda (f)
15635 (let ((e (expand-file-name (substitute-in-file-name f)
15636 org-directory)))
15637 (if pair-with-expansion
15638 (cons e f)
15639 e)))
15642 ;;;###autoload
15643 (defun org-cycle-agenda-files ()
15644 "Cycle through the files in `org-agenda-files'.
15645 If the current buffer visits an agenda file, find the next one in the list.
15646 If the current buffer does not, find the first agenda file."
15647 (interactive)
15648 (let* ((fs (org-agenda-files t))
15649 (files (append fs (list (car fs))))
15650 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15651 file)
15652 (unless files (error "No agenda files"))
15653 (catch 'exit
15654 (while (setq file (pop files))
15655 (if (equal (file-truename file) tcf)
15656 (when (car files)
15657 (find-file (car files))
15658 (throw 'exit t))))
15659 (find-file (car fs)))
15660 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15662 (defun org-agenda-file-to-front (&optional to-end)
15663 "Move/add the current file to the top of the agenda file list.
15664 If the file is not present in the list, it is added to the front. If it is
15665 present, it is moved there. With optional argument TO-END, add/move to the
15666 end of the list."
15667 (interactive "P")
15668 (let ((org-agenda-skip-unavailable-files nil)
15669 (file-alist (mapcar (lambda (x)
15670 (cons (file-truename x) x))
15671 (org-agenda-files t)))
15672 (ctf (file-truename buffer-file-name))
15673 x had)
15674 (setq x (assoc ctf file-alist) had x)
15676 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15677 (if to-end
15678 (setq file-alist (append (delq x file-alist) (list x)))
15679 (setq file-alist (cons x (delq x file-alist))))
15680 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15681 (org-install-agenda-files-menu)
15682 (message "File %s to %s of agenda file list"
15683 (if had "moved" "added") (if to-end "end" "front"))))
15685 (defun org-remove-file (&optional file)
15686 "Remove current file from the list of files in variable `org-agenda-files'.
15687 These are the files which are being checked for agenda entries.
15688 Optional argument FILE means use this file instead of the current."
15689 (interactive)
15690 (let* ((org-agenda-skip-unavailable-files nil)
15691 (file (or file buffer-file-name))
15692 (true-file (file-truename file))
15693 (afile (abbreviate-file-name file))
15694 (files (delq nil (mapcar
15695 (lambda (x)
15696 (if (equal true-file
15697 (file-truename x))
15698 nil x))
15699 (org-agenda-files t)))))
15700 (if (not (= (length files) (length (org-agenda-files t))))
15701 (progn
15702 (org-store-new-agenda-file-list files)
15703 (org-install-agenda-files-menu)
15704 (message "Removed file: %s" afile))
15705 (message "File was not in list: %s (not removed)" afile))))
15707 (defun org-file-menu-entry (file)
15708 (vector file (list 'find-file file) t))
15710 (defun org-check-agenda-file (file)
15711 "Make sure FILE exists. If not, ask user what to do."
15712 (when (not (file-exists-p file))
15713 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15714 (abbreviate-file-name file))
15715 (let ((r (downcase (read-char-exclusive))))
15716 (cond
15717 ((equal r ?r)
15718 (org-remove-file file)
15719 (throw 'nextfile t))
15720 (t (error "Abort"))))))
15722 (defun org-get-agenda-file-buffer (file)
15723 "Get a buffer visiting FILE. If the buffer needs to be created, add
15724 it to the list of buffers which might be released later."
15725 (let ((buf (org-find-base-buffer-visiting file)))
15726 (if buf
15727 buf ; just return it
15728 ;; Make a new buffer and remember it
15729 (setq buf (find-file-noselect file))
15730 (if buf (push buf org-agenda-new-buffers))
15731 buf)))
15733 (defun org-release-buffers (blist)
15734 "Release all buffers in list, asking the user for confirmation when needed.
15735 When a buffer is unmodified, it is just killed. When modified, it is saved
15736 \(if the user agrees) and then killed."
15737 (let (buf file)
15738 (while (setq buf (pop blist))
15739 (setq file (buffer-file-name buf))
15740 (when (and (buffer-modified-p buf)
15741 file
15742 (y-or-n-p (format "Save file %s? " file)))
15743 (with-current-buffer buf (save-buffer)))
15744 (kill-buffer buf))))
15746 (defun org-prepare-agenda-buffers (files)
15747 "Create buffers for all agenda files, protect archived trees and comments."
15748 (interactive)
15749 (let ((pa '(:org-archived t))
15750 (pc '(:org-comment t))
15751 (pall '(:org-archived t :org-comment t))
15752 (inhibit-read-only t)
15753 (rea (concat ":" org-archive-tag ":"))
15754 bmp file re)
15755 (save-excursion
15756 (save-restriction
15757 (while (setq file (pop files))
15758 (catch 'nextfile
15759 (if (bufferp file)
15760 (set-buffer file)
15761 (org-check-agenda-file file)
15762 (set-buffer (org-get-agenda-file-buffer file)))
15763 (widen)
15764 (setq bmp (buffer-modified-p))
15765 (org-refresh-category-properties)
15766 (setq org-todo-keywords-for-agenda
15767 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15768 (setq org-done-keywords-for-agenda
15769 (append org-done-keywords-for-agenda org-done-keywords))
15770 (setq org-todo-keyword-alist-for-agenda
15771 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15772 (setq org-drawers-for-agenda
15773 (append org-drawers-for-agenda org-drawers))
15774 (setq org-tag-alist-for-agenda
15775 (append org-tag-alist-for-agenda org-tag-alist))
15777 (save-excursion
15778 (remove-text-properties (point-min) (point-max) pall)
15779 (when org-agenda-skip-archived-trees
15780 (goto-char (point-min))
15781 (while (re-search-forward rea nil t)
15782 (if (org-on-heading-p t)
15783 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15784 (goto-char (point-min))
15786 (while (re-search-forward re nil t)
15787 (add-text-properties
15788 (match-beginning 0) (org-end-of-subtree t) pc)))
15789 (set-buffer-modified-p bmp)))))
15790 (setq org-todo-keywords-for-agenda
15791 (org-uniquify org-todo-keywords-for-agenda))
15792 (setq org-todo-keyword-alist-for-agenda
15793 (org-uniquify org-todo-keyword-alist-for-agenda)
15794 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15796 ;;;; Embedded LaTeX
15798 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15799 "Keymap for the minor `org-cdlatex-mode'.")
15801 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15802 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15803 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15804 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15805 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15807 (defvar org-cdlatex-texmathp-advice-is-done nil
15808 "Flag remembering if we have applied the advice to texmathp already.")
15810 (define-minor-mode org-cdlatex-mode
15811 "Toggle the minor `org-cdlatex-mode'.
15812 This mode supports entering LaTeX environment and math in LaTeX fragments
15813 in Org-mode.
15815 nil " OCDL" nil
15816 (when org-cdlatex-mode (require 'cdlatex))
15817 (unless org-cdlatex-texmathp-advice-is-done
15818 (setq org-cdlatex-texmathp-advice-is-done t)
15819 (defadvice texmathp (around org-math-always-on activate)
15820 "Always return t in org-mode buffers.
15821 This is because we want to insert math symbols without dollars even outside
15822 the LaTeX math segments. If Orgmode thinks that point is actually inside
15823 an embedded LaTeX fragment, let texmathp do its job.
15825 (interactive)
15826 (let (p)
15827 (cond
15828 ((not (org-mode-p)) ad-do-it)
15829 ((eq this-command 'cdlatex-math-symbol)
15830 (setq ad-return-value t
15831 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15832 (t
15833 (let ((p (org-inside-LaTeX-fragment-p)))
15834 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15835 (setq ad-return-value t
15836 texmathp-why '("Org-mode embedded math" . 0))
15837 (if p ad-do-it)))))))))
15839 (defun turn-on-org-cdlatex ()
15840 "Unconditionally turn on `org-cdlatex-mode'."
15841 (org-cdlatex-mode 1))
15843 (defun org-inside-LaTeX-fragment-p ()
15844 "Test if point is inside a LaTeX fragment.
15846 sequence appearing also before point.
15847 Even though the matchers for math are configurable, this function assumes
15849 delimiters are skipped when they have been removed by customization.
15850 The return value is nil, or a cons cell with the delimiter and
15851 and the position of this delimiter.
15853 This function does a reasonably good job, but can locally be fooled by
15854 for example currency specifications. For example it will assume being in
15856 fragments that are properly closed, but during editing, we have to live
15857 with the uncertainty caused by missing closing delimiters. This function
15858 looks only before point, not after."
15859 (catch 'exit
15860 (let ((pos (point))
15861 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15862 (lim (progn
15864 (point)))
15865 dd-on str (start 0) m re)
15866 (goto-char pos)
15867 (when dodollar
15869 re (nth 1 (assoc "$" org-latex-regexps)))
15870 (while (string-match re str start)
15871 (cond
15872 ((= (match-end 0) (length str))
15873 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15874 ((= (match-end 0) (- (length str) 5))
15875 (throw 'exit nil))
15876 (t (setq start (match-end 0))))))
15877 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15878 (goto-char pos)
15879 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15880 (and (match-beginning 2) (throw 'exit nil))
15881 ;; count $$
15883 (setq dd-on (not dd-on)))
15884 (goto-char pos)
15885 (if dd-on (cons "$$" m))))))
15887 (defun org-inside-latex-macro-p ()
15888 "Is point inside a LaTeX macro or its arguments?"
15889 (save-match-data
15890 (org-in-regexp
15893 (defun org-try-cdlatex-tab ()
15894 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15895 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15896 - inside a LaTeX fragment, or
15897 - after the first word in a line, where an abbreviation expansion could
15898 insert a LaTeX environment."
15899 (when org-cdlatex-mode
15900 (cond
15901 ((save-excursion
15902 (skip-chars-backward "a-zA-Z0-9*")
15904 (bolp))
15905 (cdlatex-tab) t)
15906 ((org-inside-LaTeX-fragment-p)
15907 (cdlatex-tab) t)
15908 (t nil))))
15910 (defun org-cdlatex-underscore-caret (&optional arg)
15911 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15912 Revert to the normal definition outside of these fragments."
15913 (interactive "P")
15914 (if (org-inside-LaTeX-fragment-p)
15915 (call-interactively 'cdlatex-sub-superscript)
15916 (let (org-cdlatex-mode)
15917 (call-interactively (key-binding (vector last-input-event))))))
15919 (defun org-cdlatex-math-modify (&optional arg)
15920 "Execute `cdlatex-math-modify' in LaTeX fragments.
15921 Revert to the normal definition outside of these fragments."
15922 (interactive "P")
15923 (if (org-inside-LaTeX-fragment-p)
15924 (call-interactively 'cdlatex-math-modify)
15925 (let (org-cdlatex-mode)
15926 (call-interactively (key-binding (vector last-input-event))))))
15928 (defvar org-latex-fragment-image-overlays nil
15929 "List of overlays carrying the images of latex fragments.")
15930 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15932 (defun org-remove-latex-fragment-image-overlays ()
15933 "Remove all overlays with LaTeX fragment images in current buffer."
15934 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15935 (setq org-latex-fragment-image-overlays nil))
15937 (defun org-preview-latex-fragment (&optional subtree)
15938 "Preview the LaTeX fragment at point, or all locally or globally.
15939 If the cursor is in a LaTeX fragment, create the image and overlay
15940 it over the source code. If there is no fragment at point, display
15941 all fragments in the current text, from one headline to the next. With
15942 prefix SUBTREE, display all fragments in the current subtree. With a
15944 the cursor is before the first headline,
15945 display all fragments in the buffer.
15947 (interactive "P")
15948 (org-remove-latex-fragment-image-overlays)
15949 (save-excursion
15950 (save-restriction
15951 (let (beg end at msg)
15952 (cond
15953 ((or (equal subtree '(16))
15954 (not (save-excursion
15955 (re-search-backward (concat "^" outline-regexp) nil t))))
15956 (setq beg (point-min) end (point-max)
15957 msg "Creating images for buffer...%s"))
15958 ((equal subtree '(4))
15959 (org-back-to-heading)
15960 (setq beg (point) end (org-end-of-subtree t)
15961 msg "Creating images for subtree...%s"))
15962 (t
15963 (if (setq at (org-inside-LaTeX-fragment-p))
15964 (goto-char (max (point-min) (- (cdr at) 2)))
15965 (org-back-to-heading))
15966 (setq beg (point) end (progn (outline-next-heading) (point))
15967 msg (if at "Creating image...%s"
15968 "Creating images for entry...%s"))))
15969 (message msg "")
15970 (narrow-to-region beg end)
15971 (goto-char beg)
15972 (org-format-latex
15973 (concat "ltxpng/" (file-name-sans-extension
15974 (file-name-nondirectory
15975 buffer-file-name)))
15976 default-directory 'overlays msg at 'forbuffer 'dvipng)
15977 (message msg "done. Use `C-c C-c' to remove images.")))))
15979 (defvar org-latex-regexps
15981 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15984 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15988 "Regular expressions for matching embedded LaTeX.")
15990 (defvar org-export-have-math nil) ;; dynamic scoping
15991 (defun org-format-latex (prefix &optional dir overlays msg at
15992 forbuffer processing-type)
15993 "Replace LaTeX fragments with links to an image, and produce images.
15994 Some of the options can be changed using the variable
15995 `org-format-latex-options'."
15996 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15997 (let* ((prefixnodir (file-name-nondirectory prefix))
15998 (absprefix (expand-file-name prefix dir))
15999 (todir (file-name-directory absprefix))
16000 (opt org-format-latex-options)
16001 (matchers (plist-get opt :matchers))
16002 (re-list org-latex-regexps)
16003 (org-format-latex-header-extra
16004 (plist-get (org-infile-export-plist) :latex-header-extra))
16005 (cnt 0) txt hash link beg end re e checkdir
16006 executables-checked string
16007 m n block linkfile movefile ov)
16008 ;; Check the different regular expressions
16009 (while (setq e (pop re-list))
16010 (setq m (car e) re (nth 1 e) n (nth 2 e)
16012 (when (member m matchers)
16013 (goto-char (point-min))
16014 (while (re-search-forward re nil t)
16015 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16016 (not (get-text-property (match-beginning n)
16017 'org-protected))
16018 (or (not overlays)
16019 (not (eq (get-char-property (match-beginning n)
16020 'org-overlay-type)
16021 'org-latex-overlay))))
16022 (setq org-export-have-math t)
16023 (cond
16024 ((eq processing-type 'verbatim)
16025 ;; Leave the text verbatim, just protect it
16026 (add-text-properties (match-beginning n) (match-end n)
16027 '(org-protected t)))
16028 ((eq processing-type 'mathjax)
16029 ;; Prepare for MathJax processing
16030 (setq string (match-string n))
16031 (if (member m '("$" "$1"))
16032 (save-excursion
16033 (delete-region (match-beginning n) (match-end n))
16034 (goto-char (match-beginning n))
16037 '(org-protected t))))
16038 (add-text-properties (match-beginning n) (match-end n)
16039 '(org-protected t))))
16040 ((or (eq processing-type 'dvipng) t)
16041 ;; Process to an image
16042 (setq txt (match-string n)
16043 beg (match-beginning n) end (match-end n)
16044 cnt (1+ cnt))
16045 (let (print-length print-level) ; make sure full list is printed
16046 (setq hash (sha1 (prin1-to-string
16047 (list org-format-latex-header
16048 org-format-latex-header-extra
16049 org-export-latex-default-packages-alist
16050 org-export-latex-packages-alist
16051 org-format-latex-options
16052 forbuffer txt)))
16053 linkfile (format "%s_%s.png" prefix hash)
16054 movefile (format "%s_%s.png" absprefix hash)))
16055 (setq link (concat block "[[file:" linkfile "]]" block))
16056 (if msg (message msg cnt))
16057 (goto-char beg)
16058 (unless checkdir ; make sure the directory exists
16059 (setq checkdir t)
16060 (or (file-directory-p todir) (make-directory todir t)))
16062 (unless executables-checked
16063 (org-check-external-command
16064 "latex" "needed to convert LaTeX fragments to images")
16065 (org-check-external-command
16066 "dvipng" "needed to convert LaTeX fragments to images")
16067 (setq executables-checked t))
16069 (unless (file-exists-p movefile)
16070 (org-create-formula-image
16071 txt movefile opt forbuffer))
16072 (if overlays
16073 (progn
16074 (mapc (lambda (o)
16075 (if (eq (overlay-get o 'org-overlay-type)
16076 'org-latex-overlay)
16077 (delete-overlay o)))
16078 (overlays-in beg end))
16079 (setq ov (make-overlay beg end))
16080 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16081 (if (featurep 'xemacs)
16082 (progn
16083 (overlay-put ov 'invisible t)
16084 (overlay-put
16085 ov 'end-glyph
16086 (make-glyph (vector 'png :file movefile))))
16087 (overlay-put
16088 ov 'display
16089 (list 'image :type 'png :file movefile :ascent 'center)))
16090 (push ov org-latex-fragment-image-overlays)
16091 (goto-char end))
16092 (delete-region beg end)
16093 (insert (org-add-props link
16094 (list 'org-latex-src
16095 (replace-regexp-in-string
16098 ;; This function borrows from Ganesh Swami's latex2png.el
16099 (defun org-create-formula-image (string tofile options buffer)
16100 "This calls dvipng."
16101 (require 'org-latex)
16102 (let* ((tmpdir (if (featurep 'xemacs)
16103 (temp-directory)
16104 temporary-file-directory))
16105 (texfilebase (make-temp-name
16106 (expand-file-name "orgtex" tmpdir)))
16107 (texfile (concat texfilebase ".tex"))
16108 (dvifile (concat texfilebase ".dvi"))
16109 (pngfile (concat texfilebase ".png"))
16110 (fnh (if (featurep 'xemacs)
16111 (font-height (get-face-font 'default))
16112 (face-attribute 'default :height nil)))
16113 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16114 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16115 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16116 "Black"))
16117 (bg (or (plist-get options (if buffer :background :html-background))
16118 "Transparent")))
16119 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16120 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16121 (with-temp-file texfile
16122 (insert (org-splice-latex-header
16123 org-format-latex-header
16124 org-export-latex-default-packages-alist
16125 org-export-latex-packages-alist t
16126 org-format-latex-header-extra))
16128 (require 'org-latex)
16129 (org-export-latex-fix-inputenc))
16130 (let ((dir default-directory))
16131 (condition-case nil
16132 (progn
16133 (cd tmpdir)
16134 (call-process "latex" nil nil nil texfile))
16135 (error nil))
16136 (cd dir))
16137 (if (not (file-exists-p dvifile))
16138 (progn (message "Failed to create dvi file from %s" texfile) nil)
16139 (condition-case nil
16140 (call-process "dvipng" nil nil nil
16141 "-fg" fg "-bg" bg
16142 "-D" dpi
16143 ;;"-x" scale "-y" scale
16144 "-T" "tight"
16145 "-o" pngfile
16146 dvifile)
16147 (error nil))
16148 (if (not (file-exists-p pngfile))
16149 (if org-format-latex-signal-error
16150 (error "Failed to create png file from %s" texfile)
16151 (message "Failed to create png file from %s" texfile)
16152 nil)
16153 ;; Use the requested file name and clean up
16154 (copy-file pngfile tofile 'replace)
16155 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16156 (delete-file (concat texfilebase e)))
16157 pngfile))))
16159 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16160 "Fill a LaTeX header template TPL.
16161 In the template, the following place holders will be recognized:
16164 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16166 [NO-PACKAGES] do not include PKG
16167 [EXTRA] the string EXTRA
16168 [NO-EXTRA] do not include EXTRA
16170 For backward compatibility, if both the positive and the negative place
16172 assumed to be present at the end of the template.
16173 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16174 EXTRA is a string.
16175 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16176 (let (rpl (end ""))
16178 (setq rpl (if (or (match-end 1) (not def-pkg))
16179 "" (org-latex-packages-to-string def-pkg snippets-p t))
16180 tpl (replace-match rpl t t tpl))
16181 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16184 (setq rpl (if (or (match-end 1) (not pkg))
16185 "" (org-latex-packages-to-string pkg snippets-p t))
16186 tpl (replace-match rpl t t tpl))
16187 (if pkg (setq end
16189 (org-latex-packages-to-string pkg snippets-p)))))
16192 (setq rpl (if (or (match-end 1) (not extra))
16194 tpl (replace-match rpl t t tpl))
16200 tpl)))
16202 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16204 (setq pkg (mapconcat (lambda(p)
16205 (cond
16206 ((stringp p) p)
16207 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16208 (format "%% Package %s omitted" (cadr p)))
16209 ((equal "" (car p))
16211 (t
16213 (car p) (cadr p)))))
16214 pkg
16218 (defun org-dvipng-color (attr)
16219 "Return an rgb color specification for dvipng."
16220 (apply 'format "rgb %s %s %s"
16221 (mapcar 'org-normalize-color
16222 (color-values (face-attribute 'default attr nil)))))
16224 (defun org-normalize-color (value)
16225 "Return string to be used as color value for an RGB component."
16226 (format "%g" (/ value 65535.0)))
16228 ;; Image display
16231 (defvar org-inline-image-overlays nil)
16232 (make-variable-buffer-local 'org-inline-image-overlays)
16234 (defun org-toggle-inline-images (&optional include-linked)
16235 "Toggle the display of inline images.
16236 INCLUDE-LINKED is passed to `org-display-inline-images'."
16237 (interactive "P")
16238 (if org-inline-image-overlays
16239 (progn
16240 (org-remove-inline-images)
16241 (message "Inline image display turned off"))
16242 (org-display-inline-images include-linked)
16243 (if org-inline-image-overlays
16244 (message "%d images displayed inline"
16245 (length org-inline-image-overlays))
16246 (message "No images to display inline"))))
16248 (defun org-display-inline-images (&optional include-linked refresh beg end)
16249 "Display inline images.
16250 Normally only links without a description part are inlined, because this
16251 is how it will work for export. When INCLUDE-LINKED is set, also links
16252 with a description part will be inlined. This can be nice for a quick
16253 look at those images, but it does not reflect what exported files will look
16254 like.
16255 When REFRESH is set, refresh existing images between BEG and END.
16256 This will create new image displays only if necessary.
16257 BEG and END default to the buffer boundaries."
16258 (interactive "P")
16259 (unless refresh
16260 (org-remove-inline-images)
16261 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16262 (save-excursion
16263 (save-restriction
16264 (widen)
16265 (setq beg (or beg (point-min)) end (or end (point-max)))
16266 (goto-char (point-min))
16268 (substring (org-image-file-name-regexp) 0 -2)
16270 old file ov img)
16271 (while (re-search-forward re end t)
16272 (setq old (get-char-property-and-overlay (match-beginning 1)
16273 'org-image-overlay))
16274 (setq file (expand-file-name
16275 (concat (or (match-string 3) "") (match-string 4))))
16276 (when (file-exists-p file)
16277 (if (and (car-safe old) refresh)
16278 (image-refresh (overlay-get (cdr old) 'display))
16279 (setq img (save-match-data (create-image file)))
16280 (when img
16281 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16282 (overlay-put ov 'display img)
16283 (overlay-put ov 'face 'default)
16284 (overlay-put ov 'org-image-overlay t)
16285 (overlay-put ov 'modification-hooks
16286 (list 'org-display-inline-modification-hook))
16287 (push ov org-inline-image-overlays)))))))))
16289 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16290 "Remove inline-display overlay if a corresponding region is modified."
16291 (let ((inhibit-modification-hooks t))
16292 (when (and ov after)
16293 (delete ov org-inline-image-overlays)
16294 (delete-overlay ov))))
16296 (defun org-remove-inline-images ()
16297 "Remove inline display of images."
16298 (interactive)
16299 (mapc 'delete-overlay org-inline-image-overlays)
16300 (setq org-inline-image-overlays nil))
16302 ;;;; Key bindings
16304 ;; Make `C-c C-x' a prefix key
16305 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16307 ;; TAB key with modifiers
16308 (org-defkey org-mode-map "\C-i" 'org-cycle)
16309 (org-defkey org-mode-map [(tab)] 'org-cycle)
16310 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16311 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16313 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16314 ;; The following line is necessary under Suse GNU/Linux
16315 (unless (featurep 'xemacs)
16316 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16317 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16318 (define-key org-mode-map [backtab] 'org-shifttab)
16320 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16321 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16322 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16324 ;; Cursor keys with modifiers
16325 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16326 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16327 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16328 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16330 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16331 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16332 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16333 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16335 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16336 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16337 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16338 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16340 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16341 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16343 ;; Babel keys
16344 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16345 (mapc (lambda (pair)
16346 (define-key org-babel-map (car pair) (cdr pair)))
16347 org-babel-key-bindings)
16349 ;;; Extra keys for tty access.
16350 ;; We only set them when really needed because otherwise the
16351 ;; menus don't show the simple keys
16353 (when (or org-use-extra-keys
16354 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16355 (not window-system))
16356 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16357 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16358 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16359 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16360 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16361 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16362 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16363 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16364 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16365 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16366 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16367 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16368 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16369 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16370 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16371 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16372 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16373 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16374 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16375 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16376 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16377 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16378 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16379 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16380 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16381 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16382 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16383 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16385 ;; All the other keys
16387 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16388 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16389 (if (boundp 'narrow-map)
16390 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16391 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16392 (if (boundp 'narrow-map)
16393 (org-defkey narrow-map "b" 'org-narrow-to-block)
16394 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16395 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16396 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16397 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16398 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16399 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16400 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16401 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16402 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16403 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16404 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16405 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16406 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16407 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16408 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16409 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16410 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16412 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16413 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16414 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16415 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16416 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16417 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16418 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16419 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16420 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16421 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16422 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16423 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16424 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16425 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16426 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16427 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16428 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16429 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16430 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16432 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16433 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16434 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16435 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16436 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16437 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16438 (org-defkey org-mode-map "\C-c^" 'org-sort)
16439 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16440 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16441 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16442 (org-defkey org-mode-map "\C-m" 'org-return)
16443 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16444 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16445 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16446 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16447 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16448 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16449 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16450 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16451 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16452 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16453 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16454 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16455 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16456 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16457 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16458 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16459 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16460 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16461 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16462 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16463 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16464 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16466 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16467 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16468 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16469 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16471 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16472 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16473 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16474 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16475 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16476 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16477 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16478 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16479 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16480 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16482 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16483 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16484 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16485 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16486 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16487 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16488 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16490 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16491 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16492 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16493 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16494 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16496 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16498 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16500 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16501 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16503 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16506 (when (featurep 'xemacs)
16507 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16510 (defconst org-speed-commands-default
16511 '(
16512 ("Outline Navigation")
16513 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16514 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16515 ("f" . (org-speed-move-safe 'org-forward-same-level))
16516 ("b" . (org-speed-move-safe 'org-backward-same-level))
16517 ("u" . (org-speed-move-safe 'outline-up-heading))
16518 ("j" . org-goto)
16519 ("g" . (org-refile t))
16520 ("Outline Visibility")
16521 ("c" . org-cycle)
16522 ("C" . org-shifttab)
16523 (" " . org-display-outline-path)
16524 ("Outline Structure Editing")
16525 ("U" . org-shiftmetaup)
16526 ("D" . org-shiftmetadown)
16527 ("r" . org-metaright)
16528 ("l" . org-metaleft)
16529 ("R" . org-shiftmetaright)
16530 ("L" . org-shiftmetaleft)
16531 ("i" . (progn (forward-char 1) (call-interactively
16532 'org-insert-heading-respect-content)))
16533 ("^" . org-sort)
16534 ("w" . org-refile)
16535 ("a" . org-archive-subtree-default-with-confirmation)
16536 ("." . org-mark-subtree)
16537 ("Clock Commands")
16538 ("I" . org-clock-in)
16539 ("O" . org-clock-out)
16540 ("Meta Data Editing")
16541 ("t" . org-todo)
16542 ("0" . (org-priority ?\ ))
16543 ("1" . (org-priority ?A))
16544 ("2" . (org-priority ?B))
16545 ("3" . (org-priority ?C))
16546 (";" . org-set-tags-command)
16547 ("e" . org-set-effort)
16548 ("Agenda Views etc")
16549 ("v" . org-agenda)
16550 ("/" . org-sparse-tree)
16551 ("Misc")
16552 ("o" . org-open-at-point)
16553 ("?" . org-speed-command-help)
16554 ("<" . (org-agenda-set-restriction-lock 'subtree))
16555 (">" . (org-agenda-remove-restriction-lock))
16556 )
16557 "The default speed commands.")
16559 (defun org-print-speed-command (e)
16560 (if (> (length (car e)) 1)
16561 (progn
16563 (princ (car e))
16565 (princ (make-string (length (car e)) ?-))
16567 (princ (car e))
16568 (princ " ")
16569 (if (symbolp (cdr e))
16570 (princ (symbol-name (cdr e)))
16571 (prin1 (cdr e)))
16574 (defun org-speed-command-help ()
16575 "Show the available speed commands."
16576 (interactive)
16577 (if (not org-use-speed-commands)
16578 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16579 (with-output-to-temp-buffer "*Help*"
16581 (mapc 'org-print-speed-command org-speed-commands-user)
16584 (mapc 'org-print-speed-command org-speed-commands-default))
16585 (with-current-buffer "*Help*"
16586 (setq truncate-lines t))))
16588 (defun org-speed-move-safe (cmd)
16589 "Execute CMD, but make sure that the cursor always ends up in a headline.
16590 If not, return to the original position and throw an error."
16591 (interactive)
16592 (let ((pos (point)))
16593 (call-interactively cmd)
16594 (unless (and (bolp) (org-on-heading-p))
16595 (goto-char pos)
16596 (error "Boundary reached while executing %s" cmd))))
16598 (defvar org-self-insert-command-undo-counter 0)
16600 (defvar org-table-auto-blank-field) ; defined in org-table.el
16601 (defvar org-speed-command nil)
16603 (defun org-speed-command-default-hook (keys)
16604 "Hook for activating single-letter speed commands.
16605 `org-speed-commands-default' specifies a minimal command set. Use
16606 `org-speed-commands-user' for further customization."
16607 (when (or (and (bolp) (looking-at outline-regexp))
16608 (and (functionp org-use-speed-commands)
16609 (funcall org-use-speed-commands)))
16610 (cdr (assoc keys (append org-speed-commands-user
16611 org-speed-commands-default)))))
16613 (defun org-babel-speed-command-hook (keys)
16614 "Hook for activating single-letter code block commands."
16615 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16616 (cdr (assoc keys org-babel-key-bindings))))
16618 (defcustom org-speed-command-hook
16619 '(org-speed-command-default-hook org-babel-speed-command-hook)
16620 "Hook for activating speed commands at strategic locations.
16621 Hook functions are called in sequence until a valid handler is
16622 found.
16624 Each hook takes a single argument, a user-pressed command key
16625 which is also a `self-insert-command' from the global map.
16627 Within the hook, examine the cursor position and the command key
16628 and return nil or a valid handler as appropriate. Handler could
16629 be one of an interactive command, a function, or a form.
16631 Set `org-use-speed-commands' to non-nil value to enable this
16632 hook. The default setting is `org-speed-command-default-hook'."
16633 :group 'org-structure
16634 :type 'hook)
16636 (defun org-self-insert-command (N)
16637 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16638 If the cursor is in a table looking at whitespace, the whitespace is
16639 overwritten, and the table is not marked as requiring realignment."
16640 (interactive "p")
16641 (cond
16642 ((and org-use-speed-commands
16643 (setq org-speed-command
16644 (run-hook-with-args-until-success
16645 'org-speed-command-hook (this-command-keys))))
16646 (cond
16647 ((commandp org-speed-command)
16648 (setq this-command org-speed-command)
16649 (call-interactively org-speed-command))
16650 ((functionp org-speed-command)
16651 (funcall org-speed-command))
16652 ((and org-speed-command (listp org-speed-command))
16653 (eval org-speed-command))
16654 (t (let (org-use-speed-commands)
16655 (call-interactively 'org-self-insert-command)))))
16656 ((and
16657 (org-table-p)
16658 (progn
16659 ;; check if we blank the field, and if that triggers align
16660 (and (featurep 'org-table) org-table-auto-blank-field
16661 (member last-command
16662 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16664 ;; got extra space, this field does not determine column width
16665 (let (org-table-may-need-update) (org-table-blank-field))
16666 ;; no extra space, this field may determine column width
16667 (org-table-blank-field)))
16668 t)
16669 (eq N 1)
16671 (let (org-table-may-need-update)
16672 (goto-char (1- (match-end 0)))
16673 (delete-backward-char 1)
16674 (goto-char (match-beginning 0))
16675 (self-insert-command N)))
16676 (t
16677 (setq org-table-may-need-update t)
16678 (self-insert-command N)
16679 (org-fix-tags-on-the-fly)
16680 (if org-self-insert-cluster-for-undo
16681 (if (not (eq last-command 'org-self-insert-command))
16682 (setq org-self-insert-command-undo-counter 1)
16683 (if (>= org-self-insert-command-undo-counter 20)
16684 (setq org-self-insert-command-undo-counter 1)
16685 (and (> org-self-insert-command-undo-counter 0)
16686 buffer-undo-list
16687 (not (cadr buffer-undo-list)) ; remove nil entry
16688 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16689 (setq org-self-insert-command-undo-counter
16690 (1+ org-self-insert-command-undo-counter))))))))
16692 (defun org-fix-tags-on-the-fly ()
16693 (when (and (equal (char-after (point-at-bol)) ?*)
16694 (org-on-heading-p))
16695 (org-align-tags-here org-tags-column)))
16697 (defun org-delete-backward-char (N)
16698 "Like `delete-backward-char', insert whitespace at field end in tables.
16699 When deleting backwards, in tables this function will insert whitespace in
16701 still be marked for re-alignment if the field did fill the entire column,
16702 because, in this case the deletion might narrow the column."
16703 (interactive "p")
16704 (if (and (org-table-p)
16705 (eq N 1)
16706 (string-match "|" (buffer-substring (point-at-bol) (point)))
16707 (looking-at ".*?|"))
16708 (let ((pos (point))
16710 (c org-table-may-need-update))
16711 (backward-delete-char N)
16712 (if (not overwrite-mode)
16713 (progn
16714 (skip-chars-forward "^|")
16715 (insert " ")
16716 (goto-char (1- pos))))
16717 ;; noalign: if there were two spaces at the end, this field
16718 ;; does not determine the width of the column.
16719 (if noalign (setq org-table-may-need-update c)))
16720 (backward-delete-char N)
16721 (org-fix-tags-on-the-fly)))
16723 (defun org-delete-char (N)
16724 "Like `delete-char', but insert whitespace at field end in tables.
16725 When deleting characters, in tables this function will insert whitespace in
16727 still be marked for re-alignment if the field did fill the entire column,
16728 because, in this case the deletion might narrow the column."
16729 (interactive "p")
16730 (if (and (org-table-p)
16731 (not (bolp))
16732 (not (= (char-after) ?|))
16733 (eq N 1))
16734 (if (looking-at ".*?|")
16735 (let ((pos (point))
16737 (c org-table-may-need-update))
16738 (replace-match (concat
16739 (substring (match-string 0) 1 -1)
16740 " |"))
16741 (goto-char pos)
16742 ;; noalign: if there were two spaces at the end, this field
16743 ;; does not determine the width of the column.
16744 (if noalign (setq org-table-may-need-update c)))
16745 (delete-char N))
16746 (delete-char N)
16747 (org-fix-tags-on-the-fly)))
16749 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16750 (put 'org-self-insert-command 'delete-selection t)
16751 (put 'orgtbl-self-insert-command 'delete-selection t)
16752 (put 'org-delete-char 'delete-selection 'supersede)
16753 (put 'org-delete-backward-char 'delete-selection 'supersede)
16754 (put 'org-yank 'delete-selection 'yank)
16756 ;; Make `flyspell-mode' delay after some commands
16757 (put 'org-self-insert-command 'flyspell-delayed t)
16758 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16759 (put 'org-delete-char 'flyspell-delayed t)
16760 (put 'org-delete-backward-char 'flyspell-delayed t)
16762 ;; Make pabbrev-mode expand after org-mode commands
16763 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16764 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16766 ;; How to do this: Measure non-white length of current string
16767 ;; If equal to column width, we should realign.
16769 (defun org-remap (map &rest commands)
16770 "In MAP, remap the functions given in COMMANDS.
16771 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16772 (let (new old)
16773 (while commands
16774 (setq old (pop commands) new (pop commands))
16775 (if (fboundp 'command-remapping)
16776 (org-defkey map (vector 'remap old) new)
16777 (substitute-key-definition old new map global-map)))))
16779 (when (eq org-enable-table-editor 'optimized)
16780 ;; If the user wants maximum table support, we need to hijack
16781 ;; some standard editing functions
16782 (org-remap org-mode-map
16783 'self-insert-command 'org-self-insert-command
16784 'delete-char 'org-delete-char
16785 'delete-backward-char 'org-delete-backward-char)
16786 (org-defkey org-mode-map "|" 'org-force-self-insert))
16788 (defvar org-ctrl-c-ctrl-c-hook nil
16789 "Hook for functions attaching themselves to `C-c C-c'.
16790 This can be used to add additional functionality to the C-c C-c key which
16791 executes context-dependent commands.
16792 Each function will be called with no arguments. The function must check
16793 if the context is appropriate for it to act. If yes, it should do its
16794 thing and then return a non-nil value. If the context is wrong,
16795 just do nothing and return nil.")
16797 (defvar org-tab-first-hook nil
16798 "Hook for functions to attach themselves to TAB.
16799 See `org-ctrl-c-ctrl-c-hook' for more information.
16800 This hook runs as the first action when TAB is pressed, even before
16801 `org-cycle' messes around with the `outline-regexp' to cater for
16802 inline tasks and plain list item folding.
16803 If any function in this hook returns t, any other actions that
16804 would have been caused by TAB (such as table field motion or visibility
16805 cycling) will not occur.")
16807 (defvar org-tab-after-check-for-table-hook nil
16808 "Hook for functions to attach themselves to TAB.
16809 See `org-ctrl-c-ctrl-c-hook' for more information.
16810 This hook runs after it has been established that the cursor is not in a
16811 table, but before checking if the cursor is in a headline or if global cycling
16812 should be done.
16813 If any function in this hook returns t, not other actions like visibility
16814 cycling will be done.")
16816 (defvar org-tab-after-check-for-cycling-hook nil
16817 "Hook for functions to attach themselves to TAB.
16818 See `org-ctrl-c-ctrl-c-hook' for more information.
16819 This hook runs after it has been established that not table field motion and
16820 not visibility should be done because of current context. This is probably
16821 the place where a package like yasnippets can hook in.")
16823 (defvar org-tab-before-tab-emulation-hook nil
16824 "Hook for functions to attach themselves to TAB.
16825 See `org-ctrl-c-ctrl-c-hook' for more information.
16826 This hook runs after every other options for TAB have been exhausted, but
16829 (defvar org-metaleft-hook nil
16830 "Hook for functions attaching themselves to `M-left'.
16831 See `org-ctrl-c-ctrl-c-hook' for more information.")
16832 (defvar org-metaright-hook nil
16833 "Hook for functions attaching themselves to `M-right'.
16834 See `org-ctrl-c-ctrl-c-hook' for more information.")
16835 (defvar org-metaup-hook nil
16836 "Hook for functions attaching themselves to `M-up'.
16837 See `org-ctrl-c-ctrl-c-hook' for more information.")
16838 (defvar org-metadown-hook nil
16839 "Hook for functions attaching themselves to `M-down'.
16840 See `org-ctrl-c-ctrl-c-hook' for more information.")
16841 (defvar org-shiftmetaleft-hook nil
16842 "Hook for functions attaching themselves to `M-S-left'.
16843 See `org-ctrl-c-ctrl-c-hook' for more information.")
16844 (defvar org-shiftmetaright-hook nil
16845 "Hook for functions attaching themselves to `M-S-right'.
16846 See `org-ctrl-c-ctrl-c-hook' for more information.")
16847 (defvar org-shiftmetaup-hook nil
16848 "Hook for functions attaching themselves to `M-S-up'.
16849 See `org-ctrl-c-ctrl-c-hook' for more information.")
16850 (defvar org-shiftmetadown-hook nil
16851 "Hook for functions attaching themselves to `M-S-down'.
16852 See `org-ctrl-c-ctrl-c-hook' for more information.")
16853 (defvar org-metareturn-hook nil
16854 "Hook for functions attaching themselves to `M-RET'.
16855 See `org-ctrl-c-ctrl-c-hook' for more information.")
16856 (defvar org-shiftup-hook nil
16857 "Hook for functions attaching themselves to `S-up'.
16858 See `org-ctrl-c-ctrl-c-hook' for more information.")
16859 (defvar org-shiftup-final-hook nil
16860 "Hook for functions attaching themselves to `S-up'.
16861 This one runs after all other options except shift-select have been excluded.
16862 See `org-ctrl-c-ctrl-c-hook' for more information.")
16863 (defvar org-shiftdown-hook nil
16864 "Hook for functions attaching themselves to `S-down'.
16865 See `org-ctrl-c-ctrl-c-hook' for more information.")
16866 (defvar org-shiftdown-final-hook nil
16867 "Hook for functions attaching themselves to `S-down'.
16868 This one runs after all other options except shift-select have been excluded.
16869 See `org-ctrl-c-ctrl-c-hook' for more information.")
16870 (defvar org-shiftleft-hook nil
16871 "Hook for functions attaching themselves to `S-left'.
16872 See `org-ctrl-c-ctrl-c-hook' for more information.")
16873 (defvar org-shiftleft-final-hook nil
16874 "Hook for functions attaching themselves to `S-left'.
16875 This one runs after all other options except shift-select have been excluded.
16876 See `org-ctrl-c-ctrl-c-hook' for more information.")
16877 (defvar org-shiftright-hook nil
16878 "Hook for functions attaching themselves to `S-right'.
16879 See `org-ctrl-c-ctrl-c-hook' for more information.")
16880 (defvar org-shiftright-final-hook nil
16881 "Hook for functions attaching themselves to `S-right'.
16882 This one runs after all other options except shift-select have been excluded.
16883 See `org-ctrl-c-ctrl-c-hook' for more information.")
16885 (defun org-modifier-cursor-error ()
16886 "Throw an error, a modified cursor command was applied in wrong context."
16887 (error "This command is active in special context like tables, headlines or items"))
16889 (defun org-shiftselect-error ()
16890 "Throw an error because Shift-Cursor command was applied in wrong context."
16891 (if (and (boundp 'shift-select-mode) shift-select-mode)
16892 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16893 (error "This command works only in special context like headlines or timestamps")))
16895 (defun org-call-for-shift-select (cmd)
16896 (let ((this-command-keys-shift-translated t))
16897 (call-interactively cmd)))
16899 (defun org-shifttab (&optional arg)
16900 "Global visibility cycling or move to previous table field.
16901 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16902 on context.
16903 See the individual commands for more information."
16904 (interactive "P")
16905 (cond
16906 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16907 ((integerp arg)
16908 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16909 (message "Content view to level: %d" arg)
16910 (org-content (prefix-numeric-value arg2))
16911 (setq org-cycle-global-status 'overview)))
16912 (t (call-interactively 'org-global-cycle))))
16914 (defun org-shiftmetaleft ()
16915 "Promote subtree or delete table column.
16916 Calls `org-promote-subtree', `org-outdent-item',
16917 or `org-table-delete-column', depending on context.
16918 See the individual commands for more information."
16919 (interactive)
16920 (cond
16921 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16922 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16923 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16924 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16925 (t (org-modifier-cursor-error))))
16927 (defun org-shiftmetaright ()
16928 "Demote subtree or insert table column.
16929 Calls `org-demote-subtree', `org-indent-item',
16930 or `org-table-insert-column', depending on context.
16931 See the individual commands for more information."
16932 (interactive)
16933 (cond
16934 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16935 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16936 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16937 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16938 (t (org-modifier-cursor-error))))
16940 (defun org-shiftmetaup (&optional arg)
16941 "Move subtree up or kill table row.
16942 Calls `org-move-subtree-up' or `org-table-kill-row' or
16943 `org-move-item-up' depending on context. See the individual commands
16944 for more information."
16945 (interactive "P")
16946 (cond
16947 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16948 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16949 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16950 ((org-at-item-p) (call-interactively 'org-move-item-up))
16951 (t (org-modifier-cursor-error))))
16953 (defun org-shiftmetadown (&optional arg)
16954 "Move subtree down or insert table row.
16955 Calls `org-move-subtree-down' or `org-table-insert-row' or
16956 `org-move-item-down', depending on context. See the individual
16957 commands for more information."
16958 (interactive "P")
16959 (cond
16960 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16961 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16962 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16963 ((org-at-item-p) (call-interactively 'org-move-item-down))
16964 (t (org-modifier-cursor-error))))
16966 (defsubst org-hidden-tree-error ()
16967 (error
16968 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16970 (defun org-metaleft (&optional arg)
16971 "Promote heading or move table column to left.
16972 Calls `org-do-promote' or `org-table-move-column', depending on context.
16973 With no specific context, calls the Emacs default `backward-word'.
16974 See the individual commands for more information."
16975 (interactive "P")
16976 (cond
16977 ((run-hook-with-args-until-success 'org-metaleft-hook))
16978 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16979 ((or (org-on-heading-p)
16980 (and (org-region-active-p)
16981 (save-excursion
16982 (goto-char (region-beginning))
16983 (org-on-heading-p))))
16984 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16985 (call-interactively 'org-do-promote))
16986 ((or (org-at-item-p)
16987 (and (org-region-active-p)
16988 (save-excursion
16989 (goto-char (region-beginning))
16990 (org-at-item-p))))
16991 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16992 (call-interactively 'org-outdent-item))
16993 (t (call-interactively 'backward-word))))
16995 (defun org-metaright (&optional arg)
16996 "Demote subtree or move table column to right.
16997 Calls `org-do-demote' or `org-table-move-column', depending on context.
16998 With no specific context, calls the Emacs default `forward-word'.
16999 See the individual commands for more information."
17000 (interactive "P")
17001 (cond
17002 ((run-hook-with-args-until-success 'org-metaright-hook))
17003 ((org-at-table-p) (call-interactively 'org-table-move-column))
17004 ((or (org-on-heading-p)
17005 (and (org-region-active-p)
17006 (save-excursion
17007 (goto-char (region-beginning))
17008 (org-on-heading-p))))
17009 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17010 (call-interactively 'org-do-demote))
17011 ((or (org-at-item-p)
17012 (and (org-region-active-p)
17013 (save-excursion
17014 (goto-char (region-beginning))
17015 (org-at-item-p))))
17016 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17017 (call-interactively 'org-indent-item))
17018 (t (call-interactively 'forward-word))))
17020 (defun org-check-for-hidden (what)
17021 "Check if there are hidden headlines/items in the current visual line.
17022 WHAT can be either `headlines' or `items'. If the current line is
17023 an outline or item heading and it has a folded subtree below it,
17024 this function returns t, nil otherwise."
17025 (let ((re (cond
17026 ((eq what 'headlines) (concat "^" org-outline-regexp))
17027 ((eq what 'items) (concat "^" (org-item-re t)))
17028 (t (error "This should not happen"))))
17029 beg end)
17030 (save-excursion
17031 (catch 'exit
17032 (unless (org-region-active-p)
17033 (setq beg (point-at-bol))
17034 (beginning-of-line 2)
17035 (while (and (not (eobp)) ;; this is like `next-line'
17036 (get-char-property (1- (point)) 'invisible))
17037 (beginning-of-line 2))
17038 (setq end (point))
17039 (goto-char beg)
17040 (goto-char (point-at-eol))
17041 (setq end (max end (point)))
17042 (while (re-search-forward re end t)
17043 (if (get-char-property (match-beginning 0) 'invisible)
17044 (throw 'exit t))))
17045 nil))))
17047 (defun org-metaup (&optional arg)
17048 "Move subtree up or move table row up.
17049 Calls `org-move-subtree-up' or `org-table-move-row' or
17050 `org-move-item-up', depending on context. See the individual commands
17051 for more information."
17052 (interactive "P")
17053 (cond
17054 ((run-hook-with-args-until-success 'org-metaup-hook))
17055 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17056 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17057 ((org-at-item-p) (call-interactively 'org-move-item-up))
17058 (t (transpose-lines 1) (beginning-of-line -1))))
17060 (defun org-metadown (&optional arg)
17061 "Move subtree down or move table row down.
17062 Calls `org-move-subtree-down' or `org-table-move-row' or
17063 `org-move-item-down', depending on context. See the individual
17064 commands for more information."
17065 (interactive "P")
17066 (cond
17067 ((run-hook-with-args-until-success 'org-metadown-hook))
17068 ((org-at-table-p) (call-interactively 'org-table-move-row))
17069 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17070 ((org-at-item-p) (call-interactively 'org-move-item-down))
17071 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17073 (defun org-shiftup (&optional arg)
17074 "Increase item in timestamp or increase priority of current headline.
17075 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17076 depending on context. See the individual commands for more information."
17077 (interactive "P")
17078 (cond
17079 ((run-hook-with-args-until-success 'org-shiftup-hook))
17080 ((and org-support-shift-select (org-region-active-p))
17081 (org-call-for-shift-select 'previous-line))
17082 ((org-at-timestamp-p t)
17083 (call-interactively (if org-edit-timestamp-down-means-later
17084 'org-timestamp-down 'org-timestamp-up)))
17085 ((and (not (eq org-support-shift-select 'always))
17086 org-enable-priority-commands
17087 (org-on-heading-p))
17088 (call-interactively 'org-priority-up))
17089 ((and (not org-support-shift-select) (org-at-item-p))
17090 (call-interactively 'org-previous-item))
17091 ((org-clocktable-try-shift 'up arg))
17092 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17093 (org-support-shift-select
17094 (org-call-for-shift-select 'previous-line))
17095 (t (org-shiftselect-error))))
17097 (defun org-shiftdown (&optional arg)
17098 "Decrease item in timestamp or decrease priority of current headline.
17099 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17100 depending on context. See the individual commands for more information."
17101 (interactive "P")
17102 (cond
17103 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17104 ((and org-support-shift-select (org-region-active-p))
17105 (org-call-for-shift-select 'next-line))
17106 ((org-at-timestamp-p t)
17107 (call-interactively (if org-edit-timestamp-down-means-later
17108 'org-timestamp-up 'org-timestamp-down)))
17109 ((and (not (eq org-support-shift-select 'always))
17110 org-enable-priority-commands
17111 (org-on-heading-p))
17112 (call-interactively 'org-priority-down))
17113 ((and (not org-support-shift-select) (org-at-item-p))
17114 (call-interactively 'org-next-item))
17115 ((org-clocktable-try-shift 'down arg))
17116 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17117 (org-support-shift-select
17118 (org-call-for-shift-select 'next-line))
17119 (t (org-shiftselect-error))))
17121 (defun org-shiftright (&optional arg)
17122 "Cycle the thing at point or in the current line, depending on context.
17123 Depending on context, this does one of the following:
17125 - switch a timestamp at point one day into the future
17126 - on a headline, switch to the next TODO keyword.
17127 - on an item, switch entire list to the next bullet type
17128 - on a property line, switch to the next allowed value
17129 - on a clocktable definition line, move time block into the future"
17130 (interactive "P")
17131 (cond
17132 ((run-hook-with-args-until-success 'org-shiftright-hook))
17133 ((and org-support-shift-select (org-region-active-p))
17134 (org-call-for-shift-select 'forward-char))
17135 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17136 ((and (not (eq org-support-shift-select 'always))
17137 (org-on-heading-p))
17138 (let ((org-inhibit-logging
17139 (not org-treat-S-cursor-todo-selection-as-state-change))
17140 (org-inhibit-blocking
17141 (not org-treat-S-cursor-todo-selection-as-state-change)))
17142 (org-call-with-arg 'org-todo 'right)))
17143 ((or (and org-support-shift-select
17144 (not (eq org-support-shift-select 'always))
17145 (org-at-item-bullet-p))
17146 (and (not org-support-shift-select) (org-at-item-p)))
17147 (org-call-with-arg 'org-cycle-list-bullet nil))
17148 ((and (not (eq org-support-shift-select 'always))
17149 (org-at-property-p))
17150 (call-interactively 'org-property-next-allowed-value))
17151 ((org-clocktable-try-shift 'right arg))
17152 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17153 (org-support-shift-select
17154 (org-call-for-shift-select 'forward-char))
17155 (t (org-shiftselect-error))))
17157 (defun org-shiftleft (&optional arg)
17158 "Cycle the thing at point or in the current line, depending on context.
17159 Depending on context, this does one of the following:
17161 - switch a timestamp at point one day into the past
17162 - on a headline, switch to the previous TODO keyword.
17163 - on an item, switch entire list to the previous bullet type
17164 - on a property line, switch to the previous allowed value
17165 - on a clocktable definition line, move time block into the past"
17166 (interactive "P")
17167 (cond
17168 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17169 ((and org-support-shift-select (org-region-active-p))
17170 (org-call-for-shift-select 'backward-char))
17171 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17172 ((and (not (eq org-support-shift-select 'always))
17173 (org-on-heading-p))
17174 (let ((org-inhibit-logging
17175 (not org-treat-S-cursor-todo-selection-as-state-change))
17176 (org-inhibit-blocking
17177 (not org-treat-S-cursor-todo-selection-as-state-change)))
17178 (org-call-with-arg 'org-todo 'left)))
17179 ((or (and org-support-shift-select
17180 (not (eq org-support-shift-select 'always))
17181 (org-at-item-bullet-p))
17182 (and (not org-support-shift-select) (org-at-item-p)))
17183 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17184 ((and (not (eq org-support-shift-select 'always))
17185 (org-at-property-p))
17186 (call-interactively 'org-property-previous-allowed-value))
17187 ((org-clocktable-try-shift 'left arg))
17188 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17189 (org-support-shift-select
17190 (org-call-for-shift-select 'backward-char))
17191 (t (org-shiftselect-error))))
17193 (defun org-shiftcontrolright ()
17194 "Switch to next TODO set."
17195 (interactive)
17196 (cond
17197 ((and org-support-shift-select (org-region-active-p))
17198 (org-call-for-shift-select 'forward-word))
17199 ((and (not (eq org-support-shift-select 'always))
17200 (org-on-heading-p))
17201 (org-call-with-arg 'org-todo 'nextset))
17202 (org-support-shift-select
17203 (org-call-for-shift-select 'forward-word))
17204 (t (org-shiftselect-error))))
17206 (defun org-shiftcontrolleft ()
17207 "Switch to previous TODO set."
17208 (interactive)
17209 (cond
17210 ((and org-support-shift-select (org-region-active-p))
17211 (org-call-for-shift-select 'backward-word))
17212 ((and (not (eq org-support-shift-select 'always))
17213 (org-on-heading-p))
17214 (org-call-with-arg 'org-todo 'previousset))
17215 (org-support-shift-select
17216 (org-call-for-shift-select 'backward-word))
17217 (t (org-shiftselect-error))))
17219 (defun org-ctrl-c-ret ()
17220 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17221 (interactive)
17222 (cond
17223 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17224 (t (call-interactively 'org-insert-heading))))
17226 (defun org-copy-special ()
17227 "Copy region in table or copy current subtree.
17228 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17229 See the individual commands for more information."
17230 (interactive)
17231 (call-interactively
17232 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17234 (defun org-cut-special ()
17235 "Cut region in table or cut current subtree.
17236 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17237 See the individual commands for more information."
17238 (interactive)
17239 (call-interactively
17240 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17242 (defun org-paste-special (arg)
17243 "Paste rectangular region into table, or past subtree relative to level.
17244 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17245 See the individual commands for more information."
17246 (interactive "P")
17247 (if (org-at-table-p)
17248 (org-table-paste-rectangle)
17249 (org-paste-subtree arg)))
17251 (defun org-edit-special (&optional arg)
17252 "Call a special editor for the stuff at point.
17253 When at a table, call the formula editor with `org-table-edit-formulas'.
17254 When at the first line of an src example, call `org-edit-src-code'.
17255 When in an #+include line, visit the include file. Otherwise call
17256 `ffap' to visit the file at point."
17257 (interactive)
17258 ;; possibly prep session before editing source
17259 (when arg
17260 (let* ((info (org-babel-get-src-block-info))
17261 (lang (nth 0 info))
17262 (params (nth 2 info))
17263 (session (cdr (assoc :session params))))
17264 (when (and info session) ;; we are in a source-code block with a session
17265 (funcall
17266 (intern (concat "org-babel-prep-session:" lang)) session params))))
17267 (cond ;; proceed with `org-edit-special'
17268 ((save-excursion
17269 (beginning-of-line 1)
17270 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17271 (find-file (org-trim (match-string 1))))
17272 ((org-edit-src-code))
17273 ((org-edit-fixed-width-region))
17274 ((org-at-table.el-p)
17275 (org-edit-src-code))
17276 ((or (org-at-table-p)
17277 (save-excursion
17278 (beginning-of-line 1)
17280 (call-interactively 'org-table-edit-formulas))
17281 (t (call-interactively 'ffap))))
17283 (defun org-ctrl-c-ctrl-c (&optional arg)
17284 "Set tags in headline, or update according to changed information at point.
17286 This command does many different things, depending on context:
17288 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17289 this is what we do.
17291 - If the cursor is on a statistics cookie, update it.
17293 - If the cursor is in a headline, prompt for tags and insert them
17294 into the current line, aligned to `org-tags-column'. When called
17295 with prefix arg, realign all tags in the current buffer.
17297 - If the cursor is in one of the special #+KEYWORD lines, this
17298 triggers scanning the buffer for these lines and updating the
17299 information.
17301 - If the cursor is inside a table, realign the table. This command
17302 works even if the automatic table editor has been turned off.
17304 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17305 the entire table.
17307 - If the cursor is at a footnote reference or definition, jump to
17308 the corresponding definition or references, respectively.
17310 - If the cursor is a the beginning of a dynamic block, update it.
17312 - If the current buffer is a capture buffer, close note and file it.
17314 - If the cursor is on a <<<target>>>, update radio targets and
17315 corresponding links in this buffer.
17317 - If the cursor is on a numbered item in a plain list, renumber the
17318 ordered list.
17320 - If the cursor is on a checkbox, toggle it.
17322 - If the cursor is on a code block, evaluate it. The variable
17323 `org-confirm-babel-evaluate' can be used to control prompting
17324 before code block evaluation, by default every code block
17325 evaluation requires confirmation. Code block evaluation can be
17326 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17327 (interactive "P")
17328 (let ((org-enable-table-editor t))
17329 (cond
17330 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17331 org-occur-highlights
17332 org-latex-fragment-image-overlays)
17333 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17334 (org-remove-occur-highlights)
17335 (org-remove-latex-fragment-image-overlays)
17336 (message "Temporary highlights/overlays removed from current buffer"))
17337 ((and (local-variable-p 'org-finish-function (current-buffer))
17338 (fboundp org-finish-function))
17339 (funcall org-finish-function))
17340 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17341 ((or (looking-at org-property-start-re)
17342 (org-at-property-p))
17343 (call-interactively 'org-property-action))
17344 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17346 (or (org-on-heading-p) (org-at-item-p)))
17347 (call-interactively 'org-update-statistics-cookies))
17348 ((org-on-heading-p) (call-interactively 'org-set-tags))
17349 ((org-at-table.el-p)
17350 (message "Use C-c ' to edit table.el tables"))
17351 ((org-at-table-p)
17352 (org-table-maybe-eval-formula)
17353 (if arg
17354 (call-interactively 'org-table-recalculate)
17355 (org-table-maybe-recalculate-line))
17356 (call-interactively 'org-table-align)
17357 (orgtbl-send-table 'maybe))
17358 ((or (org-footnote-at-reference-p)
17359 (org-footnote-at-definition-p))
17360 (call-interactively 'org-footnote-action))
17361 ((org-at-item-checkbox-p)
17362 (call-interactively 'org-list-repair)
17363 (call-interactively 'org-toggle-checkbox)
17364 (org-list-send-list 'maybe))
17365 ((org-at-item-p)
17366 (call-interactively 'org-list-repair)
17367 (when arg (call-interactively 'org-toggle-checkbox))
17368 (org-list-send-list 'maybe))
17369 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17370 ;; Dynamic block
17371 (beginning-of-line 1)
17372 (save-excursion (org-update-dblock)))
17373 ((save-excursion
17374 (beginning-of-line 1)
17376 (cond
17377 ((equal (match-string 1) "TBLFM")
17378 ;; Recalculate the table before this line
17379 (save-excursion
17380 (beginning-of-line 1)
17382 (if (org-at-table-p)
17383 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17384 (t
17385 (let ((org-inhibit-startup-visibility-stuff t)
17386 (org-startup-align-all-tables nil))
17387 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17388 (message "Local setup has been refreshed"))))
17389 ((org-clock-update-time-maybe))
17390 (t (error "C-c C-c can do nothing useful at this location")))))
17392 (defun org-mode-restart ()
17393 "Restart Org-mode, to scan again for special lines.
17394 Also updates the keyword regular expressions."
17395 (interactive)
17396 (org-mode)
17397 (message "Org-mode restarted"))
17399 (defun org-kill-note-or-show-branches ()
17400 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17401 (interactive)
17402 (if (not org-finish-function)
17403 (progn
17404 (hide-subtree)
17405 (call-interactively 'show-branches))
17406 (let ((org-note-abort t))
17407 (funcall org-finish-function))))
17409 (defun org-return (&optional indent)
17410 "Goto next table row or insert a newline.
17411 Calls `org-table-next-row' or `newline', depending on context.
17412 See the individual commands for more information."
17413 (interactive)
17414 (cond
17415 ((bobp) (if indent (newline-and-indent) (newline)))
17416 ((org-at-table-p)
17417 (org-table-justify-field-maybe)
17418 (call-interactively 'org-table-next-row))
17419 ((and org-return-follows-link
17420 (eq (get-text-property (point) 'face) 'org-link))
17421 (call-interactively 'org-open-at-point))
17422 ((and (org-at-heading-p)
17423 (looking-at
17425 (org-show-entry)
17426 (end-of-line 1)
17427 (newline))
17428 (t (if indent (newline-and-indent) (newline)))))
17430 (defun org-return-indent ()
17431 "Goto next table row or insert a newline and indent.
17432 Calls `org-table-next-row' or `newline-and-indent', depending on
17433 context. See the individual commands for more information."
17434 (interactive)
17435 (org-return t))
17437 (defun org-ctrl-c-star ()
17438 "Compute table, or change heading status of lines.
17439 Calls `org-table-recalculate' or `org-toggle-heading',
17440 depending on context."
17441 (interactive)
17442 (cond
17443 ((org-at-table-p)
17444 (call-interactively 'org-table-recalculate))
17445 (t
17446 ;; Convert all lines in region to list items
17447 (call-interactively 'org-toggle-heading))))
17449 (defun org-ctrl-c-minus ()
17450 "Insert separator line in table or modify bullet status of line.
17451 Also turns a plain line or a region of lines into list items.
17452 Calls `org-table-insert-hline', `org-toggle-item', or
17453 `org-cycle-list-bullet', depending on context."
17454 (interactive)
17455 (cond
17456 ((org-at-table-p)
17457 (call-interactively 'org-table-insert-hline))
17458 ((org-region-active-p)
17459 (call-interactively 'org-toggle-item))
17460 ((org-in-item-p)
17461 (call-interactively 'org-cycle-list-bullet))
17462 (t
17463 (call-interactively 'org-toggle-item))))
17465 (defun org-toggle-item ()
17466 "Convert headings or normal lines to items, items to normal lines.
17467 If there is no active region, only the current line is considered.
17469 If the first line in the region is a headline, convert all headlines to items.
17471 If the first line in the region is an item, convert all items to normal lines.
17473 If the first line is normal text, add an item bullet to each line."
17474 (interactive)
17475 (let (l2 l beg end)
17476 (if (org-region-active-p)
17477 (setq beg (region-beginning) end (region-end))
17478 (setq beg (point-at-bol)
17479 end (min (1+ (point-at-eol)) (point-max))))
17480 (save-excursion
17481 (goto-char end)
17482 (setq l2 (org-current-line))
17483 (goto-char beg)
17484 (beginning-of-line 1)
17485 (setq l (1- (org-current-line)))
17486 (if (org-at-item-p)
17487 ;; We already have items, de-itemize
17488 (while (< (setq l (1+ l)) l2)
17489 (when (org-at-item-p)
17491 (delete-region (point) (match-end 0)))
17492 (beginning-of-line 2))
17493 (if (org-on-heading-p)
17494 ;; Headings, convert to items
17495 (while (< (setq l (1+ l)) l2)
17496 (if (looking-at org-outline-regexp)
17497 (replace-match (org-list-bullet-string "-") t t))
17498 (beginning-of-line 2))
17499 ;; normal lines, turn them into items
17500 (while (< (setq l (1+ l)) l2)
17501 (unless (org-at-item-p)
17503 (replace-match
17505 (beginning-of-line 2)))))))
17507 (defun org-toggle-heading (&optional nstars)
17508 "Convert headings to normal text, or items or text to headings.
17509 If there is no active region, only the current line is considered.
17511 If the first line is a heading, remove the stars from all headlines
17512 in the region.
17514 If the first line is a plain list item, turn all plain list items
17515 into headings.
17517 If the first line is a normal line, turn each and every line in the
17518 region into a heading.
17520 When converting a line into a heading, the number of stars is chosen
17521 such that the lines become children of the current entry. However,
17522 when a prefix argument is given, its value determines the number of
17523 stars to add."
17524 (interactive "P")
17525 (let (l2 l itemp beg end)
17526 (if (org-region-active-p)
17527 (setq beg (region-beginning) end (region-end))
17528 (setq beg (point-at-bol)
17529 end (min (1+ (point-at-eol)) (point-max))))
17530 (save-excursion
17531 (goto-char end)
17532 (setq l2 (org-current-line))
17533 (goto-char beg)
17534 (beginning-of-line 1)
17535 (setq l (1- (org-current-line)))
17536 (if (org-on-heading-p)
17537 ;; We already have headlines, de-star them
17538 (while (< (setq l (1+ l)) l2)
17539 (when (org-on-heading-p t)
17540 (and (looking-at outline-regexp) (replace-match "")))
17541 (beginning-of-line 2))
17542 (setq itemp (org-at-item-p))
17543 (let* ((stars
17544 (if nstars
17545 (make-string (prefix-numeric-value current-prefix-arg)
17546 ?*)
17547 (save-excursion
17548 (if (re-search-backward org-complex-heading-regexp nil t)
17549 (match-string 1) ""))))
17550 (add-stars (cond (nstars "")
17551 ((equal stars "") "*")
17552 (org-odd-levels-only "**")
17553 (t "*")))
17554 (rpl (concat stars add-stars " ")))
17555 (while (< (setq l (1+ l)) l2)
17556 (if itemp
17557 (and (org-at-item-p) (replace-match rpl t t))
17558 (unless (org-on-heading-p)
17560 (replace-match (concat rpl (match-string 2))))))
17561 (beginning-of-line 2)))))))
17563 (defun org-meta-return (&optional arg)
17564 "Insert a new heading or wrap a region in a table.
17565 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17566 See the individual commands for more information."
17567 (interactive "P")
17568 (cond
17569 ((run-hook-with-args-until-success 'org-metareturn-hook))
17570 ((org-at-table-p)
17571 (call-interactively 'org-table-wrap-region))
17572 (t (call-interactively 'org-insert-heading))))
17574 ;;; Menu entries
17576 ;; Define the Org-mode menus
17577 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17578 '("Tbl"
17579 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17580 ["Next Field" org-cycle (org-at-table-p)]
17581 ["Previous Field" org-shifttab (org-at-table-p)]
17582 ["Next Row" org-return (org-at-table-p)]
17583 "--"
17584 ["Blank Field" org-table-blank-field (org-at-table-p)]
17585 ["Edit Field" org-table-edit-field (org-at-table-p)]
17586 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17587 "--"
17588 ("Column"
17589 ["Move Column Left" org-metaleft (org-at-table-p)]
17590 ["Move Column Right" org-metaright (org-at-table-p)]
17591 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17592 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17593 ("Row"
17594 ["Move Row Up" org-metaup (org-at-table-p)]
17595 ["Move Row Down" org-metadown (org-at-table-p)]
17596 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17597 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17598 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17599 "--"
17600 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17601 ("Rectangle"
17602 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17603 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17604 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17605 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17606 "--"
17607 ("Calculate"
17608 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17609 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17610 ["Edit Formulas" org-edit-special (org-at-table-p)]
17611 "--"
17612 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17613 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17614 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17615 "--"
17616 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17617 "--"
17618 ["Sum Column/Rectangle" org-table-sum
17619 (or (org-at-table-p) (org-region-active-p))]
17620 ["Which Column?" org-table-current-column (org-at-table-p)])
17621 ["Debug Formulas"
17622 org-table-toggle-formula-debugger
17623 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17624 ["Show Col/Row Numbers"
17625 org-table-toggle-coordinate-overlays
17626 :style toggle
17627 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17628 "--"
17629 ["Create" org-table-create (and (not (org-at-table-p))
17630 org-enable-table-editor)]
17631 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17632 ["Import from File" org-table-import (not (org-at-table-p))]
17633 ["Export to File" org-table-export (org-at-table-p)]
17634 "--"
17635 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17637 (easy-menu-define org-org-menu org-mode-map "Org menu"
17638 '("Org"
17639 ("Show/Hide"
17640 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17641 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17642 ["Sparse Tree..." org-sparse-tree t]
17643 ["Reveal Context" org-reveal t]
17644 ["Show All" show-all t]
17645 "--"
17646 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17647 "--"
17648 ["New Heading" org-insert-heading t]
17649 ("Navigate Headings"
17650 ["Up" outline-up-heading t]
17651 ["Next" outline-next-visible-heading t]
17652 ["Previous" outline-previous-visible-heading t]
17653 ["Next Same Level" outline-forward-same-level t]
17654 ["Previous Same Level" outline-backward-same-level t]
17655 "--"
17656 ["Jump" org-goto t])
17657 ("Edit Structure"
17658 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17659 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17660 "--"
17661 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17662 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17663 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17664 "--"
17665 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17666 "--"
17667 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17668 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17669 ["Demote Heading" org-metaright (not (org-at-table-p))]
17670 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17671 "--"
17672 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17673 "--"
17674 ["Convert to odd levels" org-convert-to-odd-levels t]
17675 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17676 ("Editing"
17677 ["Emphasis..." org-emphasize t]
17678 ["Edit Source Example" org-edit-special t]
17679 "--"
17680 ["Footnote new/jump" org-footnote-action t]
17681 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17682 ("Archive"
17683 ["Archive (default method)" org-archive-subtree-default t]
17684 "--"
17685 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17686 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17687 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17688 )
17689 "--"
17690 ("Hyperlinks"
17691 ["Store Link (Global)" org-store-link t]
17692 ["Find existing link to here" org-occur-link-in-agenda-files t]
17693 ["Insert Link" org-insert-link t]
17694 ["Follow Link" org-open-at-point t]
17695 "--"
17696 ["Next link" org-next-link t]
17697 ["Previous link" org-previous-link t]
17698 "--"
17699 ["Descriptive Links"
17700 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17701 :style radio
17702 :selected (member '(org-link) buffer-invisibility-spec)]
17703 ["Literal Links"
17704 (progn
17705 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17706 :style radio
17707 :selected (not (member '(org-link) buffer-invisibility-spec))])
17708 "--"
17709 ("TODO Lists"
17710 ["TODO/DONE/-" org-todo t]
17711 ("Select keyword"
17712 ["Next keyword" org-shiftright (org-on-heading-p)]
17713 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17714 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17715 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17716 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17717 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17718 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17719 "--"
17720 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17721 :selected org-enforce-todo-dependencies :style toggle :active t]
17722 "Settings for tree at point"
17723 ["Do Children sequentially" org-toggle-ordered-property :style radio
17724 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17725 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17726 ["Do Children parallel" org-toggle-ordered-property :style radio
17727 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17728 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17729 "--"
17730 ["Set Priority" org-priority t]
17731 ["Priority Up" org-shiftup t]
17732 ["Priority Down" org-shiftdown t]
17733 "--"
17734 ["Get news from all feeds" org-feed-update-all t]
17735 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17736 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17737 ("TAGS and Properties"
17738 ["Set Tags" org-set-tags-command t]
17739 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17740 "--"
17741 ["Set property" org-set-property t]
17742 ["Column view of properties" org-columns t]
17743 ["Insert Column View DBlock" org-insert-columns-dblock t])
17744 ("Dates and Scheduling"
17745 ["Timestamp" org-time-stamp t]
17746 ["Timestamp (inactive)" org-time-stamp-inactive t]
17747 ("Change Date"
17748 ["1 Day Later" org-shiftright t]
17749 ["1 Day Earlier" org-shiftleft t]
17750 ["1 ... Later" org-shiftup t]
17751 ["1 ... Earlier" org-shiftdown t])
17752 ["Compute Time Range" org-evaluate-time-range t]
17753 ["Schedule Item" org-schedule t]
17754 ["Deadline" org-deadline t]
17755 "--"
17756 ["Custom time format" org-toggle-time-stamp-overlays
17757 :style radio :selected org-display-custom-times]
17758 "--"
17759 ["Goto Calendar" org-goto-calendar t]
17760 ["Date from Calendar" org-date-from-calendar t]
17761 "--"
17762 ["Start/Restart Timer" org-timer-start t]
17763 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17764 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17765 ["Insert Timer String" org-timer t]
17766 ["Insert Timer Item" org-timer-item t])
17767 ("Logging work"
17768 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17769 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17770 ["Clock out" org-clock-out t]
17771 ["Clock cancel" org-clock-cancel t]
17772 "--"
17773 ["Mark as default task" org-clock-mark-default-task t]
17774 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17775 ["Goto running clock" org-clock-goto t]
17776 "--"
17777 ["Display times" org-clock-display t]
17778 ["Create clock table" org-clock-report t]
17779 "--"
17780 ["Record DONE time"
17781 (progn (setq org-log-done (not org-log-done))
17782 (message "Switching to %s will %s record a timestamp"
17783 (car org-done-keywords)
17784 (if org-log-done "automatically" "not")))
17785 :style toggle :selected org-log-done])
17786 "--"
17787 ["Agenda Command..." org-agenda t]
17788 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17789 ("File List for Agenda")
17790 ("Special views current file"
17791 ["TODO Tree" org-show-todo-tree t]
17792 ["Check Deadlines" org-check-deadlines t]
17793 ["Timeline" org-timeline t]
17794 ["Tags/Property tree" org-match-sparse-tree t])
17795 "--"
17796 ["Export/Publish..." org-export t]
17797 ("LaTeX"
17798 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17799 :selected org-cdlatex-mode]
17800 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17801 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17802 ["Modify math symbol" org-cdlatex-math-modify
17803 (org-inside-LaTeX-fragment-p)]
17804 ["Insert citation" org-reftex-citation t]
17805 "--"
17806 ["Template for BEAMER" org-insert-beamer-options-template t])
17807 "--"
17808 ("MobileOrg"
17809 ["Push Files and Views" org-mobile-push t]
17810 ["Get Captured and Flagged" org-mobile-pull t]
17811 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17812 "--"
17813 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17814 "--"
17815 ("Documentation"
17816 ["Show Version" org-version t]
17817 ["Info Documentation" org-info t])
17818 ("Customize"
17819 ["Browse Org Group" org-customize t]
17820 "--"
17821 ["Expand This Menu" org-create-customize-menu
17822 (fboundp 'customize-menu-create)])
17823 ["Send bug report" org-submit-bug-report t]
17824 "--"
17825 ("Refresh/Reload"
17826 ["Refresh setup current buffer" org-mode-restart t]
17827 ["Reload Org (after update)" org-reload t]
17828 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17829 ))
17831 (defun org-info (&optional node)
17832 "Read documentation for Org-mode in the info system.
17833 With optional NODE, go directly to that node."
17834 (interactive)
17835 (info (format "(org)%s" (or node ""))))
17837 ;;;###autoload
17838 (defun org-submit-bug-report ()
17839 "Submit a bug report on Org-mode via mail.
17841 Don't hesitate to report any problems or inaccurate documentation.
17843 If you don't have setup sending mail from (X)Emacs, please copy the
17844 output buffer into your mail program, as it gives us important
17845 information about your Org-mode version and configuration."
17846 (interactive)
17847 (require 'reporter)
17848 (org-load-modules-maybe)
17849 (org-require-autoloaded-modules)
17850 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17851 (reporter-submit-bug-report
17852 "emacs-orgmode@gnu.org"
17853 (org-version)
17854 (let (list)
17855 (save-window-excursion
17856 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17857 (delete-other-windows)
17858 (erase-buffer)
17859 (insert "You are about to submit a bug report to the Org-mode mailing list.
17861 We would like to add your full Org-mode and Outline configuration to the
17862 bug report. This greatly simplifies the work of the maintainer and
17863 other experts on the mailing list.
17865 HOWEVER, some variables you have customized may contain private
17866 information. The names of customers, colleagues, or friends, might
17867 appear in the form of file names, tags, todo states, or search strings.
17868 If you answer yes to the prompt, you might want to check and remove
17869 such private information before sending the email.")
17870 (add-text-properties (point-min) (point-max) '(face org-warning))
17871 (when (yes-or-no-p "Include your Org-mode configuration ")
17872 (mapatoms
17873 (lambda (v)
17874 (and (boundp v)
17876 (or (and (symbol-value v)
17878 (and
17879 (get v 'custom-type) (get v 'standard-value)
17880 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17881 (push v list)))))
17882 (kill-buffer (get-buffer "*Warn about privacy*"))
17883 list))
17884 nil nil
17885 "Remember to cover the basics, that is, what you expected to happen and
17886 what in fact did happen. You don't know how to make a good report? See
17888 http://orgmode.org/manual/Feedback.html#Feedback
17890 Your bug report will be posted to the Org-mode mailing list.
17891 ------------------------------------------------------------------------")
17892 (save-excursion
17897 (defun org-install-agenda-files-menu ()
17898 (let ((bl (buffer-list)))
17899 (save-excursion
17900 (while bl
17901 (set-buffer (pop bl))
17902 (if (org-mode-p) (setq bl nil)))
17903 (when (org-mode-p)
17904 (easy-menu-change
17905 '("Org") "File List for Agenda"
17906 (append
17907 (list
17908 ["Edit File List" (org-edit-agenda-file-list) t]
17909 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17910 ["Remove Current File from List" org-remove-file t]
17911 ["Cycle through agenda files" org-cycle-agenda-files t]
17912 ["Occur in all agenda files" org-occur-in-agenda-files t]
17913 "--")
17914 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17916 ;;;; Documentation
17918 ;;;###autoload
17919 (defun org-require-autoloaded-modules ()
17920 (interactive)
17921 (mapc 'require
17922 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17923 org-docbook org-exp org-html org-icalendar
17924 org-id org-latex
17925 org-publish org-remember org-table
17926 org-timer org-xoxo)))
17928 ;;;###autoload
17929 (defun org-reload (&optional uncompiled)
17930 "Reload all org lisp files.
17931 With prefix arg UNCOMPILED, load the uncompiled versions."
17932 (interactive "P")
17933 (require 'find-func)
17935 (dir-org (file-name-directory (org-find-library-name "org")))
17936 (dir-org-contrib (ignore-errors
17937 (file-name-directory
17938 (org-find-library-name "org-contribdir"))))
17939 (babel-files
17940 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17941 (append (list nil "comint" "eval" "exp" "keys"
17942 "lob" "ref" "table" "tangle")
17943 (delq nil
17944 (mapcar
17945 (lambda (lang)
17946 (when (cdr lang) (symbol-name (car lang))))
17947 org-babel-load-languages)))))
17948 (files
17949 (append (directory-files dir-org t file-re)
17950 babel-files
17951 (and dir-org-contrib
17952 (directory-files dir-org-contrib t file-re))))
17953 (remove-re (concat (if (featurep 'xemacs)
17954 "org-colview" "org-colview-xemacs")
17956 (setq files (mapcar 'file-name-sans-extension files))
17957 (setq files (mapcar
17958 (lambda (x) (if (string-match remove-re x) nil x))
17959 files))
17960 (setq files (delq nil files))
17961 (mapc
17962 (lambda (f)
17963 (when (featurep (intern (file-name-nondirectory f)))
17964 (if (and (not uncompiled)
17965 (file-exists-p (concat f ".elc")))
17966 (load (concat f ".elc") nil nil t)
17967 (load (concat f ".el") nil nil t))))
17968 files))
17969 (org-version))
17971 ;;;###autoload
17972 (defun org-customize ()
17973 "Call the customize function with org as argument."
17974 (interactive)
17975 (org-load-modules-maybe)
17976 (org-require-autoloaded-modules)
17977 (customize-browse 'org))
17979 (defun org-create-customize-menu ()
17980 "Create a full customization menu for Org-mode, insert it into the menu."
17981 (interactive)
17982 (org-load-modules-maybe)
17983 (org-require-autoloaded-modules)
17984 (if (fboundp 'customize-menu-create)
17985 (progn
17986 (easy-menu-change
17987 '("Org") "Customize"
17988 `(["Browse Org group" org-customize t]
17989 "--"
17990 ,(customize-menu-create 'org)
17991 ["Set" Custom-set t]
17992 ["Save" Custom-save t]
17993 ["Reset to Current" Custom-reset-current t]
17994 ["Reset to Saved" Custom-reset-saved t]
17995 ["Reset to Standard Settings" Custom-reset-standard t]))
17997 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17999 ;;;; Miscellaneous stuff
18001 ;;; Generally useful functions
18003 (defun org-get-at-bol (property)
18004 "Get text property PROPERTY at beginning of line."
18005 (get-text-property (point-at-bol) property))
18007 (defun org-find-text-property-in-string (prop s)
18008 "Return the first non-nil value of property PROP in string S."
18009 (or (get-text-property 0 prop s)
18010 (get-text-property (or (next-single-property-change 0 prop s) 0)
18011 prop s)))
18013 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18014 "Display the given MESSAGE as a warning."
18015 (if (fboundp 'display-warning)
18016 (display-warning 'org message
18017 (if (featurep 'xemacs) 'warning :warning))
18018 (let ((buf (get-buffer-create "*Org warnings*")))
18019 (with-current-buffer buf
18020 (goto-char (point-max))
18021 (insert "Warning (Org): " message)
18022 (unless (bolp)
18023 (newline)))
18024 (display-buffer buf)
18025 (sit-for 0))))
18027 (defun org-in-commented-line ()
18028 "Is point in a line starting with `#'?"
18029 (equal (char-after (point-at-bol)) ?#))
18031 (defun org-in-indented-comment-line ()
18032 "Is point in a line starting with `#' after some white space?"
18033 (save-excursion
18034 (save-match-data
18035 (goto-char (point-at-bol))
18038 (defun org-in-verbatim-emphasis ()
18039 (save-match-data
18040 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18042 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18043 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18044 (if (and marker (marker-buffer marker)
18045 (buffer-live-p (marker-buffer marker)))
18046 (progn
18047 (switch-to-buffer (marker-buffer marker))
18048 (if (or (> marker (point-max)) (< marker (point-min)))
18049 (widen))
18050 (goto-char marker)
18051 (org-show-context 'org-goto))
18052 (if bookmark
18053 (bookmark-jump bookmark)
18054 (error "Cannot find location"))))
18056 (defun org-quote-csv-field (s)
18057 "Quote field for inclusion in CSV material."
18060 s))
18062 (defun org-force-self-insert (N)
18063 "Needed to enforce self-insert under remapping."
18064 (interactive "p")
18065 (self-insert-command N))
18067 (defun org-string-width (s)
18068 "Compute width of string, ignoring invisible characters.
18069 This ignores character with invisibility property `org-link', and also
18070 characters with property `org-cwidth', because these will become invisible
18071 upon the next fontification round."
18072 (let (b l)
18073 (when (or (eq t buffer-invisibility-spec)
18074 (assq 'org-link buffer-invisibility-spec))
18075 (while (setq b (text-property-any 0 (length s)
18076 'invisible 'org-link s))
18077 (setq s (concat (substring s 0 b)
18078 (substring s (or (next-single-property-change
18079 b 'invisible s) (length s)))))))
18080 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18081 (setq s (concat (substring s 0 b)
18082 (substring s (or (next-single-property-change
18083 b 'org-cwidth s) (length s))))))
18084 (setq l (string-width s) b -1)
18085 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18086 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18087 l))
18089 (defun org-shorten-string (s maxlength)
18090 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18091 If the string is shorter or has length MAXLENGTH, just return the
18092 original string. If it is longer, the functions finds a space in the
18093 string, breaks this string off at that locations and adds three dots
18094 as ellipsis. Including the ellipsis, the string will not be longer
18095 than MAXLENGTH. If finding a good breaking point in the string does
18096 not work, the string is just chopped off in the middle of a word
18097 if necessary."
18098 (if (<= (length s) maxlength)
18099 s
18100 (let* ((n (max (- maxlength 4) 1))
18102 (if (string-match re s)
18103 (concat (match-string 1 s) "...")
18104 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18106 (defun org-get-indentation (&optional line)
18107 "Get the indentation of the current line, interpreting tabs.
18108 When LINE is given, assume it represents a line and compute its indentation."
18109 (if line
18110 (if (string-match "^ *" (org-remove-tabs line))
18111 (match-end 0))
18112 (save-excursion
18113 (beginning-of-line 1)
18115 (current-column))))
18117 (defun org-remove-tabs (s &optional width)
18118 "Replace tabulators in S with spaces.
18119 Assumes that s is a single line, starting in column 0."
18120 (setq width (or width tab-width))
18122 (setq s (replace-match
18123 (make-string
18124 (- (* width (/ (+ (match-beginning 0) width) width))
18125 (match-beginning 0)) ?\ )
18126 t t s)))
18127 s)
18129 (defun org-fix-indentation (line ind)
18130 "Fix indentation in LINE.
18131 IND is a cons cell with target and minimum indentation.
18132 If the current indentation in LINE is smaller than the minimum,
18133 leave it alone. If it is larger than ind, set it to the target."
18134 (let* ((l (org-remove-tabs line))
18135 (i (org-get-indentation l))
18136 (i1 (car ind)) (i2 (cdr ind)))
18137 (if (>= i i2) (setq l (substring line i2)))
18138 (if (> i1 0)
18139 (concat (make-string i1 ?\ ) l)
18140 l)))
18142 (defun org-remove-indentation (code &optional n)
18143 "Remove the maximum common indentation from the lines in CODE.
18144 N may optionally be the number of spaces to remove."
18145 (with-temp-buffer
18146 (insert code)
18147 (org-do-remove-indentation n)
18148 (buffer-string)))
18150 (defun org-do-remove-indentation (&optional n)
18151 "Remove the maximum common indentation from the buffer."
18152 (untabify (point-min) (point-max))
18153 (let ((min 10000) re)
18154 (if n
18155 (setq min n)
18156 (goto-char (point-min))
18158 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18159 (unless (or (= min 0) (= min 10000))
18161 (goto-char (point-min))
18162 (while (re-search-forward re nil t)
18163 (replace-match "")
18164 (end-of-line 1))
18165 min)))
18167 (defun org-fill-template (template alist)
18168 "Find each %key of ALIST in TEMPLATE and replace it."
18169 (let ((case-fold-search nil)
18170 entry key value)
18171 (setq alist (sort (copy-sequence alist)
18172 (lambda (a b) (< (length (car a)) (length (car b))))))
18173 (while (setq entry (pop alist))
18174 (setq template
18175 (replace-regexp-in-string
18176 (concat "%" (regexp-quote (car entry)))
18177 (cdr entry) template t t)))
18178 template))
18180 (defun org-base-buffer (buffer)
18181 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18182 (if (not buffer)
18183 buffer
18184 (or (buffer-base-buffer buffer)
18185 buffer)))
18187 (defun org-trim (s)
18188 "Remove whitespace at beginning and end of string."
18191 s)
18193 (defun org-wrap (string &optional width lines)
18194 "Wrap string to either a number of lines, or a width in characters.
18195 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18196 that costs. If there is a word longer than WIDTH, the text is actually
18197 wrapped to the length of that word.
18198 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18199 many lines, whatever width that takes.
18200 The return value is a list of lines, without newlines at the end."
18202 (maxword (apply 'max (mapcar 'org-string-width words)))
18203 w ll)
18204 (cond (width
18205 (org-do-wrap words (max maxword width)))
18206 (lines
18207 (setq w maxword)
18208 (setq ll (org-do-wrap words maxword))
18209 (if (<= (length ll) lines)
18210 ll
18211 (setq ll words)
18212 (while (> (length ll) lines)
18213 (setq w (1+ w))
18214 (setq ll (org-do-wrap words w)))
18215 ll))
18216 (t (error "Cannot wrap this")))))
18218 (defun org-do-wrap (words width)
18219 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18220 (let (lines line)
18221 (while words
18222 (setq line (pop words))
18223 (while (and words (< (+ (length line) (length (car words))) width))
18224 (setq line (concat line " " (pop words))))
18225 (setq lines (push line lines)))
18226 (nreverse lines)))
18228 (defun org-split-string (string &optional separators)
18229 "Splits STRING into substrings at SEPARATORS.
18230 No empty strings are returned if there are matches at the beginning
18231 and end of string."
18233 (start 0)
18234 notfirst
18235 (list nil))
18236 (while (and (string-match rexp string
18237 (if (and notfirst
18238 (= start (match-beginning 0))
18239 (< start (length string)))
18240 (1+ start) start))
18241 (< (match-beginning 0) (length string)))
18242 (setq notfirst t)
18243 (or (eq (match-beginning 0) 0)
18244 (and (eq (match-beginning 0) (match-end 0))
18245 (eq (match-beginning 0) start))
18246 (setq list
18247 (cons (substring string start (match-beginning 0))
18248 list)))
18249 (setq start (match-end 0)))
18250 (or (eq start (length string))
18251 (setq list
18252 (cons (substring string start)
18253 list)))
18254 (nreverse list)))
18256 (defun org-quote-vert (s)
18258 (while (string-match "|" s)
18260 s)
18262 (defun org-uuidgen-p (s)
18263 "Is S an ID created by UUIDGEN?"
18264 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18266 (defun org-context ()
18267 "Return a list of contexts of the current cursor position.
18268 If several contexts apply, all are returned.
18269 Each context entry is a list with a symbol naming the context, and
18270 two positions indicating start and end of the context. Possible
18271 contexts are:
18273 :headline anywhere in a headline
18274 :headline-stars on the leading stars in a headline
18275 :todo-keyword on a TODO keyword (including DONE) in a headline
18276 :tags on the TAGS in a headline
18277 :priority on the priority cookie in a headline
18278 :item on the first line of a plain list item
18279 :item-bullet on the bullet/number of a plain list item
18280 :checkbox on the checkbox in a plain list item
18281 :table in an org-mode table
18282 :table-special on a special filed in a table
18283 :table-table in a table.el table
18284 :link on a hyperlink
18285 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18286 :target on a <<target>>
18287 :radio-target on a <<<radio-target>>>
18288 :latex-fragment on a LaTeX fragment
18289 :latex-preview on a LaTeX fragment with overlayed preview image
18291 This function expects the position to be visible because it uses font-lock
18292 faces as a help to recognize the following contexts: :table-special, :link,
18293 and :keyword."
18294 (let* ((f (get-text-property (point) 'face))
18295 (faces (if (listp f) f (list f)))
18296 (p (point)) clist o)
18297 ;; First the large context
18298 (cond
18299 ((org-on-heading-p t)
18300 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18301 (when (progn
18302 (beginning-of-line 1)
18303 (looking-at org-todo-line-tags-regexp))
18304 (push (org-point-in-group p 1 :headline-stars) clist)
18305 (push (org-point-in-group p 2 :todo-keyword) clist)
18306 (push (org-point-in-group p 4 :tags) clist))
18307 (goto-char p)
18310 (push (org-point-in-group p 0 :priority) clist)))
18312 ((org-at-item-p)
18313 (push (org-point-in-group p 2 :item-bullet) clist)
18314 (push (list :item (point-at-bol)
18315 (save-excursion (org-end-of-item) (point)))
18316 clist)
18317 (and (org-at-item-checkbox-p)
18318 (push (org-point-in-group p 0 :checkbox) clist)))
18320 ((org-at-table-p)
18321 (push (list :table (org-table-begin) (org-table-end)) clist)
18322 (if (memq 'org-formula faces)
18323 (push (list :table-special
18324 (previous-single-property-change p 'face)
18325 (next-single-property-change p 'face)) clist)))
18326 ((org-at-table-p 'any)
18327 (push (list :table-table) clist)))
18328 (goto-char p)
18330 ;; Now the small context
18331 (cond
18332 ((org-at-timestamp-p)
18333 (push (org-point-in-group p 0 :timestamp) clist))
18334 ((memq 'org-link faces)
18335 (push (list :link
18336 (previous-single-property-change p 'face)
18337 (next-single-property-change p 'face)) clist))
18338 ((memq 'org-special-keyword faces)
18339 (push (list :keyword
18340 (previous-single-property-change p 'face)
18341 (next-single-property-change p 'face)) clist))
18342 ((org-on-target-p)
18343 (push (org-point-in-group p 0 :target) clist)
18344 (goto-char (1- (match-beginning 0)))
18345 (if (looking-at org-radio-target-regexp)
18346 (push (org-point-in-group p 0 :radio-target) clist))
18347 (goto-char p))
18348 ((setq o (car (delq nil
18349 (mapcar
18350 (lambda (x)
18351 (if (memq x org-latex-fragment-image-overlays) x))
18352 (overlays-at (point))))))
18353 (push (list :latex-fragment
18354 (overlay-start o) (overlay-end o)) clist)
18355 (push (list :latex-preview
18356 (overlay-start o) (overlay-end o)) clist))
18357 ((org-inside-LaTeX-fragment-p)
18358 ;; FIXME: positions wrong.
18359 (push (list :latex-fragment (point) (point)) clist)))
18361 (setq clist (nreverse (delq nil clist)))
18362 clist))
18364 ;; FIXME: Compare with at-regexp-p Do we need both?
18365 (defun org-in-regexp (re &optional nlines visually)
18366 "Check if point is inside a match of regexp.
18367 Normally only the current line is checked, but you can include NLINES extra
18368 lines both before and after point into the search.
18369 If VISUALLY is set, require that the cursor is not after the match but
18370 really on, so that the block visually is on the match."
18371 (catch 'exit
18372 (let ((pos (point))
18373 (eol (point-at-eol (+ 1 (or nlines 0))))
18374 (inc (if visually 1 0)))
18375 (save-excursion
18376 (beginning-of-line (- 1 (or nlines 0)))
18377 (while (re-search-forward re eol t)
18378 (if (and (<= (match-beginning 0) pos)
18379 (>= (+ inc (match-end 0)) pos))
18380 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18382 (defun org-at-regexp-p (regexp)
18383 "Is point inside a match of REGEXP in the current line?"
18384 (catch 'exit
18385 (save-excursion
18386 (let ((pos (point)) (end (point-at-eol)))
18387 (beginning-of-line 1)
18388 (while (re-search-forward regexp end t)
18389 (if (and (<= (match-beginning 0) pos)
18390 (>= (match-end 0) pos))
18391 (throw 'exit t)))
18392 nil))))
18394 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18395 "Return t if the current point is between matches of START-RE and END-RE.
18396 This will also return t if point is on one of the two matches or
18397 in an unfinished block. END-RE can be a string or a form
18398 returning a string.
18400 An optional third argument bounds the search for START-RE. It
18401 defaults to previous heading or `point-min'."
18402 (let ((pos (point))
18403 (limit (or bound (save-excursion (outline-previous-heading)))))
18404 (save-excursion
18405 ;; we're on a block when point is on start-re...
18406 (or (org-at-regexp-p start-re)
18407 ;; ... or start-re can be found above...
18408 (and (re-search-backward start-re limit t)
18409 ;; ... but no end-re between start-re and point.
18410 (not (re-search-forward (eval end-re) pos t)))))))
18412 (defun org-occur-in-agenda-files (regexp &optional nlines)
18413 "Call `multi-occur' with buffers for all agenda files."
18415 (let* ((files (org-agenda-files))
18416 (tnames (mapcar 'file-truename files))
18417 (extra org-agenda-text-search-extra-files)
18418 f)
18419 (when (eq (car extra) 'agenda-archives)
18420 (setq extra (cdr extra))
18421 (setq files (org-add-archive-files files)))
18422 (while (setq f (pop extra))
18423 (unless (member (file-truename f) tnames)
18424 (add-to-list 'files f 'append)
18425 (add-to-list 'tnames (file-truename f) 'append)))
18426 (multi-occur
18427 (mapcar (lambda (x)
18428 (with-current-buffer
18429 (or (get-file-buffer x) (find-file-noselect x))
18430 (widen)
18431 (current-buffer)))
18432 files)
18433 regexp)))
18435 (if (boundp 'occur-mode-find-occurrence-hook)
18436 ;; Emacs 23
18437 (add-hook 'occur-mode-find-occurrence-hook
18438 (lambda ()
18439 (when (org-mode-p)
18440 (org-reveal))))
18441 ;; Emacs 22
18442 (defadvice occur-mode-goto-occurrence
18443 (after org-occur-reveal activate)
18444 (and (org-mode-p) (org-reveal)))
18445 (defadvice occur-mode-goto-occurrence-other-window
18446 (after org-occur-reveal activate)
18447 (and (org-mode-p) (org-reveal)))
18448 (defadvice occur-mode-display-occurrence
18449 (after org-occur-reveal activate)
18450 (when (org-mode-p)
18451 (let ((pos (occur-mode-find-occurrence)))
18452 (with-current-buffer (marker-buffer pos)
18453 (save-excursion
18454 (goto-char pos)
18455 (org-reveal)))))))
18457 (defun org-occur-link-in-agenda-files ()
18458 "Create a link and search for it in the agendas.
18459 The link is not stored in `org-stored-links', it is just created
18460 for the search purpose."
18461 (interactive)
18462 (let ((link (condition-case nil
18463 (org-store-link nil)
18464 (error "Unable to create a link to here"))))
18465 (org-occur-in-agenda-files (regexp-quote link))))
18467 (defun org-uniquify (list)
18468 "Remove duplicate elements from LIST."
18469 (let (res)
18470 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18471 res))
18473 (defun org-delete-all (elts list)
18474 "Remove all elements in ELTS from LIST."
18475 (while elts
18476 (setq list (delete (pop elts) list)))
18477 list)
18479 (defun org-count (cl-item cl-seq)
18480 "Count the number of occurrences of ITEM in SEQ.
18481 Taken from `count' in cl-seq.el with all keyword arguments removed."
18482 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18483 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18484 (while (< cl-start cl-end)
18485 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18486 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18487 (setq cl-start (1+ cl-start)))
18488 cl-count))
18490 (defun org-remove-if (predicate seq)
18491 "Remove everything from SEQ that fulfills PREDICATE."
18492 (let (res e)
18493 (while seq
18494 (setq e (pop seq))
18495 (if (not (funcall predicate e)) (push e res)))
18496 (nreverse res)))
18498 (defun org-remove-if-not (predicate seq)
18499 "Remove everything from SEQ that does not fulfill PREDICATE."
18500 (let (res e)
18501 (while seq
18502 (setq e (pop seq))
18503 (if (funcall predicate e) (push e res)))
18504 (nreverse res)))
18506 (defun org-back-over-empty-lines ()
18507 "Move backwards over whitespace, to the beginning of the first empty line.
18508 Returns the number of empty lines passed."
18509 (let ((pos (point)))
18511 ;; (if (cdr (assoc 'heading org-blank-before-new-entry))
18513 ;; (forward-line -1))
18514 (beginning-of-line 2)
18515 (goto-char (min (point) pos))
18516 (count-lines (point) pos)))
18518 (defun org-skip-whitespace ()
18521 (defun org-point-in-group (point group &optional context)
18522 "Check if POINT is in match-group GROUP.
18523 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18524 match. If the match group does not exist or point is not inside it,
18525 return nil."
18526 (and (match-beginning group)
18527 (>= point (match-beginning group))
18528 (<= point (match-end group))
18529 (if context
18530 (list context (match-beginning group) (match-end group))
18531 t)))
18533 (defun org-switch-to-buffer-other-window (&rest args)
18534 "Switch to buffer in a second window on the current frame.
18535 In particular, do not allow pop-up frames.
18536 Returns the newly created buffer."
18537 (let (pop-up-frames special-display-buffer-names special-display-regexps
18538 special-display-function)
18539 (apply 'switch-to-buffer-other-window args)))
18541 (defun org-combine-plists (&rest plists)
18542 "Create a single property list from all plists in PLISTS.
18543 The process starts by copying the first list, and then setting properties
18544 from the other lists. Settings in the last list are the most significant
18545 ones and overrule settings in the other lists."
18546 (let ((rtn (copy-sequence (pop plists)))
18547 p v ls)
18548 (while plists
18549 (setq ls (pop plists))
18550 (while ls
18551 (setq p (pop ls) v (pop ls))
18552 (setq rtn (plist-put rtn p v))))
18553 rtn))
18555 (defun org-move-line-down (arg)
18556 "Move the current line down. With prefix argument, move it past ARG lines."
18557 (interactive "p")
18558 (let ((col (current-column))
18559 beg end pos)
18560 (beginning-of-line 1) (setq beg (point))
18561 (beginning-of-line 2) (setq end (point))
18562 (beginning-of-line (+ 1 arg))
18563 (setq pos (move-marker (make-marker) (point)))
18564 (insert (delete-and-extract-region beg end))
18565 (goto-char pos)
18566 (org-move-to-column col)))
18568 (defun org-move-line-up (arg)
18569 "Move the current line up. With prefix argument, move it past ARG lines."
18570 (interactive "p")
18571 (let ((col (current-column))
18572 beg end pos)
18573 (beginning-of-line 1) (setq beg (point))
18574 (beginning-of-line 2) (setq end (point))
18575 (beginning-of-line (- arg))
18576 (setq pos (move-marker (make-marker) (point)))
18577 (insert (delete-and-extract-region beg end))
18578 (goto-char pos)
18579 (org-move-to-column col)))
18581 (defun org-replace-escapes (string table)
18582 "Replace %-escapes in STRING with values in TABLE.
18584 The sequences in STRING may contain normal field width and padding information,
18586 so values can contain further %-escapes if they are define later in TABLE."
18587 (let ((tbl (copy-alist table))
18588 (case-fold-search nil)
18589 (pchg 0)
18590 e re rpl)
18591 (while (setq e (pop tbl))
18592 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18593 (when (and (cdr e) (string-match re (cdr e)))
18594 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18595 (safe "SREF"))
18596 (add-text-properties 0 3 (list 'sref sref) safe)
18597 (setcdr e (replace-match safe t t (cdr e)))))
18598 (while (string-match re string)
18599 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18600 (cdr e)))
18601 (setq string (replace-match rpl t t string))))
18602 (while (setq pchg (next-property-change pchg string))
18603 (let ((sref (get-text-property pchg 'sref string)))
18604 (when (and sref (string-match "SREF" string pchg))
18605 (setq string (replace-match sref t t string)))))
18606 string))
18608 (defun org-sublist (list start end)
18609 "Return a section of LIST, from START to END.
18610 Counting starts at 1."
18611 (let (rtn (c start))
18612 (setq list (nthcdr (1- start) list))
18613 (while (and list (<= c end))
18614 (push (pop list) rtn)
18615 (setq c (1+ c)))
18616 (nreverse rtn)))
18618 (defun org-find-base-buffer-visiting (file)
18619 "Like `find-buffer-visiting' but always return the base buffer and
18620 not an indirect buffer."
18621 (let ((buf (or (get-file-buffer file)
18622 (find-buffer-visiting file))))
18623 (if buf
18624 (or (buffer-base-buffer buf) buf)
18625 nil)))
18627 (defun org-image-file-name-regexp (&optional extensions)
18628 "Return regexp matching the file names of images.
18629 If EXTENSIONS is given, only match these."
18630 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18631 (image-file-name-regexp)
18632 (let ((image-file-name-extensions
18633 (or extensions
18634 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18635 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18637 (regexp-opt (nconc (mapcar 'upcase
18638 image-file-name-extensions)
18639 image-file-name-extensions)
18640 t)
18643 (defun org-file-image-p (file &optional extensions)
18644 "Return non-nil if FILE is an image."
18645 (save-match-data
18646 (string-match (org-image-file-name-regexp extensions) file)))
18648 (defun org-get-cursor-date ()
18649 "Return the date at cursor in as a time.
18650 This works in the calendar and in the agenda, anywhere else it just
18651 returns the current time."
18652 (let (date day defd)
18653 (cond
18654 ((eq major-mode 'calendar-mode)
18655 (setq date (calendar-cursor-to-date)
18656 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18657 ((eq major-mode 'org-agenda-mode)
18658 (setq day (get-text-property (point) 'day))
18659 (if day
18660 (setq date (calendar-gregorian-from-absolute day)
18661 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18662 (nth 2 date))))))
18663 (or defd (current-time))))
18665 (defvar org-agenda-action-marker (make-marker)
18666 "Marker pointing to the entry for the next agenda action.")
18668 (defun org-mark-entry-for-agenda-action ()
18669 "Mark the current entry as target of an agenda action.
18670 Agenda actions are actions executed from the agenda with the key `k',
18671 which make use of the date at the cursor."
18672 (interactive)
18673 (move-marker org-agenda-action-marker
18674 (save-excursion (org-back-to-heading t) (point))
18675 (current-buffer))
18676 (message
18677 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18679 (defun org-mark-subtree ()
18680 "Mark the current subtree.
18681 This puts point at the start of the current subtree, and mark at the end.
18683 If point is in an inline task, mark that task instead."
18684 (interactive)
18685 (let ((inline-task-p
18686 (and (featurep 'org-inlinetask)
18687 (org-inlinetask-in-task-p)))
18688 (beg))
18689 ;; Get beginning of subtree
18690 (cond
18691 (inline-task-p (org-inlinetask-goto-beginning))
18692 ((org-at-heading-p) (beginning-of-line))
18693 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
18694 (setq beg (point))
18695 ;; Get end of it
18696 (if inline-task-p
18697 (org-inlinetask-goto-end)
18698 (org-end-of-subtree))
18699 ;; Mark zone
18700 (push-mark (point) nil t)
18701 (goto-char beg)))
18703 ;;; Paragraph filling stuff.
18704 ;; We want this to be just right, so use the full arsenal.
18706 (defun org-indent-line-function ()
18707 "Indent line depending on context."
18708 (interactive)
18709 (let* ((pos (point))
18710 (itemp (org-at-item-p))
18711 (case-fold-search t)
18713 (inline-task-p (and (featurep 'org-inlinetask)
18714 (org-inlinetask-in-task-p)))
18715 column bpos bcol tpos tcol)
18716 (beginning-of-line 1)
18717 (cond
18718 ;; Comments
18719 ((looking-at "# ") (setq column 0))
18720 ;; Headings
18722 ;; Literal examples
18724 (setq column (org-get-indentation))) ; do nothing
18725 ;; Drawers
18727 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18728 (save-excursion
18729 (goto-char (1- (match-beginning 1)))
18730 (setq column (current-column))))
18731 ;; Special blocks
18733 (save-excursion
18734 (re-search-backward
18736 (setq column (org-get-indentation (match-string 0))))
18739 (save-excursion
18741 (setq column
18742 (if (equal (downcase (match-string 1)) "src")
18743 ;; src blocks: let `org-edit-src-exit' handle them
18744 (org-get-indentation)
18745 (org-get-indentation (match-string 0)))))
18746 ;; Lists
18747 ((org-in-item-p)
18748 (org-beginning-of-item)
18749 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18750 (setq bpos (match-beginning 1) tpos (match-end 0)
18751 bcol (progn (goto-char bpos) (current-column))
18752 tcol (progn (goto-char tpos) (current-column)))
18753 (if (> tcol (+ bcol org-description-max-indent))
18754 (setq tcol (+ bcol 5)))
18755 (goto-char pos)
18756 (setq column (if itemp (org-get-indentation) tcol)))
18757 ;; This line has nothing special, look at the previous relevant
18758 ;; line to compute indentation
18759 (t
18760 (beginning-of-line 0)
18761 (while (and (not (bobp))
18762 (not (looking-at org-drawer-regexp))
18763 ;; skip comments, verbatim, empty lines, tables,
18764 ;; inline tasks, lists, drawers and blocks
18766 (re-search-backward org-drawer-regexp nil t))
18770 (and (org-in-item-p) (goto-char (org-list-top-point)))
18771 (and (not inline-task-p)
18772 (featurep 'org-inlinetask)
18773 (org-inlinetask-in-task-p)
18774 (or (org-inlinetask-goto-beginning) t))))
18775 (beginning-of-line 0))
18776 (cond
18777 ;; There was an heading above.
18779 (if (not org-adapt-indentation)
18780 (setq column 0)
18781 (goto-char (match-end 0))
18782 (setq column (current-column))))
18783 ;; A drawer had started and is unfinished
18784 ((looking-at org-drawer-regexp)
18785 (goto-char (1- (match-beginning 1)))
18786 (setq column (current-column)))
18787 ;; Else, nothing noticeable found: get indentation and go on.
18788 (t (setq column (org-get-indentation))))))
18789 ;; Now apply indentation and move cursor accordingly
18790 (goto-char pos)
18791 (if (<= (current-column) (current-indentation))
18792 (org-indent-line-to column)
18793 (save-excursion (org-indent-line-to column)))
18794 ;; Special polishing for properties, see `org-property-format'
18795 (setq column (current-column))
18796 (beginning-of-line 1)
18797 (if (looking-at
18799 (replace-match (concat (match-string 1)
18800 (format org-property-format
18801 (match-string 2) (match-string 3)))
18802 t t))
18803 (org-move-to-column column)))
18805 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18806 "Variable to store copy of `adaptive-fill-regexp'.
18807 Since `adaptive-fill-regexp' is set to never match, we need to
18808 store a backup of its value before entering `org-mode' so that
18809 the functionality can be provided as a fall-back.")
18811 (defun org-set-autofill-regexps ()
18812 (interactive)
18813 ;; In the paragraph separator we include headlines, because filling
18814 ;; text in a line directly attached to a headline would otherwise
18815 ;; fill the headline as well.
18818 ;; The paragraph starter includes hand-formatted lists.
18819 (org-set-local
18820 'paragraph-start
18821 (concat
18830 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18831 ;; But only if the user has not turned off tables or fixed-width regions
18832 (org-set-local
18833 'auto-fill-inhibit-regexp
18836 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18837 (concat
18839 (if org-enable-table-editor "|" "")
18840 (if org-enable-fixed-width-editor ":" "")
18841 "]"))))
18842 ;; We use our own fill-paragraph function, to make sure that tables
18843 ;; and fixed-width regions are not wrapped. That function will pass
18844 ;; through to `fill-paragraph' when appropriate.
18845 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18846 ;; Adaptive filling: To get full control, first make sure that
18847 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18848 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18849 (org-set-local 'org-adaptive-fill-regexp-backup
18850 adaptive-fill-regexp))
18852 (org-set-local 'adaptive-fill-function
18853 'org-adaptive-fill-function)
18854 (org-set-local
18855 'align-mode-rules-list
18856 '((org-in-buffer-settings
18858 (modes . '(org-mode))))))
18860 (defun org-fill-paragraph (&optional justify)
18861 "Re-align a table, pass through to fill-paragraph if no table."
18862 (let ((table-p (org-at-table-p))
18863 (table.el-p (org-at-table.el-p)))
18864 (cond ((and (equal (char-after (point-at-bol)) ?*)
18865 (save-excursion (goto-char (point-at-bol))
18866 (looking-at outline-regexp)))
18867 t) ; skip headlines
18868 (table.el-p t) ; skip table.el tables
18869 (table-p (org-table-align) t) ; align org-mode tables
18870 (t nil)))) ; call paragraph-fill
18872 ;; For reference, this is the default value of adaptive-fill-regexp
18875 (defun org-adaptive-fill-function ()
18876 "Return a fill prefix for org-mode files.
18877 In particular, this makes sure hanging paragraphs for hand-formatted lists
18878 work correctly."
18879 (cond
18880 ;; Comment line
18882 (match-string-no-properties 0))
18883 ;; Description list
18885 (save-excursion
18886 (if (> (match-end 1) (+ (match-beginning 1)
18887 org-description-max-indent))
18888 (goto-char (+ (match-beginning 1) 5))
18889 (goto-char (match-end 0)))
18890 (make-string (current-column) ?\ )))
18891 ;; Ordered or unordered list
18893 (save-excursion
18894 (goto-char (match-end 0))
18895 (make-string (current-column) ?\ )))
18896 ;; Other text
18897 ((looking-at org-adaptive-fill-regexp-backup)
18898 (match-string-no-properties 0))))
18900 ;;; Other stuff.
18902 (defun org-toggle-fixed-width-section (arg)
18903 "Toggle the fixed-width export.
18904 If there is no active region, the QUOTE keyword at the current headline is
18905 inserted or removed. When present, it causes the text between this headline
18906 and the next to be exported as fixed-width text, and unmodified.
18907 If there is an active region, this command adds or removes a colon as the
18908 first character of this line. If the first character of a line is a colon,
18909 this line is also exported in fixed-width font."
18910 (interactive "P")
18911 (let* ((cc 0)
18912 (regionp (org-region-active-p))
18913 (beg (if regionp (region-beginning) (point)))
18914 (end (if regionp (region-end)))
18915 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18916 (case-fold-search nil)
18918 off)
18919 (if regionp
18920 (save-excursion
18921 (goto-char beg)
18922 (setq cc (current-column))
18923 (beginning-of-line 1)
18924 (setq off (looking-at re))
18925 (while (> nlines 0)
18926 (setq nlines (1- nlines))
18927 (beginning-of-line 1)
18928 (cond
18929 (arg
18930 (org-move-to-column cc t)
18932 (forward-line -1))
18933 ((and off (looking-at re))
18934 (replace-match "" t t nil 1))
18935 ((not off) (org-move-to-column cc t) (insert ": ")))
18936 (forward-line 1)))
18937 (save-excursion
18938 (org-back-to-heading)
18939 (if (looking-at (concat outline-regexp
18941 (replace-match "" t t nil 1)
18942 (if (looking-at outline-regexp)
18943 (progn
18944 (goto-char (match-end 0))
18945 (insert org-quote-string " "))))))))
18947 (defun org-reftex-citation ()
18948 "Use reftex-citation to insert a citation into the buffer.
18949 This looks for a line like
18951 #+BIBLIOGRAPHY: foo plain option:-d
18953 and derives from it that foo.bib is the bibliography file relevant
18954 for this document. It then installs the necessary environment for RefTeX
18955 to work in this buffer and calls `reftex-citation' to insert a citation
18956 into the buffer.
18958 Export of such citations to both LaTeX and HTML is handled by the contributed
18959 package org-exp-bibtex by Taru Karttunen."
18960 (interactive)
18961 (let ((reftex-docstruct-symbol 'rds)
18963 rds bib)
18964 (save-excursion
18965 (save-restriction
18966 (widen)
18967 (let ((case-fold-search t)
18969 (if (not (save-excursion
18970 (or (re-search-forward re nil t)
18971 (re-search-backward re nil t))))
18972 (error "No bibliography defined in file")
18973 (setq bib (concat (match-string 1) ".bib")
18974 rds (list (list 'bib bib)))))))
18975 (call-interactively 'reftex-citation)))
18977 ;;;; Functions extending outline functionality
18979 (defun org-beginning-of-line (&optional arg)
18980 "Go to the beginning of the current line. If that is invisible, continue
18981 to a visible line beginning. This makes the function of C-a more intuitive.
18982 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18983 first attempt, and only move to after the tags when the cursor is already
18984 beyond the end of the headline."
18985 (interactive "P")
18986 (let ((pos (point))
18987 (special (if (consp org-special-ctrl-a/e)
18988 (car org-special-ctrl-a/e)
18989 org-special-ctrl-a/e))
18990 refpos)
18991 (if (org-bound-and-true-p line-move-visual)
18992 (beginning-of-visual-line 1)
18993 (beginning-of-line 1))
18994 (if (and arg (fboundp 'move-beginning-of-line))
18995 (call-interactively 'move-beginning-of-line)
18996 (if (bobp)
18997 nil
18998 (backward-char 1)
18999 (if (org-truely-invisible-p)
19000 (while (and (not (bobp)) (org-truely-invisible-p))
19001 (backward-char 1)
19002 (beginning-of-line 1))
19003 (forward-char 1))))
19004 (when special
19005 (cond
19006 ((and (looking-at org-complex-heading-regexp)
19007 (= (char-after (match-end 1)) ?\ ))
19008 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19009 (point-at-eol)))
19010 (goto-char
19011 (if (eq special t)
19012 (cond ((> pos refpos) refpos)
19013 ((= pos (point)) refpos)
19014 (t (point)))
19015 (cond ((> pos (point)) (point))
19016 ((not (eq last-command this-command)) (point))
19017 (t refpos)))))
19018 ((org-at-item-p)
19019 (goto-char
19020 (if (eq special t)
19021 (cond ((> pos (match-end 4)) (match-end 4))
19022 ((= pos (point)) (match-end 4))
19023 (t (point)))
19024 (cond ((> pos (point)) (point))
19025 ((not (eq last-command this-command)) (point))
19026 (t (match-end 4))))))))
19027 (org-no-warnings
19028 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19030 (defun org-end-of-line (&optional arg)
19031 "Go to the end of the line.
19032 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19033 first attempt, and only move to after the tags when the cursor is already
19034 beyond the end of the headline."
19035 (interactive "P")
19036 (let ((special (if (consp org-special-ctrl-a/e)
19037 (cdr org-special-ctrl-a/e)
19038 org-special-ctrl-a/e)))
19039 (if (or (not special)
19040 (not (org-on-heading-p))
19041 arg)
19042 (call-interactively
19043 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19044 ((fboundp 'move-end-of-line) 'move-end-of-line)
19045 (t 'end-of-line)))
19046 (let ((pos (point)))
19047 (beginning-of-line 1)
19049 (if (eq special t)
19050 (if (or (< pos (match-beginning 1))
19051 (= pos (match-end 0)))
19052 (goto-char (match-beginning 1))
19053 (goto-char (match-end 0)))
19054 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19055 (goto-char (match-end 0))
19056 (goto-char (match-beginning 1))))
19057 (call-interactively (if (fboundp 'move-end-of-line)
19058 'move-end-of-line
19059 'end-of-line)))))
19060 (org-no-warnings
19061 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19063 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19064 (define-key org-mode-map "\C-e" 'org-end-of-line)
19066 (defun org-backward-sentence (&optional arg)
19067 "Go to beginning of sentence, or beginning of table field.
19068 This will call `backward-sentence' or `org-table-beginning-of-field',
19069 depending on context."
19070 (interactive "P")
19071 (cond
19072 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19073 (t (call-interactively 'backward-sentence))))
19075 (defun org-forward-sentence (&optional arg)
19076 "Go to end of sentence, or end of table field.
19077 This will call `forward-sentence' or `org-table-end-of-field',
19078 depending on context."
19079 (interactive "P")
19080 (cond
19081 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19082 (t (call-interactively 'forward-sentence))))
19084 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19085 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19087 (defun org-kill-line (&optional arg)
19088 "Kill line, to tags or end of line."
19089 (interactive "P")
19090 (cond
19091 ((or (not org-special-ctrl-k)
19092 (bolp)
19093 (not (org-on-heading-p)))
19094 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19095 org-ctrl-k-protect-subtree)
19096 (if (or (eq org-ctrl-k-protect-subtree 'error)
19097 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19098 (error "C-k aborted - would kill hidden subtree")))
19099 (call-interactively 'kill-line))
19101 (kill-region (point) (match-beginning 1))
19102 (org-set-tags nil t))
19103 (t (kill-region (point) (point-at-eol)))))
19105 (define-key org-mode-map "\C-k" 'org-kill-line)
19107 (defun org-yank (&optional arg)
19108 "Yank. If the kill is a subtree, treat it specially.
19109 This command will look at the current kill and check if is a single
19110 subtree, or a series of subtrees[1]. If it passes the test, and if the
19111 cursor is at the beginning of a line or after the stars of a currently
19112 empty headline, then the yank is handled specially. How exactly depends
19113 on the value of the following variables, both set by default.
19115 org-yank-folded-subtrees
19116 When set, the subtree(s) will be folded after insertion, but only
19117 if doing so would now swallow text after the yanked text.
19119 org-yank-adjusted-subtrees
19120 When set, the subtree will be promoted or demoted in order to
19121 fit into the local outline tree structure, which means that the level
19122 will be adjusted so that it becomes the smaller one of the two
19123 *visible* surrounding headings.
19125 Any prefix to this command will cause `yank' to be called directly with
19127 will just
19128 plainly yank the text as it is.
19130 \[1] The test checks if the first non-white line is a heading
19131 and if there are no other headings with fewer stars."
19132 (interactive "P")
19133 (org-yank-generic 'yank arg))
19135 (defun org-yank-generic (command arg)
19136 "Perform some yank-like command.
19138 This function implements the behavior described in the `org-yank'
19139 documentation. However, it has been generalized to work for any
19140 interactive command with similar behavior."
19142 ;; pretend to be command COMMAND
19143 (setq this-command command)
19145 (if arg
19146 (call-interactively command)
19148 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19149 (and (org-kill-is-subtree-p)
19150 (or (bolp)
19152 (string-match
19154 (buffer-substring (point-at-bol) (point)))))))
19155 swallowp)
19156 (cond
19157 ((and subtreep org-yank-folded-subtrees)
19158 (let ((beg (point))
19159 end)
19160 (if (and subtreep org-yank-adjusted-subtrees)
19161 (org-paste-subtree nil nil 'for-yank)
19162 (call-interactively command))
19164 (setq end (point))
19165 (goto-char beg)
19166 (when (and (bolp) subtreep
19167 (not (setq swallowp
19168 (org-yank-folding-would-swallow-text beg end))))
19169 (or (looking-at outline-regexp)
19170 (re-search-forward (concat "^" outline-regexp) end t))
19171 (while (and (< (point) end) (looking-at outline-regexp))
19172 (hide-subtree)
19173 (org-cycle-show-empty-lines 'folded)
19174 (condition-case nil
19175 (outline-forward-same-level 1)
19176 (error (goto-char end)))))
19177 (when swallowp
19178 (message
19179 "Inserted text not folded because that would swallow text"))
19181 (goto-char end)
19183 (beginning-of-line 1)
19184 (push-mark beg 'nomsg)))
19185 ((and subtreep org-yank-adjusted-subtrees)
19186 (let ((beg (point-at-bol)))
19187 (org-paste-subtree nil nil 'for-yank)
19188 (push-mark beg 'nomsg)))
19189 (t
19190 (call-interactively command))))))
19192 (defun org-yank-folding-would-swallow-text (beg end)
19193 "Would hide-subtree at BEG swallow any text after END?"
19194 (let (level)
19195 (save-excursion
19196 (goto-char beg)
19197 (when (or (looking-at outline-regexp)
19198 (re-search-forward (concat "^" outline-regexp) end t))
19199 (setq level (org-outline-level)))
19200 (goto-char end)
19202 (if (or (eobp)
19203 (and (bolp) (looking-at org-outline-regexp)
19204 (<= (org-outline-level) level)))
19205 nil ; Nothing would be swallowed
19206 t)))) ; something would swallow
19208 (define-key org-mode-map "\C-y" 'org-yank)
19210 (defun org-truely-invisible-p ()
19211 "Check if point is at a character currently not visible.
19212 This version does not only check the character property, but also
19213 `visible-mode'."
19214 ;; Early versions of noutline don't have `outline-invisible-p'.
19215 (if (org-bound-and-true-p visible-mode)
19216 nil
19217 (outline-invisible-p)))
19219 (defun org-invisible-p2 ()
19220 "Check if point is at a character currently not visible."
19221 (save-excursion
19222 (if (and (eolp) (not (bobp))) (backward-char 1))
19223 ;; Early versions of noutline don't have `outline-invisible-p'.
19224 (outline-invisible-p)))
19226 (defun org-back-to-heading (&optional invisible-ok)
19227 "Call `outline-back-to-heading', but provide a better error message."
19228 (condition-case nil
19229 (outline-back-to-heading invisible-ok)
19230 (error (error "Before first headline at position %d in buffer %s"
19231 (point) (current-buffer)))))
19233 (defun org-beginning-of-defun ()
19234 "Go to the beginning of the subtree, i.e. back to the heading."
19235 (org-back-to-heading))
19236 (defun org-end-of-defun ()
19237 "Go to the end of the subtree."
19238 (org-end-of-subtree nil t))
19240 (defun org-before-first-heading-p ()
19241 "Before first heading?"
19242 (save-excursion
19243 (end-of-line)
19246 (defun org-on-heading-p (&optional ignored)
19247 (outline-on-heading-p t))
19248 (defun org-at-heading-p (&optional ignored)
19249 (outline-on-heading-p t))
19251 (defun org-point-at-end-of-empty-headline ()
19252 "If point is at the end of an empty headline, return t, else nil.
19253 If the heading only contains a TODO keyword, it is still still considered
19254 empty."
19256 (save-excursion
19257 (beginning-of-line 1)
19260 (defun org-at-heading-or-item-p ()
19261 (or (org-on-heading-p) (org-at-item-p)))
19263 (defun org-on-target-p ()
19264 (or (org-in-regexp org-radio-target-regexp)
19265 (org-in-regexp org-target-regexp)))
19267 (defun org-up-heading-all (arg)
19268 "Move to the heading line of which the present line is a subheading.
19269 This function considers both visible and invisible heading lines.
19270 With argument, move up ARG levels."
19271 (if (fboundp 'outline-up-heading-all)
19272 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19273 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19275 (defun org-up-heading-safe ()
19276 "Move to the heading line of which the present line is a subheading.
19277 This version will not throw an error. It will return the level of the
19278 headline found, or nil if no higher level is found.
19280 Also, this function will be a lot faster than `outline-up-heading',
19281 because it relies on stars being the outline starters. This can really
19282 make a significant difference in outlines with very many siblings."
19283 (let (start-level re)
19284 (org-back-to-heading t)
19285 (setq start-level (funcall outline-level))
19286 (if (equal start-level 1)
19287 nil
19289 (if (re-search-backward re nil t)
19290 (funcall outline-level)))))
19292 (defun org-first-sibling-p ()
19293 "Is this heading the first child of its parents?"
19294 (interactive)
19295 (let ((re (concat "^" outline-regexp))
19296 level l)
19297 (unless (org-at-heading-p t)
19298 (error "Not at a heading"))
19299 (setq level (funcall outline-level))
19300 (save-excursion
19301 (if (not (re-search-backward re nil t))
19302 t
19303 (setq l (funcall outline-level))
19304 (< l level)))))
19306 (defun org-goto-sibling (&optional previous)
19307 "Goto the next sibling, even if it is invisible.
19308 When PREVIOUS is set, go to the previous sibling instead. Returns t
19309 when a sibling was found. When none is found, return nil and don't
19310 move point."
19311 (let ((fun (if previous 're-search-backward 're-search-forward))
19312 (pos (point))
19313 (re (concat "^" outline-regexp))
19314 level l)
19315 (when (condition-case nil (org-back-to-heading t) (error nil))
19316 (setq level (funcall outline-level))
19317 (catch 'exit
19318 (or previous (forward-char 1))
19319 (while (funcall fun re nil t)
19320 (setq l (funcall outline-level))
19321 (when (< l level) (goto-char pos) (throw 'exit nil))
19322 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19323 (goto-char pos)
19324 nil))))
19326 (defun org-show-siblings ()
19327 "Show all siblings of the current headline."
19328 (save-excursion
19329 (while (org-goto-sibling) (org-flag-heading nil)))
19330 (save-excursion
19331 (while (org-goto-sibling 'previous)
19332 (org-flag-heading nil))))
19334 (defun org-goto-first-child ()
19335 "Goto the first child, even if it is invisible.
19336 Return t when a child was found. Otherwise don't move point and
19337 return nil."
19338 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19339 (when (condition-case nil (org-back-to-heading t) (error nil))
19340 (setq level (outline-level))
19341 (forward-char 1)
19342 (if (and (re-search-forward re nil t) (> (outline-level) level))
19343 (progn (goto-char (match-beginning 0)) t)
19344 (goto-char pos) nil))))
19346 (defun org-show-hidden-entry ()
19347 "Show an entry where even the heading is hidden."
19348 (save-excursion
19349 (org-show-entry)))
19351 (defun org-flag-heading (flag &optional entry)
19352 "Flag the current heading. FLAG non-nil means make invisible.
19353 When ENTRY is non-nil, show the entire entry."
19354 (save-excursion
19355 (org-back-to-heading t)
19356 ;; Check if we should show the entire entry
19357 (if entry
19358 (progn
19359 (org-show-entry)
19360 (save-excursion
19361 (and (outline-next-heading)
19362 (org-flag-heading nil))))
19363 (outline-flag-region (max (point-min) (1- (point)))
19364 (save-excursion (outline-end-of-heading) (point))
19365 flag))))
19367 (defun org-get-next-sibling ()
19368 "Move to next heading of the same level, and return point.
19369 If there is no such heading, return nil.
19370 This is like outline-next-sibling, but invisible headings are ok."
19371 (let ((level (funcall outline-level)))
19372 (outline-next-heading)
19373 (while (and (not (eobp)) (> (funcall outline-level) level))
19374 (outline-next-heading))
19375 (if (or (eobp) (< (funcall outline-level) level))
19376 nil
19377 (point))))
19379 (defun org-get-last-sibling ()
19380 "Move to previous heading of the same level, and return point.
19381 If there is no such heading, return nil."
19382 (let ((opoint (point))
19383 (level (funcall outline-level)))
19384 (outline-previous-heading)
19385 (when (and (/= (point) opoint) (outline-on-heading-p t))
19386 (while (and (> (funcall outline-level) level)
19387 (not (bobp)))
19388 (outline-previous-heading))
19389 (if (< (funcall outline-level) level)
19390 nil
19391 (point)))))
19393 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19394 ;; This contains an exact copy of the original function, but it uses
19395 ;; `org-back-to-heading', to make it work also in invisible
19396 ;; trees. And is uses an invisible-OK argument.
19397 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19398 ;; Furthermore, when used inside Org, finding the end of a large subtree
19399 ;; with many children and grandchildren etc, this can be much faster
19400 ;; than the outline version.
19401 (org-back-to-heading invisible-OK)
19402 (let ((first t)
19403 (level (funcall outline-level)))
19404 (if (and (org-mode-p) (< level 1000))
19405 ;; A true heading (not a plain list item), in Org-mode
19406 ;; This means we can easily find the end by looking
19407 ;; only for the right number of stars. Using a regexp to do
19408 ;; this is so much faster than using a Lisp loop.
19410 (forward-char 1)
19411 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19412 ;; something else, do it the slow way
19413 (while (and (not (eobp))
19414 (or first (> (funcall outline-level) level)))
19415 (setq first nil)
19416 (outline-next-heading)))
19417 (unless to-heading
19419 (progn
19420 ;; Go to end of line before heading
19421 (forward-char -1)
19423 ;; leave blank line before heading
19424 (forward-char -1))))))
19425 (point))
19427 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19428 "Use Org version in org-mode, for dramatic speed-up."
19429 (if (eq major-mode 'org-mode)
19430 (progn
19431 (org-end-of-subtree nil t)
19432 (unless (eobp) (backward-char 1)))
19433 ad-do-it))
19435 (defun org-forward-same-level (arg &optional invisible-ok)
19436 "Move forward to the arg'th subheading at same level as this one.
19437 Stop at the first and last subheadings of a superior heading.
19438 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19439 it wil also look at invisible ones."
19440 (interactive "p")
19441 (org-back-to-heading invisible-ok)
19442 (org-on-heading-p)
19443 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19445 l)
19446 (forward-char 1)
19447 (while (> arg 0)
19448 (while (and (re-search-forward re nil 'move)
19449 (setq l (- (match-end 0) (match-beginning 0) 1))
19450 (= l level)
19451 (not invisible-ok)
19452 (progn (backward-char 1) (outline-invisible-p)))
19453 (if (< l level) (setq arg 1)))
19454 (setq arg (1- arg)))
19455 (beginning-of-line 1)))
19457 (defun org-backward-same-level (arg &optional invisible-ok)
19458 "Move backward to the arg'th subheading at same level as this one.
19459 Stop at the first and last subheadings of a superior heading."
19460 (interactive "p")
19461 (org-back-to-heading)
19462 (org-on-heading-p)
19463 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19465 l)
19466 (while (> arg 0)
19467 (while (and (re-search-backward re nil 'move)
19468 (setq l (- (match-end 0) (match-beginning 0) 1))
19469 (= l level)
19470 (not invisible-ok)
19471 (outline-invisible-p))
19472 (if (< l level) (setq arg 1)))
19473 (setq arg (1- arg)))))
19475 (defun org-show-subtree ()
19476 "Show everything after this heading at deeper levels."
19477 (outline-flag-region
19478 (point)
19479 (save-excursion
19480 (org-end-of-subtree t t))
19481 nil))
19483 (defun org-show-entry ()
19484 "Show the body directly following this heading.
19485 Show the heading too, if it is currently invisible."
19486 (interactive)
19487 (save-excursion
19488 (condition-case nil
19489 (progn
19490 (org-back-to-heading t)
19491 (outline-flag-region
19492 (max (point-min) (1- (point)))
19493 (save-excursion
19494 (if (re-search-forward
19496 (match-beginning 1)
19497 (point-max)))
19498 nil)
19499 (org-cycle-hide-drawers 'children))
19500 (error nil))))
19502 (defun org-make-options-regexp (kwds &optional extra)
19503 "Make a regular expression for keyword lines."
19504 (concat
19505 "^"
19512 ;; Make isearch reveal the necessary context
19513 (defun org-isearch-end ()
19514 "Reveal context after isearch exits."
19515 (when isearch-success ; only if search was successful
19516 (if (featurep 'xemacs)
19517 ;; Under XEmacs, the hook is run in the correct place,
19518 ;; we directly show the context.
19519 (org-show-context 'isearch)
19520 ;; In Emacs the hook runs *before* restoring the overlays.
19521 ;; So we have to use a one-time post-command-hook to do this.
19522 ;; (Emacs 22 has a special variable, see function `org-mode')
19523 (unless (and (boundp 'isearch-mode-end-hook-quit)
19524 isearch-mode-end-hook-quit)
19525 ;; Only when the isearch was not quitted.
19526 (org-add-hook 'post-command-hook 'org-isearch-post-command
19527 'append 'local)))))
19529 (defun org-isearch-post-command ()
19530 "Remove self from hook, and show context."
19531 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19532 (org-show-context 'isearch))
19535 ;;;; Integration with and fixes for other packages
19537 ;;; Imenu support
19539 (defvar org-imenu-markers nil
19540 "All markers currently used by Imenu.")
19541 (make-variable-buffer-local 'org-imenu-markers)
19543 (defun org-imenu-new-marker (&optional pos)
19544 "Return a new marker for use by Imenu, and remember the marker."
19545 (let ((m (make-marker)))
19546 (move-marker m (or pos (point)))
19547 (push m org-imenu-markers)
19548 m))
19550 (defun org-imenu-get-tree ()
19551 "Produce the index for Imenu."
19552 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19553 (setq org-imenu-markers nil)
19554 (let* ((n org-imenu-depth)
19555 (re (concat "^" outline-regexp))
19556 (subs (make-vector (1+ n) nil))
19557 (last-level 0)
19558 m level head)
19559 (save-excursion
19560 (save-restriction
19561 (widen)
19562 (goto-char (point-max))
19563 (while (re-search-backward re nil t)
19564 (setq level (org-reduced-level (funcall outline-level)))
19565 (when (<= level n)
19566 (looking-at org-complex-heading-regexp)
19567 (setq head (org-link-display-format
19568 (org-match-string-no-properties 4))
19569 m (org-imenu-new-marker))
19570 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19571 (if (>= level last-level)
19572 (push (cons head m) (aref subs level))
19573 (push (cons head (aref subs (1+ level))) (aref subs level))
19574 (loop for i from (1+ level) to n do (aset subs i nil)))
19575 (setq last-level level)))))
19576 (aref subs 1)))
19578 (eval-after-load "imenu"
19579 '(progn
19580 (add-hook 'imenu-after-jump-hook
19581 (lambda ()
19582 (if (eq major-mode 'org-mode)
19583 (org-show-context 'org-goto))))))
19585 (defun org-link-display-format (link)
19586 "Replace a link with either the description, or the link target
19587 if no description is present"
19588 (save-match-data
19589 (if (string-match org-bracket-link-analytic-regexp link)
19590 (replace-match (if (match-end 5)
19591 (match-string 5 link)
19592 (concat (match-string 1 link)
19593 (match-string 3 link)))
19594 nil t link)
19595 link)))
19597 ;; Speedbar support
19599 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19600 "Overlay marking the agenda restriction line in speedbar.")
19601 (overlay-put org-speedbar-restriction-lock-overlay
19602 'face 'org-agenda-restriction-lock)
19603 (overlay-put org-speedbar-restriction-lock-overlay
19604 'help-echo "Agendas are currently limited to this item.")
19605 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19607 (defun org-speedbar-set-agenda-restriction ()
19608 "Restrict future agenda commands to the location at point in speedbar.
19610 (interactive)
19611 (require 'org-agenda)
19612 (let (p m tp np dir txt)
19613 (cond
19614 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19615 'org-imenu t))
19616 (setq m (get-text-property p 'org-imenu-marker))
19617 (with-current-buffer (marker-buffer m)
19618 (goto-char m)
19619 (org-agenda-set-restriction-lock 'subtree)))
19620 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19621 'speedbar-function 'speedbar-find-file))
19622 (setq tp (previous-single-property-change
19623 (1+ p) 'speedbar-function)
19624 np (next-single-property-change
19625 tp 'speedbar-function)
19626 dir (speedbar-line-directory)
19627 txt (buffer-substring-no-properties (or tp (point-min))
19628 (or np (point-max))))
19629 (with-current-buffer (find-file-noselect
19630 (let ((default-directory dir))
19631 (expand-file-name txt)))
19632 (unless (org-mode-p)
19633 (error "Cannot restrict to non-Org-mode file"))
19634 (org-agenda-set-restriction-lock 'file)))
19635 (t (error "Don't know how to restrict Org-mode's agenda")))
19636 (move-overlay org-speedbar-restriction-lock-overlay
19637 (point-at-bol) (point-at-eol))
19638 (setq current-prefix-arg nil)
19639 (org-agenda-maybe-redo)))
19641 (eval-after-load "speedbar"
19642 '(progn
19643 (speedbar-add-supported-extension ".org")
19644 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19645 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19646 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19647 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19648 (add-hook 'speedbar-visiting-tag-hook
19649 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19651 ;;; Fixes and Hacks for problems with other packages
19653 ;; Make flyspell not check words in links, to not mess up our keymap
19654 (defun org-mode-flyspell-verify ()
19655 "Don't let flyspell put overlays at active buttons."
19656 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19657 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19659 (defun org-remove-flyspell-overlays-in (beg end)
19660 "Remove flyspell overlays in region."
19661 (and (org-bound-and-true-p flyspell-mode)
19662 (fboundp 'flyspell-delete-region-overlays)
19663 (flyspell-delete-region-overlays beg end))
19664 (add-text-properties beg end '(org-no-flyspell t)))
19666 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19667 (eval-after-load "bookmark"
19668 '(if (boundp 'bookmark-after-jump-hook)
19669 ;; We can use the hook
19670 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19671 ;; Hook not available, use advice
19672 (defadvice bookmark-jump (after org-make-visible activate)
19673 "Make the position visible."
19674 (org-bookmark-jump-unhide))))
19676 ;; Make sure saveplace shows the location if it was hidden
19677 (eval-after-load "saveplace"
19678 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19679 "Make the position visible."
19680 (org-bookmark-jump-unhide)))
19682 ;; Make sure ecb shows the location if it was hidden
19683 (eval-after-load "ecb"
19684 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19685 "Make hierarchy visible when jumping into location from ECB tree buffer."
19686 (if (eq major-mode 'org-mode)
19687 (org-show-context))))
19689 (defun org-bookmark-jump-unhide ()
19690 "Unhide the current position, to show the bookmark location."
19691 (and (org-mode-p)
19692 (or (outline-invisible-p)
19693 (save-excursion (goto-char (max (point-min) (1- (point))))
19694 (outline-invisible-p)))
19695 (org-show-context 'bookmark-jump)))
19697 ;; Make session.el ignore our circular variable
19698 (eval-after-load "session"
19699 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19701 ;;;; Experimental code
19703 (defun org-closed-in-range ()
19704 "Sparse tree of items closed in a certain time range.
19705 Still experimental, may disappear in the future."
19706 (interactive)
19707 ;; Get the time interval from the user.
19708 (let* ((time1 (org-float-time
19709 (org-read-date nil 'to-time nil "Starting date: ")))
19710 (time2 (org-float-time
19711 (org-read-date nil 'to-time nil "End date:")))
19712 ;; callback function
19713 (callback (lambda ()
19714 (let ((time
19715 (org-float-time
19716 (apply 'encode-time
19717 (org-parse-time-string
19718 (match-string 1))))))
19719 ;; check if time in interval
19720 (and (>= time time1) (<= time time2))))))
19721 ;; make tree, check each match with the callback
19724 ;;;; Finish up
19726 (provide 'org)
19728 (run-hooks 'org-load-hook)
19730 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19732 ;;; org.el ends here