| blob | 008ed8e2eca9c0859e762014f01b510282168531 |
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.
110 ;; babel
119 ;; load languages based on value of `org-babel-load-languages'
121 ;;;###autoload
123 "Load the languages defined in `org-babel-load-languages'."
135 org-babel-load-languages))
138 "Languages which can be evaluated in Org-mode buffers.
139 This list can be used to load support for any of the languages
140 below, note that each language will depend on a different set of
141 system executables and/or Emacs modes. When a language is
143 with `org-babel-execute-src-block' bound by default to C-c
144 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
145 be set to remove code block evaluation from the C-c C-c
146 keybinding. By default only Emacs Lisp (which has no
147 requirements) is loaded."
151 :key-type
184 ;;;; Customization variables
186 "Remove ID property of clones of a subtree.
187 When non-nil, clones of a subtree don't inherit the ID property.
188 Otherwise they inherit the ID property with a new unique
189 identifier."
193 ;;; Version
199 "Show the org-mode version in the echo area.
200 With prefix arg HERE, insert it at point."
226 ;;; Compatibility constants
228 ;;; The custom variables
231 "Outline-based notes management and organizer."
237 "Mode hook for Org-mode, run after the mode was turned on."
242 "Hook that is run after org.el has been loaded."
251 "Load all extensions listed in `org-modules'."
256 org-modules)
260 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
269 (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)
270 "Modules that should always be loaded together with org.el.
271 If a description starts with <C>, the file is not part of Emacs
272 and loading it will require that you have downloaded and properly installed
273 the org-mode distribution.
275 You can also use this system to load external packages (i.e. neither Org
276 core modules, nor modules from the CONTRIB directory). Just add symbols
277 to the end of the list. If the package is called org-xyz.el, then you need
278 to add the symbol `xyz', and the package must have a call to
280 (provide 'org-xyz)"
283 :type
314 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
322 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
331 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
347 "Non-nil means make shift-cursor commands select text when possible.
349 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
350 selecting a region, or enlarge regions started in this way.
351 In Org-mode, in special contexts, these same keys are used for other
352 purposes, important enough to compete with shift selection. Org tries
353 to balance these needs by supporting `shift-select-mode' outside these
354 special contexts, under control of this variable.
356 The default of this variable is nil, to avoid confusing behavior. Shifted
357 cursor keys will then execute Org commands in the following contexts:
358 - on a headline, changing TODO state (left/right) and priority (up/down)
359 - on a time stamp, changing the time
360 - in a plain list item, changing the bullet type
361 - in a property definition line, switching between allowed values
362 - in the BEGIN line of a clock table (changing the time block).
363 Outside these contexts, the commands will throw an error.
365 When this variable is t and the cursor is not in a special context,
366 Org-mode will support shift-selection for making and enlarging regions.
367 To make this more effective, the bullet cycling will no longer happen
368 anywhere in an item line, but only if the cursor is exactly on the bullet.
370 If you set this variable to the symbol `always', then the keys
371 will not be special in headlines, property lines, and item lines, to make
372 shift selection work there as well. If this is what you want, you can
373 use the following alternative commands: `C-c C-t' and `C-c ,' to
374 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
375 TODO sets, `C-c -' to cycle item bullet types, and properties can be
376 edited by hand or in column view.
378 However, when the cursor is on a timestamp, shift-cursor commands
379 will still edit the time stamp - this is just too good to give up.
381 XEmacs user should have this variable set to nil, because shift-select-mode
382 is Emacs 23 only."
390 "Options concerning startup of Org-mode."
395 "Non-nil means entering Org-mode will switch to OVERVIEW.
396 This can also be configured on a per-file basis by adding one of
397 the following lines anywhere in the buffer:
399 #+STARTUP: fold (or `overview', this is equivalent)
400 #+STARTUP: nofold (or `showall', this is equivalent)
401 #+STARTUP: content
402 #+STARTUP: showeverything"
411 "Non-nil means entering Org-mode will set `truncate-lines'.
412 This is useful since some lines containing links can be very long and
413 uninteresting. Also tables look terrible when wrapped."
418 "Non-nil means turn on `org-indent-mode' on startup.
419 This can also be configured on a per-file basis by adding one of
420 the following lines anywhere in the buffer:
422 #+STARTUP: indent
423 #+STARTUP: noindent"
431 When this option is turned on, you can use TeX-like syntax for sub- and
433 considered as a single item - so grouping with {} is normally not
434 needed. For example, the following things will be parsed as single
435 sub- or superscripts.
437 10^24 or 10^tau several digits will be considered 1 item.
438 10^-12 or 10^-tau a leading sign with digits or a word
439 x^2-y^3 will be read as x^2 - y^3, because items are
440 terminated by almost any nonword/nondigit char.
441 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
443 Still, ambiguity is possible - so when in doubt use {} to enclose the
444 sub/superscript. If you set this variable to the symbol `{}',
445 the braces are *required* in order to trigger interpretations as
447 frequently in plain text.
449 Not all export backends support this, but HTML does.
464 "Non-nil means turn on `org-beamer-mode' on startup.
465 This can also be configured on a per-file basis by adding one of
466 the following lines anywhere in the buffer:
468 #+STARTUP: beamer"
473 "Non-nil means align all tables when visiting a file.
474 This is useful when the column width in tables is forced with <N> cookies
475 in table fields. Such tables will look correct only after the first re-align.
476 This can also be configured on a per-file basis by adding one of
477 the following lines anywhere in the buffer:
478 #+STARTUP: align
479 #+STARTUP: noalign"
484 "Non-nil means show inline images when loading a new Org file.
485 This can also be configured on a per-file basis by adding one of
486 the following lines anywhere in the buffer:
487 #+STARTUP: inlineimages
488 #+STARTUP: noinlineimages"
493 "Non-nil means insert the first line setting Org-mode in empty files.
494 When the function `org-mode' is called interactively in an empty file, this
495 normally means that the file name does not automatically trigger Org-mode.
496 To ensure that the file will always be in Org-mode in the future, a
497 line enforcing Org-mode will be inserted into the buffer, if this option
498 has been set."
503 "Non-nil means use alternative key bindings for some keys.
504 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
505 These keys are also used by other packages like shift-selection-mode'
506 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
507 If you want to use Org-mode together with one of these other modes,
508 or more generally if you would like to move some Org-mode commands to
509 other keys, set this variable and configure the keys with the variable
510 `org-disputed-keys'.
512 This option is only relevant at load-time of Org-mode, and must be set
513 *before* org.el is loaded. Changing it requires a restart of Emacs to
514 become effective."
519 "Non-nil means use extra key sequence definitions for certain commands.
520 This happens automatically if you run XEmacs or if `window-system'
521 is nil. This variable lets you do the same manually. You must
522 set it before loading org.
524 Example: on Carbon Emacs 22 running graphically, with an external
525 keyboard on a Powerbook, the default way of setting M-left might
526 not work for either Alt or ESC. Setting this variable will make
527 it work for ESC."
541 "Keys for which Org-mode and other modes compete.
542 This is an alist, cars are the default keys, second element specifies
543 the alternative to use when `org-replace-disputed-keys' is t.
545 Keys can be specified in any syntax supported by `define-key'.
546 The value of this option takes effect only at Org-mode's startup,
547 therefore you'll have to restart Emacs to apply it after changing."
552 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
553 Or return the original if not disputed.
554 Also apply the translations defined in `org-xemacs-key-equivalents'."
559 org-disputed-keys)))
563 key)
573 "Define a key, possibly translated, as returned by `org-key'."
577 "The ellipsis to use in the Org-mode outline.
578 When nil, just use the standard three dots. When a string, use that instead,
579 When a face, use the standard 3 dots, but with the specified face.
580 The change affects only Org-mode (which will then use its own display table).
581 Changing this requires executing `M-x org-mode' in a buffer to become
582 effective."
592 "Keywords in Org-mode."
597 "String to mark deadline entries.
598 A deadline is this string, followed by a time stamp. Should be a word,
599 terminated by a colon. You can insert a schedule keyword and
601 Changes become only effective after restarting Emacs."
606 "String to mark scheduled TODO entries.
607 A schedule is this string, followed by a time stamp. Should be a word,
608 terminated by a colon. You can insert a schedule keyword and
610 Changes become only effective after restarting Emacs."
615 "String used as the prefix for timestamps logging closing a TODO entry."
620 "String used as prefix for timestamps clocking work hours on an item."
625 "Entries starting with this keyword will never be exported.
626 An entry can be toggled between COMMENT and normal with
628 Changes become only effective after restarting Emacs."
633 "Entries starting with this keyword will be exported in fixed-width font.
634 Quoting applies only to the text in the entry following the headline, and does
635 not extend beyond the next headline, even if that is lower level.
636 An entry can be toggled between QUOTE and normal with
643 "Regular expression for specifying repeated events.
647 "Options concerning the general structure of Org-mode files."
652 "Options about how to make context of a location visible."
676 "Non-nil means show full hierarchy when revealing a location.
677 Org-mode often shows locations in an org-mode file which might have
678 been invisible before. When this is set, the hierarchy of headings
679 above the exposed location is shown.
680 Turning this off for example for sparse trees makes them very compact.
681 Instead of t, this can also be an alist specifying this option for different
682 contexts. Valid contexts are
683 agenda when exposing an entry from the agenda
684 org-goto when using the command `org-goto' on key C-c C-j
685 occur-tree when using the command `org-occur' on key C-c /
686 tags-tree when constructing a sparse tree based on tags matches
687 link-search when exposing search matches associated with a link
688 mark-goto when exposing the jump goal of a mark
689 bookmark-jump when exposing a bookmark location
690 isearch when exiting from an incremental search
691 default default for all contexts not set explicitly"
696 "Non-nil means show following heading when revealing a location.
697 Org-mode often shows locations in an org-mode file which might have
698 been invisible before. When this is set, the heading following the
699 match is shown.
700 Turning this off for example for sparse trees makes them very compact,
701 but makes it harder to edit the location of the match. In such a case,
703 Instead of t, this can also be an alist specifying this option for different
704 contexts. See `org-show-hierarchy-above' for valid contexts."
709 "Non-nil means show all sibling heading when revealing a location.
710 Org-mode often shows locations in an org-mode file which might have
711 been invisible before. When this is set, the sibling of the current entry
712 heading are all made visible. If `org-show-hierarchy-above' is t,
713 the same happens on each level of the hierarchy above the current entry.
715 By default this is on for the isearch context, off for all other contexts.
716 Turning this off for example for sparse trees makes them very compact,
717 but makes it harder to edit the location of the match. In such a case,
719 Instead of t, this can also be an alist specifying this option for different
720 contexts. See `org-show-hierarchy-above' for valid contexts."
725 "Non-nil means show the entry below a headline when revealing a location.
726 Org-mode often shows locations in an org-mode file which might have
727 been invisible before. When this is set, the text below the headline that is
728 exposed is also shown.
730 By default this is off for all contexts.
731 Instead of t, this can also be an alist specifying this option for different
732 contexts. See `org-show-hierarchy-above' for valid contexts."
737 "How should indirect tree buffers be displayed?
738 This applies to indirect buffers created with the commands
740 Valid values are:
741 current-window Display in the current window
742 other-window Just display in another window.
743 dedicated-frame Create one new frame, and re-use it each time.
744 new-frame Make a new frame each time. Note that in this case
745 previously-made indirect buffers are kept, and you need to
746 kill these buffers yourself."
756 "Non-nil means activate single letter commands at beginning of a headline.
757 This may also be a function to test for appropriate locations where speed
758 commands should be active."
766 "Alist of additional speed commands.
767 This list will be checked before `org-speed-commands-default'
768 when the variable `org-use-speed-commands' is non-nil
769 and when the cursor is at the beginning of a headline.
770 The car if each entry is a string with a single letter, which must
771 be assigned to `self-insert-command' in the global map.
772 The cdr is either a command to be called interactively, a function
773 to be called, or a form to be evaluated.
774 An entry that is just a list with a single string will be interpreted
775 as a descriptive headline that will be added when listing the speed
776 commands in the Help buffer using the `?' speed command."
788 "Options concerning visibility cycling in Org-mode."
793 "Non-nil means skip CHILDREN state in entries that don't have any."
798 "Maximum level which should still be subject to visibility cycling.
799 Levels higher than this will, for cycling, be treated as text, not a headline.
800 When `org-odd-levels-only' is set, a value of N in this variable actually
801 means 2N-1 stars as the limiting headline.
802 When nil, cycle all levels.
803 Note that the limiting level of cycling is also influenced by
804 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
805 `org-inlinetask-min-level' is, cycling will be limited to levels one less
806 than its value."
813 "Names of drawers. Drawers are not opened by cycling on the headline above.
814 Drawers only open with a TAB on the drawer line itself. A drawer looks like
815 this:
816 :DRAWERNAME:
817 .....
818 :END:
820 the property API.
822 Drawers can be defined on the per-file basis with a line like:
824 #+DRAWERS: HIDDEN STATE PROPERTIES"
830 "Non-nil means entering Org-mode will fold all blocks.
831 This can also be set in on a per-file basis with
833 #+STARTUP: hideblocks
834 #+STARTUP: showblocks"
840 "Cycle globally if cursor is at beginning of buffer and not at a headline.
841 This makes it possible to do global cycling without having to use S-TAB or
843 of the buffer
844 must not be a headline - it may be empty or some other text. When used in
845 this way, `org-cycle-hook' is disables temporarily, to make sure the
846 cursor stays at the beginning of the buffer.
847 When this option is nil, don't do anything special at the beginning
848 of the buffer."
853 "Non-nil means cycle entry level or item indentation in new empty entries.
855 When the cursor is at the end of an empty headline, i.e with only stars
856 and maybe a TODO keyword, TAB will then switch the entry to become a child,
857 and then all possible ancestor states, before returning to the original state.
858 This makes data entry extremely fast: M-RET to create a new headline,
859 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
861 When the cursor is at the end of an empty plain list item, one TAB will
862 make it a subitem, two or more tabs will back up to make this an item
863 higher up in the item hierarchy."
868 "Where should `org-cycle' emulate TAB.
869 nil Never
870 white Only in completely white lines
871 whitestart Only at the beginning of lines, before the first non-white char
872 t Everywhere except in headlines
873 exc-hl-bol Everywhere except at the start of a headline
874 If TAB is used in a place where it does not emulate TAB, the current subtree
875 visibility is cycled."
882 ))
885 "Number of empty lines needed to keep an empty line between collapsed trees.
886 If you leave an empty line between the end of a subtree and the following
887 headline, this empty line is hidden when the subtree is folded.
888 Org-mode will leave (exactly) one empty line visible if the number of
889 empty lines is equal or larger to the number given in this variable.
890 So the default 2 means at least 2 empty lines after the end of a subtree
891 are needed to produce free space between a collapsed subtree and the
892 following headline.
894 If the number is negative, and the number of empty lines is at least -N,
895 all empty lines are shown.
897 Special case: when 0, never leave empty lines in collapsed view."
903 "Hook that is run before visibility cycling is happening.
904 The function(s) in this hook must accept a single argument which indicates
905 the new state that will be set right after running this hook. The
906 argument is a symbol. Before a global state change, it can have the values
907 `overview', `content', or `all'. Before a local state change, it can have
908 the values `folded', `children', or `subtree'."
913 org-cycle-hide-drawers
914 org-cycle-show-empty-lines
915 org-optimize-window-after-visibility-change)
916 "Hook that is run after `org-cycle' has changed the buffer visibility.
917 The function(s) in this hook must accept a single argument which indicates
918 the new state that was set by the most recent `org-cycle' command. The
919 argument is a symbol. After a global state change, it can have the values
920 `overview', `content', or `all'. After a local state change, it can have
921 the values `folded', `children', or `subtree'."
926 "Options concerning structure editing in Org-mode."
931 "Non-nil means skip even levels and only use odd levels for the outline.
932 This has the effect that two stars are being added/taken away in
933 promotion/demotion commands. It also influences how levels are
934 handled by the exporters.
935 Changing it requires restart of `font-lock-mode' to become effective
936 for fontification also in regions already fontified.
937 You may also set this on a per-file basis by adding one of the following
938 lines to the buffer:
940 #+STARTUP: odd
941 #+STARTUP: oddeven"
947 "Non-nil means adapt indentation to outline node level.
949 When this variable is set, Org assumes that you write outlines by
950 indenting text in each node to align with the headline (after the stars).
951 The following issues are influenced by this variable:
953 - When this is set and the *entire* text in an entry is indented, the
954 indentation is increased by one space in a demotion command, and
955 decreased by one in a promotion command. If any line in the entry
956 body starts with text at column 0, indentation is not changed at all.
958 - Property drawers and planning information is inserted indented when
959 this variable s set. When nil, they will not be indented.
961 - TAB indents a line relative to context. The lines below a headline
962 will be indented when this variable is set.
964 Note that this is all about true indentation, by adding and removing
965 space characters. See also `org-indent.el' which does level-dependent
966 indentation in a virtual way, i.e. at display time in Emacs."
971 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
973 When t, `C-a' will bring back the cursor to the beginning of the
974 headline text, i.e. after the stars and after a possible TODO keyword.
975 In an item, this will be the position after the bullet.
976 When the cursor is already at that position, another `C-a' will bring
977 it to the beginning of the line.
979 `C-e' will jump to the end of the headline, ignoring the presence of tags
980 in the headline. A second `C-e' will then jump to the true end of the
981 line, after any tags. This also means that, when this variable is
982 non-nil, `C-e' also will never jump beyond the end of the heading of a
983 folded section, i.e. not after the ellipses.
985 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
986 going to the true line boundary first. Only a directly following, identical
987 keypress will bring the cursor to the special positions.
989 This may also be a cons cell where the behavior for `C-a' and `C-e' is
990 set separately."
1009 "Non-nil means `C-k' will behave specially in headlines.
1010 When nil, `C-k' will call the default `kill-line' command.
1011 When t, the following will happen while the cursor is in the headline:
1013 - When the cursor is at the beginning of a headline, kill the entire
1014 line and possible the folded subtree below the line.
1015 - When in the middle of the headline text, kill the headline up to the tags.
1016 - When after the headline text, kill the tags."
1021 "Non-nil means, do not delete a hidden subtree with C-k.
1022 When set to the symbol `error', simply throw an error when C-k is
1023 used to kill (part-of) a headline that has hidden text behind it.
1024 Any other non-nil value will result in a query to the user, if it is
1025 OK to kill that hidden subtree. When nil, kill without remorse."
1033 "Non-nil means when yanking subtrees, fold them.
1034 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1035 it starts with a heading and all other headings in it are either children
1036 or siblings, then fold all the subtrees. However, do this only if no
1037 text after the yank would be swallowed into a folded tree by this action."
1042 "Non-nil means when yanking subtrees, adjust the level.
1043 With this setting, `org-paste-subtree' is used to insert the subtree, see
1044 this function for details."
1049 "Non-nil means M-RET will split the line at the cursor position.
1050 When nil, it will go to the end of the line before making a
1051 new line.
1052 You may also set this option in a different way for different
1053 contexts. Valid contexts are:
1055 headline when creating a new headline
1056 item when creating a new item
1057 table in a table field
1058 default the value to be used for all contexts not explicitly
1059 customized"
1076 "Non-nil means insert new headings after the current subtree.
1077 When nil, the new heading is created directly after the current line.
1080 for the duration of the command."
1086 "Should `org-insert-heading' leave a blank line before new heading/item?
1087 The value is an alist, with `heading' and `plain-list-item' as car,
1088 and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
1089 Org will look at the surrounding headings/items and try to make an
1090 intelligent decision whether to insert a blank line or not.
1092 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1093 set, the setting here is ignored and no empty line is inserted, to avoid
1094 breaking the list structure."
1107 "Hook being run after inserting a new heading."
1113 This currently only means they are never auto-wrapped.
1114 When nil, such lines will be treated like ordinary lines.
1115 See also the QUOTE keyword."
1120 "Non-nil means typing characters in `org-goto' starts incremental search."
1125 "Options concerning sparse trees in Org-mode."
1130 "Non-nil means highlight all matches that define a sparse tree.
1131 The highlights will automatically disappear the next time the buffer is
1132 changed by an edit command."
1137 "Non-nil means any change to the buffer will remove temporary highlights.
1138 Such highlights are created by `org-occur' and `org-clock-display'.
1139 When nil, `C-c C-c needs to be used to get rid of the highlights.
1140 The highlights created by `org-preview-latex-fragment' always need
1141 `C-c C-c' to be removed."
1148 "Hook that is run after `org-occur' has constructed a sparse tree.
1149 This can be used to recenter the window to show as much of the structure
1150 as possible."
1155 "Options concerning imenu and speedbar in Org-mode."
1160 "The maximum level for Imenu access to Org-mode headlines.
1161 This also applied for speedbar access."
1166 "Options concerning tables in Org-mode."
1172 When nil, such lines will be treated like ordinary lines.
1174 When equal to the symbol `optimized', the table editor will be optimized to
1175 do the following:
1176 - Automatic overwrite mode in front of whitespace in table fields.
1177 This makes the structure of the table stay in tact as long as the edited
1178 field does not exceed the column width.
1179 - Minimize the number of realigns. Normally, the table is aligned each time
1180 TAB or RET are pressed to move to another field. With optimization this
1181 happens only if changes to a field might have changed the column width.
1182 Optimization requires replacing the functions `self-insert-command',
1183 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1184 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1185 very good at guessing when a re-align will be necessary, but you can always
1188 If you would like to use the optimized version in Org-mode, but the
1189 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1191 This variable can be used to turn on and off the table editor during a session,
1192 but in order to toggle optimization, a restart is required.
1194 See also the variable `org-table-auto-blank-field'."
1202 "Non-nil means cluster self-insert commands for undo when possible.
1203 If this is set, then, like in the Emacs command loop, 20 consecutive
1204 characters will be undone together.
1205 This is configurable, because there is some impact on typing performance."
1210 "Non-nil means TAB will automatically notice a table.el table.
1211 When it sees such a table, it moves point into it and - if necessary -
1212 calls `table-recognize-table'."
1217 "Options concerning links in Org-mode."
1222 "Buffer-local version of `org-link-abbrev-alist', which see.
1227 "Alist of link abbreviations.
1228 The car of each element is a string, to be replaced at the start of a link.
1230 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1232 [[linkkey:tag][description]]
1234 The 'linkkey' must be a word word, starting with a letter, followed
1235 by letters, numbers, '-' or '_'.
1237 If REPLACE is a string, the tag will simply be appended to create the link.
1240 be inserted at that point (see the function `url-hexify-string').
1242 REPLACE may also be a function that will be called with the tag as the
1243 only argument to create the link, which should be returned as a string.
1245 See the manual for examples."
1255 "Non-nil means hide link part and only show description of bracket links.
1256 Bracket links are like [[link][description]]. This variable sets the initial
1257 state in new org-mode buffers. The setting can then be toggled on a
1258 per-buffer basis from the Org->Hyperlinks menu."
1263 "How the path name in file links should be stored.
1264 Valid values are:
1266 relative Relative to the current directory, i.e. the directory of the file
1267 into which the link is being inserted.
1268 absolute Absolute path, if possible with ~ for home directory.
1269 noabbrev Absolute path, no abbreviation of home directory.
1270 adaptive Use relative path for files in the current directory and sub-
1271 directories of it. For other files, use an absolute path."
1280 "Types of links that should be activated in Org-mode files.
1281 This is a list of symbols, each leading to the activation of a certain link
1282 type. In principle, it does not hurt to turn on most link types - there may
1283 be a small gain when turning off unused link types. The types are:
1285 bracket The recommended [[link][description]] or [[link]] links with hiding.
1286 angle Links in angular brackets that may contain whitespace like
1287 <bbdb:Carsten Dominik>.
1288 plain Plain links in normal text, no whitespace, like http://google.com.
1289 radio Text that is matched by a radio target, see manual for details.
1290 tag Tag settings in a headline (link to tag search).
1291 date Time stamps (link to calendar).
1292 footnote Footnote labels.
1294 Changing this variable requires a restart of Emacs to become effective."
1306 "Function to use to generate link descriptions from links.
1307 If nil the link location will be used. This function must take
1308 two parameters; the first is the link and the second the
1309 description `org-insert-link' has generated, and should return the
1310 description to use."
1315 "Options concerning storing links in Org-mode."
1320 "Format of the description part of a link to an email or usenet message.
1321 The following %-escapes will be replaced by corresponding information:
1329 %s subject
1330 %d date
1331 %m message-id.
1333 You may use normal field width specification between the % and the letter.
1334 This is for example useful to limit the length of the subject.
1348 It should match if the message is from the user him/herself."
1353 "Non-nil means storing a link to an Org file will use entry IDs.
1355 Note that before this variable is even considered, org-id must be loaded,
1356 so please customize `org-modules' and turn it on.
1358 The variable can have the following values:
1360 t Create an ID if needed to make a link to the current entry.
1362 create-if-interactive
1363 If `org-store-link' is called directly (interactively, as a user
1364 command), do create an ID to support the link. But when doing the
1365 job for remember, only use the ID if it already exists. The
1366 purpose of this setting is to avoid proliferation of unwanted
1367 IDs, just because you happen to be in an Org file when you
1368 call `org-remember' that automatically and preemptively
1369 creates a link. If you do want to get an ID link in a remember
1370 template to an entry not having an ID, create it first by
1371 explicitly creating a link to it, using `C-c C-l' first.
1373 create-if-interactive-and-no-custom-id
1374 Like create-if-interactive, but do not create an ID if there is
1375 a CUSTOM_ID property defined in the entry. This is the default.
1377 use-existing
1378 Use existing ID, do not create one.
1380 nil Never use an ID to make a link, instead link using a text search for
1381 the headline text."
1386 create-if-interactive)
1388 create-if-interactive-and-no-custom-id)
1393 "Non-nil means file links from `org-store-link' contain context.
1394 A search string will be added to the file name with :: as separator and
1395 used to find the context when the link is activated by the command
1396 `org-open-at-point'. When this option is t, the entire active region
1397 will be placed in the search string of the file link. If set to a
1398 positive integer, only the first n lines of context will be stored.
1401 negates this setting for the duration of the command."
1406 "Non-nil means keep link in list for entire session.
1408 The command `org-store-link' adds a link pointing to the current
1409 location to an internal list. These links accumulate during a session.
1410 The command `org-insert-link' can be used to insert links into any
1411 Org-mode file (offering completion for all stored links). When this
1413 will be removed from the list, to make completing the unused links
1414 more efficient."
1419 "Options concerning following links in Org-mode."
1424 "Function to translate links with different syntax to Org syntax.
1425 This can be used to translate links created for example by the Planner
1426 or emacs-wiki packages to Org syntax.
1427 The function must accept two parameters, a TYPE containing the link
1429 which is everything after the link protocol. It should return a cons
1430 with possibly modified values of type and path.
1431 Org contains a function for this, so if you set this variable to
1432 `org-translate-link-from-planner', you should be able follow many
1433 links created by planner."
1438 "Hook that is run after a link has been followed."
1443 "Non-nil means on links TAB will follow the link.
1444 Needs to be set before org.el is loaded.
1445 This really should not be used, it does not make sense, and the
1446 implementation is bad."
1451 "Non-nil means on links RET will follow the link."
1457 "Non-nil means mouse-1 on a link will follow the link.
1458 A longer mouse click will still set point. Does not work on XEmacs.
1459 Needs to be set before org.el is loaded."
1464 "Number of different positions to be recorded in the ring.
1465 Changing this requires a restart of Emacs to work correctly."
1470 "Non-nil means internal links in Org files must exactly match a headline.
1471 When nil, the link search tries to match a phrase with all words
1472 in the search text."
1478 query-to-create)))
1485 "Setup the frame configuration for following links.
1486 When following a link with Emacs, it may often be useful to display
1487 this link in another window or frame. This variable can be used to
1488 set this up for the different types of links.
1489 For VM, use any of
1490 `vm-visit-folder'
1491 `vm-visit-folder-other-window'
1492 `vm-visit-folder-other-frame'
1493 For Gnus, use any of
1494 `gnus'
1495 `gnus-other-frame'
1496 `org-gnus-no-new-news'
1497 For FILE, use any of
1498 `find-file'
1499 `find-file-other-window'
1500 `find-file-other-frame'
1501 For Wanderlust use any of
1502 `wl'
1503 `wl-other-frame'
1504 For the calendar, use the variable `calendar-setup'.
1505 For BBDB, it is currently only possible to display the matches in
1506 another window."
1530 "Non-nil means use indirect buffer to display infile links.
1531 Activating internal links (from one location in a file to another location
1532 in the same file) normally just jumps to the location. When the link is
1534 is displayed in
1535 another window. When this option is set, the other window actually displays
1536 an indirect buffer clone of the current buffer, to avoid any visibility
1537 changes to the current buffer."
1542 "Non-nil means `org-open-file' will open non-existing files.
1543 When nil, an error will be generated.
1544 This variable applies only to external applications because they
1545 might choke on non-existing files. If the link is to a file that
1546 will be opened in Emacs, the variable is ignored."
1551 "Non-nil means a link to a directory really means to index.org.
1552 When nil, following a directory link will run dired or open a finder/explorer
1553 window on that directory."
1558 "Function and arguments to call for following mailto links.
1559 This is a list with the first element being a Lisp function, and the
1560 remaining elements being arguments to the function. In string arguments,
1561 %a will be replaced by the address, and %s will be replaced by the subject
1562 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1571 "Non-nil means ask for confirmation before executing shell links.
1572 Shell links can be dangerous: just think about a link
1574 [[shell:rm -rf ~/*][Google Search]]
1577 but really it would remove your entire home directory.
1578 Therefore we advise against setting this variable to nil.
1579 Just change it to `y-or-n-p' if you want to confirm with a
1587 'safe-local-variable
1591 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1592 Elisp links can be dangerous: just think about a link
1597 but really it would remove your entire home directory.
1598 Therefore we advise against setting this variable to nil.
1599 Just change it to `y-or-n-p' if you want to confirm with a
1607 'safe-local-variable
1614 "Default file applications on a UNIX or GNU/Linux system.
1625 "Default file applications on a MacOS X system.
1627 for some files for which the OS does not have a good default.
1635 'mswindows-shell-execute
1640 'mswindows-shell-execute
1643 "Default file applications on a Windows NT system.
1648 '(
1653 )
1654 "External applications for opening `file:path' items in a document.
1655 Org-mode uses system defaults for different file types, but
1656 you can use this variable to set the application for a given file
1657 extension. The entries in this list are cons cells where the car identifies
1658 files and the cdr the corresponding command. Possible values for the
1659 file identifier are
1661 ways, depending on its contents:
1663 - Alphanumeric characters only:
1664 Match links with this file extension.
1666 to open PDFs with evince.
1668 - Regular expression: Match links where the
1669 filename matches the regexp. If you want to
1670 use groups here, use shy groups.
1674 to open *.html and *.xhtml with firefox.
1676 - Regular expression which contains (non-shy) groups:
1678 anything after that, matches the regexp.
1679 In a custom command string, %1, %2, etc. are replaced with
1680 the parts of the link that were matched by the groups.
1681 For backwards compatibility, if a command string is given
1682 that does not use any of the group matches, this case is
1683 handled identically to the second one (i.e. match against
1684 file name only).
1685 In a custom lisp form, you can access the group matches with
1686 (match-string n link).
1689 to open [[file:document.pdf::5]] with evince at page 5.
1691 `directory' Matches a directory
1692 `remote' Matches a remote file, accessible through tramp or efs.
1693 Remote files most likely should be visited through Emacs
1694 because external applications cannot handle such paths.
1695 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1696 so all files Emacs knows how to handle. Using this with
1697 command `emacs' will open most files in Emacs. Beware that this
1698 will also open html files inside Emacs, unless you add
1700 t Default for files not matched by any of the other options.
1701 `system' The system command to open files, like `open' on Windows
1702 and Mac OS X, and mailcap under GNU/Linux. This is the command
1703 that will be selected if you call `C-c C-o' with a double
1706 Possible values for the command are:
1707 `emacs' The file will be visited by the current Emacs process.
1708 `default' Use the default application for this file type, which is the
1709 association for t in the list, most likely in the system-specific
1710 part.
1711 This can be used to overrule an unwanted setting in the
1712 system-specific variable.
1714 This command is specified by the entry whose car is `system'.
1715 Most likely, the system-specific version of this variable
1716 does define this command, but you can overrule/replace it
1717 here.
1718 string A command to be executed by a shell; %s will be replaced
1719 by the path to the file.
1720 sexp A Lisp form which will be evaluated. The file path will
1721 be available in the Lisp variable `file'.
1722 For more examples, see the system specific constants
1723 `org-file-apps-defaults-macosx'
1724 `org-file-apps-defaults-windowsnt'
1725 `org-file-apps-defaults-gnu'."
1735 auto-mode))
1746 "Options concerning refiling entries in Org-mode."
1751 "Directory with org files.
1752 This is just a default location to look for Org files. There is no need
1753 at all to put your files into this directory. It is only used in the
1754 following situations:
1756 1. When a remember template specifies a target file that is not an
1757 absolute path. The path will then be interpreted relative to
1758 `org-directory'
1759 2. When a remember note is filed away in an interactive way (when exiting the
1760 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1761 with `org-directory' as the default path."
1767 "Default target for storing notes.
1768 Used as a fall back file for org-remember.el and org-capture.el, for
1769 templates that do not specify a target file."
1774 file))
1777 "The default interface to be used for `org-goto'.
1778 Allowed values are:
1779 outline The interface shows an outline of the relevant file
1780 and the correct heading is found by moving through
1781 the outline or by searching with incremental search.
1782 outline-path-completion Headlines in the current buffer are offered via
1783 completion. This is the interface also used by
1784 the refile command."
1791 "Maximum target level when running `org-goto' with refile interface."
1796 "Non-nil means store new notes at the beginning of a file or entry.
1797 When nil, new notes will be filed to the end of a file or entry.
1798 This can also be a list with cons cells of regular expressions that
1799 are matched against file names, and values."
1809 "Information to record when a task is refiled.
1811 Possible values are:
1813 nil Don't add anything
1814 time Add a time stamp to the task
1815 note Prompt for a note and add it with template `org-log-note-headings'
1817 This option can also be set with on a per-file-basis with
1819 #+STARTUP: nologrefile
1820 #+STARTUP: logrefile
1821 #+STARTUP: lognoterefile
1823 You can have local logging settings for a subtree by setting the LOGGING
1824 property to one or more of these keywords.
1826 When bulk-refiling from the agenda, the value `note' is forbidden and
1827 will temporarily be changed to `time'."
1837 This is list of cons cells. Each cell contains:
1838 - a specification of the files to be considered, either a list of files,
1839 or a symbol whose function or variable value will be used to retrieve
1840 a file name or a list of file names. If you use `org-agenda-files' for
1841 that, all agenda files will be scanned for targets. Nil means consider
1842 headings in the current buffer.
1843 - A specification of how to find candidate refile targets. This may be
1844 any of:
1846 This tag has to be present in all target headlines, inheritance will
1847 not be considered.
1849 todo keyword.
1851 headlines that are refiling targets.
1852 - a cons cell (:level . N). Any headline of level N is considered a target.
1853 Note that, when `org-odd-levels-only' is set, level corresponds to
1854 order in hierarchy, not to the number of stars.
1855 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1856 Note that, when `org-odd-levels-only' is set, level corresponds to
1857 order in hierarchy, not to the number of stars.
1859 You can set the variable `org-refile-target-verify-function' to a function
1860 to verify each headline found by the simple criteria above.
1862 When this variable is nil, all top-level headlines in the current buffer
1863 are used, equivalent to the value `((nil . (:level . 1))'."
1879 "Function to verify if the headline at point should be a refile target.
1880 The function will be called without arguments, with point at the
1881 beginning of the headline. It should return t and leave point
1882 where it is if the headline is a valid target for refiling.
1884 If the target should not be selected, the function must return nil.
1885 In addition to this, it may move point to a place from where the search
1886 should be continued. For example, the function may decide that the entire
1887 subtree of the current entry should be excluded and move point to the end
1888 of the subtree."
1893 "Non-nil means cache refile targets to speed up the process.
1894 The cache for a particular file will be updated automatically when
1895 the buffer has been killed, or when any of the marker used for flagging
1896 refile targets no longer points at a live buffer.
1897 If you have added new entries to a buffer that might themselves be targets,
1898 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1899 find that easier, `C-u C-u C-u C-c C-w'."
1904 "Non-nil means provide refile targets as paths.
1905 So a level 3 headline will be available as level1/level2/level3.
1907 When the value is `file', also include the file name (without directory)
1908 into the path. In this case, you can also stop the completion after
1909 the file name, to get entries inserted as top level in the file.
1911 When `full-file-path', include the full file path."
1920 "Non-nil means complete the outline path in hierarchical steps.
1921 When Org-mode uses the refile interface to select an outline path
1922 \(see variable `org-refile-use-outline-path'), the completion of
1923 the path can be done is a single go, or if can be done in steps down
1924 the headline hierarchy. Going in steps is probably the best if you
1925 do not use a special completion package like `ido' or `icicles'.
1926 However, when using these packages, going in one step can be very
1927 fast, while still showing the whole path to the entry."
1932 "Non-nil means allow to create new nodes as refile targets.
1934 of an existing node. When the value of this variable is `confirm',
1935 new node creation must be confirmed by the user (recommended)
1936 When nil, the completion must match an existing entry.
1938 Note that, if the new heading is not seen by the criteria
1939 listed in `org-refile-targets', multiple instances of the same
1940 heading would be created by trying again to file under the new
1941 heading."
1949 "Options concerning TODO items in Org-mode."
1954 "Options concerning Progress logging in Org-mode."
1959 '(
1962 "The available interpretation symbols for customizing `org-todo-keywords'.
1966 "List of TODO entry keyword sequences and their interpretation.
1969 Each sequence starts with a symbol, either `sequence' or `type',
1970 indicating if the keywords should be interpreted as a sequence of
1971 action steps, or as different types of TODO items. The first
1972 keywords are states requiring action - these states will select a headline
1973 for inclusion into the global TODO list Org-mode produces. If one of
1976 the last keyword is treated as the only DONE state of the sequence.
1979 additional state where no keyword is present. For details about this
1980 cycling, see the manual.
1982 TODO keywords and interpretation can also be set on a per-file basis with
1983 the special #+SEQ_TODO and #+TYP_TODO lines.
1985 Each keyword can optionally specify a character for fast state selection
1986 \(in combination with the variable `org-use-fast-todo-selection')
1987 and specifiers for state change logging, using the same syntax
1990 indicates to record a time stamp each time this state is selected.
1992 Each keyword may also specify if a timestamp or a note should be
1993 recorded when entering or leaving the state, by adding additional
1994 characters in the parenthesis after the keyword. This looks like this:
1996 record only the time of the state change. With X and Y being either
1998 Y when leaving the state if and only if the *target* state does not
1999 define X. You may omit any of the fast-selection key or X or /Y,
2000 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2002 For backward compatibility, this variable may also be just a list
2003 of keywords - in this case the interpretation (sequence or type) will be
2004 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2014 ;;Quick and dirty way to see
2015 ;;`org-todo-interpretations'. This takes the
2016 ;;place of item arguments
2017 :convert-widget
2024 org-todo-interpretation-widgets))
2025 widget))
2056 "Controls how TODO keywords are interpreted.
2057 This variable is in principle obsolete and is only used for
2058 backward compatibility, if the interpretation of todo keywords is
2059 not given already in `org-todo-keywords'. See that variable for
2060 more information."
2067 "Non-nil means use the fast todo selection scheme with C-c C-t.
2068 This variable describes if and under what circumstances the cycling
2069 mechanism for TODO keywords will be replaced by a single-key, direct
2070 selection scheme.
2072 When nil, fast selection is never used.
2074 When the symbol `prefix', it will be used when `org-todo' is called with
2075 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2076 in an agenda buffer.
2078 When t, fast selection is used by default. In this case, the prefix
2079 argument forces cycling instead.
2081 In all cases, the special interface is only used if access keys have actually
2082 been assigned by the user, i.e. if keywords in the configuration are followed
2083 by a letter in parenthesis, like TODO(t)."
2091 "Non-nil means update todo statistics after insert and toggle.
2092 ALL-HEADLINES means update todo statistics by including headlines
2093 with no TODO keyword as well, counting them as not done.
2094 A list of TODO keywords means the same, but skip keywords that are
2095 not in this list.
2097 When this is set, todo statistics is updated in the parent of the
2098 current entry each time a todo state is changed."
2108 "Non-nil means TODO statistics covers just direct children.
2109 When nil, all entries in the subtree are considered.
2110 This has only an effect if `org-provide-todo-statistics' is set.
2111 To set this to nil for only a single subtree, use a COOKIE_DATA
2117 "Hook which is run after the state of a TODO item was changed.
2118 The new state (a string with a TODO keyword, or nil) is available in the
2119 Lisp variable `state'."
2124 "Hook for functions that are allowed to block a state change.
2126 Each function gets as its single argument a property list, see
2127 `org-trigger-hook' for more information about this list.
2129 If any of the functions in this hook returns nil, the state change
2133 "Hook for functions that are triggered by a state change.
2135 Each function gets as its single argument a property list with at least
2136 the following elements:
2138 (:type type-of-change :position pos-at-entry-start
2139 :from old-state :to new-state)
2141 Depending on the type, more properties may be present.
2143 This mechanism is currently implemented for:
2145 TODO state changes
2146 ------------------
2147 :type todo-state-change
2148 :from previous state (keyword as a string), or nil, or a symbol
2149 'todo' or 'done', to indicate the general type of state.
2153 "Non-nil means undone TODO entries will block switching the parent to DONE.
2154 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2155 be blocked if any prior sibling is not yet done.
2156 Finally, if the parent is blocked because of ordered siblings of its own,
2157 the child will also be blocked.
2158 This variable needs to be set before org.el is loaded, and you need to
2159 restart Emacs after a change to make the change effective. The only way
2160 to change is while Emacs is running is through the customize interface."
2172 "Non-nil means unchecked boxes will block switching the parent to DONE.
2173 When this is nil, checkboxes have no influence on switching TODO states.
2174 When non-nil, you first need to check off all check boxes before the TODO
2175 entry can be switched to DONE.
2176 This variable needs to be set before org.el is loaded, and you need to
2177 restart Emacs after a change to make the change effective. The only way
2178 to change is while Emacs is running is through the customize interface."
2190 "Non-nil means inserting a TODO heading is treated as state change.
2192 logging will apply if appropriate. When nil, the new TODO item will
2193 be inserted directly, and no logging will take place."
2198 "Non-nil means switching TODO states with S-cursor counts as state change.
2199 This is the default behavior. However, setting this to nil allows a
2200 convenient way to select a TODO state and bypass any logging associated
2201 with that."
2206 "Tag changes that should be triggered by TODO state changes.
2207 This is a list. Each entry is
2209 (state-change (tag . flag) .......)
2211 State-change can be a string with a state, and empty string to indicate the
2212 state that has no TODO keyword, or it can be one of the symbols `todo'
2213 or `done', meaning any not-done or done state, respectively."
2227 "Information to record when a task moves to the DONE state.
2229 Possible values are:
2231 nil Don't add anything, just change the keyword
2232 time Add a time stamp to the task
2233 note Prompt for a note and add it with template `org-log-note-headings'
2235 This option can also be set with on a per-file-basis with
2237 #+STARTUP: nologdone
2238 #+STARTUP: logdone
2239 #+STARTUP: lognotedone
2241 You can have local logging settings for a subtree by setting the LOGGING
2242 property to one or more of these keywords."
2250 ;; Normalize old uses of org-log-done.
2257 "Information to record when the scheduling date of a tasks is modified.
2259 Possible values are:
2261 nil Don't add anything, just change the date
2262 time Add a time stamp to the task
2263 note Prompt for a note and add it with template `org-log-note-headings'
2265 This option can also be set with on a per-file-basis with
2267 #+STARTUP: nologreschedule
2268 #+STARTUP: logreschedule
2269 #+STARTUP: lognotereschedule"
2278 "Information to record when the deadline date of a tasks is modified.
2280 Possible values are:
2282 nil Don't add anything, just change the date
2283 time Add a time stamp to the task
2284 note Prompt for a note and add it with template `org-log-note-headings'
2286 This option can also be set with on a per-file-basis with
2288 #+STARTUP: nologredeadline
2289 #+STARTUP: logredeadline
2290 #+STARTUP: lognoteredeadline
2292 You can have local logging settings for a subtree by setting the LOGGING
2293 property to one or more of these keywords."
2302 "Non-nil means record a note when clocking out of an item.
2303 This can also be configured on a per-file basis by adding one of
2304 the following lines anywhere in the buffer:
2306 #+STARTUP: lognoteclock-out
2307 #+STARTUP: nolognoteclock-out"
2313 "Non-nil means the CLOSED time stamp will contain date and time.
2314 When nil, only the date will be recorded."
2328 "Headings for notes added to entries.
2329 The value is an alist, with the car being a symbol indicating the note
2330 context, and the cdr is the heading to be used. The heading may also be the
2331 empty string.
2332 %t in the heading will be replaced by a time stamp.
2333 %T will be an active time stamp instead the default inactive one
2334 %s will be replaced by the new TODO state, in double quotes.
2335 %S will be replaced by the old TODO state, in double quotes.
2336 %u will be replaced by the user name.
2337 %U will be replaced by the full user name.
2339 In fact, it is not a good idea to change the `state' entry, because
2340 agenda log mode depends on the format of these entries."
2346 "Heading when changing todo state (todo sequence only)"
2360 "Non-nil means insert state change notes and time stamps into a drawer.
2361 When nil, state changes notes will be inserted after the headline and
2362 any scheduling and clock lines, but not inside a drawer.
2364 The value of this variable should be the name of the drawer to use.
2365 LOGBOOK is proposed at the default drawer for this purpose, you can
2366 also set this to a string to define the drawer of your choice.
2370 If this variable is set, `org-log-state-notes-insert-after-drawers'
2371 will be ignored.
2373 You can set the property LOG_INTO_DRAWER to overrule this setting for
2374 a subtree."
2386 "Return the value of `org-log-into-drawer', but let properties overrule.
2387 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2388 used instead of the default value."
2396 "Non-nil means insert state change notes after any drawers in entry.
2397 Only the drawers that *immediately* follow the headline and the
2398 deadline/scheduled line are skipped.
2399 When nil, insert notes right after the heading and perhaps the line
2400 with deadline/scheduling if present.
2402 This variable will have no effect if `org-log-into-drawer' is
2403 set."
2409 "Non-nil means the latest state note will be directly after heading.
2410 When nil, the state change notes will be ordered according to time."
2416 "The TODO state to which a repeater should return the repeating task.
2417 By default this is the first task in a TODO sequence, or the previous state
2418 in a TODO_TYP set. But you can specify another task here.
2419 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2425 "Non-nil means record moving through the DONE state when triggering repeat.
2426 An auto-repeating task is immediately switched back to TODO when
2429 record a closing note, there will be no record of the task moving
2430 through DONE. This variable forces taking a note anyway.
2432 nil Don't force a record
2433 time Record a time stamp
2434 note Record a note
2436 This option can also be set with on a per-file-basis with
2438 #+STARTUP: logrepeat
2439 #+STARTUP: lognoterepeat
2440 #+STARTUP: nologrepeat
2442 You can have local logging settings for a subtree by setting the LOGGING
2443 property to one or more of these keywords."
2453 "Priorities in Org-mode."
2458 "Non-nil means priority commands are active.
2459 When nil, these commands will be disabled, so that you never accidentally
2460 set a priority."
2465 "The highest priority of TODO items. A character like ?A, ?B etc.
2466 Must have a smaller ASCII number than `org-lowest-priority'."
2471 "The lowest priority of TODO items. A character like ?A, ?B etc.
2472 Must have a larger ASCII number than `org-highest-priority'."
2477 "The default priority of TODO items.
2478 This is the priority an item get if no explicit priority is given."
2483 "Non-nil means start with default priority when starting to cycle.
2484 When this is nil, the first step in the cycle will be (depending on the
2485 command used) one higher or lower that the default priority."
2490 "Function to extract the priority from a string.
2491 The string is normally the headline. If this is nil Org computes the
2492 priority from the priority cookie like [#A] in the headline. It returns
2493 an integer, increasing by 1000 for each priority level.
2494 The user can set a different function here, which should take a string
2495 as an argument and return the numeric priority."
2500 "Options concerning time stamps and deadlines in Org-mode."
2505 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2506 When nil, these labeled time stamps are forces into the second line of an
2507 entry, just after the headline. When scheduling from the global TODO list,
2508 the time stamp will always be forced into the second line."
2513 "Formats for `format-time-string' which are used for time stamps.
2517 "Number of minutes to round time stamps to.
2518 These are two values, the first applies when first creating a time stamp.
2519 The second applies when changing it with the commands `S-up' and `S-down'.
2520 When changing the time stamp, this means that it will change in steps
2521 of N minutes, as given by the second value.
2523 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2524 numbers should be factors of 60, so for example 5, 10, 15.
2526 When this is larger than 1, you can still force an exact time stamp by using
2527 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2528 and by using a prefix arg to `S-up/down' to specify the exact number
2529 of minutes to shift."
2539 ;; Normalize old customizations of this variable.
2543 org-time-stamp-rounding-minutes)))
2546 "Non-nil means overlay custom formats over all time stamps.
2547 The formats are defined through the variable `org-time-stamp-custom-formats'.
2548 To turn this on on a per-file basis, insert anywhere in the file:
2549 #+STARTUP: customtime"
2557 "Custom formats for time stamps. See `format-time-string' for the syntax.
2558 These are overlayed over the default ISO format if the variable
2559 `org-display-custom-times' is set. Time like %H:%M should be at the
2560 end of the second format. The custom formats are also honored by export
2561 commands, if custom time display is turned on at the time of export."
2566 "Get the right format for a time string."
2571 f)))
2574 "The format string used when creating CLOCKSUM lines.
2575 This is also used when org-mode generates a time duration."
2581 org-mode generates a time duration."
2586 "The format string used when creating CLOCKSUM lines, or when
2587 org-mode generates a time duration."
2592 "No. of days before expiration during which a deadline becomes active.
2593 This variable governs the display in sparse trees and in the agenda.
2594 When 0 or negative, it means use this number (the absolute value of it)
2595 even if a deadline has a different individual lead time specified.
2597 Custom commands can set this variable in the options section."
2603 "Non-nil means assume future for incomplete date input from user.
2604 This affects the following situations:
2605 1. The user gives a month but not a year.
2608 2. The user gives a day, but no month.
2611 it will be considered as *this* month.
2613 If you set this variable to the symbol `time', then also the following
2614 will work:
2616 3. If the user gives a time, but no day. If the time is before now,
2617 to will be interpreted as tomorrow.
2619 Currently none of this works for ISO week specifications.
2621 When this option is nil, the current day, month and year will always be
2622 used as defaults.
2624 See also `org-agenda-jump-prefer-future'."
2632 "Should the agenda jump command prefer the future for incomplete dates?
2633 The default is to do the same as configured in `org-read-date-prefer-future'.
2634 But you can also set a deviating value here.
2635 This may t or nil, or the symbol `org-read-date-prefer-future'."
2640 org-read-date-prefer-future)
2645 "Non-nil means display current interpretation of date prompt live.
2646 This display will be in an overlay, in the minibuffer."
2651 "Non-nil means pop up a calendar when prompting for a date.
2652 In the calendar, the date can be selected with mouse-1. However, the
2653 minibuffer will also be active, and you can simply enter the date as well.
2654 When nil, only the minibuffer will be available."
2662 "Hook to be used to set up keys for the date/time interface.
2663 Add key definitions to `minibuffer-local-map', which will be a temporary
2664 copy."
2669 "The hour when your day really ends. Must be an integer.
2670 This has influence for the following applications:
2672 the time given here, the day recognized as TODAY is actually yesterday.
2673 - When a date is read from the user and it is still before the time given
2674 here, the current date and time will be assumed to be yesterday, 23:59.
2675 Also, timestamps inserted in remember templates follow this rule.
2677 IMPORTANT: This is a feature whose implementation is and likely will
2678 remain incomplete. Really, it is only here because past midnight seems to
2679 be the favorite working time of John Wiegley :-)"
2684 "Non-nil means S-down will increase the time in a time stamp.
2685 When nil, S-up will increase."
2690 "Non-nil means make the calendar window follow timestamp changes.
2691 When a timestamp is modified and the calendar window is visible, it will be
2692 moved to the new date."
2697 "Options concerning tags in Org-mode."
2702 "List of tags allowed in Org-mode files.
2703 When this list is nil, Org-mode will base TAG input on what is already in the
2704 buffer.
2705 The value of this variable is an alist, the car of each entry must be a
2706 keyword as a string, the cdr may be a character that is used to select
2707 that tag through the fast-tag-selection interface.
2708 See the manual for details."
2723 "List of tags that will always appear in all Org-mode files.
2724 This is in addition to any in buffer settings or customizations
2725 of `org-tag-alist'.
2726 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2727 The value of this variable is an alist, the car of each entry must be a
2728 keyword as a string, the cdr may be a character that is used to select
2729 that tag through the fast-tag-selection interface.
2730 See the manual for details.
2731 To disable these tags on a per-file basis, insert anywhere in the file:
2732 #+STARTUP: noptag"
2743 "If non-nil, always offer completion for all tags of all agenda files.
2744 Instead of customizing this variable directly, you might want to
2745 set it locally for capture buffers, because there no list of
2746 tags in that file can be created dynamically (there are none).
2748 (add-hook 'org-capture-mode-hook
2749 (lambda ()
2750 (set (make-local-variable
2751 'org-complete-tags-always-offer-all-agenda-tags)
2752 t)))"
2757 "List of tags that can be inherited by all entries in the file.
2758 The tags will be inherited if the variable `org-use-tag-inheritance'
2759 says they should be.
2763 "Non-nil means use fast tag selection scheme.
2764 This is a special interface to select and deselect tags with single keys.
2765 When nil, fast selection is never used.
2766 When the symbol `auto', fast selection is used if and only if selection
2767 characters for tags have been configured, either through the variable
2768 `org-tag-alist' or through a #+TAGS line in the buffer.
2769 When t, fast selection is always used and selection keys are assigned
2770 automatically if necessary."
2778 "Non-nil means fast tag selection exits after first change.
2779 When nil, you have to press RET to exit it.
2780 During fast tag selection, you can toggle this flag with `C-c'.
2781 This variable can also have the value `expert'. In this case, the window
2782 displaying the tags menu is not even shown, until you press C-c again."
2790 "Non-nil means fast tags selection interface will also offer TODO states.
2794 "The column to which tags should be indented in a headline.
2795 If this number is positive, it specifies the column. If it is negative,
2796 it means that the tags should be flushright to that column. For example,
2797 -80 works well for a normal 80 character screen."
2802 "Non-nil means realign tags after pro/demotion of TODO state change.
2803 These operations change the length of a headline and therefore shift
2804 the tags around. With this options turned on, after each such operation
2805 the tags are again aligned to `org-tags-column'."
2810 "Non-nil means tags in levels apply also for sublevels.
2811 When nil, only the tags directly given in a specific line apply there.
2812 This may also be a list of tags that should be inherited, or a regexp that
2813 matches tags that should be inherited. Additional control is possible
2814 with the variable `org-tags-exclude-from-inheritance' which gives an
2815 explicit list of tags to be excluded from inheritance., even if the value of
2816 `org-use-tag-inheritance' would select it for inheritance.
2818 If this option is t, a match early-on in a tree can lead to a large
2819 number of matches in the subtree when constructing the agenda or creating
2820 a sparse tree. If you only want to see the first match in a tree during
2821 a search, check out the variable `org-tags-match-list-sublevels'."
2830 "List of tags that should never be inherited.
2831 This is a way to exclude a few tags from inheritance. For way to do
2832 the opposite, to actively allow inheritance for selected tags,
2833 see the variable `org-use-tag-inheritance'."
2838 "Check if TAG is one that should be inherited."
2850 "Non-nil means list also sublevels of headlines matching a search.
2851 This variable applies to tags/property searches, and also to stuck
2852 projects because this search is based on a tags match as well.
2854 When set to the symbol `indented', sublevels are indented with
2855 leading dots.
2857 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2858 the sublevels of a headline matching a tag search often also match
2859 the same search. Listing all of them can create very long lists.
2860 Setting this variable to nil causes subtrees of a match to be skipped.
2862 This variable is semi-obsolete and probably should always be true. It
2863 is better to limit inheritance to certain tags using the variables
2864 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2872 "When set, tags are sorted using this function as a comparator."
2888 "Options concerning properties in Org-mode."
2893 "How property key/value pairs should be formatted by `indent-line'.
2894 When `indent-line' hits a property definition, it will format the line
2895 according to this format, mainly to make sure that the values are
2896 lined-up with respect to each other."
2901 "Non-nil means properties apply also for sublevels.
2903 This setting is chiefly used during property searches. Turning it on can
2904 cause significant overhead when doing a search, which is why it is not
2905 on by default.
2907 When nil, only the properties directly given in the current entry count.
2908 When t, every property is inherited. The value may also be a list of
2909 properties that should have inheritance, or a regular expression matching
2910 properties that should be inherited.
2912 However, note that some special properties use inheritance under special
2913 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2915 for valid values of a property.
2917 Note for programmers:
2918 When querying an entry with `org-entry-get', you can control if inheritance
2919 should be used. By default, `org-entry-get' looks only at the local
2920 properties. You can request inheritance by setting the inherit argument
2921 to t (to force inheritance) or to `selective' (to respect the setting
2922 in this variable)."
2931 "Check if PROPERTY is one that should be inherited."
2942 "The default column format, if no other format has been defined.
2943 This variable can be set on the per-file basis by inserting a line
2945 #+COLUMNS: %25ITEM ....."
2950 "The ellipses to be used when a field in column view is truncated.
2951 When this is the empty string, as many characters as possible are shown,
2952 but then there will be no visual indication that the field has been truncated.
2953 When this is a string of length N, the last N characters of a truncated
2954 field are replaced by this string. If the column is narrower than the
2955 ellipses string, only part of the ellipses string will be shown."
2960 "Function that modifies values for display in column view.
2961 For example, it can be used to cut out a certain part from a time stamp.
2962 The function must take 2 arguments:
2964 column-title The title of the column (*not* the property name)
2965 value The value that should be modified.
2967 The function should return the value that should be displayed,
2968 or nil if the normal value should be used."
2973 "The property that is being used to keep track of effort estimates.
2974 Effort estimates given in this property need to have the format H:MM."
2982 "List of property/value pairs that can be inherited by any entry.
2984 These are fixed values, for the preset properties. The user variable
2985 that can be used to add to this list is `org-global-properties'.
2987 The entries in this list are cons cells where the car is a property
2988 name and cdr is a string with the value. If the value represents
2993 "List of property/value pairs that can be inherited by any entry.
2995 This list will be combined with the constant `org-global-properties-fixed'.
2997 The entries in this list are cons cells where the car is a property
2998 name and cdr is a string with the value.
3000 You can set buffer-local values for the same purpose in the variable
3001 `org-file-properties' this by adding lines like
3003 #+PROPERTY: NAME VALUE"
3010 "List of property/value pairs that can be inherited by any entry.
3011 Valid for the current buffer.
3016 "Options concerning agenda views in Org-mode."
3021 "Variable used by org files to set a category for agenda display.
3022 Such files should use a file variable to set it, for example
3026 or contain a special line
3028 #+CATEGORY: ELisp
3030 If the file does not specify a category, then file's base name
3036 "The files to be used for agenda display.
3040 If an entry is a directory, all files in that directory that are matched by
3041 `org-agenda-file-regexp' will be part of the file list.
3043 If the value of the variable is not a list but a single file name, then
3044 the list of agenda files is actually stored and maintained in that file, one
3045 agenda file per line. In this file paths can be given relative to
3046 `org-directory'. Tilde expansion and environment variable substitution
3047 are also made."
3054 "Regular expression to match files for `org-agenda-files'.
3055 If any element in the list in that variable contains a directory instead
3056 of a normal file, all files in that directory that are matched by this
3057 regular expression will be included."
3062 "List of extra files to be searched by text search commands.
3063 These files will be search in addition to the agenda files by the
3064 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3065 Note that these files will only be searched for text search commands,
3066 not for the other agenda views like todo lists, tag searches or the weekly
3067 agenda. This variable is intended to list notes and possibly archive files
3068 that should also be searched by these two commands.
3069 In fact, if the first element in the list is the symbol `agenda-archives',
3070 than all archive files of all agenda files will be added to the search
3071 scope."
3082 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3083 A nil value means to remove them, after a query, from the list."
3088 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3089 The command `org-calendar-goto-agenda' will be bound to this key. The
3090 default is the character `c' because then `c' can be used to switch back and
3091 forth between agenda and calendar."
3096 "The key to be installed in `calendar-mode-map' for agenda-action.
3097 The command `org-agenda-action' will be bound to this key. The
3098 default is the character `k' because we use the same key in the agenda."
3103 "The key to be installed in `calendar-mode-map' for adding diary entries.
3104 This option is irrelevant until `org-agenda-diary-file' has been configured
3105 to point to an Org-mode file. When that is the case, the command
3106 `org-agenda-diary-entry' will be bound to the key given here, by default
3107 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3108 if you want to continue doing this, you need to change this to a different
3109 key."
3114 "File to which to add new entries with the `i' key in agenda and calendar.
3115 When this is the symbol `diary-file', the functionality in the Emacs
3116 calendar will be used to add entries to the `diary-file'. But when this
3117 points to a file, `org-agenda-diary-entry' will be used instead."
3133 org-calendar-insert-diary-entry-key
3137 "Options for embedding LaTeX code into Org-mode."
3145 "Options for creating images from LaTeX fragments.
3146 This is a property list with the following properties:
3148 `default' means use the foreground of the default face.
3150 `default' means use the background of the default face.
3151 :scale a scaling factor for the size of the images, to get more pixels
3152 :html-foreground, :html-background, :html-scale
3153 the same numbers for HTML export.
3154 :matchers a list indicating which matchers should be used to
3155 find LaTeX fragments. Valid members of this list are:
3166 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3167 When nil, just push out a message."
3176 \[PACKAGES]
3177 \[DEFAULT-PACKAGES]
3178 % The settings below are copied from fullpage.sty
3191 "The document header used for processing LaTeX fragments.
3192 It is imperative that this header make sure that no page number
3193 appears on the page. The package defined in the variables
3194 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3196 will be appended."
3203 "Set the packages alist and make sure it has 3 elements per entry."
3207 x))
3208 val)))
3212 "Get the packages alist and make sure it has 3 elements per entry."
3216 x))
3219 ;; The following variables are defined here because is it also used
3220 ;; when formatting latex fragments. Originally it was part of the
3221 ;; LaTeX exporter, which is why the name includes "export".
3238 )
3239 "Alist of default packages to be inserted in the header.
3240 Change this only if one of the packages here causes an incompatibility
3241 with another package you are using.
3242 The packages in this list are needed by one part or another of Org-mode
3243 to function properly.
3245 - inputenc, fontenc: for basic font and character selection
3246 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3247 for interpreting the entities in `org-entities'. You can skip some of these
3248 packages if you don't use any of the symbols in it.
3249 - graphicx: for including images
3250 - float, wrapfig: for figure placement
3251 - longtable: for long tables
3252 - hyperref: for cross references
3254 Therefore you should not modify this variable unless you know what you
3255 are doing. The one reason to change it anyway is that you might be loading
3256 some other package that conflicts with one of the default packages.
3258 If SNIPPET-FLAG is t, the package also needs to be included when
3259 compiling LaTeX snippets into images for inclusion into HTML."
3272 "Alist of packages to be inserted in every LaTeX header.
3273 These will be inserted after `org-export-latex-default-packages-alist'.
3275 SNIPPET-FLAG, when t, indicates that this package is also needed when
3276 turning LaTeX snippets into images for inclusion into HTML.
3277 Make sure that you only list packages here which:
3278 - you want in every file
3279 - do not conflict with the default packages in
3280 `org-export-latex-default-packages-alist'
3281 - do not conflict with the setup in `org-format-latex-header'."
3295 "Settings for Org-mode appearance."
3300 "Non-nil means fontify only the stars in each headline.
3301 When nil, the entire headline is fontified.
3302 Changing it requires restart of `font-lock-mode' to become effective
3303 also in regions already fontified."
3308 "Non-nil means hide the first N-1 stars in a headline.
3309 This works by using the face `org-hide' for these stars. This
3310 face is white for a light background, and black for a dark
3311 background. You may have to customize the face `org-hide' to
3312 make this work.
3313 Changing it requires restart of `font-lock-mode' to become effective
3314 also in regions already fontified.
3315 You may also set this on a per-file basis by adding one of the following
3316 lines to the buffer:
3318 #+STARTUP: hidestars
3319 #+STARTUP: showstars"
3324 "List of symbols corresponding to keywords to be hidden the org buffer.
3325 For example, a value '(title) for this list will make the document's title
3326 appear in the buffer without the initial #+TITLE: keyword."
3334 "Non-nil means change the face of a headline if it is marked DONE.
3335 Normally, only the TODO/DONE keyword indicates the state of a headline.
3336 When this is non-nil, the headline after the keyword is set to the
3337 `org-headline-done' as an additional indication."
3342 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3343 Changing this variable requires a restart of Emacs to take effect."
3348 "Non-nil means fontify the whole line for headings.
3349 This is useful when setting a background color for the
3350 org-level-* faces."
3355 "Non-nil means fontify what is treated specially by the exporters."
3360 "Non-nil mean font-lock should hide the emphasis marker characters."
3365 "Non-nil means show entities as UTF8 characters.
3371 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3376 "Regular expression for matching emphasis.
3377 After a match, the match groups contain these elements:
3378 0 The match of the full regular expression, including the characters
3379 before and after the proper match
3380 1 The character before the proper match, or empty at beginning of line
3381 2 The proper match, including the leading and trailing markers
3382 3 The leading marker like * or /, indicating the type of highlighting
3383 4 The text between the emphasis markers, not including the markers
3390 "Set variable and compute the emphasis regular expression."
3394 org-emphasis-alist org-emphasis-regexp-components)
3406 ;; make sure special characters appear at the right position in the class
3418 ;; Make the regexp
3426 body1
3438 body1
3446 "Components used to build the regular expression for emphasis.
3447 This is a list with five entries. Terminology: In an emphasis string
3451 specify what is allowed/forbidden in each part:
3453 pre Chars allowed as prematch. Beginning of line will be allowed too.
3454 post Chars allowed as postmatch. End of line will be allowed too.
3455 border The chars *forbidden* as border characters.
3457 non-shy groups here, and don't allow newline here.
3458 newline The maximum number of newlines allowed in an emphasis exp.
3460 Use customize to modify this, or restart Emacs after changing it."
3479 )
3480 "Special syntax for emphasized text.
3481 Text starting and ending with a special character will be emphasized, for
3482 example *bold*, _underlined_ and /italic/. This variable sets the marker
3483 characters, the face to be used by font-lock for highlighting in Org-mode
3484 Emacs buffers, and the HTML tags to be used for this.
3485 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3486 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3487 Use customize to modify this, or restart Emacs after changing it."
3502 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3505 ;;; Miscellaneous options
3508 "Completion in Org-mode."
3513 "Non-nil means use ido completion wherever possible.
3514 Note that `ido-mode' must be active for this variable to be relevant.
3515 If you decide to turn this variable on, you might well want to turn off
3516 `org-outline-path-complete-in-steps'.
3517 See also `org-completion-use-iswitchb'."
3522 "Non-nil means use iswitchb completion wherever possible.
3523 Note that `iswitchb-mode' must be active for this variable to be relevant.
3524 If you decide to turn this variable on, you might well want to turn off
3525 `org-outline-path-complete-in-steps'.
3526 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3532 Normal means, no org-mode-specific context."
3536 ;;; Functions and variables from their packages
3537 ;; Declared here to avoid compiler warnings
3539 ;; XEmacs only
3545 ;; Emacs only
3548 ;; Various packages
3566 org-format-agenda-item "org-agenda"
3597 ;;; Autoload and prepare some org modules
3599 ;; Some table stuff that needs to be defined here, because it is used
3600 ;; by the functions setting up org-mode or checking for table context.
3613 "Detect the first line outside a table when searching from within it.
3616 ;; Autoload the functions in org-table.el that are needed by functions here.
3621 org-table-convert org-table-convert-region org-table-copy-down
3622 org-table-copy-region org-table-create
3623 org-table-create-or-convert-from-region
3624 org-table-create-with-table.el org-table-current-dline
3625 org-table-cut-region org-table-delete-column org-table-edit-field
3626 org-table-edit-formulas org-table-end org-table-eval-formula
3627 org-table-export org-table-field-info
3628 org-table-get-stored-formulas org-table-goto-column
3629 org-table-hline-and-move org-table-import org-table-insert-column
3630 org-table-insert-hline org-table-insert-row org-table-iterate
3631 org-table-justify-field-maybe org-table-kill-row
3632 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3633 org-table-move-column org-table-move-column-left
3634 org-table-move-column-right org-table-move-row
3635 org-table-move-row-down org-table-move-row-up
3636 org-table-next-field org-table-next-row org-table-paste-rectangle
3637 org-table-previous-field org-table-recalculate
3638 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3639 org-table-toggle-coordinate-overlays
3640 org-table-toggle-formula-debugger org-table-wrap-region
3641 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3642 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3643 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3646 "Return t if the cursor is inside an org-type table.
3647 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3652 org-table-line-regexp)))
3653 nil))
3657 "Return t if and only if we are at a table.el table."
3663 "If there is a table.el table nearby, recognize it and move into it."
3669 nil
3679 t
3684 t)
3685 nil)
3686 nil))
3689 "Return t if the cursor is inside a hline in a table."
3694 nil))
3699 "Apply FUNCTION to the start of all tables in the buffer."
3715 ;; Declare and autoload functions from org-exp.el & Co
3723 org-insert-export-options-template
3724 org-table-clean-before-export))
3727 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3728 org-export-region-as-ascii))
3731 org-replace-region-by-latex org-export-region-as-latex
3732 org-export-as-latex org-export-as-pdf
3733 org-export-as-pdf-and-open))
3736 org-export-as-html-batch org-export-as-html-to-buffer
3737 org-replace-region-by-html org-export-region-as-html
3738 org-export-as-html))
3741 org-replace-region-by-docbook org-export-region-as-docbook
3742 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3743 org-export-as-docbook))
3746 org-export-icalendar-all-agenda-files
3747 org-export-icalendar-combine-agenda-files))
3751 ;; Declare and autoload functions from org-agenda.el
3756 org-todo-list org-tags-view org-agenda-list-stuck-projects
3757 org-diary org-agenda-to-appt
3758 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3760 ;; Autoload org-remember
3765 org-remember-apply-template org-remember org-remember-handler)))
3770 org-capture-import-remember-templates)))
3772 ;; Autoload org-clock.el
3787 "Return non-nil if clock is currently running.
3788 The return value is actually the clock marker."
3793 "org-clock"
3795 org-clock-goto org-clock-sum org-clock-display
3796 org-clock-remove-overlays org-clock-report
3797 org-clocktable-shift org-dblock-write:clocktable
3798 org-get-clocktable org-resolve-clocks)))
3801 "If this is a CLOCK line, update it and return t.
3802 Otherwise, return nil."
3811 ts te h m s neg)
3814 nil)
3819 ;; The clock is running here
3840 t))))))
3843 "Check if the current buffer contains the running clock.
3844 If yes, offer to stop it and to save the buffer with the changes."
3853 "Check if this line starts a clock table, if yes, shift the time block."
3857 ;; Autoload org-timer.el
3861 "org-timer"
3863 org-timer-change-times-in-region
3864 org-timer-set-timer
3865 org-timer-reset-timers
3866 org-timer-show-remaining-time)))
3868 ;; Autoload org-feed.el
3872 "org-feed"
3876 ;; Autoload org-indent.el
3878 ;; Define the variable already here, to make sure we have it.
3880 "Non-nil if Org-Indent mode is enabled.
3885 "org-indent"
3888 ;; Autoload org-mobile.el
3892 "org-mobile"
3895 ;; Autoload archiving code
3896 ;; The stuff that is needed for cycling and tags has to be defined here.
3899 "Options concerning archiving in Org-mode."
3904 "The location where subtrees should be archived.
3906 The value of this variable is a string, consisting of two parts,
3907 separated by a double-colon. The first part is a filename and
3908 the second part is a headline.
3910 When the filename is omitted, archiving happens in the same file.
3911 %s in the filename will be replaced by the current file
3912 name (without the directory part). Archiving to a different file
3913 is useful to keep archived entries from contributing to the
3914 Org-mode Agenda.
3916 The archived entries will be filed as subtrees of the specified
3917 headline. When the headline is omitted, the subtrees are simply
3918 filed away at the end of the file, as top-level entries. Also in
3919 the heading you can use %s to represent the file name, this can be
3920 useful when using the same archive for a number of different files.
3922 Here are a few examples:
3924 If the current file is Projects.org, archive in file
3925 Projects.org_archive, as top-level trees. This is the default.
3928 Archive in the current file, under the top-level headline
3932 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3935 Archive in file ~/org/archive.org (absolute path), under headlines
3939 Archive in file ./basement (relative path), as level 3 trees
3942 You may set this option on a per-file basis by adding to the buffer a
3943 line like
3945 #+ARCHIVE: basement::** Finished Tasks
3947 You may also define it locally for a subtree by setting an ARCHIVE property
3948 in the entry. If such a property is found in an entry, or anywhere up
3949 the hierarchy, it will be used."
3954 "The tag that marks a subtree as archived.
3955 An archived subtree does not open during visibility cycling, and does
3956 not contribute to the agenda listings.
3957 After changing this, font-lock must be restarted in the relevant buffers to
3958 get the proper fontification."
3964 "Non-nil means the agenda will skip any items located in archived trees.
3965 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3966 variable is no longer recommended, you should leave it at the value t.
3967 Instead, use the key `v' to cycle the archives-mode in the agenda."
3973 "Non-nil means ignore archived trees when creating column view."
3979 "Non-nil means `org-cycle' will open archived trees.
3980 An archived tree is a tree marked with the tag ARCHIVE.
3981 When nil, archived trees will stay folded. You can still open them with
3982 normal outline commands like `show-all', but not with the cycling commands."
3988 "Non-nil means sparse tree construction shows matches in archived trees.
3989 When nil, matches in these trees are highlighted, but the trees are kept in
3990 collapsed state."
3996 "Re-hide all archived subtrees after a visibility state change."
4007 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4010 "Cycle subtree even if it is archived."
4017 "Re-hide all archived subtrees after a visibility state change."
4032 flag)))
4039 org-archive-to-archive-sibling org-toggle-archive-tag
4040 org-archive-subtree-default
4041 org-archive-subtree-default-with-confirmation)))
4043 ;; Autoload Column View Code
4051 org-columns-compute org-agenda-columns org-columns-remove-overlays
4054 ;; Autoload ID code
4062 org-id-get-with-outline-path-completion
4063 org-id-get-with-outline-drilling org-id-store-link
4064 org-id-goto org-id-find org-id-store-link))
4066 ;; Autoload Plotting Code
4071 ;;; Variables for pre-computed regular expressions, all buffer local
4089 "Matches a headline and puts everything into groups:
4090 group 1: the stars
4091 group 2: The todo keyword, maybe
4092 group 3: Priority cookie
4093 group 4: True headline
4097 "Printf format to make regexp to match an exact headline.
4098 This regexp will match the headline of any node which hase the exact
4099 headline text that is put into the format, but may have any TODO state,
4103 "Matches a headline and puts TODO state into group 2 if present.
4158 "Regular expression to match a plain time or time range.
4159 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4160 groups carry important information:
4161 0 the full match
4162 1 the first time, range or not
4170 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4171 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4172 groups carry important information:
4173 0 the full match
4174 7 hours of duration
4183 "Regular expression to match a timestamp time or time range.
4184 After a match, the following groups carry important information:
4185 0 the full match
4186 1 date plus weekday, for back referencing to make sure both times are on the same day
4187 2 the first time, range or not
4242 "Variable associated with STARTUP options for org-mode.
4243 Each element is a list of three items: The startup options as written
4244 in the #+STARTUP line, the corresponding variable, and the value to
4245 set this variable to if the option is found. An optional forth element PUSH
4249 "Precompute regular expressions for current buffer."
4269 kwds kws0 kwsa key log value cat arch tags const links hw dws
4270 tail sep kws1 prio props ftags drawers beamer-p
4292 ;; general TODO-like setup
4304 links)))
4310 props)))
4315 ftags
4325 l var val)
4355 ))))
4372 ;; Process the TODO keywords
4374 ;; Use the global values as if they had been given locally.
4386 kws)))
4389 kwsa nil
4392 ;; 1 2
4400 kw)
4402 kws0)
4419 ;; Process the constants
4427 ;; Process the tags.
4438 tgs))
4446 ;; Compute the regular expressions and other local variables
4454 org-drawer-regexp
4458 org-not-done-keywords
4460 org-todo-regexp
4463 org-not-done-regexp
4467 org-not-done-heading-regexp
4471 org-todo-line-regexp
4475 org-complex-heading-regexp
4480 org-complex-heading-regexp-format
4489 org-nl-done-regexp
4493 org-todo-line-tags-regexp
4498 org-looking-at-done-regexp
4503 org-deadline-time-regexp
4505 org-deadline-line-regexp
4507 org-scheduled-regexp
4509 org-scheduled-time-regexp
4511 org-closed-time-regexp
4513 org-keyword-time-regexp
4519 org-keyword-time-not-clock-regexp
4525 org-maybe-keyword-time-regexp
4531 org-planning-or-clock-line-re
4536 org-all-time-keywords
4539 org-clock-string org-closed-string))
4540 )
4545 "Return the contents of FILE, as a string."
4559 "Extract the log state setting from a TODO keyword string.
4573 "Remove a pair of parenthesis at the end of each string in LIST."
4577 x))
4578 list))
4581 "Assign fast keys to a keyword-key alist.
4582 Respect keys that are already there."
4600 ;;; Some variables used in various places
4607 "Function to be called when `C-c C-c' is used.
4611 ;; FIXME: Occasionally check by commenting these, to make sure
4612 ;; no other functions uses these, forgetting to let-bind them.
4617 ;; Defined somewhere in this file, but used before definition.
4623 ;;;; Define the Org-mode
4626 (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"))
4629 ;; We use a before-change function to check if a table might need
4630 ;; an update.
4632 "Indicates that a table might need an update.
4633 This variable is set by `org-before-change-function'.
4636 "Every change indicates that a table might need an update."
4647 ;;;###autoload
4649 "Outline-based notes management and organizer, alias
4652 Org-mode develops organizational tasks around a NOTES file which
4653 contains information about projects as plain text. Org-mode is
4654 implemented on top of outline-mode, which is ideal to keep the content
4655 of large files well structured. It supports ToDo items, deadlines and
4656 time stamps, which magically appear in the diary listing of the Emacs
4657 calendar. Tables are easily created with a built-in table editor.
4658 Plain text URL-like links connect to websites, emails (VM), Usenet
4659 messages (Gnus), BBDB entries, and any files related to the project.
4660 For printing and sharing of notes, an Org-mode file (or a part of it)
4661 can be exported as a structured ASCII or HTML file.
4663 The following commands are available:
4667 ;; Get rid of Outline menus, they are not needed
4668 ;; Need to do this here because define-derived-mode sets up
4669 ;; the keymap so late. Still, it is a waste to call this each time
4670 ;; we switch another buffer into org-mode.
4673 ;; Assume this is Greg's port, it uses easymenu
4698 org-display-table 4
4701 org-ellipsis)))
4706 ;; tag faces set outside customize.... force initialization.
4708 ;; Calc embedded
4714 ;; Activate before-change-function
4718 ;; Check for running clock before killing a buffer
4720 ;; Paragraphs and auto-filling
4724 ;; Beginning/end of defun
4727 ;; Next error for sparse trees
4729 ;; Make sure dependence stuff works reliably, even for users who set it
4730 ;; too late :-(
4742 ;; Comment characters
4746 ;; Align options lines
4748 'align-mode-rules-list
4753 ;; Imenu
4757 ;; Make isearch reveal context
4760 ;; Emacs 21 and XEmacs make use of the hook
4762 ;; Emacs 22 deals with this through a special variable
4766 ;; Turn on org-beamer-mode?
4769 ;; Setup the pcomplete hooks
4780 ;; If empty file that did not turn on org-mode automatically, make it to.
4805 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4815 "Return today date, considering `org-extend-today-until'."
4820 ;;;; Font-Lock stuff, including the activators
4851 "Regular expression used to analyze links.
4852 Here is what the match groups contain after a match:
4853 1: http:
4854 2: http
4855 3: path
4856 4: [desc]
4864 "Number of stacked braces for sub/superscript matching.
4865 This has to be set before loading org.el to be effective."
4870 "Create a regular expression which will match a balanced sexp.
4871 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4872 as single character strings.
4873 The regexp returned will match the entire expression including the
4874 delimiters. It will also define a single group which contains the
4875 match except for the outermost delimiters. The maximum depth of
4876 stacked delimiters is N. Escaping delimiters is not possible."
4905 "Update the link regular expressions.
4906 This should be called after the variable `org-link-types' has changed."
4910 org-link-re-with-space
4916 org-link-re-with-space2
4922 org-link-re-with-space3
4927 org-angle-link-re
4933 org-plain-link-re
4937 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4938 org-bracket-link-regexp
4940 org-bracket-link-analytic-regexp
4948 org-bracket-link-analytic-regexp++
4956 org-any-link-re
4967 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4968 "Regular expression matching time strings for analysis.
4969 This one does not require the space after the date, so it can be used
4971 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4987 "Regular expression matching a time stamp or time stamp range.
4993 "Run through the buffer and add overlays to links."
5002 'face
5015 rtn))
5018 "Insert or change an emphasis, i.e. a font like bold or italic.
5019 If there is an active region, change that region to a new emphasis.
5020 If there is no region, just insert the marker characters and position
5021 the cursor between them.
5022 CHAR should be either the marker character, or the first character of the
5023 HTML tag associated with that emphasis. If CHAR is a space, the means
5024 to remove the emphasis of the selected region.
5025 If char is not given (for example in an interactive call) it
5026 will be prompted for."
5077 "Run through the buffer and add overlays to links."
5086 nil
5092 t)))))
5100 t)))
5103 "When non-nil, fontify code in code blocks."
5109 "Fontify #+ lines and blocks, in the correct ways."
5112 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5113 limit t)
5121 end end1 quoting block-type)
5124 ;; a single line of backend-specific content
5132 ; for backend-specific code
5133 t)
5135 ;; Truly a block
5147 beg end
5151 ; for end_src
5159 ; end of source block
5167 t))
5180 ;; just any other in-buffer setting, but not indented
5184 t)
5192 t)
5200 "Run through the buffer and add overlays to links."
5208 t)))
5211 "Run through the buffer and add overlays to links."
5213 limit t)
5218 'keymap org-mouse-map
5219 'help-echo
5221 "Footnote definition"
5223 ))
5225 t)))
5228 "Run through the buffer and add overlays to bracketed links."
5232 ;; FIXME: above we should remove the escapes.
5233 ;; but that requires another match, protecting match data,
5234 ;; a lot of overhead for font-lock.
5241 ;; We need to remove the invisible property here. Table narrowing
5242 ;; may have made some of this invisible.
5260 t)))
5263 "Run through the buffer and add overlays to dates."
5275 t)))
5284 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5288 "Run through the buffer and add overlays to target matches."
5296 'keymap org-mouse-map
5300 t)))))
5303 "Find all radio targets in this file and update the regular expression."
5318 t)))
5325 ;; This should be with the exporter code, but we also use if for font-locking
5335 "Compute regular expression for stuff treated specially by exporters."
5342 org-latex-regexps)))
5370 org-entities)))
5374 org-latex-entities)
5375 nil))
5377 ))
5378 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5381 org-export-html-special-string-regexps)))
5386 ))))
5388 'org-latex-and-specials-regexp
5393 "Run through the buffer and add overlays to links."
5397 limit t))
5411 rtn)))
5414 "Restart `font-lock-mode', to force refontification."
5420 "Return a list of all targets in this file.
5421 With optional argument RADIO, only find radio targets."
5423 rtn)
5428 rtn)))
5431 "Make regular expression matching all strings in TARGETS.
5432 The regular expression finds the targets also if there is a line break
5433 between words."
5442 x)
5443 targets
5455 t)))
5458 "Compute the outline level of the heading at point.
5459 This function assumes that the cursor is at the beginning of a line matched
5460 by `outline-regexp'. Otherwise it returns garbage.
5461 If this is called at a normal headline, the level is the number of stars.
5462 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
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)))
5843 outline-regexp
5851 org-cycle-hook))
5855 ;; special case: use global cycling
5869 ;; Table: enter it or move to the next field.
5880 ;; Global cycling: delegate to `org-cycle-internal-global'.
5883 ;; Drawers: delegate to `org-flag-drawer'.
5891 ;; Show-subtree, ARG levels up from here.
5899 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5905 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5912 ;; From there: TAB emulation and template completion.
5936 t
5945 "Do the global cycling action."
5949 ;; We just created the overview - now do table of contents
5950 ;; This can be slow in very large buffers, so indicate action
5960 ;; We just showed the table of contents - now show everything
5968 ;; Default action: go to overview
5976 "Do the local cycling action."
5978 ;; First, determine end of headline (EOH), end of subtree or item
5979 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6003 ;; Determine end invisible part of buffer (EOL)
6005 ;; XEmacs doesn't have `next-single-char-property-change'
6015 ;; Find out what to do next and set `this-command'
6018 ;; Nothing is hidden behind this heading
6030 org-cycle-skip-children-state-if-no-children))))
6031 ;; Entire subtree is hidden in one line: children view
6037 ;; Fold every list in subtree to top-level items.
6059 ;; We just showed the children, or no children are there,
6060 ;; now show everything.
6067 ;; Default action: hide the subtree.
6074 ;;;###autoload
6076 "Cycle the global visibility. For details see `org-cycle'.
6078 With a numeric prefix, show all headlines up to that level."
6094 "Set the visibility required by startup options and properties."
6109 "Switch subtree visibilities according to :VISIBILITY: property."
6116 nil t)
6141 "Switch to overview mode, showing only top-level headlines.
6142 Really, this shows all headlines with level equal or greater than the level
6143 of the first headline in the buffer. This is important, because if the
6144 first headline is not level one, then (hide-sublevels 1) gives confusing
6145 results."
6156 "Show all headlines in the buffer, like a table of contents.
6157 With numerical argument N, show content up to level N."
6160 ;; Visit all headings and show their offspring
6167 t)
6176 "Adjust the window after a change in outline visibility.
6177 This function is the default value of the hook `org-cycle-hook'."
6187 "Remove outline overlays that do not contain non-white stuff."
6197 "Fix visibility issues after moving a subtree."
6198 ;; First, find a reasonable region to look at:
6199 ;; Start two siblings above, end three below
6217 ;; Properly fold already folded siblings
6228 "Show empty lines above all visible headlines.
6229 The region to be covered depends on STATE when called through
6230 `org-cycle-hook'. Lisp program can use t for STATE to get the
6231 entire buffer covered. Note that an empty line is only shown if there
6232 are at least `org-cycle-separator-lines' empty lines before the headline."
6242 beg end b e)
6266 ;; Never hide empty lines at the end of the file.
6276 "Move to the parent and re-show empty lines before visible headlines."
6282 "Return `org-agenda-files' list, plus all open org-mode files.
6283 This is useful for operations that need to scan all of a user's
6284 open and agenda-wise Org files."
6292 files))
6295 "Return the beginning position of the current entry."
6299 "Return the end position of the current entry."
6303 "Re-hide all drawers after a visibility state change."
6330 "Is the end of the current subtree visible?"
6335 "Move cursor to the first headline and recenter the headline.
6336 Optional argument N means put the headline into the Nth line of the window."
6342 ;;; Saving and restoring visibility
6345 "Return a list of the locations of all outline overlays.
6346 These are overlays with the `invisible' property value `outline'.
6347 The return value is a list of cons cells, with start and stop
6348 positions for each overlay.
6349 If USE-MARKERS is set, return the positions as markers."
6367 "Create visibility overlays for all positions in DATA.
6368 DATA should have been made by `org-outline-overlay-data'."
6377 data)))))
6379 ;;; Folding of blocks
6390 "Call FUNCTION at the head of all source blocks in the current buffer.
6391 Optional arguments START and END can be used to limit the range."
6403 "Toggle the visibility of all blocks in the current buffer."
6407 "Fold all blocks in the current buffer."
6413 "Unfold all blocks in the current buffer."
6419 "Toggle visibility of block at point."
6430 "Toggle the visibility of the current block."
6437 ov)
6453 ;; make the block accessible to isearch
6455 ov 'isearch-open-invisible
6466 ;; org-tab-after-check-for-cycling-hook
6468 ;; Remove overlays when changing major mode
6473 ;;; Org-goto
6479 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6495 nil)
6496 (org-defkey map "q" 'org-goto-quit)
6497 (org-defkey map "n" 'outline-next-visible-heading)
6498 (org-defkey map "p" 'outline-previous-visible-heading)
6499 (org-defkey map "f" 'outline-forward-same-level)
6500 (org-defkey map "b" 'outline-backward-same-level)
6501 (org-defkey map "u" 'outline-up-heading))
6502 (org-defkey map "/" 'org-occur)
6503 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6504 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6505 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6506 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6507 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6508 map))
6510 (defconst org-goto-help
6511 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6512 RET=jump to location [Q]uit and return to previous location
6513 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6515 (defvar org-goto-start-pos) ; dynamically scoped parameter
6517 ;; FIXME: Docstring does not mention both interfaces
6518 (defun org-goto (&optional alternative-interface)
6519 "Look up a different location in the current file, keeping current visibility.
6521 When you want look-up or go to a different location in a document, the
6522 fastest way is often to fold the entire buffer and then dive into the tree.
6523 This method has the disadvantage, that the previous location will be folded,
6524 which may not be what you want.
6526 This command works around this by showing a copy of the current buffer
6527 in an indirect buffer, in overview mode. You can dive into the tree in
6528 that copy, use org-occur and incremental search to find a location.
6529 When pressing RET or `Q', the command returns to the original buffer in
6530 which the visibility is still unchanged. After RET is will also jump to
6531 the location selected in the indirect buffer and expose the
6532 the headline hierarchy above."
6533 (interactive "P")
6534 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6535 (org-refile-use-outline-path t)
6536 (org-refile-target-verify-function nil)
6537 (interface
6538 (if (not alternative-interface)
6539 org-goto-interface
6540 (if (eq org-goto-interface 'outline)
6541 'outline-path-completion
6542 'outline)))
6543 (org-goto-start-pos (point))
6544 (selected-point
6545 (if (eq interface 'outline)
6546 (car (org-get-location (current-buffer) org-goto-help))
6547 (let ((pa (org-refile-get-location "Goto: ")))
6548 (org-refile-check-position pa)
6549 (nth 3 pa)))))
6550 (if selected-point
6551 (progn
6552 (org-mark-ring-push org-goto-start-pos)
6553 (goto-char selected-point)
6554 (if (or (outline-invisible-p) (org-invisible-p2))
6555 (org-show-context 'org-goto)))
6556 (message "Quit"))))
6558 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6559 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6560 (defvar org-goto-local-auto-isearch-map) ; defined below
6562 (defun org-get-location (buf help)
6563 "Let the user select a location in the Org-mode buffer BUF.
6564 This function uses a recursive edit. It returns the selected position
6565 or nil."
6566 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6567 (isearch-hide-immediately nil)
6568 (isearch-search-fun-function
6569 (lambda () 'org-goto-local-search-headings))
6570 (org-goto-selected-point org-goto-exit-command)
6571 (pop-up-frames nil)
6572 (special-display-buffer-names nil)
6573 (special-display-regexps nil)
6574 (special-display-function nil))
6575 (save-excursion
6576 (save-window-excursion
6577 (delete-other-windows)
6578 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6579 (switch-to-buffer
6580 (condition-case nil
6581 (make-indirect-buffer (current-buffer) "*org-goto*")
6582 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6583 (with-output-to-temp-buffer "*Help*"
6584 (princ help))
6585 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6586 (setq buffer-read-only nil)
6587 (let ((org-startup-truncated t)
6588 (org-startup-folded nil)
6589 (org-startup-align-all-tables nil))
6590 (org-mode)
6591 (org-overview))
6592 (setq buffer-read-only t)
6593 (if (and (boundp 'org-goto-start-pos)
6594 (integer-or-marker-p org-goto-start-pos))
6595 (let ((org-show-hierarchy-above t)
6596 (org-show-siblings t)
6597 (org-show-following-heading t))
6598 (goto-char org-goto-start-pos)
6599 (and (outline-invisible-p) (org-show-context)))
6600 (goto-char (point-min)))
6601 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6602 (message "Select location and press RET")
6603 (use-local-map org-goto-map)
6604 (recursive-edit)
6605 ))
6606 (kill-buffer "*org-goto*")
6607 (cons org-goto-selected-point org-goto-exit-command)))
6609 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6610 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6611 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6612 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6614 (defun org-goto-local-search-headings (string bound noerror)
6615 "Search and make sure that any matches are in headlines."
6616 (catch 'return
6617 (while (if isearch-forward
6618 (search-forward string bound noerror)
6619 (search-backward string bound noerror))
6620 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6621 (and (member :headline context)
6622 (not (member :tags context))))
6623 (throw 'return (point))))))
6625 (defun org-goto-local-auto-isearch ()
6626 "Start isearch."
6627 (interactive)
6628 (goto-char (point-min))
6629 (let ((keys (this-command-keys)))
6630 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6631 (isearch-mode t)
6632 (isearch-process-search-char (string-to-char keys)))))
6634 (defun org-goto-ret (&optional arg)
6635 "Finish `org-goto' by going to the new location."
6636 (interactive "P")
6637 (setq org-goto-selected-point (point)
6638 org-goto-exit-command 'return)
6639 (throw 'exit nil))
6641 (defun org-goto-left ()
6642 "Finish `org-goto' by going to the new location."
6643 (interactive)
6644 (if (org-on-heading-p)
6645 (progn
6646 (beginning-of-line 1)
6647 (setq org-goto-selected-point (point)
6648 org-goto-exit-command 'left)
6649 (throw 'exit nil))
6650 (error "Not on a heading")))
6652 (defun org-goto-right ()
6653 "Finish `org-goto' by going to the new location."
6654 (interactive)
6655 (if (org-on-heading-p)
6656 (progn
6657 (setq org-goto-selected-point (point)
6658 org-goto-exit-command 'right)
6659 (throw 'exit nil))
6660 (error "Not on a heading")))
6662 (defun org-goto-quit ()
6663 "Finish `org-goto' without cursor motion."
6664 (interactive)
6665 (setq org-goto-selected-point nil)
6666 (setq org-goto-exit-command 'quit)
6667 (throw 'exit nil))
6669 ;;; Indirect buffer display of subtrees
6671 (defvar org-indirect-dedicated-frame nil
6672 "This is the frame being used for indirect tree display.")
6673 (defvar org-last-indirect-buffer nil)
6675 (defun org-tree-to-indirect-buffer (&optional arg)
6676 "Create indirect buffer and narrow it to current subtree.
6677 With numerical prefix ARG, go up to this level and then take that tree.
6678 If ARG is negative, go up that many levels.
6679 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6680 indirect buffer previously made with this command, to avoid proliferation of
6681 indirect buffers. However, when you call the command with a \
6683 when `org-indirect-buffer-display' is `new-frame', the last buffer
6684 is kept so that you can work with several indirect buffers at the same time.
6685 If `org-indirect-buffer-display' is `dedicated-frame', the \
6687 requests that a new frame be made for the new buffer, so that the dedicated
6688 frame is not changed."
6689 (interactive "P")
6690 (let ((cbuf (current-buffer))
6691 (cwin (selected-window))
6692 (pos (point))
6693 beg end level heading ibuf)
6694 (save-excursion
6695 (org-back-to-heading t)
6696 (when (numberp arg)
6697 (setq level (org-outline-level))
6698 (if (< arg 0) (setq arg (+ level arg)))
6699 (while (> (setq level (org-outline-level)) arg)
6700 (outline-up-heading 1 t)))
6701 (setq beg (point)
6702 heading (org-get-heading))
6703 (org-end-of-subtree t t)
6704 (if (org-on-heading-p) (backward-char 1))
6705 (setq end (point)))
6706 (if (and (buffer-live-p org-last-indirect-buffer)
6707 (not (eq org-indirect-buffer-display 'new-frame))
6708 (not arg))
6709 (kill-buffer org-last-indirect-buffer))
6710 (setq ibuf (org-get-indirect-buffer cbuf)
6711 org-last-indirect-buffer ibuf)
6712 (cond
6713 ((or (eq org-indirect-buffer-display 'new-frame)
6714 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6715 (select-frame (make-frame))
6716 (delete-other-windows)
6717 (switch-to-buffer ibuf)
6718 (org-set-frame-title heading))
6719 ((eq org-indirect-buffer-display 'dedicated-frame)
6720 (raise-frame
6721 (select-frame (or (and org-indirect-dedicated-frame
6722 (frame-live-p org-indirect-dedicated-frame)
6723 org-indirect-dedicated-frame)
6724 (setq org-indirect-dedicated-frame (make-frame)))))
6725 (delete-other-windows)
6726 (switch-to-buffer ibuf)
6727 (org-set-frame-title (concat "Indirect: " heading)))
6728 ((eq org-indirect-buffer-display 'current-window)
6729 (switch-to-buffer ibuf))
6730 ((eq org-indirect-buffer-display 'other-window)
6731 (pop-to-buffer ibuf))
6732 (t (error "Invalid value")))
6733 (if (featurep 'xemacs)
6734 (save-excursion (org-mode) (turn-on-font-lock)))
6735 (narrow-to-region beg end)
6736 (show-all)
6737 (goto-char pos)
6738 (and (window-live-p cwin) (select-window cwin))))
6740 (defun org-get-indirect-buffer (&optional buffer)
6741 (setq buffer (or buffer (current-buffer)))
6742 (let ((n 1) (base (buffer-name buffer)) bname)
6743 (while (buffer-live-p
6744 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6745 (setq n (1+ n)))
6746 (condition-case nil
6747 (make-indirect-buffer buffer bname 'clone)
6748 (error (make-indirect-buffer buffer bname)))))
6750 (defun org-set-frame-title (title)
6751 "Set the title of the current frame to the string TITLE."
6752 ;; FIXME: how to name a single frame in XEmacs???
6753 (unless (featurep 'xemacs)
6754 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6756 ;;;; Structure editing
6758 ;;; Inserting headlines
6760 (defun org-previous-line-empty-p ()
6761 (save-excursion
6762 (and (not (bobp))
6763 (or (beginning-of-line 0) t)
6764 (save-match-data
6767 (defun org-insert-heading (&optional force-heading invisible-ok)
6768 "Insert a new heading or item with same depth at point.
6769 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6770 If point is at the beginning of a headline, insert a sibling before the
6771 current headline. If point is not at the beginning, split the line,
6772 create the new headline with the text in the current line after point
6773 \(but see also the variable `org-M-RET-may-split-line').
6775 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6776 This is important for non-interactive uses of the command."
6777 (interactive "P")
6778 (if (or (= (buffer-size) 0)
6779 (and (not (save-excursion
6780 (and (ignore-errors (org-back-to-heading invisible-ok))
6781 (org-on-heading-p))))
6782 (not (org-in-item-p))))
6783 (progn
6785 (run-hooks 'org-insert-heading-hook))
6786 (when (or force-heading (not (org-insert-item)))
6787 (let* ((empty-line-p nil)
6788 (level nil)
6789 (on-heading (org-on-heading-p))
6790 (head (save-excursion
6791 (condition-case nil
6792 (progn
6793 (org-back-to-heading invisible-ok)
6794 (when (and (not on-heading)
6795 (featurep 'org-inlinetask)
6796 (integerp org-inlinetask-min-level)
6797 (>= (length (match-string 0))
6798 org-inlinetask-min-level))
6799 ;; Find a heading level before the inline task
6800 (while (and (setq level (org-up-heading-safe))
6801 (>= level org-inlinetask-min-level)))
6802 (if (org-on-heading-p)
6803 (org-back-to-heading invisible-ok)
6804 (error "This should not happen")))
6805 (setq empty-line-p (org-previous-line-empty-p))
6806 (match-string 0))
6807 (error "*"))))
6808 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6809 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6810 pos hide-previous previous-pos)
6811 (cond
6812 ((and (org-on-heading-p) (bolp)
6813 (or (bobp)
6814 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6815 ;; insert before the current line
6816 (open-line (if blank 2 1)))
6817 ((and (bolp)
6818 (not org-insert-heading-respect-content)
6819 (or (bobp)
6820 (save-excursion
6821 (backward-char 1) (not (outline-invisible-p)))))
6822 ;; insert right here
6823 nil)
6824 (t
6825 ;; somewhere in the line
6826 (save-excursion
6827 (setq previous-pos (point-at-bol))
6828 (end-of-line)
6829 (setq hide-previous (outline-invisible-p)))
6830 (and org-insert-heading-respect-content (org-show-subtree))
6831 (let ((split
6832 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6833 (save-excursion
6834 (let ((p (point)))
6835 (goto-char (point-at-bol))
6836 (and (looking-at org-complex-heading-regexp)
6837 (> p (match-beginning 4)))))))
6838 tags pos)
6839 (cond
6840 (org-insert-heading-respect-content
6841 (org-end-of-subtree nil t)
6842 (when (featurep 'org-inlinetask)
6843 (while (and (not (eobp))
6845 (>= (length (match-string 1))
6846 org-inlinetask-min-level))
6847 (org-end-of-subtree nil t)))
6848 (or (bolp) (newline))
6849 (or (org-previous-line-empty-p)
6850 (and blank (newline)))
6851 (open-line 1))
6852 ((org-on-heading-p)
6853 (when hide-previous
6854 (show-children)
6855 (org-show-entry))
6857 (setq tags (and (match-end 2) (match-string 2)))
6858 (and (match-end 1)
6859 (delete-region (match-beginning 1) (match-end 1)))
6860 (setq pos (point-at-bol))
6861 (or split (end-of-line 1))
6862 (delete-horizontal-space)
6864 (buffer-substring (point-at-bol) (point)))
6865 (insert " "))
6866 (newline (if blank 2 1))
6867 (when tags
6868 (save-excursion
6869 (goto-char pos)
6870 (end-of-line 1)
6871 (insert " " tags)
6872 (org-set-tags nil 'align))))
6873 (t
6874 (or split (end-of-line 1))
6875 (newline (if blank 2 1)))))))
6876 (insert head) (just-one-space)
6877 (setq pos (point))
6878 (end-of-line 1)
6879 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6880 (when (and org-insert-heading-respect-content hide-previous)
6881 (save-excursion
6882 (goto-char previous-pos)
6883 (hide-subtree)))
6884 (run-hooks 'org-insert-heading-hook)))))
6886 (defun org-get-heading (&optional no-tags)
6887 "Return the heading of the current entry, without the stars."
6888 (save-excursion
6889 (org-back-to-heading t)
6890 (if (looking-at
6891 (if no-tags
6894 (match-string 1) "")))
6896 (defun org-heading-components ()
6897 "Return the components of the current heading.
6898 This is a list with the following elements:
6899 - the level as an integer
6900 - the reduced level, different if `org-odd-levels-only' is set.
6901 - the TODO keyword, or nil
6902 - the priority character, like ?A, or nil if no priority is given
6903 - the headline text itself, or the tags string if no headline text
6904 - the tags string, or nil."
6905 (save-excursion
6906 (org-back-to-heading t)
6907 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6908 (list (length (match-string 1))
6909 (org-reduced-level (length (match-string 1)))
6910 (org-match-string-no-properties 2)
6911 (and (match-end 3) (aref (match-string 3) 2))
6912 (org-match-string-no-properties 4)
6913 (org-match-string-no-properties 5)))))
6915 (defun org-get-entry ()
6916 "Get the entry text, after heading, entire subtree."
6917 (save-excursion
6918 (org-back-to-heading t)
6919 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6921 (defun org-insert-heading-after-current ()
6922 "Insert a new heading with same level as current, after current subtree."
6923 (interactive)
6924 (org-back-to-heading)
6925 (org-insert-heading)
6926 (org-move-subtree-down)
6927 (end-of-line 1))
6929 (defun org-insert-heading-respect-content ()
6930 (interactive)
6931 (let ((org-insert-heading-respect-content t))
6932 (org-insert-heading t)))
6934 (defun org-insert-todo-heading-respect-content (&optional force-state)
6935 (interactive "P")
6936 (let ((org-insert-heading-respect-content t))
6937 (org-insert-todo-heading force-state t)))
6939 (defun org-insert-todo-heading (arg &optional force-heading)
6940 "Insert a new heading with the same level and TODO state as current heading.
6941 If the heading has no TODO state, or if the state is DONE, use the first
6942 state (TODO by default). Also with prefix arg, force first state."
6943 (interactive "P")
6944 (when (or force-heading (not (org-insert-item 'checkbox)))
6945 (org-insert-heading force-heading)
6946 (save-excursion
6947 (org-back-to-heading)
6948 (outline-previous-heading)
6949 (looking-at org-todo-line-regexp))
6950 (let*
6951 ((new-mark-x
6952 (if (or arg
6953 (not (match-beginning 2))
6954 (member (match-string 2) org-done-keywords))
6955 (car org-todo-keywords-1)
6956 (match-string 2)))
6957 (new-mark
6958 (or
6959 (run-hook-with-args-until-success
6960 'org-todo-get-default-hook new-mark-x nil)
6961 new-mark-x)))
6962 (beginning-of-line 1)
6964 (if org-treat-insert-todo-heading-as-state-change
6965 (org-todo new-mark)
6966 (insert new-mark " "))))
6967 (when org-provide-todo-statistics
6968 (org-update-parent-todo-statistics))))
6970 (defun org-insert-subheading (arg)
6971 "Insert a new subheading and demote it.
6972 Works for outline headings and for plain lists alike."
6973 (interactive "P")
6974 (org-insert-heading arg)
6975 (cond
6976 ((org-on-heading-p) (org-do-demote))
6977 ((org-at-item-p) (org-indent-item))))
6979 (defun org-insert-todo-subheading (arg)
6980 "Insert a new subheading with TODO keyword or checkbox and demote it.
6981 Works for outline headings and for plain lists alike."
6982 (interactive "P")
6983 (org-insert-todo-heading arg)
6984 (cond
6985 ((org-on-heading-p) (org-do-demote))
6986 ((org-at-item-p) (org-indent-item))))
6988 ;;; Promotion and Demotion
6990 (defvar org-after-demote-entry-hook nil
6991 "Hook run after an entry has been demoted.
6992 The cursor will be at the beginning of the entry.
6993 When a subtree is being demoted, the hook will be called for each node.")
6995 (defvar org-after-promote-entry-hook nil
6996 "Hook run after an entry has been promoted.
6997 The cursor will be at the beginning of the entry.
6998 When a subtree is being promoted, the hook will be called for each node.")
7000 (defun org-promote-subtree ()
7001 "Promote the entire subtree.
7002 See also `org-promote'."
7003 (interactive)
7004 (save-excursion
7005 (org-map-tree 'org-promote))
7006 (org-fix-position-after-promote))
7008 (defun org-demote-subtree ()
7009 "Demote the entire subtree. See `org-demote'.
7010 See also `org-promote'."
7011 (interactive)
7012 (save-excursion
7013 (org-map-tree 'org-demote))
7014 (org-fix-position-after-promote))
7017 (defun org-do-promote ()
7018 "Promote the current heading higher up the tree.
7019 If the region is active in `transient-mark-mode', promote all headings
7020 in the region."
7021 (interactive)
7022 (save-excursion
7023 (if (org-region-active-p)
7024 (org-map-region 'org-promote (region-beginning) (region-end))
7025 (org-promote)))
7026 (org-fix-position-after-promote))
7028 (defun org-do-demote ()
7029 "Demote the current heading lower down the tree.
7030 If the region is active in `transient-mark-mode', demote all headings
7031 in the region."
7032 (interactive)
7033 (save-excursion
7034 (if (org-region-active-p)
7035 (org-map-region 'org-demote (region-beginning) (region-end))
7036 (org-demote)))
7037 (org-fix-position-after-promote))
7039 (defun org-fix-position-after-promote ()
7040 "Make sure that after pro/demotion cursor position is right."
7041 (let ((pos (point)))
7042 (when (save-excursion
7043 (beginning-of-line 1)
7044 (looking-at org-todo-line-regexp)
7045 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7046 (cond ((eobp) (insert " "))
7047 ((eolp) (insert " "))
7048 ((equal (char-after) ?\ ) (forward-char 1))))))
7050 (defun org-current-level ()
7051 "Return the level of the current entry, or nil if before the first headline.
7052 The level is the number of stars at the beginning of the headline."
7053 (save-excursion
7054 (org-with-limited-levels
7055 (ignore-errors
7056 (org-back-to-heading t)
7057 (funcall outline-level)))))
7059 (defun org-get-previous-line-level ()
7060 "Return the outline depth of the last headline before the current line.
7061 Returns 0 for the first headline in the buffer, and nil if before the
7062 first headline."
7063 (let ((current-level (org-current-level))
7064 (prev-level (when (> (line-number-at-pos) 1)
7065 (save-excursion
7066 (beginning-of-line 0)
7067 (org-current-level)))))
7068 (cond ((null current-level) nil) ; Before first headline
7069 ((null prev-level) 0) ; At first headline
7070 (prev-level))))
7072 (defun org-reduced-level (l)
7073 "Compute the effective level of a heading.
7074 This takes into account the setting of `org-odd-levels-only'."
7075 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7077 (defun org-level-increment ()
7078 "Return the number of stars that will be added or removed at a
7079 time to headlines when structure editing, based on the value of
7080 `org-odd-levels-only'."
7081 (if org-odd-levels-only 2 1))
7083 (defun org-get-valid-level (level &optional change)
7084 "Rectify a level change under the influence of `org-odd-levels-only'
7085 LEVEL is a current level, CHANGE is by how much the level should be
7086 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7087 even level numbers will become the next higher odd number."
7088 (if org-odd-levels-only
7089 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7090 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7091 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7092 (max 1 (+ level (or change 0)))))
7094 (if (boundp 'define-obsolete-function-alias)
7095 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7096 (define-obsolete-function-alias 'org-get-legal-level
7097 'org-get-valid-level)
7098 (define-obsolete-function-alias 'org-get-legal-level
7099 'org-get-valid-level "23.1")))
7101 (defun org-promote ()
7102 "Promote the current heading higher up the tree.
7103 If the region is active in `transient-mark-mode', promote all headings
7104 in the region."
7105 (org-back-to-heading t)
7106 (let* ((level (save-match-data (funcall outline-level)))
7107 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7108 (diff (abs (- level (length up-head) -1))))
7109 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7110 (replace-match up-head nil t)
7111 ;; Fixup tag positioning
7112 (and org-auto-align-tags (org-set-tags nil t))
7113 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7114 (run-hooks 'org-after-promote-entry-hook)))
7116 (defun org-demote ()
7117 "Demote the current heading lower down the tree.
7118 If the region is active in `transient-mark-mode', demote all headings
7119 in the region."
7120 (org-back-to-heading t)
7121 (let* ((level (save-match-data (funcall outline-level)))
7122 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7123 (diff (abs (- level (length down-head) -1))))
7124 (replace-match down-head nil t)
7125 ;; Fixup tag positioning
7126 (and org-auto-align-tags (org-set-tags nil t))
7127 (if org-adapt-indentation (org-fixup-indentation diff))
7128 (run-hooks 'org-after-demote-entry-hook)))
7130 (defun org-cycle-level ()
7131 "Cycle the level of an empty headline through possible states.
7132 This goes first to child, then to parent, level, then up the hierarchy.
7133 After top level, it switches back to sibling level."
7134 (interactive)
7135 (let ((org-adapt-indentation nil))
7136 (when (org-point-at-end-of-empty-headline)
7137 (setq this-command 'org-cycle-level) ; Only needed for caching
7138 (let ((cur-level (org-current-level))
7139 (prev-level (org-get-previous-line-level)))
7140 (cond
7141 ;; If first headline in file, promote to top-level.
7142 ((= prev-level 0)
7143 (loop repeat (/ (- cur-level 1) (org-level-increment))
7144 do (org-do-promote)))
7145 ;; If same level as prev, demote one.
7146 ((= prev-level cur-level)
7147 (org-do-demote))
7148 ;; If parent is top-level, promote to top level if not already.
7149 ((= prev-level 1)
7150 (loop repeat (/ (- cur-level 1) (org-level-increment))
7151 do (org-do-promote)))
7152 ;; If top-level, return to prev-level.
7153 ((= cur-level 1)
7154 (loop repeat (/ (- prev-level 1) (org-level-increment))
7155 do (org-do-demote)))
7156 ;; If less than prev-level, promote one.
7157 ((< cur-level prev-level)
7158 (org-do-promote))
7159 ;; If deeper than prev-level, promote until higher than
7160 ;; prev-level.
7161 ((> cur-level prev-level)
7162 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7163 do (org-do-promote))))
7164 t))))
7166 (defun org-map-tree (fun)
7167 "Call FUN for every heading underneath the current one."
7168 (org-back-to-heading)
7169 (let ((level (funcall outline-level)))
7170 (save-excursion
7171 (funcall fun)
7172 (while (and (progn
7173 (outline-next-heading)
7174 (> (funcall outline-level) level))
7175 (not (eobp)))
7176 (funcall fun)))))
7178 (defun org-map-region (fun beg end)
7179 "Call FUN for every heading between BEG and END."
7180 (let ((org-ignore-region t))
7181 (save-excursion
7182 (setq end (copy-marker end))
7183 (goto-char beg)
7184 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7185 (< (point) end))
7186 (funcall fun))
7187 (while (and (progn
7188 (outline-next-heading)
7189 (< (point) end))
7190 (not (eobp)))
7191 (funcall fun)))))
7193 (defun org-fixup-indentation (diff)
7194 "Change the indentation in the current entry by DIFF.
7195 However, if any line in the current entry has no indentation, or if it
7196 would end up with no indentation after the change, nothing at all is done."
7197 (save-excursion
7198 (let ((end (save-excursion (outline-next-heading)
7199 (point-marker)))
7200 (prohibit (if (> diff 0)
7203 col)
7204 (unless (save-excursion (end-of-line 1)
7205 (re-search-forward prohibit end t))
7206 (while (and (< (point) end)
7208 (goto-char (match-end 0))
7209 (setq col (current-column))
7210 (if (< diff 0) (replace-match ""))
7211 (org-indent-to-column (+ diff col))))
7212 (move-marker end nil))))
7214 (defun org-convert-to-odd-levels ()
7215 "Convert an org-mode file with all levels allowed to one with odd levels.
7216 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7217 level 5 etc."
7218 (interactive)
7219 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7220 (let ((outline-regexp org-outline-regexp)
7221 (outline-level 'org-outline-level)
7222 (org-odd-levels-only nil) n)
7223 (save-excursion
7224 (goto-char (point-min))
7226 (setq n (- (length (match-string 0)) 2))
7227 (while (>= (setq n (1- n)) 0)
7228 (org-demote))
7229 (end-of-line 1))))))
7231 (defun org-convert-to-oddeven-levels ()
7232 "Convert an org-mode file with only odd levels to one with odd/even levels.
7233 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7234 file contains a section with an even level, conversion would
7235 destroy the structure of the file. An error is signaled in this
7236 case."
7237 (interactive)
7238 (goto-char (point-min))
7239 ;; First check if there are no even levels
7241 (org-show-context t)
7242 (error "Not all levels are odd in this file. Conversion not possible"))
7243 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7244 (let ((outline-regexp org-outline-regexp)
7245 (outline-level 'org-outline-level)
7246 (org-odd-levels-only nil) n)
7247 (save-excursion
7248 (goto-char (point-min))
7250 (setq n (/ (1- (length (match-string 0))) 2))
7251 (while (>= (setq n (1- n)) 0)
7252 (org-promote))
7253 (end-of-line 1))))))
7255 (defun org-tr-level (n)
7256 "Make N odd if required."
7257 (if org-odd-levels-only (1+ (/ n 2)) n))
7259 ;;; Vertical tree motion, cutting and pasting of subtrees
7261 (defun org-move-subtree-up (&optional arg)
7262 "Move the current subtree up past ARG headlines of the same level."
7263 (interactive "p")
7264 (org-move-subtree-down (- (prefix-numeric-value arg))))
7266 (defun org-move-subtree-down (&optional arg)
7267 "Move the current subtree down past ARG headlines of the same level."
7268 (interactive "p")
7269 (setq arg (prefix-numeric-value arg))
7270 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7271 'org-get-last-sibling))
7272 (ins-point (make-marker))
7273 (cnt (abs arg))
7274 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7275 ;; Select the tree
7276 (org-back-to-heading)
7277 (setq beg0 (point))
7278 (save-excursion
7279 (setq ne-beg (org-back-over-empty-lines))
7280 (setq beg (point)))
7281 (save-match-data
7282 (save-excursion (outline-end-of-heading)
7283 (setq folded (outline-invisible-p)))
7284 (outline-end-of-subtree))
7285 (outline-next-heading)
7286 (setq ne-end (org-back-over-empty-lines))
7287 (setq end (point))
7288 (goto-char beg0)
7289 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7290 ;; include less whitespace
7291 (save-excursion
7292 (goto-char beg)
7293 (forward-line (- ne-beg ne-end))
7294 (setq beg (point))))
7295 ;; Find insertion point, with error handling
7296 (while (> cnt 0)
7297 (or (and (funcall movfunc) (looking-at outline-regexp))
7298 (progn (goto-char beg0)
7299 (error "Cannot move past superior level or buffer limit")))
7300 (setq cnt (1- cnt)))
7301 (if (> arg 0)
7302 ;; Moving forward - still need to move over subtree
7303 (progn (org-end-of-subtree t t)
7304 (save-excursion
7305 (org-back-over-empty-lines)
7306 (or (bolp) (newline)))))
7307 (setq ne-ins (org-back-over-empty-lines))
7308 (move-marker ins-point (point))
7309 (setq txt (buffer-substring beg end))
7310 (org-save-markers-in-region beg end)
7311 (delete-region beg end)
7312 (org-remove-empty-overlays-at beg)
7313 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7314 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7316 (let ((bbb (point)))
7317 (insert-before-markers txt)
7318 (org-reinstall-markers-in-region bbb)
7319 (move-marker ins-point bbb))
7321 (setq ins-end (point))
7322 (goto-char ins-point)
7323 (org-skip-whitespace)
7324 (when (and (< arg 0)
7325 (org-first-sibling-p)
7326 (> ne-ins ne-beg))
7327 ;; Move whitespace back to beginning
7328 (save-excursion
7329 (goto-char ins-end)
7330 (let ((kill-whole-line t))
7331 (kill-line (- ne-ins ne-beg)) (point)))
7333 (move-marker ins-point nil)
7334 (if folded
7335 (hide-subtree)
7336 (org-show-entry)
7337 (show-children)
7338 (org-cycle-hide-drawers 'children))
7339 (org-clean-visibility-after-subtree-move)))
7341 (defvar org-subtree-clip ""
7342 "Clipboard for cut and paste of subtrees.
7343 This is actually only a copy of the kill, because we use the normal kill
7344 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7346 (defvar org-subtree-clip-folded nil
7347 "Was the last copied subtree folded?
7348 This is used to fold the tree back after pasting.")
7350 (defun org-cut-subtree (&optional n)
7351 "Cut the current subtree into the clipboard.
7352 With prefix arg N, cut this many sequential subtrees.
7353 This is a short-hand for marking the subtree and then cutting it."
7354 (interactive "p")
7355 (org-copy-subtree n 'cut))
7357 (defun org-copy-subtree (&optional n cut force-store-markers)
7358 "Cut the current subtree into the clipboard.
7359 With prefix arg N, cut this many sequential subtrees.
7360 This is a short-hand for marking the subtree and then copying it.
7361 If CUT is non-nil, actually cut the subtree.
7362 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7363 of some markers in the region, even if CUT is non-nil. This is
7364 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7365 (interactive "p")
7366 (let (beg end folded (beg0 (point)))
7367 (if (interactive-p)
7368 (org-back-to-heading nil) ; take what looks like a subtree
7369 (org-back-to-heading t)) ; take what is really there
7370 (org-back-over-empty-lines)
7371 (setq beg (point))
7373 (save-match-data
7374 (save-excursion (outline-end-of-heading)
7375 (setq folded (outline-invisible-p)))
7376 (condition-case nil
7377 (org-forward-same-level (1- n) t)
7378 (error nil))
7379 (org-end-of-subtree t t))
7380 (org-back-over-empty-lines)
7381 (setq end (point))
7382 (goto-char beg0)
7383 (when (> end beg)
7384 (setq org-subtree-clip-folded folded)
7385 (when (or cut force-store-markers)
7386 (org-save-markers-in-region beg end))
7387 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7388 (setq org-subtree-clip (current-kill 0))
7389 (message "%s: Subtree(s) with %d characters"
7390 (if cut "Cut" "Copied")
7391 (length org-subtree-clip)))))
7393 (defun org-paste-subtree (&optional level tree for-yank)
7394 "Paste the clipboard as a subtree, with modification of headline level.
7395 The entire subtree is promoted or demoted in order to match a new headline
7396 level.
7398 If the cursor is at the beginning of a headline, the same level as
7399 that headline is used to paste the tree
7401 If not, the new level is derived from the *visible* headings
7402 before and after the insertion point, and taken to be the inferior headline
7403 level of the two. So if the previous visible heading is level 3 and the
7404 next is level 4 (or vice versa), level 4 will be used for insertion.
7405 This makes sure that the subtree remains an independent subtree and does
7406 not swallow low level entries.
7408 You can also force a different level, either by using a numeric prefix
7409 argument, or by inserting the heading marker by hand. For example, if the
7412 If optional TREE is given, use this text instead of the kill ring.
7414 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7415 move back over whitespace before inserting, and move point to the end of
7416 the inserted text when done."
7417 (interactive "P")
7418 (setq tree (or tree (and kill-ring (current-kill 0))))
7419 (unless (org-kill-is-subtree-p tree)
7420 (error "%s"
7421 (substitute-command-keys
7423 (let* ((visp (not (outline-invisible-p)))
7424 (txt tree)
7429 (old-level (if (string-match ^re txt)
7430 (- (match-end 0) (match-beginning 0) 1)
7431 -1))
7432 (force-level (cond (level (prefix-numeric-value level))
7434 (string-match
7435 ^re_ (buffer-substring
7436 (point-at-bol) (point))))
7437 (- (match-end 1) (match-beginning 1)))
7438 ((and (bolp)
7439 (looking-at org-outline-regexp))
7440 (- (match-end 0) (point) 1))
7441 (t nil)))
7442 (previous-level (save-excursion
7443 (condition-case nil
7444 (progn
7445 (outline-previous-visible-heading 1)
7446 (if (looking-at re)
7447 (- (match-end 0) (match-beginning 0) 1)
7448 1))
7449 (error 1))))
7450 (next-level (save-excursion
7451 (condition-case nil
7452 (progn
7453 (or (looking-at outline-regexp)
7454 (outline-next-visible-heading 1))
7455 (if (looking-at re)
7456 (- (match-end 0) (match-beginning 0) 1)
7457 1))
7458 (error 1))))
7459 (new-level (or force-level (max previous-level next-level)))
7460 (shift (if (or (= old-level -1)
7461 (= new-level -1)
7462 (= old-level new-level))
7463 0
7464 (- new-level old-level)))
7465 (delta (if (> shift 0) -1 1))
7466 (func (if (> shift 0) 'org-demote 'org-promote))
7467 (org-odd-levels-only nil)
7468 beg end newend)
7469 ;; Remove the forced level indicator
7470 (if force-level
7471 (delete-region (point-at-bol) (point)))
7472 ;; Paste
7473 (beginning-of-line 1)
7474 (unless for-yank (org-back-over-empty-lines))
7475 (setq beg (point))
7476 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7477 (insert-before-markers txt)
7479 (setq newend (point))
7480 (org-reinstall-markers-in-region beg)
7481 (setq end (point))
7482 (goto-char beg)
7484 (setq beg (point))
7485 (if (and (outline-invisible-p) visp)
7486 (save-excursion (outline-show-heading)))
7487 ;; Shift if necessary
7488 (unless (= shift 0)
7489 (save-restriction
7490 (narrow-to-region beg end)
7491 (while (not (= shift 0))
7492 (org-map-region func (point-min) (point-max))
7493 (setq shift (+ delta shift)))
7494 (goto-char (point-min))
7495 (setq newend (point-max))))
7496 (when (or (interactive-p) for-yank)
7497 (message "Clipboard pasted as level %d subtree" new-level))
7498 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7499 kill-ring
7500 (eq org-subtree-clip (current-kill 0))
7501 org-subtree-clip-folded)
7502 ;; The tree was folded before it was killed/copied
7503 (hide-subtree))
7504 (and for-yank (goto-char newend))))
7506 (defun org-kill-is-subtree-p (&optional txt)
7507 "Check if the current kill is an outline subtree, or a set of trees.
7508 Returns nil if kill does not start with a headline, or if the first
7509 headline level is not the largest headline level in the tree.
7510 So this will actually accept several entries of equal levels as well,
7511 which is OK for `org-paste-subtree'.
7512 If optional TXT is given, check this string instead of the current kill."
7513 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7514 (start-level (and kill
7517 kill)
7518 (- (match-end 2) (match-beginning 2) 1)))
7519 (re (concat "^" org-outline-regexp))
7520 (start (1+ (or (match-beginning 2) -1))))
7521 (if (not start-level)
7522 (progn
7523 nil) ;; does not even start with a heading
7524 (catch 'exit
7525 (while (setq start (string-match re kill (1+ start)))
7526 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7527 (throw 'exit nil)))
7528 t))))
7530 (defvar org-markers-to-move nil
7531 "Markers that should be moved with a cut-and-paste operation.
7532 Those markers are stored together with their positions relative to
7533 the start of the region.")
7535 (defun org-save-markers-in-region (beg end)
7536 "Check markers in region.
7537 If these markers are between BEG and END, record their position relative
7538 to BEG, so that after moving the block of text, we can put the markers back
7539 into place.
7540 This function gets called just before an entry or tree gets cut from the
7541 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7542 called immediately, to move the markers with the entries."
7543 (setq org-markers-to-move nil)
7544 (when (featurep 'org-clock)
7545 (org-clock-save-markers-for-cut-and-paste beg end))
7546 (when (featurep 'org-agenda)
7547 (org-agenda-save-markers-for-cut-and-paste beg end)))
7549 (defun org-check-and-save-marker (marker beg end)
7550 "Check if MARKER is between BEG and END.
7551 If yes, remember the marker and the distance to BEG."
7552 (when (and (marker-buffer marker)
7553 (equal (marker-buffer marker) (current-buffer)))
7554 (if (and (>= marker beg) (< marker end))
7555 (push (cons marker (- marker beg)) org-markers-to-move))))
7557 (defun org-reinstall-markers-in-region (beg)
7558 "Move all remembered markers to their position relative to BEG."
7559 (mapc (lambda (x)
7560 (move-marker (car x) (+ beg (cdr x))))
7561 org-markers-to-move)
7562 (setq org-markers-to-move nil))
7564 (defun org-narrow-to-subtree ()
7565 "Narrow buffer to the current subtree."
7566 (interactive)
7567 (save-excursion
7568 (save-match-data
7569 (narrow-to-region
7570 (progn (org-back-to-heading t) (point))
7571 (progn (org-end-of-subtree t t)
7572 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7573 (point))))))
7575 (defun org-narrow-to-block ()
7576 "Narrow buffer to the current block."
7577 (interactive)
7580 (case-fold-search t) ;; allow #+BEGIN
7581 b_start b_end)
7582 (if (org-in-regexps-block-p bstart bend)
7583 (progn
7584 (save-excursion (re-search-backward bstart nil t)
7585 (setq b_start (match-beginning 0)))
7586 (save-excursion (re-search-forward bend nil t)
7587 (setq b_end (match-end 0)))
7588 (narrow-to-region b_start b_end))
7589 (error "Not in a block"))))
7591 (eval-when-compile
7592 (defvar org-property-drawer-re))
7594 (defvar org-property-start-re) ;; defined below
7595 (defun org-clone-subtree-with-time-shift (n &optional shift)
7596 "Clone the task (subtree) at point N times.
7597 The clones will be inserted as siblings.
7599 In interactive use, the user will be prompted for the number of
7600 clones to be produced, and for a time SHIFT, which may be a
7601 repeater as used in time stamps, for example `+3d'.
7603 When a valid repeater is given and the entry contains any time
7604 stamps, the clones will become a sequence in time, with time
7605 stamps in the subtree shifted for each clone produced. If SHIFT
7606 is nil or the empty string, time stamps will be left alone. The
7607 ID property of the original subtree is removed.
7609 If the original subtree did contain time stamps with a repeater,
7610 the following will happen:
7611 - the repeater will be removed in each clone
7612 - an additional clone will be produced, with the current, unshifted
7613 date(s) in the entry.
7614 - the original entry will be placed *after* all the clones, with
7615 repeater intact.
7616 - the start days in the repeater in the original entry will be shifted
7617 to past the last clone.
7618 I this way you can spell out a number of instances of a repeating task,
7619 and still retain the repeater to cover future instances of the task."
7620 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7621 (let (beg end template task idprop
7622 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7623 (if (not (and (integerp n) (> n 0)))
7624 (error "Invalid number of replications %s" n))
7627 shift)))
7628 (error "Invalid shift specification %s" shift))
7629 (when doshift
7630 (setq shift-n (string-to-number (match-string 1 shift))
7631 shift-what (cdr (assoc (match-string 2 shift)
7632 '(("d" . day) ("w" . week)
7633 ("m" . month) ("y" . year))))))
7634 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7635 (setq nmin 1 nmax n)
7636 (org-back-to-heading t)
7637 (setq beg (point))
7638 (setq idprop (org-entry-get nil "ID"))
7639 (org-end-of-subtree t t)
7641 (setq end (point))
7642 (setq template (buffer-substring beg end))
7643 (when (and doshift
7645 (delete-region beg end)
7646 (setq end beg)
7647 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7648 (goto-char end)
7649 (loop for n from nmin to nmax do
7650 ;; prepare clone
7651 (with-temp-buffer
7652 (insert template)
7653 (org-mode)
7654 (goto-char (point-min))
7655 (and idprop (if org-clone-delete-id
7656 (org-entry-delete nil "ID")
7657 (org-id-get-create t)))
7658 (while (re-search-forward org-property-start-re nil t)
7659 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7660 (goto-char (point-min))
7661 (when doshift
7662 (while (re-search-forward org-ts-regexp-both nil t)
7663 (org-timestamp-change (* n shift-n) shift-what))
7664 (unless (= n n-no-remove)
7665 (goto-char (point-min))
7666 (while (re-search-forward org-ts-regexp nil t)
7667 (save-excursion
7668 (goto-char (match-beginning 0))
7670 (delete-region (match-beginning 1) (match-end 1)))))))
7671 (setq task (buffer-string)))
7672 (insert task))
7673 (goto-char beg)))
7675 ;;; Outline Sorting
7677 (defun org-sort (with-case)
7678 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7679 Optional argument WITH-CASE means sort case-sensitively.
7680 With a double prefix argument, also remove duplicate entries."
7681 (interactive "P")
7682 (cond
7683 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7684 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7685 (t
7686 (org-call-with-arg 'org-sort-entries with-case))))
7688 (defun org-sort-remove-invisible (s)
7689 (remove-text-properties 0 (length s) org-rm-props s)
7690 (while (string-match org-bracket-link-regexp s)
7691 (setq s (replace-match (if (match-end 2)
7692 (match-string 3 s)
7693 (match-string 1 s)) t t s)))
7694 s)
7696 (defvar org-priority-regexp) ; defined later in the file
7698 (defvar org-after-sorting-entries-or-items-hook nil
7699 "Hook that is run after a bunch of entries or items have been sorted.
7700 When children are sorted, the cursor is in the parent line when this
7701 hook gets called. When a region or a plain list is sorted, the cursor
7702 will be in the first entry of the sorted region/list.")
7704 (defun org-sort-entries
7705 (&optional with-case sorting-type getkey-func compare-func property)
7706 "Sort entries on a certain level of an outline tree.
7707 If there is an active region, the entries in the region are sorted.
7708 Else, if the cursor is before the first entry, sort the top-level items.
7709 Else, the children of the entry at point are sorted.
7711 Sorting can be alphabetically, numerically, by date/time as given by
7712 a time stamp, by a property or by priority.
7714 The command prompts for the sorting type unless it has been given to the
7715 function through the SORTING-TYPE argument, which needs to be a character,
7716 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7717 precise meaning of each character:
7719 n Numerically, by converting the beginning of the entry/item to a number.
7720 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7721 t By date/time, either the first active time stamp in the entry, or, if
7722 none exist, by the first inactive one.
7723 s By the scheduled date/time.
7724 d By deadline date/time.
7725 c By creation time, which is assumed to be the first inactive time stamp
7726 at the beginning of a line.
7727 p By priority according to the cookie.
7728 r By the value of a property.
7730 Capital letters will reverse the sort order.
7732 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7733 called with point at the beginning of the record. It must return either
7734 a string or a number that should serve as the sorting key for that record.
7736 Comparing entries ignores case by default. However, with an optional argument
7737 WITH-CASE, the sorting considers case as well."
7738 (interactive "P")
7739 (let ((case-func (if with-case 'identity 'downcase))
7740 start beg end stars re re2
7741 txt what tmp)
7742 ;; Find beginning and end of region to sort
7743 (cond
7744 ((org-region-active-p)
7745 ;; we will sort the region
7746 (setq end (region-end)
7747 what "region")
7748 (goto-char (region-beginning))
7749 (if (not (org-on-heading-p)) (outline-next-heading))
7750 (setq start (point)))
7751 ((or (org-on-heading-p)
7752 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7753 ;; we will sort the children of the current headline
7754 (org-back-to-heading)
7755 (setq start (point)
7756 end (progn (org-end-of-subtree t t)
7758 (org-back-over-empty-lines)
7759 (point))
7760 what "children")
7761 (goto-char start)
7762 (show-subtree)
7763 (outline-next-heading))
7764 (t
7765 ;; we will sort the top-level entries in this file
7766 (goto-char (point-min))
7767 (or (org-on-heading-p) (outline-next-heading))
7768 (setq start (point))
7769 (goto-char (point-max))
7770 (beginning-of-line 1)
7772 ;; File ends in a non-white line
7773 (end-of-line 1)
7775 (setq end (point-max))
7776 (setq what "top-level")
7777 (goto-char start)
7778 (show-all)))
7780 (setq beg (point))
7781 (if (>= beg end) (error "Nothing to sort"))
7784 (setq stars (match-string 1)
7785 re (concat "^" (regexp-quote stars) " +")
7787 txt (buffer-substring beg end))
7789 (if (and (not (equal stars "*")) (string-match re2 txt))
7790 (error "Region to sort contains a level above the first entry"))
7792 (unless sorting-type
7793 (message
7794 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7796 A/N/T/S/D/C/P/O/F means reversed:"
7797 what)
7798 (setq sorting-type (read-char-exclusive))
7800 (and (= (downcase sorting-type) ?f)
7801 (setq getkey-func
7802 (org-icompleting-read "Sort using function: "
7803 obarray 'fboundp t nil nil))
7804 (setq getkey-func (intern getkey-func)))
7806 (and (= (downcase sorting-type) ?r)
7807 (setq property
7808 (org-icompleting-read "Property: "
7809 (mapcar 'list (org-buffer-property-keys t))
7810 nil t))))
7812 (message "Sorting entries...")
7814 (save-restriction
7815 (narrow-to-region start end)
7816 (let ((dcst (downcase sorting-type))
7817 (case-fold-search nil)
7818 (now (current-time)))
7819 (sort-subr
7820 (/= dcst sorting-type)
7821 ;; This function moves to the beginning character of the "record" to
7822 ;; be sorted.
7823 (lambda nil
7824 (if (re-search-forward re nil t)
7825 (goto-char (match-beginning 0))
7826 (goto-char (point-max))))
7827 ;; This function moves to the last character of the "record" being
7828 ;; sorted.
7829 (lambda nil
7830 (save-match-data
7831 (condition-case nil
7832 (outline-forward-same-level 1)
7833 (error
7834 (goto-char (point-max))))))
7835 ;; This function returns the value that gets sorted against.
7836 (lambda nil
7837 (cond
7838 ((= dcst ?n)
7839 (if (looking-at org-complex-heading-regexp)
7840 (string-to-number (match-string 4))
7841 nil))
7842 ((= dcst ?a)
7843 (if (looking-at org-complex-heading-regexp)
7844 (funcall case-func (match-string 4))
7845 nil))
7846 ((= dcst ?t)
7847 (let ((end (save-excursion (outline-next-heading) (point))))
7848 (if (or (re-search-forward org-ts-regexp end t)
7849 (re-search-forward org-ts-regexp-both end t))
7850 (org-time-string-to-seconds (match-string 0))
7851 (org-float-time now))))
7852 ((= dcst ?c)
7853 (let ((end (save-excursion (outline-next-heading) (point))))
7854 (if (re-search-forward
7856 end t)
7857 (org-time-string-to-seconds (match-string 0))
7858 (org-float-time now))))
7859 ((= dcst ?s)
7860 (let ((end (save-excursion (outline-next-heading) (point))))
7861 (if (re-search-forward org-scheduled-time-regexp end t)
7862 (org-time-string-to-seconds (match-string 1))
7863 (org-float-time now))))
7864 ((= dcst ?d)
7865 (let ((end (save-excursion (outline-next-heading) (point))))
7866 (if (re-search-forward org-deadline-time-regexp end t)
7867 (org-time-string-to-seconds (match-string 1))
7868 (org-float-time now))))
7869 ((= dcst ?p)
7870 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7871 (string-to-char (match-string 2))
7872 org-default-priority))
7873 ((= dcst ?r)
7874 (or (org-entry-get nil property) ""))
7875 ((= dcst ?o)
7876 (if (looking-at org-complex-heading-regexp)
7877 (- 9999 (length (member (match-string 2)
7878 org-todo-keywords-1)))))
7879 ((= dcst ?f)
7880 (if getkey-func
7881 (progn
7882 (setq tmp (funcall getkey-func))
7883 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7884 tmp)
7885 (error "Invalid key function `%s'" getkey-func)))
7886 (t (error "Invalid sorting type `%c'" sorting-type))))
7887 nil
7888 (cond
7889 ((= dcst ?a) 'string<)
7890 ((= dcst ?f) compare-func)
7891 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7892 (t nil)))))
7893 (run-hooks 'org-after-sorting-entries-or-items-hook)
7894 (message "Sorting entries...done")))
7896 (defun org-do-sort (table what &optional with-case sorting-type)
7897 "Sort TABLE of WHAT according to SORTING-TYPE.
7898 The user will be prompted for the SORTING-TYPE if the call to this
7899 function does not specify it. WHAT is only for the prompt, to indicate
7900 what is being sorted. The sorting key will be extracted from
7901 the car of the elements of the table.
7902 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7903 (unless sorting-type
7904 (message
7905 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7906 what)
7907 (setq sorting-type (read-char-exclusive)))
7908 (let ((dcst (downcase sorting-type))
7909 extractfun comparefun)
7910 ;; Define the appropriate functions
7911 (cond
7912 ((= dcst ?n)
7913 (setq extractfun 'string-to-number
7914 comparefun (if (= dcst sorting-type) '< '>)))
7915 ((= dcst ?a)
7916 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7917 (lambda(x) (downcase (org-sort-remove-invisible x))))
7918 comparefun (if (= dcst sorting-type)
7919 'string<
7920 (lambda (a b) (and (not (string< a b))
7921 (not (string= a b)))))))
7922 ((= dcst ?t)
7923 (setq extractfun
7924 (lambda (x)
7925 (if (or (string-match org-ts-regexp x)
7926 (string-match org-ts-regexp-both x))
7927 (org-float-time
7928 (org-time-string-to-time (match-string 0 x)))
7929 0))
7930 comparefun (if (= dcst sorting-type) '< '>)))
7931 (t (error "Invalid sorting type `%c'" sorting-type)))
7933 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7934 table)
7935 (lambda (a b) (funcall comparefun (car a) (car b))))))
7938 ;;; The orgstruct minor mode
7940 ;; Define a minor mode which can be used in other modes in order to
7941 ;; integrate the org-mode structure editing commands.
7943 ;; This is really a hack, because the org-mode structure commands use
7944 ;; keys which normally belong to the major mode. Here is how it
7945 ;; works: The minor mode defines all the keys necessary to operate the
7946 ;; structure commands, but wraps the commands into a function which
7947 ;; tests if the cursor is currently at a headline or a plain list
7948 ;; item. If that is the case, the structure command is used,
7949 ;; temporarily setting many Org-mode variables like regular
7950 ;; expressions for filling etc. However, when any of those keys is
7951 ;; used at a different location, function uses `key-binding' to look
7952 ;; up if the key has an associated command in another currently active
7953 ;; keymap (minor modes, major mode, global), and executes that
7954 ;; command. There might be problems if any of the keys is otherwise
7955 ;; used as a prefix key.
7957 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7958 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7959 ;; addresses this by checking explicitly for both bindings.
7961 (defvar orgstruct-mode-map (make-sparse-keymap)
7962 "Keymap for the minor `orgstruct-mode'.")
7964 (defvar org-local-vars nil
7965 "List of local variables, for use by `orgstruct-mode'.")
7967 ;;;###autoload
7968 (define-minor-mode orgstruct-mode
7969 "Toggle the minor mode `orgstruct-mode'.
7970 This mode is for using Org-mode structure commands in other
7971 modes. The following keys behave as if Org-mode were active, if
7972 the cursor is on a headline, or on a plain list item (both as
7973 defined by Org-mode).
7975 M-up Move entry/item up
7976 M-down Move entry/item down
7977 M-left Promote
7978 M-right Demote
7979 M-S-up Move entry/item up
7980 M-S-down Move entry/item down
7981 M-S-left Promote subtree
7982 M-S-right Demote subtree
7983 M-q Fill paragraph and items like in Org-mode
7984 C-c ^ Sort entries
7985 C-c - Cycle list bullet
7986 TAB Cycle item visibility
7987 M-RET Insert new heading/item
7988 S-M-RET Insert new TODO heading / Checkbox item
7989 C-c C-c Set tags / toggle checkbox"
7990 nil " OrgStruct" nil
7991 (org-load-modules-maybe)
7992 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7994 ;;;###autoload
7995 (defun turn-on-orgstruct ()
7996 "Unconditionally turn on `orgstruct-mode'."
7997 (orgstruct-mode 1))
7999 (defun orgstruct++-mode (&optional arg)
8000 "Toggle `orgstruct-mode', the enhanced version of it.
8001 In addition to setting orgstruct-mode, this also exports all indentation
8002 and autofilling variables from org-mode into the buffer. It will also
8003 recognize item context in multiline items.
8004 Note that turning off orgstruct-mode will *not* remove the
8005 indentation/paragraph settings. This can only be done by refreshing the
8007 (interactive "P")
8008 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8009 (if (< arg 1)
8010 (orgstruct-mode -1)
8011 (orgstruct-mode 1)
8012 (let (var val)
8013 (mapc
8014 (lambda (x)
8015 (when (string-match
8017 (symbol-name (car x)))
8018 (setq var (car x) val (nth 1 x))
8019 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8020 org-local-vars)
8021 (org-set-local 'orgstruct-is-++ t))))
8023 (defvar orgstruct-is-++ nil
8024 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8025 (make-variable-buffer-local 'orgstruct-is-++)
8027 ;;;###autoload
8028 (defun turn-on-orgstruct++ ()
8029 "Unconditionally turn on `orgstruct++-mode'."
8030 (orgstruct++-mode 1))
8032 (defun orgstruct-error ()
8033 "Error when there is no default binding for a structure key."
8034 (interactive)
8035 (error "This key has no function outside structure elements"))
8037 (defun orgstruct-setup ()
8038 "Setup orgstruct keymaps."
8039 (let ((nfunc 0)
8040 (bindings
8041 (list
8042 '([(meta up)] org-metaup)
8043 '([(meta down)] org-metadown)
8044 '([(meta left)] org-metaleft)
8045 '([(meta right)] org-metaright)
8046 '([(meta shift up)] org-shiftmetaup)
8047 '([(meta shift down)] org-shiftmetadown)
8048 '([(meta shift left)] org-shiftmetaleft)
8049 '([(meta shift right)] org-shiftmetaright)
8050 '([?\e (up)] org-metaup)
8051 '([?\e (down)] org-metadown)
8052 '([?\e (left)] org-metaleft)
8053 '([?\e (right)] org-metaright)
8054 '([?\e (shift up)] org-shiftmetaup)
8055 '([?\e (shift down)] org-shiftmetadown)
8056 '([?\e (shift left)] org-shiftmetaleft)
8057 '([?\e (shift right)] org-shiftmetaright)
8058 '([(shift up)] org-shiftup)
8059 '([(shift down)] org-shiftdown)
8060 '([(shift left)] org-shiftleft)
8061 '([(shift right)] org-shiftright)
8062 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8063 '("\M-q" fill-paragraph)
8064 '("\C-c^" org-sort)
8065 '("\C-c-" org-cycle-list-bullet)))
8066 elt key fun cmd)
8067 (while (setq elt (pop bindings))
8068 (setq nfunc (1+ nfunc))
8069 (setq key (org-key (car elt))
8070 fun (nth 1 elt)
8071 cmd (orgstruct-make-binding fun nfunc key))
8072 (org-defkey orgstruct-mode-map key cmd))
8074 ;; Special treatment needed for TAB and RET
8075 (org-defkey orgstruct-mode-map [(tab)]
8076 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8077 (org-defkey orgstruct-mode-map "\C-i"
8078 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8080 (org-defkey orgstruct-mode-map "\M-\C-m"
8081 (orgstruct-make-binding 'org-insert-heading 105
8082 "\M-\C-m" [(meta return)]))
8083 (org-defkey orgstruct-mode-map [(meta return)]
8084 (orgstruct-make-binding 'org-insert-heading 106
8085 [(meta return)] "\M-\C-m"))
8087 (org-defkey orgstruct-mode-map [(shift meta return)]
8088 (orgstruct-make-binding 'org-insert-todo-heading 107
8089 [(meta return)] "\M-\C-m"))
8091 (org-defkey orgstruct-mode-map "\e\C-m"
8092 (orgstruct-make-binding 'org-insert-heading 108
8093 "\e\C-m" [?\e (return)]))
8094 (org-defkey orgstruct-mode-map [?\e (return)]
8095 (orgstruct-make-binding 'org-insert-heading 109
8096 [?\e (return)] "\e\C-m"))
8097 (org-defkey orgstruct-mode-map [?\e (shift return)]
8098 (orgstruct-make-binding 'org-insert-todo-heading 110
8099 [?\e (return)] "\e\C-m"))
8101 (unless org-local-vars
8102 (setq org-local-vars (org-get-local-variables)))
8104 t))
8106 (defun orgstruct-make-binding (fun n &rest keys)
8107 "Create a function for binding in the structure minor mode.
8108 FUN is the command to call inside a table. N is used to create a unique
8109 command name. KEYS are keys that should be checked in for a command
8110 to execute outside of tables."
8111 (eval
8112 (list 'defun
8113 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8114 '(arg)
8116 "Outside of structure, run the binding of `"
8117 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8118 "'.")
8119 '(interactive "p")
8120 (list 'if
8121 `(org-context-p 'headline 'item
8122 (and orgstruct-is-++
8123 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8124 'item-body))
8125 (list 'org-run-like-in-org-mode (list 'quote fun))
8126 (list 'let '(orgstruct-mode)
8127 (list 'call-interactively
8128 (append '(or)
8129 (mapcar (lambda (k)
8130 (list 'key-binding k))
8131 keys)
8132 '('orgstruct-error))))))))
8134 (defun org-context-p (&rest contexts)
8135 "Check if local context is any of CONTEXTS.
8136 Possible values in the list of contexts are `table', `headline', and `item'."
8137 (let ((pos (point)))
8138 (goto-char (point-at-bol))
8139 (prog1 (or (and (memq 'table contexts)
8141 (and (memq 'headline contexts)
8143 (looking-at outline-regexp))
8144 (and (memq 'item contexts)
8146 (and (memq 'item-body contexts)
8147 (org-in-item-p)))
8148 (goto-char pos))))
8150 (defun org-get-local-variables ()
8151 "Return a list of all local variables in an org-mode buffer."
8152 (let (varlist)
8153 (with-current-buffer (get-buffer-create "*Org tmp*")
8154 (erase-buffer)
8155 (org-mode)
8156 (setq varlist (buffer-local-variables)))
8157 (kill-buffer "*Org tmp*")
8158 (delq nil
8159 (mapcar
8160 (lambda (x)
8161 (setq x
8162 (if (symbolp x)
8163 (list x)
8164 (list (car x) (list 'quote (cdr x)))))
8165 (if (string-match
8166 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8167 (symbol-name (car x)))
8168 x nil))
8169 varlist))))
8171 (defun org-clone-local-variables (from-buffer &optional regexp)
8172 "Clone local variables from FROM-BUFFER.
8173 Optional argument REGEXP selects variables to clone."
8174 (mapc
8175 (lambda (pair)
8176 (and (symbolp (car pair))
8177 (or (null regexp)
8178 (string-match regexp (symbol-name (car pair))))
8179 (set (make-local-variable (car pair))
8180 (cdr pair))))
8181 (buffer-local-variables from-buffer)))
8183 ;;;###autoload
8184 (defun org-run-like-in-org-mode (cmd)
8185 "Run a command, pretending that the current buffer is in Org-mode.
8186 This will temporarily bind local variables that are typically bound in
8187 Org-mode to the values they have in Org-mode, and then interactively
8188 call CMD."
8189 (org-load-modules-maybe)
8190 (unless org-local-vars
8191 (setq org-local-vars (org-get-local-variables)))
8192 (eval (list 'let org-local-vars
8193 (list 'call-interactively (list 'quote cmd)))))
8195 ;;;; Archiving
8197 (defun org-get-category (&optional pos force-refresh)
8198 "Get the category applying to position POS."
8199 (if force-refresh (org-refresh-category-properties))
8200 (let ((pos (or pos (point))))
8201 (or (get-text-property pos 'org-category)
8202 (progn (org-refresh-category-properties)
8203 (get-text-property pos 'org-category)))))
8205 (defun org-refresh-category-properties ()
8206 "Refresh category text properties in the buffer."
8207 (let ((def-cat (cond
8208 ((null org-category)
8209 (if buffer-file-name
8210 (file-name-sans-extension
8211 (file-name-nondirectory buffer-file-name))
8212 "???"))
8213 ((symbolp org-category) (symbol-name org-category))
8214 (t org-category)))
8215 beg end cat pos optionp)
8216 (org-unmodified
8217 (save-excursion
8218 (save-restriction
8219 (widen)
8220 (goto-char (point-min))
8221 (put-text-property (point) (point-max) 'org-category def-cat)
8222 (while (re-search-forward
8224 (setq pos (match-end 0)
8225 optionp (equal (char-after (match-beginning 0)) ?#)
8226 cat (org-trim (match-string 2)))
8227 (if optionp
8228 (setq beg (point-at-bol) end (point-max))
8229 (org-back-to-heading t)
8230 (setq beg (point) end (org-end-of-subtree t t)))
8231 (put-text-property beg end 'org-category cat)
8232 (goto-char pos)))))))
8235 ;;;; Link Stuff
8237 ;;; Link abbreviations
8239 (defun org-link-expand-abbrev (link)
8240 "Apply replacements as defined in `org-link-abbrev-alist."
8242 (let* ((key (match-string 1 link))
8243 (as (or (assoc key org-link-abbrev-alist-local)
8244 (assoc key org-link-abbrev-alist)))
8245 (tag (and (match-end 2) (match-string 3 link)))
8246 rpl)
8247 (if (not as)
8248 link
8249 (setq rpl (cdr as))
8250 (cond
8251 ((symbolp rpl) (funcall rpl tag))
8252 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8253 ((string-match "%h" rpl)
8254 (replace-match (url-hexify-string (or tag "")) t t rpl))
8255 (t (concat rpl tag)))))
8256 link))
8258 ;;; Storing and inserting links
8260 (defvar org-insert-link-history nil
8261 "Minibuffer history for links inserted with `org-insert-link'.")
8263 (defvar org-stored-links nil
8264 "Contains the links stored with `org-store-link'.")
8266 (defvar org-store-link-plist nil
8267 "Plist with info about the most recently link created with `org-store-link'.")
8269 (defvar org-link-protocols nil
8270 "Link protocols added to Org-mode using `org-add-link-type'.")
8272 (defvar org-store-link-functions nil
8273 "List of functions that are called to create and store a link.
8274 Each function will be called in turn until one returns a non-nil
8275 value. Each function should check if it is responsible for creating
8276 this link (for example by looking at the major mode).
8277 If not, it must exit and return nil.
8278 If yes, it should return a non-nil value after a calling
8279 `org-store-link-props' with a list of properties and values.
8280 Special properties are:
8284 This is obligatory as well.
8285 :description Optional default description for the second pair
8286 of brackets in an Org-mode link. The user can still change
8287 this when inserting this link into an Org-mode buffer.
8289 In addition to these, any additional properties can be specified
8290 and then used in remember templates.")
8292 (defun org-add-link-type (type &optional follow export)
8293 "Add TYPE to the list of `org-link-types'.
8294 Re-compute all regular expressions depending on `org-link-types'
8296 FOLLOW and EXPORT are two functions.
8298 FOLLOW should take the link path as the single argument and do whatever
8299 is necessary to follow the link, for example find a file or display
8300 a mail message.
8302 EXPORT should format the link path for export to one of the export formats.
8303 It should be a function accepting three arguments:
8306 desc the description of the link, if any, or a description added by
8307 org-export-normalize-links if there is none
8308 format the export format, a symbol like `html' or `latex' or `ascii'..
8310 The function may use the FORMAT information to return different values
8311 depending on the format. The return value will be put literally into
8312 the exported file. If the return value is nil, this means Org should
8313 do what it normally does with links which do not have EXPORT defined.
8315 Org-mode has a built-in default for exporting links. If you are happy with
8316 this default, there is no need to define an export function for the link
8317 type. For a simple example of an export function, see `org-bbdb.el'."
8318 (add-to-list 'org-link-types type t)
8319 (org-make-link-regexps)
8320 (if (assoc type org-link-protocols)
8321 (setcdr (assoc type org-link-protocols) (list follow export))
8322 (push (list type follow export) org-link-protocols)))
8324 (defvar org-agenda-buffer-name)
8326 ;;;###autoload
8327 (defun org-store-link (arg)
8329 This link is added to `org-stored-links' and can later be inserted
8332 For some link types, a prefix arg is interpreted:
8333 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8334 For file links, arg negates `org-context-in-file-links'."
8335 (interactive "P")
8336 (org-load-modules-maybe)
8337 (setq org-store-link-plist nil) ; reset
8338 (org-with-limited-levels
8339 (let (link cpltxt desc description search txt custom-id agenda-link)
8340 (cond
8342 ((run-hook-with-args-until-success 'org-store-link-functions)
8343 (setq link (plist-get org-store-link-plist :link)
8344 desc (or (plist-get org-store-link-plist :description) link)))
8346 ((equal (buffer-name) "*Org Edit Src Example*")
8347 (let (label gc)
8348 (while (or (not label)
8349 (save-excursion
8350 (save-restriction
8351 (widen)
8352 (goto-char (point-min))
8353 (re-search-forward
8354 (regexp-quote (format org-coderef-label-format label))
8355 nil t))))
8356 (when label (message "Label exists already") (sit-for 2))
8357 (setq label (read-string "Code line label: " label)))
8358 (end-of-line 1)
8359 (setq link (format org-coderef-label-format label))
8360 (setq gc (- 79 (length link)))
8361 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8362 (insert link)
8363 (setq link (concat "(" label ")") desc nil)))
8365 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8366 ;; We are in the agenda, link to referenced location
8367 (let ((m (or (get-text-property (point) 'org-hd-marker)
8368 (get-text-property (point) 'org-marker))))
8369 (when m
8370 (org-with-point-at m
8371 (setq agenda-link
8372 (if (interactive-p)
8373 (call-interactively 'org-store-link)
8374 (org-store-link nil)))))))
8376 ((eq major-mode 'calendar-mode)
8377 (let ((cd (calendar-cursor-to-date)))
8378 (setq link
8379 (format-time-string
8380 (car org-time-stamp-formats)
8381 (apply 'encode-time
8382 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8383 nil nil nil))))
8384 (org-store-link-props :type "calendar" :date cd)))
8386 ((eq major-mode 'w3-mode)
8387 (setq cpltxt (if (and (buffer-name)
8388 (not (string-match "Untitled" (buffer-name))))
8389 (buffer-name)
8390 (url-view-url t))
8391 link (org-make-link (url-view-url t)))
8392 (org-store-link-props :type "w3" :url (url-view-url t)))
8394 ((eq major-mode 'w3m-mode)
8395 (setq cpltxt (or w3m-current-title w3m-current-url)
8396 link (org-make-link w3m-current-url))
8397 (org-store-link-props :type "w3m" :url (url-view-url t)))
8399 ((setq search (run-hook-with-args-until-success
8400 'org-create-file-search-functions))
8401 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8402 "::" search))
8403 (setq cpltxt (or description link)))
8405 ((eq major-mode 'image-mode)
8406 (setq cpltxt (concat "file:"
8407 (abbreviate-file-name buffer-file-name))
8408 link (org-make-link cpltxt))
8409 (org-store-link-props :type "image" :file buffer-file-name))
8411 ((eq major-mode 'dired-mode)
8412 ;; link to the file in the current line
8413 (let ((file (dired-get-filename nil t)))
8414 (setq file (if file
8415 (abbreviate-file-name
8416 (expand-file-name (dired-get-filename nil t)))
8417 ;; otherwise, no file so use current directory.
8418 default-directory))
8419 (setq cpltxt (concat "file:" file)
8420 link (org-make-link cpltxt))))
8422 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8423 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8424 (cond
8426 (setq cpltxt
8427 (concat "file:"
8428 (abbreviate-file-name
8429 (buffer-file-name (buffer-base-buffer)))
8430 "::" (match-string 1))
8431 link (org-make-link cpltxt)))
8432 ((and (featurep 'org-id)
8433 (or (eq org-link-to-org-use-id t)
8434 (and (eq org-link-to-org-use-id 'create-if-interactive)
8435 (interactive-p))
8436 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8437 (interactive-p)
8438 (not custom-id))
8439 (and org-link-to-org-use-id
8440 (org-entry-get nil "ID"))))
8441 ;; We can make a link using the ID.
8442 (setq link (condition-case nil
8443 (prog1 (org-id-store-link)
8444 (setq desc (plist-get org-store-link-plist
8445 :description)))
8446 (error
8447 ;; probably before first headline, link to file only
8448 (concat "file:"
8449 (abbreviate-file-name
8450 (buffer-file-name (buffer-base-buffer))))))))
8451 (t
8452 ;; Just link to current headline
8453 (setq cpltxt (concat "file:"
8454 (abbreviate-file-name
8455 (buffer-file-name (buffer-base-buffer)))))
8456 ;; Add a context search string
8457 (when (org-xor org-context-in-file-links arg)
8458 (setq txt (cond
8459 ((org-on-heading-p) nil)
8460 ((org-region-active-p)
8461 (buffer-substring (region-beginning) (region-end)))
8462 (t nil)))
8464 (setq cpltxt
8465 (concat cpltxt "::"
8466 (condition-case nil
8467 (org-make-org-heading-search-string txt)
8468 (error "")))
8469 desc (or (nth 4 (ignore-errors
8470 (org-heading-components))) "NONE"))))
8472 (setq cpltxt (substring cpltxt 0 -2)))
8473 (setq link (org-make-link cpltxt)))))
8475 ((buffer-file-name (buffer-base-buffer))
8476 ;; Just link to this file here.
8477 (setq cpltxt (concat "file:"
8478 (abbreviate-file-name
8479 (buffer-file-name (buffer-base-buffer)))))
8480 ;; Add a context string
8481 (when (org-xor org-context-in-file-links arg)
8482 (setq txt (if (org-region-active-p)
8483 (buffer-substring (region-beginning) (region-end))
8484 (buffer-substring (point-at-bol) (point-at-eol))))
8485 ;; Only use search option if there is some text.
8487 (setq cpltxt
8488 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8489 desc "NONE")))
8490 (setq link (org-make-link cpltxt)))
8492 ((interactive-p)
8493 (error "Cannot link to a buffer which is not visiting a file"))
8495 (t (setq link nil)))
8497 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8498 (setq link (or link cpltxt)
8499 desc (or desc cpltxt))
8500 (if (equal desc "NONE") (setq desc nil))
8502 (if (and (or (interactive-p) executing-kbd-macro) link)
8503 (progn
8504 (setq org-stored-links
8505 (cons (list link desc) org-stored-links))
8506 (message "Stored: %s" (or desc link))
8507 (when custom-id
8508 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8509 "::#" custom-id))
8510 (setq org-stored-links
8511 (cons (list link desc) org-stored-links))))
8512 (or agenda-link (and link (org-make-link-string link desc)))))))
8514 (defun org-store-link-props (&rest plist)
8515 "Store link properties, extract names and addresses."
8516 (let (x adr)
8517 (when (setq x (plist-get plist :from))
8518 (setq adr (mail-extract-address-components x))
8519 (setq plist (plist-put plist :fromname (car adr)))
8520 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8521 (when (setq x (plist-get plist :to))
8522 (setq adr (mail-extract-address-components x))
8523 (setq plist (plist-put plist :toname (car adr)))
8524 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8525 (let ((from (plist-get plist :from))
8526 (to (plist-get plist :to)))
8527 (when (and from to org-from-is-user-regexp)
8528 (setq plist
8529 (plist-put plist :fromto
8530 (if (string-match org-from-is-user-regexp from)
8531 (concat "to %t")
8532 (concat "from %f"))))))
8533 (setq org-store-link-plist plist))
8535 (defun org-add-link-props (&rest plist)
8536 "Add these properties to the link property list."
8537 (let (key value)
8538 (while plist
8539 (setq key (pop plist) value (pop plist))
8540 (setq org-store-link-plist
8541 (plist-put org-store-link-plist key value)))))
8543 (defun org-email-link-description (&optional fmt)
8544 "Return the description part of an email link.
8545 This takes information from `org-store-link-plist' and formats it
8546 according to FMT (default from `org-email-link-description-format')."
8547 (setq fmt (or fmt org-email-link-description-format))
8548 (let* ((p org-store-link-plist)
8549 (to (plist-get p :toaddress))
8550 (from (plist-get p :fromaddress))
8551 (table
8552 (list
8553 (cons "%c" (plist-get p :fromto))
8554 (cons "%F" (plist-get p :from))
8555 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8556 (cons "%T" (plist-get p :to))
8557 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8558 (cons "%s" (plist-get p :subject))
8559 (cons "%d" (plist-get p :date))
8560 (cons "%m" (plist-get p :message-id)))))
8561 (when (string-match "%c" fmt)
8562 ;; Check if the user wrote this message
8563 (if (and org-from-is-user-regexp from to
8564 (save-match-data (string-match org-from-is-user-regexp from)))
8565 (setq fmt (replace-match "to %t" t t fmt))
8566 (setq fmt (replace-match "from %f" t t fmt))))
8567 (org-replace-escapes fmt table)))
8569 (defun org-make-org-heading-search-string (&optional string heading)
8570 "Make search string for STRING or current headline."
8571 (interactive)
8572 (let ((s (or string (org-get-heading)))
8573 (lines org-context-in-file-links))
8574 (unless (and string (not heading))
8575 ;; We are using a headline, clean up garbage in there.
8576 (if (string-match org-todo-regexp s)
8577 (setq s (replace-match "" t t s)))
8579 (setq s (replace-match "" t t s)))
8580 (setq s (org-trim s))
8583 (setq s (replace-match "" t t s)))
8584 (while (string-match org-ts-regexp s)
8585 (setq s (replace-match "" t t s))))
8586 (or string (setq s (concat "*" s))) ; Add * for headlines
8587 (when (and string (integerp lines) (> lines 0))
8589 (when (< lines (length slines))
8590 (setq s (mapconcat
8591 'identity
8592 (reverse (nthcdr (- (length slines) lines)
8596 (defun org-make-link (&rest strings)
8597 "Concatenate STRINGS."
8598 (apply 'concat strings))
8600 (defun org-make-link-string (link &optional description)
8601 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8603 (error "Empty link"))
8604 (when (and description
8605 (stringp description)
8607 (setq description nil))
8608 (when (stringp description)
8609 ;; Remove brackets from the description, they are fatal.
8611 (setq description (replace-match "{" t t description)))
8613 (setq description (replace-match "}" t t description))))
8614 (when (equal (org-link-escape link) description)
8615 ;; No description needed, it is identical
8616 (setq description nil))
8617 (when (and (not description)
8618 (not (equal link (org-link-escape link))))
8619 (setq description (org-extract-attributes link)))
8620 (setq link (if (string-match org-link-types-re link)
8621 (concat (match-string 1 link)
8622 (org-link-escape (substring link (match-end 1))))
8623 (org-link-escape link)))
8624 (concat "[[" link "]"
8625 (if description (concat "[" description "]") "")
8626 "]"))
8628 (defconst org-link-escape-chars
8629 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8630 "List of characters that should be escaped in link.
8631 This is the list that is used for internal purposes.")
8633 (defvar org-url-encoding-use-url-hexify nil)
8635 (defconst org-link-escape-chars-browser
8636 '(?\ )
8637 "List of escapes for characters that are problematic in links.
8638 This is the list that is used before handing over to the browser.")
8640 (defun org-link-escape (text &optional table merge)
8641 "Return percent escaped representation of TEXT.
8642 TEXT is a string with the text to escape.
8643 Optional argument TABLE is a list with characters that should be
8644 escaped. When nil, `org-link-escape-chars' is used.
8645 If optional argument MERGE is set, merge TABLE into
8646 `org-link-escape-chars'."
8647 (if (and org-url-encoding-use-url-hexify (not table))
8648 (url-hexify-string text)
8649 (cond
8650 ((and table merge)
8651 (mapc (lambda (defchr)
8652 (unless (member defchr table)
8653 (setq table (cons defchr table)))) org-link-escape-chars))
8654 ((null table)
8655 (setq table org-link-escape-chars)))
8656 (mapconcat
8657 (lambda (char)
8658 (if (or (member char table)
8659 (< char 32) (= char 37) (> char 126))
8660 (mapconcat (lambda (sequence-element)
8661 (format "%%%.2X" sequence-element))
8662 (or (encode-coding-char char 'utf-8)
8663 (error "Unable to percent escape character: %s"
8664 (char-to-string char))) "")
8665 (char-to-string char))) text "")))
8667 (defun org-link-unescape (str)
8668 "Unhex hexified unicode strings as returned from the JavaScript function
8669 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8670 (unless (and (null str) (string= "" str))
8671 (let ((pos 0) (case-fold-search t) unhexed)
8673 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8674 (setq str (replace-match unhexed t t str))
8675 (setq pos (+ pos (length unhexed))))))
8676 str)
8678 (defun org-link-unescape-compound (hex)
8679 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8680 Note: this function also decodes single byte encodings like
8682 (save-match-data
8683 (let* ((bytes (cdr (split-string hex "%")))
8684 (ret "")
8685 (eat 0)
8686 (sum 0))
8687 (while bytes
8688 (let* ((val (string-to-number (pop bytes) 16))
8689 (shift-xor
8690 (if (= 0 eat)
8691 (cond
8692 ((>= val 252) (cons 6 252))
8693 ((>= val 248) (cons 5 248))
8694 ((>= val 240) (cons 4 240))
8695 ((>= val 224) (cons 3 224))
8696 ((>= val 192) (cons 2 192))
8697 (t (cons 0 0)))
8698 (cons 6 128))))
8699 (if (>= val 192) (setq eat (car shift-xor)))
8700 (setq val (logxor val (cdr shift-xor)))
8701 (setq sum (+ (lsh sum (car shift-xor)) val))
8702 (if (> eat 0) (setq eat (- eat 1)))
8703 (cond
8704 ((= 0 eat) ;multi byte
8705 (setq ret (concat ret (org-char-to-string sum)))
8706 (setq sum 0))
8707 ((not bytes) ; single byte(s)
8708 (setq ret (org-link-unescape-single-byte-sequence hex))))
8709 )) ;; end (while bytes
8710 ret )))
8712 (defun org-link-unescape-single-byte-sequence (hex)
8713 "Unhexify hex-encoded single byte character sequences."
8714 (mapconcat (lambda (byte)
8715 (char-to-string (string-to-number byte 16)))
8716 (cdr (split-string hex "%")) ""))
8718 (defun org-xor (a b)
8719 "Exclusive or."
8720 (if a (not b) b))
8722 (defun org-fixup-message-id-for-http (s)
8723 "Replace special characters in a message id, so it can be used in an http query."
8724 (when (string-match "%" s)
8725 (setq s (mapconcat (lambda (c)
8726 (if (eq c ?%)
8727 "%25"
8728 (char-to-string c)))
8729 s "")))
8730 (while (string-match "<" s)
8731 (setq s (replace-match "%3C" t t s)))
8732 (while (string-match ">" s)
8733 (setq s (replace-match "%3E" t t s)))
8734 (while (string-match "@" s)
8735 (setq s (replace-match "%40" t t s)))
8736 s)
8738 ;;;###autoload
8739 (defun org-insert-link-global ()
8740 "Insert a link like Org-mode does.
8741 This command can be called in any mode to insert a link in Org-mode syntax."
8742 (interactive)
8743 (org-load-modules-maybe)
8744 (org-run-like-in-org-mode 'org-insert-link))
8746 (defun org-insert-link (&optional complete-file link-location)
8747 "Insert a link. At the prompt, enter the link.
8749 Completion can be used to insert any of the link protocol prefixes like
8750 http or ftp in use.
8752 The history can be used to select a link previously stored with
8753 `org-store-link'. When the empty string is entered (i.e. if you just
8754 press RET at the prompt), the link defaults to the most recently
8755 stored link. As SPC triggers completion in the minibuffer, you need to
8756 use M-SPC or C-q SPC to force the insertion of a space character.
8758 You will also be prompted for a description, and if one is given, it will
8759 be displayed in the buffer instead of the link.
8761 If there is already a link at point, this command will allow you to edit link
8762 and description parts.
8765 be selected using completion. The path to the file will be relative to the
8766 current directory if the file is in the current directory or a subdirectory.
8767 Otherwise, the link will be the absolute path as completed in the minibuffer
8768 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8769 option `org-link-file-path-type'.
8772 the current directory or below.
8775 `org-keep-stored-link-after-insertion'.
8777 If `org-make-link-description-function' is non-nil, this function will be
8778 called with the link target, and the result will be the default
8779 link description.
8781 If the LINK-LOCATION parameter is non-nil, this value will be
8782 used as the link location instead of reading one interactively."
8783 (interactive "P")
8784 (let* ((wcf (current-window-configuration))
8785 (region (if (org-region-active-p)
8786 (buffer-substring (region-beginning) (region-end))))
8787 (remove (and region (list (region-beginning) (region-end))))
8788 (desc region)
8789 tmphist ; byte-compile incorrectly complains about this
8790 (link link-location)
8791 entry file all-prefixes)
8792 (cond
8793 (link-location) ; specified by arg, just use it.
8794 ((org-in-regexp org-bracket-link-regexp 1)
8795 ;; We do have a link at point, and we are going to edit it.
8796 (setq remove (list (match-beginning 0) (match-end 0)))
8797 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8798 (setq link (read-string "Link: "
8799 (org-link-unescape
8800 (org-match-string-no-properties 1)))))
8801 ((or (org-in-regexp org-angle-link-re)
8802 (org-in-regexp org-plain-link-re))
8803 ;; Convert to bracket link
8804 (setq remove (list (match-beginning 0) (match-end 0))
8805 link (read-string "Link: "
8806 (org-remove-angle-brackets (match-string 0)))))
8807 ((member complete-file '((4) (16)))
8808 ;; Completing read for file names.
8809 (setq link (org-file-complete-link complete-file)))
8810 (t
8811 ;; Read link, with completion for stored links.
8812 (with-output-to-temp-buffer "*Org Links*"
8813 (princ "Insert a link.
8815 (when org-stored-links
8817 (princ (mapconcat
8818 (lambda (x)
8819 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8821 (let ((cw (selected-window)))
8822 (select-window (get-buffer-window "*Org Links*" 'visible))
8823 (setq truncate-lines t)
8824 (unless (pos-visible-in-window-p (point-max))
8825 (org-fit-window-to-buffer))
8826 (and (window-live-p cw) (select-window cw)))
8827 ;; Fake a link history, containing the stored links.
8828 (setq tmphist (append (mapcar 'car org-stored-links)
8829 org-insert-link-history))
8830 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8831 (mapcar 'car org-link-abbrev-alist)
8832 org-link-types))
8833 (unwind-protect
8834 (progn
8835 (setq link
8836 (let ((org-completion-use-ido nil)
8837 (org-completion-use-iswitchb nil))
8838 (org-completing-read
8839 "Link: "
8840 (append
8841 (mapcar (lambda (x) (list (concat x ":")))
8842 all-prefixes)
8843 (mapcar 'car org-stored-links))
8844 nil nil nil
8845 'tmphist
8846 (car (car org-stored-links)))))
8848 (error "No link selected"))
8849 (if (or (member link all-prefixes)
8850 (and (equal ":" (substring link -1))
8851 (member (substring link 0 -1) all-prefixes)
8852 (setq link (substring link 0 -1))))
8853 (setq link (org-link-try-special-completion link))))
8854 (set-window-configuration wcf)
8855 (kill-buffer "*Org Links*"))
8856 (setq entry (assoc link org-stored-links))
8857 (or entry (push link org-insert-link-history))
8858 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8859 (not org-keep-stored-link-after-insertion))
8860 (setq org-stored-links (delq (assoc link org-stored-links)
8861 org-stored-links)))
8862 (setq desc (or desc (nth 1 entry)))))
8864 (if (string-match org-plain-link-re link)
8865 ;; URL-like link, normalize the use of angular brackets.
8866 (setq link (org-make-link (org-remove-angle-brackets link))))
8868 ;; Check if we are linking to the current file with a search option
8869 ;; If yes, simplify the link by using only the search option.
8870 (when (and buffer-file-name
8872 (let* ((path (match-string 1 link))
8873 (case-fold-search nil)
8874 (search (match-string 2 link)))
8875 (save-match-data
8876 (if (equal (file-truename buffer-file-name) (file-truename path))
8877 ;; We are linking to this same file, with a search option
8878 (setq link search)))))
8880 ;; Check if we can/should use a relative path. If yes, simplify the link
8882 (let* ((type (match-string 1 link))
8883 (path (match-string 2 link))
8884 (origpath path)
8885 (case-fold-search nil))
8886 (cond
8887 ((or (eq org-link-file-path-type 'absolute)
8888 (equal complete-file '(16)))
8889 (setq path (abbreviate-file-name (expand-file-name path))))
8890 ((eq org-link-file-path-type 'noabbrev)
8891 (setq path (expand-file-name path)))
8892 ((eq org-link-file-path-type 'relative)
8893 (setq path (file-relative-name path)))
8894 (t
8895 (save-match-data
8896 (if (string-match (concat "^" (regexp-quote
8897 (expand-file-name
8898 (file-name-as-directory
8899 default-directory))))
8900 (expand-file-name path))
8901 ;; We are linking a file with relative path name.
8902 (setq path (substring (expand-file-name path)
8903 (match-end 0)))
8904 (setq path (abbreviate-file-name (expand-file-name path)))))))
8905 (setq link (concat type path))
8906 (if (equal desc origpath)
8907 (setq desc path))))
8909 (if org-make-link-description-function
8910 (setq desc (funcall org-make-link-description-function link desc)))
8912 (setq desc (read-string "Description: " desc))
8914 (if remove (apply 'delete-region remove))
8915 (insert (org-make-link-string link desc))))
8917 (defun org-link-try-special-completion (type)
8918 "If there is completion support for link type TYPE, offer it."
8919 (let ((fun (intern (concat "org-" type "-complete-link"))))
8920 (if (functionp fun)
8921 (funcall fun)
8922 (read-string "Link (no completion support): " (concat type ":")))))
8924 (defun org-file-complete-link (&optional arg)
8925 "Create a file link using completion."
8926 (let (file link)
8927 (setq file (read-file-name "File: "))
8928 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8929 (pwd1 (file-name-as-directory (abbreviate-file-name
8930 (expand-file-name ".")))))
8931 (cond
8932 ((equal arg '(16))
8933 (setq link (org-make-link
8934 "file:"
8935 (abbreviate-file-name (expand-file-name file)))))
8937 (setq link (org-make-link "file:" (match-string 1 file))))
8939 (expand-file-name file))
8940 (setq link (org-make-link
8941 "file:" (match-string 1 (expand-file-name file)))))
8942 (t (setq link (org-make-link "file:" file)))))
8943 link))
8945 (defun org-completing-read (&rest args)
8946 "Completing-read with SPACE being a normal character."
8947 (let ((minibuffer-local-completion-map
8948 (copy-keymap minibuffer-local-completion-map)))
8949 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8950 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8951 (apply 'org-icompleting-read args)))
8953 (defun org-completing-read-no-i (&rest args)
8954 (let (org-completion-use-ido org-completion-use-iswitchb)
8955 (apply 'org-completing-read args)))
8957 (defun org-iswitchb-completing-read (prompt choices &rest args)
8958 "Use iswitch as a completing-read replacement to choose from choices.
8959 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8960 from."
8961 (let* ((iswitchb-use-virtual-buffers nil)
8962 (iswitchb-make-buflist-hook
8963 (lambda ()
8964 (setq iswitchb-temp-buflist choices))))
8965 (iswitchb-read-buffer prompt)))
8967 (defun org-icompleting-read (&rest args)
8968 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8969 (org-without-partial-completion
8970 (if (and org-completion-use-ido
8971 (fboundp 'ido-completing-read)
8972 (boundp 'ido-mode) ido-mode
8973 (listp (second args)))
8974 (let ((ido-enter-matching-directory nil))
8975 (apply 'ido-completing-read (concat (car args))
8976 (if (consp (car (nth 1 args)))
8977 (mapcar (lambda (x) (car x)) (nth 1 args))
8978 (nth 1 args))
8979 (cddr args)))
8980 (if (and org-completion-use-iswitchb
8981 (boundp 'iswitchb-mode) iswitchb-mode
8982 (listp (second args)))
8983 (apply 'org-iswitchb-completing-read (concat (car args))
8984 (if (consp (car (nth 1 args)))
8985 (mapcar (lambda (x) (car x)) (nth 1 args))
8986 (nth 1 args))
8987 (cddr args))
8988 (apply 'completing-read args)))))
8990 (defun org-extract-attributes (s)
8991 "Extract the attributes cookie from a string and set as text property."
8992 (let (a attr (start 0) key value)
8993 (save-match-data
8995 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8997 (setq key (match-string 1 a) value (match-string 2 a)
8998 start (match-end 0)
8999 attr (plist-put attr (intern key) value))))
9000 (org-add-props s nil 'org-attr attr))
9001 s))
9003 (defun org-extract-attributes-from-string (tag)
9004 (let (key value attr)
9006 (setq key (match-string 1 tag) value (match-string 2 tag)
9007 tag (replace-match "" t t tag)
9008 attr (plist-put attr (intern key) value)))
9009 (cons tag attr)))
9011 (defun org-attributes-to-string (plist)
9012 "Format a property list into an HTML attribute list."
9013 (let ((s "") key value)
9014 (while plist
9015 (setq key (pop plist) value (pop plist))
9016 (and value
9018 s))
9020 ;;; Opening/following a link
9022 (defvar org-link-search-failed nil)
9024 (defvar org-open-link-functions nil
9025 "Hook for functions finding a plain text link.
9026 These functions must take a single argument, the link content.
9027 They will be called for links that look like [[link text][description]]
9031 These functions will be called *before* Org attempts to resolve the
9032 link by doing text searches in the current buffer - so if you want a
9034 handle this as a special case.
9036 When the function does handle the link, it must return a non-nil value.
9037 If it decides that it is not responsible for this link, it must return
9038 nil to indicate that that Org-mode can continue with other options
9039 like exact and fuzzy text search.")
9041 (defun org-next-link ()
9042 "Move forward to the next link.
9043 If the link is in hidden text, expose it."
9044 (interactive)
9045 (when (and org-link-search-failed (eq this-command last-command))
9046 (goto-char (point-min))
9047 (message "Link search wrapped back to beginning of buffer"))
9048 (setq org-link-search-failed nil)
9049 (let* ((pos (point))
9050 (ct (org-context))
9051 (a (assoc :link ct)))
9052 (if a (goto-char (nth 2 a)))
9053 (if (re-search-forward org-any-link-re nil t)
9054 (progn
9055 (goto-char (match-beginning 0))
9056 (if (outline-invisible-p) (org-show-context)))
9057 (goto-char pos)
9058 (setq org-link-search-failed t)
9059 (error "No further link found"))))
9061 (defun org-previous-link ()
9062 "Move backward to the previous link.
9063 If the link is in hidden text, expose it."
9064 (interactive)
9065 (when (and org-link-search-failed (eq this-command last-command))
9066 (goto-char (point-max))
9067 (message "Link search wrapped back to end of buffer"))
9068 (setq org-link-search-failed nil)
9069 (let* ((pos (point))
9070 (ct (org-context))
9071 (a (assoc :link ct)))
9072 (if a (goto-char (nth 1 a)))
9073 (if (re-search-backward org-any-link-re nil t)
9074 (progn
9075 (goto-char (match-beginning 0))
9076 (if (outline-invisible-p) (org-show-context)))
9077 (goto-char pos)
9078 (setq org-link-search-failed t)
9079 (error "No further link found"))))
9081 (defun org-translate-link (s)
9082 "Translate a link string if a translation function has been defined."
9083 (if (and org-link-translation-function
9084 (fboundp org-link-translation-function)
9086 (progn
9087 (setq s (funcall org-link-translation-function
9088 (match-string 1) (match-string 2)))
9089 (concat (car s) ":" (cdr s)))
9090 s))
9092 (defun org-translate-link-from-planner (type path)
9093 "Translate a link from Emacs Planner syntax so that Org can follow it.
9094 This is still an experimental function, your mileage may vary."
9095 (cond
9096 ((member type '("http" "https" "news" "ftp"))
9097 ;; standard Internet links are the same.
9098 nil)
9099 ((and (equal type "irc") (string-match "^//" path))
9100 ;; Planner has two / at the beginning of an irc link, we have 1.
9101 ;; We should have zero, actually....
9102 (setq path (substring path 1)))
9103 ((and (equal type "lisp") (string-match "^/" path))
9104 ;; Planner has a slash, we do not.
9105 (setq type "elisp" path (substring path 1)))
9107 ;; A typical message link. Planner has the id after the final slash,
9108 ;; we separate it with a hash mark
9109 (setq path (concat (match-string 1 path) "#"
9110 (org-remove-angle-brackets (match-string 2 path)))))
9111 )
9112 (cons type path))
9114 (defun org-find-file-at-mouse (ev)
9115 "Open file link or URL at mouse."
9116 (interactive "e")
9117 (mouse-set-point ev)
9118 (org-open-at-point 'in-emacs))
9120 (defun org-open-at-mouse (ev)
9121 "Open file link or URL at mouse."
9122 (interactive "e")
9123 (mouse-set-point ev)
9124 (if (eq major-mode 'org-agenda-mode)
9125 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9126 (org-open-at-point))
9128 (defvar org-window-config-before-follow-link nil
9129 "The window configuration before following a link.
9130 This is saved in case the need arises to restore it.")
9132 (defvar org-open-link-marker (make-marker)
9133 "Marker pointing to the location where `org-open-at-point; was called.")
9135 ;;;###autoload
9136 (defun org-open-at-point-global ()
9137 "Follow a link like Org-mode does.
9138 This command can be called in any mode to follow a link that has
9139 Org-mode syntax."
9140 (interactive)
9141 (org-run-like-in-org-mode 'org-open-at-point))
9143 ;;;###autoload
9144 (defun org-open-link-from-string (s &optional arg reference-buffer)
9145 "Open a link in the string S, as if it was in Org-mode."
9147 (let ((reference-buffer (or reference-buffer (current-buffer))))
9148 (with-temp-buffer
9149 (let ((org-inhibit-startup t))
9150 (org-mode)
9151 (insert s)
9152 (goto-char (point-min))
9153 (when reference-buffer
9154 (setq org-link-abbrev-alist-local
9155 (with-current-buffer reference-buffer
9156 org-link-abbrev-alist-local)))
9157 (org-open-at-point arg reference-buffer)))))
9159 (defvar org-open-at-point-functions nil
9160 "Hook that is run when following a link at point.
9162 Functions in this hook must return t if they identify and follow
9163 a link at point. If they don't find anything interesting at point,
9164 they must return nil.")
9166 (defun org-open-at-point (&optional arg reference-buffer)
9167 "Open link at or after point.
9168 If there is no link at point, this function will search forward up to
9169 the end of the current line.
9170 Normally, files will be opened by an appropriate application. If the
9171 optional prefix argument ARG is non-nil, Emacs will visit the file.
9172 With a double prefix argument, try to open outside of Emacs, in the
9173 application the system uses for this file type."
9174 (interactive "P")
9175 ;; if in a code block, then open the block's results
9176 (unless (call-interactively #'org-babel-open-src-block-result)
9177 (org-load-modules-maybe)
9178 (move-marker org-open-link-marker (point))
9179 (setq org-window-config-before-follow-link (current-window-configuration))
9180 (org-remove-occur-highlights nil nil t)
9181 (cond
9182 ((and (org-on-heading-p)
9183 (not (org-in-regexp
9188 (not (get-text-property (point) 'org-linked-text)))
9189 (or (org-offer-links-in-entry arg)
9190 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9191 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9192 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9193 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9194 (not (org-in-regexp org-bracket-link-regexp)))
9195 (org-footnote-action))
9196 (t
9197 (let (type path link line search (pos (point)))
9198 (catch 'match
9199 (save-excursion
9201 (when (org-in-regexp org-bracket-link-regexp 1)
9202 (setq link (org-extract-attributes
9203 (org-link-unescape (org-match-string-no-properties 1))))
9205 (setq link (replace-match " " t t link)))
9206 (setq link (org-link-expand-abbrev link))
9207 (cond
9208 ((or (file-name-absolute-p link)
9210 (setq type "file" path link))
9211 ((string-match org-link-re-with-space3 link)
9212 (setq type (match-string 1 link) path (match-string 2 link)))
9213 (t (setq type "thisfile" path link)))
9214 (throw 'match t)))
9216 (when (get-text-property (point) 'org-linked-text)
9217 (setq type "thisfile"
9218 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9219 (1+ (point)) (point))
9220 path (buffer-substring
9221 (previous-single-property-change pos 'org-linked-text)
9222 (next-single-property-change pos 'org-linked-text)))
9223 (throw 'match t))
9225 (save-excursion
9226 (when (or (org-in-regexp org-angle-link-re)
9227 (org-in-regexp org-plain-link-re))
9228 (setq type (match-string 1) path (match-string 2))
9229 (throw 'match t)))
9230 (save-excursion
9232 (setq type "tags"
9233 path (match-string 1))
9234 (while (string-match ":" path)
9235 (setq path (replace-match "+" t t path)))
9236 (throw 'match t)))
9238 (setq type "tree-match"
9239 path (match-string 1))
9240 (throw 'match t)))
9241 (unless path
9242 (error "No link found"))
9244 ;; switch back to reference buffer
9245 ;; needed when if called in a temporary buffer through
9246 ;; org-open-link-from-string
9247 (with-current-buffer (or reference-buffer (current-buffer))
9249 ;; Remove any trailing spaces in path
9251 (setq path (replace-match "" t t path)))
9252 (if (and org-link-translation-function
9253 (fboundp org-link-translation-function))
9254 ;; Check if we need to translate the link
9255 (let ((tmp (funcall org-link-translation-function type path)))
9256 (setq type (car tmp) path (cdr tmp))))
9258 (cond
9260 ((assoc type org-link-protocols)
9261 (funcall (nth 1 (assoc type org-link-protocols)) path))
9263 ((equal type "mailto")
9264 (let ((cmd (car org-link-mailto-program))
9265 (args (cdr org-link-mailto-program)) args1
9266 (address path) (subject "") a)
9268 (setq address (match-string 1 path)
9269 subject (org-link-escape (match-string 2 path))))
9270 (while args
9271 (cond
9272 ((not (stringp (car args))) (push (pop args) args1))
9273 (t (setq a (pop args))
9274 (if (string-match "%a" a)
9275 (setq a (replace-match address t t a)))
9276 (if (string-match "%s" a)
9277 (setq a (replace-match subject t t a)))
9278 (push a args1))))
9279 (apply cmd (nreverse args1))))
9281 ((member type '("http" "https" "ftp" "news"))
9282 (browse-url (concat type ":" (org-link-escape
9283 path org-link-escape-chars-browser))))
9285 ((string= type "doi")
9286 (browse-url (concat "http://dx.doi.org/"
9287 (org-link-escape
9288 path org-link-escape-chars-browser))))
9290 ((member type '("message"))
9291 (browse-url (concat type ":" path)))
9293 ((string= type "tags")
9294 (org-tags-view arg path))
9296 ((string= type "tree-match")
9299 ((string= type "file")
9301 (setq line (string-to-number (match-string 1 path))
9302 path (substring path 0 (match-beginning 0)))
9304 (setq search (match-string 1 path)
9305 path (substring path 0 (match-beginning 0)))))
9306 (if (string-match "[*?{]" (file-name-nondirectory path))
9307 (dired path)
9308 (org-open-file path arg line search)))
9310 ((string= type "shell")
9311 (let ((cmd path))
9312 (if (or (not org-confirm-shell-link-function)
9313 (funcall org-confirm-shell-link-function
9315 (org-add-props cmd nil
9316 'face 'org-warning))))
9317 (progn
9318 (message "Executing %s" cmd)
9319 (shell-command cmd))
9320 (error "Abort"))))
9322 ((string= type "elisp")
9323 (let ((cmd path))
9324 (if (or (not org-confirm-elisp-link-function)
9325 (funcall org-confirm-elisp-link-function
9327 (org-add-props cmd nil
9328 'face 'org-warning))))
9329 (message "%s => %s" cmd
9330 (if (equal (string-to-char cmd) ?\()
9331 (eval (read cmd))
9332 (call-interactively (read cmd))))
9333 (error "Abort"))))
9335 ((and (string= type "thisfile")
9336 (run-hook-with-args-until-success
9337 'org-open-link-functions path)))
9339 ((string= type "thisfile")
9340 (if arg
9341 (switch-to-buffer-other-window
9342 (org-get-buffer-for-internal-link (current-buffer)))
9343 (org-mark-ring-push))
9344 (let ((cmd `(org-link-search
9345 ,path
9346 ,(cond ((equal arg '(4)) ''occur)
9347 ((equal arg '(16)) ''org-occur)
9348 (t nil))
9349 ,pos)))
9350 (condition-case nil (eval cmd)
9351 (error (progn (widen) (eval cmd))))))
9353 (t
9354 (browse-url-at-point)))))))
9355 (move-marker org-open-link-marker nil)
9356 (run-hook-with-args 'org-follow-link-hook)))
9358 (defun org-offer-links-in-entry (&optional nth zero)
9359 "Offer links in the current entry and follow the selected link.
9360 If there is only one link, follow it immediately as well.
9361 If NTH is an integer, immediately pick the NTH link found.
9362 If ZERO is a string, check also this string for a link, and if
9363 there is one, offer it as link number zero."
9367 (cnt ?0)
9368 (in-emacs (if (integerp nth) nil nth))
9369 have-zero end links link c)
9370 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9371 (push (match-string 0 zero) links)
9372 (setq cnt (1- cnt) have-zero t))
9373 (save-excursion
9374 (org-back-to-heading t)
9375 (setq end (save-excursion (outline-next-heading) (point)))
9376 (while (re-search-forward re end t)
9377 (push (match-string 0) links))
9378 (setq links (org-uniquify (reverse links))))
9380 (cond
9381 ((null links)
9382 (message "No links"))
9383 ((equal (length links) 1)
9384 (setq link (list (car links))))
9385 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9386 (setq link (nth (if have-zero nth (1- nth)) links)))
9387 (t ; we have to select a link
9388 (save-excursion
9389 (save-window-excursion
9390 (delete-other-windows)
9391 (with-output-to-temp-buffer "*Select Link*"
9392 (mapc (lambda (l)
9393 (if (not (string-match org-bracket-link-regexp l))
9395 (org-remove-angle-brackets l)))
9396 (if (match-end 3)
9398 (match-string 3 l) (match-string 1 l)))
9400 (match-string 1 l))))))
9401 links))
9402 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9403 (message "Select link to open, RET to open all:")
9404 (setq c (read-char-exclusive))
9405 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9406 (when (equal c ?q) (error "Abort"))
9407 (if (equal c ?\C-m)
9408 (setq link links)
9409 (setq nth (- c ?0))
9410 (if have-zero (setq nth (1+ nth)))
9411 (unless (and (integerp nth) (>= (length links) nth))
9412 (error "Invalid link selection"))
9413 (setq link (list (nth (1- nth) links))))))
9414 (if link
9415 (let ((buf (current-buffer)))
9416 (dolist (l link)
9417 (org-open-link-from-string l in-emacs buf))
9418 t)
9419 nil)))
9421 ;; Add special file links that specify the way of opening
9423 (org-add-link-type "file+sys" 'org-open-file-with-system)
9424 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9425 (defun org-open-file-with-system (path)
9426 "Open file at PATH using the system way of opening it."
9427 (org-open-file path 'system))
9428 (defun org-open-file-with-emacs (path)
9429 "Open file at PATH in Emacs."
9430 (org-open-file path 'emacs))
9431 (defun org-remove-file-link-modifiers ()
9432 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9433 (goto-char (point-min))
9435 (org-if-unprotected
9436 (replace-match "file:" t t))))
9437 (eval-after-load "org-exp"
9438 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9439 'org-remove-file-link-modifiers))
9441 ;;;; Time estimates
9443 (defun org-get-effort (&optional pom)
9444 "Get the effort estimate for the current entry."
9445 (org-entry-get pom org-effort-property))
9447 ;;; File search
9449 (defvar org-create-file-search-functions nil
9450 "List of functions to construct the right search string for a file link.
9451 These functions are called in turn with point at the location to
9452 which the link should point.
9454 A function in the hook should first test if it would like to
9455 handle this file type, for example by checking the `major-mode'
9456 or the file extension. If it decides not to handle this file, it
9457 should just return nil to give other functions a chance. If it
9458 does handle the file, it must return the search string to be used
9459 when following the link. The search string will be part of the
9460 file link, given after a double colon, and `org-open-at-point'
9461 will automatically search for it. If special measures must be
9462 taken to make the search successful, another function should be
9463 added to the companion hook `org-execute-file-search-functions',
9464 which see.
9466 A function in this hook may also use `setq' to set the variable
9467 `description' to provide a suggestion for the descriptive text to
9468 be used for this link when it gets inserted into an Org-mode
9471 (defvar org-execute-file-search-functions nil
9472 "List of functions to execute a file search triggered by a link.
9474 Functions added to this hook must accept a single argument, the
9475 search string that was part of the file link, the part after the
9476 double colon. The function must first check if it would like to
9477 handle this search, for example by checking the `major-mode' or
9478 the file extension. If it decides not to handle this search, it
9479 should just return nil to give other functions a chance. If it
9480 does handle the search, it must return a non-nil value to keep
9481 other functions from trying.
9483 Each function can access the current prefix argument through the
9484 variable `current-prefix-argument'. Note that a single prefix is
9485 used to force opening a link in Emacs, so it may be good to only
9486 use a numeric or double prefix to guide the search function.
9488 In case this is needed, a function in this hook can also restore
9489 the window configuration before `org-open-at-point' was called using:
9491 (set-window-configuration org-window-config-before-follow-link)")
9493 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9494 (defun org-link-search (s &optional type avoid-pos)
9495 "Search for a link search option.
9496 If S is surrounded by forward slashes, it is interpreted as a
9497 regular expression. In org-mode files, this will create an `org-occur'
9498 sparse tree. In ordinary files, `occur' will be used to list matches.
9499 If the current buffer is in `dired-mode', grep will be used to search
9500 in all files. If AVOID-POS is given, ignore matches near that position."
9501 (let ((case-fold-search t)
9505 org-emphasis-alist)
9507 (pos (point))
9508 (pre nil) (post nil)
9509 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9510 (cond
9511 ;; First check if there are any special search functions
9512 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9513 ;; Now try the builtin stuff
9514 ((and (equal (string-to-char s0) ?#)
9515 (> (length s0) 1)
9516 (save-excursion
9517 (goto-char (point-min))
9518 (and
9519 (re-search-forward
9521 (setq type 'dedicated
9522 pos (match-beginning 0))))
9523 ;; There is an exact target for this
9524 (goto-char pos)
9525 (org-back-to-heading t)))
9526 ((save-excursion
9527 (goto-char (point-min))
9528 (and
9529 (re-search-forward
9530 (concat "<<" (regexp-quote s0) ">>") nil t)
9531 (setq type 'dedicated
9532 pos (match-beginning 0))))
9533 ;; There is an exact target for this
9534 (goto-char pos))
9536 (save-excursion
9537 (goto-char (point-min))
9538 (and
9539 (re-search-forward
9540 (concat "[^[]" (regexp-quote
9541 (format org-coderef-label-format
9542 (match-string 1 s0))))
9543 nil t)
9544 (setq type 'dedicated
9545 pos (1+ (match-beginning 0))))))
9546 ;; There is a coderef target for this
9547 (goto-char pos))
9549 ;; A regular expression
9550 (cond
9551 ((org-mode-p)
9552 (org-occur (match-string 1 s)))
9553 ;;((eq major-mode 'dired-mode)
9554 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9555 (t (org-do-occur (match-string 1 s)))))
9556 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9557 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9558 (goto-char (point-min))
9559 (cond
9560 ((let (case-fold-search)
9561 (re-search-forward (format org-complex-heading-regexp-format
9562 (regexp-quote s))
9563 nil t))
9564 ;; OK, found a match
9565 (setq type 'dedicated)
9566 (goto-char (match-beginning 0)))
9567 ((and (not org-link-search-inhibit-query)
9568 (eq org-link-search-must-match-exact-headline 'query-to-create)
9569 (y-or-n-p "No match - create this as a new heading? "))
9570 (goto-char (point-max))
9571 (or (bolp) (newline))
9573 (beginning-of-line 0))
9574 (t
9575 (goto-char pos)
9576 (error "No match"))))
9577 (t
9578 ;; A normal search string
9579 (when (equal (string-to-char s) ?*)
9580 ;; Anchor on headlines, post may include tags.
9583 s (substring s 1)))
9584 (remove-text-properties
9585 0 (length s)
9586 '(face nil mouse-face nil keymap nil fontified nil) s)
9587 ;; Make a series of regular expressions to find a match
9596 re4 (concat "[^a-zA-Z_]" re4_)
9598 re1 (concat pre re2 post)
9599 re3 (concat pre (if pre re4_ re4) post)
9600 re5 (concat pre ".*" re4)
9601 re2 (concat pre re2)
9602 re2a (concat pre (if pre re2a_ re2a))
9603 re4 (concat pre (if pre re4_ re4))
9607 ))
9608 (cond
9609 ((eq type 'org-occur) (org-occur reall))
9610 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9611 (t (goto-char (point-min))
9612 (setq type 'fuzzy)
9613 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9614 (org-search-not-self 1 re1 nil t)
9615 (org-search-not-self 1 re2 nil t)
9616 (org-search-not-self 1 re2a nil t)
9617 (org-search-not-self 1 re3 nil t)
9618 (org-search-not-self 1 re4 nil t)
9619 (org-search-not-self 1 re5 nil t)
9620 )
9621 (goto-char (match-beginning 1))
9622 (goto-char pos)
9623 (error "No match"))))))
9624 (and (org-mode-p) (org-show-context 'link-search))
9625 type))
9627 (defun org-search-not-self (group &rest args)
9628 "Execute `re-search-forward', but only accept matches that do not
9629 enclose the position of `org-open-link-marker'."
9630 (let ((m org-open-link-marker))
9631 (catch 'exit
9632 (while (apply 're-search-forward args)
9633 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9634 (goto-char (match-end group))
9635 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9636 (> (match-beginning 0) (marker-position m))
9637 (< (match-end 0) (marker-position m)))
9638 (save-match-data
9639 (or (not (org-in-regexp
9640 org-bracket-link-analytic-regexp 1))
9641 (not (match-end 4)) ; no description
9642 (and (<= (match-beginning 4) (point))
9643 (>= (match-end 4) (point))))))
9644 (throw 'exit (point))))))))
9646 (defun org-get-buffer-for-internal-link (buffer)
9647 "Return a buffer to be used for displaying the link target of internal links."
9648 (cond
9649 ((not org-display-internal-link-with-indirect-buffer)
9650 buffer)
9651 ((string-match "(Clone)$" (buffer-name buffer))
9652 (message "Buffer is already a clone, not making another one")
9653 ;; we also do not modify visibility in this case
9654 buffer)
9655 (t ; make a new indirect buffer for displaying the link
9656 (let* ((bn (buffer-name buffer))
9657 (ibn (concat bn "(Clone)"))
9658 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9659 (with-current-buffer ib (org-overview))
9660 ib))))
9662 (defun org-do-occur (regexp &optional cleanup)
9663 "Call the Emacs command `occur'.
9664 If CLEANUP is non-nil, remove the printout of the regular expression
9665 in the *Occur* buffer. This is useful if the regex is long and not useful
9666 to read."
9667 (occur regexp)
9668 (when cleanup
9669 (let ((cwin (selected-window)) win beg end)
9670 (when (setq win (get-buffer-window "*Occur*"))
9671 (select-window win))
9672 (goto-char (point-min))
9673 (when (re-search-forward "match[a-z]+" nil t)
9674 (setq beg (match-end 0))
9676 (setq end (1- (match-beginning 0)))))
9677 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9678 (goto-char (point-min))
9679 (select-window cwin))))
9681 ;;; The mark ring for links jumps
9683 (defvar org-mark-ring nil
9684 "Mark ring for positions before jumps in Org-mode.")
9685 (defvar org-mark-ring-last-goto nil
9686 "Last position in the mark ring used to go back.")
9687 ;; Fill and close the ring
9688 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9689 (loop for i from 1 to org-mark-ring-length do
9690 (push (make-marker) org-mark-ring))
9691 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9692 org-mark-ring)
9694 (defun org-mark-ring-push (&optional pos buffer)
9695 "Put the current position or POS into the mark ring and rotate it."
9696 (interactive)
9697 (setq pos (or pos (point)))
9698 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9699 (move-marker (car org-mark-ring)
9700 (or pos (point))
9701 (or buffer (current-buffer)))
9702 (message "%s"
9703 (substitute-command-keys
9706 (defun org-mark-ring-goto (&optional n)
9707 "Jump to the previous position in the mark ring.
9708 With prefix arg N, jump back that many stored positions. When
9709 called several times in succession, walk through the entire ring.
9710 Org-mode commands jumping to a different position in the current file,
9711 or to another Org-mode file, automatically push the old position
9712 onto the ring."
9713 (interactive "p")
9714 (let (p m)
9715 (if (eq last-command this-command)
9716 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9717 (setq p org-mark-ring))
9718 (setq org-mark-ring-last-goto p)
9719 (setq m (car p))
9720 (switch-to-buffer (marker-buffer m))
9721 (goto-char m)
9722 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9724 (defun org-remove-angle-brackets (s)
9725 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9726 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9727 s)
9728 (defun org-add-angle-brackets (s)
9729 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9730 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9731 s)
9732 (defun org-remove-double-quotes (s)
9735 s)
9737 ;;; Following specific links
9739 (defun org-follow-timestamp-link ()
9740 (cond
9741 ((org-at-date-range-p t)
9742 (let ((org-agenda-start-on-weekday)
9743 (t1 (match-string 1))
9744 (t2 (match-string 2)))
9745 (setq t1 (time-to-days (org-time-string-to-time t1))
9746 t2 (time-to-days (org-time-string-to-time t2)))
9747 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9748 ((org-at-timestamp-p t)
9749 (org-agenda-list nil (time-to-days (org-time-string-to-time
9750 (substring (match-string 1) 0 10)))
9751 1))
9752 (t (error "This should not happen"))))
9755 ;;; Following file links
9756 (defvar org-wait nil)
9757 (defun org-open-file (path &optional in-emacs line search)
9758 "Open the file at PATH.
9759 First, this expands any special file name abbreviations. Then the
9760 configuration variable `org-file-apps' is checked if it contains an
9761 entry for this file type, and if yes, the corresponding command is launched.
9763 If no application is found, Emacs simply visits the file.
9765 With optional prefix argument IN-EMACS, Emacs will visit the file.
9767 prefix arg, Org tries to avoid opening in Emacs
9768 and to use an external application to visit the file.
9770 Optional LINE specifies a line to go to, optional SEARCH a string
9771 to search for. If LINE or SEARCH is given, the file will be
9772 opened in Emacs, unless an entry from org-file-apps that makes
9773 use of groups in a regexp matches.
9774 If the file does not exist, an error is thrown."
9775 (let* ((file (if (equal path "")
9776 buffer-file-name
9777 (substitute-in-file-name (expand-file-name path))))
9778 (file-apps (append org-file-apps (org-default-apps)))
9779 (apps (org-remove-if
9780 'org-file-apps-entry-match-against-dlink-p file-apps))
9781 (apps-dlink (org-remove-if-not
9782 'org-file-apps-entry-match-against-dlink-p file-apps))
9783 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9784 (dirp (if remp nil (file-directory-p file)))
9785 (file (if (and dirp org-open-directory-means-index-dot-org)
9786 (concat (file-name-as-directory file) "index.org")
9787 file))
9788 (a-m-a-p (assq 'auto-mode apps))
9789 (dfile (downcase file))
9790 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9791 (link (cond ((and (eq line nil)
9792 (eq search nil))
9793 file)
9794 (line
9795 (concat file "::" (number-to-string line)))
9796 (search
9797 (concat file "::" search))))
9798 (dlink (downcase link))
9799 (old-buffer (current-buffer))
9800 (old-pos (point))
9801 (old-mode major-mode)
9802 ext cmd link-match-data)
9804 (setq ext (match-string 1 dfile))
9806 (setq ext (match-string 1 dfile))))
9807 (cond
9808 ((member in-emacs '((16) system))
9809 (setq cmd (cdr (assoc 'system apps))))
9810 (in-emacs (setq cmd 'emacs))
9811 (t
9812 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9813 (and dirp (cdr (assoc 'directory apps)))
9814 ; first, try matching against apps-dlink
9815 ; if we get a match here, store the match data for later
9816 (let ((match (assoc-default dlink apps-dlink
9817 'string-match)))
9818 (if match
9819 (progn (setq link-match-data (match-data))
9820 match)
9821 (progn (setq in-emacs (or in-emacs line search))
9822 nil))) ; if we have no match in apps-dlink,
9823 ; always open the file in emacs if line or search
9824 ; is given (for backwards compatibility)
9825 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9826 'string-match)
9827 (cdr (assoc ext apps))
9828 (cdr (assoc t apps))))))
9829 (when (eq cmd 'system)
9830 (setq cmd (cdr (assoc 'system apps))))
9831 (when (eq cmd 'default)
9832 (setq cmd (cdr (assoc t apps))))
9833 (when (eq cmd 'mailcap)
9834 (require 'mailcap)
9835 (mailcap-parse-mailcaps)
9836 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9837 (command (mailcap-mime-info mime-type)))
9838 (if (stringp command)
9839 (setq cmd command)
9840 (setq cmd 'emacs))))
9841 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9842 (not (file-exists-p file))
9843 (not org-open-non-existing-files))
9844 (error "No such file: %s" file))
9845 (cond
9847 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9849 (setq cmd (replace-match "%s" t t cmd)))
9850 (while (string-match "%s" cmd)
9851 (setq cmd (replace-match
9852 (save-match-data
9853 (shell-quote-argument
9854 (convert-standard-filename file)))
9855 t t cmd)))
9857 ;; Replace "%1", "%2" etc. in command with group matches from regex
9858 (save-match-data
9859 (let ((match-index 1)
9860 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9861 (set-match-data link-match-data)
9862 (while (<= match-index number-of-groups)
9863 (let ((regex (concat "%" (number-to-string match-index)))
9864 (replace-with (match-string match-index dlink)))
9865 (while (string-match regex cmd)
9866 (setq cmd (replace-match replace-with t t cmd))))
9867 (setq match-index (+ match-index 1)))))
9869 (save-window-excursion
9870 (start-process-shell-command cmd nil cmd)
9871 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9872 ))
9873 ((or (stringp cmd)
9874 (eq cmd 'emacs))
9875 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9876 (widen)
9877 (if line (org-goto-line line)
9878 (if search (org-link-search search))))
9879 ((consp cmd)
9880 (let ((file (convert-standard-filename file)))
9881 (save-match-data
9882 (set-match-data link-match-data)
9883 (eval cmd))))
9884 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9885 (and (org-mode-p) (eq old-mode 'org-mode)
9886 (or (not (equal old-buffer (current-buffer)))
9887 (not (equal old-pos (point))))
9888 (org-mark-ring-push old-pos old-buffer))))
9890 (defun org-file-apps-entry-match-against-dlink-p (entry)
9891 "This function returns non-nil if `entry' uses a regular
9892 expression which should be matched against the whole link by
9893 org-open-file.
9895 It assumes that is the case when the entry uses a regular
9896 expression which has at least one grouping construct and the
9897 action is either a lisp form or a command string containing
9898 '%1', i.e. using at least one subexpression match as a
9899 parameter."
9900 (let ((selector (car entry))
9901 (action (cdr entry)))
9902 (if (stringp selector)
9903 (and (> (regexp-opt-depth selector) 0)
9904 (or (and (stringp action)
9905 (string-match "%[0-9]" action))
9906 (consp action)))
9907 nil)))
9909 (defun org-default-apps ()
9910 "Return the default applications for this operating system."
9911 (cond
9912 ((eq system-type 'darwin)
9913 org-file-apps-defaults-macosx)
9914 ((eq system-type 'windows-nt)
9915 org-file-apps-defaults-windowsnt)
9916 (t org-file-apps-defaults-gnu)))
9918 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9919 "Convert extensions to regular expressions in the cars of LIST.
9920 Also, weed out any non-string entries, because the return value is used
9921 only for regexp matching.
9922 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9923 point to the symbol `emacs', indicating that the file should
9924 be opened in Emacs."
9925 (append
9926 (delq nil
9927 (mapcar (lambda (x)
9928 (if (not (stringp (car x)))
9929 nil
9931 x
9933 list))
9934 (if add-auto-mode
9935 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9937 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9938 (defun org-file-remote-p (file)
9939 "Test whether FILE specifies a location on a remote system.
9940 Return non-nil if the location is indeed remote.
9944 (cond ((fboundp 'file-remote-p)
9945 (file-remote-p file))
9946 ((fboundp 'tramp-handle-file-remote-p)
9947 (tramp-handle-file-remote-p file))
9948 ((and (boundp 'ange-ftp-name-format)
9949 (string-match (car ange-ftp-name-format) file))
9950 t)
9951 (t nil)))
9954 ;;;; Refiling
9956 (defun org-get-org-file ()
9957 "Read a filename, with default directory `org-directory'."
9958 (let ((default (or org-default-notes-file remember-data-file)))
9959 (read-file-name (format "File name [%s]: " default)
9960 (file-name-as-directory org-directory)
9961 default)))
9963 (defun org-notes-order-reversed-p ()
9964 "Check if the current file should receive notes in reversed order."
9965 (cond
9966 ((not org-reverse-note-order) nil)
9967 ((eq t org-reverse-note-order) t)
9968 ((not (listp org-reverse-note-order)) nil)
9969 (t (catch 'exit
9970 (let ((all org-reverse-note-order)
9971 entry)
9972 (while (setq entry (pop all))
9973 (if (string-match (car entry) buffer-file-name)
9974 (throw 'exit (cdr entry))))
9975 nil)))))
9977 (defvar org-refile-target-table nil
9978 "The list of refile targets, created by `org-refile'.")
9980 (defvar org-agenda-new-buffers nil
9981 "Buffers created to visit agenda files.")
9983 (defvar org-refile-cache nil
9984 "Cache for refile targets.")
9987 (defvar org-refile-markers nil
9988 "All the markers used for caching refile locations.")
9990 (defun org-refile-marker (pos)
9991 "Get a new refile marker, but only if caching is in use."
9992 (if (not org-refile-use-cache)
9993 pos
9994 (let ((m (make-marker)))
9995 (move-marker m pos)
9996 (push m org-refile-markers)
9997 m)))
9999 (defun org-refile-cache-clear ()
10000 "Clear the refile cache and disable all the markers."
10001 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10002 (setq org-refile-markers nil)
10003 (setq org-refile-cache nil)
10004 (message "Refile cache has been cleared"))
10006 (defun org-refile-cache-check-set (set)
10007 "Check if all the markers in the cache still have live buffers."
10008 (let (marker)
10009 (catch 'exit
10010 (while (and set (setq marker (nth 3 (pop set))))
10011 ;; if org-refile-use-outline-path is 'file, marker may be nil
10012 (when (and marker (null (marker-buffer marker)))
10013 (message "not found") (sit-for 3)
10014 (throw 'exit nil)))
10015 t)))
10017 (defun org-refile-cache-put (set &rest identifiers)
10018 "Push the refile targets SET into the cache, under IDENTIFIERS."
10019 (let* ((key (sha1 (prin1-to-string identifiers)))
10020 (entry (assoc key org-refile-cache)))
10021 (if entry
10022 (setcdr entry set)
10023 (push (cons key set) org-refile-cache))))
10025 (defun org-refile-cache-get (&rest identifiers)
10026 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10027 (cond
10028 ((not org-refile-cache) nil)
10029 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10030 (t
10031 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10032 org-refile-cache))))
10033 (and set (org-refile-cache-check-set set) set)))))
10035 (defun org-get-refile-targets (&optional default-buffer)
10036 "Produce a table with refile targets."
10037 (let ((case-fold-search nil)
10038 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10039 (entries (or org-refile-targets '((nil . (:level . 1)))))
10040 targets tgs txt re files f desc descre fast-path-p level pos0)
10041 (message "Getting targets...")
10042 (with-current-buffer (or default-buffer (current-buffer))
10043 (while (setq entry (pop entries))
10044 (setq files (car entry) desc (cdr entry))
10045 (setq fast-path-p nil)
10046 (cond
10047 ((null files) (setq files (list (current-buffer))))
10048 ((eq files 'org-agenda-files)
10049 (setq files (org-agenda-files 'unrestricted)))
10050 ((and (symbolp files) (fboundp files))
10051 (setq files (funcall files)))
10052 ((and (symbolp files) (boundp files))
10053 (setq files (symbol-value files))))
10054 (if (stringp files) (setq files (list files)))
10055 (cond
10056 ((eq (car desc) :tag)
10058 ((eq (car desc) :todo)
10060 ((eq (car desc) :regexp)
10061 (setq descre (cdr desc)))
10062 ((eq (car desc) :level)
10064 (if org-odd-levels-only
10065 (1- (* 2 (cdr desc)))
10066 (cdr desc)))
10068 ((eq (car desc) :maxlevel)
10069 (setq fast-path-p t)
10071 (if org-odd-levels-only
10072 (1- (* 2 (cdr desc)))
10073 (cdr desc)))
10075 (t (error "Bad refiling target description %s" desc)))
10076 (while (setq f (pop files))
10077 (with-current-buffer
10078 (if (bufferp f) f (org-get-agenda-file-buffer f))
10079 (or
10080 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10081 (progn
10082 (if (bufferp f) (setq f (buffer-file-name
10083 (buffer-base-buffer f))))
10084 (setq f (and f (expand-file-name f)))
10085 (if (eq org-refile-use-outline-path 'file)
10086 (push (list (file-name-nondirectory f) f nil nil) tgs))
10087 (save-excursion
10088 (save-restriction
10089 (widen)
10090 (goto-char (point-min))
10091 (while (re-search-forward descre nil t)
10092 (goto-char (setq pos0 (point-at-bol)))
10093 (catch 'next
10094 (when org-refile-target-verify-function
10095 (save-match-data
10096 (or (funcall org-refile-target-verify-function)
10097 (throw 'next t))))
10098 (when (looking-at org-complex-heading-regexp)
10099 (setq level (org-reduced-level
10100 (- (match-end 1) (match-beginning 1)))
10101 txt (org-link-display-format (match-string 4))
10103 re (format org-complex-heading-regexp-format
10104 (regexp-quote (match-string 4))))
10105 (when org-refile-use-outline-path
10106 (setq txt (mapconcat
10107 'org-protect-slash
10108 (append
10109 (if (eq org-refile-use-outline-path
10110 'file)
10111 (list (file-name-nondirectory
10112 (buffer-file-name
10113 (buffer-base-buffer))))
10114 (if (eq org-refile-use-outline-path
10115 'full-file-path)
10116 (list (buffer-file-name
10117 (buffer-base-buffer)))))
10118 (org-get-outline-path fast-path-p
10119 level txt)
10120 (list txt))
10121 "/")))
10122 (push (list txt f re (org-refile-marker (point)))
10123 tgs)))
10124 (when (= (point) pos0)
10125 ;; verification function has not moved point
10126 (goto-char (point-at-eol))))))))
10127 (when org-refile-use-cache
10128 (org-refile-cache-put tgs (buffer-file-name) descre))
10129 (setq targets (append tgs targets))
10130 ))))
10131 (message "Getting targets...done")
10132 (nreverse targets)))
10134 (defun org-protect-slash (s)
10135 (while (string-match "/" s)
10137 s)
10139 (defvar org-olpa (make-vector 20 nil))
10141 (defun org-get-outline-path (&optional fastp level heading)
10142 "Return the outline path to the current entry, as a list.
10144 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10145 routine which makes outline path derivations for an entire file,
10146 avoiding backtracing. Refile target collection makes use of that."
10147 (if fastp
10148 (progn
10149 (if (> level 19)
10150 (error "Outline path failure, more than 19 levels"))
10151 (loop for i from level upto 19 do
10152 (aset org-olpa i nil))
10153 (prog1
10154 (delq nil (append org-olpa nil))
10155 (aset org-olpa level heading)))
10156 (let (rtn case-fold-search)
10157 (save-excursion
10158 (save-restriction
10159 (widen)
10160 (while (org-up-heading-safe)
10161 (when (looking-at org-complex-heading-regexp)
10162 (push (org-match-string-no-properties 4) rtn)))
10163 rtn)))))
10165 (defun org-format-outline-path (path &optional width prefix)
10166 "Format the outline path PATH for display.
10167 Width is the maximum number of characters that is available.
10168 Prefix is a prefix to be included in the returned string,
10169 such as the file name."
10170 (setq width (or width 79))
10171 (if prefix (setq width (- width (length prefix))))
10172 (if (not path)
10173 (or prefix "")
10174 (let* ((nsteps (length path))
10175 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10176 (maxwidth (if (<= total-width width)
10177 10000 ;; everything fits
10178 ;; we need to shorten the level headings
10179 (/ (- width nsteps) nsteps)))
10180 (org-odd-levels-only nil)
10181 (n 0)
10182 (total (1+ (length prefix))))
10183 (setq maxwidth (max maxwidth 10))
10184 (concat prefix
10185 (mapconcat
10186 (lambda (h)
10187 (setq n (1+ n))
10188 (if (and (= n nsteps) (< maxwidth 10000))
10189 (setq maxwidth (- total-width total)))
10190 (if (< (length h) maxwidth)
10191 (progn (setq total (+ total (length h) 1)) h)
10192 (setq h (substring h 0 (- maxwidth 2))
10193 total (+ total maxwidth 1))
10195 (setq h (substring h 0 (match-beginning 0))))
10196 (setq h (concat h "..")))
10197 (org-add-props h nil 'face
10198 (nth (% (1- n) org-n-level-faces)
10199 org-level-faces))
10200 h)
10201 path "/")))))
10203 (defun org-display-outline-path (&optional file current)
10204 "Display the current outline path in the echo area."
10205 (interactive "P")
10206 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10207 (case-fold-search nil)
10208 (path (and (org-mode-p) (org-get-outline-path))))
10209 (if current (setq path (append path
10210 (save-excursion
10211 (org-back-to-heading t)
10212 (if (looking-at org-complex-heading-regexp)
10213 (list (match-string 4)))))))
10214 (message "%s"
10215 (org-format-outline-path
10216 path
10217 (1- (frame-width))
10218 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10220 (defvar org-refile-history nil
10221 "History for refiling operations.")
10223 (defvar org-after-refile-insert-hook nil
10224 "Hook run after `org-refile' has inserted its stuff at the new location.
10225 Note that this is still *before* the stuff will be removed from
10226 the *old* location.")
10228 (defvar org-capture-last-stored-marker)
10229 (defun org-refile (&optional goto default-buffer rfloc)
10230 "Move the entry at point to another heading.
10231 The list of target headings is compiled using the information in
10232 `org-refile-targets', which see. This list is created before each use
10233 and will therefore always be up-to-date.
10235 At the target location, the entry is filed as a subitem of the target heading.
10236 Depending on `org-reverse-note-order', the new subitem will either be the
10237 first or the last subitem.
10239 If there is an active region, all entries in that region will be moved.
10240 However, the region must fulfill the requirement that the first heading
10241 is the first one sets the top-level of the moved text - at most siblings
10242 below it are allowed.
10244 With prefix arg GOTO, the command will only visit the target location,
10245 not actually move anything.
10247 go to the location where the last refiling
10248 operation has put the subtree.
10249 With a prefix argument of `2', refile to the running clock.
10251 RFLOC can be a refile location obtained in a different way.
10253 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10255 If you are using target caching (see `org-refile-use-cache'),
10256 You have to clear the target cache in order to find new targets.
10257 This can be done with a 0 prefix: `C-0 C-c C-w'"
10258 (interactive "P")
10259 (if (member goto '(0 (64)))
10260 (org-refile-cache-clear)
10261 (let* ((cbuf (current-buffer))
10262 (regionp (org-region-active-p))
10263 (region-start (and regionp (region-beginning)))
10264 (region-end (and regionp (region-end)))
10265 (region-length (and regionp (- region-end region-start)))
10266 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10267 pos it nbuf file re level reversed)
10268 (setq last-command nil)
10269 (when regionp
10270 (goto-char region-start)
10271 (or (bolp) (goto-char (point-at-bol)))
10272 (setq region-start (point))
10273 (unless (org-kill-is-subtree-p
10274 (buffer-substring region-start region-end))
10275 (error "The region is not a (sequence of) subtree(s)")))
10276 (if (equal goto '(16))
10277 (org-refile-goto-last-stored)
10278 (when (or
10279 (and (equal goto 2)
10280 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10281 (prog1
10282 (setq it (list (or org-clock-heading "running clock")
10283 (buffer-file-name
10284 (marker-buffer org-clock-hd-marker))
10285 ""
10286 (marker-position org-clock-hd-marker)))
10287 (setq goto nil)))
10288 (setq it (or rfloc
10289 (save-excursion
10290 (org-refile-get-location
10291 (if goto "Goto: " "Refile to: ") default-buffer
10292 org-refile-allow-creating-parent-nodes)))))
10293 (setq file (nth 1 it)
10294 re (nth 2 it)
10295 pos (nth 3 it))
10296 (if (and (not goto)
10297 pos
10298 (equal (buffer-file-name) file)
10299 (if regionp
10300 (and (>= pos region-start)
10301 (<= pos region-end))
10302 (and (>= pos (point))
10303 (< pos (save-excursion
10304 (org-end-of-subtree t t))))))
10305 (error "Cannot refile to position inside the tree or region"))
10307 (setq nbuf (or (find-buffer-visiting file)
10308 (find-file-noselect file)))
10309 (if goto
10310 (progn
10311 (switch-to-buffer nbuf)
10312 (goto-char pos)
10313 (org-show-context 'org-goto))
10314 (if regionp
10315 (progn
10316 (org-kill-new (buffer-substring region-start region-end))
10317 (org-save-markers-in-region region-start region-end))
10318 (org-copy-subtree 1 nil t))
10319 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10320 (find-file-noselect file)))
10321 (setq reversed (org-notes-order-reversed-p))
10322 (save-excursion
10323 (save-restriction
10324 (widen)
10325 (if pos
10326 (progn
10327 (goto-char pos)
10328 (looking-at outline-regexp)
10329 (setq level (org-get-valid-level (funcall outline-level) 1))
10330 (goto-char
10331 (if reversed
10332 (or (outline-next-heading) (point-max))
10333 (or (save-excursion (org-get-next-sibling))
10334 (org-end-of-subtree t t)
10335 (point-max)))))
10336 (setq level 1)
10337 (if (not reversed)
10338 (goto-char (point-max))
10339 (goto-char (point-min))
10340 (or (outline-next-heading) (goto-char (point-max)))))
10341 (if (not (bolp)) (newline))
10342 (org-paste-subtree level)
10343 (when org-log-refile
10344 (org-add-log-setup 'refile nil nil 'findpos
10345 org-log-refile)
10346 (unless (eq org-log-refile 'note)
10347 (save-excursion (org-add-log-note))))
10348 (and org-auto-align-tags (org-set-tags nil t))
10349 (bookmark-set "org-refile-last-stored")
10350 ;; If we are refiling for capture, make sure that the
10351 ;; last-capture pointers point here
10352 (when (org-bound-and-true-p org-refile-for-capture)
10353 (bookmark-set "org-capture-last-stored-marker")
10354 (move-marker org-capture-last-stored-marker (point)))
10355 (if (fboundp 'deactivate-mark) (deactivate-mark))
10356 (run-hooks 'org-after-refile-insert-hook))))
10357 (if regionp
10358 (delete-region (point) (+ (point) region-length))
10359 (org-cut-subtree))
10360 (when (featurep 'org-inlinetask)
10361 (org-inlinetask-remove-END-maybe))
10362 (setq org-markers-to-move nil)
10365 (defun org-refile-goto-last-stored ()
10366 "Go to the location where the last refile was stored."
10367 (interactive)
10368 (bookmark-jump "org-refile-last-stored")
10369 (message "This is the location of the last refile"))
10371 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10372 "Prompt the user for a refile location, using PROMPT."
10373 (let ((org-refile-targets org-refile-targets)
10374 (org-refile-use-outline-path org-refile-use-outline-path))
10375 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10376 (unless org-refile-target-table
10377 (error "No refile targets"))
10378 (let* ((cbuf (current-buffer))
10379 (partial-completion-mode nil)
10380 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10381 (cfunc (if (and org-refile-use-outline-path
10382 org-outline-path-complete-in-steps)
10383 'org-olpath-completing-read
10384 'org-icompleting-read))
10385 (extra (if org-refile-use-outline-path "/" ""))
10386 (filename (and cfn (expand-file-name cfn)))
10387 (tbl (mapcar
10388 (lambda (x)
10389 (if (and (not (member org-refile-use-outline-path
10390 '(file full-file-path)))
10391 (not (equal filename (nth 1 x))))
10392 (cons (concat (car x) extra " ("
10393 (file-name-nondirectory (nth 1 x)) ")")
10394 (cdr x))
10395 (cons (concat (car x) extra) (cdr x))))
10396 org-refile-target-table))
10397 (completion-ignore-case t)
10398 pa answ parent-target child parent old-hist)
10399 (setq old-hist org-refile-history)
10400 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10401 nil 'org-refile-history))
10402 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10403 (org-refile-check-position pa)
10404 (if pa
10405 (progn
10406 (when (or (not org-refile-history)
10407 (not (eq old-hist org-refile-history))
10408 (not (equal (car pa) (car org-refile-history))))
10409 (setq org-refile-history
10410 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10411 org-refile-history
10412 (cdr org-refile-history))))
10413 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10414 (pop org-refile-history)))
10415 pa)
10417 (progn
10418 (setq parent (match-string 1 answ)
10419 child (match-string 2 answ))
10420 (setq parent-target (or (assoc parent tbl)
10421 (assoc (concat parent "/") tbl)))
10422 (when (and parent-target
10423 (or (eq new-nodes t)
10424 (and (eq new-nodes 'confirm)
10426 child)))))
10427 (org-refile-new-child parent-target child)))
10428 (error "Invalid target location")))))
10430 (defun org-refile-check-position (refile-pointer)
10431 "Check if the refile pointer matches the readline to which it points."
10432 (let* ((file (nth 1 refile-pointer))
10433 (re (nth 2 refile-pointer))
10434 (pos (nth 3 refile-pointer))
10435 buffer)
10436 (when (org-string-nw-p re)
10437 (setq buffer (if (markerp pos)
10438 (marker-buffer pos)
10439 (or (find-buffer-visiting file)
10440 (find-file-noselect file))))
10441 (with-current-buffer buffer
10442 (save-excursion
10443 (save-restriction
10444 (widen)
10445 (goto-char pos)
10446 (beginning-of-line 1)
10447 (unless (org-looking-at-p re)
10448 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10450 (defun org-refile-new-child (parent-target child)
10451 "Use refile target PARENT-TARGET to add new CHILD below it."
10452 (unless parent-target
10453 (error "Cannot find parent for new node"))
10454 (let ((file (nth 1 parent-target))
10455 (pos (nth 3 parent-target))
10456 level)
10457 (with-current-buffer (or (find-buffer-visiting file)
10458 (find-file-noselect file))
10459 (save-excursion
10460 (save-restriction
10461 (widen)
10462 (if pos
10463 (goto-char pos)
10464 (goto-char (point-max))
10465 (if (not (bolp)) (newline)))
10466 (when (looking-at outline-regexp)
10467 (setq level (funcall outline-level))
10468 (org-end-of-subtree t t))
10469 (org-back-over-empty-lines)
10471 (if pos (org-get-valid-level level 1) 1) ?*)
10473 (beginning-of-line 0)
10474 (list (concat (car parent-target) "/" child) file "" (point)))))))
10476 (defun org-olpath-completing-read (prompt collection &rest args)
10477 "Read an outline path like a file name."
10478 (let ((thetable collection)
10479 (org-completion-use-ido nil) ; does not work with ido.
10480 (org-completion-use-iswitchb nil)) ; or iswitchb
10481 (apply
10482 'org-icompleting-read prompt
10483 (lambda (string predicate &optional flag)
10484 (let (rtn r f (l (length string)))
10485 (cond
10486 ((eq flag nil)
10487 ;; try completion
10488 (try-completion string thetable))
10489 ((eq flag t)
10490 ;; all-completions
10491 (setq rtn (all-completions string thetable predicate))
10492 (mapcar
10493 (lambda (x)
10494 (setq r (substring x l))
10495 (if (string-match " ([^)]*)$" x)
10496 (setq f (match-string 0 x))
10497 (setq f ""))
10498 (if (string-match "/" r)
10499 (concat string (substring r 0 (match-end 0)) f)
10500 x))
10501 rtn))
10502 ((eq flag 'lambda)
10503 ;; exact match?
10504 (assoc string thetable)))
10505 ))
10506 args)))
10508 ;;;; Dynamic blocks
10510 (defun org-find-dblock (name)
10511 "Find the first dynamic block with name NAME in the buffer.
10512 If not found, stay at current position and return nil."
10513 (let (pos)
10514 (save-excursion
10515 (goto-char (point-min))
10517 nil t)
10518 (match-beginning 0))))
10519 (if pos (goto-char pos))
10520 pos))
10522 (defconst org-dblock-start-re
10524 "Matches the start line of a dynamic block, with parameters.")
10527 "Matches the end of a dynamic block.")
10529 (defun org-create-dblock (plist)
10530 "Create a dynamic block section, with parameters taken from PLIST.
10531 PLIST must contain a :name entry which is used as name of the block."
10533 (end-of-line 1)
10534 (newline))
10535 (let ((col (current-column))
10536 (name (plist-get plist :name)))
10537 (insert "#+BEGIN: " name)
10538 (while plist
10539 (if (eq (car plist) :name)
10540 (setq plist (cddr plist))
10541 (insert " " (prin1-to-string (pop plist)))))
10543 (beginning-of-line -2)))
10545 (defun org-prepare-dblock ()
10546 "Prepare dynamic block for refresh.
10547 This empties the block, puts the cursor at the insert position and returns
10548 the property list including an extra property :name with the block name."
10549 (unless (looking-at org-dblock-start-re)
10550 (error "Not at a dynamic block"))
10551 (let* ((begdel (1+ (match-end 0)))
10552 (name (org-no-properties (match-string 1)))
10553 (params (append (list :name name)
10554 (read (concat "(" (match-string 3) ")")))))
10555 (save-excursion
10556 (beginning-of-line 1)
10558 (setq params (plist-put params :indentation-column (current-column))))
10559 (unless (re-search-forward org-dblock-end-re nil t)
10560 (error "Dynamic block not terminated"))
10561 (setq params
10562 (append params
10563 (list :content (buffer-substring
10564 begdel (match-beginning 0)))))
10565 (delete-region begdel (match-beginning 0))
10566 (goto-char begdel)
10567 (open-line 1)
10568 params))
10570 (defun org-map-dblocks (&optional command)
10571 "Apply COMMAND to all dynamic blocks in the current buffer.
10572 If COMMAND is not given, use `org-update-dblock'."
10573 (let ((cmd (or command 'org-update-dblock)))
10574 (save-excursion
10575 (goto-char (point-min))
10576 (while (re-search-forward org-dblock-start-re nil t)
10577 (goto-char (match-beginning 0))
10578 (save-excursion
10579 (condition-case nil
10580 (funcall cmd)
10581 (error (message "Error during update of dynamic block"))))
10582 (unless (re-search-forward org-dblock-end-re nil t)
10583 (error "Dynamic block not terminated"))))))
10585 (defun org-dblock-update (&optional arg)
10586 "User command for updating dynamic blocks.
10587 Update the dynamic block at point. With prefix ARG, update all dynamic
10588 blocks in the buffer."
10589 (interactive "P")
10590 (if arg
10591 (org-update-all-dblocks)
10592 (or (looking-at org-dblock-start-re)
10593 (org-beginning-of-dblock))
10594 (org-update-dblock)))
10596 (defun org-update-dblock ()
10597 "Update the dynamic block at point.
10598 This means to empty the block, parse for parameters and then call
10599 the correct writing function."
10600 (interactive)
10601 (save-window-excursion
10602 (let* ((pos (point))
10603 (line (org-current-line))
10604 (params (org-prepare-dblock))
10605 (name (plist-get params :name))
10606 (indent (plist-get params :indentation-column))
10607 (cmd (intern (concat "org-dblock-write:" name))))
10608 (message "Updating dynamic block `%s' at line %d..." name line)
10609 (funcall cmd params)
10610 (message "Updating dynamic block `%s' at line %d...done" name line)
10611 (goto-char pos)
10612 (when (and indent (> indent 0))
10613 (setq indent (make-string indent ?\ ))
10614 (save-excursion
10615 (org-beginning-of-dblock)
10616 (forward-line 1)
10617 (while (not (looking-at org-dblock-end-re))
10618 (insert indent)
10619 (beginning-of-line 2))
10620 (when (looking-at org-dblock-end-re)
10622 (replace-match ""))
10623 (insert indent)))))))
10625 (defun org-beginning-of-dblock ()
10626 "Find the beginning of the dynamic block at point.
10627 Error if there is no such block at point."
10628 (let ((pos (point))
10629 beg)
10630 (end-of-line 1)
10631 (if (and (re-search-backward org-dblock-start-re nil t)
10632 (setq beg (match-beginning 0))
10633 (re-search-forward org-dblock-end-re nil t)
10634 (> (match-end 0) pos))
10635 (goto-char beg)
10636 (goto-char pos)
10637 (error "Not in a dynamic block"))))
10639 (defun org-update-all-dblocks ()
10640 "Update all dynamic blocks in the buffer.
10641 This function can be used in a hook."
10642 (interactive)
10643 (when (org-mode-p)
10644 (org-map-dblocks 'org-update-dblock)))
10647 ;;;; Completion
10649 (defconst org-additional-option-like-keywords
10650 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10651 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10652 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10653 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10654 "BEGIN:" "END:"
10655 "ORGTBL" "TBLFM:" "TBLNAME:"
10656 "BEGIN_EXAMPLE" "END_EXAMPLE"
10657 "BEGIN_QUOTE" "END_QUOTE"
10658 "BEGIN_VERSE" "END_VERSE"
10659 "BEGIN_CENTER" "END_CENTER"
10660 "BEGIN_SRC" "END_SRC"
10661 "BEGIN_RESULT" "END_RESULT"
10662 "SOURCE:" "SRCNAME:" "FUNCTION:"
10663 "RESULTS:"
10664 "HEADER:" "HEADERS:"
10665 "BABEL:"
10666 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10667 "CAPTION:" "LABEL:"
10668 "SETUPFILE:"
10669 "INCLUDE:"
10670 "BIND:"
10671 "MACRO:"))
10673 (defcustom org-structure-template-alist
10674 '(
10687 ("L" "#+latex: "
10691 ("H" "#+html: "
10694 ("A" "#+ascii: ")
10695 ("i" "#+include %file ?"
10697 )
10698 "Structure completion elements.
10699 This is a list of abbreviation keys and values. The value gets inserted
10700 if you type `<' followed by the key and then press the completion key,
10701 usually `M-TAB'. %file will be replaced by a file name after prompting
10702 for the file using completion.
10703 There are two templates for each key, the first uses the original Org syntax,
10704 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10705 the default when the /org-mtags.el/ module has been loaded. See also the
10706 variable `org-mtags-prefer-muse-templates'.
10707 This is an experimental feature, it is undecided if it is going to stay in."
10708 :group 'org-completion
10709 :type '(repeat
10710 (string :tag "Key")
10711 (string :tag "Template")
10712 (string :tag "Muse Template")))
10714 (defun org-try-structure-completion ()
10715 "Try to complete a structure template before point.
10717 expands them."
10718 (let ((l (buffer-substring (point-at-bol) (point)))
10719 a)
10722 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10723 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10724 (match-beginning 1)) a)
10725 t)))
10727 (defun org-complete-expand-structure-template (start cell)
10728 "Expand a structure template."
10729 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10730 (rpl (nth (if musep 2 1) cell))
10731 (ind ""))
10732 (delete-region start (point))
10734 (cond
10735 ((bolp))
10737 (setq ind (buffer-substring (point-at-bol) (point))))
10738 (t (newline))))
10739 (setq start (point))
10740 (if (string-match "%file" rpl)
10741 (setq rpl (replace-match
10742 (concat
10744 (save-match-data
10745 (abbreviate-file-name (read-file-name "Include file: ")))
10747 t t rpl)))
10750 (insert rpl)
10753 ;;;; TODO, DEADLINE, Comments
10755 (defun org-toggle-comment ()
10756 "Change the COMMENT state of an entry."
10757 (interactive)
10758 (save-excursion
10759 (org-back-to-heading)
10760 (let (case-fold-search)
10761 (if (looking-at (concat outline-regexp
10763 (replace-match "" t t nil 1)
10764 (if (looking-at outline-regexp)
10765 (progn
10766 (goto-char (match-end 0))
10767 (insert org-comment-string " ")))))))
10769 (defvar org-last-todo-state-is-todo nil
10770 "This is non-nil when the last TODO state change led to a TODO state.
10771 If the last change removed the TODO tag or switched to DONE, then
10772 this is nil.")
10774 (defvar org-setting-tags nil) ; dynamically skipped
10776 (defvar org-todo-setup-filter-hook nil
10777 "Hook for functions that pre-filter todo specs.
10778 Each function takes a todo spec and returns either nil or the spec
10779 transformed into canonical form." )
10781 (defvar org-todo-get-default-hook nil
10782 "Hook for functions that get a default item for todo.
10783 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10784 nil or a string to be used for the todo mark." )
10786 (defvar org-agenda-headline-snapshot-before-repeat)
10788 (defun org-todo (&optional arg)
10789 "Change the TODO state of an item.
10790 The state of an item is given by a keyword at the start of the heading,
10791 like
10792 *** TODO Write paper
10793 *** DONE Call mom
10795 The different keywords are specified in the variable `org-todo-keywords'.
10797 So for this example: when the item starts with TODO, it is changed to DONE.
10798 When it starts with DONE, the DONE is removed. And when neither TODO nor
10799 DONE are present, add TODO at the beginning of the heading.
10802 state.
10803 With numeric prefix arg, switch to that state.
10805 keywords (nextset).
10808 For calling through lisp, arg is also interpreted in the following way:
10809 'none -> empty state
10811 'done -> switch to DONE
10812 'nextset -> switch to the next set of keywords
10813 'previousset -> switch to the previous set of keywords
10815 really is a member of `org-todo-keywords'."
10816 (interactive "P")
10817 (if (equal arg '(16)) (setq arg 'nextset))
10818 (let ((org-blocker-hook org-blocker-hook)
10819 (case-fold-search nil))
10820 (when (equal arg '(64))
10821 (setq arg nil org-blocker-hook nil))
10822 (when (and org-blocker-hook
10823 (or org-inhibit-blocking
10824 (org-entry-get nil "NOBLOCKING")))
10825 (setq org-blocker-hook nil))
10826 (save-excursion
10827 (catch 'exit
10828 (org-back-to-heading t)
10829 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10831 (looking-at " *"))
10832 (let* ((match-data (match-data))
10833 (startpos (point-at-bol))
10834 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10835 (org-log-done org-log-done)
10836 (org-log-repeat org-log-repeat)
10837 (org-todo-log-states org-todo-log-states)
10838 (this (match-string 1))
10839 (hl-pos (match-beginning 0))
10840 (head (org-get-todo-sequence-head this))
10841 (ass (assoc head org-todo-kwd-alist))
10842 (interpret (nth 1 ass))
10843 (done-word (nth 3 ass))
10844 (final-done-word (nth 4 ass))
10845 (last-state (or this ""))
10846 (completion-ignore-case t)
10847 (member (member this org-todo-keywords-1))
10848 (tail (cdr member))
10849 (state (cond
10850 ((and org-todo-key-trigger
10851 (or (and (equal arg '(4))
10852 (eq org-use-fast-todo-selection 'prefix))
10853 (and (not arg) org-use-fast-todo-selection
10854 (not (eq org-use-fast-todo-selection
10855 'prefix)))))
10856 ;; Use fast selection
10857 (org-fast-todo-selection))
10858 ((and (equal arg '(4))
10859 (or (not org-use-fast-todo-selection)
10860 (not org-todo-key-trigger)))
10861 ;; Read a state with completion
10862 (org-icompleting-read
10863 "State: " (mapcar (lambda(x) (list x))
10864 org-todo-keywords-1)
10865 nil t))
10866 ((eq arg 'right)
10867 (if this
10868 (if tail (car tail) nil)
10869 (car org-todo-keywords-1)))
10870 ((eq arg 'left)
10871 (if (equal member org-todo-keywords-1)
10872 nil
10873 (if this
10874 (nth (- (length org-todo-keywords-1)
10875 (length tail) 2)
10876 org-todo-keywords-1)
10877 (org-last org-todo-keywords-1))))
10878 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10879 (setq arg nil))) ; hack to fall back to cycling
10880 (arg
10881 ;; user or caller requests a specific state
10882 (cond
10883 ((equal arg "") nil)
10884 ((eq arg 'none) nil)
10885 ((eq arg 'done) (or done-word (car org-done-keywords)))
10886 ((eq arg 'nextset)
10887 (or (car (cdr (member head org-todo-heads)))
10888 (car org-todo-heads)))
10889 ((eq arg 'previousset)
10890 (let ((org-todo-heads (reverse org-todo-heads)))
10891 (or (car (cdr (member head org-todo-heads)))
10892 (car org-todo-heads))))
10893 ((car (member arg org-todo-keywords-1)))
10894 ((stringp arg)
10895 (error "State `%s' not valid in this file" arg))
10896 ((nth (1- (prefix-numeric-value arg))
10897 org-todo-keywords-1))))
10898 ((null member) (or head (car org-todo-keywords-1)))
10899 ((equal this final-done-word) nil) ;; -> make empty
10900 ((null tail) nil) ;; -> first entry
10901 ((memq interpret '(type priority))
10902 (if (eq this-command last-command)
10903 (car tail)
10904 (if (> (length tail) 0)
10905 (or done-word (car org-done-keywords))
10906 nil)))
10907 (t
10908 (car tail))))
10909 (state (or
10910 (run-hook-with-args-until-success
10911 'org-todo-get-default-hook state last-state)
10912 state))
10913 (next (if state (concat " " state " ") " "))
10914 (change-plist (list :type 'todo-state-change :from this :to state
10915 :position startpos))
10916 dolog now-done-p)
10917 (when org-blocker-hook
10918 (setq org-last-todo-state-is-todo
10919 (not (member this org-done-keywords)))
10920 (unless (save-excursion
10921 (save-match-data
10922 (run-hook-with-args-until-failure
10923 'org-blocker-hook change-plist)))
10924 (if (interactive-p)
10925 (error "TODO state change from %s to %s blocked" this state)
10926 ;; fail silently
10927 (message "TODO state change from %s to %s blocked" this state)
10928 (throw 'exit nil))))
10929 (store-match-data match-data)
10930 (replace-match next t t)
10931 (unless (pos-visible-in-window-p hl-pos)
10932 (message "TODO state changed to %s" (org-trim next)))
10933 (unless head
10934 (setq head (org-get-todo-sequence-head state)
10935 ass (assoc head org-todo-kwd-alist)
10936 interpret (nth 1 ass)
10937 done-word (nth 3 ass)
10938 final-done-word (nth 4 ass)))
10939 (when (memq arg '(nextset previousset))
10940 (message "Keyword-Set %d/%d: %s"
10941 (- (length org-todo-sets) -1
10942 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10943 (length org-todo-sets)
10944 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10945 (setq org-last-todo-state-is-todo
10946 (not (member state org-done-keywords)))
10947 (setq now-done-p (and (member state org-done-keywords)
10948 (not (member this org-done-keywords))))
10949 (and logging (org-local-logging logging))
10950 (when (and (or org-todo-log-states org-log-done)
10951 (not (eq org-inhibit-logging t))
10952 (not (memq arg '(nextset previousset))))
10953 ;; we need to look at recording a time and note
10954 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10955 (nth 2 (assoc this org-todo-log-states))))
10956 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10957 (setq dolog 'time))
10958 (when (and state
10959 (member state org-not-done-keywords)
10960 (not (member this org-not-done-keywords)))
10961 ;; This is now a todo state and was not one before
10962 ;; If there was a CLOSED time stamp, get rid of it.
10963 (org-add-planning-info nil nil 'closed))
10964 (when (and now-done-p org-log-done)
10965 ;; It is now done, and it was not done before
10966 (org-add-planning-info 'closed (org-current-time))
10967 (if (and (not dolog) (eq 'note org-log-done))
10968 (org-add-log-setup 'done state this 'findpos 'note)))
10969 (when (and state dolog)
10970 ;; This is a non-nil state, and we need to log it
10971 (org-add-log-setup 'state state this 'findpos dolog)))
10972 ;; Fixup tag positioning
10973 (org-todo-trigger-tag-changes state)
10974 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10975 (when org-provide-todo-statistics
10976 (org-update-parent-todo-statistics))
10977 (run-hooks 'org-after-todo-state-change-hook)
10978 (if (and arg (not (member state org-done-keywords)))
10979 (setq head (org-get-todo-sequence-head state)))
10980 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10981 ;; Do we need to trigger a repeat?
10982 (when now-done-p
10983 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10984 ;; This is for the agenda, take a snapshot of the headline.
10985 (save-match-data
10986 (setq org-agenda-headline-snapshot-before-repeat
10987 (org-get-heading))))
10988 (org-auto-repeat-maybe state))
10989 ;; Fixup cursor location if close to the keyword
10990 (if (and (outline-on-heading-p)
10991 (not (bolp))
10992 (save-excursion (beginning-of-line 1)
10993 (looking-at org-todo-line-regexp))
10994 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10995 (progn
10996 (goto-char (or (match-end 2) (match-end 1)))
10997 (and (looking-at " ") (just-one-space))))
10998 (when org-trigger-hook
10999 (save-excursion
11000 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11002 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11003 "Block turning an entry into a TODO, using the hierarchy.
11004 This checks whether the current task should be blocked from state
11005 changes. Such blocking occurs when:
11007 1. The task has children which are not all in a completed state.
11009 2. A task has a parent with the property :ORDERED:, and there
11010 are siblings prior to the current task with incomplete
11011 status.
11013 3. The parent of the task is blocked because it has siblings that should
11014 be done first, or is child of a block grandparent TODO entry."
11016 (if (not org-enforce-todo-dependencies)
11017 t ; if locally turned off don't block
11018 (catch 'dont-block
11019 ;; If this is not a todo state change, or if this entry is already DONE,
11020 ;; do not block
11021 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11022 (member (plist-get change-plist :from)
11023 (cons 'done org-done-keywords))
11024 (member (plist-get change-plist :to)
11025 (cons 'todo org-not-done-keywords))
11026 (not (plist-get change-plist :to)))
11027 (throw 'dont-block t))
11028 ;; If this task has children, and any are undone, it's blocked
11029 (save-excursion
11030 (org-back-to-heading t)
11031 (let ((this-level (funcall outline-level)))
11032 (outline-next-heading)
11033 (let ((child-level (funcall outline-level)))
11034 (while (and (not (eobp))
11035 (> child-level this-level))
11036 ;; this todo has children, check whether they are all
11037 ;; completed
11038 (if (and (not (org-entry-is-done-p))
11039 (org-entry-is-todo-p))
11040 (throw 'dont-block nil))
11041 (outline-next-heading)
11042 (setq child-level (funcall outline-level))))))
11043 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11044 ;; any previous siblings are undone, it's blocked
11045 (save-excursion
11046 (org-back-to-heading t)
11047 (let* ((pos (point))
11048 (parent-pos (and (org-up-heading-safe) (point))))
11049 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11050 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11051 (forward-line 1)
11052 (re-search-forward org-not-done-heading-regexp pos t))
11053 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11054 ;; Search further up the hierarchy, to see if an anchestor is blocked
11055 (while t
11056 (goto-char parent-pos)
11057 (if (not (looking-at org-not-done-heading-regexp))
11058 (throw 'dont-block t)) ; do not block, parent is not a TODO
11059 (setq pos (point))
11060 (setq parent-pos (and (org-up-heading-safe) (point)))
11061 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11062 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11063 (forward-line 1)
11064 (re-search-forward org-not-done-heading-regexp pos t))
11065 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11067 (defcustom org-track-ordered-property-with-tag nil
11068 "Should the ORDERED property also be shown as a tag?
11069 The ORDERED property decides if an entry should require subtasks to be
11070 completed in sequence. Since a property is not very visible, setting
11071 this option means that toggling the ORDERED property with the command
11072 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11073 not relevant for the behavior, but it makes things more visible.
11075 Note that toggling the tag with tags commands will not change the property
11076 and therefore not influence behavior!
11078 This can be t, meaning the tag ORDERED should be used, It can also be a
11079 string to select a different tag for this task."
11080 :group 'org-todo
11081 :type '(choice
11082 (const :tag "No tracking" nil)
11083 (const :tag "Track with ORDERED tag" t)
11084 (string :tag "Use other tag")))
11086 (defun org-toggle-ordered-property ()
11087 "Toggle the ORDERED property of the current entry.
11088 For better visibility, you can track the value of this property with a tag.
11089 See variable `org-track-ordered-property-with-tag'."
11090 (interactive)
11091 (let* ((t1 org-track-ordered-property-with-tag)
11092 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11093 (save-excursion
11094 (org-back-to-heading)
11095 (if (org-entry-get nil "ORDERED")
11096 (progn
11097 (org-delete-property "ORDERED")
11098 (and tag (org-toggle-tag tag 'off))
11099 (message "Subtasks can be completed in arbitrary order"))
11100 (org-entry-put nil "ORDERED" "t")
11101 (and tag (org-toggle-tag tag 'on))
11102 (message "Subtasks must be completed in sequence")))))
11104 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11105 (defun org-block-todo-from-checkboxes (change-plist)
11106 "Block turning an entry into a TODO, using checkboxes.
11107 This checks whether the current task should be blocked from state
11108 changes because there are unchecked boxes in this entry."
11109 (if (not org-enforce-todo-checkbox-dependencies)
11110 t ; if locally turned off don't block
11111 (catch 'dont-block
11112 ;; If this is not a todo state change, or if this entry is already DONE,
11113 ;; do not block
11114 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11115 (member (plist-get change-plist :from)
11116 (cons 'done org-done-keywords))
11117 (member (plist-get change-plist :to)
11118 (cons 'todo org-not-done-keywords))
11119 (not (plist-get change-plist :to)))
11120 (throw 'dont-block t))
11121 ;; If this task has checkboxes that are not checked, it's blocked
11122 (save-excursion
11123 (org-back-to-heading t)
11124 (let ((beg (point)) end)
11125 (outline-next-heading)
11126 (setq end (point))
11127 (goto-char beg)
11129 end t)
11130 (progn
11131 (if (boundp 'org-blocked-by-checkboxes)
11132 (setq org-blocked-by-checkboxes t))
11133 (throw 'dont-block nil)))))
11134 t))) ; do not block
11136 (defun org-entry-blocked-p ()
11137 "Is the current entry blocked?"
11138 (if (org-entry-get nil "NOBLOCKING")
11139 nil ;; Never block this entry
11140 (not
11141 (run-hook-with-args-until-failure
11142 'org-blocker-hook
11143 (list :type 'todo-state-change
11144 :position (point)
11145 :from 'todo
11146 :to 'done)))))
11148 (defun org-update-statistics-cookies (all)
11149 "Update the statistics cookie, either from TODO or from checkboxes.
11150 This should be called with the cursor in a line with a statistics cookie."
11151 (interactive "P")
11152 (if all
11153 (progn
11154 (org-update-checkbox-count 'all)
11155 (org-map-entries 'org-update-parent-todo-statistics))
11156 (if (not (org-on-heading-p))
11157 (org-update-checkbox-count)
11158 (let ((pos (move-marker (make-marker) (point)))
11159 end l1 l2)
11160 (ignore-errors (org-back-to-heading t))
11161 (if (not (org-on-heading-p))
11162 (org-update-checkbox-count)
11163 (setq l1 (org-outline-level))
11164 (setq end (save-excursion
11165 (outline-next-heading)
11166 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11167 (point)))
11168 (if (and (save-excursion
11169 (re-search-forward
11171 (not (save-excursion (re-search-forward
11173 (org-update-checkbox-count)
11174 (if (and l2 (> l2 l1))
11175 (progn
11176 (goto-char end)
11177 (org-update-parent-todo-statistics))
11178 (goto-char pos)
11179 (beginning-of-line 1)
11180 (while (re-search-forward
11182 (point-at-eol) t)
11183 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11184 (goto-char pos)
11185 (move-marker pos nil)))))
11187 (defvar org-entry-property-inherited-from) ;; defined below
11188 (defun org-update-parent-todo-statistics ()
11189 "Update any statistics cookie in the parent of the current headline.
11190 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11191 the entire subtree and this will travel up the hierarchy and update
11192 statistics everywhere."
11193 (interactive)
11194 (let* ((lim 0) prop
11195 (recursive (or (not org-hierarchical-todo-statistics)
11196 (string-match
11198 (or (setq prop (org-entry-get
11199 nil "COOKIE_DATA" 'inherit)) ""))))
11200 (lim (or (and prop (marker-position
11201 org-entry-property-inherited-from))
11202 lim))
11203 (first t)
11205 level ltoggle l1 new ndel
11206 (cnt-all 0) (cnt-done 0) is-percent kwd
11207 checkbox-beg ov ovs ove cookie-present)
11208 (catch 'exit
11209 (save-excursion
11210 (beginning-of-line 1)
11211 (if (org-at-heading-p)
11212 (setq ltoggle (funcall outline-level))
11213 (error "This should not happen"))
11214 (while (and (setq level (org-up-heading-safe))
11215 (or recursive first)
11216 (>= (point) lim))
11217 (setq first nil cookie-present nil)
11218 (unless (and level
11219 (not (string-match
11221 (downcase
11222 (or (org-entry-get
11223 nil "COOKIE_DATA")
11224 "")))))
11225 (throw 'exit nil))
11226 (while (re-search-forward box-re (point-at-eol) t)
11227 (setq cnt-all 0 cnt-done 0 cookie-present t)
11228 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11229 (save-match-data
11230 (unless (outline-next-heading) (throw 'exit nil))
11231 (while (and (looking-at org-complex-heading-regexp)
11232 (> (setq l1 (length (match-string 1))) level))
11233 (setq kwd (and (or recursive (= l1 ltoggle))
11234 (match-string 2)))
11235 (if (or (eq org-provide-todo-statistics 'all-headlines)
11236 (and (listp org-provide-todo-statistics)
11237 (or (member kwd org-provide-todo-statistics)
11238 (member kwd org-done-keywords))))
11239 (setq cnt-all (1+ cnt-all))
11240 (if (eq org-provide-todo-statistics t)
11241 (and kwd (setq cnt-all (1+ cnt-all)))))
11242 (and (member kwd org-done-keywords)
11243 (setq cnt-done (1+ cnt-done)))
11244 (outline-next-heading)))
11245 (setq new
11246 (if is-percent
11247 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11248 (format "[%d/%d]" cnt-done cnt-all))
11249 ndel (- (match-end 0) checkbox-beg))
11250 ;; handle overlays when updating cookie from column view
11251 (when (setq ov (car (overlays-at checkbox-beg)))
11252 (setq ovs (overlay-start ov) ove (overlay-end ov))
11253 (delete-overlay ov))
11254 (goto-char checkbox-beg)
11255 (insert new)
11256 (delete-region (point) (+ (point) ndel))
11257 (when ov (move-overlay ov ovs ove)))
11258 (when cookie-present
11259 (run-hook-with-args 'org-after-todo-statistics-hook
11260 cnt-done (- cnt-all cnt-done))))))
11261 (run-hooks 'org-todo-statistics-hook)))
11263 (defvar org-after-todo-statistics-hook nil
11264 "Hook that is called after a TODO statistics cookie has been updated.
11265 Each function is called with two arguments: the number of not-done entries
11266 and the number of done entries.
11268 For example, the following function, when added to this hook, will switch
11269 an entry to DONE when all children are done, and back to TODO when new
11270 entries are set to a TODO status. Note that this hook is only called
11271 when there is a statistics cookie in the headline!
11273 (defun org-summary-todo (n-done n-not-done)
11275 (let (org-log-done org-log-states) ; turn off logging
11277 ")
11279 (defvar org-todo-statistics-hook nil
11280 "Hook that is run whenever Org thinks TODO statistics should be updated.
11281 This hook runs even if there is no statistics cookie present, in which case
11282 `org-after-todo-statistics-hook' would not run.")
11284 (defun org-todo-trigger-tag-changes (state)
11285 "Apply the changes defined in `org-todo-state-tags-triggers'."
11286 (let ((l org-todo-state-tags-triggers)
11287 changes)
11288 (when (or (not state) (equal state ""))
11289 (setq changes (append changes (cdr (assoc "" l)))))
11290 (when (and (stringp state) (> (length state) 0))
11291 (setq changes (append changes (cdr (assoc state l)))))
11292 (when (member state org-not-done-keywords)
11293 (setq changes (append changes (cdr (assoc 'todo l)))))
11294 (when (member state org-done-keywords)
11295 (setq changes (append changes (cdr (assoc 'done l)))))
11296 (dolist (c changes)
11297 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11299 (defun org-local-logging (value)
11300 "Get logging settings from a property VALUE."
11301 (let* (words w a)
11302 ;; directly set the variables, they are already local.
11303 (setq org-log-done nil
11304 org-log-repeat nil
11305 org-todo-log-states nil)
11306 (setq words (org-split-string value))
11307 (while (setq w (pop words))
11308 (cond
11309 ((setq a (assoc w org-startup-options))
11310 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11311 (set (nth 1 a) (nth 2 a))))
11312 ((setq a (org-extract-log-state-settings w))
11313 (and (member (car a) org-todo-keywords-1)
11314 (push a org-todo-log-states)))))))
11316 (defun org-get-todo-sequence-head (kwd)
11317 "Return the head of the TODO sequence to which KWD belongs.
11318 If KWD is not set, check if there is a text property remembering the
11319 right sequence."
11320 (let (p)
11321 (cond
11322 ((not kwd)
11323 (or (get-text-property (point-at-bol) 'org-todo-head)
11324 (progn
11325 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11326 nil (point-at-eol)))
11327 (get-text-property p 'org-todo-head))))
11328 ((not (member kwd org-todo-keywords-1))
11329 (car org-todo-keywords-1))
11330 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11332 (defun org-fast-todo-selection ()
11333 "Fast TODO keyword selection with single keys.
11334 Returns the new TODO keyword, or nil if no state change should occur."
11335 (let* ((fulltable org-todo-key-alist)
11336 (done-keywords org-done-keywords) ;; needed for the faces.
11337 (maxlen (apply 'max (mapcar
11338 (lambda (x)
11339 (if (stringp (car x)) (string-width (car x)) 0))
11340 fulltable)))
11341 (expert nil)
11342 (fwidth (+ maxlen 3 1 3))
11343 (ncol (/ (- (window-width) 4) fwidth))
11344 tg cnt e c tbl
11345 groups ingroup)
11346 (save-excursion
11347 (save-window-excursion
11348 (if expert
11349 (set-buffer (get-buffer-create " *Org todo*"))
11350 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11351 (erase-buffer)
11352 (org-set-local 'org-done-keywords done-keywords)
11353 (setq tbl fulltable cnt 0)
11354 (while (setq e (pop tbl))
11355 (cond
11356 ((equal e '(:startgroup))
11357 (push '() groups) (setq ingroup t)
11358 (when (not (= cnt 0))
11359 (setq cnt 0)
11361 (insert "{ "))
11362 ((equal e '(:endgroup))
11363 (setq ingroup nil cnt 0)
11365 ((equal e '(:newline))
11366 (when (not (= cnt 0))
11367 (setq cnt 0)
11369 (setq e (car tbl))
11370 (while (equal (car tbl) '(:newline))
11372 (setq tbl (cdr tbl)))))
11373 (t
11374 (setq tg (car e) c (cdr e))
11375 (if ingroup (push tg (car groups)))
11376 (setq tg (org-add-props tg nil 'face
11377 (org-get-todo-face tg)))
11378 (if (and (= cnt 0) (not ingroup)) (insert " "))
11379 (insert "[" c "] " tg (make-string
11380 (- fwidth 4 (length tg)) ?\ ))
11381 (when (= (setq cnt (1+ cnt)) ncol)
11383 (if ingroup (insert " "))
11384 (setq cnt 0)))))
11386 (goto-char (point-min))
11387 (if (not expert) (org-fit-window-to-buffer))
11388 (message "[a-z..]:Set [SPC]:clear")
11389 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11390 (cond
11391 ((or (= c ?\C-g)
11392 (and (= c ?q) (not (rassoc c fulltable))))
11393 (setq quit-flag t))
11394 ((= c ?\ ) nil)
11395 ((setq e (rassoc c fulltable) tg (car e))
11396 tg)
11397 (t (setq quit-flag t)))))))
11399 (defun org-entry-is-todo-p ()
11400 (member (org-get-todo-state) org-not-done-keywords))
11402 (defun org-entry-is-done-p ()
11403 (member (org-get-todo-state) org-done-keywords))
11405 (defun org-get-todo-state ()
11406 (save-excursion
11407 (org-back-to-heading t)
11408 (and (looking-at org-todo-line-regexp)
11409 (match-end 2)
11410 (match-string 2))))
11412 (defun org-at-date-range-p (&optional inactive-ok)
11413 "Is the cursor inside a date range?"
11414 (interactive)
11415 (save-excursion
11416 (catch 'exit
11417 (let ((pos (point)))
11419 (skip-chars-backward "<[")
11420 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11421 (>= (match-end 0) pos)
11422 (throw 'exit t))
11424 (skip-chars-backward "<[")
11425 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11426 (>= (match-end 0) pos)
11427 (throw 'exit t)))
11428 nil)))
11430 (defun org-get-repeat (&optional tagline)
11431 "Check if there is a deadline/schedule with repeater in this entry."
11432 (save-match-data
11433 (save-excursion
11434 (org-back-to-heading t)
11435 (and (re-search-forward (if tagline
11437 org-repeat-re)
11438 (org-entry-end-position) t)
11439 (match-string-no-properties 1)))))
11441 (defvar org-last-changed-timestamp)
11442 (defvar org-last-inserted-timestamp)
11443 (defvar org-log-post-message)
11444 (defvar org-log-note-purpose)
11445 (defvar org-log-note-how)
11446 (defvar org-log-note-extra)
11447 (defun org-auto-repeat-maybe (done-word)
11448 "Check if the current headline contains a repeated deadline/schedule.
11449 If yes, set TODO state back to what it was and change the base date
11450 of repeating deadline/scheduled time stamps to new date.
11451 This function is run automatically after each state change to a DONE state."
11452 ;; last-state is dynamically scoped into this function
11453 (let* ((repeat (org-get-repeat))
11454 (aa (assoc last-state org-todo-kwd-alist))
11455 (interpret (nth 1 aa))
11456 (head (nth 2 aa))
11457 (whata '(("d" . day) ("m" . month) ("y" . year)))
11458 (msg "Entry repeats: ")
11459 (org-log-done nil)
11460 (org-todo-log-states nil)
11461 re type n what ts time to-state)
11462 (when repeat
11463 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11464 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11465 org-todo-repeat-to-state))
11466 (unless (and to-state (member to-state org-todo-keywords-1))
11467 (setq to-state (if (eq interpret 'type) last-state head)))
11468 (org-todo to-state)
11469 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11470 (org-entry-put nil "LAST_REPEAT" (format-time-string
11471 (org-time-stamp-format t t))))
11472 (when org-log-repeat
11473 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11474 (memq 'org-add-log-note post-command-hook))
11475 ;; OK, we are already setup for some record
11476 (if (eq org-log-repeat 'note)
11477 ;; make sure we take a note, not only a time stamp
11478 (setq org-log-note-how 'note))
11479 ;; Set up for taking a record
11480 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11481 last-state
11482 'findpos org-log-repeat)))
11483 (org-back-to-heading t)
11484 (org-add-planning-info nil nil 'closed)
11488 (while (re-search-forward
11489 re (save-excursion (outline-next-heading) (point)) t)
11490 (setq type (if (match-end 1) org-scheduled-string
11491 (if (match-end 3) org-deadline-string "Plain:"))
11492 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11494 (setq n (string-to-number (match-string 2 ts))
11495 what (match-string 3 ts))
11496 (if (equal what "w") (setq n (* n 7) what "d"))
11497 ;; Preparation, see if we need to modify the start date for the change
11498 (when (match-end 1)
11499 (setq time (save-match-data (org-time-string-to-time ts)))
11500 (cond
11501 ((equal (match-string 1 ts) ".")
11502 ;; Shift starting date to today
11503 (org-timestamp-change
11504 (- (time-to-days (current-time)) (time-to-days time))
11505 'day))
11506 ((equal (match-string 1 ts) "+")
11507 (let ((nshiftmax 10) (nshift 0))
11508 (while (or (= nshift 0)
11509 (<= (time-to-days time)
11510 (time-to-days (current-time))))
11511 (when (= (incf nshift) nshiftmax)
11512 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11513 (error "Abort")))
11514 (org-timestamp-change n (cdr (assoc what whata)))
11515 (org-at-timestamp-p t)
11516 (setq ts (match-string 1))
11517 (setq time (save-match-data (org-time-string-to-time ts)))))
11518 (org-timestamp-change (- n) (cdr (assoc what whata)))
11519 ;; rematch, so that we have everything in place for the real shift
11520 (org-at-timestamp-p t)
11521 (setq ts (match-string 1))
11523 (org-timestamp-change n (cdr (assoc what whata)))
11524 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11525 (setq org-log-post-message msg)
11526 (message "%s" msg))))
11528 (defun org-show-todo-tree (arg)
11529 "Make a compact tree which shows all headlines marked with TODO.
11530 The tree will show the lines where the regexp matches, and all higher
11531 headlines above the match.
11533 With a numeric prefix N, construct a sparse tree for the Nth element
11534 of `org-todo-keywords-1'."
11535 (interactive "P")
11536 (let ((case-fold-search nil)
11537 (kwd-re
11538 (cond ((null arg) org-not-done-regexp)
11539 ((equal arg '(4))
11540 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11541 (mapcar 'list org-todo-keywords-1))))
11545 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11546 (regexp-quote (nth (1- (prefix-numeric-value arg))
11547 org-todo-keywords-1)))
11548 (t (error "Invalid prefix argument: %s" arg)))))
11549 (message "%d TODO entries found"
11550 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11552 (defun org-deadline (&optional remove time)
11554 With argument REMOVE, remove any deadline from the item.
11555 When TIME is set, it should be an internal time specification, and the
11556 scheduling will use the corresponding date."
11557 (interactive "P")
11558 (let* ((old-date (org-entry-get nil "DEADLINE"))
11559 (repeater (and old-date
11560 (string-match
11562 old-date)
11563 (match-string 1 old-date))))
11564 (if remove
11565 (progn
11566 (when (and old-date org-log-redeadline)
11567 (org-add-log-setup 'deldeadline nil old-date 'findpos
11568 org-log-redeadline))
11569 (org-remove-timestamp-with-keyword org-deadline-string)
11570 (message "Item no longer has a deadline."))
11571 (org-add-planning-info 'deadline time 'closed)
11572 (when (and old-date org-log-redeadline
11573 (not (equal old-date
11574 (substring org-last-inserted-timestamp 1 -1))))
11575 (org-add-log-setup 'redeadline nil old-date 'findpos
11576 org-log-redeadline))
11577 (when repeater
11578 (save-excursion
11579 (org-back-to-heading t)
11580 (when (re-search-forward (concat org-deadline-string " "
11581 org-last-inserted-timestamp)
11582 (save-excursion
11583 (outline-next-heading) (point)) t)
11584 (goto-char (1- (match-end 0)))
11585 (insert " " repeater)
11586 (setq org-last-inserted-timestamp
11587 (concat (substring org-last-inserted-timestamp 0 -1)
11588 " " repeater
11589 (substring org-last-inserted-timestamp -1))))))
11590 (message "Deadline on %s" org-last-inserted-timestamp))))
11592 (defun org-schedule (&optional remove time)
11593 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11594 With argument REMOVE, remove any scheduling date from the item.
11595 When TIME is set, it should be an internal time specification, and the
11596 scheduling will use the corresponding date."
11597 (interactive "P")
11598 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11599 (repeater (and old-date
11600 (string-match
11602 old-date)
11603 (match-string 1 old-date))))
11604 (if remove
11605 (progn
11606 (when (and old-date org-log-reschedule)
11607 (org-add-log-setup 'delschedule nil old-date 'findpos
11608 org-log-reschedule))
11609 (org-remove-timestamp-with-keyword org-scheduled-string)
11610 (message "Item is no longer scheduled."))
11611 (org-add-planning-info 'scheduled time 'closed)
11612 (when (and old-date org-log-reschedule
11613 (not (equal old-date
11614 (substring org-last-inserted-timestamp 1 -1))))
11615 (org-add-log-setup 'reschedule nil old-date 'findpos
11616 org-log-reschedule))
11617 (when repeater
11618 (save-excursion
11619 (org-back-to-heading t)
11620 (when (re-search-forward (concat org-scheduled-string " "
11621 org-last-inserted-timestamp)
11622 (save-excursion
11623 (outline-next-heading) (point)) t)
11624 (goto-char (1- (match-end 0)))
11625 (insert " " repeater)
11626 (setq org-last-inserted-timestamp
11627 (concat (substring org-last-inserted-timestamp 0 -1)
11628 " " repeater
11629 (substring org-last-inserted-timestamp -1))))))
11630 (message "Scheduled to %s" org-last-inserted-timestamp))))
11632 (defun org-get-scheduled-time (pom &optional inherit)
11633 "Get the scheduled time as a time tuple, of a format suitable
11634 for calling org-schedule with, or if there is no scheduling,
11635 returns nil."
11636 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11637 (when time
11638 (apply 'encode-time (org-parse-time-string time)))))
11640 (defun org-get-deadline-time (pom &optional inherit)
11641 "Get the deadline as a time tuple, of a format suitable for
11642 calling org-deadline with, or if there is no scheduling, returns
11643 nil."
11644 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11645 (when time
11646 (apply 'encode-time (org-parse-time-string time)))))
11648 (defun org-remove-timestamp-with-keyword (keyword)
11649 "Remove all time stamps with KEYWORD in the current entry."
11651 beg)
11652 (save-excursion
11653 (org-back-to-heading t)
11654 (setq beg (point))
11655 (outline-next-heading)
11656 (while (re-search-backward re beg t)
11657 (replace-match "")
11659 (equal (char-before) ?\ ))
11660 (backward-delete-char 1)
11662 (point-at-bol) (point-at-eol)))
11663 (delete-region (point-at-bol)
11664 (min (point-max) (1+ (point-at-eol))))))))))
11666 (defun org-add-planning-info (what &optional time &rest remove)
11667 "Insert new timestamp with keyword in the line directly after the headline.
11668 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11669 If non is given, the user is prompted for a date.
11670 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11671 be removed."
11672 (interactive)
11673 (let (org-time-was-given org-end-time-was-given ts
11674 end default-time default-input)
11676 (catch 'exit
11677 (when (and (not time) (memq what '(scheduled deadline)))
11678 ;; Try to get a default date/time from existing timestamp
11679 (save-excursion
11680 (org-back-to-heading t)
11681 (setq end (save-excursion (outline-next-heading) (point)))
11682 (when (re-search-forward (if (eq what 'scheduled)
11683 org-scheduled-time-regexp
11684 org-deadline-time-regexp)
11685 end t)
11686 (setq ts (match-string 1)
11687 default-time
11688 (apply 'encode-time (org-parse-time-string ts))
11689 default-input (and ts (org-get-compact-tod ts))))))
11690 (when what
11691 ;; If necessary, get the time from the user
11692 (setq time (or time (org-read-date nil 'to-time nil nil
11693 default-time default-input))))
11695 (when (and org-insert-labeled-timestamps-at-point
11696 (member what '(scheduled deadline)))
11697 (insert
11698 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11699 (org-insert-time-stamp time org-time-was-given
11700 nil nil nil (list org-end-time-was-given))
11701 (setq what nil))
11702 (save-excursion
11703 (save-restriction
11704 (let (col list elt ts buffer-invisibility-spec)
11705 (org-back-to-heading t)
11707 (goto-char (match-end 1))
11708 (setq col (current-column))
11709 (goto-char (match-end 0))
11711 (when (and (not what)
11712 (not (looking-at
11714 org-keyword-time-not-clock-regexp))))
11715 ;; Nothing to add, nothing to remove...... :-)
11716 (throw 'exit nil))
11717 (if (and (not (looking-at outline-regexp))
11720 (not (equal (match-string 1) org-clock-string)))
11721 (narrow-to-region (match-beginning 0) (match-end 0))
11723 (backward-char 1)
11724 (narrow-to-region (point) (point))
11725 (and org-adapt-indentation (org-indent-to-column col)))
11726 ;; Check if we have to remove something.
11727 (setq list (cons what remove))
11728 (while list
11729 (setq elt (pop list))
11730 (goto-char (point-min))
11731 (when (or (and (eq elt 'scheduled)
11732 (re-search-forward org-scheduled-time-regexp nil t))
11733 (and (eq elt 'deadline)
11734 (re-search-forward org-deadline-time-regexp nil t))
11735 (and (eq elt 'closed)
11736 (re-search-forward org-closed-time-regexp nil t)))
11737 (replace-match "")
11738 (if (looking-at "--+<[^>]+>") (replace-match ""))
11739 (skip-chars-backward " ")
11740 (if (looking-at " +") (replace-match ""))))
11741 (goto-char (point-max))
11742 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11743 (when what
11744 (insert
11745 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11746 (cond ((eq what 'scheduled) org-scheduled-string)
11747 ((eq what 'deadline) org-deadline-string)
11748 ((eq what 'closed) org-closed-string))
11749 " ")
11750 (setq ts (org-insert-time-stamp
11751 time
11752 (or org-time-was-given
11753 (and (eq what 'closed) org-log-done-with-time))
11754 (eq what 'closed)
11755 nil nil (list org-end-time-was-given)))
11756 (end-of-line 1))
11757 (goto-char (point-min))
11758 (widen)
11761 (delete-region (1- (point)) (point-at-eol)))
11762 ts))))))
11764 (defvar org-log-note-marker (make-marker))
11765 (defvar org-log-note-purpose nil)
11766 (defvar org-log-note-state nil)
11767 (defvar org-log-note-previous-state nil)
11768 (defvar org-log-note-how nil)
11769 (defvar org-log-note-extra nil)
11770 (defvar org-log-note-window-configuration nil)
11771 (defvar org-log-note-return-to (make-marker))
11772 (defvar org-log-post-message nil
11773 "Message to be displayed after a log note has been stored.
11774 The auto-repeater uses this.")
11776 (defun org-add-note ()
11777 "Add a note to the current entry.
11778 This is done in the same way as adding a state change note."
11779 (interactive)
11780 (org-add-log-setup 'note nil nil 'findpos nil))
11782 (defvar org-property-end-re)
11783 (defun org-add-log-setup (&optional purpose state prev-state
11784 findpos how extra)
11785 "Set up the post command hook to take a note.
11786 If this is about to TODO state change, the new state is expected in STATE.
11787 When FINDPOS is non-nil, find the correct position for the note in
11788 the current entry. If not, assume that it can be inserted at point.
11789 HOW is an indicator what kind of note should be created.
11790 EXTRA is additional text that will be inserted into the notes buffer."
11791 (let* ((org-log-into-drawer (org-log-into-drawer))
11792 (drawer (cond ((stringp org-log-into-drawer)
11793 org-log-into-drawer)
11794 (org-log-into-drawer "LOGBOOK")
11795 (t nil))))
11796 (save-restriction
11797 (save-excursion
11798 (when findpos
11799 (org-back-to-heading t)
11800 (narrow-to-region (point) (save-excursion
11801 (outline-next-heading) (point)))
11805 (goto-char (match-end 0))
11806 (cond
11807 (drawer
11809 nil t)
11810 (progn
11811 (goto-char (match-end 0))
11812 (or org-log-states-order-reversed
11813 (and (re-search-forward org-property-end-re nil t)
11814 (goto-char (1- (match-beginning 0))))))
11816 (beginning-of-line 0)
11817 (org-indent-line-function)
11818 (beginning-of-line 2)
11819 (org-indent-line-function)
11820 (end-of-line 0)))
11821 ((and org-log-state-notes-insert-after-drawers
11822 (save-excursion
11823 (forward-line) (looking-at org-drawer-regexp)))
11824 (forward-line)
11825 (while (looking-at org-drawer-regexp)
11826 (goto-char (match-end 0))
11827 (re-search-forward org-property-end-re (point-max) t)
11828 (forward-line))
11829 (forward-line -1)))
11830 (unless org-log-states-order-reversed
11832 (org-skip-over-state-notes)
11834 (move-marker org-log-note-marker (point))
11835 (setq org-log-note-purpose purpose
11836 org-log-note-state state
11837 org-log-note-previous-state prev-state
11838 org-log-note-how how
11839 org-log-note-extra extra)
11840 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11842 (defun org-skip-over-state-notes ()
11843 "Skip past the list of State notes in an entry."
11845 (when (ignore-errors (goto-char (org-in-item-p)))
11846 (let* ((struct (org-list-struct))
11847 (prevs (org-list-prevs-alist struct)))
11849 (goto-char (or (org-list-get-next-item (point) struct prevs)
11850 (org-list-get-item-end (point) struct)))))))
11852 (defun org-add-log-note (&optional purpose)
11853 "Pop up a window for taking a note, and add this note later at point."
11854 (remove-hook 'post-command-hook 'org-add-log-note)
11855 (setq org-log-note-window-configuration (current-window-configuration))
11856 (delete-other-windows)
11857 (move-marker org-log-note-return-to (point))
11858 (switch-to-buffer (marker-buffer org-log-note-marker))
11859 (goto-char org-log-note-marker)
11860 (org-switch-to-buffer-other-window "*Org Note*")
11861 (erase-buffer)
11862 (if (memq org-log-note-how '(time state))
11863 (let (current-prefix-arg) (org-store-log-note))
11864 (let ((org-inhibit-startup t)) (org-mode))
11865 (insert (format "# Insert note for %s.
11867 (cond
11868 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11869 ((eq org-log-note-purpose 'done) "closed todo item")
11870 ((eq org-log-note-purpose 'state)
11872 (or org-log-note-previous-state "")
11873 (or org-log-note-state "")))
11874 ((eq org-log-note-purpose 'reschedule)
11875 "rescheduling")
11876 ((eq org-log-note-purpose 'delschedule)
11877 "no longer scheduled")
11878 ((eq org-log-note-purpose 'redeadline)
11879 "changing deadline")
11880 ((eq org-log-note-purpose 'deldeadline)
11881 "removing deadline")
11882 ((eq org-log-note-purpose 'refile)
11883 "refiling")
11884 ((eq org-log-note-purpose 'note)
11885 "this entry")
11886 (t (error "This should not happen")))))
11887 (if org-log-note-extra (insert org-log-note-extra))
11888 (org-set-local 'org-finish-function 'org-store-log-note)))
11890 (defvar org-note-abort nil) ; dynamically scoped
11891 (defun org-store-log-note ()
11892 "Finish taking a log note, and insert it to where it belongs."
11893 (let ((txt (buffer-string))
11894 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11895 lines ind bul)
11896 (kill-buffer (current-buffer))
11898 (setq txt (replace-match "" t t txt)))
11900 (setq txt (replace-match "" t t txt)))
11903 (setq note
11904 (org-replace-escapes
11905 note
11906 (list (cons "%u" (user-login-name))
11907 (cons "%U" user-full-name)
11908 (cons "%t" (format-time-string
11909 (org-time-stamp-format 'long 'inactive)
11910 (current-time)))
11911 (cons "%T" (format-time-string
11912 (org-time-stamp-format 'long nil)
11913 (current-time)))
11914 (cons "%s" (if org-log-note-state
11916 ""))
11917 (cons "%S" (if org-log-note-previous-state
11921 (push note lines))
11922 (when (or current-prefix-arg org-note-abort)
11923 (when org-log-into-drawer
11924 (org-remove-empty-drawer-at
11925 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11926 org-log-note-marker))
11927 (setq lines nil))
11928 (when lines
11929 (with-current-buffer (marker-buffer org-log-note-marker)
11930 (save-excursion
11931 (goto-char org-log-note-marker)
11932 (move-marker org-log-note-marker nil)
11933 (end-of-line 1)
11935 (setq ind (save-excursion
11936 (if (ignore-errors (goto-char (org-in-item-p)))
11937 (let ((struct (org-list-struct)))
11938 (org-list-get-ind
11939 (org-list-get-top-point struct) struct))
11941 (cond
11942 ((and (org-at-heading-p)
11943 org-adapt-indentation)
11944 (1+ (org-current-level)))
11945 ((org-at-heading-p) 0)
11946 (t (org-get-indentation))))))
11947 (setq bul (org-list-bullet-string "-"))
11948 (org-indent-line-to ind)
11949 (insert bul (pop lines))
11950 (let ((ind-body (+ (length bul) ind)))
11951 (while lines
11953 (org-indent-line-to ind-body)
11954 (insert (pop lines))))
11955 (message "Note stored")
11956 (org-back-to-heading t)
11957 (org-cycle-hide-drawers 'children)))))
11958 (set-window-configuration org-log-note-window-configuration)
11959 (with-current-buffer (marker-buffer org-log-note-return-to)
11960 (goto-char org-log-note-return-to))
11961 (move-marker org-log-note-return-to nil)
11962 (and org-log-post-message (message "%s" org-log-post-message)))
11964 (defun org-remove-empty-drawer-at (drawer pos)
11965 "Remove an empty drawer DRAWER at position POS.
11966 POS may also be a marker."
11967 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11968 (save-excursion
11969 (save-restriction
11970 (widen)
11971 (goto-char pos)
11972 (if (org-in-regexp
11974 (replace-match ""))))))
11976 (defun org-sparse-tree (&optional arg)
11977 "Create a sparse tree, prompt for the details.
11978 This command can create sparse trees. You first need to select the type
11979 of match used to create the tree:
11981 t Show all TODO entries.
11982 T Show entries with a specific TODO keyword.
11983 m Show entries selected by a tags/property match.
11984 p Enter a property name and its value (both with completion on existing
11985 names/values) and show entries with that property.
11986 r Show entries matching a regular expression (`/' can be used as well)
11987 d Show deadlines due within `org-deadline-warning-days'.
11988 b Show deadlines and scheduled items before a date.
11989 a Show deadlines and scheduled items after a date."
11990 (interactive "P")
11991 (let (ans kwd value)
11992 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11993 (setq ans (read-char-exclusive))
11994 (cond
11995 ((equal ans ?d)
11996 (call-interactively 'org-check-deadlines))
11997 ((equal ans ?b)
11998 (call-interactively 'org-check-before-date))
11999 ((equal ans ?a)
12000 (call-interactively 'org-check-after-date))
12001 ((equal ans ?t)
12002 (org-show-todo-tree nil))
12003 ((equal ans ?T)
12004 (org-show-todo-tree '(4)))
12005 ((member ans '(?T ?m))
12006 (call-interactively 'org-match-sparse-tree))
12007 ((member ans '(?p ?P))
12008 (setq kwd (org-icompleting-read "Property: "
12009 (mapcar 'list (org-buffer-property-keys))))
12010 (setq value (org-icompleting-read "Value: "
12011 (mapcar 'list (org-property-values kwd))))
12014 (org-match-sparse-tree arg (concat kwd "=" value)))
12015 ((member ans '(?r ?R ?/))
12016 (call-interactively 'org-occur))
12019 (defvar org-occur-highlights nil
12020 "List of overlays used for occur matches.")
12021 (make-variable-buffer-local 'org-occur-highlights)
12022 (defvar org-occur-parameters nil
12023 "Parameters of the active org-occur calls.
12024 This is a list, each call to org-occur pushes as cons cell,
12025 containing the regular expression and the callback, onto the list.
12026 The list can contain several entries if `org-occur' has been called
12027 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12028 will only contain one set of parameters. When the highlights are
12029 removed (for example with `C-c C-c', or with the next edit (depending
12030 on `org-remove-highlights-with-change'), this variable is emptied
12031 as well.")
12032 (make-variable-buffer-local 'org-occur-parameters)
12034 (defun org-occur (regexp &optional keep-previous callback)
12035 "Make a compact tree which shows all matches of REGEXP.
12036 The tree will show the lines where the regexp matches, and all higher
12037 headlines above the match. It will also show the heading after the match,
12038 to make sure editing the matching entry is easy.
12039 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12040 call to `org-occur' will be kept, to allow stacking of calls to this
12041 command.
12042 If CALLBACK is non-nil, it is a function which is called to confirm
12043 that the match should indeed be shown."
12045 (when (equal regexp "")
12046 (error "Regexp cannot be empty"))
12047 (unless keep-previous
12048 (org-remove-occur-highlights nil nil t))
12049 (push (cons regexp callback) org-occur-parameters)
12050 (let ((cnt 0))
12051 (save-excursion
12052 (goto-char (point-min))
12053 (if (or (not keep-previous) ; do not want to keep
12054 (not org-occur-highlights)) ; no previous matches
12055 ;; hide everything
12056 (org-overview))
12057 (while (re-search-forward regexp nil t)
12058 (when (or (not callback)
12059 (save-match-data (funcall callback)))
12060 (setq cnt (1+ cnt))
12061 (when org-highlight-sparse-tree-matches
12062 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12063 (org-show-context 'occur-tree))))
12064 (when org-remove-highlights-with-change
12065 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12066 nil 'local))
12067 (unless org-sparse-tree-open-archived-trees
12068 (org-hide-archived-subtrees (point-min) (point-max)))
12069 (run-hooks 'org-occur-hook)
12070 (if (interactive-p)
12071 (message "%d match(es) for regexp %s" cnt regexp))
12072 cnt))
12074 (defun org-occur-next-match (&optional n reset)
12075 "Function for `next-error-function' to find sparse tree matches.
12076 N is the number of matches to move, when negative move backwards.
12077 RESET is entirely ignored - this function always goes back to the
12078 starting point when no match is found."
12079 (let* ((limit (if (< n 0) (point-min) (point-max)))
12080 (search-func (if (< n 0)
12081 'previous-single-char-property-change
12082 'next-single-char-property-change))
12083 (n (abs n))
12084 (pos (point))
12085 p1)
12086 (catch 'exit
12087 (while (setq p1 (funcall search-func (point) 'org-type))
12088 (when (equal p1 limit)
12089 (goto-char pos)
12090 (error "No more matches"))
12091 (when (equal (get-char-property p1 'org-type) 'org-occur)
12092 (setq n (1- n))
12093 (when (= n 0)
12094 (goto-char p1)
12095 (throw 'exit (point))))
12096 (goto-char p1))
12097 (goto-char p1)
12098 (error "No more matches"))))
12100 (defun org-show-context (&optional key)
12101 "Make sure point and context are visible.
12102 How much context is shown depends upon the variables
12103 `org-show-hierarchy-above', `org-show-following-heading'. and
12104 `org-show-siblings'."
12105 (let ((heading-p (org-on-heading-p t))
12106 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12107 (following-p (org-get-alist-option org-show-following-heading key))
12108 (entry-p (org-get-alist-option org-show-entry-below key))
12109 (siblings-p (org-get-alist-option org-show-siblings key)))
12110 (catch 'exit
12111 ;; Show heading or entry text
12112 (if (and heading-p (not entry-p))
12113 (org-flag-heading nil) ; only show the heading
12114 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12115 (org-show-hidden-entry))) ; show entire entry
12116 (when following-p
12117 ;; Show next sibling, or heading below text
12118 (save-excursion
12119 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12120 (org-flag-heading nil))))
12121 (when siblings-p (org-show-siblings))
12122 (when hierarchy-p
12123 ;; show all higher headings, possibly with siblings
12124 (save-excursion
12125 (while (and (condition-case nil
12126 (progn (org-up-heading-all 1) t)
12127 (error nil))
12128 (not (bobp)))
12129 (org-flag-heading nil)
12130 (when siblings-p (org-show-siblings))))))))
12132 (defvar org-reveal-start-hook nil
12133 "Hook run before revealing a location.")
12135 (defun org-reveal (&optional siblings)
12136 "Show current entry, hierarchy above it, and the following headline.
12137 This can be used to show a consistent set of context around locations
12138 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12139 not t for the search context.
12141 With optional argument SIBLINGS, on each level of the hierarchy all
12142 siblings are shown. This repairs the tree structure to what it would
12143 look like when opened with hierarchical calls to `org-cycle'.
12145 go to the parent and show the
12146 entire tree."
12147 (interactive "P")
12148 (run-hooks 'org-reveal-start-hook)
12149 (let ((org-show-hierarchy-above t)
12150 (org-show-following-heading t)
12151 (org-show-siblings (if siblings t org-show-siblings)))
12152 (org-show-context nil))
12153 (when (equal siblings '(16))
12154 (save-excursion
12155 (when (org-up-heading-safe)
12156 (org-show-subtree)
12157 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12159 (defun org-highlight-new-match (beg end)
12160 "Highlight from BEG to END and mark the highlight is an occur headline."
12161 (let ((ov (make-overlay beg end)))
12162 (overlay-put ov 'face 'secondary-selection)
12163 (overlay-put ov 'org-type 'org-occur)
12164 (push ov org-occur-highlights)))
12166 (defun org-remove-occur-highlights (&optional beg end noremove)
12167 "Remove the occur highlights from the buffer.
12168 BEG and END are ignored. If NOREMOVE is nil, remove this function
12169 from the `before-change-functions' in the current buffer."
12170 (interactive)
12171 (unless org-inhibit-highlight-removal
12172 (mapc 'delete-overlay org-occur-highlights)
12173 (setq org-occur-highlights nil)
12174 (setq org-occur-parameters nil)
12175 (unless noremove
12176 (remove-hook 'before-change-functions
12177 'org-remove-occur-highlights 'local))))
12179 ;;;; Priorities
12182 "Regular expression matching the priority indicator.")
12184 (defvar org-remove-priority-next-time nil)
12186 (defun org-priority-up ()
12187 "Increase the priority of the current item."
12188 (interactive)
12189 (org-priority 'up))
12191 (defun org-priority-down ()
12192 "Decrease the priority of the current item."
12193 (interactive)
12194 (org-priority 'down))
12196 (defun org-priority (&optional action)
12197 "Change the priority of an item by ARG.
12198 ACTION can be `set', `up', `down', or a character."
12199 (interactive)
12200 (unless org-enable-priority-commands
12201 (error "Priority commands are disabled"))
12202 (setq action (or action 'set))
12203 (let (current new news have remove)
12204 (save-excursion
12205 (org-back-to-heading t)
12206 (if (looking-at org-priority-regexp)
12207 (setq current (string-to-char (match-string 2))
12208 have t)
12209 (setq current org-default-priority))
12210 (cond
12211 ((eq action 'remove)
12212 (setq remove t new ?\ ))
12213 ((or (eq action 'set)
12214 (if (featurep 'xemacs) (characterp action) (integerp action)))
12215 (if (not (eq action 'set))
12216 (setq new action)
12217 (message "Priority %c-%c, SPC to remove: "
12218 org-highest-priority org-lowest-priority)
12219 (save-match-data
12220 (setq new (read-char-exclusive))))
12221 (if (and (= (upcase org-highest-priority) org-highest-priority)
12222 (= (upcase org-lowest-priority) org-lowest-priority))
12223 (setq new (upcase new)))
12224 (cond ((equal new ?\ ) (setq remove t))
12225 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12226 (error "Priority must be between `%c' and `%c'"
12227 org-highest-priority org-lowest-priority))))
12228 ((eq action 'up)
12229 (if (and (not have) (eq last-command this-command))
12230 (setq new org-lowest-priority)
12231 (setq new (if (and org-priority-start-cycle-with-default (not have))
12232 org-default-priority (1- current)))))
12233 ((eq action 'down)
12234 (if (and (not have) (eq last-command this-command))
12235 (setq new org-highest-priority)
12236 (setq new (if (and org-priority-start-cycle-with-default (not have))
12237 org-default-priority (1+ current)))))
12238 (t (error "Invalid action")))
12239 (if (or (< (upcase new) org-highest-priority)
12240 (> (upcase new) org-lowest-priority))
12241 (setq remove t))
12242 (setq news (format "%c" new))
12243 (if have
12244 (if remove
12245 (replace-match "" t t nil 1)
12246 (replace-match news t t nil 2))
12247 (if remove
12248 (error "No priority cookie found in line")
12249 (let ((case-fold-search nil))
12250 (looking-at org-todo-line-regexp))
12251 (if (match-end 2)
12252 (progn
12253 (goto-char (match-end 2))
12254 (insert " [#" news "]"))
12255 (goto-char (match-beginning 3))
12256 (insert "[#" news "] "))))
12257 (org-preserve-lc (org-set-tags nil 'align)))
12258 (if remove
12259 (message "Priority removed")
12260 (message "Priority of current item set to %s" news))))
12262 (defun org-get-priority (s)
12263 "Find priority cookie and return priority."
12264 (if (functionp org-get-priority-function)
12265 (funcall org-get-priority-function)
12266 (save-match-data
12267 (if (not (string-match org-priority-regexp s))
12268 (* 1000 (- org-lowest-priority org-default-priority))
12269 (* 1000 (- org-lowest-priority
12270 (string-to-char (match-string 2 s))))))))
12272 ;;;; Tags
12274 (defvar org-agenda-archives-mode)
12275 (defvar org-map-continue-from nil
12276 "Position from where mapping should continue.
12277 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12279 (defvar org-scanner-tags nil
12280 "The current tag list while the tags scanner is running.")
12281 (defvar org-trust-scanner-tags nil
12282 "Should `org-get-tags-at' use the tags for the scanner.
12283 This is for internal dynamical scoping only.
12284 When this is non-nil, the function `org-get-tags-at' will return the value
12285 of `org-scanner-tags' instead of building the list by itself. This
12286 can lead to large speed-ups when the tags scanner is used in a file with
12287 many entries, and when the list of tags is retrieved, for example to
12288 obtain a list of properties. Building the tags list for each entry in such
12289 a file becomes an N^2 operation - but with this variable set, it scales
12290 as N.")
12292 (defun org-scan-tags (action matcher &optional todo-only)
12293 "Scan headline tags with inheritance and produce output ACTION.
12295 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12296 or `agenda' to produce an entry list for an agenda view. It can also be
12297 a Lisp form or a function that should be called at each matched headline, in
12298 this case the return value is a list of all return values from these calls.
12300 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12301 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12302 only lines with a TODO keyword are included in the output."
12303 (require 'org-agenda)
12306 (org-re
12308 (props (list 'face 'default
12309 'done-face 'org-agenda-done
12310 'undone-face 'default
12311 'mouse-face 'highlight
12312 'org-not-done-regexp org-not-done-regexp
12313 'org-todo-regexp org-todo-regexp
12314 'help-echo
12315 (format "mouse-2 or RET jump to org file %s"
12316 (abbreviate-file-name
12317 (or (buffer-file-name (buffer-base-buffer))
12318 (buffer-name (buffer-base-buffer)))))))
12319 (case-fold-search nil)
12320 (org-map-continue-from nil)
12321 lspos tags tags-list
12322 (tags-alist (list (cons 0 org-file-tags)))
12323 (llast 0) rtn rtn1 level category i txt
12324 todo marker entry priority)
12325 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12326 (setq action (list 'lambda nil action)))
12327 (save-excursion
12328 (goto-char (point-min))
12329 (when (eq action 'sparse-tree)
12330 (org-overview)
12331 (org-remove-occur-highlights))
12332 (while (re-search-forward re nil t)
12333 (catch :skip
12334 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12335 tags (if (match-end 4) (org-match-string-no-properties 4)))
12336 (goto-char (setq lspos (match-beginning 0)))
12337 (setq level (org-reduced-level (funcall outline-level))
12338 category (org-get-category))
12339 (setq i llast llast level)
12340 ;; remove tag lists from same and sublevels
12341 (while (>= i level)
12342 (when (setq entry (assoc i tags-alist))
12343 (setq tags-alist (delete entry tags-alist)))
12344 (setq i (1- i)))
12345 ;; add the next tags
12346 (when tags
12347 (setq tags (org-split-string tags ":")
12348 tags-alist
12349 (cons (cons level tags) tags-alist)))
12350 ;; compile tags for current headline
12351 (setq tags-list
12352 (if org-use-tag-inheritance
12353 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12354 tags)
12355 org-scanner-tags tags-list)
12356 (when org-use-tag-inheritance
12357 (setcdr (car tags-alist)
12358 (mapcar (lambda (x)
12359 (setq x (copy-sequence x))
12360 (org-add-prop-inherited x))
12361 (cdar tags-alist))))
12362 (when (and tags org-use-tag-inheritance
12363 (or (not (eq t org-use-tag-inheritance))
12364 org-tags-exclude-from-inheritance))
12365 ;; selective inheritance, remove uninherited ones
12366 (setcdr (car tags-alist)
12367 (org-remove-uniherited-tags (cdar tags-alist))))
12368 (when (and (or (not todo-only)
12369 (and (member todo org-not-done-keywords)
12370 (or (not org-agenda-tags-todo-honor-ignore-options)
12371 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12372 (let ((case-fold-search t)) (eval matcher))
12373 (or
12374 (not (member org-archive-tag tags-list))
12375 ;; we have an archive tag, should we use this anyway?
12376 (or (not org-agenda-skip-archived-trees)
12377 (and (eq action 'agenda) org-agenda-archives-mode))))
12378 (unless (eq action 'sparse-tree) (org-agenda-skip))
12380 ;; select this headline
12382 (cond
12383 ((eq action 'sparse-tree)
12384 (and org-highlight-sparse-tree-matches
12385 (org-get-heading) (match-end 0)
12386 (org-highlight-new-match
12387 (match-beginning 0) (match-beginning 1)))
12388 (org-show-context 'tags-tree))
12389 ((eq action 'agenda)
12390 (setq txt (org-format-agenda-item
12391 ""
12392 (concat
12393 (if (eq org-tags-match-list-sublevels 'indented)
12394 (make-string (1- level) ?.) "")
12395 (org-get-heading))
12396 category
12397 tags-list
12398 )
12399 priority (org-get-priority txt))
12400 (goto-char lspos)
12401 (setq marker (org-agenda-new-marker))
12402 (org-add-props txt props
12403 'org-marker marker 'org-hd-marker marker 'org-category category
12404 'todo-state todo
12405 'priority priority 'type "tagsmatch")
12406 (push txt rtn))
12407 ((functionp action)
12408 (setq org-map-continue-from nil)
12409 (save-excursion
12410 (setq rtn1 (funcall action))
12411 (push rtn1 rtn)))
12412 (t (error "Invalid action")))
12414 ;; if we are to skip sublevels, jump to end of subtree
12415 (unless org-tags-match-list-sublevels
12416 (org-end-of-subtree t)
12417 (backward-char 1))))
12418 ;; Get the correct position from where to continue
12419 (if org-map-continue-from
12420 (goto-char org-map-continue-from)
12421 (and (= (point) lspos) (end-of-line 1)))))
12422 (when (and (eq action 'sparse-tree)
12423 (not org-sparse-tree-open-archived-trees))
12424 (org-hide-archived-subtrees (point-min) (point-max)))
12425 (nreverse rtn)))
12427 (defun org-remove-uniherited-tags (tags)
12428 "Remove all tags that are not inherited from the list TAGS."
12429 (cond
12430 ((eq org-use-tag-inheritance t)
12431 (if org-tags-exclude-from-inheritance
12432 (org-delete-all org-tags-exclude-from-inheritance tags)
12433 tags))
12434 ((not org-use-tag-inheritance) nil)
12435 ((stringp org-use-tag-inheritance)
12436 (delq nil (mapcar
12437 (lambda (x)
12438 (if (and (string-match org-use-tag-inheritance x)
12439 (not (member x org-tags-exclude-from-inheritance)))
12440 x nil))
12441 tags)))
12442 ((listp org-use-tag-inheritance)
12443 (delq nil (mapcar
12444 (lambda (x)
12445 (if (member x org-use-tag-inheritance) x nil))
12446 tags)))))
12448 (defvar todo-only) ;; dynamically scoped
12450 (defun org-match-sparse-tree (&optional todo-only match)
12451 "Create a sparse tree according to tags string MATCH.
12452 MATCH can contain positive and negative selection of tags, like
12454 If optional argument TODO-ONLY is non-nil, only select lines that are
12455 also TODO lines."
12456 (interactive "P")
12457 (org-prepare-agenda-buffers (list (current-buffer)))
12458 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12460 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12462 (defvar org-cached-props nil)
12463 (defun org-cached-entry-get (pom property)
12464 (if (or (eq t org-use-property-inheritance)
12465 (and (stringp org-use-property-inheritance)
12466 (string-match org-use-property-inheritance property))
12467 (and (listp org-use-property-inheritance)
12468 (member property org-use-property-inheritance)))
12469 ;; Caching is not possible, check it directly
12470 (org-entry-get pom property 'inherit)
12471 ;; Get all properties, so that we can do complicated checks easily
12472 (cdr (assoc property (or org-cached-props
12473 (setq org-cached-props
12474 (org-entry-properties pom)))))))
12476 (defun org-global-tags-completion-table (&optional files)
12477 "Return the list of all tags in all agenda buffer/files.
12478 Optional FILES argument is a list of files to which can be used
12479 instead of the agenda files."
12480 (save-excursion
12481 (org-uniquify
12482 (delq nil
12483 (apply 'append
12484 (mapcar
12485 (lambda (file)
12486 (set-buffer (find-file-noselect file))
12487 (append (org-get-buffer-tags)
12488 (mapcar (lambda (x) (if (stringp (car-safe x))
12489 (list (car-safe x)) nil))
12490 org-tag-alist)))
12491 (if (and files (car files))
12492 files
12493 (org-agenda-files))))))))
12495 (defun org-make-tags-matcher (match)
12496 "Create the TAGS//TODO matcher form for the selection string MATCH."
12497 ;; todo-only is scoped dynamically into this function, and the function
12498 ;; may change it if the matcher asks for it.
12499 (unless match
12500 ;; Get a new match request, with completion
12501 (let ((org-last-tags-completion-table
12502 (org-global-tags-completion-table)))
12503 (setq match (org-completing-read-no-i
12504 "Match: " 'org-tags-completion-function nil nil nil
12505 'org-tags-history))))
12507 ;; Parse the string and create a lisp form
12508 (let ((match0 match)
12509 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12510 minus tag mm
12511 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12512 orterms term orlist re-p str-p level-p level-op time-p
12513 prop-p pn pv po gv rest)
12514 (if (string-match "/+" match)
12515 ;; match contains also a todo-matching request
12516 (progn
12517 (setq tagsmatch (substring match 0 (match-beginning 0))
12518 todomatch (substring match (match-end 0)))
12519 (if (string-match "^!" todomatch)
12520 (setq todo-only t todomatch (substring todomatch 1)))
12522 (setq todomatch nil)))
12523 ;; only matching tags
12524 (setq tagsmatch match todomatch nil))
12526 ;; Make the tags matcher
12528 (setq tagsmatcher t)
12529 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12530 (while (setq term (pop orterms))
12532 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12533 (while (string-match re term)
12534 (setq rest (substring term (match-end 0))
12535 minus (and (match-end 1)
12536 (equal (match-string 1 term) "-"))
12537 tag (save-match-data (replace-regexp-in-string
12539 (match-string 2 term)))
12540 re-p (equal (string-to-char tag) ?{)
12541 level-p (match-end 4)
12542 prop-p (match-end 5)
12543 mm (cond
12544 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12545 (level-p
12546 (setq level-op (org-op-to-function (match-string 3 term)))
12547 `(,level-op level ,(string-to-number
12548 (match-string 4 term))))
12549 (prop-p
12550 (setq pn (match-string 5 term)
12551 po (match-string 6 term)
12552 pv (match-string 7 term)
12553 re-p (equal (string-to-char pv) ?{)
12555 time-p (save-match-data
12557 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12558 (if time-p (setq pv (org-matcher-time pv)))
12559 (setq po (org-op-to-function po (if time-p 'time str-p)))
12560 (cond
12561 ((equal pn "CATEGORY")
12562 (setq gv '(get-text-property (point) 'org-category)))
12563 ((equal pn "TODO")
12564 (setq gv 'todo))
12565 (t
12566 (setq gv `(org-cached-entry-get nil ,pn))))
12567 (if re-p
12568 (if (eq po 'org<>)
12569 `(not (string-match ,pv (or ,gv "")))
12570 `(string-match ,pv (or ,gv "")))
12571 (if str-p
12572 `(,po (or ,gv "") ,pv)
12573 `(,po (string-to-number (or ,gv ""))
12574 ,(string-to-number pv) ))))
12575 (t `(member ,tag tags-list)))
12576 mm (if minus (list 'not mm) mm)
12577 term rest)
12578 (push mm tagsmatcher))
12579 (push (if (> (length tagsmatcher) 1)
12580 (cons 'and tagsmatcher)
12581 (car tagsmatcher))
12582 orlist)
12583 (setq tagsmatcher nil))
12584 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12585 (setq tagsmatcher
12586 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12587 ;; Make the todo matcher
12589 (setq todomatcher t)
12590 (setq orterms (org-split-string todomatch "|") orlist nil)
12591 (while (setq term (pop orterms))
12592 (while (string-match re term)
12593 (setq minus (and (match-end 1)
12594 (equal (match-string 1 term) "-"))
12595 kwd (match-string 2 term)
12596 re-p (equal (string-to-char kwd) ?{)
12597 term (substring term (match-end 0))
12598 mm (if re-p
12599 `(string-match ,(substring kwd 1 -1) todo)
12600 (list 'equal 'todo kwd))
12601 mm (if minus (list 'not mm) mm))
12602 (push mm todomatcher))
12603 (push (if (> (length todomatcher) 1)
12604 (cons 'and todomatcher)
12605 (car todomatcher))
12606 orlist)
12607 (setq todomatcher nil))
12608 (setq todomatcher (if (> (length orlist) 1)
12609 (cons 'or orlist) (car orlist))))
12611 ;; Return the string and lisp forms of the matcher
12612 (setq matcher (if todomatcher
12613 (list 'and tagsmatcher todomatcher)
12614 tagsmatcher))
12615 (cons match0 matcher)))
12617 (defun org-op-to-function (op &optional stringp)
12618 "Turn an operator into the appropriate function."
12619 (setq op
12620 (cond
12621 ((equal op "<" ) '(< string< org-time<))
12622 ((equal op ">" ) '(> org-string> org-time>))
12623 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12624 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12625 ((member op '("=" "==")) '(= string= org-time=))
12626 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12627 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12629 (defun org<> (a b) (not (= a b)))
12630 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12631 (defun org-string>= (a b) (not (string< a b)))
12632 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12633 (defun org-string<> (a b) (not (string= a b)))
12634 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12635 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12636 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12637 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12638 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12639 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12640 (defun org-2ft (s)
12641 "Convert S to a floating point time.
12642 If S is already a number, just return it. If it is a string, parse
12643 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12644 (cond
12645 ((numberp s) s)
12646 ((stringp s)
12647 (condition-case nil
12648 (float-time (apply 'encode-time (org-parse-time-string s)))
12649 (error 0.)))
12650 (t 0.)))
12652 (defun org-time-today ()
12653 "Time in seconds today at 0:00.
12654 Returns the float number of seconds since the beginning of the
12655 epoch to the beginning of today (00:00)."
12656 (float-time (apply 'encode-time
12657 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12659 (defun org-matcher-time (s)
12660 "Interpret a time comparison value."
12661 (save-match-data
12662 (cond
12663 ((string= s "<now>") (float-time))
12664 ((string= s "<today>") (org-time-today))
12665 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12666 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12668 (+ (org-time-today)
12669 (* (string-to-number (match-string 1 s))
12670 (cdr (assoc (match-string 2 s)
12671 '(("d" . 86400.0) ("w" . 604800.0)
12672 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12673 (t (org-2ft s)))))
12675 (defun org-match-any-p (re list)
12676 "Does re match any element of list?"
12677 (setq list (mapcar (lambda (x) (string-match re x)) list))
12678 (delq nil list))
12680 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12681 (defvar org-tags-overlay (make-overlay 1 1))
12682 (org-detach-overlay org-tags-overlay)
12684 (defun org-get-local-tags-at (&optional pos)
12685 "Get a list of tags defined in the current headline."
12686 (org-get-tags-at pos 'local))
12688 (defun org-get-local-tags ()
12689 "Get a list of tags defined in the current headline."
12690 (org-get-tags-at nil 'local))
12692 (defun org-get-tags-at (&optional pos local)
12693 "Get a list of all headline tags applicable at POS.
12694 POS defaults to point. If tags are inherited, the list contains
12695 the targets in the same sequence as the headlines appear, i.e.
12696 the tags of the current headline come last.
12697 When LOCAL is non-nil, only return tags from the current headline,
12698 ignore inherited ones."
12699 (interactive)
12700 (if (and org-trust-scanner-tags
12701 (or (not pos) (equal pos (point)))
12702 (not local))
12703 org-scanner-tags
12704 (let (tags ltags lastpos parent)
12705 (save-excursion
12706 (save-restriction
12707 (widen)
12708 (goto-char (or pos (point)))
12709 (save-match-data
12710 (catch 'done
12711 (condition-case nil
12712 (progn
12713 (org-back-to-heading t)
12714 (while (not (equal lastpos (point)))
12715 (setq lastpos (point))
12716 (when (looking-at
12718 (setq ltags (org-split-string
12719 (org-match-string-no-properties 1) ":"))
12720 (when parent
12721 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12722 (setq tags (append
12723 (if parent
12724 (org-remove-uniherited-tags ltags)
12725 ltags)
12726 tags)))
12727 (or org-use-tag-inheritance (throw 'done t))
12728 (if local (throw 'done t))
12729 (or (org-up-heading-safe) (error nil))
12730 (setq parent t)))
12731 (error nil)))))
12732 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12734 (defun org-add-prop-inherited (s)
12735 (add-text-properties 0 (length s) '(inherited t) s)
12736 s)
12738 (defun org-toggle-tag (tag &optional onoff)
12739 "Toggle the tag TAG for the current line.
12740 If ONOFF is `on' or `off', don't toggle but set to this state."
12741 (let (res current)
12742 (save-excursion
12743 (org-back-to-heading t)
12745 (point-at-eol) t)
12746 (progn
12747 (setq current (match-string 1))
12748 (replace-match ""))
12749 (setq current ""))
12750 (setq current (nreverse (org-split-string current ":")))
12751 (cond
12752 ((eq onoff 'on)
12753 (setq res t)
12754 (or (member tag current) (push tag current)))
12755 ((eq onoff 'off)
12756 (or (not (member tag current)) (setq current (delete tag current))))
12757 (t (if (member tag current)
12758 (setq current (delete tag current))
12759 (setq res t)
12760 (push tag current))))
12761 (end-of-line 1)
12762 (if current
12763 (progn
12764 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12765 (org-set-tags nil t))
12766 (delete-horizontal-space))
12767 (run-hooks 'org-after-tags-change-hook))
12768 res))
12770 (defun org-align-tags-here (to-col)
12771 ;; Assumes that this is a headline
12772 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12773 (beginning-of-line 1)
12775 (< pos (match-beginning 2)))
12776 (progn
12777 (setq tags-l (- (match-end 2) (match-beginning 2)))
12778 (goto-char (match-beginning 1))
12779 (insert " ")
12780 (delete-region (point) (1+ (match-beginning 2)))
12781 (setq ncol (max (1+ (current-column))
12782 (1+ col)
12783 (if (> to-col 0)
12784 to-col
12785 (- (abs to-col) tags-l))))
12786 (setq p (point))
12787 (insert (make-string (- ncol (current-column)) ?\ ))
12788 (setq ncol (current-column))
12789 (when indent-tabs-mode (tabify p (point-at-eol)))
12790 (org-move-to-column (min ncol col) t))
12791 (goto-char pos))))
12793 (defun org-set-tags-command (&optional arg just-align)
12794 "Call the set-tags command for the current entry."
12795 (interactive "P")
12796 (if (org-on-heading-p)
12797 (org-set-tags arg just-align)
12798 (save-excursion
12799 (org-back-to-heading t)
12800 (org-set-tags arg just-align))))
12802 (defun org-set-tags-to (data)
12803 "Set the tags of the current entry to DATA, replacing the current tags.
12804 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12805 If DATA is nil or the empty string, any tags will be removed."
12806 (interactive "sTags: ")
12807 (setq data
12808 (cond
12809 ((eq data nil) "")
12810 ((equal data "") "")
12811 ((stringp data)
12812 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12813 ":"))
12814 ((listp data)
12815 (concat ":" (mapconcat 'identity data ":") ":"))
12816 (t nil)))
12817 (when data
12818 (save-excursion
12819 (org-back-to-heading t)
12820 (when (looking-at org-complex-heading-regexp)
12821 (if (match-end 5)
12822 (progn
12823 (goto-char (match-beginning 5))
12824 (insert data)
12825 (delete-region (point) (point-at-eol))
12826 (org-set-tags nil 'align))
12827 (goto-char (point-at-eol))
12828 (insert " " data)
12829 (org-set-tags nil 'align)))
12830 (beginning-of-line 1)
12832 (delete-region (match-beginning 1) (match-end 1))))))
12834 (defun org-align-all-tags ()
12835 "Align the tags i all headings."
12836 (interactive)
12837 (save-excursion
12838 (or (ignore-errors (org-back-to-heading t))
12839 (outline-next-heading))
12840 (if (org-on-heading-p)
12841 (org-set-tags t)
12842 (message "No headings"))))
12844 (defvar org-indent-indentation-per-level)
12845 (defun org-set-tags (&optional arg just-align)
12846 "Set the tags for the current headline.
12847 With prefix ARG, realign all tags in headings in the current buffer."
12848 (interactive "P")
12849 (let* ((re (concat "^" outline-regexp))
12850 (current (org-get-tags-string))
12851 (col (current-column))
12852 (org-setting-tags t)
12853 table current-tags inherited-tags ; computed below when needed
12854 tags p0 c0 c1 rpl di tc level)
12855 (if arg
12856 (save-excursion
12857 (goto-char (point-min))
12858 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12859 (while (re-search-forward re nil t)
12860 (org-set-tags nil t)
12861 (end-of-line 1)))
12862 (message "All tags realigned to column %d" org-tags-column))
12863 (if just-align
12864 (setq tags current)
12865 ;; Get a new set of tags from the user
12866 (save-excursion
12867 (setq table (append org-tag-persistent-alist
12868 (or org-tag-alist (org-get-buffer-tags))
12869 (and
12870 org-complete-tags-always-offer-all-agenda-tags
12871 (org-global-tags-completion-table
12872 (org-agenda-files))))
12873 org-last-tags-completion-table table
12874 current-tags (org-split-string current ":")
12875 inherited-tags (nreverse
12876 (nthcdr (length current-tags)
12877 (nreverse (org-get-tags-at))))
12878 tags
12879 (if (or (eq t org-use-fast-tag-selection)
12880 (and org-use-fast-tag-selection
12881 (delq nil (mapcar 'cdr table))))
12882 (org-fast-tag-selection
12883 current-tags inherited-tags table
12884 (if org-fast-tag-selection-include-todo
12885 org-todo-key-alist))
12886 (let ((org-add-colon-after-tag-completion t))
12887 (org-trim
12888 (org-without-partial-completion
12889 (org-icompleting-read "Tags: "
12890 'org-tags-completion-function
12891 nil nil current 'org-tags-history)))))))
12892 (while (string-match "[-+&]+" tags)
12893 ;; No boolean logic, just a list
12894 (setq tags (replace-match ":" t t tags))))
12896 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12898 (if org-tags-sort-function
12899 (setq tags (mapconcat 'identity
12900 (sort (org-split-string
12901 tags (org-re "[^[:alnum:]_@#%]+"))
12902 org-tags-sort-function) ":")))
12905 (setq tags "")
12906 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12907 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12909 ;; Insert new tags at the correct column
12910 (beginning-of-line 1)
12911 (setq level (or (and (looking-at org-outline-regexp)
12912 (- (match-end 0) (point) 1))
12913 1))
12914 (cond
12915 ((and (equal current "") (equal tags "")))
12916 ((re-search-forward
12918 (point-at-eol) t)
12919 (if (equal tags "")
12920 (setq rpl "")
12921 (goto-char (match-beginning 0))
12922 (setq c0 (current-column)
12923 ;; compute offset for the case of org-indent-mode active
12924 di (if org-indent-mode
12925 (* (1- org-indent-indentation-per-level) (1- level))
12926 0)
12927 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12928 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12929 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12930 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12931 (replace-match rpl t t)
12932 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12933 tags)
12934 (t (error "Tags alignment failed")))
12935 (org-move-to-column col)
12936 (unless just-align
12937 (run-hooks 'org-after-tags-change-hook)))))
12939 (defun org-change-tag-in-region (beg end tag off)
12940 "Add or remove TAG for each entry in the region.
12941 This works in the agenda, and also in an org-mode buffer."
12942 (interactive
12943 (list (region-beginning) (region-end)
12944 (let ((org-last-tags-completion-table
12945 (if (org-mode-p)
12946 (org-get-buffer-tags)
12947 (org-global-tags-completion-table))))
12948 (org-icompleting-read
12949 "Tag: " 'org-tags-completion-function nil nil nil
12950 'org-tags-history))
12951 (progn
12953 (equal (read-char-exclusive) ?r))))
12954 (if (fboundp 'deactivate-mark) (deactivate-mark))
12955 (let ((agendap (equal major-mode 'org-agenda-mode))
12956 l1 l2 m buf pos newhead (cnt 0))
12957 (goto-char end)
12958 (setq l2 (1- (org-current-line)))
12959 (goto-char beg)
12960 (setq l1 (org-current-line))
12961 (loop for l from l1 to l2 do
12962 (org-goto-line l)
12963 (setq m (get-text-property (point) 'org-hd-marker))
12964 (when (or (and (org-mode-p) (org-on-heading-p))
12965 (and agendap m))
12966 (setq buf (if agendap (marker-buffer m) (current-buffer))
12967 pos (if agendap m (point)))
12968 (with-current-buffer buf
12969 (save-excursion
12970 (save-restriction
12971 (goto-char pos)
12972 (setq cnt (1+ cnt))
12973 (org-toggle-tag tag (if off 'off 'on))
12974 (setq newhead (org-get-heading)))))
12975 (and agendap (org-agenda-change-all-lines newhead m))))
12976 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12978 (defun org-tags-completion-function (string predicate &optional flag)
12979 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12980 (confirm (lambda (x) (stringp (car x)))))
12982 (setq s1 (match-string 1 string)
12983 s2 (match-string 2 string))
12984 (setq s1 "" s2 string))
12985 (cond
12986 ((eq flag nil)
12987 ;; try completion
12988 (setq rtn (try-completion s2 ctable confirm))
12989 (if (stringp rtn)
12990 (setq rtn
12991 (concat s1 s2 (substring rtn (length s2))
12992 (if (and org-add-colon-after-tag-completion
12993 (assoc rtn ctable))
12994 ":" ""))))
12995 rtn)
12996 ((eq flag t)
12997 ;; all-completions
12998 (all-completions s2 ctable confirm)
12999 )
13000 ((eq flag 'lambda)
13001 ;; exact match?
13002 (assoc s2 ctable)))
13003 ))
13005 (defun org-fast-tag-insert (kwd tags face &optional end)
13006 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13007 (insert (format "%-12s" (concat kwd ":"))
13008 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13009 (or end "")))
13011 (defun org-fast-tag-show-exit (flag)
13012 (save-excursion
13013 (org-goto-line 3)
13015 (replace-match ""))
13016 (when flag
13017 (end-of-line 1)
13018 (org-move-to-column (- (window-width) 19) t)
13019 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13021 (defun org-set-current-tags-overlay (current prefix)
13022 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13023 (if (featurep 'xemacs)
13024 (org-overlay-display org-tags-overlay (concat prefix s)
13025 'secondary-selection)
13026 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13027 (org-overlay-display org-tags-overlay (concat prefix s)))))
13029 (defvar org-last-tag-selection-key nil)
13030 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13031 "Fast tag selection with single keys.
13032 CURRENT is the current list of tags in the headline, INHERITED is the
13033 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13034 possibly with grouping information. TODO-TABLE is a similar table with
13035 TODO keywords, should these have keys assigned to them.
13036 If the keys are nil, a-z are automatically assigned.
13037 Returns the new tags string, or nil to not change the current settings."
13038 (let* ((fulltable (append table todo-table))
13039 (maxlen (apply 'max (mapcar
13040 (lambda (x)
13041 (if (stringp (car x)) (string-width (car x)) 0))
13042 fulltable)))
13043 (buf (current-buffer))
13044 (expert (eq org-fast-tag-selection-single-key 'expert))
13045 (buffer-tags nil)
13046 (fwidth (+ maxlen 3 1 3))
13047 (ncol (/ (- (window-width) 4) fwidth))
13048 (i-face 'org-done)
13049 (c-face 'org-todo)
13050 tg cnt e c char c1 c2 ntable tbl rtn
13051 ov-start ov-end ov-prefix
13052 (exit-after-next org-fast-tag-selection-single-key)
13053 (done-keywords org-done-keywords)
13054 groups ingroup)
13055 (save-excursion
13056 (beginning-of-line 1)
13057 (if (looking-at
13059 (setq ov-start (match-beginning 1)
13060 ov-end (match-end 1)
13061 ov-prefix "")
13062 (setq ov-start (1- (point-at-eol))
13063 ov-end (1+ ov-start))
13065 (setq ov-prefix
13066 (concat
13067 (buffer-substring (1- (point)) (point))
13068 (if (> (current-column) org-tags-column)
13069 " "
13070 (make-string (- org-tags-column (current-column)) ?\ ))))))
13071 (move-overlay org-tags-overlay ov-start ov-end)
13072 (save-window-excursion
13073 (if expert
13074 (set-buffer (get-buffer-create " *Org tags*"))
13075 (delete-other-windows)
13076 (split-window-vertically)
13077 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13078 (erase-buffer)
13079 (org-set-local 'org-done-keywords done-keywords)
13082 (org-fast-tag-show-exit exit-after-next)
13083 (org-set-current-tags-overlay current ov-prefix)
13084 (setq tbl fulltable char ?a cnt 0)
13085 (while (setq e (pop tbl))
13086 (cond
13087 ((equal (car e) :startgroup)
13088 (push '() groups) (setq ingroup t)
13089 (when (not (= cnt 0))
13090 (setq cnt 0)
13092 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13093 ((equal (car e) :endgroup)
13094 (setq ingroup nil cnt 0)
13096 ((equal e '(:newline))
13097 (when (not (= cnt 0))
13098 (setq cnt 0)
13100 (setq e (car tbl))
13101 (while (equal (car tbl) '(:newline))
13103 (setq tbl (cdr tbl)))))
13104 (t
13105 (setq tg (copy-sequence (car e)) c2 nil)
13106 (if (cdr e)
13107 (setq c (cdr e))
13108 ;; automatically assign a character.
13109 (setq c1 (string-to-char
13110 (downcase (substring
13111 tg (if (= (string-to-char tg) ?@) 1 0)))))
13112 (if (or (rassoc c1 ntable) (rassoc c1 table))
13113 (while (or (rassoc char ntable) (rassoc char table))
13114 (setq char (1+ char)))
13115 (setq c2 c1))
13116 (setq c (or c2 char)))
13117 (if ingroup (push tg (car groups)))
13118 (setq tg (org-add-props tg nil 'face
13119 (cond
13120 ((not (assoc tg table))
13121 (org-get-todo-face tg))
13122 ((member tg current) c-face)
13123 ((member tg inherited) i-face)
13124 (t nil))))
13125 (if (and (= cnt 0) (not ingroup)) (insert " "))
13126 (insert "[" c "] " tg (make-string
13127 (- fwidth 4 (length tg)) ?\ ))
13128 (push (cons tg c) ntable)
13129 (when (= (setq cnt (1+ cnt)) ncol)
13131 (if ingroup (insert " "))
13132 (setq cnt 0)))))
13133 (setq ntable (nreverse ntable))
13135 (goto-char (point-min))
13136 (if (not expert) (org-fit-window-to-buffer))
13137 (setq rtn
13138 (catch 'exit
13139 (while t
13140 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13141 (if (not groups) "no " "")
13142 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13143 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13144 (setq org-last-tag-selection-key c)
13145 (cond
13147 ((= c ?!)
13148 (setq groups (not groups))
13149 (goto-char (point-min))
13150 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13151 ((= c ?\C-c)
13152 (if (not expert)
13153 (org-fast-tag-show-exit
13154 (setq exit-after-next (not exit-after-next)))
13155 (setq expert nil)
13156 (delete-other-windows)
13157 (set-window-buffer (split-window-vertically) " *Org tags*")
13158 (org-switch-to-buffer-other-window " *Org tags*")
13159 (org-fit-window-to-buffer)))
13160 ((or (= c ?\C-g)
13161 (and (= c ?q) (not (rassoc c ntable))))
13162 (org-detach-overlay org-tags-overlay)
13163 (setq quit-flag t))
13164 ((= c ?\ )
13165 (setq current nil)
13166 (if exit-after-next (setq exit-after-next 'now)))
13168 (condition-case nil
13169 (setq tg (org-icompleting-read
13170 "Tag: "
13171 (or buffer-tags
13172 (with-current-buffer buf
13173 (org-get-buffer-tags)))))
13174 (quit (setq tg "")))
13176 (add-to-list 'buffer-tags (list tg))
13177 (if (member tg current)
13178 (setq current (delete tg current))
13179 (push tg current)))
13180 (if exit-after-next (setq exit-after-next 'now)))
13181 ((setq e (rassoc c todo-table) tg (car e))
13182 (with-current-buffer buf
13183 (save-excursion (org-todo tg)))
13184 (if exit-after-next (setq exit-after-next 'now)))
13185 ((setq e (rassoc c ntable) tg (car e))
13186 (if (member tg current)
13187 (setq current (delete tg current))
13188 (loop for g in groups do
13189 (if (member tg g)
13190 (mapc (lambda (x)
13191 (setq current (delete x current)))
13192 g)))
13193 (push tg current))
13194 (if exit-after-next (setq exit-after-next 'now))))
13196 ;; Create a sorted list
13197 (setq current
13198 (sort current
13199 (lambda (a b)
13200 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13201 (if (eq exit-after-next 'now) (throw 'exit t))
13202 (goto-char (point-min))
13203 (beginning-of-line 2)
13204 (delete-region (point) (point-at-eol))
13205 (org-fast-tag-insert "Current" current c-face)
13206 (org-set-current-tags-overlay current ov-prefix)
13207 (while (re-search-forward
13209 (setq tg (match-string 1))
13210 (add-text-properties
13211 (match-beginning 1) (match-end 1)
13212 (list 'face
13213 (cond
13214 ((member tg current) c-face)
13215 ((member tg inherited) i-face)
13216 (t (get-text-property (match-beginning 1) 'face))))))
13217 (goto-char (point-min)))))
13218 (org-detach-overlay org-tags-overlay)
13219 (if rtn
13220 (mapconcat 'identity current ":")
13221 nil))))
13223 (defun org-get-tags-string ()
13224 "Get the TAGS string in the current headline."
13225 (unless (org-on-heading-p t)
13226 (error "Not on a heading"))
13227 (save-excursion
13228 (beginning-of-line 1)
13230 (org-match-string-no-properties 1)
13231 "")))
13233 (defun org-get-tags ()
13234 "Get the list of tags specified in the current headline."
13235 (org-split-string (org-get-tags-string) ":"))
13237 (defun org-get-buffer-tags ()
13238 "Get a table of all tags used in the buffer, for completion."
13239 (let (tags)
13240 (save-excursion
13241 (goto-char (point-min))
13242 (while (re-search-forward
13244 (when (equal (char-after (point-at-bol 0)) ?*)
13245 (mapc (lambda (x) (add-to-list 'tags x))
13246 (org-split-string (org-match-string-no-properties 1) ":")))))
13247 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13248 (mapcar 'list tags)))
13250 ;;;; The mapping API
13252 ;;;###autoload
13253 (defun org-map-entries (func &optional match scope &rest skip)
13254 "Call FUNC at each headline selected by MATCH in SCOPE.
13256 FUNC is a function or a lisp form. The function will be called without
13257 arguments, with the cursor positioned at the beginning of the headline.
13258 The return values of all calls to the function will be collected and
13259 returned as a list.
13261 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13262 does not need to preserve point. After evaluation, the cursor will be
13263 moved to the end of the line (presumably of the headline of the
13264 processed entry) and search continues from there. Under some
13265 circumstances, this may not produce the wanted results. For example,
13266 if you have removed (e.g. archived) the current (sub)tree it could
13267 mean that the next entry will be skipped entirely. In such cases, you
13268 can specify the position from where search should continue by making
13269 FUNC set the variable `org-map-continue-from' to the desired buffer
13270 position.
13272 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13273 Only headlines that are matched by this query will be considered during
13274 the iteration. When MATCH is nil or t, all headlines will be
13275 visited by the iteration.
13277 SCOPE determines the scope of this command. It can be any of:
13279 nil The current buffer, respecting the restriction if any
13280 tree The subtree started with the entry at point
13281 file The current buffer, without restriction
13282 file-with-archives
13283 The current buffer, and any archives associated with it
13284 agenda All agenda files
13285 agenda-with-archives
13286 All agenda files with any archive files associated with them
13287 \(file1 file2 ...)
13288 If this is a list, all files in the list will be scanned
13290 The remaining args are treated as settings for the skipping facilities of
13291 the scanner. The following items can be given here:
13293 archive skip trees with the archive tag.
13294 comment skip trees with the COMMENT keyword
13295 function or Emacs Lisp form:
13296 will be used as value for `org-agenda-skip-function', so whenever
13297 the function returns t, FUNC will not be called for that
13298 entry and search will continue from the point where the
13299 function leaves it.
13301 If your function needs to retrieve the tags including inherited tags
13302 at the *current* entry, you can use the value of the variable
13303 `org-scanner-tags' which will be much faster than getting the value
13304 with `org-get-tags-at'. If your function gets properties with
13305 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13306 to t around the call to `org-entry-properties' to get the same speedup.
13307 Note that if your function moves around to retrieve tags and properties at
13308 a *different* entry, you cannot use these techniques."
13309 (let* ((org-agenda-archives-mode nil) ; just to make sure
13310 (org-agenda-skip-archived-trees (memq 'archive skip))
13311 (org-agenda-skip-comment-trees (memq 'comment skip))
13312 (org-agenda-skip-function
13313 (car (org-delete-all '(comment archive) skip)))
13314 (org-tags-match-list-sublevels t)
13315 matcher file res
13316 org-todo-keywords-for-agenda
13317 org-done-keywords-for-agenda
13318 org-todo-keyword-alist-for-agenda
13319 org-drawers-for-agenda
13320 org-tag-alist-for-agenda)
13322 (cond
13323 ((eq match t) (setq matcher t))
13324 ((eq match nil) (setq matcher t))
13325 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13327 (save-excursion
13328 (save-restriction
13329 (when (eq scope 'tree)
13330 (org-back-to-heading t)
13331 (org-narrow-to-subtree)
13332 (setq scope nil))
13334 (if (not scope)
13335 (progn
13336 (org-prepare-agenda-buffers
13337 (list (buffer-file-name (current-buffer))))
13338 (setq res (org-scan-tags func matcher)))
13339 ;; Get the right scope
13340 (cond
13341 ((and scope (listp scope) (symbolp (car scope)))
13342 (setq scope (eval scope)))
13343 ((eq scope 'agenda)
13344 (setq scope (org-agenda-files t)))
13345 ((eq scope 'agenda-with-archives)
13346 (setq scope (org-agenda-files t))
13347 (setq scope (org-add-archive-files scope)))
13348 ((eq scope 'file)
13349 (setq scope (list (buffer-file-name))))
13350 ((eq scope 'file-with-archives)
13351 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13352 (org-prepare-agenda-buffers scope)
13353 (while (setq file (pop scope))
13354 (with-current-buffer (org-find-base-buffer-visiting file)
13355 (save-excursion
13356 (save-restriction
13357 (widen)
13358 (goto-char (point-min))
13359 (setq res (append res (org-scan-tags func matcher))))))))))
13360 res))
13362 ;;;; Properties
13364 ;;; Setting and retrieving properties
13366 (defconst org-special-properties
13367 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13368 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13369 "The special properties valid in Org-mode.
13371 These are properties that are not defined in the property drawer,
13372 but in some other way.")
13374 (defconst org-default-properties
13375 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13376 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13377 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13378 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13379 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13380 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13381 "Some properties that are used by Org-mode for various purposes.
13382 Being in this list makes sure that they are offered for completion.")
13385 "Regular expression matching the first line of a property drawer.")
13388 "Regular expression matching the last line of a property drawer.")
13391 "Regular expression matching the first line of a property drawer.")
13394 "Regular expression matching the first line of a property drawer.")
13396 (defconst org-property-drawer-re
13399 "Matches an entire property drawer.")
13401 (defconst org-clock-drawer-re
13404 "Matches an entire clock drawer.")
13406 (defun org-property-action ()
13407 "Do an action on properties."
13408 (interactive)
13409 (let (c)
13410 (org-at-property-p)
13411 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13412 (setq c (read-char-exclusive))
13413 (cond
13414 ((equal c ?s)
13415 (call-interactively 'org-set-property))
13416 ((equal c ?d)
13417 (call-interactively 'org-delete-property))
13418 ((equal c ?D)
13419 (call-interactively 'org-delete-property-globally))
13420 ((equal c ?c)
13421 (call-interactively 'org-compute-property-at-point))
13422 (t (error "No such property action %c" c)))))
13424 (defun org-set-effort (&optional value)
13425 "Set the effort property of the current entry.
13426 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13427 allowed value."
13428 (interactive "P")
13429 (if (equal value 0) (setq value 10))
13430 (let* ((completion-ignore-case t)
13431 (prop org-effort-property)
13432 (cur (org-entry-get nil prop))
13433 (allowed (org-property-get-allowed-values nil prop 'table))
13434 (existing (mapcar 'list (org-property-values prop)))
13435 rpl
13436 (val (cond
13437 ((stringp value) value)
13438 ((and allowed (integerp value))
13439 (or (car (nth (1- value) allowed))
13440 (car (org-last allowed))))
13441 (allowed
13442 (message "Select 1-9,0, [RET%s]: %s"
13443 (if cur (concat "=" cur) "")
13444 (mapconcat 'car allowed " "))
13445 (setq rpl (read-char-exclusive))
13447 cur
13448 (setq rpl (- rpl ?0))
13449 (if (equal rpl 0) (setq rpl 10))
13450 (if (and (> rpl 0) (<= rpl (length allowed)))
13451 (car (nth (1- rpl) allowed))
13452 (org-completing-read "Effort: " allowed nil))))
13453 (t
13454 (let (org-completion-use-ido org-completion-use-iswitchb)
13455 (org-completing-read
13457 (concat "[" cur "]") "")
13458 ": ")
13459 existing nil nil "" nil cur))))))
13460 (unless (equal (org-entry-get nil prop) val)
13461 (org-entry-put nil prop val))
13462 (message "%s is now %s" prop val)))
13464 (defun org-at-property-p ()
13465 "Is cursor inside a property drawer?"
13466 (save-excursion
13467 (beginning-of-line 1)
13469 (save-match-data ;; Used by calling procedures
13470 (let ((p (point))
13471 (range (unless (org-before-first-heading-p)
13472 (org-get-property-block))))
13473 (and range (<= (car range) p) (< p (cdr range))))))))
13475 (defun org-get-property-block (&optional beg end force)
13476 "Return the (beg . end) range of the body of the property drawer.
13477 BEG and END can be beginning and end of subtree, if not given
13478 they will be found.
13479 If the drawer does not exist and FORCE is non-nil, create the drawer."
13480 (catch 'exit
13481 (save-excursion
13482 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13483 (end (or end (progn (outline-next-heading) (point)))))
13484 (goto-char beg)
13485 (if (re-search-forward org-property-start-re end t)
13486 (setq beg (1+ (match-end 0)))
13487 (if force
13488 (save-excursion
13489 (org-insert-property-drawer)
13490 (setq end (progn (outline-next-heading) (point))))
13491 (throw 'exit nil))
13492 (goto-char beg)
13493 (if (re-search-forward org-property-start-re end t)
13494 (setq beg (1+ (match-end 0)))))
13495 (if (re-search-forward org-property-end-re end t)
13496 (setq end (match-beginning 0))
13497 (or force (throw 'exit nil))
13498 (goto-char beg)
13499 (setq end beg)
13500 (org-indent-line-function)
13502 (cons beg end)))))
13504 (defun org-entry-properties (&optional pom which specific)
13505 "Get all properties of the entry at point-or-marker POM.
13506 This includes the TODO keyword, the tags, time strings for deadline,
13507 scheduled, and clocking, and any additional properties defined in the
13508 entry. The return value is an alist, keys may occur multiple times
13509 if the property key was used several times.
13510 POM may also be nil, in which case the current entry is used.
13511 If WHICH is nil or `all', get all properties. If WHICH is
13512 `special' or `standard', only get that subclass. If WHICH
13513 is a string only get exactly this property. SPECIFIC can be a string, the
13514 specific property we are interested in. Specifying it can speed
13515 things up because then unnecessary parsing is avoided."
13516 (setq which (or which 'all))
13517 (org-with-point-at pom
13518 (let ((clockstr (substring org-clock-string 0 -1))
13519 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13520 (case-fold-search nil)
13521 beg end range props sum-props key key1 value string clocksum)
13522 (save-excursion
13523 (when (condition-case nil
13524 (and (org-mode-p) (org-back-to-heading t))
13525 (error nil))
13526 (setq beg (point))
13527 (setq sum-props (get-text-property (point) 'org-summaries))
13528 (setq clocksum (get-text-property (point) :org-clock-minutes))
13529 (outline-next-heading)
13530 (setq end (point))
13531 (when (memq which '(all special))
13532 ;; Get the special properties, like TODO and tags
13533 (goto-char beg)
13534 (when (and (or (not specific) (string= specific "TODO"))
13535 (looking-at org-todo-line-regexp) (match-end 2))
13536 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13537 (when (and (or (not specific) (string= specific "PRIORITY"))
13538 (looking-at org-priority-regexp))
13539 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13540 (when (or (not specific) (string= specific "FILE"))
13541 (push (cons "FILE" buffer-file-name) props))
13542 (when (and (or (not specific) (string= specific "TAGS"))
13543 (setq value (org-get-tags-string))
13545 (push (cons "TAGS" value) props))
13546 (when (and (or (not specific) (string= specific "ALLTAGS"))
13547 (setq value (org-get-tags-at)))
13548 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13549 ":"))
13550 props))
13551 (when (or (not specific) (string= specific "BLOCKED"))
13552 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13553 (when (or (not specific)
13554 (member specific
13555 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13556 "TIMESTAMP" "TIMESTAMP_IA")))
13557 (catch 'match
13558 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13559 (setq key (if (match-end 1)
13560 (substring (org-match-string-no-properties 1)
13561 0 -1))
13562 string (if (equal key clockstr)
13563 (org-no-properties
13564 (org-trim
13565 (buffer-substring
13566 (match-beginning 3) (goto-char
13567 (point-at-eol)))))
13568 (substring (org-match-string-no-properties 3)
13569 1 -1)))
13570 ;; Get the correct property name from the key. This is
13571 ;; necessary if the user has configured time keywords.
13572 (setq key1 (concat key ":"))
13573 (cond
13574 ((not key)
13575 (setq key
13576 (if (= (char-after (match-beginning 3)) ?\[)
13577 "TIMESTAMP_IA" "TIMESTAMP")))
13578 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13579 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13580 ((equal key1 org-closed-string) (setq key "CLOSED"))
13581 ((equal key1 org-clock-string) (setq key "CLOCK")))
13582 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13583 (progn
13584 (push (cons key string) props)
13585 ;; no need to search further if match is found
13586 (throw 'match t))
13587 (when (or (equal key "CLOCK") (not (assoc key props)))
13588 (push (cons key string) props))))))
13589 )
13591 (when (memq which '(all standard))
13592 ;; Get the standard properties, like :PROP: ...
13593 (setq range (org-get-property-block beg end))
13594 (when range
13595 (goto-char (car range))
13596 (while (re-search-forward
13598 (cdr range) t)
13599 (setq key (org-match-string-no-properties 1)
13600 value (org-trim (or (org-match-string-no-properties 2) "")))
13601 (unless (member key excluded)
13602 (push (cons key (or value "")) props)))))
13603 (if clocksum
13604 (push (cons "CLOCKSUM"
13605 (org-columns-number-to-string (/ (float clocksum) 60.)
13606 'add_times))
13607 props))
13608 (unless (assoc "CATEGORY" props)
13609 (push (cons "CATEGORY" (org-get-category)) props))
13610 (append sum-props (nreverse props)))))))
13612 (defun org-entry-get (pom property &optional inherit literal-nil)
13613 "Get value of PROPERTY for entry at point-or-marker POM.
13614 If INHERIT is non-nil and the entry does not have the property,
13615 then also check higher levels of the hierarchy.
13616 If INHERIT is the symbol `selective', use inheritance only if the setting
13617 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13618 If the property is present but empty, the return value is the empty string.
13619 If the property is not present at all, nil is returned.
13622 do not interpret it as the list atom nil. This is used for inheritance
13624 (org-with-point-at pom
13625 (if (and inherit (if (eq inherit 'selective)
13626 (org-property-inherit-p property)
13627 t))
13628 (org-entry-get-with-inheritance property literal-nil)
13629 (if (member property org-special-properties)
13630 ;; We need a special property. Use `org-entry-properties' to
13631 ;; retrieve it, but specify the wanted property
13632 (cdr (assoc property (org-entry-properties nil 'special property)))
13633 (let ((range (unless (org-before-first-heading-p)
13634 (org-get-property-block))))
13635 (if (and range
13636 (goto-char (car range))
13637 (re-search-forward
13639 (cdr range) t))
13640 ;; Found the property, return it.
13641 (if (match-end 1)
13642 (if literal-nil
13643 (org-match-string-no-properties 1)
13644 (org-not-nil (org-match-string-no-properties 1)))
13645 "")))))))
13647 (defun org-property-or-variable-value (var &optional inherit)
13648 "Check if there is a property fixing the value of VAR.
13649 If yes, return this value. If not, return the current value of the variable."
13650 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13652 (read prop)
13653 (symbol-value var))))
13655 (defun org-entry-delete (pom property)
13656 "Delete the property PROPERTY from entry at point-or-marker POM."
13657 (org-with-point-at pom
13658 (if (member property org-special-properties)
13659 nil ; cannot delete these properties.
13660 (let ((range (org-get-property-block)))
13661 (if (and range
13662 (goto-char (car range))
13663 (re-search-forward
13665 (cdr range) t))
13666 (progn
13667 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13668 t)
13669 nil)))))
13671 ;; Multi-values properties are properties that contain multiple values
13672 ;; These values are assumed to be single words, separated by whitespace.
13673 (defun org-entry-add-to-multivalued-property (pom property value)
13674 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13675 (let* ((old (org-entry-get pom property))
13677 (setq value (org-entry-protect-space value))
13678 (unless (member value values)
13679 (setq values (cons value values))
13680 (org-entry-put pom property
13681 (mapconcat 'identity values " ")))))
13683 (defun org-entry-remove-from-multivalued-property (pom property value)
13684 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13685 (let* ((old (org-entry-get pom property))
13687 (setq value (org-entry-protect-space value))
13688 (when (member value values)
13689 (setq values (delete value values))
13690 (org-entry-put pom property
13691 (mapconcat 'identity values " ")))))
13693 (defun org-entry-member-in-multivalued-property (pom property value)
13694 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13695 (let* ((old (org-entry-get pom property))
13697 (setq value (org-entry-protect-space value))
13698 (member value values)))
13700 (defun org-entry-get-multivalued-property (pom property)
13701 "Return a list of values in a multivalued property."
13702 (let* ((value (org-entry-get pom property))
13704 (mapcar 'org-entry-restore-space values)))
13706 (defun org-entry-put-multivalued-property (pom property &rest values)
13707 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13708 VALUES should be a list of strings. Spaces will be protected."
13709 (org-entry-put pom property
13710 (mapconcat 'org-entry-protect-space values " "))
13711 (let* ((value (org-entry-get pom property))
13713 (mapcar 'org-entry-restore-space values)))
13715 (defun org-entry-protect-space (s)
13716 "Protect spaces and newline in string S."
13717 (while (string-match " " s)
13718 (setq s (replace-match "%20" t t s)))
13720 (setq s (replace-match "%0A" t t s)))
13721 s)
13723 (defun org-entry-restore-space (s)
13724 "Restore spaces and newline in string S."
13725 (while (string-match "%20" s)
13726 (setq s (replace-match " " t t s)))
13727 (while (string-match "%0A" s)
13729 s)
13731 (defvar org-entry-property-inherited-from (make-marker)
13732 "Marker pointing to the entry from where a property was inherited.
13733 Each call to `org-entry-get-with-inheritance' will set this marker to the
13734 location of the entry where the inheritance search matched. If there was
13735 no match, the marker will point nowhere.
13736 Note that also `org-entry-get' calls this function, if the INHERIT flag
13737 is set.")
13739 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13740 "Get entry property, and search higher levels if not present.
13741 The search will stop at the first ancestor which has the property defined.
13743 should be considered as undefined (this is the meaning of nil here).
13745 (move-marker org-entry-property-inherited-from nil)
13746 (let (tmp)
13747 (unless (org-before-first-heading-p)
13748 (save-excursion
13749 (save-restriction
13750 (widen)
13751 (catch 'ex
13752 (while t
13753 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13754 (org-back-to-heading t)
13755 (move-marker org-entry-property-inherited-from (point))
13756 (throw 'ex tmp))
13757 (or (org-up-heading-safe) (throw 'ex nil)))))))
13758 (setq tmp (or tmp
13759 (cdr (assoc property org-file-properties))
13760 (cdr (assoc property org-global-properties))
13761 (cdr (assoc property org-global-properties-fixed))))
13762 (if literal-nil tmp (org-not-nil tmp))))
13764 (defvar org-property-changed-functions nil
13765 "Hook called when the value of a property has changed.
13766 Each hook function should accept two arguments, the name of the property
13767 and the new value.")
13769 (defun org-entry-put (pom property value)
13770 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13771 (org-with-point-at pom
13772 (org-back-to-heading t)
13773 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13774 range)
13775 (cond
13776 ((equal property "TODO")
13778 (not (member value org-todo-keywords-1)))
13780 (if (or (not value)
13782 (setq value 'none))
13783 (org-todo value)
13784 (org-set-tags nil 'align))
13785 ((equal property "PRIORITY")
13787 (string-to-char value) ?\ ))
13788 (org-set-tags nil 'align))
13789 ((equal property "SCHEDULED")
13790 (if (re-search-forward org-scheduled-time-regexp end t)
13791 (cond
13792 ((eq value 'earlier) (org-timestamp-change -1 'day))
13793 ((eq value 'later) (org-timestamp-change 1 'day))
13794 (t (call-interactively 'org-schedule)))
13795 (call-interactively 'org-schedule)))
13796 ((equal property "DEADLINE")
13797 (if (re-search-forward org-deadline-time-regexp end t)
13798 (cond
13799 ((eq value 'earlier) (org-timestamp-change -1 'day))
13800 ((eq value 'later) (org-timestamp-change 1 'day))
13801 (t (call-interactively 'org-deadline)))
13802 (call-interactively 'org-deadline)))
13803 ((member property org-special-properties)
13804 (error "The %s property can not yet be set with `org-entry-put'"
13805 property))
13806 (t ; a non-special property
13807 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13808 (setq range (org-get-property-block beg end 'force))
13809 (goto-char (car range))
13810 (if (re-search-forward
13812 (progn
13813 (delete-region (match-beginning 1) (match-end 1))
13814 (goto-char (match-beginning 1)))
13815 (goto-char (cdr range))
13817 (backward-char 1)
13818 (org-indent-line-function)
13819 (insert ":" property ":"))
13820 (and value (insert " " value))
13821 (org-indent-line-function)))))
13822 (run-hook-with-args 'org-property-changed-functions property value)))
13824 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13825 "Get all property keys in the current buffer.
13826 With INCLUDE-SPECIALS, also list the special properties that reflect things
13827 like tags and TODO state.
13828 With INCLUDE-DEFAULTS, also include properties that has special meaning
13829 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13830 With INCLUDE-COLUMNS, also include property names given in COLUMN
13831 formats in the current buffer."
13832 (let (rtn range cfmt s p)
13833 (save-excursion
13834 (save-restriction
13835 (widen)
13836 (goto-char (point-min))
13837 (while (re-search-forward org-property-start-re nil t)
13838 (setq range (org-get-property-block))
13839 (goto-char (car range))
13840 (while (re-search-forward
13842 (cdr range) t)
13843 (add-to-list 'rtn (org-match-string-no-properties 1)))
13844 (outline-next-heading))))
13846 (when include-specials
13847 (setq rtn (append org-special-properties rtn)))
13849 (when include-defaults
13850 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13851 (add-to-list 'rtn org-effort-property))
13853 (when include-columns
13854 (save-excursion
13855 (save-restriction
13856 (widen)
13857 (goto-char (point-min))
13858 (while (re-search-forward
13860 nil t)
13861 (setq cfmt (match-string 2) s 0)
13863 cfmt s)
13864 (setq s (match-end 0)
13865 p (match-string 1 cfmt))
13866 (unless (or (equal p "ITEM")
13867 (member p org-special-properties))
13868 (add-to-list 'rtn (match-string 1 cfmt))))))))
13870 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13872 (defun org-property-values (key)
13873 "Return a list of all values of property KEY."
13874 (save-excursion
13875 (save-restriction
13876 (widen)
13877 (goto-char (point-min))
13879 values)
13880 (while (re-search-forward re nil t)
13881 (add-to-list 'values (org-trim (match-string 1))))
13882 (delete "" values)))))
13884 (defun org-insert-property-drawer ()
13885 "Insert a property drawer into the current entry."
13886 (interactive)
13887 (org-back-to-heading t)
13888 (looking-at outline-regexp)
13889 (let ((indent (if org-adapt-indentation
13890 (- (match-end 0)(match-beginning 0))
13891 0))
13892 (beg (point))
13894 end hiddenp)
13895 (outline-next-heading)
13896 (setq end (point))
13897 (goto-char beg)
13898 (while (re-search-forward re end t))
13899 (setq hiddenp (outline-invisible-p))
13900 (end-of-line 1)
13903 (if (member (match-string 1) '("CLOCK:" ":END:"))
13904 ;; just skip this line
13905 (beginning-of-line 2)
13906 ;; Drawer start, find the end
13908 (beginning-of-line 1)))
13909 (org-skip-over-state-notes)
13911 (if (eq (char-before) ?*) (forward-char 1))
13913 (beginning-of-line 0)
13914 (org-indent-to-column indent)
13915 (beginning-of-line 2)
13916 (org-indent-to-column indent)
13917 (beginning-of-line 0)
13918 (if hiddenp
13919 (save-excursion
13920 (org-back-to-heading t)
13921 (hide-entry))
13922 (org-flag-drawer t))))
13924 (defvar org-property-set-functions-alist nil
13925 "Property set function alist.
13926 Each entry should have the following format:
13928 (PROPERTY . READ-FUNCTION)
13930 The read function will be called with the same argument as
13931 `org-completing-read.")
13933 (defun org-set-property-function (property)
13934 "Get the function that should be used to set PROPERTY.
13935 This is computed according to `org-property-set-functions-alist'."
13936 (or (cdr (assoc property org-property-set-functions-alist))
13937 'org-completing-read))
13939 (defun org-read-property-value (property)
13940 "Read PROPERTY value from user."
13941 (let* ((completion-ignore-case t)
13942 (allowed (org-property-get-allowed-values nil property 'table))
13943 (cur (org-entry-get nil property))
13944 (prompt (concat property " value"
13946 (concat " [" cur "]") "") ": "))
13947 (set-function (org-set-property-function property))
13948 (val (if allowed
13949 (funcall set-function prompt allowed nil
13950 (not (get-text-property 0 'org-unrestricted
13951 (caar allowed))))
13952 (let (org-completion-use-ido org-completion-use-iswitchb)
13953 (funcall set-function prompt
13954 (mapcar 'list (org-property-values property))
13955 nil nil "" nil cur)))))
13956 (if (equal val "")
13957 cur
13958 val)))
13960 (defun org-read-property-name ()
13961 "Read a property name."
13962 (let* ((completion-ignore-case t)
13963 (keys (org-buffer-property-keys nil t t))
13964 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
13965 (if (member property keys)
13966 property
13967 (or (cdr (assoc (downcase property)
13968 (mapcar (lambda (x) (cons (downcase x) x))
13969 keys)))
13970 property))))
13972 (defun org-set-property (property value)
13973 "In the current entry, set PROPERTY to VALUE.
13974 When called interactively, this will prompt for a property name, offering
13975 completion on existing and default properties. And then it will prompt
13976 for a value, offering completion either on allowed values (via an inherited
13977 xxx_ALL property) or on existing values in other instances of this property
13978 in the current file."
13979 (interactive (list nil nil))
13980 (let* ((property (or property (org-read-property-name)))
13981 (value (or value (org-read-property-value property))))
13982 (unless (equal (org-entry-get nil property) value)
13983 (org-entry-put nil property value))))
13985 (defun org-delete-property (property)
13986 "In the current entry, delete PROPERTY."
13987 (interactive
13988 (let* ((completion-ignore-case t)
13989 (prop (org-icompleting-read "Property: "
13990 (org-entry-properties nil 'standard))))
13991 (list prop)))
13992 (message "Property %s %s" property
13993 (if (org-entry-delete nil property)
13994 "deleted"
13995 "was not present in the entry")))
13997 (defun org-delete-property-globally (property)
13998 "Remove PROPERTY globally, from all entries."
13999 (interactive
14000 (let* ((completion-ignore-case t)
14001 (prop (org-icompleting-read
14002 "Globally remove property: "
14003 (mapcar 'list (org-buffer-property-keys)))))
14004 (list prop)))
14005 (save-excursion
14006 (save-restriction
14007 (widen)
14008 (goto-char (point-min))
14009 (let ((cnt 0))
14010 (while (re-search-forward
14012 nil t)
14013 (setq cnt (1+ cnt))
14014 (replace-match ""))
14017 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14019 (defun org-compute-property-at-point ()
14020 "Compute the property at point.
14021 This looks for an enclosing column format, extracts the operator and
14022 then applies it to the property in the column format's scope."
14023 (interactive)
14024 (unless (org-at-property-p)
14025 (error "Not at a property"))
14026 (let ((prop (org-match-string-no-properties 2)))
14027 (org-columns-get-format-and-top-level)
14028 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14029 (error "No operator defined for property %s" prop))
14030 (org-columns-compute prop)))
14032 (defvar org-property-allowed-value-functions nil
14033 "Hook for functions supplying allowed values for a specific property.
14034 The functions must take a single argument, the name of the property, and
14036 the values, this means that these values are intended as defaults for
14037 completion, but that other values should be allowed too.
14038 The functions must return nil if they are not responsible for this
14039 property.")
14041 (defun org-property-get-allowed-values (pom property &optional table)
14042 "Get allowed values for the property PROPERTY.
14043 When TABLE is non-nil, return an alist that can directly be used for
14044 completion."
14045 (let (vals)
14046 (cond
14047 ((equal property "TODO")
14048 (setq vals (org-with-point-at pom
14049 (append org-todo-keywords-1 '("")))))
14050 ((equal property "PRIORITY")
14051 (let ((n org-lowest-priority))
14052 (while (>= n org-highest-priority)
14053 (push (char-to-string n) vals)
14054 (setq n (1- n)))))
14055 ((member property org-special-properties))
14056 ((setq vals (run-hook-with-args-until-success
14057 'org-property-allowed-value-functions property)))
14058 (t
14059 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14061 (setq vals (car (read-from-string (concat "(" vals ")"))))
14062 (setq vals (mapcar (lambda (x)
14063 (cond ((stringp x) x)
14064 ((numberp x) (number-to-string x))
14065 ((symbolp x) (symbol-name x))
14066 (t "???")))
14067 vals)))))
14068 (when (member ":ETC" vals)
14069 (setq vals (remove ":ETC" vals))
14070 (org-add-props (car vals) '(org-unrestricted t)))
14071 (if table (mapcar 'list vals) vals)))
14073 (defun org-property-previous-allowed-value (&optional previous)
14074 "Switch to the next allowed value for this property."
14075 (interactive)
14076 (org-property-next-allowed-value t))
14078 (defun org-property-next-allowed-value (&optional previous)
14079 "Switch to the next allowed value for this property."
14080 (interactive)
14081 (unless (org-at-property-p)
14082 (error "Not at a property"))
14083 (let* ((key (match-string 2))
14084 (value (match-string 3))
14085 (allowed (or (org-property-get-allowed-values (point) key)
14086 (and (member value '("[ ]" "[-]" "[X]"))
14087 '("[ ]" "[X]"))))
14088 nval)
14089 (unless allowed
14090 (error "Allowed values for this property have not been defined"))
14091 (if previous (setq allowed (reverse allowed)))
14092 (if (member value allowed)
14093 (setq nval (car (cdr (member value allowed)))))
14094 (setq nval (or nval (car allowed)))
14095 (if (equal nval value)
14096 (error "Only one allowed value for this property"))
14097 (org-at-property-p)
14098 (replace-match (concat " :" key ": " nval) t t)
14099 (org-indent-line-function)
14100 (beginning-of-line 1)
14102 (run-hook-with-args 'org-property-changed-functions key nval)))
14104 (defun org-find-olp (path &optional this-buffer)
14105 "Return a marker pointing to the entry at outline path OLP.
14106 If anything goes wrong, throw an error.
14107 You can wrap this call to catch the error like this:
14109 (condition-case msg
14110 (org-mobile-locate-entry (match-string 4))
14111 (error (nth 1 msg)))
14113 The return value will then be either a string with the error message,
14114 or a marker if everything is OK.
14116 If THIS-BUFFER is set, the outline path does not contain a file,
14117 only headings."
14118 (let* ((file (if this-buffer buffer-file-name (pop path)))
14119 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14120 (level 1)
14121 (lmin 1)
14122 (lmax 1)
14123 limit re end found pos heading cnt)
14124 (unless buffer (error "File not found :%s" file))
14125 (with-current-buffer buffer
14126 (save-excursion
14127 (save-restriction
14128 (widen)
14129 (setq limit (point-max))
14130 (goto-char (point-min))
14131 (while (setq heading (pop path))
14132 (setq re (format org-complex-heading-regexp-format
14133 (regexp-quote heading)))
14134 (setq cnt 0 pos (point))
14135 (while (re-search-forward re end t)
14136 (setq level (- (match-end 1) (match-beginning 1)))
14137 (if (and (>= level lmin) (<= level lmax))
14138 (setq found (match-beginning 0) cnt (1+ cnt))))
14139 (when (= cnt 0) (error "Heading not found on level %d: %s"
14140 lmax heading))
14141 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14142 lmax heading))
14143 (goto-char found)
14144 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14145 (setq end (save-excursion (org-end-of-subtree t t))))
14146 (when (org-on-heading-p)
14147 (move-marker (make-marker) (point))))))))
14149 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14150 "Find node HEADING in BUFFER.
14151 Return a marker to the heading if it was found, or nil if not.
14152 If POS-ONLY is set, return just the position instead of a marker.
14154 The heading text must match exact, but it may have a TODO keyword,
14155 a priority cookie and tags in the standard locations."
14156 (with-current-buffer (or buffer (current-buffer))
14157 (save-excursion
14158 (save-restriction
14159 (widen)
14160 (goto-char (point-min))
14161 (let (case-fold-search)
14162 (if (re-search-forward
14163 (format org-complex-heading-regexp-format
14164 (regexp-quote heading)) nil t)
14165 (if pos-only
14166 (match-beginning 0)
14167 (move-marker (make-marker) (match-beginning 0)))))))))
14169 (defun org-find-exact-heading-in-directory (heading &optional dir)
14170 "Find Org node headline HEADING in all .org files in directory DIR.
14171 When the target headline is found, return a marker to this location."
14172 (let ((files (directory-files (or dir default-directory)
14174 file visiting m buffer)
14175 (catch 'found
14176 (while (setq file (pop files))
14177 (message "trying %s" file)
14178 (setq visiting (org-find-base-buffer-visiting file))
14179 (setq buffer (or visiting (find-file-noselect file)))
14180 (setq m (org-find-exact-headline-in-buffer
14181 heading buffer))
14182 (when (and (not m) (not visiting)) (kill-buffer buffer))
14183 (and m (throw 'found m))))))
14185 (defun org-find-entry-with-id (ident)
14186 "Locate the entry that contains the ID property with exact value IDENT.
14187 IDENT can be a string, a symbol or a number, this function will search for
14188 the string representation of it.
14189 Return the position where this entry starts, or nil if there is no such entry."
14190 (interactive "sID: ")
14191 (let ((id (cond
14192 ((stringp ident) ident)
14193 ((symbol-name ident) (symbol-name ident))
14194 ((numberp ident) (number-to-string ident))
14195 (t (error "IDENT %s must be a string, symbol or number" ident))))
14196 (case-fold-search nil))
14197 (save-excursion
14198 (save-restriction
14199 (widen)
14200 (goto-char (point-min))
14201 (when (re-search-forward
14203 nil t)
14204 (org-back-to-heading t)
14205 (point))))))
14207 ;;;; Timestamps
14209 (defvar org-last-changed-timestamp nil)
14210 (defvar org-last-inserted-timestamp nil
14211 "The last time stamp inserted with `org-insert-time-stamp'.")
14212 (defvar org-time-was-given) ; dynamically scoped parameter
14213 (defvar org-end-time-was-given) ; dynamically scoped parameter
14214 (defvar org-ts-what) ; dynamically scoped parameter
14216 (defun org-time-stamp (arg &optional inactive)
14217 "Prompt for a date/time and insert a time stamp.
14218 If the user specifies a time like HH:MM, or if this command is called
14219 with a prefix argument, the time stamp will contain date and time.
14220 Otherwise, only the date will be included. All parts of a date not
14221 specified by the user will be filled in from the current date/time.
14222 So if you press just return without typing anything, the time stamp
14223 will represent the current date/time. If there is already a timestamp
14224 at the cursor, it will be modified."
14225 (interactive "P")
14226 (let* ((ts nil)
14227 (default-time
14228 ;; Default time is either today, or, when entering a range,
14229 ;; the range start.
14230 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14231 (save-excursion
14232 (re-search-backward
14234 (- (point) 20) t)))
14235 (apply 'encode-time (org-parse-time-string (match-string 1)))
14236 (current-time)))
14237 (default-input (and ts (org-get-compact-tod ts)))
14238 org-time-was-given org-end-time-was-given time)
14239 (cond
14240 ((and (org-at-timestamp-p t)
14241 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14242 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14243 (insert "--")
14244 (setq time (let ((this-command this-command))
14245 (org-read-date arg 'totime nil nil
14246 default-time default-input)))
14247 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14248 ((org-at-timestamp-p t)
14249 (setq time (let ((this-command this-command))
14250 (org-read-date arg 'totime nil nil default-time default-input)))
14251 (when (org-at-timestamp-p t) ; just to get the match data
14252 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14253 (replace-match "")
14254 (setq org-last-changed-timestamp
14255 (org-insert-time-stamp
14256 time (or org-time-was-given arg)
14257 inactive nil nil (list org-end-time-was-given))))
14258 (message "Timestamp updated"))
14259 (t
14260 (setq time (let ((this-command this-command))
14261 (org-read-date arg 'totime nil nil default-time default-input)))
14262 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14263 nil nil (list org-end-time-was-given))))))
14265 ;; FIXME: can we use this for something else, like computing time differences?
14266 (defun org-get-compact-tod (s)
14267 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14268 (let* ((t1 (match-string 1 s))
14269 (h1 (string-to-number (match-string 2 s)))
14270 (m1 (string-to-number (match-string 3 s)))
14271 (t2 (and (match-end 4) (match-string 5 s)))
14272 (h2 (and t2 (string-to-number (match-string 6 s))))
14273 (m2 (and t2 (string-to-number (match-string 7 s))))
14274 dh dm)
14275 (if (not t2)
14276 t1
14277 (setq dh (- h2 h1) dm (- m2 m1))
14278 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14279 (concat t1 "+" (number-to-string dh)
14280 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14282 (defun org-time-stamp-inactive (&optional arg)
14283 "Insert an inactive time stamp.
14284 An inactive time stamp is enclosed in square brackets instead of angle
14285 brackets. It is inactive in the sense that it does not trigger agenda entries,
14286 does not link to the calendar and cannot be changed with the S-cursor keys.
14287 So these are more for recording a certain time/date."
14288 (interactive "P")
14289 (org-time-stamp arg 'inactive))
14291 (defvar org-date-ovl (make-overlay 1 1))
14292 (overlay-put org-date-ovl 'face 'org-warning)
14293 (org-detach-overlay org-date-ovl)
14295 (defvar org-ans1) ; dynamically scoped parameter
14296 (defvar org-ans2) ; dynamically scoped parameter
14298 (defvar org-plain-time-of-day-regexp) ; defined below
14300 (defvar org-overriding-default-time nil) ; dynamically scoped
14301 (defvar org-read-date-overlay nil)
14302 (defvar org-dcst nil) ; dynamically scoped
14303 (defvar org-read-date-history nil)
14304 (defvar org-read-date-final-answer nil)
14306 (defun org-read-date (&optional with-time to-time from-string prompt
14307 default-time default-input)
14308 "Read a date, possibly a time, and make things smooth for the user.
14309 The prompt will suggest to enter an ISO date, but you can also enter anything
14310 which will at least partially be understood by `parse-time-string'.
14311 Unrecognized parts of the date will default to the current day, month, year,
14312 hour and minute. If this command is called to replace a timestamp at point,
14313 of to enter the second timestamp of a range, the default time is taken
14314 from the existing stamp. Furthermore, the command prefers the future,
14315 so if you are giving a date where the year is not given, and the day-month
14316 combination is already past in the current year, it will assume you
14317 mean next year. For details, see the manual. A few examples:
14319 3-2-5 --> 2003-02-05
14320 feb 15 --> currentyear-02-15
14321 2/15 --> currentyear-02-15
14322 sep 12 9 --> 2009-09-12
14323 12:45 --> today 12:45
14324 22 sept 0:34 --> currentyear-09-22 0:34
14325 12 --> currentyear-currentmonth-12
14326 Fri --> nearest Friday (today or later)
14327 etc.
14329 Furthermore you can specify a relative date by giving, as the *first* thing
14330 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14331 change in days weeks, months, years.
14332 With a single plus or minus, the date is relative to today. With a double
14333 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14334 +4d --> four days from today
14335 +4 --> same as above
14336 +2w --> two weeks from today
14337 ++5 --> five days from default date
14339 The function understands only English month and weekday abbreviations,
14340 but this can be configured with the variables `parse-time-months' and
14341 `parse-time-weekdays'.
14343 While prompting, a calendar is popped up - you can also select the
14344 date with the mouse (button 1). The calendar shows a period of three
14345 months. To scroll it to other months, use the keys `>' and `<'.
14346 If you don't like the calendar, turn it off with
14347 \(setq org-read-date-popup-calendar nil)
14349 With optional argument TO-TIME, the date will immediately be converted
14350 to an internal time.
14351 With an optional argument WITH-TIME, the prompt will suggest to also
14352 insert a time. Note that when WITH-TIME is not set, you can still
14353 enter a time, and this function will inform the calling routine about
14354 this change. The calling routine may then choose to change the format
14355 used to insert the time stamp into the buffer to include the time.
14356 With optional argument FROM-STRING, read from this string instead from
14357 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14358 the time/date that is used for everything that is not specified by the
14359 user."
14360 (require 'parse-time)
14361 (let* ((org-time-stamp-rounding-minutes
14362 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14363 (org-dcst org-display-custom-times)
14364 (ct (org-current-time))
14365 (def (or org-overriding-default-time default-time ct))
14366 (defdecode (decode-time def))
14367 (dummy (progn
14368 (when (< (nth 2 defdecode) org-extend-today-until)
14369 (setcar (nthcdr 2 defdecode) -1)
14370 (setcar (nthcdr 1 defdecode) 59)
14371 (setq def (apply 'encode-time defdecode)
14372 defdecode (decode-time def)))))
14373 (calendar-frame-setup nil)
14374 (calendar-setup nil)
14375 (calendar-move-hook nil)
14376 (calendar-view-diary-initially-flag nil)
14377 (calendar-view-holidays-initially-flag nil)
14378 (timestr (format-time-string
14379 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14380 (prompt (concat (if prompt (concat prompt " ") "")
14381 (format "Date+time [%s]: " timestr)))
14382 ans (org-ans0 "") org-ans1 org-ans2 final)
14384 (cond
14385 (from-string (setq ans from-string))
14386 (org-read-date-popup-calendar
14387 (save-excursion
14388 (save-window-excursion
14389 (calendar)
14390 (calendar-forward-day (- (time-to-days def)
14391 (calendar-absolute-from-gregorian
14392 (calendar-current-date))))
14393 (org-eval-in-calendar nil t)
14394 (let* ((old-map (current-local-map))
14395 (map (copy-keymap calendar-mode-map))
14396 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14397 (org-defkey map (kbd "RET") 'org-calendar-select)
14398 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14399 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14400 (org-defkey minibuffer-local-map [(meta shift left)]
14401 (lambda () (interactive)
14402 (org-eval-in-calendar '(calendar-backward-month 1))))
14403 (org-defkey minibuffer-local-map [(meta shift right)]
14404 (lambda () (interactive)
14405 (org-eval-in-calendar '(calendar-forward-month 1))))
14406 (org-defkey minibuffer-local-map [(meta shift up)]
14407 (lambda () (interactive)
14408 (org-eval-in-calendar '(calendar-backward-year 1))))
14409 (org-defkey minibuffer-local-map [(meta shift down)]
14410 (lambda () (interactive)
14411 (org-eval-in-calendar '(calendar-forward-year 1))))
14412 (org-defkey minibuffer-local-map [?\e (shift left)]
14413 (lambda () (interactive)
14414 (org-eval-in-calendar '(calendar-backward-month 1))))
14415 (org-defkey minibuffer-local-map [?\e (shift right)]
14416 (lambda () (interactive)
14417 (org-eval-in-calendar '(calendar-forward-month 1))))
14418 (org-defkey minibuffer-local-map [?\e (shift up)]
14419 (lambda () (interactive)
14420 (org-eval-in-calendar '(calendar-backward-year 1))))
14421 (org-defkey minibuffer-local-map [?\e (shift down)]
14422 (lambda () (interactive)
14423 (org-eval-in-calendar '(calendar-forward-year 1))))
14424 (org-defkey minibuffer-local-map [(shift up)]
14425 (lambda () (interactive)
14426 (org-eval-in-calendar '(calendar-backward-week 1))))
14427 (org-defkey minibuffer-local-map [(shift down)]
14428 (lambda () (interactive)
14429 (org-eval-in-calendar '(calendar-forward-week 1))))
14430 (org-defkey minibuffer-local-map [(shift left)]
14431 (lambda () (interactive)
14432 (org-eval-in-calendar '(calendar-backward-day 1))))
14433 (org-defkey minibuffer-local-map [(shift right)]
14434 (lambda () (interactive)
14435 (org-eval-in-calendar '(calendar-forward-day 1))))
14436 (org-defkey minibuffer-local-map ">"
14437 (lambda () (interactive)
14438 (org-eval-in-calendar '(scroll-calendar-left 1))))
14439 (org-defkey minibuffer-local-map "<"
14440 (lambda () (interactive)
14441 (org-eval-in-calendar '(scroll-calendar-right 1))))
14442 (org-defkey minibuffer-local-map "\C-v"
14443 (lambda () (interactive)
14444 (org-eval-in-calendar
14445 '(calendar-scroll-left-three-months 1))))
14446 (org-defkey minibuffer-local-map "\M-v"
14447 (lambda () (interactive)
14448 (org-eval-in-calendar
14449 '(calendar-scroll-right-three-months 1))))
14450 (run-hooks 'org-read-date-minibuffer-setup-hook)
14451 (unwind-protect
14452 (progn
14453 (use-local-map map)
14454 (add-hook 'post-command-hook 'org-read-date-display)
14455 (setq org-ans0 (read-string prompt default-input
14456 'org-read-date-history nil))
14457 ;; org-ans0: from prompt
14458 ;; org-ans1: from mouse click
14459 ;; org-ans2: from calendar motion
14460 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14461 (remove-hook 'post-command-hook 'org-read-date-display)
14462 (use-local-map old-map)
14463 (when org-read-date-overlay
14464 (delete-overlay org-read-date-overlay)
14465 (setq org-read-date-overlay nil)))))))
14467 (t ; Naked prompt only
14468 (unwind-protect
14469 (setq ans (read-string prompt default-input
14470 'org-read-date-history timestr))
14471 (when org-read-date-overlay
14472 (delete-overlay org-read-date-overlay)
14473 (setq org-read-date-overlay nil)))))
14475 (setq final (org-read-date-analyze ans def defdecode))
14477 ;; One round trip to get rid of 34th of August and stuff like that....
14478 (setq final (decode-time (apply 'encode-time final)))
14480 (setq org-read-date-final-answer ans)
14482 (if to-time
14483 (apply 'encode-time final)
14484 (if (and (boundp 'org-time-was-given) org-time-was-given)
14485 (format "%04d-%02d-%02d %02d:%02d"
14486 (nth 5 final) (nth 4 final) (nth 3 final)
14487 (nth 2 final) (nth 1 final))
14488 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14490 (defvar def)
14491 (defvar defdecode)
14492 (defvar with-time)
14493 (defvar org-read-date-analyze-futurep nil)
14494 (defun org-read-date-display ()
14495 "Display the current date prompt interpretation in the minibuffer."
14496 (when org-read-date-display-live
14497 (when org-read-date-overlay
14498 (delete-overlay org-read-date-overlay))
14499 (let ((p (point)))
14500 (end-of-line 1)
14501 (while (not (equal (buffer-substring
14502 (max (point-min) (- (point) 4)) (point))
14503 " "))
14504 (insert " "))
14505 (goto-char p))
14506 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14507 " " (or org-ans1 org-ans2)))
14508 (org-end-time-was-given nil)
14509 (f (org-read-date-analyze ans def defdecode))
14510 (fmts (if org-dcst
14511 org-time-stamp-custom-formats
14512 org-time-stamp-formats))
14513 (fmt (if (or with-time
14514 (and (boundp 'org-time-was-given) org-time-was-given))
14515 (cdr fmts)
14516 (car fmts)))
14517 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14518 (when (and org-end-time-was-given
14519 (string-match org-plain-time-of-day-regexp txt))
14520 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14521 org-end-time-was-given
14522 (substring txt (match-end 0)))))
14523 (when org-read-date-analyze-futurep
14524 (setq txt (concat txt " (=>F)")))
14525 (setq org-read-date-overlay
14526 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14527 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14529 (defun org-read-date-analyze (ans def defdecode)
14530 "Analyze the combined answer of the date prompt."
14531 ;; FIXME: cleanup and comment
14532 (let ((nowdecode (decode-time (current-time)))
14533 delta deltan deltaw deltadef year month day
14534 hour minute second wday pm h2 m2 tl wday1
14535 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14536 (setq org-read-date-analyze-futurep nil)
14538 (setq ans "+0"))
14540 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14541 (setq ans (replace-match "" t t ans)
14542 deltan (car delta)
14543 deltaw (nth 1 delta)
14544 deltadef (nth 2 delta)))
14546 ;; Check if there is an iso week date in there
14547 ;; If yes, store the info and postpone interpreting it until the rest
14548 ;; of the parsing is done
14549 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14550 (setq iso-year (if (match-end 1)
14551 (org-small-year-to-year
14552 (string-to-number (match-string 1 ans))))
14553 iso-weekday (if (match-end 3)
14554 (string-to-number (match-string 3 ans)))
14555 iso-week (string-to-number (match-string 2 ans)))
14556 (setq ans (replace-match "" t t ans)))
14558 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14559 (when (string-match
14561 (setq year (if (match-end 2)
14562 (string-to-number (match-string 2 ans))
14563 (progn (setq kill-year t)
14564 (string-to-number (format-time-string "%Y"))))
14565 month (string-to-number (match-string 3 ans))
14566 day (string-to-number (match-string 4 ans)))
14567 (if (< year 100) (setq year (+ 2000 year)))
14569 t nil ans)))
14570 ;; Help matching american dates, like 5/30 or 5/30/7
14571 (when (string-match
14572 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14573 (setq year (if (match-end 4)
14574 (string-to-number (match-string 4 ans))
14575 (progn (setq kill-year t)
14576 (string-to-number (format-time-string "%Y"))))
14577 month (string-to-number (match-string 1 ans))
14578 day (string-to-number (match-string 2 ans)))
14579 (if (< year 100) (setq year (+ 2000 year)))
14581 t nil ans)))
14582 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14583 ;; If there is a time with am/pm, and *no* time without it, we convert
14584 ;; so that matching will be successful.
14585 (loop for i from 1 to 2 do ; twice, for end time as well
14588 (setq hour (string-to-number (match-string 1 ans))
14589 minute (if (match-end 3)
14590 (string-to-number (match-string 3 ans))
14591 0)
14592 pm (equal ?p
14593 (string-to-char (downcase (match-string 4 ans)))))
14594 (if (and (= hour 12) (not pm))
14595 (setq hour 0)
14596 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14597 (setq ans (replace-match (format "%02d:%02d" hour minute)
14598 t t ans))))
14600 ;; Check if a time range is given as a duration
14601 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14602 (setq hour (string-to-number (match-string 1 ans))
14603 h2 (+ hour (string-to-number (match-string 3 ans)))
14604 minute (string-to-number (match-string 2 ans))
14605 m2 (+ minute (if (match-end 5) (string-to-number
14606 (match-string 5 ans))0)))
14607 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14608 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14609 t t ans)))
14611 ;; Check if there is a time range
14612 (when (boundp 'org-end-time-was-given)
14613 (setq org-time-was-given nil)
14614 (when (and (string-match org-plain-time-of-day-regexp ans)
14615 (match-end 8))
14616 (setq org-end-time-was-given (match-string 8 ans))
14617 (setq ans (concat (substring ans 0 (match-beginning 7))
14618 (substring ans (match-end 7))))))
14620 (setq tl (parse-time-string ans)
14621 day (or (nth 3 tl) (nth 3 defdecode))
14622 month (or (nth 4 tl)
14623 (if (and org-read-date-prefer-future
14624 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14625 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14626 (nth 4 defdecode)))
14627 year (or (and (not kill-year) (nth 5 tl))
14628 (if (and org-read-date-prefer-future
14629 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14630 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14631 (nth 5 defdecode)))
14632 hour (or (nth 2 tl) (nth 2 defdecode))
14633 minute (or (nth 1 tl) (nth 1 defdecode))
14634 second (or (nth 0 tl) 0)
14635 wday (nth 6 tl))
14637 (when (and (eq org-read-date-prefer-future 'time)
14638 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14639 (equal day (nth 3 nowdecode))
14640 (equal month (nth 4 nowdecode))
14641 (equal year (nth 5 nowdecode))
14642 (nth 2 tl)
14643 (or (< (nth 2 tl) (nth 2 nowdecode))
14644 (and (= (nth 2 tl) (nth 2 nowdecode))
14645 (nth 1 tl)
14646 (< (nth 1 tl) (nth 1 nowdecode)))))
14647 (setq day (1+ day)
14648 futurep t))
14650 ;; Special date definitions below
14651 (cond
14652 (iso-week
14653 ;; There was an iso week
14654 (require 'cal-iso)
14655 (setq futurep nil)
14656 (setq year (or iso-year year)
14657 day (or iso-weekday wday 1)
14658 wday nil ; to make sure that the trigger below does not match
14659 iso-date (calendar-gregorian-from-absolute
14660 (calendar-absolute-from-iso
14661 (list iso-week day year))))
14662 ; FIXME: Should we also push ISO weeks into the future?
14663 ; (when (and org-read-date-prefer-future
14664 ; (not iso-year)
14665 ; (< (calendar-absolute-from-gregorian iso-date)
14666 ; (time-to-days (current-time))))
14667 ; (setq year (1+ year)
14668 ; iso-date (calendar-gregorian-from-absolute
14669 ; (calendar-absolute-from-iso
14670 ; (list iso-week day year)))))
14671 (setq month (car iso-date)
14672 year (nth 2 iso-date)
14673 day (nth 1 iso-date)))
14674 (deltan
14675 (setq futurep nil)
14676 (unless deltadef
14677 (let ((now (decode-time (current-time))))
14678 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14679 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14680 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14681 ((equal deltaw "m") (setq month (+ month deltan)))
14682 ((equal deltaw "y") (setq year (+ year deltan)))))
14683 ((and wday (not (nth 3 tl)))
14684 (setq futurep nil)
14685 ;; Weekday was given, but no day, so pick that day in the week
14686 ;; on or after the derived date.
14687 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14688 (unless (equal wday wday1)
14689 (setq day (+ day (% (- wday wday1 -7) 7))))))
14690 (if (and (boundp 'org-time-was-given)
14691 (nth 2 tl))
14692 (setq org-time-was-given t))
14693 (if (< year 100) (setq year (+ 2000 year)))
14694 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14695 (setq org-read-date-analyze-futurep futurep)
14696 (list second minute hour day month year)))
14698 (defvar parse-time-weekdays)
14700 (defun org-read-date-get-relative (s today default)
14701 "Check string S for special relative date string.
14702 TODAY and DEFAULT are internal times, for today and for a default.
14703 Return shift list (N what def-flag)
14705 N is the number of WHATs to shift.
14706 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14707 the DEFAULT date rather than TODAY."
14708 (when (and
14709 (string-match
14710 (concat
14715 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14716 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14717 (string-to-char (substring (match-string 1 s) -1))
14718 ?+))
14719 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14720 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14721 (what (if (match-end 3) (match-string 3 s) "d"))
14722 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14723 (date (if rel default today))
14724 (wday (nth 6 (decode-time date)))
14725 delta)
14726 (if wday1
14727 (progn
14728 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14729 (if (= dir ?-) (setq delta (- delta 7)))
14730 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14731 (list delta "d" rel))
14732 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14734 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14735 "Turn a user-specified date into the internal representation.
14736 The internal representation needed by the calendar is (month day year).
14737 This is a wrapper to handle the brain-dead convention in calendar that
14738 user function argument order change dependent on argument order."
14739 (if (boundp 'calendar-date-style)
14740 (cond
14741 ((eq calendar-date-style 'american)
14742 (list arg1 arg2 arg3))
14743 ((eq calendar-date-style 'european)
14744 (list arg2 arg1 arg3))
14745 ((eq calendar-date-style 'iso)
14746 (list arg2 arg3 arg1)))
14747 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14748 (if (org-bound-and-true-p european-calendar-style)
14749 (list arg2 arg1 arg3)
14750 (list arg1 arg2 arg3)))))
14752 (defun org-eval-in-calendar (form &optional keepdate)
14753 "Eval FORM in the calendar window and return to current window.
14754 Also, store the cursor date in variable org-ans2."
14755 (let ((sf (selected-frame))
14756 (sw (selected-window)))
14757 (select-window (get-buffer-window "*Calendar*" t))
14758 (eval form)
14759 (when (and (not keepdate) (calendar-cursor-to-date))
14760 (let* ((date (calendar-cursor-to-date))
14761 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14762 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14763 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14764 (select-window sw)
14765 (org-select-frame-set-input-focus sf)))
14767 (defun org-calendar-select ()
14768 "Return to `org-read-date' with the date currently selected.
14769 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14770 (interactive)
14771 (when (calendar-cursor-to-date)
14772 (let* ((date (calendar-cursor-to-date))
14773 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14774 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14775 (if (active-minibuffer-window) (exit-minibuffer))))
14777 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14778 "Insert a date stamp for the date given by the internal TIME.
14779 WITH-HM means use the stamp format that includes the time of the day.
14780 INACTIVE means use square brackets instead of angular ones, so that the
14781 stamp will not contribute to the agenda.
14782 PRE and POST are optional strings to be inserted before and after the
14783 stamp.
14784 The command returns the inserted time stamp."
14785 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14786 stamp)
14787 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14788 (insert-before-markers (or pre ""))
14789 (when (listp extra)
14790 (setq extra (car extra))
14791 (if (and (stringp extra)
14793 (setq extra (format "-%02d:%02d"
14794 (string-to-number (match-string 1 extra))
14795 (string-to-number (match-string 2 extra))))
14796 (setq extra nil)))
14797 (when extra
14798 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14799 (insert-before-markers (setq stamp (format-time-string fmt time)))
14800 (insert-before-markers (or post ""))
14801 (setq org-last-inserted-timestamp stamp)))
14803 (defun org-toggle-time-stamp-overlays ()
14804 "Toggle the use of custom time stamp formats."
14805 (interactive)
14806 (setq org-display-custom-times (not org-display-custom-times))
14807 (unless org-display-custom-times
14808 (let ((p (point-min)) (bmp (buffer-modified-p)))
14809 (while (setq p (next-single-property-change p 'display))
14810 (if (and (get-text-property p 'display)
14811 (eq (get-text-property p 'face) 'org-date))
14812 (remove-text-properties
14813 p (setq p (next-single-property-change p 'display))
14814 '(display t))))
14815 (set-buffer-modified-p bmp)))
14816 (if (featurep 'xemacs)
14817 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14818 (org-restart-font-lock)
14819 (setq org-table-may-need-update t)
14820 (if org-display-custom-times
14821 (message "Time stamps are overlayed with custom format")
14822 (message "Time stamp overlays removed")))
14824 (defun org-display-custom-time (beg end)
14825 "Overlay modified time stamp format over timestamp between BEG and END."
14826 (let* ((ts (buffer-substring beg end))
14827 t1 w1 with-hm tf time str w2 (off 0))
14828 (save-match-data
14829 (setq t1 (org-parse-time-string ts t))
14830 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14831 (setq off (- (match-end 0) (match-beginning 0)))))
14832 (setq end (- end off))
14833 (setq w1 (- end beg)
14834 with-hm (and (nth 1 t1) (nth 2 t1))
14835 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14836 time (org-fix-decoded-time t1)
14837 str (org-add-props
14838 (format-time-string
14839 (substring tf 1 -1) (apply 'encode-time time))
14840 nil 'mouse-face 'highlight)
14841 w2 (length str))
14842 (if (not (= w2 w1))
14843 (add-text-properties (1+ beg) (+ 2 beg)
14844 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14845 (if (featurep 'xemacs)
14846 (progn
14847 (put-text-property beg end 'invisible t)
14848 (put-text-property beg end 'end-glyph (make-glyph str)))
14849 (put-text-property beg end 'display str))))
14851 (defun org-translate-time (string)
14852 "Translate all timestamps in STRING to custom format.
14853 But do this only if the variable `org-display-custom-times' is set."
14854 (when org-display-custom-times
14855 (save-match-data
14856 (let* ((start 0)
14857 (re org-ts-regexp-both)
14858 t1 with-hm inactive tf time str beg end)
14859 (while (setq start (string-match re string start))
14860 (setq beg (match-beginning 0)
14861 end (match-end 0)
14862 t1 (save-match-data
14863 (org-parse-time-string (substring string beg end) t))
14864 with-hm (and (nth 1 t1) (nth 2 t1))
14865 inactive (equal (substring string beg (1+ beg)) "[")
14866 tf (funcall (if with-hm 'cdr 'car)
14867 org-time-stamp-custom-formats)
14868 time (org-fix-decoded-time t1)
14869 str (format-time-string
14870 (concat
14871 (if inactive "[" "<") (substring tf 1 -1)
14872 (if inactive "]" ">"))
14873 (apply 'encode-time time))
14874 string (replace-match str t t string)
14875 start (+ start (length str)))))))
14876 string)
14878 (defun org-fix-decoded-time (time)
14879 "Set 0 instead of nil for the first 6 elements of time.
14880 Don't touch the rest."
14881 (let ((n 0))
14882 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14884 (defun org-days-to-time (timestamp-string)
14885 "Difference between TIMESTAMP-STRING and now in days."
14886 (- (time-to-days (org-time-string-to-time timestamp-string))
14887 (time-to-days (current-time))))
14889 (defun org-deadline-close (timestamp-string &optional ndays)
14890 "Is the time in TIMESTAMP-STRING close to the current date?"
14891 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14892 (and (< (org-days-to-time timestamp-string) ndays)
14893 (not (org-entry-is-done-p))))
14895 (defun org-get-wdays (ts)
14896 "Get the deadline lead time appropriate for timestring TS."
14897 (cond
14898 ((<= org-deadline-warning-days 0)
14899 ;; 0 or negative, enforce this value no matter what
14900 (- org-deadline-warning-days))
14902 ;; lead time is specified.
14903 (floor (* (string-to-number (match-string 1 ts))
14904 (cdr (assoc (match-string 2 ts)
14905 '(("d" . 1) ("w" . 7)
14906 ("m" . 30.4) ("y" . 365.25)))))))
14907 ;; go for the default.
14908 (t org-deadline-warning-days)))
14910 (defun org-calendar-select-mouse (ev)
14911 "Return to `org-read-date' with the date currently selected.
14912 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14913 (interactive "e")
14914 (mouse-set-point ev)
14915 (when (calendar-cursor-to-date)
14916 (let* ((date (calendar-cursor-to-date))
14917 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14918 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14919 (if (active-minibuffer-window) (exit-minibuffer))))
14921 (defun org-check-deadlines (ndays)
14922 "Check if there are any deadlines due or past due.
14923 A deadline is considered due if it happens within `org-deadline-warning-days'
14924 days from today's date. If the deadline appears in an entry marked DONE,
14925 it is not shown. The prefix arg NDAYS can be used to test that many
14927 (interactive "P")
14928 (let* ((org-warn-days
14929 (cond
14930 ((equal ndays '(4)) 100000)
14931 (ndays (prefix-numeric-value ndays))
14932 (t (abs org-deadline-warning-days))))
14933 (case-fold-search nil)
14935 (callback
14936 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14938 (message "%d deadlines past-due or due within %d days"
14939 (org-occur regexp nil callback)
14940 org-warn-days)))
14942 (defun org-check-before-date (date)
14943 "Check if there are deadlines or scheduled entries before DATE."
14944 (interactive (list (org-read-date)))
14945 (let ((case-fold-search nil)
14949 (callback
14950 (lambda () (time-less-p
14951 (org-time-string-to-time (match-string 2))
14952 (org-time-string-to-time date)))))
14953 (message "%d entries before %s"
14954 (org-occur regexp nil callback) date)))
14956 (defun org-check-after-date (date)
14957 "Check if there are deadlines or scheduled entries after DATE."
14958 (interactive (list (org-read-date)))
14959 (let ((case-fold-search nil)
14963 (callback
14964 (lambda () (not
14965 (time-less-p
14966 (org-time-string-to-time (match-string 2))
14967 (org-time-string-to-time date))))))
14968 (message "%d entries after %s"
14969 (org-occur regexp nil callback) date)))
14971 (defun org-evaluate-time-range (&optional to-buffer)
14972 "Evaluate a time range by computing the difference between start and end.
14973 Normally the result is just printed in the echo area, but with prefix arg
14974 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14975 If the time range is actually in a table, the result is inserted into the
14976 next column.
14977 For time difference computation, a year is assumed to be exactly 365
14978 days in order to avoid rounding problems."
14979 (interactive "P")
14980 (or
14981 (org-clock-update-time-maybe)
14982 (save-excursion
14983 (unless (org-at-date-range-p t)
14984 (goto-char (point-at-bol))
14985 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14986 (if (not (org-at-date-range-p t))
14987 (error "Not at a time-stamp range, and none found in current line")))
14988 (let* ((ts1 (match-string 1))
14989 (ts2 (match-string 2))
14990 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14991 (match-end (match-end 0))
14992 (time1 (org-time-string-to-time ts1))
14993 (time2 (org-time-string-to-time ts2))
14994 (t1 (org-float-time time1))
14995 (t2 (org-float-time time2))
14996 (diff (abs (- t2 t1)))
14997 (negative (< (- t2 t1) 0))
14998 ;; (ys (floor (* 365 24 60 60)))
14999 (ds (* 24 60 60))
15000 (hs (* 60 60))
15001 (fy "%dy %dd %02d:%02d")
15002 (fy1 "%dy %dd")
15003 (fd "%dd %02d:%02d")
15004 (fd1 "%dd")
15005 (fh "%02d:%02d")
15006 y d h m align)
15007 (if havetime
15008 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15009 y 0
15010 d (floor (/ diff ds)) diff (mod diff ds)
15011 h (floor (/ diff hs)) diff (mod diff hs)
15012 m (floor (/ diff 60)))
15013 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15014 y 0
15015 d (floor (+ (/ diff ds) 0.5))
15016 h 0 m 0))
15017 (if (not to-buffer)
15018 (message "%s" (org-make-tdiff-string y d h m))
15019 (if (org-at-table-p)
15020 (progn
15021 (goto-char match-end)
15022 (setq align t)
15023 (and (looking-at " *|") (goto-char (match-end 0))))
15024 (goto-char match-end))
15025 (if (looking-at
15027 (replace-match ""))
15028 (if negative (insert " -"))
15029 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15030 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15031 (insert " " (format fh h m))))
15032 (if align (org-table-align))
15033 (message "Time difference inserted")))))
15035 (defun org-make-tdiff-string (y d h m)
15036 (let ((fmt "")
15037 (l nil))
15038 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15039 l (push y l)))
15040 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15041 l (push d l)))
15042 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15043 l (push h l)))
15044 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15045 l (push m l)))
15046 (apply 'format fmt (nreverse l))))
15048 (defun org-time-string-to-time (s)
15049 (apply 'encode-time (org-parse-time-string s)))
15050 (defun org-time-string-to-seconds (s)
15051 (org-float-time (org-time-string-to-time s)))
15053 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15054 "Convert a time stamp to an absolute day number.
15055 If there is a specifier for a cyclic time stamp, get the closest date to
15056 DAYNR.
15057 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15058 The variable date is bound by the calendar when this is called."
15059 (cond
15061 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15062 daynr
15063 (+ daynr 1000)))
15065 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15066 (time-to-days (current-time))) (match-string 0 s)
15067 prefer show-all))
15068 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15070 (defun org-days-to-iso-week (days)
15071 "Return the iso week number."
15072 (require 'cal-iso)
15073 (car (calendar-iso-from-absolute days)))
15075 (defun org-small-year-to-year (year)
15076 "Convert 2-digit years into 4-digit years.
15077 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15078 The year 2000 cannot be abbreviated. Any year larger than 99
15079 is returned unchanged."
15080 (if (< year 38)
15081 (setq year (+ 2000 year))
15082 (if (< year 100)
15083 (setq year (+ 1900 year))))
15084 year)
15086 (defun org-time-from-absolute (d)
15087 "Return the time corresponding to date D.
15088 D may be an absolute day number, or a calendar-type list (month day year)."
15089 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15090 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15092 (defun org-calendar-holiday ()
15093 "List of holidays, for Diary display in Org-mode."
15094 (require 'holidays)
15095 (let ((hl (funcall
15096 (if (fboundp 'calendar-check-holidays)
15097 'calendar-check-holidays 'check-calendar-holidays) date)))
15098 (if hl (mapconcat 'identity hl "; "))))
15100 (defun org-diary-sexp-entry (sexp entry date)
15101 "Process a SEXP diary ENTRY for DATE."
15102 (require 'diary-lib)
15103 (let ((result (if calendar-debug-sexp
15104 (let ((stack-trace-on-error t))
15105 (eval (car (read-from-string sexp))))
15106 (condition-case nil
15107 (eval (car (read-from-string sexp)))
15108 (error
15109 (beep)
15110 (message "Bad sexp at line %d in %s: %s"
15111 (org-current-line)
15112 (buffer-file-name) sexp)
15113 (sleep-for 2))))))
15114 (cond ((stringp result) (split-string result "; "))
15115 ((and (consp result)
15116 (not (consp (cdr result)))
15117 (stringp (cdr result))) (cdr result))
15118 ((and (consp result)
15119 (stringp (car result))) result)
15120 (result entry)
15121 (t nil))))
15123 (defun org-diary-to-ical-string (frombuf)
15124 "Get iCalendar entries from diary entries in buffer FROMBUF.
15125 This uses the icalendar.el library."
15126 (let* ((tmpdir (if (featurep 'xemacs)
15127 (temp-directory)
15128 temporary-file-directory))
15129 (tmpfile (make-temp-name
15130 (expand-file-name "orgics" tmpdir)))
15131 buf rtn b e)
15132 (with-current-buffer frombuf
15133 (icalendar-export-region (point-min) (point-max) tmpfile)
15134 (setq buf (find-buffer-visiting tmpfile))
15135 (set-buffer buf)
15136 (goto-char (point-min))
15137 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15138 (setq b (match-beginning 0)))
15139 (goto-char (point-max))
15140 (if (re-search-backward "^END:VEVENT" nil t)
15141 (setq e (match-end 0)))
15143 (kill-buffer buf)
15144 (delete-file tmpfile)
15145 rtn))
15147 (defun org-closest-date (start current change prefer show-all)
15148 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15149 When PREFER is `past', return a date that is either CURRENT or past.
15150 When PREFER is `future', return a date that is either CURRENT or future.
15151 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15152 ;; Make the proper lists from the dates
15153 (catch 'exit
15154 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15155 dn dw sday cday n1 n2 n0
15156 d m y y1 y2 date1 date2 nmonths nm ny m2)
15158 (setq start (org-date-to-gregorian start)
15159 current (org-date-to-gregorian
15160 (if show-all
15161 current
15162 (time-to-days (current-time))))
15163 sday (calendar-absolute-from-gregorian start)
15164 cday (calendar-absolute-from-gregorian current))
15166 (if (<= cday sday) (throw 'exit sday))
15169 (setq dn (string-to-number (match-string 1 change))
15170 dw (cdr (assoc (match-string 2 change) a1)))
15171 (error "Invalid change specifier: %s" change))
15172 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15173 (cond
15174 ((eq dw 'day)
15175 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15176 n2 (+ n1 dn)))
15177 ((eq dw 'year)
15178 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15179 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15180 (setq date1 (list m d y1)
15181 n1 (calendar-absolute-from-gregorian date1)
15182 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15183 n2 (calendar-absolute-from-gregorian date2)))
15184 ((eq dw 'month)
15185 ;; approx number of month between the two dates
15186 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15187 ;; How often does dn fit in there?
15188 (setq d (nth 1 start) m (car start) y (nth 2 start)
15189 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15190 m (+ m nm)
15191 ny (floor (/ m 12))
15192 y (+ y ny)
15193 m (- m (* ny 12)))
15194 (while (> m 12) (setq m (- m 12) y (1+ y)))
15195 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15196 (setq m2 (+ m dn) y2 y)
15197 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15198 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15199 (while (<= n2 cday)
15200 (setq n1 n2 m m2 y y2)
15201 (setq m2 (+ m dn) y2 y)
15202 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15203 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15204 ;; Make sure n1 is the earlier date
15205 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15206 (if show-all
15207 (cond
15208 ((eq prefer 'past) (if (= cday n2) n2 n1))
15209 ((eq prefer 'future) (if (= cday n1) n1 n2))
15210 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15211 (cond
15212 ((eq prefer 'past) (if (= cday n2) n2 n1))
15213 ((eq prefer 'future) (if (= cday n1) n1 n2))
15214 (t (if (= cday n1) n1 n2)))))))
15216 (defun org-date-to-gregorian (date)
15217 "Turn any specification of DATE into a Gregorian date for the calendar."
15218 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15219 ((and (listp date) (= (length date) 3)) date)
15220 ((stringp date)
15221 (setq date (org-parse-time-string date))
15222 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15223 ((listp date)
15224 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15226 (defun org-parse-time-string (s &optional nodefault)
15227 "Parse the standard Org-mode time string.
15228 This should be a lot faster than the normal `parse-time-string'.
15229 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15230 hour and minute fields will be nil if not given."
15231 (if (string-match org-ts-regexp0 s)
15232 (list 0
15233 (if (or (match-beginning 8) (not nodefault))
15234 (string-to-number (or (match-string 8 s) "0")))
15235 (if (or (match-beginning 7) (not nodefault))
15236 (string-to-number (or (match-string 7 s) "0")))
15237 (string-to-number (match-string 4 s))
15238 (string-to-number (match-string 3 s))
15239 (string-to-number (match-string 2 s))
15240 nil nil nil)
15241 (error "Not a standard Org-mode time string: %s" s)))
15243 (defun org-timestamp-up (&optional arg)
15244 "Increase the date item at the cursor by one.
15245 If the cursor is on the year, change the year. If it is on the month or
15246 the day, change that.
15247 With prefix ARG, change by that many units."
15248 (interactive "p")
15249 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15251 (defun org-timestamp-down (&optional arg)
15252 "Decrease the date item at the cursor by one.
15253 If the cursor is on the year, change the year. If it is on the month or
15254 the day, change that.
15255 With prefix ARG, change by that many units."
15256 (interactive "p")
15257 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15259 (defun org-timestamp-up-day (&optional arg)
15260 "Increase the date in the time stamp by one day.
15261 With prefix ARG, change that many days."
15262 (interactive "p")
15263 (if (and (not (org-at-timestamp-p t))
15264 (org-on-heading-p))
15265 (org-todo 'up)
15266 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15268 (defun org-timestamp-down-day (&optional arg)
15269 "Decrease the date in the time stamp by one day.
15270 With prefix ARG, change that many days."
15271 (interactive "p")
15272 (if (and (not (org-at-timestamp-p t))
15273 (org-on-heading-p))
15274 (org-todo 'down)
15275 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15277 (defun org-at-timestamp-p (&optional inactive-ok)
15278 "Determine if the cursor is in or at a timestamp."
15279 (interactive)
15280 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15281 (pos (point))
15282 (ans (or (looking-at tsr)
15283 (save-excursion
15285 (if (> (point) (point-min)) (backward-char 1))
15286 (and (looking-at tsr)
15287 (> (- (match-end 0) pos) -1))))))
15288 (and ans
15289 (boundp 'org-ts-what)
15290 (setq org-ts-what
15291 (cond
15292 ((= pos (match-beginning 0)) 'bracket)
15293 ((= pos (1- (match-end 0))) 'bracket)
15294 ((org-pos-in-match-range pos 2) 'year)
15295 ((org-pos-in-match-range pos 3) 'month)
15296 ((org-pos-in-match-range pos 7) 'hour)
15297 ((org-pos-in-match-range pos 8) 'minute)
15298 ((or (org-pos-in-match-range pos 4)
15299 (org-pos-in-match-range pos 5)) 'day)
15300 ((and (> pos (or (match-end 8) (match-end 5)))
15301 (< pos (match-end 0)))
15302 (- pos (or (match-end 8) (match-end 5))))
15303 (t 'day))))
15304 ans))
15306 (defun org-toggle-timestamp-type ()
15307 "Toggle the type (<active> or [inactive]) of a time stamp."
15308 (interactive)
15309 (when (org-at-timestamp-p t)
15310 (let ((beg (match-beginning 0)) (end (match-end 0))
15311 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15312 (save-excursion
15313 (goto-char beg)
15314 (while (re-search-forward "[][<>]" end t)
15315 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15316 t t)))
15317 (message "Timestamp is now %sactive"
15318 (if (equal (char-after beg) ?<) "" "in")))))
15320 (defun org-timestamp-change (n &optional what updown)
15321 "Change the date in the time stamp at point.
15322 The date will be changed by N times WHAT. WHAT can be `day', `month',
15323 `year', `minute', `second'. If WHAT is not given, the cursor position
15324 in the timestamp determines what will be changed."
15325 (let ((pos (point))
15326 with-hm inactive
15327 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15328 org-ts-what
15329 extra rem
15330 ts time time0)
15331 (if (not (org-at-timestamp-p t))
15332 (error "Not at a timestamp"))
15333 (if (and (not what) (eq org-ts-what 'bracket))
15334 (org-toggle-timestamp-type)
15335 (if (and (not what) (not (eq org-ts-what 'day))
15336 org-display-custom-times
15337 (get-text-property (point) 'display)
15338 (not (get-text-property (1- (point)) 'display)))
15339 (setq org-ts-what 'day))
15340 (setq org-ts-what (or what org-ts-what)
15341 inactive (= (char-after (match-beginning 0)) ?\[)
15342 ts (match-string 0))
15343 (replace-match "")
15344 (if (string-match
15346 ts)
15347 (setq extra (match-string 1 ts)))
15349 (setq with-hm t))
15350 (setq time0 (org-parse-time-string ts))
15351 (when (and updown
15352 (eq org-ts-what 'minute)
15353 (not current-prefix-arg))
15354 ;; This looks like s-up and s-down. Change by one rounding step.
15355 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15356 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15357 (setcar (cdr time0) (+ (nth 1 time0)
15358 (if (> n 0) (- rem) (- dm rem))))))
15359 (setq time
15360 (encode-time (or (car time0) 0)
15361 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15362 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15363 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15364 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15365 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15366 (nthcdr 6 time0)))
15367 (when (and (member org-ts-what '(hour minute))
15368 extra
15370 (setq extra (org-modify-ts-extra
15371 extra
15372 (if (eq org-ts-what 'hour) 2 5)
15373 n dm)))
15374 (when (integerp org-ts-what)
15375 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15376 (if (eq what 'calendar)
15377 (let ((cal-date (org-get-date-from-calendar)))
15378 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15379 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15380 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15381 (setcar time0 (or (car time0) 0))
15382 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15383 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15384 (setq time (apply 'encode-time time0))))
15385 (setq org-last-changed-timestamp
15386 (org-insert-time-stamp time with-hm inactive nil nil extra))
15387 (org-clock-update-time-maybe)
15388 (goto-char pos)
15389 ;; Try to recenter the calendar window, if any
15390 (if (and org-calendar-follow-timestamp-change
15391 (get-buffer-window "*Calendar*" t)
15392 (memq org-ts-what '(day month year)))
15393 (org-recenter-calendar (time-to-days time))))))
15395 (defun org-modify-ts-extra (s pos n dm)
15396 "Change the different parts of the lead-time and repeat fields in timestamp."
15397 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15398 ng h m new rem)
15399 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15400 (cond
15401 ((or (org-pos-in-match-range pos 2)
15402 (org-pos-in-match-range pos 3))
15403 (setq m (string-to-number (match-string 3 s))
15404 h (string-to-number (match-string 2 s)))
15405 (if (org-pos-in-match-range pos 2)
15406 (setq h (+ h n))
15407 (setq n (* dm (org-no-warnings (signum n))))
15408 (when (not (= 0 (setq rem (% m dm))))
15409 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15410 (setq m (+ m n)))
15411 (if (< m 0) (setq m (+ m 60) h (1- h)))
15412 (if (> m 59) (setq m (- m 60) h (1+ h)))
15413 (setq h (min 24 (max 0 h)))
15414 (setq ng 1 new (format "-%02d:%02d" h m)))
15415 ((org-pos-in-match-range pos 6)
15416 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15417 ((org-pos-in-match-range pos 5)
15418 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15420 ((org-pos-in-match-range pos 9)
15421 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15422 ((org-pos-in-match-range pos 8)
15423 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15425 (when ng
15426 (setq s (concat
15427 (substring s 0 (match-beginning ng))
15428 new
15429 (substring s (match-end ng))))))
15430 s))
15432 (defun org-recenter-calendar (date)
15433 "If the calendar is visible, recenter it to DATE."
15434 (let* ((win (selected-window))
15435 (cwin (get-buffer-window "*Calendar*" t))
15436 (calendar-move-hook nil))
15437 (when cwin
15438 (select-window cwin)
15439 (calendar-goto-date (if (listp date) date
15440 (calendar-gregorian-from-absolute date)))
15441 (select-window win))))
15443 (defun org-goto-calendar (&optional arg)
15444 "Go to the Emacs calendar at the current date.
15445 If there is a time stamp in the current line, go to that date.
15446 A prefix ARG can be used to force the current date."
15447 (interactive "P")
15448 (let ((tsr org-ts-regexp) diff
15449 (calendar-move-hook nil)
15450 (calendar-view-holidays-initially-flag nil)
15451 (calendar-view-diary-initially-flag nil))
15452 (if (or (org-at-timestamp-p)
15453 (save-excursion
15454 (beginning-of-line 1)
15455 (looking-at (concat ".*" tsr))))
15456 (let ((d1 (time-to-days (current-time)))
15457 (d2 (time-to-days
15458 (org-time-string-to-time (match-string 1)))))
15459 (setq diff (- d2 d1))))
15460 (calendar)
15461 (calendar-goto-today)
15462 (if (and diff (not arg)) (calendar-forward-day diff))))
15464 (defun org-get-date-from-calendar ()
15465 "Return a list (month day year) of date at point in calendar."
15466 (with-current-buffer "*Calendar*"
15467 (save-match-data
15468 (calendar-cursor-to-date))))
15470 (defun org-date-from-calendar ()
15471 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15472 If there is already a time stamp at the cursor position, update it."
15473 (interactive)
15474 (if (org-at-timestamp-p t)
15475 (org-timestamp-change 0 'calendar)
15476 (let ((cal-date (org-get-date-from-calendar)))
15477 (org-insert-time-stamp
15478 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15480 (defun org-minutes-to-hh:mm-string (m)
15481 "Compute H:MM from a number of minutes."
15482 (let ((h (/ m 60)))
15483 (setq m (- m (* 60 h)))
15484 (format org-time-clocksum-format h m)))
15486 (defun org-hh:mm-string-to-minutes (s)
15487 "Convert a string H:MM to a number of minutes.
15488 If the string is just a number, interpret it as minutes.
15489 In fact, the first hh:mm or number in the string will be taken,
15490 there can be extra stuff in the string.
15491 If no number is found, the return value is 0."
15492 (cond
15494 (+ (* (string-to-number (match-string 1 s)) 60)
15495 (string-to-number (match-string 2 s))))
15497 (string-to-number (match-string 1 s)))
15498 (t 0)))
15500 ;;;; Files
15502 (defun org-save-all-org-buffers ()
15503 "Save all Org-mode buffers without user confirmation."
15504 (interactive)
15505 (message "Saving all Org-mode buffers...")
15506 (save-some-buffers t 'org-mode-p)
15507 (when (featurep 'org-id) (org-id-locations-save))
15508 (message "Saving all Org-mode buffers... done"))
15510 (defun org-revert-all-org-buffers ()
15511 "Revert all Org-mode buffers.
15512 Prompt for confirmation when there are unsaved changes.
15513 Be sure you know what you are doing before letting this function
15514 overwrite your changes.
15516 This function is useful in a setup where one tracks org files
15517 with a version control system, to revert on one machine after pulling
15518 changes from another. I believe the procedure must be like this:
15520 1. M-x org-save-all-org-buffers
15521 2. Pull changes from the other machine, resolve conflicts
15522 3. M-x org-revert-all-org-buffers"
15523 (interactive)
15524 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15525 (error "Abort"))
15526 (save-excursion
15527 (save-window-excursion
15528 (mapc
15529 (lambda (b)
15530 (when (and (with-current-buffer b (org-mode-p))
15531 (with-current-buffer b buffer-file-name))
15532 (switch-to-buffer b)
15533 (revert-buffer t 'no-confirm)))
15534 (buffer-list))
15535 (when (and (featurep 'org-id) org-id-track-globally)
15536 (org-id-locations-load)))))
15538 ;;;; Agenda files
15540 ;;;###autoload
15541 (defun org-switchb (&optional arg)
15542 "Switch between Org buffers.
15543 With a prefix argument, restrict available to files.
15544 With two prefix arguments, restrict available buffers to agenda files.
15546 Defaults to `iswitchb' for buffer name completion.
15547 Set `org-completion-use-ido' to make it use ido instead."
15548 (interactive "P")
15549 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15550 ((equal arg '(16)) (org-buffer-list 'agenda))
15551 (t (org-buffer-list))))
15552 (org-completion-use-iswitchb org-completion-use-iswitchb)
15553 (org-completion-use-ido org-completion-use-ido))
15554 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15555 (setq org-completion-use-iswitchb t))
15556 (switch-to-buffer
15557 (org-icompleting-read "Org buffer: "
15558 (mapcar 'list (mapcar 'buffer-name blist))
15559 nil t))))
15561 ;;; Define some older names previously used for this functionality
15562 ;;;###autoload
15563 (defalias 'org-ido-switchb 'org-switchb)
15564 ;;;###autoload
15565 (defalias 'org-iswitchb 'org-switchb)
15567 (defun org-buffer-list (&optional predicate exclude-tmp)
15568 "Return a list of Org buffers.
15569 PREDICATE can be `export', `files' or `agenda'.
15571 export restrict the list to Export buffers.
15572 files restrict the list to buffers visiting Org files.
15573 agenda restrict the list to buffers visiting agenda files.
15575 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15576 (let* ((bfn nil)
15577 (agenda-files (and (eq predicate 'agenda)
15578 (mapcar 'file-truename (org-agenda-files t))))
15579 (filter
15580 (cond
15581 ((eq predicate 'files)
15582 (lambda (b) (with-current-buffer b (org-mode-p))))
15583 ((eq predicate 'export)
15584 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15585 ((eq predicate 'agenda)
15586 (lambda (b)
15587 (with-current-buffer b
15588 (and (org-mode-p)
15589 (setq bfn (buffer-file-name b))
15590 (member (file-truename bfn) agenda-files)))))
15591 (t (lambda (b) (with-current-buffer b
15592 (or (org-mode-p)
15593 (string-match "\*Org .*Export"
15594 (buffer-name b)))))))))
15595 (delq nil
15596 (mapcar
15597 (lambda(b)
15598 (if (and (funcall filter b)
15599 (or (not exclude-tmp)
15600 (not (string-match "tmp" (buffer-name b)))))
15601 b
15602 nil))
15603 (buffer-list)))))
15605 (defun org-agenda-files (&optional unrestricted archives)
15606 "Get the list of agenda files.
15607 Optional UNRESTRICTED means return the full list even if a restriction
15608 is currently in place.
15609 When ARCHIVES is t, include all archive files that are really being
15610 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15611 `org-agenda-archives-mode' is t."
15612 (let ((files
15613 (cond
15614 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15615 ((stringp org-agenda-files) (org-read-agenda-file-list))
15616 ((listp org-agenda-files) org-agenda-files)
15617 (t (error "Invalid value of `org-agenda-files'")))))
15618 (setq files (apply 'append
15619 (mapcar (lambda (f)
15620 (if (file-directory-p f)
15621 (directory-files
15622 f t org-agenda-file-regexp)
15623 (list f)))
15624 files)))
15625 (when org-agenda-skip-unavailable-files
15626 (setq files (delq nil
15627 (mapcar (function
15628 (lambda (file)
15629 (and (file-readable-p file) file)))
15630 files))))
15631 (when (or (eq archives t)
15632 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15633 (setq files (org-add-archive-files files)))
15634 files))
15636 (defun org-agenda-file-p (&optional file)
15637 "Return non-nil, if FILE is an agenda file.
15638 If FILE is omitted, use the file associated with the current
15639 buffer."
15640 (member (or file (buffer-file-name))
15641 (org-agenda-files t)))
15643 (defun org-edit-agenda-file-list ()
15644 "Edit the list of agenda files.
15645 Depending on setup, this either uses customize to edit the variable
15646 `org-agenda-files', or it visits the file that is holding the list. In the
15647 latter case, the buffer is set up in a way that saving it automatically kills
15648 the buffer and restores the previous window configuration."
15649 (interactive)
15650 (if (stringp org-agenda-files)
15651 (let ((cw (current-window-configuration)))
15652 (find-file org-agenda-files)
15653 (org-set-local 'org-window-configuration cw)
15654 (org-add-hook 'after-save-hook
15655 (lambda ()
15656 (set-window-configuration
15657 (prog1 org-window-configuration
15658 (kill-buffer (current-buffer))))
15659 (org-install-agenda-files-menu)
15660 (message "New agenda file list installed"))
15661 nil 'local)
15662 (message "%s" (substitute-command-keys
15664 (customize-variable 'org-agenda-files)))
15666 (defun org-store-new-agenda-file-list (list)
15667 "Set new value for the agenda file list and save it correctly."
15668 (if (stringp org-agenda-files)
15669 (let ((fe (org-read-agenda-file-list t)) b u)
15670 (while (setq b (find-buffer-visiting org-agenda-files))
15671 (kill-buffer b))
15672 (with-temp-file org-agenda-files
15673 (insert
15674 (mapconcat
15675 (lambda (f) ;; Keep un-expanded entries.
15676 (if (setq u (assoc f fe))
15677 (cdr u)
15678 f))
15681 (let ((org-mode-hook nil) (org-inhibit-startup t)
15682 (org-insert-mode-line-in-empty-file nil))
15683 (setq org-agenda-files list)
15684 (customize-save-variable 'org-agenda-files org-agenda-files))))
15686 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15687 "Read the list of agenda files from a file.
15688 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15689 filenames, used by `org-store-new-agenda-file-list' to write back
15690 un-expanded file names."
15691 (when (file-directory-p org-agenda-files)
15692 (error "`org-agenda-files' cannot be a single directory"))
15693 (when (stringp org-agenda-files)
15694 (with-temp-buffer
15695 (insert-file-contents org-agenda-files)
15696 (mapcar
15697 (lambda (f)
15698 (let ((e (expand-file-name (substitute-in-file-name f)
15699 org-directory)))
15700 (if pair-with-expansion
15701 (cons e f)
15702 e)))
15705 ;;;###autoload
15706 (defun org-cycle-agenda-files ()
15707 "Cycle through the files in `org-agenda-files'.
15708 If the current buffer visits an agenda file, find the next one in the list.
15709 If the current buffer does not, find the first agenda file."
15710 (interactive)
15711 (let* ((fs (org-agenda-files t))
15712 (files (append fs (list (car fs))))
15713 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15714 file)
15715 (unless files (error "No agenda files"))
15716 (catch 'exit
15717 (while (setq file (pop files))
15718 (if (equal (file-truename file) tcf)
15719 (when (car files)
15720 (find-file (car files))
15721 (throw 'exit t))))
15722 (find-file (car fs)))
15723 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15725 (defun org-agenda-file-to-front (&optional to-end)
15726 "Move/add the current file to the top of the agenda file list.
15727 If the file is not present in the list, it is added to the front. If it is
15728 present, it is moved there. With optional argument TO-END, add/move to the
15729 end of the list."
15730 (interactive "P")
15731 (let ((org-agenda-skip-unavailable-files nil)
15732 (file-alist (mapcar (lambda (x)
15733 (cons (file-truename x) x))
15734 (org-agenda-files t)))
15735 (ctf (file-truename buffer-file-name))
15736 x had)
15737 (setq x (assoc ctf file-alist) had x)
15739 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15740 (if to-end
15741 (setq file-alist (append (delq x file-alist) (list x)))
15742 (setq file-alist (cons x (delq x file-alist))))
15743 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15744 (org-install-agenda-files-menu)
15745 (message "File %s to %s of agenda file list"
15746 (if had "moved" "added") (if to-end "end" "front"))))
15748 (defun org-remove-file (&optional file)
15749 "Remove current file from the list of files in variable `org-agenda-files'.
15750 These are the files which are being checked for agenda entries.
15751 Optional argument FILE means use this file instead of the current."
15752 (interactive)
15753 (let* ((org-agenda-skip-unavailable-files nil)
15754 (file (or file buffer-file-name))
15755 (true-file (file-truename file))
15756 (afile (abbreviate-file-name file))
15757 (files (delq nil (mapcar
15758 (lambda (x)
15759 (if (equal true-file
15760 (file-truename x))
15761 nil x))
15762 (org-agenda-files t)))))
15763 (if (not (= (length files) (length (org-agenda-files t))))
15764 (progn
15765 (org-store-new-agenda-file-list files)
15766 (org-install-agenda-files-menu)
15767 (message "Removed file: %s" afile))
15768 (message "File was not in list: %s (not removed)" afile))))
15770 (defun org-file-menu-entry (file)
15771 (vector file (list 'find-file file) t))
15773 (defun org-check-agenda-file (file)
15774 "Make sure FILE exists. If not, ask user what to do."
15775 (when (not (file-exists-p file))
15776 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15777 (abbreviate-file-name file))
15778 (let ((r (downcase (read-char-exclusive))))
15779 (cond
15780 ((equal r ?r)
15781 (org-remove-file file)
15782 (throw 'nextfile t))
15783 (t (error "Abort"))))))
15785 (defun org-get-agenda-file-buffer (file)
15786 "Get a buffer visiting FILE. If the buffer needs to be created, add
15787 it to the list of buffers which might be released later."
15788 (let ((buf (org-find-base-buffer-visiting file)))
15789 (if buf
15790 buf ; just return it
15791 ;; Make a new buffer and remember it
15792 (setq buf (find-file-noselect file))
15793 (if buf (push buf org-agenda-new-buffers))
15794 buf)))
15796 (defun org-release-buffers (blist)
15797 "Release all buffers in list, asking the user for confirmation when needed.
15798 When a buffer is unmodified, it is just killed. When modified, it is saved
15799 \(if the user agrees) and then killed."
15800 (let (buf file)
15801 (while (setq buf (pop blist))
15802 (setq file (buffer-file-name buf))
15803 (when (and (buffer-modified-p buf)
15804 file
15805 (y-or-n-p (format "Save file %s? " file)))
15806 (with-current-buffer buf (save-buffer)))
15807 (kill-buffer buf))))
15809 (defun org-prepare-agenda-buffers (files)
15810 "Create buffers for all agenda files, protect archived trees and comments."
15811 (interactive)
15812 (let ((pa '(:org-archived t))
15813 (pc '(:org-comment t))
15814 (pall '(:org-archived t :org-comment t))
15815 (inhibit-read-only t)
15816 (rea (concat ":" org-archive-tag ":"))
15817 bmp file re)
15818 (save-excursion
15819 (save-restriction
15820 (while (setq file (pop files))
15821 (catch 'nextfile
15822 (if (bufferp file)
15823 (set-buffer file)
15824 (org-check-agenda-file file)
15825 (set-buffer (org-get-agenda-file-buffer file)))
15826 (widen)
15827 (setq bmp (buffer-modified-p))
15828 (org-refresh-category-properties)
15829 (setq org-todo-keywords-for-agenda
15830 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15831 (setq org-done-keywords-for-agenda
15832 (append org-done-keywords-for-agenda org-done-keywords))
15833 (setq org-todo-keyword-alist-for-agenda
15834 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15835 (setq org-drawers-for-agenda
15836 (append org-drawers-for-agenda org-drawers))
15837 (setq org-tag-alist-for-agenda
15838 (append org-tag-alist-for-agenda org-tag-alist))
15840 (save-excursion
15841 (remove-text-properties (point-min) (point-max) pall)
15842 (when org-agenda-skip-archived-trees
15843 (goto-char (point-min))
15844 (while (re-search-forward rea nil t)
15845 (if (org-on-heading-p t)
15846 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15847 (goto-char (point-min))
15849 (while (re-search-forward re nil t)
15850 (add-text-properties
15851 (match-beginning 0) (org-end-of-subtree t) pc)))
15852 (set-buffer-modified-p bmp)))))
15853 (setq org-todo-keywords-for-agenda
15854 (org-uniquify org-todo-keywords-for-agenda))
15855 (setq org-todo-keyword-alist-for-agenda
15856 (org-uniquify org-todo-keyword-alist-for-agenda)
15857 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15859 ;;;; Embedded LaTeX
15861 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15862 "Keymap for the minor `org-cdlatex-mode'.")
15864 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15865 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15866 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15867 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15868 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15870 (defvar org-cdlatex-texmathp-advice-is-done nil
15871 "Flag remembering if we have applied the advice to texmathp already.")
15873 (define-minor-mode org-cdlatex-mode
15874 "Toggle the minor `org-cdlatex-mode'.
15875 This mode supports entering LaTeX environment and math in LaTeX fragments
15876 in Org-mode.
15878 nil " OCDL" nil
15879 (when org-cdlatex-mode (require 'cdlatex))
15880 (unless org-cdlatex-texmathp-advice-is-done
15881 (setq org-cdlatex-texmathp-advice-is-done t)
15882 (defadvice texmathp (around org-math-always-on activate)
15883 "Always return t in org-mode buffers.
15884 This is because we want to insert math symbols without dollars even outside
15885 the LaTeX math segments. If Orgmode thinks that point is actually inside
15886 an embedded LaTeX fragment, let texmathp do its job.
15888 (interactive)
15889 (let (p)
15890 (cond
15891 ((not (org-mode-p)) ad-do-it)
15892 ((eq this-command 'cdlatex-math-symbol)
15893 (setq ad-return-value t
15894 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15895 (t
15896 (let ((p (org-inside-LaTeX-fragment-p)))
15897 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15898 (setq ad-return-value t
15899 texmathp-why '("Org-mode embedded math" . 0))
15900 (if p ad-do-it)))))))))
15902 (defun turn-on-org-cdlatex ()
15903 "Unconditionally turn on `org-cdlatex-mode'."
15904 (org-cdlatex-mode 1))
15906 (defun org-inside-LaTeX-fragment-p ()
15907 "Test if point is inside a LaTeX fragment.
15909 sequence appearing also before point.
15910 Even though the matchers for math are configurable, this function assumes
15912 delimiters are skipped when they have been removed by customization.
15913 The return value is nil, or a cons cell with the delimiter and
15914 and the position of this delimiter.
15916 This function does a reasonably good job, but can locally be fooled by
15917 for example currency specifications. For example it will assume being in
15919 fragments that are properly closed, but during editing, we have to live
15920 with the uncertainty caused by missing closing delimiters. This function
15921 looks only before point, not after."
15922 (catch 'exit
15923 (let ((pos (point))
15924 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15925 (lim (progn
15927 (point)))
15928 dd-on str (start 0) m re)
15929 (goto-char pos)
15930 (when dodollar
15932 re (nth 1 (assoc "$" org-latex-regexps)))
15933 (while (string-match re str start)
15934 (cond
15935 ((= (match-end 0) (length str))
15936 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15937 ((= (match-end 0) (- (length str) 5))
15938 (throw 'exit nil))
15939 (t (setq start (match-end 0))))))
15940 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15941 (goto-char pos)
15942 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15943 (and (match-beginning 2) (throw 'exit nil))
15944 ;; count $$
15946 (setq dd-on (not dd-on)))
15947 (goto-char pos)
15948 (if dd-on (cons "$$" m))))))
15950 (defun org-inside-latex-macro-p ()
15951 "Is point inside a LaTeX macro or its arguments?"
15952 (save-match-data
15953 (org-in-regexp
15956 (defun org-try-cdlatex-tab ()
15957 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15958 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15959 - inside a LaTeX fragment, or
15960 - after the first word in a line, where an abbreviation expansion could
15961 insert a LaTeX environment."
15962 (when org-cdlatex-mode
15963 (cond
15964 ((save-excursion
15965 (skip-chars-backward "a-zA-Z0-9*")
15967 (bolp))
15968 (cdlatex-tab) t)
15969 ((org-inside-LaTeX-fragment-p)
15970 (cdlatex-tab) t)
15971 (t nil))))
15973 (defun org-cdlatex-underscore-caret (&optional arg)
15974 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15975 Revert to the normal definition outside of these fragments."
15976 (interactive "P")
15977 (if (org-inside-LaTeX-fragment-p)
15978 (call-interactively 'cdlatex-sub-superscript)
15979 (let (org-cdlatex-mode)
15980 (call-interactively (key-binding (vector last-input-event))))))
15982 (defun org-cdlatex-math-modify (&optional arg)
15983 "Execute `cdlatex-math-modify' in LaTeX fragments.
15984 Revert to the normal definition outside of these fragments."
15985 (interactive "P")
15986 (if (org-inside-LaTeX-fragment-p)
15987 (call-interactively 'cdlatex-math-modify)
15988 (let (org-cdlatex-mode)
15989 (call-interactively (key-binding (vector last-input-event))))))
15991 (defvar org-latex-fragment-image-overlays nil
15992 "List of overlays carrying the images of latex fragments.")
15993 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15995 (defun org-remove-latex-fragment-image-overlays ()
15996 "Remove all overlays with LaTeX fragment images in current buffer."
15997 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15998 (setq org-latex-fragment-image-overlays nil))
16000 (defun org-preview-latex-fragment (&optional subtree)
16001 "Preview the LaTeX fragment at point, or all locally or globally.
16002 If the cursor is in a LaTeX fragment, create the image and overlay
16003 it over the source code. If there is no fragment at point, display
16004 all fragments in the current text, from one headline to the next. With
16005 prefix SUBTREE, display all fragments in the current subtree. With a
16007 the cursor is before the first headline,
16008 display all fragments in the buffer.
16010 (interactive "P")
16011 (org-remove-latex-fragment-image-overlays)
16012 (save-excursion
16013 (save-restriction
16014 (let (beg end at msg)
16015 (cond
16016 ((or (equal subtree '(16))
16017 (not (save-excursion
16018 (re-search-backward (concat "^" outline-regexp) nil t))))
16019 (setq beg (point-min) end (point-max)
16020 msg "Creating images for buffer...%s"))
16021 ((equal subtree '(4))
16022 (org-back-to-heading)
16023 (setq beg (point) end (org-end-of-subtree t)
16024 msg "Creating images for subtree...%s"))
16025 (t
16026 (if (setq at (org-inside-LaTeX-fragment-p))
16027 (goto-char (max (point-min) (- (cdr at) 2)))
16028 (org-back-to-heading))
16029 (setq beg (point) end (progn (outline-next-heading) (point))
16030 msg (if at "Creating image...%s"
16031 "Creating images for entry...%s"))))
16032 (message msg "")
16033 (narrow-to-region beg end)
16034 (goto-char beg)
16035 (org-format-latex
16036 (concat "ltxpng/" (file-name-sans-extension
16037 (file-name-nondirectory
16038 buffer-file-name)))
16039 default-directory 'overlays msg at 'forbuffer 'dvipng)
16040 (message msg "done. Use `C-c C-c' to remove images.")))))
16042 (defvar org-latex-regexps
16044 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16047 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16051 "Regular expressions for matching embedded LaTeX.")
16053 (defvar org-export-have-math nil) ;; dynamic scoping
16054 (defun org-format-latex (prefix &optional dir overlays msg at
16055 forbuffer processing-type)
16056 "Replace LaTeX fragments with links to an image, and produce images.
16057 Some of the options can be changed using the variable
16058 `org-format-latex-options'."
16059 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16060 (let* ((prefixnodir (file-name-nondirectory prefix))
16061 (absprefix (expand-file-name prefix dir))
16062 (todir (file-name-directory absprefix))
16063 (opt org-format-latex-options)
16064 (matchers (plist-get opt :matchers))
16065 (re-list org-latex-regexps)
16066 (org-format-latex-header-extra
16067 (plist-get (org-infile-export-plist) :latex-header-extra))
16068 (cnt 0) txt hash link beg end re e checkdir
16069 executables-checked string
16070 m n block linkfile movefile ov)
16071 ;; Check the different regular expressions
16072 (while (setq e (pop re-list))
16073 (setq m (car e) re (nth 1 e) n (nth 2 e)
16075 (when (member m matchers)
16076 (goto-char (point-min))
16077 (while (re-search-forward re nil t)
16078 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16079 (not (get-text-property (match-beginning n)
16080 'org-protected))
16081 (or (not overlays)
16082 (not (eq (get-char-property (match-beginning n)
16083 'org-overlay-type)
16084 'org-latex-overlay))))
16085 (setq org-export-have-math t)
16086 (cond
16087 ((eq processing-type 'verbatim)
16088 ;; Leave the text verbatim, just protect it
16089 (add-text-properties (match-beginning n) (match-end n)
16090 '(org-protected t)))
16091 ((eq processing-type 'mathjax)
16092 ;; Prepare for MathJax processing
16093 (setq string (match-string n))
16094 (if (member m '("$" "$1"))
16095 (save-excursion
16096 (delete-region (match-beginning n) (match-end n))
16097 (goto-char (match-beginning n))
16100 '(org-protected t))))
16101 (add-text-properties (match-beginning n) (match-end n)
16102 '(org-protected t))))
16103 ((or (eq processing-type 'dvipng) t)
16104 ;; Process to an image
16105 (setq txt (match-string n)
16106 beg (match-beginning n) end (match-end n)
16107 cnt (1+ cnt))
16108 (let (print-length print-level) ; make sure full list is printed
16109 (setq hash (sha1 (prin1-to-string
16110 (list org-format-latex-header
16111 org-format-latex-header-extra
16112 org-export-latex-default-packages-alist
16113 org-export-latex-packages-alist
16114 org-format-latex-options
16115 forbuffer txt)))
16116 linkfile (format "%s_%s.png" prefix hash)
16117 movefile (format "%s_%s.png" absprefix hash)))
16118 (setq link (concat block "[[file:" linkfile "]]" block))
16119 (if msg (message msg cnt))
16120 (goto-char beg)
16121 (unless checkdir ; make sure the directory exists
16122 (setq checkdir t)
16123 (or (file-directory-p todir) (make-directory todir t)))
16125 (unless executables-checked
16126 (org-check-external-command
16127 "latex" "needed to convert LaTeX fragments to images")
16128 (org-check-external-command
16129 "dvipng" "needed to convert LaTeX fragments to images")
16130 (setq executables-checked t))
16132 (unless (file-exists-p movefile)
16133 (org-create-formula-image
16134 txt movefile opt forbuffer))
16135 (if overlays
16136 (progn
16137 (mapc (lambda (o)
16138 (if (eq (overlay-get o 'org-overlay-type)
16139 'org-latex-overlay)
16140 (delete-overlay o)))
16141 (overlays-in beg end))
16142 (setq ov (make-overlay beg end))
16143 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16144 (if (featurep 'xemacs)
16145 (progn
16146 (overlay-put ov 'invisible t)
16147 (overlay-put
16148 ov 'end-glyph
16149 (make-glyph (vector 'png :file movefile))))
16150 (overlay-put
16151 ov 'display
16152 (list 'image :type 'png :file movefile :ascent 'center)))
16153 (push ov org-latex-fragment-image-overlays)
16154 (goto-char end))
16155 (delete-region beg end)
16156 (insert (org-add-props link
16157 (list 'org-latex-src
16158 (replace-regexp-in-string
16161 ;; This function borrows from Ganesh Swami's latex2png.el
16162 (defun org-create-formula-image (string tofile options buffer)
16163 "This calls dvipng."
16164 (require 'org-latex)
16165 (let* ((tmpdir (if (featurep 'xemacs)
16166 (temp-directory)
16167 temporary-file-directory))
16168 (texfilebase (make-temp-name
16169 (expand-file-name "orgtex" tmpdir)))
16170 (texfile (concat texfilebase ".tex"))
16171 (dvifile (concat texfilebase ".dvi"))
16172 (pngfile (concat texfilebase ".png"))
16173 (fnh (if (featurep 'xemacs)
16174 (font-height (get-face-font 'default))
16175 (face-attribute 'default :height nil)))
16176 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16177 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16178 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16179 "Black"))
16180 (bg (or (plist-get options (if buffer :background :html-background))
16181 "Transparent")))
16182 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16183 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16184 (with-temp-file texfile
16185 (insert (org-splice-latex-header
16186 org-format-latex-header
16187 org-export-latex-default-packages-alist
16188 org-export-latex-packages-alist t
16189 org-format-latex-header-extra))
16191 (require 'org-latex)
16192 (org-export-latex-fix-inputenc))
16193 (let ((dir default-directory))
16194 (condition-case nil
16195 (progn
16196 (cd tmpdir)
16197 (call-process "latex" nil nil nil texfile))
16198 (error nil))
16199 (cd dir))
16200 (if (not (file-exists-p dvifile))
16201 (progn (message "Failed to create dvi file from %s" texfile) nil)
16202 (condition-case nil
16203 (call-process "dvipng" nil nil nil
16204 "-fg" fg "-bg" bg
16205 "-D" dpi
16206 ;;"-x" scale "-y" scale
16207 "-T" "tight"
16208 "-o" pngfile
16209 dvifile)
16210 (error nil))
16211 (if (not (file-exists-p pngfile))
16212 (if org-format-latex-signal-error
16213 (error "Failed to create png file from %s" texfile)
16214 (message "Failed to create png file from %s" texfile)
16215 nil)
16216 ;; Use the requested file name and clean up
16217 (copy-file pngfile tofile 'replace)
16218 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16219 (delete-file (concat texfilebase e)))
16220 pngfile))))
16222 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16223 "Fill a LaTeX header template TPL.
16224 In the template, the following place holders will be recognized:
16227 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16229 [NO-PACKAGES] do not include PKG
16230 [EXTRA] the string EXTRA
16231 [NO-EXTRA] do not include EXTRA
16233 For backward compatibility, if both the positive and the negative place
16235 assumed to be present at the end of the template.
16236 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16237 EXTRA is a string.
16238 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16239 (let (rpl (end ""))
16241 (setq rpl (if (or (match-end 1) (not def-pkg))
16242 "" (org-latex-packages-to-string def-pkg snippets-p t))
16243 tpl (replace-match rpl t t tpl))
16244 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16247 (setq rpl (if (or (match-end 1) (not pkg))
16248 "" (org-latex-packages-to-string pkg snippets-p t))
16249 tpl (replace-match rpl t t tpl))
16250 (if pkg (setq end
16252 (org-latex-packages-to-string pkg snippets-p)))))
16255 (setq rpl (if (or (match-end 1) (not extra))
16257 tpl (replace-match rpl t t tpl))
16263 tpl)))
16265 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16267 (setq pkg (mapconcat (lambda(p)
16268 (cond
16269 ((stringp p) p)
16270 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16271 (format "%% Package %s omitted" (cadr p)))
16272 ((equal "" (car p))
16274 (t
16276 (car p) (cadr p)))))
16277 pkg
16281 (defun org-dvipng-color (attr)
16282 "Return an rgb color specification for dvipng."
16283 (apply 'format "rgb %s %s %s"
16284 (mapcar 'org-normalize-color
16285 (color-values (face-attribute 'default attr nil)))))
16287 (defun org-normalize-color (value)
16288 "Return string to be used as color value for an RGB component."
16289 (format "%g" (/ value 65535.0)))
16291 ;; Image display
16294 (defvar org-inline-image-overlays nil)
16295 (make-variable-buffer-local 'org-inline-image-overlays)
16297 (defun org-toggle-inline-images (&optional include-linked)
16298 "Toggle the display of inline images.
16299 INCLUDE-LINKED is passed to `org-display-inline-images'."
16300 (interactive "P")
16301 (if org-inline-image-overlays
16302 (progn
16303 (org-remove-inline-images)
16304 (message "Inline image display turned off"))
16305 (org-display-inline-images include-linked)
16306 (if org-inline-image-overlays
16307 (message "%d images displayed inline"
16308 (length org-inline-image-overlays))
16309 (message "No images to display inline"))))
16311 (defun org-display-inline-images (&optional include-linked refresh beg end)
16312 "Display inline images.
16313 Normally only links without a description part are inlined, because this
16314 is how it will work for export. When INCLUDE-LINKED is set, also links
16315 with a description part will be inlined. This can be nice for a quick
16316 look at those images, but it does not reflect what exported files will look
16317 like.
16318 When REFRESH is set, refresh existing images between BEG and END.
16319 This will create new image displays only if necessary.
16320 BEG and END default to the buffer boundaries."
16321 (interactive "P")
16322 (unless refresh
16323 (org-remove-inline-images)
16324 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16325 (save-excursion
16326 (save-restriction
16327 (widen)
16328 (setq beg (or beg (point-min)) end (or end (point-max)))
16329 (goto-char (point-min))
16331 (substring (org-image-file-name-regexp) 0 -2)
16333 old file ov img)
16334 (while (re-search-forward re end t)
16335 (setq old (get-char-property-and-overlay (match-beginning 1)
16336 'org-image-overlay))
16337 (setq file (expand-file-name
16338 (concat (or (match-string 3) "") (match-string 4))))
16339 (when (file-exists-p file)
16340 (if (and (car-safe old) refresh)
16341 (image-refresh (overlay-get (cdr old) 'display))
16342 (setq img (save-match-data (create-image file)))
16343 (when img
16344 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16345 (overlay-put ov 'display img)
16346 (overlay-put ov 'face 'default)
16347 (overlay-put ov 'org-image-overlay t)
16348 (overlay-put ov 'modification-hooks
16349 (list 'org-display-inline-modification-hook))
16350 (push ov org-inline-image-overlays)))))))))
16352 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16353 "Remove inline-display overlay if a corresponding region is modified."
16354 (let ((inhibit-modification-hooks t))
16355 (when (and ov after)
16356 (delete ov org-inline-image-overlays)
16357 (delete-overlay ov))))
16359 (defun org-remove-inline-images ()
16360 "Remove inline display of images."
16361 (interactive)
16362 (mapc 'delete-overlay org-inline-image-overlays)
16363 (setq org-inline-image-overlays nil))
16365 ;;;; Key bindings
16367 ;; Make `C-c C-x' a prefix key
16368 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16370 ;; TAB key with modifiers
16371 (org-defkey org-mode-map "\C-i" 'org-cycle)
16372 (org-defkey org-mode-map [(tab)] 'org-cycle)
16373 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16374 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16376 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16377 ;; The following line is necessary under Suse GNU/Linux
16378 (unless (featurep 'xemacs)
16379 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16380 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16381 (define-key org-mode-map [backtab] 'org-shifttab)
16383 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16384 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16385 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16387 ;; Cursor keys with modifiers
16388 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16389 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16390 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16391 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16393 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16394 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16395 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16396 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16398 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16399 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16400 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16401 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16403 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16404 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16406 ;; Babel keys
16407 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16408 (mapc (lambda (pair)
16409 (define-key org-babel-map (car pair) (cdr pair)))
16410 org-babel-key-bindings)
16412 ;;; Extra keys for tty access.
16413 ;; We only set them when really needed because otherwise the
16414 ;; menus don't show the simple keys
16416 (when (or org-use-extra-keys
16417 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16418 (not window-system))
16419 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16420 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16421 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16422 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16423 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16424 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16425 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16426 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16427 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16428 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16429 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16430 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16431 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16432 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16433 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16434 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16435 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16436 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16437 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16438 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16439 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16440 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16441 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16442 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16443 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16444 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16445 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16446 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16448 ;; All the other keys
16450 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16451 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16452 (if (boundp 'narrow-map)
16453 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16454 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16455 (if (boundp 'narrow-map)
16456 (org-defkey narrow-map "b" 'org-narrow-to-block)
16457 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16458 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16459 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16460 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16461 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16462 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16463 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16464 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16465 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16466 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16467 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16468 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16469 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16470 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16471 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16472 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16473 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16475 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16476 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16477 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16478 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16479 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16480 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16481 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16482 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16483 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16484 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16485 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16486 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16487 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16488 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16489 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16490 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16491 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16492 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16493 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16495 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16496 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16497 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16498 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16499 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16500 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16501 (org-defkey org-mode-map "\C-c^" 'org-sort)
16502 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16503 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16504 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16505 (org-defkey org-mode-map "\C-m" 'org-return)
16506 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16507 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16508 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16509 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16510 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16511 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16512 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16513 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16514 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16515 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16516 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16517 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16518 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16519 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16520 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16521 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16522 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16523 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16524 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16525 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16526 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16527 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16529 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16530 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16531 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16532 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16534 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16535 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16536 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16537 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16538 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16539 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16540 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16541 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16542 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16543 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16545 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16546 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16547 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16548 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16549 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16550 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16551 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16553 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16554 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16555 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16556 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16557 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16559 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16561 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16563 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16564 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16566 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16569 (when (featurep 'xemacs)
16570 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16573 (defconst org-speed-commands-default
16574 '(
16575 ("Outline Navigation")
16576 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16577 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16578 ("f" . (org-speed-move-safe 'org-forward-same-level))
16579 ("b" . (org-speed-move-safe 'org-backward-same-level))
16580 ("u" . (org-speed-move-safe 'outline-up-heading))
16581 ("j" . org-goto)
16582 ("g" . (org-refile t))
16583 ("Outline Visibility")
16584 ("c" . org-cycle)
16585 ("C" . org-shifttab)
16586 (" " . org-display-outline-path)
16587 ("Outline Structure Editing")
16588 ("U" . org-shiftmetaup)
16589 ("D" . org-shiftmetadown)
16590 ("r" . org-metaright)
16591 ("l" . org-metaleft)
16592 ("R" . org-shiftmetaright)
16593 ("L" . org-shiftmetaleft)
16594 ("i" . (progn (forward-char 1) (call-interactively
16595 'org-insert-heading-respect-content)))
16596 ("^" . org-sort)
16597 ("w" . org-refile)
16598 ("a" . org-archive-subtree-default-with-confirmation)
16599 ("." . org-mark-subtree)
16600 ("Clock Commands")
16601 ("I" . org-clock-in)
16602 ("O" . org-clock-out)
16603 ("Meta Data Editing")
16604 ("t" . org-todo)
16605 ("0" . (org-priority ?\ ))
16606 ("1" . (org-priority ?A))
16607 ("2" . (org-priority ?B))
16608 ("3" . (org-priority ?C))
16609 (";" . org-set-tags-command)
16610 ("e" . org-set-effort)
16611 ("Agenda Views etc")
16612 ("v" . org-agenda)
16613 ("/" . org-sparse-tree)
16614 ("Misc")
16615 ("o" . org-open-at-point)
16616 ("?" . org-speed-command-help)
16617 ("<" . (org-agenda-set-restriction-lock 'subtree))
16618 (">" . (org-agenda-remove-restriction-lock))
16619 )
16620 "The default speed commands.")
16622 (defun org-print-speed-command (e)
16623 (if (> (length (car e)) 1)
16624 (progn
16626 (princ (car e))
16628 (princ (make-string (length (car e)) ?-))
16630 (princ (car e))
16631 (princ " ")
16632 (if (symbolp (cdr e))
16633 (princ (symbol-name (cdr e)))
16634 (prin1 (cdr e)))
16637 (defun org-speed-command-help ()
16638 "Show the available speed commands."
16639 (interactive)
16640 (if (not org-use-speed-commands)
16641 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16642 (with-output-to-temp-buffer "*Help*"
16644 (mapc 'org-print-speed-command org-speed-commands-user)
16647 (mapc 'org-print-speed-command org-speed-commands-default))
16648 (with-current-buffer "*Help*"
16649 (setq truncate-lines t))))
16651 (defun org-speed-move-safe (cmd)
16652 "Execute CMD, but make sure that the cursor always ends up in a headline.
16653 If not, return to the original position and throw an error."
16654 (interactive)
16655 (let ((pos (point)))
16656 (call-interactively cmd)
16657 (unless (and (bolp) (org-on-heading-p))
16658 (goto-char pos)
16659 (error "Boundary reached while executing %s" cmd))))
16661 (defvar org-self-insert-command-undo-counter 0)
16663 (defvar org-table-auto-blank-field) ; defined in org-table.el
16664 (defvar org-speed-command nil)
16666 (defun org-speed-command-default-hook (keys)
16667 "Hook for activating single-letter speed commands.
16668 `org-speed-commands-default' specifies a minimal command set. Use
16669 `org-speed-commands-user' for further customization."
16670 (when (or (and (bolp) (looking-at outline-regexp))
16671 (and (functionp org-use-speed-commands)
16672 (funcall org-use-speed-commands)))
16673 (cdr (assoc keys (append org-speed-commands-user
16674 org-speed-commands-default)))))
16676 (defun org-babel-speed-command-hook (keys)
16677 "Hook for activating single-letter code block commands."
16678 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16679 (cdr (assoc keys org-babel-key-bindings))))
16681 (defcustom org-speed-command-hook
16682 '(org-speed-command-default-hook org-babel-speed-command-hook)
16683 "Hook for activating speed commands at strategic locations.
16684 Hook functions are called in sequence until a valid handler is
16685 found.
16687 Each hook takes a single argument, a user-pressed command key
16688 which is also a `self-insert-command' from the global map.
16690 Within the hook, examine the cursor position and the command key
16691 and return nil or a valid handler as appropriate. Handler could
16692 be one of an interactive command, a function, or a form.
16694 Set `org-use-speed-commands' to non-nil value to enable this
16695 hook. The default setting is `org-speed-command-default-hook'."
16696 :group 'org-structure
16697 :type 'hook)
16699 (defun org-self-insert-command (N)
16700 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16701 If the cursor is in a table looking at whitespace, the whitespace is
16702 overwritten, and the table is not marked as requiring realignment."
16703 (interactive "p")
16704 (cond
16705 ((and org-use-speed-commands
16706 (setq org-speed-command
16707 (run-hook-with-args-until-success
16708 'org-speed-command-hook (this-command-keys))))
16709 (cond
16710 ((commandp org-speed-command)
16711 (setq this-command org-speed-command)
16712 (call-interactively org-speed-command))
16713 ((functionp org-speed-command)
16714 (funcall org-speed-command))
16715 ((and org-speed-command (listp org-speed-command))
16716 (eval org-speed-command))
16717 (t (let (org-use-speed-commands)
16718 (call-interactively 'org-self-insert-command)))))
16719 ((and
16720 (org-table-p)
16721 (progn
16722 ;; check if we blank the field, and if that triggers align
16723 (and (featurep 'org-table) org-table-auto-blank-field
16724 (member last-command
16725 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16727 ;; got extra space, this field does not determine column width
16728 (let (org-table-may-need-update) (org-table-blank-field))
16729 ;; no extra space, this field may determine column width
16730 (org-table-blank-field)))
16731 t)
16732 (eq N 1)
16734 (let (org-table-may-need-update)
16735 (goto-char (1- (match-end 0)))
16736 (delete-backward-char 1)
16737 (goto-char (match-beginning 0))
16738 (self-insert-command N)))
16739 (t
16740 (setq org-table-may-need-update t)
16741 (self-insert-command N)
16742 (org-fix-tags-on-the-fly)
16743 (if org-self-insert-cluster-for-undo
16744 (if (not (eq last-command 'org-self-insert-command))
16745 (setq org-self-insert-command-undo-counter 1)
16746 (if (>= org-self-insert-command-undo-counter 20)
16747 (setq org-self-insert-command-undo-counter 1)
16748 (and (> org-self-insert-command-undo-counter 0)
16749 buffer-undo-list
16750 (not (cadr buffer-undo-list)) ; remove nil entry
16751 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16752 (setq org-self-insert-command-undo-counter
16753 (1+ org-self-insert-command-undo-counter))))))))
16755 (defun org-fix-tags-on-the-fly ()
16756 (when (and (equal (char-after (point-at-bol)) ?*)
16757 (org-on-heading-p))
16758 (org-align-tags-here org-tags-column)))
16760 (defun org-delete-backward-char (N)
16761 "Like `delete-backward-char', insert whitespace at field end in tables.
16762 When deleting backwards, in tables this function will insert whitespace in
16764 still be marked for re-alignment if the field did fill the entire column,
16765 because, in this case the deletion might narrow the column."
16766 (interactive "p")
16767 (if (and (org-table-p)
16768 (eq N 1)
16769 (string-match "|" (buffer-substring (point-at-bol) (point)))
16770 (looking-at ".*?|"))
16771 (let ((pos (point))
16773 (c org-table-may-need-update))
16774 (backward-delete-char N)
16775 (if (not overwrite-mode)
16776 (progn
16777 (skip-chars-forward "^|")
16778 (insert " ")
16779 (goto-char (1- pos))))
16780 ;; noalign: if there were two spaces at the end, this field
16781 ;; does not determine the width of the column.
16782 (if noalign (setq org-table-may-need-update c)))
16783 (backward-delete-char N)
16784 (org-fix-tags-on-the-fly)))
16786 (defun org-delete-char (N)
16787 "Like `delete-char', but insert whitespace at field end in tables.
16788 When deleting characters, in tables this function will insert whitespace in
16790 still be marked for re-alignment if the field did fill the entire column,
16791 because, in this case the deletion might narrow the column."
16792 (interactive "p")
16793 (if (and (org-table-p)
16794 (not (bolp))
16795 (not (= (char-after) ?|))
16796 (eq N 1))
16797 (if (looking-at ".*?|")
16798 (let ((pos (point))
16800 (c org-table-may-need-update))
16801 (replace-match (concat
16802 (substring (match-string 0) 1 -1)
16803 " |"))
16804 (goto-char pos)
16805 ;; noalign: if there were two spaces at the end, this field
16806 ;; does not determine the width of the column.
16807 (if noalign (setq org-table-may-need-update c)))
16808 (delete-char N))
16809 (delete-char N)
16810 (org-fix-tags-on-the-fly)))
16812 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16813 (put 'org-self-insert-command 'delete-selection t)
16814 (put 'orgtbl-self-insert-command 'delete-selection t)
16815 (put 'org-delete-char 'delete-selection 'supersede)
16816 (put 'org-delete-backward-char 'delete-selection 'supersede)
16817 (put 'org-yank 'delete-selection 'yank)
16819 ;; Make `flyspell-mode' delay after some commands
16820 (put 'org-self-insert-command 'flyspell-delayed t)
16821 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16822 (put 'org-delete-char 'flyspell-delayed t)
16823 (put 'org-delete-backward-char 'flyspell-delayed t)
16825 ;; Make pabbrev-mode expand after org-mode commands
16826 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16827 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16829 ;; How to do this: Measure non-white length of current string
16830 ;; If equal to column width, we should realign.
16832 (defun org-remap (map &rest commands)
16833 "In MAP, remap the functions given in COMMANDS.
16834 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16835 (let (new old)
16836 (while commands
16837 (setq old (pop commands) new (pop commands))
16838 (if (fboundp 'command-remapping)
16839 (org-defkey map (vector 'remap old) new)
16840 (substitute-key-definition old new map global-map)))))
16842 (when (eq org-enable-table-editor 'optimized)
16843 ;; If the user wants maximum table support, we need to hijack
16844 ;; some standard editing functions
16845 (org-remap org-mode-map
16846 'self-insert-command 'org-self-insert-command
16847 'delete-char 'org-delete-char
16848 'delete-backward-char 'org-delete-backward-char)
16849 (org-defkey org-mode-map "|" 'org-force-self-insert))
16851 (defvar org-ctrl-c-ctrl-c-hook nil
16852 "Hook for functions attaching themselves to `C-c C-c'.
16853 This can be used to add additional functionality to the C-c C-c key which
16854 executes context-dependent commands.
16855 Each function will be called with no arguments. The function must check
16856 if the context is appropriate for it to act. If yes, it should do its
16857 thing and then return a non-nil value. If the context is wrong,
16858 just do nothing and return nil.")
16860 (defvar org-tab-first-hook nil
16861 "Hook for functions to attach themselves to TAB.
16862 See `org-ctrl-c-ctrl-c-hook' for more information.
16863 This hook runs as the first action when TAB is pressed, even before
16864 `org-cycle' messes around with the `outline-regexp' to cater for
16865 inline tasks and plain list item folding.
16866 If any function in this hook returns t, any other actions that
16867 would have been caused by TAB (such as table field motion or visibility
16868 cycling) will not occur.")
16870 (defvar org-tab-after-check-for-table-hook nil
16871 "Hook for functions to attach themselves to TAB.
16872 See `org-ctrl-c-ctrl-c-hook' for more information.
16873 This hook runs after it has been established that the cursor is not in a
16874 table, but before checking if the cursor is in a headline or if global cycling
16875 should be done.
16876 If any function in this hook returns t, not other actions like visibility
16877 cycling will be done.")
16879 (defvar org-tab-after-check-for-cycling-hook nil
16880 "Hook for functions to attach themselves to TAB.
16881 See `org-ctrl-c-ctrl-c-hook' for more information.
16882 This hook runs after it has been established that not table field motion and
16883 not visibility should be done because of current context. This is probably
16884 the place where a package like yasnippets can hook in.")
16886 (defvar org-tab-before-tab-emulation-hook nil
16887 "Hook for functions to attach themselves to TAB.
16888 See `org-ctrl-c-ctrl-c-hook' for more information.
16889 This hook runs after every other options for TAB have been exhausted, but
16892 (defvar org-metaleft-hook nil
16893 "Hook for functions attaching themselves to `M-left'.
16894 See `org-ctrl-c-ctrl-c-hook' for more information.")
16895 (defvar org-metaright-hook nil
16896 "Hook for functions attaching themselves to `M-right'.
16897 See `org-ctrl-c-ctrl-c-hook' for more information.")
16898 (defvar org-metaup-hook nil
16899 "Hook for functions attaching themselves to `M-up'.
16900 See `org-ctrl-c-ctrl-c-hook' for more information.")
16901 (defvar org-metadown-hook nil
16902 "Hook for functions attaching themselves to `M-down'.
16903 See `org-ctrl-c-ctrl-c-hook' for more information.")
16904 (defvar org-shiftmetaleft-hook nil
16905 "Hook for functions attaching themselves to `M-S-left'.
16906 See `org-ctrl-c-ctrl-c-hook' for more information.")
16907 (defvar org-shiftmetaright-hook nil
16908 "Hook for functions attaching themselves to `M-S-right'.
16909 See `org-ctrl-c-ctrl-c-hook' for more information.")
16910 (defvar org-shiftmetaup-hook nil
16911 "Hook for functions attaching themselves to `M-S-up'.
16912 See `org-ctrl-c-ctrl-c-hook' for more information.")
16913 (defvar org-shiftmetadown-hook nil
16914 "Hook for functions attaching themselves to `M-S-down'.
16915 See `org-ctrl-c-ctrl-c-hook' for more information.")
16916 (defvar org-metareturn-hook nil
16917 "Hook for functions attaching themselves to `M-RET'.
16918 See `org-ctrl-c-ctrl-c-hook' for more information.")
16919 (defvar org-shiftup-hook nil
16920 "Hook for functions attaching themselves to `S-up'.
16921 See `org-ctrl-c-ctrl-c-hook' for more information.")
16922 (defvar org-shiftup-final-hook nil
16923 "Hook for functions attaching themselves to `S-up'.
16924 This one runs after all other options except shift-select have been excluded.
16925 See `org-ctrl-c-ctrl-c-hook' for more information.")
16926 (defvar org-shiftdown-hook nil
16927 "Hook for functions attaching themselves to `S-down'.
16928 See `org-ctrl-c-ctrl-c-hook' for more information.")
16929 (defvar org-shiftdown-final-hook nil
16930 "Hook for functions attaching themselves to `S-down'.
16931 This one runs after all other options except shift-select have been excluded.
16932 See `org-ctrl-c-ctrl-c-hook' for more information.")
16933 (defvar org-shiftleft-hook nil
16934 "Hook for functions attaching themselves to `S-left'.
16935 See `org-ctrl-c-ctrl-c-hook' for more information.")
16936 (defvar org-shiftleft-final-hook nil
16937 "Hook for functions attaching themselves to `S-left'.
16938 This one runs after all other options except shift-select have been excluded.
16939 See `org-ctrl-c-ctrl-c-hook' for more information.")
16940 (defvar org-shiftright-hook nil
16941 "Hook for functions attaching themselves to `S-right'.
16942 See `org-ctrl-c-ctrl-c-hook' for more information.")
16943 (defvar org-shiftright-final-hook nil
16944 "Hook for functions attaching themselves to `S-right'.
16945 This one runs after all other options except shift-select have been excluded.
16946 See `org-ctrl-c-ctrl-c-hook' for more information.")
16948 (defun org-modifier-cursor-error ()
16949 "Throw an error, a modified cursor command was applied in wrong context."
16950 (error "This command is active in special context like tables, headlines or items"))
16952 (defun org-shiftselect-error ()
16953 "Throw an error because Shift-Cursor command was applied in wrong context."
16954 (if (and (boundp 'shift-select-mode) shift-select-mode)
16955 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16956 (error "This command works only in special context like headlines or timestamps")))
16958 (defun org-call-for-shift-select (cmd)
16959 (let ((this-command-keys-shift-translated t))
16960 (call-interactively cmd)))
16962 (defun org-shifttab (&optional arg)
16963 "Global visibility cycling or move to previous table field.
16964 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16965 on context.
16966 See the individual commands for more information."
16967 (interactive "P")
16968 (cond
16969 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16970 ((integerp arg)
16971 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16972 (message "Content view to level: %d" arg)
16973 (org-content (prefix-numeric-value arg2))
16974 (setq org-cycle-global-status 'overview)))
16975 (t (call-interactively 'org-global-cycle))))
16977 (defun org-shiftmetaleft ()
16978 "Promote subtree or delete table column.
16979 Calls `org-promote-subtree', `org-outdent-item',
16980 or `org-table-delete-column', depending on context.
16981 See the individual commands for more information."
16982 (interactive)
16983 (cond
16984 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16985 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16986 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16987 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16988 (t (org-modifier-cursor-error))))
16990 (defun org-shiftmetaright ()
16991 "Demote subtree or insert table column.
16992 Calls `org-demote-subtree', `org-indent-item',
16993 or `org-table-insert-column', depending on context.
16994 See the individual commands for more information."
16995 (interactive)
16996 (cond
16997 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16998 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16999 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17000 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17001 (t (org-modifier-cursor-error))))
17003 (defun org-shiftmetaup (&optional arg)
17004 "Move subtree up or kill table row.
17005 Calls `org-move-subtree-up' or `org-table-kill-row' or
17006 `org-move-item-up' depending on context. See the individual commands
17007 for more information."
17008 (interactive "P")
17009 (cond
17010 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17011 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17012 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17013 ((org-at-item-p) (call-interactively 'org-move-item-up))
17014 (t (org-modifier-cursor-error))))
17016 (defun org-shiftmetadown (&optional arg)
17017 "Move subtree down or insert table row.
17018 Calls `org-move-subtree-down' or `org-table-insert-row' or
17019 `org-move-item-down', depending on context. See the individual
17020 commands for more information."
17021 (interactive "P")
17022 (cond
17023 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17024 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17025 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17026 ((org-at-item-p) (call-interactively 'org-move-item-down))
17027 (t (org-modifier-cursor-error))))
17029 (defsubst org-hidden-tree-error ()
17030 (error
17031 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17033 (defun org-metaleft (&optional arg)
17034 "Promote heading or move table column to left.
17035 Calls `org-do-promote' or `org-table-move-column', depending on context.
17036 With no specific context, calls the Emacs default `backward-word'.
17037 See the individual commands for more information."
17038 (interactive "P")
17039 (cond
17040 ((run-hook-with-args-until-success 'org-metaleft-hook))
17041 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17042 ((or (org-on-heading-p)
17043 (and (org-region-active-p)
17044 (save-excursion
17045 (goto-char (region-beginning))
17046 (org-on-heading-p))))
17047 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17048 (call-interactively 'org-do-promote))
17049 ((or (org-at-item-p)
17050 (and (org-region-active-p)
17051 (save-excursion
17052 (goto-char (region-beginning))
17053 (org-at-item-p))))
17054 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17055 (call-interactively 'org-outdent-item))
17056 (t (call-interactively 'backward-word))))
17058 (defun org-metaright (&optional arg)
17059 "Demote subtree or move table column to right.
17060 Calls `org-do-demote' or `org-table-move-column', depending on context.
17061 With no specific context, calls the Emacs default `forward-word'.
17062 See the individual commands for more information."
17063 (interactive "P")
17064 (cond
17065 ((run-hook-with-args-until-success 'org-metaright-hook))
17066 ((org-at-table-p) (call-interactively 'org-table-move-column))
17067 ((or (org-on-heading-p)
17068 (and (org-region-active-p)
17069 (save-excursion
17070 (goto-char (region-beginning))
17071 (org-on-heading-p))))
17072 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17073 (call-interactively 'org-do-demote))
17074 ((or (org-at-item-p)
17075 (and (org-region-active-p)
17076 (save-excursion
17077 (goto-char (region-beginning))
17078 (org-at-item-p))))
17079 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17080 (call-interactively 'org-indent-item))
17081 (t (call-interactively 'forward-word))))
17083 (defun org-check-for-hidden (what)
17084 "Check if there are hidden headlines/items in the current visual line.
17085 WHAT can be either `headlines' or `items'. If the current line is
17086 an outline or item heading and it has a folded subtree below it,
17087 this function returns t, nil otherwise."
17088 (let ((re (cond
17089 ((eq what 'headlines) (concat "^" org-outline-regexp))
17090 ((eq what 'items) (org-item-beginning-re))
17091 (t (error "This should not happen"))))
17092 beg end)
17093 (save-excursion
17094 (catch 'exit
17095 (unless (org-region-active-p)
17096 (setq beg (point-at-bol))
17097 (beginning-of-line 2)
17098 (while (and (not (eobp)) ;; this is like `next-line'
17099 (get-char-property (1- (point)) 'invisible))
17100 (beginning-of-line 2))
17101 (setq end (point))
17102 (goto-char beg)
17103 (goto-char (point-at-eol))
17104 (setq end (max end (point)))
17105 (while (re-search-forward re end t)
17106 (if (get-char-property (match-beginning 0) 'invisible)
17107 (throw 'exit t))))
17108 nil))))
17110 (defun org-metaup (&optional arg)
17111 "Move subtree up or move table row up.
17112 Calls `org-move-subtree-up' or `org-table-move-row' or
17113 `org-move-item-up', depending on context. See the individual commands
17114 for more information."
17115 (interactive "P")
17116 (cond
17117 ((run-hook-with-args-until-success 'org-metaup-hook))
17118 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17119 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17120 ((org-at-item-p) (call-interactively 'org-move-item-up))
17121 (t (transpose-lines 1) (beginning-of-line -1))))
17123 (defun org-metadown (&optional arg)
17124 "Move subtree down or move table row down.
17125 Calls `org-move-subtree-down' or `org-table-move-row' or
17126 `org-move-item-down', depending on context. See the individual
17127 commands for more information."
17128 (interactive "P")
17129 (cond
17130 ((run-hook-with-args-until-success 'org-metadown-hook))
17131 ((org-at-table-p) (call-interactively 'org-table-move-row))
17132 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17133 ((org-at-item-p) (call-interactively 'org-move-item-down))
17134 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17136 (defun org-shiftup (&optional arg)
17137 "Increase item in timestamp or increase priority of current headline.
17138 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17139 depending on context. See the individual commands for more information."
17140 (interactive "P")
17141 (cond
17142 ((run-hook-with-args-until-success 'org-shiftup-hook))
17143 ((and org-support-shift-select (org-region-active-p))
17144 (org-call-for-shift-select 'previous-line))
17145 ((org-at-timestamp-p t)
17146 (call-interactively (if org-edit-timestamp-down-means-later
17147 'org-timestamp-down 'org-timestamp-up)))
17148 ((and (not (eq org-support-shift-select 'always))
17149 org-enable-priority-commands
17150 (org-on-heading-p))
17151 (call-interactively 'org-priority-up))
17152 ((and (not org-support-shift-select) (org-at-item-p))
17153 (call-interactively 'org-previous-item))
17154 ((org-clocktable-try-shift 'up arg))
17155 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17156 (org-support-shift-select
17157 (org-call-for-shift-select 'previous-line))
17158 (t (org-shiftselect-error))))
17160 (defun org-shiftdown (&optional arg)
17161 "Decrease item in timestamp or decrease priority of current headline.
17162 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17163 depending on context. See the individual commands for more information."
17164 (interactive "P")
17165 (cond
17166 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17167 ((and org-support-shift-select (org-region-active-p))
17168 (org-call-for-shift-select 'next-line))
17169 ((org-at-timestamp-p t)
17170 (call-interactively (if org-edit-timestamp-down-means-later
17171 'org-timestamp-up 'org-timestamp-down)))
17172 ((and (not (eq org-support-shift-select 'always))
17173 org-enable-priority-commands
17174 (org-on-heading-p))
17175 (call-interactively 'org-priority-down))
17176 ((and (not org-support-shift-select) (org-at-item-p))
17177 (call-interactively 'org-next-item))
17178 ((org-clocktable-try-shift 'down arg))
17179 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17180 (org-support-shift-select
17181 (org-call-for-shift-select 'next-line))
17182 (t (org-shiftselect-error))))
17184 (defun org-shiftright (&optional arg)
17185 "Cycle the thing at point or in the current line, depending on context.
17186 Depending on context, this does one of the following:
17188 - switch a timestamp at point one day into the future
17189 - on a headline, switch to the next TODO keyword.
17190 - on an item, switch entire list to the next bullet type
17191 - on a property line, switch to the next allowed value
17192 - on a clocktable definition line, move time block into the future"
17193 (interactive "P")
17194 (cond
17195 ((run-hook-with-args-until-success 'org-shiftright-hook))
17196 ((and org-support-shift-select (org-region-active-p))
17197 (org-call-for-shift-select 'forward-char))
17198 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17199 ((and (not (eq org-support-shift-select 'always))
17200 (org-on-heading-p))
17201 (let ((org-inhibit-logging
17202 (not org-treat-S-cursor-todo-selection-as-state-change))
17203 (org-inhibit-blocking
17204 (not org-treat-S-cursor-todo-selection-as-state-change)))
17205 (org-call-with-arg 'org-todo 'right)))
17206 ((or (and org-support-shift-select
17207 (not (eq org-support-shift-select 'always))
17208 (org-at-item-bullet-p))
17209 (and (not org-support-shift-select) (org-at-item-p)))
17210 (org-call-with-arg 'org-cycle-list-bullet nil))
17211 ((and (not (eq org-support-shift-select 'always))
17212 (org-at-property-p))
17213 (call-interactively 'org-property-next-allowed-value))
17214 ((org-clocktable-try-shift 'right arg))
17215 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17216 (org-support-shift-select
17217 (org-call-for-shift-select 'forward-char))
17218 (t (org-shiftselect-error))))
17220 (defun org-shiftleft (&optional arg)
17221 "Cycle the thing at point or in the current line, depending on context.
17222 Depending on context, this does one of the following:
17224 - switch a timestamp at point one day into the past
17225 - on a headline, switch to the previous TODO keyword.
17226 - on an item, switch entire list to the previous bullet type
17227 - on a property line, switch to the previous allowed value
17228 - on a clocktable definition line, move time block into the past"
17229 (interactive "P")
17230 (cond
17231 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17232 ((and org-support-shift-select (org-region-active-p))
17233 (org-call-for-shift-select 'backward-char))
17234 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17235 ((and (not (eq org-support-shift-select 'always))
17236 (org-on-heading-p))
17237 (let ((org-inhibit-logging
17238 (not org-treat-S-cursor-todo-selection-as-state-change))
17239 (org-inhibit-blocking
17240 (not org-treat-S-cursor-todo-selection-as-state-change)))
17241 (org-call-with-arg 'org-todo 'left)))
17242 ((or (and org-support-shift-select
17243 (not (eq org-support-shift-select 'always))
17244 (org-at-item-bullet-p))
17245 (and (not org-support-shift-select) (org-at-item-p)))
17246 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17247 ((and (not (eq org-support-shift-select 'always))
17248 (org-at-property-p))
17249 (call-interactively 'org-property-previous-allowed-value))
17250 ((org-clocktable-try-shift 'left arg))
17251 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17252 (org-support-shift-select
17253 (org-call-for-shift-select 'backward-char))
17254 (t (org-shiftselect-error))))
17256 (defun org-shiftcontrolright ()
17257 "Switch to next TODO set."
17258 (interactive)
17259 (cond
17260 ((and org-support-shift-select (org-region-active-p))
17261 (org-call-for-shift-select 'forward-word))
17262 ((and (not (eq org-support-shift-select 'always))
17263 (org-on-heading-p))
17264 (org-call-with-arg 'org-todo 'nextset))
17265 (org-support-shift-select
17266 (org-call-for-shift-select 'forward-word))
17267 (t (org-shiftselect-error))))
17269 (defun org-shiftcontrolleft ()
17270 "Switch to previous TODO set."
17271 (interactive)
17272 (cond
17273 ((and org-support-shift-select (org-region-active-p))
17274 (org-call-for-shift-select 'backward-word))
17275 ((and (not (eq org-support-shift-select 'always))
17276 (org-on-heading-p))
17277 (org-call-with-arg 'org-todo 'previousset))
17278 (org-support-shift-select
17279 (org-call-for-shift-select 'backward-word))
17280 (t (org-shiftselect-error))))
17282 (defun org-ctrl-c-ret ()
17283 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17284 (interactive)
17285 (cond
17286 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17287 (t (call-interactively 'org-insert-heading))))
17289 (defun org-copy-special ()
17290 "Copy region in table or copy current subtree.
17291 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17292 See the individual commands for more information."
17293 (interactive)
17294 (call-interactively
17295 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17297 (defun org-cut-special ()
17298 "Cut region in table or cut current subtree.
17299 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17300 See the individual commands for more information."
17301 (interactive)
17302 (call-interactively
17303 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17305 (defun org-paste-special (arg)
17306 "Paste rectangular region into table, or past subtree relative to level.
17307 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17308 See the individual commands for more information."
17309 (interactive "P")
17310 (if (org-at-table-p)
17311 (org-table-paste-rectangle)
17312 (org-paste-subtree arg)))
17314 (defun org-edit-special (&optional arg)
17315 "Call a special editor for the stuff at point.
17316 When at a table, call the formula editor with `org-table-edit-formulas'.
17317 When at the first line of an src example, call `org-edit-src-code'.
17318 When in an #+include line, visit the include file. Otherwise call
17319 `ffap' to visit the file at point."
17320 (interactive)
17321 ;; possibly prep session before editing source
17322 (when arg
17323 (let* ((info (org-babel-get-src-block-info))
17324 (lang (nth 0 info))
17325 (params (nth 2 info))
17326 (session (cdr (assoc :session params))))
17327 (when (and info session) ;; we are in a source-code block with a session
17328 (funcall
17329 (intern (concat "org-babel-prep-session:" lang)) session params))))
17330 (cond ;; proceed with `org-edit-special'
17331 ((save-excursion
17332 (beginning-of-line 1)
17333 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17334 (find-file (org-trim (match-string 1))))
17335 ((org-edit-src-code))
17336 ((org-edit-fixed-width-region))
17337 ((org-at-table.el-p)
17338 (org-edit-src-code))
17339 ((or (org-at-table-p)
17340 (save-excursion
17341 (beginning-of-line 1)
17343 (call-interactively 'org-table-edit-formulas))
17344 (t (call-interactively 'ffap))))
17346 (defun org-ctrl-c-ctrl-c (&optional arg)
17347 "Set tags in headline, or update according to changed information at point.
17349 This command does many different things, depending on context:
17351 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17352 this is what we do.
17354 - If the cursor is on a statistics cookie, update it.
17356 - If the cursor is in a headline, prompt for tags and insert them
17357 into the current line, aligned to `org-tags-column'. When called
17358 with prefix arg, realign all tags in the current buffer.
17360 - If the cursor is in one of the special #+KEYWORD lines, this
17361 triggers scanning the buffer for these lines and updating the
17362 information.
17364 - If the cursor is inside a table, realign the table. This command
17365 works even if the automatic table editor has been turned off.
17367 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17368 the entire table.
17370 - If the cursor is at a footnote reference or definition, jump to
17371 the corresponding definition or references, respectively.
17373 - If the cursor is a the beginning of a dynamic block, update it.
17375 - If the current buffer is a capture buffer, close note and file it.
17377 - If the cursor is on a <<<target>>>, update radio targets and
17378 corresponding links in this buffer.
17380 - If the cursor is on a numbered item in a plain list, renumber the
17381 ordered list.
17383 - If the cursor is on a checkbox, toggle it.
17385 - If the cursor is on a code block, evaluate it. The variable
17386 `org-confirm-babel-evaluate' can be used to control prompting
17387 before code block evaluation, by default every code block
17388 evaluation requires confirmation. Code block evaluation can be
17389 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17390 (interactive "P")
17391 (let ((org-enable-table-editor t))
17392 (cond
17393 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17394 org-occur-highlights
17395 org-latex-fragment-image-overlays)
17396 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17397 (org-remove-occur-highlights)
17398 (org-remove-latex-fragment-image-overlays)
17399 (message "Temporary highlights/overlays removed from current buffer"))
17400 ((and (local-variable-p 'org-finish-function (current-buffer))
17401 (fboundp org-finish-function))
17402 (funcall org-finish-function))
17403 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17404 ((or (looking-at org-property-start-re)
17405 (org-at-property-p))
17406 (call-interactively 'org-property-action))
17407 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17409 (or (org-on-heading-p) (org-at-item-p)))
17410 (call-interactively 'org-update-statistics-cookies))
17411 ((org-on-heading-p) (call-interactively 'org-set-tags))
17412 ((org-at-table.el-p)
17413 (message "Use C-c ' to edit table.el tables"))
17414 ((org-at-table-p)
17415 (org-table-maybe-eval-formula)
17416 (if arg
17417 (call-interactively 'org-table-recalculate)
17418 (org-table-maybe-recalculate-line))
17419 (call-interactively 'org-table-align)
17420 (orgtbl-send-table 'maybe))
17421 ((or (org-footnote-at-reference-p)
17422 (org-footnote-at-definition-p))
17423 (call-interactively 'org-footnote-action))
17424 ((org-at-item-checkbox-p)
17425 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17426 ;; list only if at top item.
17427 (let* ((cbox (match-string 1))
17428 (struct (org-list-struct))
17429 (old-struct (copy-tree struct))
17430 (parents (org-list-parents-alist struct))
17431 (prevs (org-list-prevs-alist struct))
17432 (orderedp (org-entry-get nil "ORDERED"))
17433 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17434 block-item)
17435 ;; Use a light version of `org-toggle-checkbox' to avoid
17436 ;; computing list structure twice.
17437 (org-list-set-checkbox (point-at-bol) struct
17438 (cond
17439 ((equal arg '(16)) "[-]")
17440 ((equal arg '(4)) nil)
17441 ((equal "[ ]" cbox) "[X]")
17442 (t "[ ]")))
17443 (org-list-struct-fix-ind struct parents)
17444 (org-list-struct-fix-bul struct prevs)
17445 (setq block-item
17446 (org-list-struct-fix-box struct parents prevs orderedp))
17447 (when block-item
17448 (message
17449 "Checkboxes were removed due to unchecked box at line %d"
17450 (org-current-line block-item)))
17451 (org-list-struct-apply-struct struct old-struct)
17452 (org-update-checkbox-count-maybe)
17453 (when firstp (org-list-send-list 'maybe))))
17454 ((org-at-item-p)
17455 ;; Cursor at an item: repair list. Do checkbox related actions
17456 ;; only if function was called with an argument. Send list only
17457 ;; if at top item.
17458 (let* ((struct (org-list-struct))
17459 (old-struct (copy-tree struct))
17460 (parents (org-list-parents-alist struct))
17461 (prevs (org-list-prevs-alist struct))
17462 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17463 (org-list-struct-fix-ind struct parents)
17464 (org-list-struct-fix-bul struct prevs)
17465 (when arg
17466 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17467 (org-list-struct-fix-box struct parents prevs))
17468 (org-list-struct-apply-struct struct old-struct)
17469 (when arg (org-update-checkbox-count-maybe))
17470 (when firstp (org-list-send-list 'maybe))))
17471 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17472 ;; Dynamic block
17473 (beginning-of-line 1)
17474 (save-excursion (org-update-dblock)))
17475 ((save-excursion
17476 (beginning-of-line 1)
17478 (cond
17479 ((equal (match-string 1) "TBLFM")
17480 ;; Recalculate the table before this line
17481 (save-excursion
17482 (beginning-of-line 1)
17484 (if (org-at-table-p)
17485 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17486 (t
17487 (let ((org-inhibit-startup-visibility-stuff t)
17488 (org-startup-align-all-tables nil))
17489 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17490 (message "Local setup has been refreshed"))))
17491 ((org-clock-update-time-maybe))
17492 (t (error "C-c C-c can do nothing useful at this location")))))
17494 (defun org-mode-restart ()
17495 "Restart Org-mode, to scan again for special lines.
17496 Also updates the keyword regular expressions."
17497 (interactive)
17498 (org-mode)
17499 (message "Org-mode restarted"))
17501 (defun org-kill-note-or-show-branches ()
17502 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17503 (interactive)
17504 (if (not org-finish-function)
17505 (progn
17506 (hide-subtree)
17507 (call-interactively 'show-branches))
17508 (let ((org-note-abort t))
17509 (funcall org-finish-function))))
17511 (defun org-return (&optional indent)
17512 "Goto next table row or insert a newline.
17513 Calls `org-table-next-row' or `newline', depending on context.
17514 See the individual commands for more information."
17515 (interactive)
17516 (cond
17517 ((bobp) (if indent (newline-and-indent) (newline)))
17518 ((org-at-table-p)
17519 (org-table-justify-field-maybe)
17520 (call-interactively 'org-table-next-row))
17521 ;; when `newline-and-indent' is called within a list, make sure
17522 ;; text moved stays inside the item.
17523 ((and (org-in-item-p) indent)
17524 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17525 (progn
17526 (newline)
17527 (org-indent-line-to (length (match-string 0))))
17528 (let ((ind (org-get-indentation)))
17529 (newline)
17530 (if (org-looking-back org-list-end-re)
17531 (org-indent-line-function)
17532 (org-indent-line-to ind)))))
17533 ((and org-return-follows-link
17534 (eq (get-text-property (point) 'face) 'org-link))
17535 (call-interactively 'org-open-at-point))
17536 ((and (org-at-heading-p)
17537 (looking-at
17539 (org-show-entry)
17540 (end-of-line 1)
17541 (newline))
17542 (t (if indent (newline-and-indent) (newline)))))
17544 (defun org-return-indent ()
17545 "Goto next table row or insert a newline and indent.
17546 Calls `org-table-next-row' or `newline-and-indent', depending on
17547 context. See the individual commands for more information."
17548 (interactive)
17549 (org-return t))
17551 (defun org-ctrl-c-star ()
17552 "Compute table, or change heading status of lines.
17553 Calls `org-table-recalculate' or `org-toggle-heading',
17554 depending on context."
17555 (interactive)
17556 (cond
17557 ((org-at-table-p)
17558 (call-interactively 'org-table-recalculate))
17559 (t
17560 ;; Convert all lines in region to list items
17561 (call-interactively 'org-toggle-heading))))
17563 (defun org-ctrl-c-minus ()
17564 "Insert separator line in table or modify bullet status of line.
17565 Also turns a plain line or a region of lines into list items.
17566 Calls `org-table-insert-hline', `org-toggle-item', or
17567 `org-cycle-list-bullet', depending on context."
17568 (interactive)
17569 (cond
17570 ((org-at-table-p)
17571 (call-interactively 'org-table-insert-hline))
17572 ((org-region-active-p)
17573 (call-interactively 'org-toggle-item))
17574 ((org-in-item-p)
17575 (call-interactively 'org-cycle-list-bullet))
17576 (t
17577 (call-interactively 'org-toggle-item))))
17579 (defun org-toggle-item (arg)
17580 "Convert headings or normal lines to items, items to normal lines.
17581 If there is no active region, only the current line is considered.
17583 If the first non blank line in the region is an headline, convert
17584 all headlines to items.
17586 If it is an item, convert all items to normal lines.
17588 If it is normal text, change region into an item. With a prefix
17589 argument ARG, change each line in region into an item."
17590 (interactive "P")
17591 (let (l2 l beg end)
17592 (if (org-region-active-p)
17593 (setq beg (region-beginning) end (region-end))
17594 (setq beg (point-at-bol)
17595 end (min (1+ (point-at-eol)) (point-max))))
17596 (org-with-limited-levels
17597 (save-excursion
17598 (goto-char end)
17599 (setq l2 (org-current-line))
17600 (goto-char beg)
17601 (beginning-of-line 1)
17602 ;; Ignore blank lines at beginning of region
17604 (beginning-of-line 1)
17605 (setq l (1- (org-current-line)))
17606 (cond
17607 ;; Case 1. Start at an item: de-itemize.
17608 ((org-at-item-p)
17609 (while (< (setq l (1+ l)) l2)
17610 (when (org-at-item-p)
17612 (delete-region (point) (match-end 0)))
17613 (beginning-of-line 2)))
17614 ;; Case 2. Start an an heading: convert to items.
17615 ((org-on-heading-p)
17616 (let* ((bul (org-list-bullet-string "-"))
17617 (len (length bul))
17618 (ind 0) (level 0))
17619 (while (< (setq l (1+ l)) l2)
17620 (cond
17621 ((looking-at outline-regexp)
17622 (let* ((lvl (org-reduced-level
17623 (- (length (match-string 0)) 2)))
17624 (s (concat (make-string (* len lvl) ? ) bul)))
17625 (replace-match s t t)
17626 (setq ind (length s) level lvl)))
17627 ;; Ignore blank lines and inline tasks.
17630 ;; Ensure normal text belongs to the new item.
17631 (t (org-indent-line-to (+ (max (- (org-get-indentation) level 2) 0)
17632 ind))))
17633 (beginning-of-line 2))))
17634 ;; Case 3. Normal line with ARG: turn each of them into items
17635 ;; unless they are already one.
17636 (arg
17637 (while (< (setq l (1+ l)) l2)
17638 (unless (or (org-on-heading-p) (org-at-item-p))
17640 (replace-match
17642 (beginning-of-line 2)))
17643 ;; Case 4. Normal line without ARG: make the first line of
17644 ;; region an item, and shift indentation of others
17645 ;; lines to set them as item's body.
17646 (t (let* ((bul (org-list-bullet-string "-"))
17647 (bul-len (length bul))
17648 (ref-ind (org-get-indentation)))
17650 (insert bul)
17651 (beginning-of-line 2)
17652 (while (and (< (setq l (1+ l)) l2) (< (point) end))
17653 ;; Ensure that lines less indented than first one
17654 ;; still get included in item body.
17655 (org-indent-line-to (+ (max ref-ind (org-get-indentation))
17656 bul-len))
17657 (beginning-of-line 2)))))))))
17659 (defun org-toggle-heading (&optional nstars)
17660 "Convert headings to normal text, or items or text to headings.
17661 If there is no active region, only the current line is considered.
17663 If the first non blank line is an headline, remove the stars from
17664 all headlines in the region.
17666 If it is a plain list item, turn all plain list items into headings.
17668 If it is a normal line, turn each and every normal line (i.e. not
17669 an heading or an item) in the region into a heading.
17671 When converting a line into a heading, the number of stars is chosen
17672 such that the lines become children of the current entry. However,
17673 when a prefix argument is given, its value determines the number of
17674 stars to add."
17675 (interactive "P")
17676 (let (l2 l itemp beg end)
17677 (if (org-region-active-p)
17678 (setq beg (region-beginning) end (copy-marker (region-end)))
17679 (setq beg (point-at-bol)
17680 end (min (1+ (point-at-eol)) (point-max))))
17681 ;; Ensure inline tasks don't count as headings.
17682 (org-with-limited-levels
17683 (save-excursion
17684 (goto-char end)
17685 (setq l2 (org-current-line))
17686 (goto-char beg)
17687 (beginning-of-line 1)
17688 ;; Ignore blank lines at beginning of region
17690 (beginning-of-line 1)
17691 (setq l (1- (org-current-line)))
17692 (cond
17693 ;; Case 1. Started at an heading: de-star headings.
17694 ((org-on-heading-p)
17695 (while (< (setq l (1+ l)) l2)
17696 (when (org-on-heading-p t)
17697 (looking-at outline-regexp) (replace-match ""))
17698 (beginning-of-line 2)))
17699 ;; Case 2. Started at an item: change items into headlines.
17700 ((org-at-item-p)
17701 (let ((stars (make-string
17702 (if nstars
17703 (prefix-numeric-value current-prefix-arg)
17704 (or (org-current-level) 0))
17705 ?*)))
17706 (while (< (point) end)
17707 (when (org-at-item-p)
17708 ;; Pay attention to cases when region ends before list.
17709 (let* ((struct (org-list-struct))
17710 (list-end (min (org-list-get-bottom-point struct) end)))
17711 (save-restriction
17712 (narrow-to-region (point) list-end)
17713 (insert
17714 (org-list-to-subtree
17715 (org-list-parse-list t)
17716 '(:istart (concat stars (funcall get-stars depth))
17717 :icount (concat stars
17718 (funcall get-stars depth))))))))
17719 (beginning-of-line 2))))
17720 ;; Case 3. Started at normal text: make every line an heading,
17721 ;; skipping headlines and items.
17722 (t (let* ((stars (make-string
17723 (if nstars
17724 (prefix-numeric-value current-prefix-arg)
17725 (or (org-current-level) 0))
17726 ?*))
17727 (add-stars (cond (nstars "")
17728 ((equal stars "") "*")
17729 (org-odd-levels-only "**")
17730 (t "*")))
17731 (rpl (concat stars add-stars " ")))
17732 (while (< (setq l (1+ l)) l2)
17733 (unless (or (org-on-heading-p) (org-at-item-p))
17735 (replace-match (concat rpl (match-string 2)))))
17736 (beginning-of-line 2)))))))))
17738 (defun org-meta-return (&optional arg)
17739 "Insert a new heading or wrap a region in a table.
17740 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17741 See the individual commands for more information."
17742 (interactive "P")
17743 (cond
17744 ((run-hook-with-args-until-success 'org-metareturn-hook))
17745 ((org-at-table-p)
17746 (call-interactively 'org-table-wrap-region))
17747 (t (call-interactively 'org-insert-heading))))
17749 ;;; Menu entries
17751 ;; Define the Org-mode menus
17752 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17753 '("Tbl"
17754 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17755 ["Next Field" org-cycle (org-at-table-p)]
17756 ["Previous Field" org-shifttab (org-at-table-p)]
17757 ["Next Row" org-return (org-at-table-p)]
17758 "--"
17759 ["Blank Field" org-table-blank-field (org-at-table-p)]
17760 ["Edit Field" org-table-edit-field (org-at-table-p)]
17761 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17762 "--"
17763 ("Column"
17764 ["Move Column Left" org-metaleft (org-at-table-p)]
17765 ["Move Column Right" org-metaright (org-at-table-p)]
17766 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17767 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17768 ("Row"
17769 ["Move Row Up" org-metaup (org-at-table-p)]
17770 ["Move Row Down" org-metadown (org-at-table-p)]
17771 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17772 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17773 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17774 "--"
17775 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17776 ("Rectangle"
17777 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17778 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17779 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17780 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17781 "--"
17782 ("Calculate"
17783 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17784 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17785 ["Edit Formulas" org-edit-special (org-at-table-p)]
17786 "--"
17787 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17788 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17789 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17790 "--"
17791 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17792 "--"
17793 ["Sum Column/Rectangle" org-table-sum
17794 (or (org-at-table-p) (org-region-active-p))]
17795 ["Which Column?" org-table-current-column (org-at-table-p)])
17796 ["Debug Formulas"
17797 org-table-toggle-formula-debugger
17798 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17799 ["Show Col/Row Numbers"
17800 org-table-toggle-coordinate-overlays
17801 :style toggle
17802 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17803 "--"
17804 ["Create" org-table-create (and (not (org-at-table-p))
17805 org-enable-table-editor)]
17806 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17807 ["Import from File" org-table-import (not (org-at-table-p))]
17808 ["Export to File" org-table-export (org-at-table-p)]
17809 "--"
17810 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17812 (easy-menu-define org-org-menu org-mode-map "Org menu"
17813 '("Org"
17814 ("Show/Hide"
17815 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17816 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17817 ["Sparse Tree..." org-sparse-tree t]
17818 ["Reveal Context" org-reveal t]
17819 ["Show All" show-all t]
17820 "--"
17821 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17822 "--"
17823 ["New Heading" org-insert-heading t]
17824 ("Navigate Headings"
17825 ["Up" outline-up-heading t]
17826 ["Next" outline-next-visible-heading t]
17827 ["Previous" outline-previous-visible-heading t]
17828 ["Next Same Level" outline-forward-same-level t]
17829 ["Previous Same Level" outline-backward-same-level t]
17830 "--"
17831 ["Jump" org-goto t])
17832 ("Edit Structure"
17833 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17834 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17835 "--"
17836 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17837 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17838 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17839 "--"
17840 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17841 "--"
17842 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17843 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17844 ["Demote Heading" org-metaright (not (org-at-table-p))]
17845 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17846 "--"
17847 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17848 "--"
17849 ["Convert to odd levels" org-convert-to-odd-levels t]
17850 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17851 ("Editing"
17852 ["Emphasis..." org-emphasize t]
17853 ["Edit Source Example" org-edit-special t]
17854 "--"
17855 ["Footnote new/jump" org-footnote-action t]
17856 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17857 ("Archive"
17858 ["Archive (default method)" org-archive-subtree-default t]
17859 "--"
17860 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17861 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17862 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17863 )
17864 "--"
17865 ("Hyperlinks"
17866 ["Store Link (Global)" org-store-link t]
17867 ["Find existing link to here" org-occur-link-in-agenda-files t]
17868 ["Insert Link" org-insert-link t]
17869 ["Follow Link" org-open-at-point t]
17870 "--"
17871 ["Next link" org-next-link t]
17872 ["Previous link" org-previous-link t]
17873 "--"
17874 ["Descriptive Links"
17875 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17876 :style radio
17877 :selected (member '(org-link) buffer-invisibility-spec)]
17878 ["Literal Links"
17879 (progn
17880 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17881 :style radio
17882 :selected (not (member '(org-link) buffer-invisibility-spec))])
17883 "--"
17884 ("TODO Lists"
17885 ["TODO/DONE/-" org-todo t]
17886 ("Select keyword"
17887 ["Next keyword" org-shiftright (org-on-heading-p)]
17888 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17889 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17890 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17891 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17892 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17893 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17894 "--"
17895 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17896 :selected org-enforce-todo-dependencies :style toggle :active t]
17897 "Settings for tree at point"
17898 ["Do Children sequentially" org-toggle-ordered-property :style radio
17899 :selected (org-entry-get nil "ORDERED")
17900 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17901 ["Do Children parallel" org-toggle-ordered-property :style radio
17902 :selected (not (org-entry-get nil "ORDERED"))
17903 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17904 "--"
17905 ["Set Priority" org-priority t]
17906 ["Priority Up" org-shiftup t]
17907 ["Priority Down" org-shiftdown t]
17908 "--"
17909 ["Get news from all feeds" org-feed-update-all t]
17910 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17911 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17912 ("TAGS and Properties"
17913 ["Set Tags" org-set-tags-command t]
17914 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17915 "--"
17916 ["Set property" org-set-property t]
17917 ["Column view of properties" org-columns t]
17918 ["Insert Column View DBlock" org-insert-columns-dblock t])
17919 ("Dates and Scheduling"
17920 ["Timestamp" org-time-stamp t]
17921 ["Timestamp (inactive)" org-time-stamp-inactive t]
17922 ("Change Date"
17923 ["1 Day Later" org-shiftright t]
17924 ["1 Day Earlier" org-shiftleft t]
17925 ["1 ... Later" org-shiftup t]
17926 ["1 ... Earlier" org-shiftdown t])
17927 ["Compute Time Range" org-evaluate-time-range t]
17928 ["Schedule Item" org-schedule t]
17929 ["Deadline" org-deadline t]
17930 "--"
17931 ["Custom time format" org-toggle-time-stamp-overlays
17932 :style radio :selected org-display-custom-times]
17933 "--"
17934 ["Goto Calendar" org-goto-calendar t]
17935 ["Date from Calendar" org-date-from-calendar t]
17936 "--"
17937 ["Start/Restart Timer" org-timer-start t]
17938 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17939 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17940 ["Insert Timer String" org-timer t]
17941 ["Insert Timer Item" org-timer-item t])
17942 ("Logging work"
17943 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17944 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17945 ["Clock out" org-clock-out t]
17946 ["Clock cancel" org-clock-cancel t]
17947 "--"
17948 ["Mark as default task" org-clock-mark-default-task t]
17949 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17950 ["Goto running clock" org-clock-goto t]
17951 "--"
17952 ["Display times" org-clock-display t]
17953 ["Create clock table" org-clock-report t]
17954 "--"
17955 ["Record DONE time"
17956 (progn (setq org-log-done (not org-log-done))
17957 (message "Switching to %s will %s record a timestamp"
17958 (car org-done-keywords)
17959 (if org-log-done "automatically" "not")))
17960 :style toggle :selected org-log-done])
17961 "--"
17962 ["Agenda Command..." org-agenda t]
17963 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17964 ("File List for Agenda")
17965 ("Special views current file"
17966 ["TODO Tree" org-show-todo-tree t]
17967 ["Check Deadlines" org-check-deadlines t]
17968 ["Timeline" org-timeline t]
17969 ["Tags/Property tree" org-match-sparse-tree t])
17970 "--"
17971 ["Export/Publish..." org-export t]
17972 ("LaTeX"
17973 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17974 :selected org-cdlatex-mode]
17975 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17976 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17977 ["Modify math symbol" org-cdlatex-math-modify
17978 (org-inside-LaTeX-fragment-p)]
17979 ["Insert citation" org-reftex-citation t]
17980 "--"
17981 ["Template for BEAMER" org-insert-beamer-options-template t])
17982 "--"
17983 ("MobileOrg"
17984 ["Push Files and Views" org-mobile-push t]
17985 ["Get Captured and Flagged" org-mobile-pull t]
17986 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17987 "--"
17988 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17989 "--"
17990 ("Documentation"
17991 ["Show Version" org-version t]
17992 ["Info Documentation" org-info t])
17993 ("Customize"
17994 ["Browse Org Group" org-customize t]
17995 "--"
17996 ["Expand This Menu" org-create-customize-menu
17997 (fboundp 'customize-menu-create)])
17998 ["Send bug report" org-submit-bug-report t]
17999 "--"
18000 ("Refresh/Reload"
18001 ["Refresh setup current buffer" org-mode-restart t]
18002 ["Reload Org (after update)" org-reload t]
18003 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18004 ))
18006 (defun org-info (&optional node)
18007 "Read documentation for Org-mode in the info system.
18008 With optional NODE, go directly to that node."
18009 (interactive)
18010 (info (format "(org)%s" (or node ""))))
18012 ;;;###autoload
18013 (defun org-submit-bug-report ()
18014 "Submit a bug report on Org-mode via mail.
18016 Don't hesitate to report any problems or inaccurate documentation.
18018 If you don't have setup sending mail from (X)Emacs, please copy the
18019 output buffer into your mail program, as it gives us important
18020 information about your Org-mode version and configuration."
18021 (interactive)
18022 (require 'reporter)
18023 (org-load-modules-maybe)
18024 (org-require-autoloaded-modules)
18025 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18026 (reporter-submit-bug-report
18027 "emacs-orgmode@gnu.org"
18028 (org-version)
18029 (let (list)
18030 (save-window-excursion
18031 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
18032 (delete-other-windows)
18033 (erase-buffer)
18034 (insert "You are about to submit a bug report to the Org-mode mailing list.
18036 We would like to add your full Org-mode and Outline configuration to the
18037 bug report. This greatly simplifies the work of the maintainer and
18038 other experts on the mailing list.
18040 HOWEVER, some variables you have customized may contain private
18041 information. The names of customers, colleagues, or friends, might
18042 appear in the form of file names, tags, todo states, or search strings.
18043 If you answer yes to the prompt, you might want to check and remove
18044 such private information before sending the email.")
18045 (add-text-properties (point-min) (point-max) '(face org-warning))
18046 (when (yes-or-no-p "Include your Org-mode configuration ")
18047 (mapatoms
18048 (lambda (v)
18049 (and (boundp v)
18051 (or (and (symbol-value v)
18053 (and
18054 (get v 'custom-type) (get v 'standard-value)
18055 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18056 (push v list)))))
18057 (kill-buffer (get-buffer "*Warn about privacy*"))
18058 list))
18059 nil nil
18060 "Remember to cover the basics, that is, what you expected to happen and
18061 what in fact did happen. You don't know how to make a good report? See
18063 http://orgmode.org/manual/Feedback.html#Feedback
18065 Your bug report will be posted to the Org-mode mailing list.
18066 ------------------------------------------------------------------------")
18067 (save-excursion
18072 (defun org-install-agenda-files-menu ()
18073 (let ((bl (buffer-list)))
18074 (save-excursion
18075 (while bl
18076 (set-buffer (pop bl))
18077 (if (org-mode-p) (setq bl nil)))
18078 (when (org-mode-p)
18079 (easy-menu-change
18080 '("Org") "File List for Agenda"
18081 (append
18082 (list
18083 ["Edit File List" (org-edit-agenda-file-list) t]
18084 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18085 ["Remove Current File from List" org-remove-file t]
18086 ["Cycle through agenda files" org-cycle-agenda-files t]
18087 ["Occur in all agenda files" org-occur-in-agenda-files t]
18088 "--")
18089 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18091 ;;;; Documentation
18093 ;;;###autoload
18094 (defun org-require-autoloaded-modules ()
18095 (interactive)
18096 (mapc 'require
18097 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18098 org-docbook org-exp org-html org-icalendar
18099 org-id org-latex
18100 org-publish org-remember org-table
18101 org-timer org-xoxo)))
18103 ;;;###autoload
18104 (defun org-reload (&optional uncompiled)
18105 "Reload all org lisp files.
18106 With prefix arg UNCOMPILED, load the uncompiled versions."
18107 (interactive "P")
18108 (require 'find-func)
18110 (dir-org (file-name-directory (org-find-library-name "org")))
18111 (dir-org-contrib (ignore-errors
18112 (file-name-directory
18113 (org-find-library-name "org-contribdir"))))
18114 (babel-files
18115 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18116 (append (list nil "comint" "eval" "exp" "keys"
18117 "lob" "ref" "table" "tangle")
18118 (delq nil
18119 (mapcar
18120 (lambda (lang)
18121 (when (cdr lang) (symbol-name (car lang))))
18122 org-babel-load-languages)))))
18123 (files
18124 (append (directory-files dir-org t file-re)
18125 babel-files
18126 (and dir-org-contrib
18127 (directory-files dir-org-contrib t file-re))))
18128 (remove-re (concat (if (featurep 'xemacs)
18129 "org-colview" "org-colview-xemacs")
18131 (setq files (mapcar 'file-name-sans-extension files))
18132 (setq files (mapcar
18133 (lambda (x) (if (string-match remove-re x) nil x))
18134 files))
18135 (setq files (delq nil files))
18136 (mapc
18137 (lambda (f)
18138 (when (featurep (intern (file-name-nondirectory f)))
18139 (if (and (not uncompiled)
18140 (file-exists-p (concat f ".elc")))
18141 (load (concat f ".elc") nil nil t)
18142 (load (concat f ".el") nil nil t))))
18143 files))
18144 (org-version))
18146 ;;;###autoload
18147 (defun org-customize ()
18148 "Call the customize function with org as argument."
18149 (interactive)
18150 (org-load-modules-maybe)
18151 (org-require-autoloaded-modules)
18152 (customize-browse 'org))
18154 (defun org-create-customize-menu ()
18155 "Create a full customization menu for Org-mode, insert it into the menu."
18156 (interactive)
18157 (org-load-modules-maybe)
18158 (org-require-autoloaded-modules)
18159 (if (fboundp 'customize-menu-create)
18160 (progn
18161 (easy-menu-change
18162 '("Org") "Customize"
18163 `(["Browse Org group" org-customize t]
18164 "--"
18165 ,(customize-menu-create 'org)
18166 ["Set" Custom-set t]
18167 ["Save" Custom-save t]
18168 ["Reset to Current" Custom-reset-current t]
18169 ["Reset to Saved" Custom-reset-saved t]
18170 ["Reset to Standard Settings" Custom-reset-standard t]))
18172 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18174 ;;;; Miscellaneous stuff
18176 ;;; Generally useful functions
18178 (defun org-get-at-bol (property)
18179 "Get text property PROPERTY at beginning of line."
18180 (get-text-property (point-at-bol) property))
18182 (defun org-find-text-property-in-string (prop s)
18183 "Return the first non-nil value of property PROP in string S."
18184 (or (get-text-property 0 prop s)
18185 (get-text-property (or (next-single-property-change 0 prop s) 0)
18186 prop s)))
18188 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18189 "Display the given MESSAGE as a warning."
18190 (if (fboundp 'display-warning)
18191 (display-warning 'org message
18192 (if (featurep 'xemacs) 'warning :warning))
18193 (let ((buf (get-buffer-create "*Org warnings*")))
18194 (with-current-buffer buf
18195 (goto-char (point-max))
18196 (insert "Warning (Org): " message)
18197 (unless (bolp)
18198 (newline)))
18199 (display-buffer buf)
18200 (sit-for 0))))
18202 (defun org-in-commented-line ()
18203 "Is point in a line starting with `#'?"
18204 (equal (char-after (point-at-bol)) ?#))
18206 (defun org-in-indented-comment-line ()
18207 "Is point in a line starting with `#' after some white space?"
18208 (save-excursion
18209 (save-match-data
18210 (goto-char (point-at-bol))
18213 (defun org-in-verbatim-emphasis ()
18214 (save-match-data
18215 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18217 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18218 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18219 (if (and marker (marker-buffer marker)
18220 (buffer-live-p (marker-buffer marker)))
18221 (progn
18222 (switch-to-buffer (marker-buffer marker))
18223 (if (or (> marker (point-max)) (< marker (point-min)))
18224 (widen))
18225 (goto-char marker)
18226 (org-show-context 'org-goto))
18227 (if bookmark
18228 (bookmark-jump bookmark)
18229 (error "Cannot find location"))))
18231 (defun org-quote-csv-field (s)
18232 "Quote field for inclusion in CSV material."
18235 s))
18237 (defun org-force-self-insert (N)
18238 "Needed to enforce self-insert under remapping."
18239 (interactive "p")
18240 (self-insert-command N))
18242 (defun org-string-width (s)
18243 "Compute width of string, ignoring invisible characters.
18244 This ignores character with invisibility property `org-link', and also
18245 characters with property `org-cwidth', because these will become invisible
18246 upon the next fontification round."
18247 (let (b l)
18248 (when (or (eq t buffer-invisibility-spec)
18249 (assq 'org-link buffer-invisibility-spec))
18250 (while (setq b (text-property-any 0 (length s)
18251 'invisible 'org-link s))
18252 (setq s (concat (substring s 0 b)
18253 (substring s (or (next-single-property-change
18254 b 'invisible s) (length s)))))))
18255 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18256 (setq s (concat (substring s 0 b)
18257 (substring s (or (next-single-property-change
18258 b 'org-cwidth s) (length s))))))
18259 (setq l (string-width s) b -1)
18260 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18261 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18262 l))
18264 (defun org-shorten-string (s maxlength)
18265 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18266 If the string is shorter or has length MAXLENGTH, just return the
18267 original string. If it is longer, the functions finds a space in the
18268 string, breaks this string off at that locations and adds three dots
18269 as ellipsis. Including the ellipsis, the string will not be longer
18270 than MAXLENGTH. If finding a good breaking point in the string does
18271 not work, the string is just chopped off in the middle of a word
18272 if necessary."
18273 (if (<= (length s) maxlength)
18274 s
18275 (let* ((n (max (- maxlength 4) 1))
18277 (if (string-match re s)
18278 (concat (match-string 1 s) "...")
18279 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18281 (defun org-get-indentation (&optional line)
18282 "Get the indentation of the current line, interpreting tabs.
18283 When LINE is given, assume it represents a line and compute its indentation."
18284 (if line
18285 (if (string-match "^ *" (org-remove-tabs line))
18286 (match-end 0))
18287 (save-excursion
18288 (beginning-of-line 1)
18290 (current-column))))
18292 (defun org-get-string-indentation (s)
18293 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18294 (let ((n -1) (i 0) (w tab-width) c)
18295 (catch 'exit
18296 (while (< (setq n (1+ n)) (length s))
18297 (setq c (aref s n))
18298 (cond ((= c ?\ ) (setq i (1+ i)))
18300 (t (throw 'exit t)))))
18301 i))
18303 (defun org-remove-tabs (s &optional width)
18304 "Replace tabulators in S with spaces.
18305 Assumes that s is a single line, starting in column 0."
18306 (setq width (or width tab-width))
18308 (setq s (replace-match
18309 (make-string
18310 (- (* width (/ (+ (match-beginning 0) width) width))
18311 (match-beginning 0)) ?\ )
18312 t t s)))
18313 s)
18315 (defun org-fix-indentation (line ind)
18316 "Fix indentation in LINE.
18317 IND is a cons cell with target and minimum indentation.
18318 If the current indentation in LINE is smaller than the minimum,
18319 leave it alone. If it is larger than ind, set it to the target."
18320 (let* ((l (org-remove-tabs line))
18321 (i (org-get-indentation l))
18322 (i1 (car ind)) (i2 (cdr ind)))
18323 (if (>= i i2) (setq l (substring line i2)))
18324 (if (> i1 0)
18325 (concat (make-string i1 ?\ ) l)
18326 l)))
18328 (defun org-remove-indentation (code &optional n)
18329 "Remove the maximum common indentation from the lines in CODE.
18330 N may optionally be the number of spaces to remove."
18331 (with-temp-buffer
18332 (insert code)
18333 (org-do-remove-indentation n)
18334 (buffer-string)))
18336 (defun org-do-remove-indentation (&optional n)
18337 "Remove the maximum common indentation from the buffer."
18338 (untabify (point-min) (point-max))
18339 (let ((min 10000) re)
18340 (if n
18341 (setq min n)
18342 (goto-char (point-min))
18344 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18345 (unless (or (= min 0) (= min 10000))
18347 (goto-char (point-min))
18348 (while (re-search-forward re nil t)
18349 (replace-match "")
18350 (end-of-line 1))
18351 min)))
18353 (defun org-fill-template (template alist)
18354 "Find each %key of ALIST in TEMPLATE and replace it."
18355 (let ((case-fold-search nil)
18356 entry key value)
18357 (setq alist (sort (copy-sequence alist)
18358 (lambda (a b) (< (length (car a)) (length (car b))))))
18359 (while (setq entry (pop alist))
18360 (setq template
18361 (replace-regexp-in-string
18362 (concat "%" (regexp-quote (car entry)))
18363 (cdr entry) template t t)))
18364 template))
18366 (defun org-base-buffer (buffer)
18367 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18368 (if (not buffer)
18369 buffer
18370 (or (buffer-base-buffer buffer)
18371 buffer)))
18373 (defun org-trim (s)
18374 "Remove whitespace at beginning and end of string."
18377 s)
18379 (defun org-wrap (string &optional width lines)
18380 "Wrap string to either a number of lines, or a width in characters.
18381 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18382 that costs. If there is a word longer than WIDTH, the text is actually
18383 wrapped to the length of that word.
18384 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18385 many lines, whatever width that takes.
18386 The return value is a list of lines, without newlines at the end."
18388 (maxword (apply 'max (mapcar 'org-string-width words)))
18389 w ll)
18390 (cond (width
18391 (org-do-wrap words (max maxword width)))
18392 (lines
18393 (setq w maxword)
18394 (setq ll (org-do-wrap words maxword))
18395 (if (<= (length ll) lines)
18396 ll
18397 (setq ll words)
18398 (while (> (length ll) lines)
18399 (setq w (1+ w))
18400 (setq ll (org-do-wrap words w)))
18401 ll))
18402 (t (error "Cannot wrap this")))))
18404 (defun org-do-wrap (words width)
18405 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18406 (let (lines line)
18407 (while words
18408 (setq line (pop words))
18409 (while (and words (< (+ (length line) (length (car words))) width))
18410 (setq line (concat line " " (pop words))))
18411 (setq lines (push line lines)))
18412 (nreverse lines)))
18414 (defun org-split-string (string &optional separators)
18415 "Splits STRING into substrings at SEPARATORS.
18416 No empty strings are returned if there are matches at the beginning
18417 and end of string."
18419 (start 0)
18420 notfirst
18421 (list nil))
18422 (while (and (string-match rexp string
18423 (if (and notfirst
18424 (= start (match-beginning 0))
18425 (< start (length string)))
18426 (1+ start) start))
18427 (< (match-beginning 0) (length string)))
18428 (setq notfirst t)
18429 (or (eq (match-beginning 0) 0)
18430 (and (eq (match-beginning 0) (match-end 0))
18431 (eq (match-beginning 0) start))
18432 (setq list
18433 (cons (substring string start (match-beginning 0))
18434 list)))
18435 (setq start (match-end 0)))
18436 (or (eq start (length string))
18437 (setq list
18438 (cons (substring string start)
18439 list)))
18440 (nreverse list)))
18442 (defun org-quote-vert (s)
18444 (while (string-match "|" s)
18446 s)
18448 (defun org-uuidgen-p (s)
18449 "Is S an ID created by UUIDGEN?"
18450 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18452 (defun org-context ()
18453 "Return a list of contexts of the current cursor position.
18454 If several contexts apply, all are returned.
18455 Each context entry is a list with a symbol naming the context, and
18456 two positions indicating start and end of the context. Possible
18457 contexts are:
18459 :headline anywhere in a headline
18460 :headline-stars on the leading stars in a headline
18461 :todo-keyword on a TODO keyword (including DONE) in a headline
18462 :tags on the TAGS in a headline
18463 :priority on the priority cookie in a headline
18464 :item on the first line of a plain list item
18465 :item-bullet on the bullet/number of a plain list item
18466 :checkbox on the checkbox in a plain list item
18467 :table in an org-mode table
18468 :table-special on a special filed in a table
18469 :table-table in a table.el table
18470 :link on a hyperlink
18471 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18472 :target on a <<target>>
18473 :radio-target on a <<<radio-target>>>
18474 :latex-fragment on a LaTeX fragment
18475 :latex-preview on a LaTeX fragment with overlayed preview image
18477 This function expects the position to be visible because it uses font-lock
18478 faces as a help to recognize the following contexts: :table-special, :link,
18479 and :keyword."
18480 (let* ((f (get-text-property (point) 'face))
18481 (faces (if (listp f) f (list f)))
18482 (p (point)) clist o)
18483 ;; First the large context
18484 (cond
18485 ((org-on-heading-p t)
18486 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18487 (when (progn
18488 (beginning-of-line 1)
18489 (looking-at org-todo-line-tags-regexp))
18490 (push (org-point-in-group p 1 :headline-stars) clist)
18491 (push (org-point-in-group p 2 :todo-keyword) clist)
18492 (push (org-point-in-group p 4 :tags) clist))
18493 (goto-char p)
18496 (push (org-point-in-group p 0 :priority) clist)))
18498 ((org-at-item-p)
18499 (push (org-point-in-group p 2 :item-bullet) clist)
18500 (push (list :item (point-at-bol)
18501 (save-excursion (org-end-of-item) (point)))
18502 clist)
18503 (and (org-at-item-checkbox-p)
18504 (push (org-point-in-group p 0 :checkbox) clist)))
18506 ((org-at-table-p)
18507 (push (list :table (org-table-begin) (org-table-end)) clist)
18508 (if (memq 'org-formula faces)
18509 (push (list :table-special
18510 (previous-single-property-change p 'face)
18511 (next-single-property-change p 'face)) clist)))
18512 ((org-at-table-p 'any)
18513 (push (list :table-table) clist)))
18514 (goto-char p)
18516 ;; Now the small context
18517 (cond
18518 ((org-at-timestamp-p)
18519 (push (org-point-in-group p 0 :timestamp) clist))
18520 ((memq 'org-link faces)
18521 (push (list :link
18522 (previous-single-property-change p 'face)
18523 (next-single-property-change p 'face)) clist))
18524 ((memq 'org-special-keyword faces)
18525 (push (list :keyword
18526 (previous-single-property-change p 'face)
18527 (next-single-property-change p 'face)) clist))
18528 ((org-on-target-p)
18529 (push (org-point-in-group p 0 :target) clist)
18530 (goto-char (1- (match-beginning 0)))
18531 (if (looking-at org-radio-target-regexp)
18532 (push (org-point-in-group p 0 :radio-target) clist))
18533 (goto-char p))
18534 ((setq o (car (delq nil
18535 (mapcar
18536 (lambda (x)
18537 (if (memq x org-latex-fragment-image-overlays) x))
18538 (overlays-at (point))))))
18539 (push (list :latex-fragment
18540 (overlay-start o) (overlay-end o)) clist)
18541 (push (list :latex-preview
18542 (overlay-start o) (overlay-end o)) clist))
18543 ((org-inside-LaTeX-fragment-p)
18544 ;; FIXME: positions wrong.
18545 (push (list :latex-fragment (point) (point)) clist)))
18547 (setq clist (nreverse (delq nil clist)))
18548 clist))
18550 ;; FIXME: Compare with at-regexp-p Do we need both?
18551 (defun org-in-regexp (re &optional nlines visually)
18552 "Check if point is inside a match of regexp.
18553 Normally only the current line is checked, but you can include NLINES extra
18554 lines both before and after point into the search.
18555 If VISUALLY is set, require that the cursor is not after the match but
18556 really on, so that the block visually is on the match."
18557 (catch 'exit
18558 (let ((pos (point))
18559 (eol (point-at-eol (+ 1 (or nlines 0))))
18560 (inc (if visually 1 0)))
18561 (save-excursion
18562 (beginning-of-line (- 1 (or nlines 0)))
18563 (while (re-search-forward re eol t)
18564 (if (and (<= (match-beginning 0) pos)
18565 (>= (+ inc (match-end 0)) pos))
18566 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18568 (defun org-at-regexp-p (regexp)
18569 "Is point inside a match of REGEXP in the current line?"
18570 (catch 'exit
18571 (save-excursion
18572 (let ((pos (point)) (end (point-at-eol)))
18573 (beginning-of-line 1)
18574 (while (re-search-forward regexp end t)
18575 (if (and (<= (match-beginning 0) pos)
18576 (>= (match-end 0) pos))
18577 (throw 'exit t)))
18578 nil))))
18580 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18581 "Return t if the current point is between matches of START-RE and END-RE.
18582 This will also return t if point is on one of the two matches or
18583 in an unfinished block. END-RE can be a string or a form
18584 returning a string.
18586 An optional third argument bounds the search for START-RE. It
18587 defaults to previous heading or `point-min'."
18588 (let ((pos (point))
18589 (limit (or bound (save-excursion (outline-previous-heading)))))
18590 (save-excursion
18591 ;; we're on a block when point is on start-re...
18592 (or (org-at-regexp-p start-re)
18593 ;; ... or start-re can be found above...
18594 (and (re-search-backward start-re limit t)
18595 ;; ... but no end-re between start-re and point.
18596 (not (re-search-forward (eval end-re) pos t)))))))
18598 (defun org-occur-in-agenda-files (regexp &optional nlines)
18599 "Call `multi-occur' with buffers for all agenda files."
18601 (let* ((files (org-agenda-files))
18602 (tnames (mapcar 'file-truename files))
18603 (extra org-agenda-text-search-extra-files)
18604 f)
18605 (when (eq (car extra) 'agenda-archives)
18606 (setq extra (cdr extra))
18607 (setq files (org-add-archive-files files)))
18608 (while (setq f (pop extra))
18609 (unless (member (file-truename f) tnames)
18610 (add-to-list 'files f 'append)
18611 (add-to-list 'tnames (file-truename f) 'append)))
18612 (multi-occur
18613 (mapcar (lambda (x)
18614 (with-current-buffer
18615 (or (get-file-buffer x) (find-file-noselect x))
18616 (widen)
18617 (current-buffer)))
18618 files)
18619 regexp)))
18621 (if (boundp 'occur-mode-find-occurrence-hook)
18622 ;; Emacs 23
18623 (add-hook 'occur-mode-find-occurrence-hook
18624 (lambda ()
18625 (when (org-mode-p)
18626 (org-reveal))))
18627 ;; Emacs 22
18628 (defadvice occur-mode-goto-occurrence
18629 (after org-occur-reveal activate)
18630 (and (org-mode-p) (org-reveal)))
18631 (defadvice occur-mode-goto-occurrence-other-window
18632 (after org-occur-reveal activate)
18633 (and (org-mode-p) (org-reveal)))
18634 (defadvice occur-mode-display-occurrence
18635 (after org-occur-reveal activate)
18636 (when (org-mode-p)
18637 (let ((pos (occur-mode-find-occurrence)))
18638 (with-current-buffer (marker-buffer pos)
18639 (save-excursion
18640 (goto-char pos)
18641 (org-reveal)))))))
18643 (defun org-occur-link-in-agenda-files ()
18644 "Create a link and search for it in the agendas.
18645 The link is not stored in `org-stored-links', it is just created
18646 for the search purpose."
18647 (interactive)
18648 (let ((link (condition-case nil
18649 (org-store-link nil)
18650 (error "Unable to create a link to here"))))
18651 (org-occur-in-agenda-files (regexp-quote link))))
18653 (defun org-uniquify (list)
18654 "Remove duplicate elements from LIST."
18655 (let (res)
18656 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18657 res))
18659 (defun org-delete-all (elts list)
18660 "Remove all elements in ELTS from LIST."
18661 (while elts
18662 (setq list (delete (pop elts) list)))
18663 list)
18665 (defun org-count (cl-item cl-seq)
18666 "Count the number of occurrences of ITEM in SEQ.
18667 Taken from `count' in cl-seq.el with all keyword arguments removed."
18668 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18669 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18670 (while (< cl-start cl-end)
18671 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18672 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18673 (setq cl-start (1+ cl-start)))
18674 cl-count))
18676 (defun org-remove-if (predicate seq)
18677 "Remove everything from SEQ that fulfills PREDICATE."
18678 (let (res e)
18679 (while seq
18680 (setq e (pop seq))
18681 (if (not (funcall predicate e)) (push e res)))
18682 (nreverse res)))
18684 (defun org-remove-if-not (predicate seq)
18685 "Remove everything from SEQ that does not fulfill PREDICATE."
18686 (let (res e)
18687 (while seq
18688 (setq e (pop seq))
18689 (if (funcall predicate e) (push e res)))
18690 (nreverse res)))
18692 (defun org-back-over-empty-lines ()
18693 "Move backwards over whitespace, to the beginning of the first empty line.
18694 Returns the number of empty lines passed."
18695 (let ((pos (point)))
18697 ;; (if (cdr (assoc 'heading org-blank-before-new-entry))
18699 ;; (forward-line -1))
18700 (beginning-of-line 2)
18701 (goto-char (min (point) pos))
18702 (count-lines (point) pos)))
18704 (defun org-skip-whitespace ()
18707 (defun org-point-in-group (point group &optional context)
18708 "Check if POINT is in match-group GROUP.
18709 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18710 match. If the match group does not exist or point is not inside it,
18711 return nil."
18712 (and (match-beginning group)
18713 (>= point (match-beginning group))
18714 (<= point (match-end group))
18715 (if context
18716 (list context (match-beginning group) (match-end group))
18717 t)))
18719 (defun org-switch-to-buffer-other-window (&rest args)
18720 "Switch to buffer in a second window on the current frame.
18721 In particular, do not allow pop-up frames.
18722 Returns the newly created buffer."
18723 (let (pop-up-frames special-display-buffer-names special-display-regexps
18724 special-display-function)
18725 (apply 'switch-to-buffer-other-window args)))
18727 (defun org-combine-plists (&rest plists)
18728 "Create a single property list from all plists in PLISTS.
18729 The process starts by copying the first list, and then setting properties
18730 from the other lists. Settings in the last list are the most significant
18731 ones and overrule settings in the other lists."
18732 (let ((rtn (copy-sequence (pop plists)))
18733 p v ls)
18734 (while plists
18735 (setq ls (pop plists))
18736 (while ls
18737 (setq p (pop ls) v (pop ls))
18738 (setq rtn (plist-put rtn p v))))
18739 rtn))
18741 (defun org-move-line-down (arg)
18742 "Move the current line down. With prefix argument, move it past ARG lines."
18743 (interactive "p")
18744 (let ((col (current-column))
18745 beg end pos)
18746 (beginning-of-line 1) (setq beg (point))
18747 (beginning-of-line 2) (setq end (point))
18748 (beginning-of-line (+ 1 arg))
18749 (setq pos (move-marker (make-marker) (point)))
18750 (insert (delete-and-extract-region beg end))
18751 (goto-char pos)
18752 (org-move-to-column col)))
18754 (defun org-move-line-up (arg)
18755 "Move the current line up. With prefix argument, move it past ARG lines."
18756 (interactive "p")
18757 (let ((col (current-column))
18758 beg end pos)
18759 (beginning-of-line 1) (setq beg (point))
18760 (beginning-of-line 2) (setq end (point))
18761 (beginning-of-line (- arg))
18762 (setq pos (move-marker (make-marker) (point)))
18763 (insert (delete-and-extract-region beg end))
18764 (goto-char pos)
18765 (org-move-to-column col)))
18767 (defun org-replace-escapes (string table)
18768 "Replace %-escapes in STRING with values in TABLE.
18770 The sequences in STRING may contain normal field width and padding information,
18772 so values can contain further %-escapes if they are define later in TABLE."
18773 (let ((tbl (copy-alist table))
18774 (case-fold-search nil)
18775 (pchg 0)
18776 e re rpl)
18777 (while (setq e (pop tbl))
18778 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18779 (when (and (cdr e) (string-match re (cdr e)))
18780 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18781 (safe "SREF"))
18782 (add-text-properties 0 3 (list 'sref sref) safe)
18783 (setcdr e (replace-match safe t t (cdr e)))))
18784 (while (string-match re string)
18785 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18786 (cdr e)))
18787 (setq string (replace-match rpl t t string))))
18788 (while (setq pchg (next-property-change pchg string))
18789 (let ((sref (get-text-property pchg 'sref string)))
18790 (when (and sref (string-match "SREF" string pchg))
18791 (setq string (replace-match sref t t string)))))
18792 string))
18794 (defun org-sublist (list start end)
18795 "Return a section of LIST, from START to END.
18796 Counting starts at 1."
18797 (let (rtn (c start))
18798 (setq list (nthcdr (1- start) list))
18799 (while (and list (<= c end))
18800 (push (pop list) rtn)
18801 (setq c (1+ c)))
18802 (nreverse rtn)))
18804 (defun org-find-base-buffer-visiting (file)
18805 "Like `find-buffer-visiting' but always return the base buffer and
18806 not an indirect buffer."
18807 (let ((buf (or (get-file-buffer file)
18808 (find-buffer-visiting file))))
18809 (if buf
18810 (or (buffer-base-buffer buf) buf)
18811 nil)))
18813 (defun org-image-file-name-regexp (&optional extensions)
18814 "Return regexp matching the file names of images.
18815 If EXTENSIONS is given, only match these."
18816 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18817 (image-file-name-regexp)
18818 (let ((image-file-name-extensions
18819 (or extensions
18820 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18821 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18823 (regexp-opt (nconc (mapcar 'upcase
18824 image-file-name-extensions)
18825 image-file-name-extensions)
18826 t)
18829 (defun org-file-image-p (file &optional extensions)
18830 "Return non-nil if FILE is an image."
18831 (save-match-data
18832 (string-match (org-image-file-name-regexp extensions) file)))
18834 (defun org-get-cursor-date ()
18835 "Return the date at cursor in as a time.
18836 This works in the calendar and in the agenda, anywhere else it just
18837 returns the current time."
18838 (let (date day defd)
18839 (cond
18840 ((eq major-mode 'calendar-mode)
18841 (setq date (calendar-cursor-to-date)
18842 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18843 ((eq major-mode 'org-agenda-mode)
18844 (setq day (get-text-property (point) 'day))
18845 (if day
18846 (setq date (calendar-gregorian-from-absolute day)
18847 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18848 (nth 2 date))))))
18849 (or defd (current-time))))
18851 (defvar org-agenda-action-marker (make-marker)
18852 "Marker pointing to the entry for the next agenda action.")
18854 (defun org-mark-entry-for-agenda-action ()
18855 "Mark the current entry as target of an agenda action.
18856 Agenda actions are actions executed from the agenda with the key `k',
18857 which make use of the date at the cursor."
18858 (interactive)
18859 (move-marker org-agenda-action-marker
18860 (save-excursion (org-back-to-heading t) (point))
18861 (current-buffer))
18862 (message
18863 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18865 (defun org-mark-subtree ()
18866 "Mark the current subtree.
18867 This puts point at the start of the current subtree, and mark at the end.
18869 If point is in an inline task, mark that task instead."
18870 (interactive)
18871 (let ((inline-task-p
18872 (and (featurep 'org-inlinetask)
18873 (org-inlinetask-in-task-p)))
18874 (beg))
18875 ;; Get beginning of subtree
18876 (cond
18877 (inline-task-p (org-inlinetask-goto-beginning))
18878 ((org-at-heading-p) (beginning-of-line))
18879 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
18880 (setq beg (point))
18881 ;; Get end of it
18882 (if inline-task-p
18883 (org-inlinetask-goto-end)
18884 (org-end-of-subtree))
18885 ;; Mark zone
18886 (push-mark (point) nil t)
18887 (goto-char beg)))
18889 ;;; Paragraph filling stuff.
18890 ;; We want this to be just right, so use the full arsenal.
18892 (defun org-indent-line-function ()
18893 "Indent line depending on context."
18894 (interactive)
18895 (let* ((pos (point))
18896 (itemp (org-at-item-p))
18897 (case-fold-search t)
18899 (inline-task-p (and (featurep 'org-inlinetask)
18900 (org-inlinetask-in-task-p)))
18901 (inline-re (and inline-task-p
18902 (org-inlinetask-outline-regexp)))
18903 column)
18904 (beginning-of-line 1)
18905 (cond
18906 ;; Comments
18907 ((looking-at "# ") (setq column 0))
18908 ;; Headings
18910 ;; Literal examples
18912 (setq column (org-get-indentation))) ; do nothing
18913 ;; Drawers
18915 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18916 (save-excursion
18917 (goto-char (1- (match-beginning 1)))
18918 (setq column (current-column))))
18919 ;; Special blocks
18921 (save-excursion
18922 (re-search-backward
18924 (setq column (org-get-indentation (match-string 0))))
18927 (save-excursion
18929 (setq column
18930 (if (equal (downcase (match-string 1)) "src")
18931 ;; src blocks: let `org-edit-src-exit' handle them
18932 (org-get-indentation)
18933 (org-get-indentation (match-string 0)))))
18934 ;; Lists
18935 ((ignore-errors (goto-char (org-in-item-p)))
18936 (setq column (if itemp
18937 (org-get-indentation)
18938 (org-list-item-body-column (point))))
18939 (goto-char pos))
18940 ;; This line has nothing special, look at the previous relevant
18941 ;; line to compute indentation
18942 (t
18943 (beginning-of-line 0)
18944 (while (and (not (bobp))
18945 (not (looking-at org-drawer-regexp))
18946 ;; When point started in an inline task, do not move
18947 ;; above task starting line.
18948 (not (and inline-task-p
18949 (looking-at inline-re)))
18950 ;; Skip comments, verbatim, empty lines, tables,
18951 ;; inline tasks, lists, drawers and blocks.
18953 (re-search-backward org-drawer-regexp nil t))
18957 (and (ignore-errors (goto-char (org-in-item-p)))
18958 (goto-char
18959 (org-list-get-top-point (org-list-struct))))
18960 (and (not inline-task-p)
18961 (featurep 'org-inlinetask)
18962 (org-inlinetask-in-task-p)
18963 (or (org-inlinetask-goto-beginning) t))))
18964 (beginning-of-line 0))
18965 (cond
18966 ;; There was an heading above.
18968 (if (not org-adapt-indentation)
18969 (setq column 0)
18970 (goto-char (match-end 0))
18971 (setq column (current-column))))
18972 ;; A drawer had started and is unfinished
18973 ((looking-at org-drawer-regexp)
18974 (goto-char (1- (match-beginning 1)))
18975 (setq column (current-column)))
18976 ;; Else, nothing noticeable found: get indentation and go on.
18977 (t (setq column (org-get-indentation))))))
18978 ;; Now apply indentation and move cursor accordingly
18979 (goto-char pos)
18980 (if (<= (current-column) (current-indentation))
18981 (org-indent-line-to column)
18982 (save-excursion (org-indent-line-to column)))
18983 ;; Special polishing for properties, see `org-property-format'
18984 (setq column (current-column))
18985 (beginning-of-line 1)
18986 (if (looking-at
18988 (replace-match (concat (match-string 1)
18989 (format org-property-format
18990 (match-string 2) (match-string 3)))
18991 t t))
18992 (org-move-to-column column)))
18994 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18995 "Variable to store copy of `adaptive-fill-regexp'.
18996 Since `adaptive-fill-regexp' is set to never match, we need to
18997 store a backup of its value before entering `org-mode' so that
18998 the functionality can be provided as a fall-back.")
19000 (defun org-set-autofill-regexps ()
19001 (interactive)
19002 ;; In the paragraph separator we include headlines, because filling
19003 ;; text in a line directly attached to a headline would otherwise
19004 ;; fill the headline as well.
19007 ;; The paragraph starter includes hand-formatted lists.
19008 (org-set-local
19009 'paragraph-start
19010 (concat
19019 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19020 ;; But only if the user has not turned off tables or fixed-width regions
19021 (org-set-local
19022 'auto-fill-inhibit-regexp
19025 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19026 (concat
19028 (if org-enable-table-editor "|" "")
19029 (if org-enable-fixed-width-editor ":" "")
19030 "]"))))
19031 ;; We use our own fill-paragraph function, to make sure that tables
19032 ;; and fixed-width regions are not wrapped. That function will pass
19033 ;; through to `fill-paragraph' when appropriate.
19034 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19035 ;; Adaptive filling: To get full control, first make sure that
19036 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19037 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19038 (org-set-local 'org-adaptive-fill-regexp-backup
19039 adaptive-fill-regexp))
19041 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19042 (org-set-local 'adaptive-fill-function
19043 'org-adaptive-fill-function)
19044 (org-set-local
19045 'align-mode-rules-list
19046 '((org-in-buffer-settings
19048 (modes . '(org-mode))))))
19050 (defun org-fill-paragraph (&optional justify)
19051 "Re-align a table, pass through to fill-paragraph if no table."
19052 (let ((table-p (org-at-table-p))
19053 (table.el-p (org-at-table.el-p))
19054 (itemp (org-in-item-p)))
19055 (cond ((and (equal (char-after (point-at-bol)) ?*)
19056 (save-excursion (goto-char (point-at-bol))
19057 (looking-at outline-regexp)))
19058 t) ; skip headlines
19059 (table.el-p t) ; skip table.el tables
19060 (table-p (org-table-align) t) ; align Org tables
19061 (itemp ; align text in items
19062 (let* ((struct (save-excursion (goto-char itemp)
19063 (org-list-struct)))
19064 (parents (org-list-parents-alist struct))
19065 (children (org-list-get-children itemp struct parents))
19066 beg end prev next prefix)
19067 ;; Determine in which part of item point is: before
19068 ;; first child, after last child, between two
19069 ;; sub-lists, or simply in item if there's no child.
19070 (cond
19071 ((not children)
19072 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19073 beg itemp
19074 end (org-list-get-item-end itemp struct)))
19075 ((< (point) (setq next (car children)))
19076 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19077 beg itemp
19078 end next))
19079 ((> (point) (setq prev (car (last children))))
19080 (setq beg (org-list-get-item-end prev struct)
19081 end (org-list-get-item-end itemp struct)
19082 prefix (save-excursion
19083 (goto-char beg)
19085 (make-string (current-column) ?\ ))))
19086 (t (catch 'exit
19087 (while (setq next (pop children))
19088 (if (> (point) next)
19089 (setq prev next)
19090 (setq beg (org-list-get-item-end prev struct)
19091 end next
19092 prefix (save-excursion
19093 (goto-char beg)
19095 (make-string (current-column) ?\ )))
19096 (throw 'exit nil))))))
19097 ;; Use `fill-paragraph' with buffer narrowed to item
19098 ;; without any child, and with our computed PREFIX.
19099 (flet ((fill-context-prefix (from to &optional flr) prefix))
19100 (save-restriction
19101 (narrow-to-region beg end)
19102 (save-excursion (fill-paragraph justify)))) t))
19103 ;; Special case where point is not in a list but is on
19104 ;; a paragraph adjacent to a list: make sure this paragraph
19105 ;; doesn't get merged with the end of the list by narrowing
19106 ;; buffer first.
19107 ((save-excursion (fill-forward-paragraph -1)
19108 (setq itemp (org-in-item-p)))
19109 (let ((struct (save-excursion (goto-char itemp)
19110 (org-list-struct))))
19111 (save-restriction
19112 (narrow-to-region (org-list-get-bottom-point struct)
19113 (save-excursion (fill-forward-paragraph 1)
19114 (point)))
19115 (fill-paragraph justify) t)))
19116 ;; Else simply call `fill-paragraph'.
19117 (t nil))))
19119 ;; For reference, this is the default value of adaptive-fill-regexp
19122 (defun org-adaptive-fill-function ()
19123 "Return a fill prefix for org-mode files."
19124 (let (itemp)
19125 (save-excursion
19126 (cond
19127 ;; Comment line
19129 (match-string-no-properties 0))
19130 ;; Point is in a list after `backward-paragraph': original
19131 ;; point wasn't in the list, or filling would have been taken
19132 ;; care of by `org-auto-fill-function', but the list and the
19133 ;; real paragraph are not separated by a blank line. Thus, move
19134 ;; point after the list to go back to real paragraph and
19135 ;; determine fill-prefix. If point is at an item, do not
19136 ;; compute prefix and list structure, as first line of
19137 ;; paragraph will be skipped anyway.
19138 ((org-at-item-p) "")
19139 ((setq itemp (org-in-item-p))
19140 (goto-char itemp)
19141 (let* ((struct (org-list-struct))
19142 (bottom (org-list-get-bottom-point struct)))
19143 (goto-char bottom)
19144 (make-string (org-get-indentation) ?\ )))
19145 ;; Other text
19146 ((looking-at org-adaptive-fill-regexp-backup)
19147 (match-string-no-properties 0))))))
19149 (defun org-auto-fill-function ()
19150 "Auto-fill function."
19151 (let (itemp prefix)
19152 ;; When in a list, compute an appropriate fill-prefix and make
19153 ;; sure it will be used by `do-auto-fill'.
19154 (if (setq itemp (org-in-item-p))
19155 (progn
19156 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19157 (flet ((fill-context-prefix (from to &optional flr) prefix))
19158 (do-auto-fill)))
19159 ;; Else just use `do-auto-fill'.
19160 (do-auto-fill))))
19162 ;;; Other stuff.
19164 (defun org-toggle-fixed-width-section (arg)
19165 "Toggle the fixed-width export.
19166 If there is no active region, the QUOTE keyword at the current headline is
19167 inserted or removed. When present, it causes the text between this headline
19168 and the next to be exported as fixed-width text, and unmodified.
19169 If there is an active region, this command adds or removes a colon as the
19170 first character of this line. If the first character of a line is a colon,
19171 this line is also exported in fixed-width font."
19172 (interactive "P")
19173 (let* ((cc 0)
19174 (regionp (org-region-active-p))
19175 (beg (if regionp (region-beginning) (point)))
19176 (end (if regionp (region-end)))
19177 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19178 (case-fold-search nil)
19180 off)
19181 (if regionp
19182 (save-excursion
19183 (goto-char beg)
19184 (setq cc (current-column))
19185 (beginning-of-line 1)
19186 (setq off (looking-at re))
19187 (while (> nlines 0)
19188 (setq nlines (1- nlines))
19189 (beginning-of-line 1)
19190 (cond
19191 (arg
19192 (org-move-to-column cc t)
19194 (forward-line -1))
19195 ((and off (looking-at re))
19196 (replace-match "" t t nil 1))
19197 ((not off) (org-move-to-column cc t) (insert ": ")))
19198 (forward-line 1)))
19199 (save-excursion
19200 (org-back-to-heading)
19201 (if (looking-at (concat outline-regexp
19203 (replace-match "" t t nil 1)
19204 (if (looking-at outline-regexp)
19205 (progn
19206 (goto-char (match-end 0))
19207 (insert org-quote-string " "))))))))
19209 (defun org-reftex-citation ()
19210 "Use reftex-citation to insert a citation into the buffer.
19211 This looks for a line like
19213 #+BIBLIOGRAPHY: foo plain option:-d
19215 and derives from it that foo.bib is the bibliography file relevant
19216 for this document. It then installs the necessary environment for RefTeX
19217 to work in this buffer and calls `reftex-citation' to insert a citation
19218 into the buffer.
19220 Export of such citations to both LaTeX and HTML is handled by the contributed
19221 package org-exp-bibtex by Taru Karttunen."
19222 (interactive)
19223 (let ((reftex-docstruct-symbol 'rds)
19225 rds bib)
19226 (save-excursion
19227 (save-restriction
19228 (widen)
19229 (let ((case-fold-search t)
19231 (if (not (save-excursion
19232 (or (re-search-forward re nil t)
19233 (re-search-backward re nil t))))
19234 (error "No bibliography defined in file")
19235 (setq bib (concat (match-string 1) ".bib")
19236 rds (list (list 'bib bib)))))))
19237 (call-interactively 'reftex-citation)))
19239 ;;;; Functions extending outline functionality
19241 (defun org-beginning-of-line (&optional arg)
19242 "Go to the beginning of the current line. If that is invisible, continue
19243 to a visible line beginning. This makes the function of C-a more intuitive.
19244 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19245 first attempt, and only move to after the tags when the cursor is already
19246 beyond the end of the headline."
19247 (interactive "P")
19248 (let ((pos (point))
19249 (special (if (consp org-special-ctrl-a/e)
19250 (car org-special-ctrl-a/e)
19251 org-special-ctrl-a/e))
19252 refpos)
19253 (if (org-bound-and-true-p line-move-visual)
19254 (beginning-of-visual-line 1)
19255 (beginning-of-line 1))
19256 (if (and arg (fboundp 'move-beginning-of-line))
19257 (call-interactively 'move-beginning-of-line)
19258 (if (bobp)
19259 nil
19260 (backward-char 1)
19261 (if (org-truely-invisible-p)
19262 (while (and (not (bobp)) (org-truely-invisible-p))
19263 (backward-char 1)
19264 (beginning-of-line 1))
19265 (forward-char 1))))
19266 (when special
19267 (cond
19268 ((and (looking-at org-complex-heading-regexp)
19269 (= (char-after (match-end 1)) ?\ ))
19270 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19271 (point-at-eol)))
19272 (goto-char
19273 (if (eq special t)
19274 (cond ((> pos refpos) refpos)
19275 ((= pos (point)) refpos)
19276 (t (point)))
19277 (cond ((> pos (point)) (point))
19278 ((not (eq last-command this-command)) (point))
19279 (t refpos)))))
19280 ((org-at-item-p)
19281 (goto-char
19282 (if (eq special t)
19283 (cond ((> pos (match-end 0)) (match-end 0))
19284 ((= pos (point)) (match-end 0))
19285 (t (point)))
19286 (cond ((> pos (point)) (point))
19287 ((not (eq last-command this-command)) (point))
19288 (t (match-end 0))))))))
19289 (org-no-warnings
19290 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19292 (defun org-end-of-line (&optional arg)
19293 "Go to the end of the line.
19294 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19295 first attempt, and only move to after the tags when the cursor is already
19296 beyond the end of the headline."
19297 (interactive "P")
19298 (let ((special (if (consp org-special-ctrl-a/e)
19299 (cdr org-special-ctrl-a/e)
19300 org-special-ctrl-a/e)))
19301 (if (or (not special)
19302 (not (org-on-heading-p))
19303 arg)
19304 (call-interactively
19305 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19306 ((fboundp 'move-end-of-line) 'move-end-of-line)
19307 (t 'end-of-line)))
19308 (let ((pos (point)))
19309 (beginning-of-line 1)
19311 (if (eq special t)
19312 (if (or (< pos (match-beginning 1))
19313 (= pos (match-end 0)))
19314 (goto-char (match-beginning 1))
19315 (goto-char (match-end 0)))
19316 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19317 (goto-char (match-end 0))
19318 (goto-char (match-beginning 1))))
19319 (call-interactively (if (fboundp 'move-end-of-line)
19320 'move-end-of-line
19321 'end-of-line)))))
19322 (org-no-warnings
19323 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19325 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19326 (define-key org-mode-map "\C-e" 'org-end-of-line)
19328 (defun org-backward-sentence (&optional arg)
19329 "Go to beginning of sentence, or beginning of table field.
19330 This will call `backward-sentence' or `org-table-beginning-of-field',
19331 depending on context."
19332 (interactive "P")
19333 (cond
19334 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19335 (t (call-interactively 'backward-sentence))))
19337 (defun org-forward-sentence (&optional arg)
19338 "Go to end of sentence, or end of table field.
19339 This will call `forward-sentence' or `org-table-end-of-field',
19340 depending on context."
19341 (interactive "P")
19342 (cond
19343 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19344 (t (call-interactively 'forward-sentence))))
19346 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19347 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19349 (defun org-kill-line (&optional arg)
19350 "Kill line, to tags or end of line."
19351 (interactive "P")
19352 (cond
19353 ((or (not org-special-ctrl-k)
19354 (bolp)
19355 (not (org-on-heading-p)))
19356 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19357 org-ctrl-k-protect-subtree)
19358 (if (or (eq org-ctrl-k-protect-subtree 'error)
19359 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19360 (error "C-k aborted - would kill hidden subtree")))
19361 (call-interactively 'kill-line))
19363 (kill-region (point) (match-beginning 1))
19364 (org-set-tags nil t))
19365 (t (kill-region (point) (point-at-eol)))))
19367 (define-key org-mode-map "\C-k" 'org-kill-line)
19369 (defun org-yank (&optional arg)
19370 "Yank. If the kill is a subtree, treat it specially.
19371 This command will look at the current kill and check if is a single
19372 subtree, or a series of subtrees[1]. If it passes the test, and if the
19373 cursor is at the beginning of a line or after the stars of a currently
19374 empty headline, then the yank is handled specially. How exactly depends
19375 on the value of the following variables, both set by default.
19377 org-yank-folded-subtrees
19378 When set, the subtree(s) will be folded after insertion, but only
19379 if doing so would now swallow text after the yanked text.
19381 org-yank-adjusted-subtrees
19382 When set, the subtree will be promoted or demoted in order to
19383 fit into the local outline tree structure, which means that the level
19384 will be adjusted so that it becomes the smaller one of the two
19385 *visible* surrounding headings.
19387 Any prefix to this command will cause `yank' to be called directly with
19389 will just
19390 plainly yank the text as it is.
19392 \[1] The test checks if the first non-white line is a heading
19393 and if there are no other headings with fewer stars."
19394 (interactive "P")
19395 (org-yank-generic 'yank arg))
19397 (defun org-yank-generic (command arg)
19398 "Perform some yank-like command.
19400 This function implements the behavior described in the `org-yank'
19401 documentation. However, it has been generalized to work for any
19402 interactive command with similar behavior."
19404 ;; pretend to be command COMMAND
19405 (setq this-command command)
19407 (if arg
19408 (call-interactively command)
19410 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19411 (and (org-kill-is-subtree-p)
19412 (or (bolp)
19414 (string-match
19416 (buffer-substring (point-at-bol) (point)))))))
19417 swallowp)
19418 (cond
19419 ((and subtreep org-yank-folded-subtrees)
19420 (let ((beg (point))
19421 end)
19422 (if (and subtreep org-yank-adjusted-subtrees)
19423 (org-paste-subtree nil nil 'for-yank)
19424 (call-interactively command))
19426 (setq end (point))
19427 (goto-char beg)
19428 (when (and (bolp) subtreep
19429 (not (setq swallowp
19430 (org-yank-folding-would-swallow-text beg end))))
19431 (or (looking-at outline-regexp)
19432 (re-search-forward (concat "^" outline-regexp) end t))
19433 (while (and (< (point) end) (looking-at outline-regexp))
19434 (hide-subtree)
19435 (org-cycle-show-empty-lines 'folded)
19436 (condition-case nil
19437 (outline-forward-same-level 1)
19438 (error (goto-char end)))))
19439 (when swallowp
19440 (message
19441 "Inserted text not folded because that would swallow text"))
19443 (goto-char end)
19445 (beginning-of-line 1)
19446 (push-mark beg 'nomsg)))
19447 ((and subtreep org-yank-adjusted-subtrees)
19448 (let ((beg (point-at-bol)))
19449 (org-paste-subtree nil nil 'for-yank)
19450 (push-mark beg 'nomsg)))
19451 (t
19452 (call-interactively command))))))
19454 (defun org-yank-folding-would-swallow-text (beg end)
19455 "Would hide-subtree at BEG swallow any text after END?"
19456 (let (level)
19457 (save-excursion
19458 (goto-char beg)
19459 (when (or (looking-at outline-regexp)
19460 (re-search-forward (concat "^" outline-regexp) end t))
19461 (setq level (org-outline-level)))
19462 (goto-char end)
19464 (if (or (eobp)
19465 (and (bolp) (looking-at org-outline-regexp)
19466 (<= (org-outline-level) level)))
19467 nil ; Nothing would be swallowed
19468 t)))) ; something would swallow
19470 (define-key org-mode-map "\C-y" 'org-yank)
19472 (defun org-truely-invisible-p ()
19473 "Check if point is at a character currently not visible.
19474 This version does not only check the character property, but also
19475 `visible-mode'."
19476 ;; Early versions of noutline don't have `outline-invisible-p'.
19477 (if (org-bound-and-true-p visible-mode)
19478 nil
19479 (outline-invisible-p)))
19481 (defun org-invisible-p2 ()
19482 "Check if point is at a character currently not visible."
19483 (save-excursion
19484 (if (and (eolp) (not (bobp))) (backward-char 1))
19485 ;; Early versions of noutline don't have `outline-invisible-p'.
19486 (outline-invisible-p)))
19488 (defun org-back-to-heading (&optional invisible-ok)
19489 "Call `outline-back-to-heading', but provide a better error message."
19490 (condition-case nil
19491 (outline-back-to-heading invisible-ok)
19492 (error (error "Before first headline at position %d in buffer %s"
19493 (point) (current-buffer)))))
19495 (defun org-beginning-of-defun ()
19496 "Go to the beginning of the subtree, i.e. back to the heading."
19497 (org-back-to-heading))
19498 (defun org-end-of-defun ()
19499 "Go to the end of the subtree."
19500 (org-end-of-subtree nil t))
19502 (defun org-before-first-heading-p ()
19503 "Before first heading?"
19504 (save-excursion
19505 (end-of-line)
19508 (defun org-on-heading-p (&optional ignored)
19509 (outline-on-heading-p t))
19510 (defun org-at-heading-p (&optional ignored)
19511 (outline-on-heading-p t))
19513 (defun org-point-at-end-of-empty-headline ()
19514 "If point is at the end of an empty headline, return t, else nil.
19515 If the heading only contains a TODO keyword, it is still still considered
19516 empty."
19518 (save-excursion
19519 (beginning-of-line 1)
19522 (defun org-at-heading-or-item-p ()
19523 (or (org-on-heading-p) (org-at-item-p)))
19525 (defun org-on-target-p ()
19526 (or (org-in-regexp org-radio-target-regexp)
19527 (org-in-regexp org-target-regexp)))
19529 (defun org-up-heading-all (arg)
19530 "Move to the heading line of which the present line is a subheading.
19531 This function considers both visible and invisible heading lines.
19532 With argument, move up ARG levels."
19533 (if (fboundp 'outline-up-heading-all)
19534 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19535 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19537 (defun org-up-heading-safe ()
19538 "Move to the heading line of which the present line is a subheading.
19539 This version will not throw an error. It will return the level of the
19540 headline found, or nil if no higher level is found.
19542 Also, this function will be a lot faster than `outline-up-heading',
19543 because it relies on stars being the outline starters. This can really
19544 make a significant difference in outlines with very many siblings."
19545 (let (start-level re)
19546 (org-back-to-heading t)
19547 (setq start-level (funcall outline-level))
19548 (if (equal start-level 1)
19549 nil
19551 (if (re-search-backward re nil t)
19552 (funcall outline-level)))))
19554 (defun org-first-sibling-p ()
19555 "Is this heading the first child of its parents?"
19556 (interactive)
19557 (let ((re (concat "^" outline-regexp))
19558 level l)
19559 (unless (org-at-heading-p t)
19560 (error "Not at a heading"))
19561 (setq level (funcall outline-level))
19562 (save-excursion
19563 (if (not (re-search-backward re nil t))
19564 t
19565 (setq l (funcall outline-level))
19566 (< l level)))))
19568 (defun org-goto-sibling (&optional previous)
19569 "Goto the next sibling, even if it is invisible.
19570 When PREVIOUS is set, go to the previous sibling instead. Returns t
19571 when a sibling was found. When none is found, return nil and don't
19572 move point."
19573 (let ((fun (if previous 're-search-backward 're-search-forward))
19574 (pos (point))
19575 (re (concat "^" outline-regexp))
19576 level l)
19577 (when (condition-case nil (org-back-to-heading t) (error nil))
19578 (setq level (funcall outline-level))
19579 (catch 'exit
19580 (or previous (forward-char 1))
19581 (while (funcall fun re nil t)
19582 (setq l (funcall outline-level))
19583 (when (< l level) (goto-char pos) (throw 'exit nil))
19584 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19585 (goto-char pos)
19586 nil))))
19588 (defun org-show-siblings ()
19589 "Show all siblings of the current headline."
19590 (save-excursion
19591 (while (org-goto-sibling) (org-flag-heading nil)))
19592 (save-excursion
19593 (while (org-goto-sibling 'previous)
19594 (org-flag-heading nil))))
19596 (defun org-goto-first-child ()
19597 "Goto the first child, even if it is invisible.
19598 Return t when a child was found. Otherwise don't move point and
19599 return nil."
19600 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19601 (when (condition-case nil (org-back-to-heading t) (error nil))
19602 (setq level (outline-level))
19603 (forward-char 1)
19604 (if (and (re-search-forward re nil t) (> (outline-level) level))
19605 (progn (goto-char (match-beginning 0)) t)
19606 (goto-char pos) nil))))
19608 (defun org-show-hidden-entry ()
19609 "Show an entry where even the heading is hidden."
19610 (save-excursion
19611 (org-show-entry)))
19613 (defun org-flag-heading (flag &optional entry)
19614 "Flag the current heading. FLAG non-nil means make invisible.
19615 When ENTRY is non-nil, show the entire entry."
19616 (save-excursion
19617 (org-back-to-heading t)
19618 ;; Check if we should show the entire entry
19619 (if entry
19620 (progn
19621 (org-show-entry)
19622 (save-excursion
19623 (and (outline-next-heading)
19624 (org-flag-heading nil))))
19625 (outline-flag-region (max (point-min) (1- (point)))
19626 (save-excursion (outline-end-of-heading) (point))
19627 flag))))
19629 (defun org-get-next-sibling ()
19630 "Move to next heading of the same level, and return point.
19631 If there is no such heading, return nil.
19632 This is like outline-next-sibling, but invisible headings are ok."
19633 (let ((level (funcall outline-level)))
19634 (outline-next-heading)
19635 (while (and (not (eobp)) (> (funcall outline-level) level))
19636 (outline-next-heading))
19637 (if (or (eobp) (< (funcall outline-level) level))
19638 nil
19639 (point))))
19641 (defun org-get-last-sibling ()
19642 "Move to previous heading of the same level, and return point.
19643 If there is no such heading, return nil."
19644 (let ((opoint (point))
19645 (level (funcall outline-level)))
19646 (outline-previous-heading)
19647 (when (and (/= (point) opoint) (outline-on-heading-p t))
19648 (while (and (> (funcall outline-level) level)
19649 (not (bobp)))
19650 (outline-previous-heading))
19651 (if (< (funcall outline-level) level)
19652 nil
19653 (point)))))
19655 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19656 ;; This contains an exact copy of the original function, but it uses
19657 ;; `org-back-to-heading', to make it work also in invisible
19658 ;; trees. And is uses an invisible-OK argument.
19659 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19660 ;; Furthermore, when used inside Org, finding the end of a large subtree
19661 ;; with many children and grandchildren etc, this can be much faster
19662 ;; than the outline version.
19663 (org-back-to-heading invisible-OK)
19664 (let ((first t)
19665 (level (funcall outline-level)))
19666 (if (and (org-mode-p) (< level 1000))
19667 ;; A true heading (not a plain list item), in Org-mode
19668 ;; This means we can easily find the end by looking
19669 ;; only for the right number of stars. Using a regexp to do
19670 ;; this is so much faster than using a Lisp loop.
19672 (forward-char 1)
19673 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19674 ;; something else, do it the slow way
19675 (while (and (not (eobp))
19676 (or first (> (funcall outline-level) level)))
19677 (setq first nil)
19678 (outline-next-heading)))
19679 (unless to-heading
19681 (progn
19682 ;; Go to end of line before heading
19683 (forward-char -1)
19685 ;; leave blank line before heading
19686 (forward-char -1))))))
19687 (point))
19689 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19690 "Use Org version in org-mode, for dramatic speed-up."
19691 (if (org-mode-p)
19692 (progn
19693 (org-end-of-subtree nil t)
19694 (unless (eobp) (backward-char 1)))
19695 ad-do-it))
19697 (defun org-forward-same-level (arg &optional invisible-ok)
19698 "Move forward to the arg'th subheading at same level as this one.
19699 Stop at the first and last subheadings of a superior heading.
19700 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19701 it wil also look at invisible ones."
19702 (interactive "p")
19703 (org-back-to-heading invisible-ok)
19704 (org-on-heading-p)
19705 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19707 l)
19708 (forward-char 1)
19709 (while (> arg 0)
19710 (while (and (re-search-forward re nil 'move)
19711 (setq l (- (match-end 0) (match-beginning 0) 1))
19712 (= l level)
19713 (not invisible-ok)
19714 (progn (backward-char 1) (outline-invisible-p)))
19715 (if (< l level) (setq arg 1)))
19716 (setq arg (1- arg)))
19717 (beginning-of-line 1)))
19719 (defun org-backward-same-level (arg &optional invisible-ok)
19720 "Move backward to the arg'th subheading at same level as this one.
19721 Stop at the first and last subheadings of a superior heading."
19722 (interactive "p")
19723 (org-back-to-heading)
19724 (org-on-heading-p)
19725 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19727 l)
19728 (while (> arg 0)
19729 (while (and (re-search-backward re nil 'move)
19730 (setq l (- (match-end 0) (match-beginning 0) 1))
19731 (= l level)
19732 (not invisible-ok)
19733 (outline-invisible-p))
19734 (if (< l level) (setq arg 1)))
19735 (setq arg (1- arg)))))
19737 (defun org-show-subtree ()
19738 "Show everything after this heading at deeper levels."
19739 (outline-flag-region
19740 (point)
19741 (save-excursion
19742 (org-end-of-subtree t t))
19743 nil))
19745 (defun org-show-entry ()
19746 "Show the body directly following this heading.
19747 Show the heading too, if it is currently invisible."
19748 (interactive)
19749 (save-excursion
19750 (condition-case nil
19751 (progn
19752 (org-back-to-heading t)
19753 (outline-flag-region
19754 (max (point-min) (1- (point)))
19755 (save-excursion
19756 (if (re-search-forward
19758 (match-beginning 1)
19759 (point-max)))
19760 nil)
19761 (org-cycle-hide-drawers 'children))
19762 (error nil))))
19764 (defun org-make-options-regexp (kwds &optional extra)
19765 "Make a regular expression for keyword lines."
19766 (concat
19767 "^"
19774 ;; Make isearch reveal the necessary context
19775 (defun org-isearch-end ()
19776 "Reveal context after isearch exits."
19777 (when isearch-success ; only if search was successful
19778 (if (featurep 'xemacs)
19779 ;; Under XEmacs, the hook is run in the correct place,
19780 ;; we directly show the context.
19781 (org-show-context 'isearch)
19782 ;; In Emacs the hook runs *before* restoring the overlays.
19783 ;; So we have to use a one-time post-command-hook to do this.
19784 ;; (Emacs 22 has a special variable, see function `org-mode')
19785 (unless (and (boundp 'isearch-mode-end-hook-quit)
19786 isearch-mode-end-hook-quit)
19787 ;; Only when the isearch was not quitted.
19788 (org-add-hook 'post-command-hook 'org-isearch-post-command
19789 'append 'local)))))
19791 (defun org-isearch-post-command ()
19792 "Remove self from hook, and show context."
19793 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19794 (org-show-context 'isearch))
19797 ;;;; Integration with and fixes for other packages
19799 ;;; Imenu support
19801 (defvar org-imenu-markers nil
19802 "All markers currently used by Imenu.")
19803 (make-variable-buffer-local 'org-imenu-markers)
19805 (defun org-imenu-new-marker (&optional pos)
19806 "Return a new marker for use by Imenu, and remember the marker."
19807 (let ((m (make-marker)))
19808 (move-marker m (or pos (point)))
19809 (push m org-imenu-markers)
19810 m))
19812 (defun org-imenu-get-tree ()
19813 "Produce the index for Imenu."
19814 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19815 (setq org-imenu-markers nil)
19816 (let* ((n org-imenu-depth)
19817 (re (concat "^" outline-regexp))
19818 (subs (make-vector (1+ n) nil))
19819 (last-level 0)
19820 m level head)
19821 (save-excursion
19822 (save-restriction
19823 (widen)
19824 (goto-char (point-max))
19825 (while (re-search-backward re nil t)
19826 (setq level (org-reduced-level (funcall outline-level)))
19827 (when (<= level n)
19828 (looking-at org-complex-heading-regexp)
19829 (setq head (org-link-display-format
19830 (org-match-string-no-properties 4))
19831 m (org-imenu-new-marker))
19832 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19833 (if (>= level last-level)
19834 (push (cons head m) (aref subs level))
19835 (push (cons head (aref subs (1+ level))) (aref subs level))
19836 (loop for i from (1+ level) to n do (aset subs i nil)))
19837 (setq last-level level)))))
19838 (aref subs 1)))
19840 (eval-after-load "imenu"
19841 '(progn
19842 (add-hook 'imenu-after-jump-hook
19843 (lambda ()
19844 (if (org-mode-p)
19845 (org-show-context 'org-goto))))))
19847 (defun org-link-display-format (link)
19848 "Replace a link with either the description, or the link target
19849 if no description is present"
19850 (save-match-data
19851 (if (string-match org-bracket-link-analytic-regexp link)
19852 (replace-match (if (match-end 5)
19853 (match-string 5 link)
19854 (concat (match-string 1 link)
19855 (match-string 3 link)))
19856 nil t link)
19857 link)))
19859 ;; Speedbar support
19861 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19862 "Overlay marking the agenda restriction line in speedbar.")
19863 (overlay-put org-speedbar-restriction-lock-overlay
19864 'face 'org-agenda-restriction-lock)
19865 (overlay-put org-speedbar-restriction-lock-overlay
19866 'help-echo "Agendas are currently limited to this item.")
19867 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19869 (defun org-speedbar-set-agenda-restriction ()
19870 "Restrict future agenda commands to the location at point in speedbar.
19872 (interactive)
19873 (require 'org-agenda)
19874 (let (p m tp np dir txt)
19875 (cond
19876 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19877 'org-imenu t))
19878 (setq m (get-text-property p 'org-imenu-marker))
19879 (with-current-buffer (marker-buffer m)
19880 (goto-char m)
19881 (org-agenda-set-restriction-lock 'subtree)))
19882 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19883 'speedbar-function 'speedbar-find-file))
19884 (setq tp (previous-single-property-change
19885 (1+ p) 'speedbar-function)
19886 np (next-single-property-change
19887 tp 'speedbar-function)
19888 dir (speedbar-line-directory)
19889 txt (buffer-substring-no-properties (or tp (point-min))
19890 (or np (point-max))))
19891 (with-current-buffer (find-file-noselect
19892 (let ((default-directory dir))
19893 (expand-file-name txt)))
19894 (unless (org-mode-p)
19895 (error "Cannot restrict to non-Org-mode file"))
19896 (org-agenda-set-restriction-lock 'file)))
19897 (t (error "Don't know how to restrict Org-mode's agenda")))
19898 (move-overlay org-speedbar-restriction-lock-overlay
19899 (point-at-bol) (point-at-eol))
19900 (setq current-prefix-arg nil)
19901 (org-agenda-maybe-redo)))
19903 (eval-after-load "speedbar"
19904 '(progn
19905 (speedbar-add-supported-extension ".org")
19906 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19907 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19908 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19909 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19910 (add-hook 'speedbar-visiting-tag-hook
19911 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19913 ;;; Fixes and Hacks for problems with other packages
19915 ;; Make flyspell not check words in links, to not mess up our keymap
19916 (defun org-mode-flyspell-verify ()
19917 "Don't let flyspell put overlays at active buttons."
19918 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19919 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19921 (defun org-remove-flyspell-overlays-in (beg end)
19922 "Remove flyspell overlays in region."
19923 (and (org-bound-and-true-p flyspell-mode)
19924 (fboundp 'flyspell-delete-region-overlays)
19925 (flyspell-delete-region-overlays beg end))
19926 (add-text-properties beg end '(org-no-flyspell t)))
19928 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19929 (eval-after-load "bookmark"
19930 '(if (boundp 'bookmark-after-jump-hook)
19931 ;; We can use the hook
19932 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19933 ;; Hook not available, use advice
19934 (defadvice bookmark-jump (after org-make-visible activate)
19935 "Make the position visible."
19936 (org-bookmark-jump-unhide))))
19938 ;; Make sure saveplace shows the location if it was hidden
19939 (eval-after-load "saveplace"
19940 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19941 "Make the position visible."
19942 (org-bookmark-jump-unhide)))
19944 ;; Make sure ecb shows the location if it was hidden
19945 (eval-after-load "ecb"
19946 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19947 "Make hierarchy visible when jumping into location from ECB tree buffer."
19948 (if (org-mode-p)
19949 (org-show-context))))
19951 (defun org-bookmark-jump-unhide ()
19952 "Unhide the current position, to show the bookmark location."
19953 (and (org-mode-p)
19954 (or (outline-invisible-p)
19955 (save-excursion (goto-char (max (point-min) (1- (point))))
19956 (outline-invisible-p)))
19957 (org-show-context 'bookmark-jump)))
19959 ;; Make session.el ignore our circular variable
19960 (eval-after-load "session"
19961 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19963 ;;;; Experimental code
19965 (defun org-closed-in-range ()
19966 "Sparse tree of items closed in a certain time range.
19967 Still experimental, may disappear in the future."
19968 (interactive)
19969 ;; Get the time interval from the user.
19970 (let* ((time1 (org-float-time
19971 (org-read-date nil 'to-time nil "Starting date: ")))
19972 (time2 (org-float-time
19973 (org-read-date nil 'to-time nil "End date:")))
19974 ;; callback function
19975 (callback (lambda ()
19976 (let ((time
19977 (org-float-time
19978 (apply 'encode-time
19979 (org-parse-time-string
19980 (match-string 1))))))
19981 ;; check if time in interval
19982 (and (>= time time1) (<= time time2))))))
19983 ;; make tree, check each match with the callback
19986 ;;;; Finish up
19988 (provide 'org)
19990 (run-hooks 'org-load-hook)
19992 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19994 ;;; org.el ends here