| blob | 60384288f207cb11d533a9b29dcbf1a2ba3f1c15 |
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
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.01trans
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
78 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
89 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
90 ;; the file noutline.el being loaded.
92 ;; We require noutline, which might be provided in outline.el
94 ;; Other stuff we need.
108 ;; babel
117 ;; load languages based on value of `org-babel-load-languages'
119 ;;;###autoload
121 "Load the languages defined in `org-babel-load-languages'."
133 org-babel-load-languages))
136 "Languages which can be evaluated in Org-mode buffers.
137 This list can be used to load support for any of the languages
138 below, note that each language will depend on a different set of
139 system executables and/or Emacs modes. When a language is
141 with `org-babel-execute-src-block' bound by default to C-c
142 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
143 be set to remove code block evaluation from the C-c C-c
144 keybinding. By default only Emacs Lisp (which has no
145 requirements) is loaded."
149 :key-type
177 ;;;; Customization variables
179 "Remove ID property of clones of a subtree.
180 When non-nil, clones of a subtree don't inherit the ID property.
181 Otherwise they inherit the ID property with a new unique
182 identifier."
186 ;;; Version
192 "Show the org-mode version in the echo area.
193 With prefix arg HERE, insert it at point."
219 ;;; Compatibility constants
221 ;;; The custom variables
224 "Outline-based notes management and organizer."
230 "Mode hook for Org-mode, run after the mode was turned on."
235 "Hook that is run after org.el has been loaded."
244 "Load all extensions listed in `org-modules'."
249 org-modules)
253 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
262 (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)
263 "Modules that should always be loaded together with org.el.
264 If a description starts with <C>, the file is not part of Emacs
265 and loading it will require that you have downloaded and properly installed
266 the org-mode distribution.
268 You can also use this system to load external packages (i.e. neither Org
269 core modules, nor modules from the CONTRIB directory). Just add symbols
270 to the end of the list. If the package is called org-xyz.el, then you need
271 to add the symbol `xyz', and the package must have a call to
273 (provide 'org-xyz)"
276 :type
306 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
313 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
321 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
338 "Non-nil means make shift-cursor commands select text when possible.
340 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
341 selecting a region, or enlarge regions started in this way.
342 In Org-mode, in special contexts, these same keys are used for other
343 purposes, important enough to compete with shift selection. Org tries
344 to balance these needs by supporting `shift-select-mode' outside these
345 special contexts, under control of this variable.
347 The default of this variable is nil, to avoid confusing behavior. Shifted
348 cursor keys will then execute Org commands in the following contexts:
349 - on a headline, changing TODO state (left/right) and priority (up/down)
350 - on a time stamp, changing the time
351 - in a plain list item, changing the bullet type
352 - in a property definition line, switching between allowed values
353 - in the BEGIN line of a clock table (changing the time block).
354 Outside these contexts, the commands will throw an error.
356 When this variable is t and the cursor is not in a special context,
357 Org-mode will support shift-selection for making and enlarging regions.
358 To make this more effective, the bullet cycling will no longer happen
359 anywhere in an item line, but only if the cursor is exactly on the bullet.
361 If you set this variable to the symbol `always', then the keys
362 will not be special in headlines, property lines, and item lines, to make
363 shift selection work there as well. If this is what you want, you can
364 use the following alternative commands: `C-c C-t' and `C-c ,' to
365 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
366 TODO sets, `C-c -' to cycle item bullet types, and properties can be
367 edited by hand or in column view.
369 However, when the cursor is on a timestamp, shift-cursor commands
370 will still edit the time stamp - this is just too good to give up.
372 XEmacs user should have this variable set to nil, because shift-select-mode
373 is Emacs 23 only."
381 "Options concerning startup of Org-mode."
386 "Non-nil means entering Org-mode will switch to OVERVIEW.
387 This can also be configured on a per-file basis by adding one of
388 the following lines anywhere in the buffer:
390 #+STARTUP: fold (or `overview', this is equivalent)
391 #+STARTUP: nofold (or `showall', this is equivalent)
392 #+STARTUP: content
393 #+STARTUP: showeverything"
402 "Non-nil means entering Org-mode will set `truncate-lines'.
403 This is useful since some lines containing links can be very long and
404 uninteresting. Also tables look terrible when wrapped."
409 "Non-nil means turn on `org-indent-mode' on startup.
410 This can also be configured on a per-file basis by adding one of
411 the following lines anywhere in the buffer:
413 #+STARTUP: indent
414 #+STARTUP: noindent"
422 When this option is turned on, you can use TeX-like syntax for sub- and
424 considered as a single item - so grouping with {} is normally not
425 needed. For example, the following things will be parsed as single
426 sub- or superscripts.
428 10^24 or 10^tau several digits will be considered 1 item.
429 10^-12 or 10^-tau a leading sign with digits or a word
430 x^2-y^3 will be read as x^2 - y^3, because items are
431 terminated by almost any nonword/nondigit char.
432 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
434 Still, ambiguity is possible - so when in doubt use {} to enclose the
435 sub/superscript. If you set this variable to the symbol `{}',
436 the braces are *required* in order to trigger interpretations as
438 frequently in plain text.
440 Not all export backends support this, but HTML does.
455 "Non-nil means turn on `org-beamer-mode' on startup.
456 This can also be configured on a per-file basis by adding one of
457 the following lines anywhere in the buffer:
459 #+STARTUP: beamer"
464 "Non-nil means align all tables when visiting a file.
465 This is useful when the column width in tables is forced with <N> cookies
466 in table fields. Such tables will look correct only after the first re-align.
467 This can also be configured on a per-file basis by adding one of
468 the following lines anywhere in the buffer:
469 #+STARTUP: align
470 #+STARTUP: noalign"
475 "Non-nil means insert the first line setting Org-mode in empty files.
476 When the function `org-mode' is called interactively in an empty file, this
477 normally means that the file name does not automatically trigger Org-mode.
478 To ensure that the file will always be in Org-mode in the future, a
479 line enforcing Org-mode will be inserted into the buffer, if this option
480 has been set."
485 "Non-nil means use alternative key bindings for some keys.
486 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
487 These keys are also used by other packages like shift-selection-mode'
488 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
489 If you want to use Org-mode together with one of these other modes,
490 or more generally if you would like to move some Org-mode commands to
491 other keys, set this variable and configure the keys with the variable
492 `org-disputed-keys'.
494 This option is only relevant at load-time of Org-mode, and must be set
495 *before* org.el is loaded. Changing it requires a restart of Emacs to
496 become effective."
501 "Non-nil means use extra key sequence definitions for certain commands.
502 This happens automatically if you run XEmacs or if `window-system'
503 is nil. This variable lets you do the same manually. You must
504 set it before loading org.
506 Example: on Carbon Emacs 22 running graphically, with an external
507 keyboard on a Powerbook, the default way of setting M-left might
508 not work for either Alt or ESC. Setting this variable will make
509 it work for ESC."
523 "Keys for which Org-mode and other modes compete.
524 This is an alist, cars are the default keys, second element specifies
525 the alternative to use when `org-replace-disputed-keys' is t.
527 Keys can be specified in any syntax supported by `define-key'.
528 The value of this option takes effect only at Org-mode's startup,
529 therefore you'll have to restart Emacs to apply it after changing."
534 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
535 Or return the original if not disputed.
536 Also apply the translations defined in `org-xemacs-key-equivalents'."
541 org-disputed-keys)))
545 key)
555 "Define a key, possibly translated, as returned by `org-key'."
559 "The ellipsis to use in the Org-mode outline.
560 When nil, just use the standard three dots. When a string, use that instead,
561 When a face, use the standard 3 dots, but with the specified face.
562 The change affects only Org-mode (which will then use its own display table).
563 Changing this requires executing `M-x org-mode' in a buffer to become
564 effective."
574 "Keywords in Org-mode."
579 "String to mark deadline entries.
580 A deadline is this string, followed by a time stamp. Should be a word,
581 terminated by a colon. You can insert a schedule keyword and
583 Changes become only effective after restarting Emacs."
588 "String to mark scheduled TODO entries.
589 A schedule is this string, followed by a time stamp. Should be a word,
590 terminated by a colon. You can insert a schedule keyword and
592 Changes become only effective after restarting Emacs."
597 "String used as the prefix for timestamps logging closing a TODO entry."
602 "String used as prefix for timestamps clocking work hours on an item."
607 "Entries starting with this keyword will never be exported.
608 An entry can be toggled between COMMENT and normal with
610 Changes become only effective after restarting Emacs."
615 "Entries starting with this keyword will be exported in fixed-width font.
616 Quoting applies only to the text in the entry following the headline, and does
617 not extend beyond the next headline, even if that is lower level.
618 An entry can be toggled between QUOTE and normal with
625 "Regular expression for specifying repeated events.
629 "Options concerning the general structure of Org-mode files."
634 "Options about how to make context of a location visible."
658 "Non-nil means show full hierarchy when revealing a location.
659 Org-mode often shows locations in an org-mode file which might have
660 been invisible before. When this is set, the hierarchy of headings
661 above the exposed location is shown.
662 Turning this off for example for sparse trees makes them very compact.
663 Instead of t, this can also be an alist specifying this option for different
664 contexts. Valid contexts are
665 agenda when exposing an entry from the agenda
666 org-goto when using the command `org-goto' on key C-c C-j
667 occur-tree when using the command `org-occur' on key C-c /
668 tags-tree when constructing a sparse tree based on tags matches
669 link-search when exposing search matches associated with a link
670 mark-goto when exposing the jump goal of a mark
671 bookmark-jump when exposing a bookmark location
672 isearch when exiting from an incremental search
673 default default for all contexts not set explicitly"
678 "Non-nil means show following heading when revealing a location.
679 Org-mode often shows locations in an org-mode file which might have
680 been invisible before. When this is set, the heading following the
681 match is shown.
682 Turning this off for example for sparse trees makes them very compact,
683 but makes it harder to edit the location of the match. In such a case,
685 Instead of t, this can also be an alist specifying this option for different
686 contexts. See `org-show-hierarchy-above' for valid contexts."
691 "Non-nil means show all sibling heading when revealing a location.
692 Org-mode often shows locations in an org-mode file which might have
693 been invisible before. When this is set, the sibling of the current entry
694 heading are all made visible. If `org-show-hierarchy-above' is t,
695 the same happens on each level of the hierarchy above the current entry.
697 By default this is on for the isearch context, off for all other contexts.
698 Turning this off for example for sparse trees makes them very compact,
699 but makes it harder to edit the location of the match. In such a case,
701 Instead of t, this can also be an alist specifying this option for different
702 contexts. See `org-show-hierarchy-above' for valid contexts."
707 "Non-nil means show the entry below a headline when revealing a location.
708 Org-mode often shows locations in an org-mode file which might have
709 been invisible before. When this is set, the text below the headline that is
710 exposed is also shown.
712 By default this is off for all contexts.
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "How should indirect tree buffers be displayed?
720 This applies to indirect buffers created with the commands
722 Valid values are:
723 current-window Display in the current window
724 other-window Just display in another window.
725 dedicated-frame Create one new frame, and re-use it each time.
726 new-frame Make a new frame each time. Note that in this case
727 previously-made indirect buffers are kept, and you need to
728 kill these buffers yourself."
738 "Non-nil means activate single letter commands at beginning of a headline.
739 This may also be a function to test for appropriate locations where speed
740 commands should be active."
748 "Alist of additional speed commands.
749 This list will be checked before `org-speed-commands-default'
750 when the variable `org-use-speed-commands' is non-nil
751 and when the cursor is at the beginning of a headline.
752 The car if each entry is a string with a single letter, which must
753 be assigned to `self-insert-command' in the global map.
754 The cdr is either a command to be called interactively, a function
755 to be called, or a form to be evaluated.
756 An entry that is just a list with a single string will be interpreted
757 as a descriptive headline that will be added when listing the speed
758 commands in the Help buffer using the `?' speed command."
770 "Options concerning visibility cycling in Org-mode."
775 "Non-nil means skip CHILDREN state in entries that don't have any."
780 "Maximum level which should still be subject to visibility cycling.
781 Levels higher than this will, for cycling, be treated as text, not a headline.
782 When `org-odd-levels-only' is set, a value of N in this variable actually
783 means 2N-1 stars as the limiting headline.
784 When nil, cycle all levels.
785 Note that the limiting level of cycling is also influenced by
786 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
787 `org-inlinetask-min-level' is, cycling will be limited to levels one less
788 than its value."
795 "Names of drawers. Drawers are not opened by cycling on the headline above.
796 Drawers only open with a TAB on the drawer line itself. A drawer looks like
797 this:
798 :DRAWERNAME:
799 .....
800 :END:
802 the property API.
804 Drawers can be defined on the per-file basis with a line like:
806 #+DRAWERS: HIDDEN STATE PROPERTIES"
812 "Non-nil means entering Org-mode will fold all blocks.
813 This can also be set in on a per-file basis with
815 #+STARTUP: hideblocks
816 #+STARTUP: showblocks"
822 "Cycle globally if cursor is at beginning of buffer and not at a headline.
823 This makes it possible to do global cycling without having to use S-TAB or
825 of the buffer
826 must not be a headline - it may be empty or some other text. When used in
827 this way, `org-cycle-hook' is disables temporarily, to make sure the
828 cursor stays at the beginning of the buffer.
829 When this option is nil, don't do anything special at the beginning
830 of the buffer."
835 "Non-nil means cycle entry level or item indentation in new empty entries.
837 When the cursor is at the end of an empty headline, i.e with only stars
838 and maybe a TODO keyword, TAB will then switch the entry to become a child,
839 and then all possible ancestor states, before returning to the original state.
840 This makes data entry extremely fast: M-RET to create a new headline,
841 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
843 When the cursor is at the end of an empty plain list item, one TAB will
844 make it a subitem, two or more tabs will back up to make this an item
845 higher up in the item hierarchy."
850 "Where should `org-cycle' emulate TAB.
851 nil Never
852 white Only in completely white lines
853 whitestart Only at the beginning of lines, before the first non-white char
854 t Everywhere except in headlines
855 exc-hl-bol Everywhere except at the start of a headline
856 If TAB is used in a place where it does not emulate TAB, the current subtree
857 visibility is cycled."
864 ))
867 "Number of empty lines needed to keep an empty line between collapsed trees.
868 If you leave an empty line between the end of a subtree and the following
869 headline, this empty line is hidden when the subtree is folded.
870 Org-mode will leave (exactly) one empty line visible if the number of
871 empty lines is equal or larger to the number given in this variable.
872 So the default 2 means at least 2 empty lines after the end of a subtree
873 are needed to produce free space between a collapsed subtree and the
874 following headline.
876 If the number is negative, and the number of empty lines is at least -N,
877 all empty lines are shown.
879 Special case: when 0, never leave empty lines in collapsed view."
885 "Hook that is run before visibility cycling is happening.
886 The function(s) in this hook must accept a single argument which indicates
887 the new state that will be set right after running this hook. The
888 argument is a symbol. Before a global state change, it can have the values
889 `overview', `content', or `all'. Before a local state change, it can have
890 the values `folded', `children', or `subtree'."
895 org-cycle-hide-drawers
896 org-cycle-show-empty-lines
897 org-optimize-window-after-visibility-change)
898 "Hook that is run after `org-cycle' has changed the buffer visibility.
899 The function(s) in this hook must accept a single argument which indicates
900 the new state that was set by the most recent `org-cycle' command. The
901 argument is a symbol. After a global state change, it can have the values
902 `overview', `content', or `all'. After a local state change, it can have
903 the values `folded', `children', or `subtree'."
908 "Options concerning structure editing in Org-mode."
913 "Non-nil means skip even levels and only use odd levels for the outline.
914 This has the effect that two stars are being added/taken away in
915 promotion/demotion commands. It also influences how levels are
916 handled by the exporters.
917 Changing it requires restart of `font-lock-mode' to become effective
918 for fontification also in regions already fontified.
919 You may also set this on a per-file basis by adding one of the following
920 lines to the buffer:
922 #+STARTUP: odd
923 #+STARTUP: oddeven"
929 "Non-nil means adapt indentation to outline node level.
931 When this variable is set, Org assumes that you write outlines by
932 indenting text in each node to align with the headline (after the stars).
933 The following issues are influenced by this variable:
935 - When this is set and the *entire* text in an entry is indented, the
936 indentation is increased by one space in a demotion command, and
937 decreased by one in a promotion command. If any line in the entry
938 body starts with text at column 0, indentation is not changed at all.
940 - Property drawers and planning information is inserted indented when
941 this variable s set. When nil, they will not be indented.
943 - TAB indents a line relative to context. The lines below a headline
944 will be indented when this variable is set.
946 Note that this is all about true indentation, by adding and removing
947 space characters. See also `org-indent.el' which does level-dependent
948 indentation in a virtual way, i.e. at display time in Emacs."
953 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
955 When t, `C-a' will bring back the cursor to the beginning of the
956 headline text, i.e. after the stars and after a possible TODO keyword.
957 In an item, this will be the position after the bullet.
958 When the cursor is already at that position, another `C-a' will bring
959 it to the beginning of the line.
961 `C-e' will jump to the end of the headline, ignoring the presence of tags
962 in the headline. A second `C-e' will then jump to the true end of the
963 line, after any tags. This also means that, when this variable is
964 non-nil, `C-e' also will never jump beyond the end of the heading of a
965 folded section, i.e. not after the ellipses.
967 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
968 going to the true line boundary first. Only a directly following, identical
969 keypress will bring the cursor to the special positions.
971 This may also be a cons cell where the behavior for `C-a' and `C-e' is
972 set separately."
991 "Non-nil means `C-k' will behave specially in headlines.
992 When nil, `C-k' will call the default `kill-line' command.
993 When t, the following will happen while the cursor is in the headline:
995 - When the cursor is at the beginning of a headline, kill the entire
996 line and possible the folded subtree below the line.
997 - When in the middle of the headline text, kill the headline up to the tags.
998 - When after the headline text, kill the tags."
1003 "Non-nil means, do not delete a hidden subtree with C-k.
1004 When set to the symbol `error', simply throw an error when C-k is
1005 used to kill (part-of) a headline that has hidden text behind it.
1006 Any other non-nil value will result in a query to the user, if it is
1007 OK to kill that hidden subtree. When nil, kill without remorse."
1015 "Non-nil means when yanking subtrees, fold them.
1016 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1017 it starts with a heading and all other headings in it are either children
1018 or siblings, then fold all the subtrees. However, do this only if no
1019 text after the yank would be swallowed into a folded tree by this action."
1024 "Non-nil means when yanking subtrees, adjust the level.
1025 With this setting, `org-paste-subtree' is used to insert the subtree, see
1026 this function for details."
1031 "Non-nil means M-RET will split the line at the cursor position.
1032 When nil, it will go to the end of the line before making a
1033 new line.
1034 You may also set this option in a different way for different
1035 contexts. Valid contexts are:
1037 headline when creating a new headline
1038 item when creating a new item
1039 table in a table field
1040 default the value to be used for all contexts not explicitly
1041 customized"
1058 "Non-nil means insert new headings after the current subtree.
1059 When nil, the new heading is created directly after the current line.
1062 for the duration of the command."
1068 "Should `org-insert-heading' leave a blank line before new heading/item?
1069 The value is an alist, with `heading' and `plain-list-item' as car,
1070 and a boolean flag as cdr. For plain lists, if the variable
1071 `org-empty-line-terminates-plain-lists' is set, the setting here
1072 is ignored and no empty line is inserted, to keep the list in tact."
1085 "Hook being run after inserting a new heading."
1091 This currently only means they are never auto-wrapped.
1092 When nil, such lines will be treated like ordinary lines.
1093 See also the QUOTE keyword."
1098 "Non-nil means typing characters in `org-goto' starts incremental search."
1103 "Options concerning sparse trees in Org-mode."
1108 "Non-nil means highlight all matches that define a sparse tree.
1109 The highlights will automatically disappear the next time the buffer is
1110 changed by an edit command."
1115 "Non-nil means any change to the buffer will remove temporary highlights.
1116 Such highlights are created by `org-occur' and `org-clock-display'.
1117 When nil, `C-c C-c needs to be used to get rid of the highlights.
1118 The highlights created by `org-preview-latex-fragment' always need
1119 `C-c C-c' to be removed."
1126 "Hook that is run after `org-occur' has constructed a sparse tree.
1127 This can be used to recenter the window to show as much of the structure
1128 as possible."
1133 "Options concerning imenu and speedbar in Org-mode."
1138 "The maximum level for Imenu access to Org-mode headlines.
1139 This also applied for speedbar access."
1144 "Options concerning tables in Org-mode."
1150 When nil, such lines will be treated like ordinary lines.
1152 When equal to the symbol `optimized', the table editor will be optimized to
1153 do the following:
1154 - Automatic overwrite mode in front of whitespace in table fields.
1155 This makes the structure of the table stay in tact as long as the edited
1156 field does not exceed the column width.
1157 - Minimize the number of realigns. Normally, the table is aligned each time
1158 TAB or RET are pressed to move to another field. With optimization this
1159 happens only if changes to a field might have changed the column width.
1160 Optimization requires replacing the functions `self-insert-command',
1161 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1162 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1163 very good at guessing when a re-align will be necessary, but you can always
1166 If you would like to use the optimized version in Org-mode, but the
1167 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1169 This variable can be used to turn on and off the table editor during a session,
1170 but in order to toggle optimization, a restart is required.
1172 See also the variable `org-table-auto-blank-field'."
1180 "Non-nil means cluster self-insert commands for undo when possible.
1181 If this is set, then, like in the Emacs command loop, 20 consecutive
1182 characters will be undone together.
1183 This is configurable, because there is some impact on typing performance."
1188 "Non-nil means TAB will automatically notice a table.el table.
1189 When it sees such a table, it moves point into it and - if necessary -
1190 calls `table-recognize-table'."
1195 "Options concerning links in Org-mode."
1200 "Buffer-local version of `org-link-abbrev-alist', which see.
1205 "Alist of link abbreviations.
1206 The car of each element is a string, to be replaced at the start of a link.
1208 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1210 [[linkkey:tag][description]]
1212 The 'linkkey' must be a word word, starting with a letter, followed
1213 by letters, numbers, '-' or '_'.
1215 If REPLACE is a string, the tag will simply be appended to create the link.
1218 be inserted at that point (see the function `url-hexify-string').
1220 REPLACE may also be a function that will be called with the tag as the
1221 only argument to create the link, which should be returned as a string.
1223 See the manual for examples."
1233 "Non-nil means hide link part and only show description of bracket links.
1234 Bracket links are like [[link][description]]. This variable sets the initial
1235 state in new org-mode buffers. The setting can then be toggled on a
1236 per-buffer basis from the Org->Hyperlinks menu."
1241 "How the path name in file links should be stored.
1242 Valid values are:
1244 relative Relative to the current directory, i.e. the directory of the file
1245 into which the link is being inserted.
1246 absolute Absolute path, if possible with ~ for home directory.
1247 noabbrev Absolute path, no abbreviation of home directory.
1248 adaptive Use relative path for files in the current directory and sub-
1249 directories of it. For other files, use an absolute path."
1258 "Types of links that should be activated in Org-mode files.
1259 This is a list of symbols, each leading to the activation of a certain link
1260 type. In principle, it does not hurt to turn on most link types - there may
1261 be a small gain when turning off unused link types. The types are:
1263 bracket The recommended [[link][description]] or [[link]] links with hiding.
1264 angular Links in angular brackets that may contain whitespace like
1265 <bbdb:Carsten Dominik>.
1266 plain Plain links in normal text, no whitespace, like http://google.com.
1267 radio Text that is matched by a radio target, see manual for details.
1268 tag Tag settings in a headline (link to tag search).
1269 date Time stamps (link to calendar).
1270 footnote Footnote labels.
1272 Changing this variable requires a restart of Emacs to become effective."
1284 "Function to use to generate link descriptions from links.
1285 If nil the link location will be used. This function must take
1286 two parameters; the first is the link and the second the
1287 description `org-insert-link' has generated, and should return the
1288 description to use."
1293 "Options concerning storing links in Org-mode."
1298 "Format of the description part of a link to an email or usenet message.
1299 The following %-escapes will be replaced by corresponding information:
1307 %s subject
1308 %m message-id.
1310 You may use normal field width specification between the % and the letter.
1311 This is for example useful to limit the length of the subject.
1325 It should match if the message is from the user him/herself."
1330 "Non-nil means storing a link to an Org file will use entry IDs.
1332 Note that before this variable is even considered, org-id must be loaded,
1333 so please customize `org-modules' and turn it on.
1335 The variable can have the following values:
1337 t Create an ID if needed to make a link to the current entry.
1339 create-if-interactive
1340 If `org-store-link' is called directly (interactively, as a user
1341 command), do create an ID to support the link. But when doing the
1342 job for remember, only use the ID if it already exists. The
1343 purpose of this setting is to avoid proliferation of unwanted
1344 IDs, just because you happen to be in an Org file when you
1345 call `org-remember' that automatically and preemptively
1346 creates a link. If you do want to get an ID link in a remember
1347 template to an entry not having an ID, create it first by
1348 explicitly creating a link to it, using `C-c C-l' first.
1350 create-if-interactive-and-no-custom-id
1351 Like create-if-interactive, but do not create an ID if there is
1352 a CUSTOM_ID property defined in the entry. This is the default.
1354 use-existing
1355 Use existing ID, do not create one.
1357 nil Never use an ID to make a link, instead link using a text search for
1358 the headline text."
1363 create-if-interactive)
1365 create-if-interactive-and-no-custom-id)
1370 "Non-nil means file links from `org-store-link' contain context.
1371 A search string will be added to the file name with :: as separator and
1372 used to find the context when the link is activated by the command
1373 `org-open-at-point'.
1375 negates this setting for the duration of the command."
1380 "Non-nil means keep link in list for entire session.
1382 The command `org-store-link' adds a link pointing to the current
1383 location to an internal list. These links accumulate during a session.
1384 The command `org-insert-link' can be used to insert links into any
1385 Org-mode file (offering completion for all stored links). When this
1387 will be removed from the list, to make completing the unused links
1388 more efficient."
1393 "Options concerning following links in Org-mode."
1398 "Function to translate links with different syntax to Org syntax.
1399 This can be used to translate links created for example by the Planner
1400 or emacs-wiki packages to Org syntax.
1401 The function must accept two parameters, a TYPE containing the link
1403 which is everything after the link protocol. It should return a cons
1404 with possibly modified values of type and path.
1405 Org contains a function for this, so if you set this variable to
1406 `org-translate-link-from-planner', you should be able follow many
1407 links created by planner."
1412 "Hook that is run after a link has been followed."
1417 "Non-nil means on links TAB will follow the link.
1418 Needs to be set before org.el is loaded.
1419 This really should not be used, it does not make sense, and the
1420 implementation is bad."
1425 "Non-nil means on links RET will follow the link."
1431 "Non-nil means mouse-1 on a link will follow the link.
1432 A longer mouse click will still set point. Does not work on XEmacs.
1433 Needs to be set before org.el is loaded."
1438 "Number of different positions to be recorded in the ring.
1439 Changing this requires a restart of Emacs to work correctly."
1444 "Non-nil means internal links in Org files must exactly match a headline.
1445 When nil, the link search tries to match a phrase will all words
1446 in the search text."
1452 query-to-create)))
1459 "Setup the frame configuration for following links.
1460 When following a link with Emacs, it may often be useful to display
1461 this link in another window or frame. This variable can be used to
1462 set this up for the different types of links.
1463 For VM, use any of
1464 `vm-visit-folder'
1465 `vm-visit-folder-other-frame'
1466 For Gnus, use any of
1467 `gnus'
1468 `gnus-other-frame'
1469 `org-gnus-no-new-news'
1470 For FILE, use any of
1471 `find-file'
1472 `find-file-other-window'
1473 `find-file-other-frame'
1474 For Wanderlust use any of
1475 `wl'
1476 `wl-other-frame'
1477 For the calendar, use the variable `calendar-setup'.
1478 For BBDB, it is currently only possible to display the matches in
1479 another window."
1503 "Non-nil means use indirect buffer to display infile links.
1504 Activating internal links (from one location in a file to another location
1505 in the same file) normally just jumps to the location. When the link is
1507 is displayed in
1508 another window. When this option is set, the other window actually displays
1509 an indirect buffer clone of the current buffer, to avoid any visibility
1510 changes to the current buffer."
1515 "Non-nil means `org-open-file' will open non-existing files.
1516 When nil, an error will be generated.
1517 This variable applies only to external applications because they
1518 might choke on non-existing files. If the link is to a file that
1519 will be opened in Emacs, the variable is ignored."
1524 "Non-nil means a link to a directory really means to index.org.
1525 When nil, following a directory link will run dired or open a finder/explorer
1526 window on that directory."
1531 "Function and arguments to call for following mailto links.
1532 This is a list with the first element being a Lisp function, and the
1533 remaining elements being arguments to the function. In string arguments,
1534 %a will be replaced by the address, and %s will be replaced by the subject
1535 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1544 "Non-nil means ask for confirmation before executing shell links.
1545 Shell links can be dangerous: just think about a link
1547 [[shell:rm -rf ~/*][Google Search]]
1550 but really it would remove your entire home directory.
1551 Therefore we advise against setting this variable to nil.
1552 Just change it to `y-or-n-p' if you want to confirm with a
1560 'safe-local-variable
1564 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1565 Elisp links can be dangerous: just think about a link
1570 but really it would remove your entire home directory.
1571 Therefore we advise against setting this variable to nil.
1572 Just change it to `y-or-n-p' if you want to confirm with a
1580 'safe-local-variable
1587 "Default file applications on a UNIX or GNU/Linux system.
1598 "Default file applications on a MacOS X system.
1600 for some files for which the OS does not have a good default.
1608 'mswindows-shell-execute
1613 'mswindows-shell-execute
1616 "Default file applications on a Windows NT system.
1621 '(
1626 )
1627 "External applications for opening `file:path' items in a document.
1628 Org-mode uses system defaults for different file types, but
1629 you can use this variable to set the application for a given file
1630 extension. The entries in this list are cons cells where the car identifies
1631 files and the cdr the corresponding command. Possible values for the
1632 file identifier are
1634 ways, depending on its contents:
1636 - Alphanumeric characters only:
1637 Match links with this file extension.
1639 to open PDFs with evince.
1641 - Regular expression: Match links where the
1642 filename matches the regexp. If you want to
1643 use groups here, use shy groups.
1647 to open *.html and *.xhtml with firefox.
1649 - Regular expression which contains (non-shy) groups:
1651 anything after that, matches the regexp.
1652 In a custom command string, %1, %2, etc. are replaced with
1653 the parts of the link that were matched by the groups.
1654 For backwards compatibility, if a command string is given
1655 that does not use any of the group matches, this case is
1656 handled identically to the second one (i.e. match against
1657 file name only).
1658 In a custom lisp form, you can access the group matches with
1659 (match-string n link).
1662 to open [[file:document.pdf::5]] with evince at page 5.
1664 `directory' Matches a directory
1665 `remote' Matches a remote file, accessible through tramp or efs.
1666 Remote files most likely should be visited through Emacs
1667 because external applications cannot handle such paths.
1668 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1669 so all files Emacs knows how to handle. Using this with
1670 command `emacs' will open most files in Emacs. Beware that this
1671 will also open html files inside Emacs, unless you add
1673 t Default for files not matched by any of the other options.
1674 `system' The system command to open files, like `open' on Windows
1675 and Mac OS X, and mailcap under GNU/Linux. This is the command
1676 that will be selected if you call `C-c C-o' with a double
1679 Possible values for the command are:
1680 `emacs' The file will be visited by the current Emacs process.
1681 `default' Use the default application for this file type, which is the
1682 association for t in the list, most likely in the system-specific
1683 part.
1684 This can be used to overrule an unwanted setting in the
1685 system-specific variable.
1687 This command is specified by the entry whose car is `system'.
1688 Most likely, the system-specific version of this variable
1689 does define this command, but you can overrule/replace it
1690 here.
1691 string A command to be executed by a shell; %s will be replaced
1692 by the path to the file.
1693 sexp A Lisp form which will be evaluated. The file path will
1694 be available in the Lisp variable `file'.
1695 For more examples, see the system specific constants
1696 `org-file-apps-defaults-macosx'
1697 `org-file-apps-defaults-windowsnt'
1698 `org-file-apps-defaults-gnu'."
1708 auto-mode))
1719 "Options concerning refiling entries in Org-mode."
1724 "Directory with org files.
1725 This is just a default location to look for Org files. There is no need
1726 at all to put your files into this directory. It is only used in the
1727 following situations:
1729 1. When a remember template specifies a target file that is not an
1730 absolute path. The path will then be interpreted relative to
1731 `org-directory'
1732 2. When a remember note is filed away in an interactive way (when exiting the
1733 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1734 with `org-directory' as the default path."
1740 "Default target for storing notes.
1741 Used as a fall back file for org-remember.el and org-capture.el, for
1742 templates that do not specify a target file."
1747 file))
1750 "The default interface to be used for `org-goto'.
1751 Allowed values are:
1752 outline The interface shows an outline of the relevant file
1753 and the correct heading is found by moving through
1754 the outline or by searching with incremental search.
1755 outline-path-completion Headlines in the current buffer are offered via
1756 completion. This is the interface also used by
1757 the refile command."
1764 "Maximum target level when running `org-goto' with refile interface."
1769 "Non-nil means store new notes at the beginning of a file or entry.
1770 When nil, new notes will be filed to the end of a file or entry.
1771 This can also be a list with cons cells of regular expressions that
1772 are matched against file names, and values."
1782 "Information to record when a task is refiled.
1784 Possible values are:
1786 nil Don't add anything
1787 time Add a time stamp to the task
1788 note Prompt for a note and add it with template `org-log-note-headings'
1790 This option can also be set with on a per-file-basis with
1792 #+STARTUP: nologrefile
1793 #+STARTUP: logrefile
1794 #+STARTUP: lognoterefile
1796 You can have local logging settings for a subtree by setting the LOGGING
1797 property to one or more of these keywords.
1799 When bulk-refiling from the agenda, the value `note' is forbidden and
1800 will temporarily be changed to `time'."
1810 This is list of cons cells. Each cell contains:
1811 - a specification of the files to be considered, either a list of files,
1812 or a symbol whose function or variable value will be used to retrieve
1813 a file name or a list of file names. If you use `org-agenda-files' for
1814 that, all agenda files will be scanned for targets. Nil means consider
1815 headings in the current buffer.
1816 - A specification of how to find candidate refile targets. This may be
1817 any of:
1819 This tag has to be present in all target headlines, inheritance will
1820 not be considered.
1822 todo keyword.
1824 headlines that are refiling targets.
1825 - a cons cell (:level . N). Any headline of level N is considered a target.
1826 Note that, when `org-odd-levels-only' is set, level corresponds to
1827 order in hierarchy, not to the number of stars.
1828 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1829 Note that, when `org-odd-levels-only' is set, level corresponds to
1830 order in hierarchy, not to the number of stars.
1832 You can set the variable `org-refile-target-verify-function' to a function
1833 to verify each headline found by the simple criteria above.
1835 When this variable is nil, all top-level headlines in the current buffer
1836 are used, equivalent to the value `((nil . (:level . 1))'."
1852 "Function to verify if the headline at point should be a refile target.
1853 The function will be called without arguments, with point at the
1854 beginning of the headline. It should return t and leave point
1855 where it is if the headline is a valid target for refiling.
1857 If the target should not be selected, the function must return nil.
1858 In addition to this, it may move point to a place from where the search
1859 should be continued. For example, the function may decide that the entire
1860 subtree of the current entry should be excluded and move point to the end
1861 of the subtree."
1866 "Non-nil means cache refile targets to speed up the process.
1867 The cache for a particular file will be updated automatically when
1868 the buffer has been killed, or when any of the marker used for flagging
1869 refile targets no longer points at a live buffer.
1870 If you have added new entries to a buffer that might themselves be targets,
1871 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1872 find that easier, `C-u C-u C-u C-c C-w'."
1877 "Non-nil means provide refile targets as paths.
1878 So a level 3 headline will be available as level1/level2/level3.
1880 When the value is `file', also include the file name (without directory)
1881 into the path. In this case, you can also stop the completion after
1882 the file name, to get entries inserted as top level in the file.
1884 When `full-file-path', include the full file path."
1893 "Non-nil means complete the outline path in hierarchical steps.
1894 When Org-mode uses the refile interface to select an outline path
1895 \(see variable `org-refile-use-outline-path'), the completion of
1896 the path can be done is a single go, or if can be done in steps down
1897 the headline hierarchy. Going in steps is probably the best if you
1898 do not use a special completion package like `ido' or `icicles'.
1899 However, when using these packages, going in one step can be very
1900 fast, while still showing the whole path to the entry."
1905 "Non-nil means allow to create new nodes as refile targets.
1907 of an existing node. When the value of this variable is `confirm',
1908 new node creation must be confirmed by the user (recommended)
1909 When nil, the completion must match an existing entry.
1911 Note that, if the new heading is not seen by the criteria
1912 listed in `org-refile-targets', multiple instances of the same
1913 heading would be created by trying again to file under the new
1914 heading."
1922 "Options concerning TODO items in Org-mode."
1927 "Options concerning Progress logging in Org-mode."
1932 '(
1935 "The available interpretation symbols for customizing `org-todo-keywords'.
1939 "List of TODO entry keyword sequences and their interpretation.
1942 Each sequence starts with a symbol, either `sequence' or `type',
1943 indicating if the keywords should be interpreted as a sequence of
1944 action steps, or as different types of TODO items. The first
1945 keywords are states requiring action - these states will select a headline
1946 for inclusion into the global TODO list Org-mode produces. If one of
1949 the last keyword is treated as the only DONE state of the sequence.
1952 additional state where no keyword is present. For details about this
1953 cycling, see the manual.
1955 TODO keywords and interpretation can also be set on a per-file basis with
1956 the special #+SEQ_TODO and #+TYP_TODO lines.
1958 Each keyword can optionally specify a character for fast state selection
1959 \(in combination with the variable `org-use-fast-todo-selection')
1960 and specifiers for state change logging, using the same syntax
1963 indicates to record a time stamp each time this state is selected.
1965 Each keyword may also specify if a timestamp or a note should be
1966 recorded when entering or leaving the state, by adding additional
1967 characters in the parenthesis after the keyword. This looks like this:
1969 record only the time of the state change. With X and Y being either
1971 Y when leaving the state if and only if the *target* state does not
1972 define X. You may omit any of the fast-selection key or X or /Y,
1973 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1975 For backward compatibility, this variable may also be just a list
1976 of keywords - in this case the interpretation (sequence or type) will be
1977 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1987 ;;Quick and dirty way to see
1988 ;;`org-todo-interpretations'. This takes the
1989 ;;place of item arguments
1990 :convert-widget
1997 org-todo-interpretation-widgets))
1998 widget))
2029 "Controls how TODO keywords are interpreted.
2030 This variable is in principle obsolete and is only used for
2031 backward compatibility, if the interpretation of todo keywords is
2032 not given already in `org-todo-keywords'. See that variable for
2033 more information."
2040 "Non-nil means use the fast todo selection scheme with C-c C-t.
2041 This variable describes if and under what circumstances the cycling
2042 mechanism for TODO keywords will be replaced by a single-key, direct
2043 selection scheme.
2045 When nil, fast selection is never used.
2047 When the symbol `prefix', it will be used when `org-todo' is called with
2048 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2049 in an agenda buffer.
2051 When t, fast selection is used by default. In this case, the prefix
2052 argument forces cycling instead.
2054 In all cases, the special interface is only used if access keys have actually
2055 been assigned by the user, i.e. if keywords in the configuration are followed
2056 by a letter in parenthesis, like TODO(t)."
2064 "Non-nil means update todo statistics after insert and toggle.
2065 ALL-HEADLINES means update todo statistics by including headlines
2066 with no TODO keyword as well, counting them as not done.
2067 A list of TODO keywords means the same, but skip keywords that are
2068 not in this list.
2070 When this is set, todo statistics is updated in the parent of the
2071 current entry each time a todo state is changed."
2081 "Non-nil means TODO statistics covers just direct children.
2082 When nil, all entries in the subtree are considered.
2083 This has only an effect if `org-provide-todo-statistics' is set.
2084 To set this to nil for only a single subtree, use a COOKIE_DATA
2090 "Hook which is run after the state of a TODO item was changed.
2091 The new state (a string with a TODO keyword, or nil) is available in the
2092 Lisp variable `state'."
2097 "Hook for functions that are allowed to block a state change.
2099 Each function gets as its single argument a property list, see
2100 `org-trigger-hook' for more information about this list.
2102 If any of the functions in this hook returns nil, the state change
2106 "Hook for functions that are triggered by a state change.
2108 Each function gets as its single argument a property list with at least
2109 the following elements:
2111 (:type type-of-change :position pos-at-entry-start
2112 :from old-state :to new-state)
2114 Depending on the type, more properties may be present.
2116 This mechanism is currently implemented for:
2118 TODO state changes
2119 ------------------
2120 :type todo-state-change
2121 :from previous state (keyword as a string), or nil, or a symbol
2122 'todo' or 'done', to indicate the general type of state.
2126 "Non-nil means undone TODO entries will block switching the parent to DONE.
2127 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2128 be blocked if any prior sibling is not yet done.
2129 Finally, if the parent is blocked because of ordered siblings of its own,
2130 the child will also be blocked.
2131 This variable needs to be set before org.el is loaded, and you need to
2132 restart Emacs after a change to make the change effective. The only way
2133 to change is while Emacs is running is through the customize interface."
2145 "Non-nil means unchecked boxes will block switching the parent to DONE.
2146 When this is nil, checkboxes have no influence on switching TODO states.
2147 When non-nil, you first need to check off all check boxes before the TODO
2148 entry can be switched to DONE.
2149 This variable needs to be set before org.el is loaded, and you need to
2150 restart Emacs after a change to make the change effective. The only way
2151 to change is while Emacs is running is through the customize interface."
2163 "Non-nil means inserting a TODO heading is treated as state change.
2165 logging will apply if appropriate. When nil, the new TODO item will
2166 be inserted directly, and no logging will take place."
2171 "Non-nil means switching TODO states with S-cursor counts as state change.
2172 This is the default behavior. However, setting this to nil allows a
2173 convenient way to select a TODO state and bypass any logging associated
2174 with that."
2179 "Tag changes that should be triggered by TODO state changes.
2180 This is a list. Each entry is
2182 (state-change (tag . flag) .......)
2184 State-change can be a string with a state, and empty string to indicate the
2185 state that has no TODO keyword, or it can be one of the symbols `todo'
2186 or `done', meaning any not-done or done state, respectively."
2200 "Information to record when a task moves to the DONE state.
2202 Possible values are:
2204 nil Don't add anything, just change the keyword
2205 time Add a time stamp to the task
2206 note Prompt for a note and add it with template `org-log-note-headings'
2208 This option can also be set with on a per-file-basis with
2210 #+STARTUP: nologdone
2211 #+STARTUP: logdone
2212 #+STARTUP: lognotedone
2214 You can have local logging settings for a subtree by setting the LOGGING
2215 property to one or more of these keywords."
2223 ;; Normalize old uses of org-log-done.
2230 "Information to record when the scheduling date of a tasks is modified.
2232 Possible values are:
2234 nil Don't add anything, just change the date
2235 time Add a time stamp to the task
2236 note Prompt for a note and add it with template `org-log-note-headings'
2238 This option can also be set with on a per-file-basis with
2240 #+STARTUP: nologreschedule
2241 #+STARTUP: logreschedule
2242 #+STARTUP: lognotereschedule"
2251 "Information to record when the deadline date of a tasks is modified.
2253 Possible values are:
2255 nil Don't add anything, just change the date
2256 time Add a time stamp to the task
2257 note Prompt for a note and add it with template `org-log-note-headings'
2259 This option can also be set with on a per-file-basis with
2261 #+STARTUP: nologredeadline
2262 #+STARTUP: logredeadline
2263 #+STARTUP: lognoteredeadline
2265 You can have local logging settings for a subtree by setting the LOGGING
2266 property to one or more of these keywords."
2275 "Non-nil means record a note when clocking out of an item.
2276 This can also be configured on a per-file basis by adding one of
2277 the following lines anywhere in the buffer:
2279 #+STARTUP: lognoteclock-out
2280 #+STARTUP: nolognoteclock-out"
2286 "Non-nil means the CLOSED time stamp will contain date and time.
2287 When nil, only the date will be recorded."
2301 "Headings for notes added to entries.
2302 The value is an alist, with the car being a symbol indicating the note
2303 context, and the cdr is the heading to be used. The heading may also be the
2304 empty string.
2305 %t in the heading will be replaced by a time stamp.
2306 %T will be an active time stamp instead the default inactive one
2307 %s will be replaced by the new TODO state, in double quotes.
2308 %S will be replaced by the old TODO state, in double quotes.
2309 %u will be replaced by the user name.
2310 %U will be replaced by the full user name.
2312 In fact, it is not a good idea to change the `state' entry, because
2313 agenda log mode depends on the format of these entries."
2319 "Heading when changing todo state (todo sequence only)"
2333 "Non-nil means insert state change notes and time stamps into a drawer.
2334 When nil, state changes notes will be inserted after the headline and
2335 any scheduling and clock lines, but not inside a drawer.
2337 The value of this variable should be the name of the drawer to use.
2338 LOGBOOK is proposed at the default drawer for this purpose, you can
2339 also set this to a string to define the drawer of your choice.
2343 If this variable is set, `org-log-state-notes-insert-after-drawers'
2344 will be ignored.
2346 You can set the property LOG_INTO_DRAWER to overrule this setting for
2347 a subtree."
2359 "Return the value of `org-log-into-drawer', but let properties overrule.
2360 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2361 used instead of the default value."
2369 "Non-nil means insert state change notes after any drawers in entry.
2370 Only the drawers that *immediately* follow the headline and the
2371 deadline/scheduled line are skipped.
2372 When nil, insert notes right after the heading and perhaps the line
2373 with deadline/scheduling if present.
2375 This variable will have no effect if `org-log-into-drawer' is
2376 set."
2382 "Non-nil means the latest state note will be directly after heading.
2383 When nil, the state change notes will be ordered according to time."
2389 "The TODO state to which a repeater should return the repeating task.
2390 By default this is the first task in a TODO sequence, or the previous state
2391 in a TODO_TYP set. But you can specify another task here.
2392 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2398 "Non-nil means record moving through the DONE state when triggering repeat.
2399 An auto-repeating task is immediately switched back to TODO when
2402 record a closing note, there will be no record of the task moving
2403 through DONE. This variable forces taking a note anyway.
2405 nil Don't force a record
2406 time Record a time stamp
2407 note Record a note
2409 This option can also be set with on a per-file-basis with
2411 #+STARTUP: logrepeat
2412 #+STARTUP: lognoterepeat
2413 #+STARTUP: nologrepeat
2415 You can have local logging settings for a subtree by setting the LOGGING
2416 property to one or more of these keywords."
2426 "Priorities in Org-mode."
2431 "Non-nil means priority commands are active.
2432 When nil, these commands will be disabled, so that you never accidentally
2433 set a priority."
2438 "The highest priority of TODO items. A character like ?A, ?B etc.
2439 Must have a smaller ASCII number than `org-lowest-priority'."
2444 "The lowest priority of TODO items. A character like ?A, ?B etc.
2445 Must have a larger ASCII number than `org-highest-priority'."
2450 "The default priority of TODO items.
2451 This is the priority an item get if no explicit priority is given."
2456 "Non-nil means start with default priority when starting to cycle.
2457 When this is nil, the first step in the cycle will be (depending on the
2458 command used) one higher or lower that the default priority."
2463 "Options concerning time stamps and deadlines in Org-mode."
2468 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2469 When nil, these labeled time stamps are forces into the second line of an
2470 entry, just after the headline. When scheduling from the global TODO list,
2471 the time stamp will always be forced into the second line."
2476 "Formats for `format-time-string' which are used for time stamps.
2480 "Number of minutes to round time stamps to.
2481 These are two values, the first applies when first creating a time stamp.
2482 The second applies when changing it with the commands `S-up' and `S-down'.
2483 When changing the time stamp, this means that it will change in steps
2484 of N minutes, as given by the second value.
2486 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2487 numbers should be factors of 60, so for example 5, 10, 15.
2489 When this is larger than 1, you can still force an exact time stamp by using
2490 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2491 and by using a prefix arg to `S-up/down' to specify the exact number
2492 of minutes to shift."
2502 ;; Normalize old customizations of this variable.
2506 org-time-stamp-rounding-minutes)))
2509 "Non-nil means overlay custom formats over all time stamps.
2510 The formats are defined through the variable `org-time-stamp-custom-formats'.
2511 To turn this on on a per-file basis, insert anywhere in the file:
2512 #+STARTUP: customtime"
2520 "Custom formats for time stamps. See `format-time-string' for the syntax.
2521 These are overlayed over the default ISO format if the variable
2522 `org-display-custom-times' is set. Time like %H:%M should be at the
2523 end of the second format. The custom formats are also honored by export
2524 commands, if custom time display is turned on at the time of export."
2529 "Get the right format for a time string."
2534 f)))
2537 "The format string used when creating CLOCKSUM lines.
2538 This is also used when org-mode generates a time duration."
2544 org-mode generates a time duration."
2549 "The format string used when creating CLOCKSUM lines, or when
2550 org-mode generates a time duration."
2555 "No. of days before expiration during which a deadline becomes active.
2556 This variable governs the display in sparse trees and in the agenda.
2557 When 0 or negative, it means use this number (the absolute value of it)
2558 even if a deadline has a different individual lead time specified.
2560 Custom commands can set this variable in the options section."
2566 "Non-nil means assume future for incomplete date input from user.
2567 This affects the following situations:
2568 1. The user gives a month but not a year.
2571 2. The user gives a day, but no month.
2574 it will be considered as *this* month.
2576 If you set this variable to the symbol `time', then also the following
2577 will work:
2579 3. If the user gives a time, but no day. If the time is before now,
2580 to will be interpreted as tomorrow.
2582 Currently none of this works for ISO week specifications.
2584 When this option is nil, the current day, month and year will always be
2585 used as defaults."
2593 "Non-nil means display current interpretation of date prompt live.
2594 This display will be in an overlay, in the minibuffer."
2599 "Non-nil means pop up a calendar when prompting for a date.
2600 In the calendar, the date can be selected with mouse-1. However, the
2601 minibuffer will also be active, and you can simply enter the date as well.
2602 When nil, only the minibuffer will be available."
2610 "Hook to be used to set up keys for the date/time interface.
2611 Add key definitions to `minibuffer-local-map', which will be a temporary
2612 copy."
2617 "The hour when your day really ends. Must be an integer.
2618 This has influence for the following applications:
2620 the time given here, the day recognized as TODAY is actually yesterday.
2621 - When a date is read from the user and it is still before the time given
2622 here, the current date and time will be assumed to be yesterday, 23:59.
2623 Also, timestamps inserted in remember templates follow this rule.
2625 IMPORTANT: This is a feature whose implementation is and likely will
2626 remain incomplete. Really, it is only here because past midnight seems to
2627 be the favorite working time of John Wiegley :-)"
2632 "Non-nil means S-down will increase the time in a time stamp.
2633 When nil, S-up will increase."
2638 "Non-nil means make the calendar window follow timestamp changes.
2639 When a timestamp is modified and the calendar window is visible, it will be
2640 moved to the new date."
2645 "Options concerning tags in Org-mode."
2650 "List of tags allowed in Org-mode files.
2651 When this list is nil, Org-mode will base TAG input on what is already in the
2652 buffer.
2653 The value of this variable is an alist, the car of each entry must be a
2654 keyword as a string, the cdr may be a character that is used to select
2655 that tag through the fast-tag-selection interface.
2656 See the manual for details."
2671 "List of tags that will always appear in all Org-mode files.
2672 This is in addition to any in buffer settings or customizations
2673 of `org-tag-alist'.
2674 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2675 The value of this variable is an alist, the car of each entry must be a
2676 keyword as a string, the cdr may be a character that is used to select
2677 that tag through the fast-tag-selection interface.
2678 See the manual for details.
2679 To disable these tags on a per-file basis, insert anywhere in the file:
2680 #+STARTUP: noptag"
2691 "If non-nil, always offer completion for all tags of all agenda files.
2692 Instead of customizing this variable directly, you might want to
2693 set it locally for remember buffers, because there no list of
2694 tags in that file can be created dynamically (there are none).
2696 (add-hook 'org-remember-mode-hook
2697 (lambda ()
2698 (set (make-local-variable
2699 'org-complete-tags-always-offer-all-agenda-tags)
2700 t)))"
2705 "List of tags that can be inherited by all entries in the file.
2706 The tags will be inherited if the variable `org-use-tag-inheritance'
2707 says they should be.
2711 "Non-nil means use fast tag selection scheme.
2712 This is a special interface to select and deselect tags with single keys.
2713 When nil, fast selection is never used.
2714 When the symbol `auto', fast selection is used if and only if selection
2715 characters for tags have been configured, either through the variable
2716 `org-tag-alist' or through a #+TAGS line in the buffer.
2717 When t, fast selection is always used and selection keys are assigned
2718 automatically if necessary."
2726 "Non-nil means fast tag selection exits after first change.
2727 When nil, you have to press RET to exit it.
2728 During fast tag selection, you can toggle this flag with `C-c'.
2729 This variable can also have the value `expert'. In this case, the window
2730 displaying the tags menu is not even shown, until you press C-c again."
2738 "Non-nil means fast tags selection interface will also offer TODO states.
2742 "The column to which tags should be indented in a headline.
2743 If this number is positive, it specifies the column. If it is negative,
2744 it means that the tags should be flushright to that column. For example,
2745 -80 works well for a normal 80 character screen."
2750 "Non-nil means realign tags after pro/demotion of TODO state change.
2751 These operations change the length of a headline and therefore shift
2752 the tags around. With this options turned on, after each such operation
2753 the tags are again aligned to `org-tags-column'."
2758 "Non-nil means tags in levels apply also for sublevels.
2759 When nil, only the tags directly given in a specific line apply there.
2760 This may also be a list of tags that should be inherited, or a regexp that
2761 matches tags that should be inherited. Additional control is possible
2762 with the variable `org-tags-exclude-from-inheritance' which gives an
2763 explicit list of tags to be excluded from inheritance., even if the value of
2764 `org-use-tag-inheritance' would select it for inheritance.
2766 If this option is t, a match early-on in a tree can lead to a large
2767 number of matches in the subtree when constructing the agenda or creating
2768 a sparse tree. If you only want to see the first match in a tree during
2769 a search, check out the variable `org-tags-match-list-sublevels'."
2778 "List of tags that should never be inherited.
2779 This is a way to exclude a few tags from inheritance. For way to do
2780 the opposite, to actively allow inheritance for selected tags,
2781 see the variable `org-use-tag-inheritance'."
2786 "Check if TAG is one that should be inherited."
2798 "Non-nil means list also sublevels of headlines matching a search.
2799 This variable applies to tags/property searches, and also to stuck
2800 projects because this search is based on a tags match as well.
2802 When set to the symbol `indented', sublevels are indented with
2803 leading dots.
2805 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2806 the sublevels of a headline matching a tag search often also match
2807 the same search. Listing all of them can create very long lists.
2808 Setting this variable to nil causes subtrees of a match to be skipped.
2810 This variable is semi-obsolete and probably should always be true. It
2811 is better to limit inheritance to certain tags using the variables
2812 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2820 "When set, tags are sorted using this function as a comparator."
2836 "Options concerning properties in Org-mode."
2841 "How property key/value pairs should be formatted by `indent-line'.
2842 When `indent-line' hits a property definition, it will format the line
2843 according to this format, mainly to make sure that the values are
2844 lined-up with respect to each other."
2849 "Non-nil means properties apply also for sublevels.
2851 This setting is chiefly used during property searches. Turning it on can
2852 cause significant overhead when doing a search, which is why it is not
2853 on by default.
2855 When nil, only the properties directly given in the current entry count.
2856 When t, every property is inherited. The value may also be a list of
2857 properties that should have inheritance, or a regular expression matching
2858 properties that should be inherited.
2860 However, note that some special properties use inheritance under special
2861 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2863 for valid values of a property.
2865 Note for programmers:
2866 When querying an entry with `org-entry-get', you can control if inheritance
2867 should be used. By default, `org-entry-get' looks only at the local
2868 properties. You can request inheritance by setting the inherit argument
2869 to t (to force inheritance) or to `selective' (to respect the setting
2870 in this variable)."
2879 "Check if PROPERTY is one that should be inherited."
2890 "The default column format, if no other format has been defined.
2891 This variable can be set on the per-file basis by inserting a line
2893 #+COLUMNS: %25ITEM ....."
2898 "The ellipses to be used when a field in column view is truncated.
2899 When this is the empty string, as many characters as possible are shown,
2900 but then there will be no visual indication that the field has been truncated.
2901 When this is a string of length N, the last N characters of a truncated
2902 field are replaced by this string. If the column is narrower than the
2903 ellipses string, only part of the ellipses string will be shown."
2908 "Function that modifies values for display in column view.
2909 For example, it can be used to cut out a certain part from a time stamp.
2910 The function must take 2 arguments:
2912 column-title The title of the column (*not* the property name)
2913 value The value that should be modified.
2915 The function should return the value that should be displayed,
2916 or nil if the normal value should be used."
2921 "The property that is being used to keep track of effort estimates.
2922 Effort estimates given in this property need to have the format H:MM."
2930 "List of property/value pairs that can be inherited by any entry.
2932 These are fixed values, for the preset properties. The user variable
2933 that can be used to add to this list is `org-global-properties'.
2935 The entries in this list are cons cells where the car is a property
2936 name and cdr is a string with the value. If the value represents
2941 "List of property/value pairs that can be inherited by any entry.
2943 This list will be combined with the constant `org-global-properties-fixed'.
2945 The entries in this list are cons cells where the car is a property
2946 name and cdr is a string with the value.
2948 You can set buffer-local values for the same purpose in the variable
2949 `org-file-properties' this by adding lines like
2951 #+PROPERTY: NAME VALUE"
2958 "List of property/value pairs that can be inherited by any entry.
2959 Valid for the current buffer.
2964 "Options concerning agenda views in Org-mode."
2969 "Variable used by org files to set a category for agenda display.
2970 Such files should use a file variable to set it, for example
2974 or contain a special line
2976 #+CATEGORY: ELisp
2978 If the file does not specify a category, then file's base name
2984 "The files to be used for agenda display.
2988 If an entry is a directory, all files in that directory that are matched by
2989 `org-agenda-file-regexp' will be part of the file list.
2991 If the value of the variable is not a list but a single file name, then
2992 the list of agenda files is actually stored and maintained in that file, one
2993 agenda file per line. In this file paths can be given relative to
2994 `org-directory'. Tilde expansion and environment variable substitution
2995 are also made."
3002 "Regular expression to match files for `org-agenda-files'.
3003 If any element in the list in that variable contains a directory instead
3004 of a normal file, all files in that directory that are matched by this
3005 regular expression will be included."
3010 "List of extra files to be searched by text search commands.
3011 These files will be search in addition to the agenda files by the
3012 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3013 Note that these files will only be searched for text search commands,
3014 not for the other agenda views like todo lists, tag searches or the weekly
3015 agenda. This variable is intended to list notes and possibly archive files
3016 that should also be searched by these two commands.
3017 In fact, if the first element in the list is the symbol `agenda-archives',
3018 than all archive files of all agenda files will be added to the search
3019 scope."
3030 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3031 A nil value means to remove them, after a query, from the list."
3036 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3037 The command `org-calendar-goto-agenda' will be bound to this key. The
3038 default is the character `c' because then `c' can be used to switch back and
3039 forth between agenda and calendar."
3044 "The key to be installed in `calendar-mode-map' for agenda-action.
3045 The command `org-agenda-action' will be bound to this key. The
3046 default is the character `k' because we use the same key in the agenda."
3051 "The key to be installed in `calendar-mode-map' for adding diary entries.
3052 This option is irrelevant until `org-agenda-diary-file' has been configured
3053 to point to an Org-mode file. When that is the case, the command
3054 `org-agenda-diary-entry' will be bound to the key given here, by default
3055 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3056 if you want to continue doing this, you need to change this to a different
3057 key."
3062 "File to which to add new entries with the `i' key in agenda and calendar.
3063 When this is the symbol `diary-file', the functionality in the Emacs
3064 calendar will be used to add entries to the `diary-file'. But when this
3065 points to a file, `org-agenda-diary-entry' will be used instead."
3081 org-calendar-insert-diary-entry-key
3085 "Options for embedding LaTeX code into Org-mode."
3093 "Options for creating images from LaTeX fragments.
3094 This is a property list with the following properties:
3096 `default' means use the foreground of the default face.
3098 `default' means use the background of the default face.
3099 :scale a scaling factor for the size of the images, to get more pixels
3100 :html-foreground, :html-background, :html-scale
3101 the same numbers for HTML export.
3102 :matchers a list indicating which matchers should be used to
3103 find LaTeX fragments. Valid members of this list are:
3114 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3115 When nil, just push out a message."
3124 \[PACKAGES]
3125 \[DEFAULT-PACKAGES]
3126 % The settings below are copied from fullpage.sty
3139 "The document header used for processing LaTeX fragments.
3140 It is imperative that this header make sure that no page number
3141 appears on the page. The package defined in the variables
3142 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3144 will be appended."
3151 "Set the packages alist and make sure it has 3 elements per entry."
3155 x))
3156 val)))
3160 "Get the packages alist and make sure it has 3 elements per entry."
3164 x))
3167 ;; The following variables are defined here because is it also used
3168 ;; when formatting latex fragments. Originally it was part of the
3169 ;; LaTeX exporter, which is why the name includes "export".
3187 )
3188 "Alist of default packages to be inserted in the header.
3189 Change this only if one of the packages here causes an incompatibility
3190 with another package you are using.
3191 The packages in this list are needed by one part or another of Org-mode
3192 to function properly.
3194 - inputenc, fontenc, t1enc: for basic font and character selection
3195 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3196 for interpreting the entities in `org-entities'. You can skip some of these
3197 packages if you don't use any of the symbols in it.
3198 - graphicx: for including images
3199 - float, wrapfig: for figure placement
3200 - longtable: for long tables
3201 - hyperref: for cross references
3203 Therefore you should not modify this variable unless you know what you
3204 are doing. The one reason to change it anyway is that you might be loading
3205 some other package that conflicts with one of the default packages.
3207 If SNIPPET-FLAG is t, the package also needs to be included when
3208 compiling LaTeX snippets into images for inclusion into HTML."
3221 "Alist of packages to be inserted in every LaTeX header.
3222 These will be inserted after `org-export-latex-default-packages-alist'.
3224 SNIPPET-FLAG, when t, indicates that this package is also needed when
3225 turning LaTeX snippets into images for inclusion into HTML.
3226 Make sure that you only list packages here which:
3227 - you want in every file
3228 - do not conflict with the default packages in
3229 `org-export-latex-default-packages-alist'
3230 - do not conflict with the setup in `org-format-latex-header'."
3244 "Settings for Org-mode appearance."
3249 "Non-nil means fontify only the stars in each headline.
3250 When nil, the entire headline is fontified.
3251 Changing it requires restart of `font-lock-mode' to become effective
3252 also in regions already fontified."
3257 "Non-nil means hide the first N-1 stars in a headline.
3258 This works by using the face `org-hide' for these stars. This
3259 face is white for a light background, and black for a dark
3260 background. You may have to customize the face `org-hide' to
3261 make this work.
3262 Changing it requires restart of `font-lock-mode' to become effective
3263 also in regions already fontified.
3264 You may also set this on a per-file basis by adding one of the following
3265 lines to the buffer:
3267 #+STARTUP: hidestars
3268 #+STARTUP: showstars"
3273 "List of keywords that should be hidden when typed in the org buffer.
3274 For example, add #+TITLE to this list in order to make the
3275 document title appear in the buffer without the initial #+TITLE:
3276 keyword."
3284 "Non-nil means change the face of a headline if it is marked DONE.
3285 Normally, only the TODO/DONE keyword indicates the state of a headline.
3286 When this is non-nil, the headline after the keyword is set to the
3287 `org-headline-done' as an additional indication."
3292 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3293 Changing this variable requires a restart of Emacs to take effect."
3298 "Non-nil means fontify the whole line for headings.
3299 This is useful when setting a background color for the
3300 org-level-* faces."
3305 "Non-nil means fontify what is treated specially by the exporters."
3310 "Non-nil mean font-lock should hide the emphasis marker characters."
3315 "Non-nil means show entities as UTF8 characters.
3321 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3326 "Regular expression for matching emphasis.
3327 After a match, the match groups contain these elements:
3328 1 The character before the proper match, or empty at beginning of line
3329 2 The proper match, including the leading and trailing markers
3330 3 The leading marker like * or /, indicating the type of highlighting
3331 4 The text between the emphasis markers, not including the markers
3338 "Set variable and compute the emphasis regular expression."
3342 org-emphasis-alist org-emphasis-regexp-components)
3354 ;; make sure special characters appear at the right position in the class
3366 ;; Make the regexp
3374 body1
3386 body1
3394 "Components used to build the regular expression for emphasis.
3395 This is a list with 6 entries. Terminology: In an emphasis string
3399 specify what is allowed/forbidden in each part:
3401 pre Chars allowed as prematch. Beginning of line will be allowed too.
3402 post Chars allowed as postmatch. End of line will be allowed too.
3403 border The chars *forbidden* as border characters.
3405 non-shy groups here, and don't allow newline here.
3406 newline The maximum number of newlines allowed in an emphasis exp.
3408 Use customize to modify this, or restart Emacs after changing it."
3427 )
3428 "Special syntax for emphasized text.
3429 Text starting and ending with a special character will be emphasized, for
3430 example *bold*, _underlined_ and /italic/. This variable sets the marker
3431 characters, the face to be used by font-lock for highlighting in Org-mode
3432 Emacs buffers, and the HTML tags to be used for this.
3433 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3434 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3435 Use customize to modify this, or restart Emacs after changing it."
3450 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3453 ;;; Miscellaneous options
3456 "Completion in Org-mode."
3461 "Non-nil means use ido completion wherever possible.
3462 Note that `ido-mode' must be active for this variable to be relevant.
3463 If you decide to turn this variable on, you might well want to turn off
3464 `org-outline-path-complete-in-steps'.
3465 See also `org-completion-use-iswitchb'."
3470 "Non-nil means use iswitchb completion wherever possible.
3471 Note that `iswitchb-mode' must be active for this variable to be relevant.
3472 If you decide to turn this variable on, you might well want to turn off
3473 `org-outline-path-complete-in-steps'.
3474 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3480 Normal means no org-mode-specific context."
3484 ;;; Functions and variables from their packages
3485 ;; Declared here to avoid compiler warnings
3487 ;; XEmacs only
3493 ;; Emacs only
3496 ;; Various packages
3514 org-format-agenda-item "org-agenda"
3541 ;;; Autoload and prepare some org modules
3543 ;; Some table stuff that needs to be defined here, because it is used
3544 ;; by the functions setting up org-mode or checking for table context.
3557 "Detect the first line outside a table when searching from within it.
3560 ;; Autoload the functions in org-table.el that are needed by functions here.
3565 org-table-convert org-table-convert-region org-table-copy-down
3566 org-table-copy-region org-table-create
3567 org-table-create-or-convert-from-region
3568 org-table-create-with-table.el org-table-current-dline
3569 org-table-cut-region org-table-delete-column org-table-edit-field
3570 org-table-edit-formulas org-table-end org-table-eval-formula
3571 org-table-export org-table-field-info
3572 org-table-get-stored-formulas org-table-goto-column
3573 org-table-hline-and-move org-table-import org-table-insert-column
3574 org-table-insert-hline org-table-insert-row org-table-iterate
3575 org-table-justify-field-maybe org-table-kill-row
3576 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3577 org-table-move-column org-table-move-column-left
3578 org-table-move-column-right org-table-move-row
3579 org-table-move-row-down org-table-move-row-up
3580 org-table-next-field org-table-next-row org-table-paste-rectangle
3581 org-table-previous-field org-table-recalculate
3582 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3583 org-table-toggle-coordinate-overlays
3584 org-table-toggle-formula-debugger org-table-wrap-region
3585 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3586 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3587 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3590 "Return t if the cursor is inside an org-type table.
3591 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3596 org-table-line-regexp)))
3597 nil))
3601 "Return t if and only if we are at a table.el table."
3607 "If there is a table.el table nearby, recognize it and move into it."
3613 nil
3623 t
3628 t)
3629 nil)
3630 nil))
3633 "Return t if the cursor is inside a hline in a table."
3638 nil))
3643 "Apply FUNCTION to the start of all tables in the buffer."
3659 ;; Declare and autoload functions from org-exp.el & Co
3667 org-insert-export-options-template
3668 org-table-clean-before-export))
3671 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3672 org-export-region-as-ascii))
3675 org-replace-region-by-latex org-export-region-as-latex
3676 org-export-as-latex org-export-as-pdf
3677 org-export-as-pdf-and-open))
3680 org-export-as-html-batch org-export-as-html-to-buffer
3681 org-replace-region-by-html org-export-region-as-html
3682 org-export-as-html))
3685 org-replace-region-by-docbook org-export-region-as-docbook
3686 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3687 org-export-as-docbook))
3690 org-export-icalendar-all-agenda-files
3691 org-export-icalendar-combine-agenda-files))
3695 ;; Declare and autoload functions from org-agenda.el
3700 org-todo-list org-tags-view org-agenda-list-stuck-projects
3701 org-diary org-agenda-to-appt
3702 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3704 ;; Autoload org-remember
3709 org-remember-apply-template org-remember org-remember-handler)))
3714 org-capture-import-remember-templates)))
3716 ;; Autoload org-clock.el
3732 "Return non-nil if clock is currently running.
3733 The return value is actually the clock marker."
3738 "org-clock"
3740 org-clock-goto org-clock-sum org-clock-display
3741 org-clock-remove-overlays org-clock-report
3742 org-clocktable-shift org-dblock-write:clocktable
3743 org-get-clocktable org-resolve-clocks)))
3746 "If this is a CLOCK line, update it and return t.
3747 Otherwise, return nil."
3756 ts te h m s neg)
3759 nil)
3764 ;; The clock is running here
3785 t))))))
3788 "Check if the current buffer contains the running clock.
3789 If yes, offer to stop it and to save the buffer with the changes."
3798 "Check if this line starts a clock table, if yes, shift the time block."
3802 ;; Autoload org-timer.el
3806 "org-timer"
3808 org-timer-change-times-in-region
3809 org-timer-set-timer
3810 org-timer-reset-timers
3811 org-timer-show-remaining-time)))
3813 ;; Autoload org-feed.el
3817 "org-feed"
3821 ;; Autoload org-indent.el
3823 ;; Define the variable already here, to make sure we have it.
3825 "Non-nil if Org-Indent mode is enabled.
3830 "org-indent"
3833 ;; Autoload org-mobile.el
3837 "org-mobile"
3840 ;; Autoload archiving code
3841 ;; The stuff that is needed for cycling and tags has to be defined here.
3844 "Options concerning archiving in Org-mode."
3849 "The location where subtrees should be archived.
3851 The value of this variable is a string, consisting of two parts,
3852 separated by a double-colon. The first part is a filename and
3853 the second part is a headline.
3855 When the filename is omitted, archiving happens in the same file.
3856 %s in the filename will be replaced by the current file
3857 name (without the directory part). Archiving to a different file
3858 is useful to keep archived entries from contributing to the
3859 Org-mode Agenda.
3861 The archived entries will be filed as subtrees of the specified
3862 headline. When the headline is omitted, the subtrees are simply
3863 filed away at the end of the file, as top-level entries. Also in
3864 the heading you can use %s to represent the file name, this can be
3865 useful when using the same archive for a number of different files.
3867 Here are a few examples:
3869 If the current file is Projects.org, archive in file
3870 Projects.org_archive, as top-level trees. This is the default.
3873 Archive in the current file, under the top-level headline
3877 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3880 Archive in file ~/org/archive.org (absolute path), under headlines
3884 Archive in file ./basement (relative path), as level 3 trees
3887 You may set this option on a per-file basis by adding to the buffer a
3888 line like
3890 #+ARCHIVE: basement::** Finished Tasks
3892 You may also define it locally for a subtree by setting an ARCHIVE property
3893 in the entry. If such a property is found in an entry, or anywhere up
3894 the hierarchy, it will be used."
3899 "The tag that marks a subtree as archived.
3900 An archived subtree does not open during visibility cycling, and does
3901 not contribute to the agenda listings.
3902 After changing this, font-lock must be restarted in the relevant buffers to
3903 get the proper fontification."
3909 "Non-nil means the agenda will skip any items located in archived trees.
3910 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3911 variable is no longer recommended, you should leave it at the value t.
3912 Instead, use the key `v' to cycle the archives-mode in the agenda."
3918 "Non-nil means ignore archived trees when creating column view."
3924 "Non-nil means `org-cycle' will open archived trees.
3925 An archived tree is a tree marked with the tag ARCHIVE.
3926 When nil, archived trees will stay folded. You can still open them with
3927 normal outline commands like `show-all', but not with the cycling commands."
3933 "Non-nil means sparse tree construction shows matches in archived trees.
3934 When nil, matches in these trees are highlighted, but the trees are kept in
3935 collapsed state."
3941 "Re-hide all archived subtrees after a visibility state change."
3952 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3955 "Cycle subtree even if it is archived."
3962 "Re-hide all archived subtrees after a visibility state change."
3977 flag)))
3984 org-archive-to-archive-sibling org-toggle-archive-tag
3985 org-archive-subtree-default
3986 org-archive-subtree-default-with-confirmation)))
3988 ;; Autoload Column View Code
3996 org-columns-compute org-agenda-columns org-columns-remove-overlays
3999 ;; Autoload ID code
4007 org-id-get-with-outline-path-completion
4008 org-id-get-with-outline-drilling org-id-store-link
4009 org-id-goto org-id-find org-id-store-link))
4011 ;; Autoload Plotting Code
4016 ;;; Variables for pre-computed regular expressions, all buffer local
4034 "Matches a headline and puts everything into groups:
4035 group 1: the stars
4036 group 2: The todo keyword, maybe
4037 group 3: Priority cookie
4038 group 4: True headline
4044 "Matches a headline and puts TODO state into group 2 if present.
4099 "Regular expression to match a plain time or time range.
4100 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4101 groups carry important information:
4102 0 the full match
4103 1 the first time, range or not
4111 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4112 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4113 groups carry important information:
4114 0 the full match
4115 7 hours of duration
4124 "Regular expression to match a timestamp time or time range.
4125 After a match, the following groups carry important information:
4126 0 the full match
4127 1 date plus weekday, for back referencing to make sure both times are on the same day
4128 2 the first time, range or not
4181 "Variable associated with STARTUP options for org-mode.
4182 Each element is a list of three items: The startup options as written
4183 in the #+STARTUP line, the corresponding variable, and the value to
4184 set this variable to if the option is found. An optional forth element PUSH
4188 "Precompute regular expressions for current buffer."
4208 kwds kws0 kwsa key log value cat arch tags const links hw dws
4209 tail sep kws1 prio props ftags drawers beamer-p
4231 ;; general TODO-like setup
4243 links)))
4249 props)))
4254 ftags
4264 l var val)
4294 ))))
4311 ;; Process the TODO keywords
4313 ;; Use the global values as if they had been given locally.
4325 kws)))
4328 kwsa nil
4331 ;; 1 2
4339 kw)
4341 kws0)
4358 ;; Process the constants
4366 ;; Process the tags.
4377 tgs))
4385 ;; Compute the regular expressions and other local variables
4393 org-drawer-regexp
4397 org-not-done-keywords
4399 org-todo-regexp
4402 org-not-done-regexp
4406 org-not-done-heading-regexp
4410 org-todo-line-regexp
4414 org-complex-heading-regexp
4419 org-complex-heading-regexp-format
4428 org-nl-done-regexp
4432 org-todo-line-tags-regexp
4437 org-looking-at-done-regexp
4442 org-deadline-time-regexp
4444 org-deadline-line-regexp
4446 org-scheduled-regexp
4448 org-scheduled-time-regexp
4450 org-closed-time-regexp
4452 org-keyword-time-regexp
4458 org-keyword-time-not-clock-regexp
4464 org-maybe-keyword-time-regexp
4470 org-planning-or-clock-line-re
4475 org-all-time-keywords
4478 org-clock-string org-closed-string))
4479 )
4484 "Return the contents of FILE, as a string."
4498 "Extract the log state setting from a TODO keyword string.
4512 "Remove a pair of parenthesis at the end of each string in LIST."
4516 x))
4517 list))
4520 "Assign fast keys to a keyword-key alist.
4521 Respect keys that are already there."
4539 ;;; Some variables used in various places
4546 "Function to be called when `C-c C-c' is used.
4550 ;; FIXME: Occasionally check by commenting these, to make sure
4551 ;; no other functions uses these, forgetting to let-bind them.
4556 ;; Defined somewhere in this file, but used before definition.
4562 ;;;; Define the Org-mode
4565 (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"))
4568 ;; We use a before-change function to check if a table might need
4569 ;; an update.
4571 "Indicates that a table might need an update.
4572 This variable is set by `org-before-change-function'.
4575 "Every change indicates that a table might need an update."
4586 ;;;###autoload
4588 "Outline-based notes management and organizer, alias
4591 Org-mode develops organizational tasks around a NOTES file which
4592 contains information about projects as plain text. Org-mode is
4593 implemented on top of outline-mode, which is ideal to keep the content
4594 of large files well structured. It supports ToDo items, deadlines and
4595 time stamps, which magically appear in the diary listing of the Emacs
4596 calendar. Tables are easily created with a built-in table editor.
4597 Plain text URL-like links connect to websites, emails (VM), Usenet
4598 messages (Gnus), BBDB entries, and any files related to the project.
4599 For printing and sharing of notes, an Org-mode file (or a part of it)
4600 can be exported as a structured ASCII or HTML file.
4602 The following commands are available:
4606 ;; Get rid of Outline menus, they are not needed
4607 ;; Need to do this here because define-derived-mode sets up
4608 ;; the keymap so late. Still, it is a waste to call this each time
4609 ;; we switch another buffer into org-mode.
4612 ;; Assume this is Greg's port, it uses easymenu
4637 org-display-table 4
4640 org-ellipsis)))
4645 ;; tag faces set outside customize.... force initialization.
4647 ;; Calc embedded
4653 ;; Activate before-change-function
4657 ;; Check for running clock before killing a buffer
4659 ;; Paragraphs and auto-filling
4663 ;; Beginning/end of defun
4666 ;; Make sure dependence stuff works reliably, even for users who set it
4667 ;; too late :-(
4679 ;; Comment characters
4683 ;; Align options lines
4685 'align-mode-rules-list
4690 ;; Imenu
4694 ;; Make isearch reveal context
4697 ;; Emacs 21 and XEmacs make use of the hook
4699 ;; Emacs 22 deals with this through a special variable
4703 ;; Turn on org-beamer-mode?
4706 ;; If empty file that did not turn on org-mode automatically, make it to.
4729 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4738 ;;;; Font-Lock stuff, including the activators
4769 "Regular expression used to analyze links.
4770 Here is what the match groups contain after a match:
4771 1: http:
4772 2: http
4773 3: path
4774 4: [desc]
4782 "Number of stacked braces for sub/superscript matching.
4783 This has to be set before loading org.el to be effective."
4788 "Create a regular expression which will match a balanced sexp.
4789 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4790 as single character strings.
4791 The regexp returned will match the entire expression including the
4792 delimiters. It will also define a single group which contains the
4793 match except for the outermost delimiters. The maximum depth of
4794 stacked delimiters is N. Escaping delimiters is not possible."
4823 "Update the link regular expressions.
4824 This should be called after the variable `org-link-types' has changed."
4828 org-link-re-with-space
4834 org-link-re-with-space2
4840 org-link-re-with-space3
4845 org-angle-link-re
4851 org-plain-link-re
4855 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4856 org-bracket-link-regexp
4858 org-bracket-link-analytic-regexp
4866 org-bracket-link-analytic-regexp++
4874 org-any-link-re
4885 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4886 "Regular expression matching time strings for analysis.
4887 This one does not require the space after the date, so it can be used
4889 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4905 "Regular expression matching a time stamp or time stamp range.
4911 "Run through the buffer and add overlays to links."
4920 'face
4933 rtn))
4936 "Insert or change an emphasis, i.e. a font like bold or italic.
4937 If there is an active region, change that region to a new emphasis.
4938 If there is no region, just insert the marker characters and position
4939 the cursor between them.
4940 CHAR should be either the marker character, or the first character of the
4941 HTML tag associated with that emphasis. If CHAR is a space, the means
4942 to remove the emphasis of the selected region.
4943 If char is not given (for example in an interactive call) it
4944 will be prompted for."
4995 "Run through the buffer and add overlays to links."
5004 nil
5010 t)))))
5018 t)))
5021 "Fontify #+ lines and blocks, in the correct ways."
5025 limit t)
5030 end end1 quoting block-type)
5033 ;; a single line of backend-specific content
5041 t)
5043 ;; Truly a block
5054 beg end
5066 t))
5079 ;; just any other in-buffer setting, but not indented
5083 t)
5091 t)
5099 "Run through the buffer and add overlays to links."
5107 t)))
5110 "Run through the buffer and add overlays to links."
5112 limit t)
5117 'keymap org-mouse-map
5118 'help-echo
5120 "Footnote definition"
5122 ))
5124 t)))
5127 "Run through the buffer and add overlays to bracketed links."
5131 ;; FIXME: above we should remove the escapes.
5132 ;; but that requires another match, protecting match data,
5133 ;; a lot of overhead for font-lock.
5140 ;; We need to remove the invisible property here. Table narrowing
5141 ;; may have made some of this invisible.
5159 t)))
5162 "Run through the buffer and add overlays to dates."
5174 t)))
5183 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5187 "Run through the buffer and add overlays to target matches."
5195 'keymap org-mouse-map
5199 t)))))
5202 "Find all radio targets in this file and update the regular expression."
5217 t)))
5224 ;; This should be with the exporter code, but we also use if for font-locking
5234 "Compute regular expression for stuff treated specially by exporters."
5241 org-latex-regexps)))
5269 org-entities)))
5273 org-latex-entities)
5274 nil))
5276 ))
5277 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5280 org-export-html-special-string-regexps)))
5285 ))))
5287 'org-latex-and-specials-regexp
5292 "Run through the buffer and add overlays to links."
5296 limit t))
5310 rtn)))
5313 "Restart `font-lock-mode', to force refontification."
5319 "Return a list of all targets in this file.
5320 With optional argument RADIO, only find radio targets."
5322 rtn)
5327 rtn)))
5330 "Make regular expression matching all strings in TARGETS.
5331 The regular expression finds the targets also if there is a line break
5332 between words."
5340 x)
5341 targets
5353 t)))
5356 "Compute the outline level of the heading at point.
5357 This function assumes that the cursor is at the beginning of a line matched
5358 by `outline-regexp'. Otherwise it returns garbage.
5359 If this is called at a normal headline, the level is the number of stars.
5360 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5361 For plain list items, if they are matched by `outline-regexp', this returns
5362 1000 plus the line indentation."
5371 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5378 "Functions that can manipulate `org-font-lock-extra-keywords'.
5379 This is calles after `org-font-lock-extra-keywords' is defined, but before
5380 it is installed to be used by font lock. This can be useful if something
5391 ;; Call the hook
5393 ;; Headlines
5400 ;; Table lines
5403 ;; Table internals
5408 ;; Drawers
5411 ;; Properties
5415 ;; Links
5426 ;; TODO lines
5429 ;; DONE
5435 nil)
5436 ;; Priorities
5438 ;; Tags
5440 ;; Special keywords
5445 ;; Emphasis
5450 ;; Checkboxes
5456 ;; Description list items
5459 ;; ARCHIVEd headings
5462 ;; Specials
5466 ;; Code
5468 ;; COMMENT
5473 ;; Blocks and meta lines
5475 )))
5478 ;; Now set the full font-lock-keywords
5485 "Toggle the composition display of entities as UTF8 characters."
5497 "Find an entity to fontify."
5503 limit t)
5515 nil))))
5518 "Fontify string S like in Org-mode."
5530 "Get the right face for match N in font-lock matching of headlines."
5540 "Get the right face for a TODO keyword KWD.
5541 If KWD is a number, get the corresponding match group."
5549 "Create a face list that inherits INHERIT, but sets the foreground color.
5550 When FACE-OR-COLOR is not a string, just return it."
5554 face-or-color)
5555 face-or-color))
5558 "Add the special tag faces."
5567 "Add the special priority faces."
5574 org-priority-faces)))
5579 "Get the right face for a TODO keyword KWD.
5580 If KWD is a number, get the corresponding match group."
5587 "Remove fontification and activation overlays from links."
5592 deactivate-mark buffer-file-name buffer-file-truename)
5595 beg end
5597 ;; also remove line-prefix and wrap-prefix properties
5599 invisible t intangible t
5600 line-prefix t wrap-prefix t
5601 org-no-flyspell t org-emphasis t)
5603 invisible t intangible t
5604 org-no-flyspell t org-emphasis t)))
5614 "Remove specific display properties that have been added by font lock.
5615 The will remove the raise properties that are used to show superscripts
5616 and subscripts."
5626 "Add raise properties to sub/superscripts."
5630 org-match-substring-regexp
5631 org-match-substring-with-braces-regexp)
5632 limit t)
5642 ;; FIXME: Should we go back one character here, for a_b^c
5643 ;; (goto-char (1- pos)) ;????????????????????
5645 t
5647 'display
5663 t)))))
5665 ;;;; Visibility cycling, including org-goto and indirect buffer
5667 ;;; Cycling
5674 ;;;###autoload
5679 "TAB-action and visibility cycling for Org-mode.
5681 This is the command invoked in Org-mode by the TAB key. Its main purpose
5682 is outline visibility cycling, but it also invokes other actions
5683 in special contexts.
5685 - When this function is called with a prefix argument, rotate the entire
5686 buffer through 3 states (global cycling)
5687 1. OVERVIEW: Show only top-level headlines.
5688 2. CONTENTS: Show all headlines of all levels, but no body text.
5689 3. SHOW ALL: Show everything.
5690 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5691 determined by the variable `org-startup-folded', and by any VISIBILITY
5692 properties in the buffer.
5693 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5694 including any drawers.
5696 - When inside a table, re-align the table and move to the next field.
5698 - When point is at the beginning of a headline, rotate the subtree started
5699 by this line through 3 different states (local cycling)
5700 1. FOLDED: Only the main headline is shown.
5701 2. CHILDREN: The main headline and the direct children are shown.
5702 From this state, you can move to one of the children
5703 and zoom in further.
5704 3. SUBTREE: Show the entire subtree, including body text.
5705 If there is no subtree, switch directly from CHILDREN to FOLDED.
5707 - When point is at the beginning of an empty headline and the variable
5708 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5709 of the headline by demoting and promoting it to likely levels. This
5710 speeds up creation document structure by pressing TAB once or several
5711 times right after creating a new headline.
5713 - When there is a numeric prefix, go up to a heading with level ARG, do
5714 a `show-subtree' and return to the previous cursor position. If ARG
5715 is negative, go up that many levels.
5717 - When point is not at the beginning of a headline, execute the global
5718 binding for TAB, which is re-indenting the line. See the option
5719 `org-cycle-emulate-tab' for details.
5721 - Special case: if point is at the beginning of the buffer and there is
5722 no headline in line 1, this function will act as if called with prefix arg.
5723 But only if also the variable `org-cycle-global-at-bob' is t."
5733 org-inlinetask-min-level
5738 limit-level)))
5754 org-cycle-hook))
5758 ;; special case: use global cycling
5772 ;; Enter the table or move to the next field in the table
5789 ;; Toggle block visibility
5794 ;; Show-subtree, ARG levels up from here.
5806 ;; TAB emulation and template completion
5830 t
5839 "Do the global cycling action."
5843 ;; We just created the overview - now do table of contents
5844 ;; This can be slow in very large buffers, so indicate action
5854 ;; We just showed the table of contents - now show everything
5862 ;; Default action: go to overview
5870 "Do the local cycling action."
5872 ;; First, some boundaries
5879 ; XEmacs does not have `next-single-char-property-change'
5880 ; I'm not sure about Emacs 21.
5898 )
5900 ;; Find out what to do next and set `this-command'
5903 ;; Nothing is hidden behind this heading
5915 org-cycle-skip-children-state-if-no-children))))
5916 ;; Entire subtree is hidden in one line: children view
5930 ;; We just showed the children, or no children are there,
5931 ;; now show everything.
5938 ;; Default action: hide the subtree.
5945 ;;;###autoload
5947 "Cycle the global visibility. For details see `org-cycle'.
5949 With a numeric prefix, show all headlines up to that level."
5965 "Set the visibility required by startup options and properties."
5980 "Switch subtree visibilities according to :VISIBILITY: property."
5987 nil t)
6012 "Switch to overview mode, showing only top-level headlines.
6013 Really, this shows all headlines with level equal or greater than the level
6014 of the first headline in the buffer. This is important, because if the
6015 first headline is not level one, then (hide-sublevels 1) gives confusing
6016 results."
6027 "Show all headlines in the buffer, like a table of contents.
6028 With numerical argument N, show content up to level N."
6031 ;; Visit all headings and show their offspring
6038 t)
6047 "Adjust the window after a change in outline visibility.
6048 This function is the default value of the hook `org-cycle-hook'."
6058 "Remove outline overlays that do not contain non-white stuff."
6068 "Fix visibility issues after moving a subtree."
6069 ;; First, find a reasonable region to look at:
6070 ;; Start two siblings above, end three below
6088 ;; Properly fold already folded siblings
6099 "Show empty lines above all visible headlines.
6100 The region to be covered depends on STATE when called through
6101 `org-cycle-hook'. Lisp program can use t for STATE to get the
6102 entire buffer covered. Note that an empty line is only shown if there
6103 are at least `org-cycle-separator-lines' empty lines before the headline."
6113 beg end b e)
6137 ;; Never hide empty lines at the end of the file.
6147 "Move to the parent and re-show empty lines before visible headlines."
6153 "Return `org-agenda-files' list, plus all open org-mode files.
6154 This is useful for operations that need to scan all of a user's
6155 open and agenda-wise Org files."
6163 files))
6166 "Return the beginning position of the current entry."
6170 "Return the end position of the current entry."
6174 "Re-hide all drawers after a visibility state change."
6201 "Is the end of the current subtree visible?"
6206 "Move cursor to the first headline and recenter the headline.
6207 Optional argument N means put the headline into the Nth line of the window."
6213 ;;; Saving and restoring visibility
6216 "Return a list of the locations of all outline overlays.
6217 The are overlays with the `invisible' property value `outline'.
6218 The return values is a list of cons cells, with start and stop
6219 positions for each overlay.
6220 If USE-MARKERS is set, return the positions as markers."
6238 "Create visibility overlays for all positions in DATA.
6239 DATA should have been made by `org-outline-overlay-data'."
6248 data)))))
6251 "Save and restore outline visibility around BODY.
6252 If USE-MARKERS is non-nil, use markers for the positions.
6253 This means that the buffer may change while running BODY,
6254 but it also means that the buffer should stay alive
6255 during the operation, because otherwise all these markers will
6256 point nowhere."
6261 ,@body
6267 data)))))
6270 ;;; Folding of blocks
6282 "Call FUNCTION at the head of all source blocks in the current buffer.
6283 Optional arguments START and END can be used to limit the range."
6295 "Toggle the visibility of all blocks in the current buffer."
6299 "Fold all blocks in the current buffer."
6305 "Unfold all blocks in the current buffer."
6311 "Toggle visibility of block at point."
6322 "Toggle the visibility of the current block."
6329 ov)
6345 ;; make the block accessible to isearch
6347 ov 'isearch-open-invisible
6358 ;; org-tab-after-check-for-cycling-hook
6360 ;; Remove overlays when changing major mode
6365 ;;; Org-goto
6371 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6387 nil)
6388 (org-defkey map "q" 'org-goto-quit)
6389 (org-defkey map "n" 'outline-next-visible-heading)
6390 (org-defkey map "p" 'outline-previous-visible-heading)
6391 (org-defkey map "f" 'outline-forward-same-level)
6392 (org-defkey map "b" 'outline-backward-same-level)
6393 (org-defkey map "u" 'outline-up-heading))
6394 (org-defkey map "/" 'org-occur)
6395 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6396 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6397 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6398 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6399 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6400 map))
6402 (defconst org-goto-help
6403 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6404 RET=jump to location [Q]uit and return to previous location
6405 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6407 (defvar org-goto-start-pos) ; dynamically scoped parameter
6409 ;; FIXME: Docstring does not mention both interfaces
6410 (defun org-goto (&optional alternative-interface)
6411 "Look up a different location in the current file, keeping current visibility.
6413 When you want look-up or go to a different location in a document, the
6414 fastest way is often to fold the entire buffer and then dive into the tree.
6415 This method has the disadvantage, that the previous location will be folded,
6416 which may not be what you want.
6418 This command works around this by showing a copy of the current buffer
6419 in an indirect buffer, in overview mode. You can dive into the tree in
6420 that copy, use org-occur and incremental search to find a location.
6421 When pressing RET or `Q', the command returns to the original buffer in
6422 which the visibility is still unchanged. After RET is will also jump to
6423 the location selected in the indirect buffer and expose the
6424 the headline hierarchy above."
6425 (interactive "P")
6426 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6427 (org-refile-use-outline-path t)
6428 (org-refile-target-verify-function nil)
6429 (interface
6430 (if (not alternative-interface)
6431 org-goto-interface
6432 (if (eq org-goto-interface 'outline)
6433 'outline-path-completion
6434 'outline)))
6435 (org-goto-start-pos (point))
6436 (selected-point
6437 (if (eq interface 'outline)
6438 (car (org-get-location (current-buffer) org-goto-help))
6439 (nth 3 (org-refile-get-location "Goto: ")))))
6440 (if selected-point
6441 (progn
6442 (org-mark-ring-push org-goto-start-pos)
6443 (goto-char selected-point)
6444 (if (or (org-invisible-p) (org-invisible-p2))
6445 (org-show-context 'org-goto)))
6446 (message "Quit"))))
6448 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6449 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6450 (defvar org-goto-local-auto-isearch-map) ; defined below
6452 (defun org-get-location (buf help)
6453 "Let the user select a location in the Org-mode buffer BUF.
6454 This function uses a recursive edit. It returns the selected position
6455 or nil."
6456 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6457 (isearch-hide-immediately nil)
6458 (isearch-search-fun-function
6459 (lambda () 'org-goto-local-search-headings))
6460 (org-goto-selected-point org-goto-exit-command)
6461 (pop-up-frames nil)
6462 (special-display-buffer-names nil)
6463 (special-display-regexps nil)
6464 (special-display-function nil))
6465 (save-excursion
6466 (save-window-excursion
6467 (delete-other-windows)
6468 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6469 (switch-to-buffer
6470 (condition-case nil
6471 (make-indirect-buffer (current-buffer) "*org-goto*")
6472 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6473 (with-output-to-temp-buffer "*Help*"
6474 (princ help))
6475 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6476 (setq buffer-read-only nil)
6477 (let ((org-startup-truncated t)
6478 (org-startup-folded nil)
6479 (org-startup-align-all-tables nil))
6480 (org-mode)
6481 (org-overview))
6482 (setq buffer-read-only t)
6483 (if (and (boundp 'org-goto-start-pos)
6484 (integer-or-marker-p org-goto-start-pos))
6485 (let ((org-show-hierarchy-above t)
6486 (org-show-siblings t)
6487 (org-show-following-heading t))
6488 (goto-char org-goto-start-pos)
6489 (and (org-invisible-p) (org-show-context)))
6490 (goto-char (point-min)))
6491 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6492 (message "Select location and press RET")
6493 (use-local-map org-goto-map)
6494 (recursive-edit)
6495 ))
6496 (kill-buffer "*org-goto*")
6497 (cons org-goto-selected-point org-goto-exit-command)))
6499 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6500 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6501 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6502 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6504 (defun org-goto-local-search-headings (string bound noerror)
6505 "Search and make sure that any matches are in headlines."
6506 (catch 'return
6507 (while (if isearch-forward
6508 (search-forward string bound noerror)
6509 (search-backward string bound noerror))
6510 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6511 (and (member :headline context)
6512 (not (member :tags context))))
6513 (throw 'return (point))))))
6515 (defun org-goto-local-auto-isearch ()
6516 "Start isearch."
6517 (interactive)
6518 (goto-char (point-min))
6519 (let ((keys (this-command-keys)))
6520 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6521 (isearch-mode t)
6522 (isearch-process-search-char (string-to-char keys)))))
6524 (defun org-goto-ret (&optional arg)
6525 "Finish `org-goto' by going to the new location."
6526 (interactive "P")
6527 (setq org-goto-selected-point (point)
6528 org-goto-exit-command 'return)
6529 (throw 'exit nil))
6531 (defun org-goto-left ()
6532 "Finish `org-goto' by going to the new location."
6533 (interactive)
6534 (if (org-on-heading-p)
6535 (progn
6536 (beginning-of-line 1)
6537 (setq org-goto-selected-point (point)
6538 org-goto-exit-command 'left)
6539 (throw 'exit nil))
6540 (error "Not on a heading")))
6542 (defun org-goto-right ()
6543 "Finish `org-goto' by going to the new location."
6544 (interactive)
6545 (if (org-on-heading-p)
6546 (progn
6547 (setq org-goto-selected-point (point)
6548 org-goto-exit-command 'right)
6549 (throw 'exit nil))
6550 (error "Not on a heading")))
6552 (defun org-goto-quit ()
6553 "Finish `org-goto' without cursor motion."
6554 (interactive)
6555 (setq org-goto-selected-point nil)
6556 (setq org-goto-exit-command 'quit)
6557 (throw 'exit nil))
6559 ;;; Indirect buffer display of subtrees
6561 (defvar org-indirect-dedicated-frame nil
6562 "This is the frame being used for indirect tree display.")
6563 (defvar org-last-indirect-buffer nil)
6565 (defun org-tree-to-indirect-buffer (&optional arg)
6566 "Create indirect buffer and narrow it to current subtree.
6567 With numerical prefix ARG, go up to this level and then take that tree.
6568 If ARG is negative, go up that many levels.
6569 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6570 indirect buffer previously made with this command, to avoid proliferation of
6571 indirect buffers. However, when you call the command with a \
6573 when `org-indirect-buffer-display' is `new-frame', the last buffer
6574 is kept so that you can work with several indirect buffers at the same time.
6575 If `org-indirect-buffer-display' is `dedicated-frame', the \
6577 requests that a new frame be made for the new buffer, so that the dedicated
6578 frame is not changed."
6579 (interactive "P")
6580 (let ((cbuf (current-buffer))
6581 (cwin (selected-window))
6582 (pos (point))
6583 beg end level heading ibuf)
6584 (save-excursion
6585 (org-back-to-heading t)
6586 (when (numberp arg)
6587 (setq level (org-outline-level))
6588 (if (< arg 0) (setq arg (+ level arg)))
6589 (while (> (setq level (org-outline-level)) arg)
6590 (outline-up-heading 1 t)))
6591 (setq beg (point)
6592 heading (org-get-heading))
6593 (org-end-of-subtree t t)
6594 (if (org-on-heading-p) (backward-char 1))
6595 (setq end (point)))
6596 (if (and (buffer-live-p org-last-indirect-buffer)
6597 (not (eq org-indirect-buffer-display 'new-frame))
6598 (not arg))
6599 (kill-buffer org-last-indirect-buffer))
6600 (setq ibuf (org-get-indirect-buffer cbuf)
6601 org-last-indirect-buffer ibuf)
6602 (cond
6603 ((or (eq org-indirect-buffer-display 'new-frame)
6604 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6605 (select-frame (make-frame))
6606 (delete-other-windows)
6607 (switch-to-buffer ibuf)
6608 (org-set-frame-title heading))
6609 ((eq org-indirect-buffer-display 'dedicated-frame)
6610 (raise-frame
6611 (select-frame (or (and org-indirect-dedicated-frame
6612 (frame-live-p org-indirect-dedicated-frame)
6613 org-indirect-dedicated-frame)
6614 (setq org-indirect-dedicated-frame (make-frame)))))
6615 (delete-other-windows)
6616 (switch-to-buffer ibuf)
6617 (org-set-frame-title (concat "Indirect: " heading)))
6618 ((eq org-indirect-buffer-display 'current-window)
6619 (switch-to-buffer ibuf))
6620 ((eq org-indirect-buffer-display 'other-window)
6621 (pop-to-buffer ibuf))
6622 (t (error "Invalid value")))
6623 (if (featurep 'xemacs)
6624 (save-excursion (org-mode) (turn-on-font-lock)))
6625 (narrow-to-region beg end)
6626 (show-all)
6627 (goto-char pos)
6628 (and (window-live-p cwin) (select-window cwin))))
6630 (defun org-get-indirect-buffer (&optional buffer)
6631 (setq buffer (or buffer (current-buffer)))
6632 (let ((n 1) (base (buffer-name buffer)) bname)
6633 (while (buffer-live-p
6634 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6635 (setq n (1+ n)))
6636 (condition-case nil
6637 (make-indirect-buffer buffer bname 'clone)
6638 (error (make-indirect-buffer buffer bname)))))
6640 (defun org-set-frame-title (title)
6641 "Set the title of the current frame to the string TITLE."
6642 ;; FIXME: how to name a single frame in XEmacs???
6643 (unless (featurep 'xemacs)
6644 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6646 ;;;; Structure editing
6648 ;;; Inserting headlines
6650 (defun org-previous-line-empty-p ()
6651 (save-excursion
6652 (and (not (bobp))
6653 (or (beginning-of-line 0) t)
6654 (save-match-data
6657 (defun org-insert-heading (&optional force-heading invisible-ok)
6658 "Insert a new heading or item with same depth at point.
6659 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6660 If point is at the beginning of a headline, insert a sibling before the
6661 current headline. If point is not at the beginning, do not split the line,
6662 but create the new headline after the current line.
6663 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6664 This is important for non-interactive uses of the command."
6665 (interactive "P")
6666 (if (or (= (buffer-size) 0)
6667 (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
6668 (org-on-heading-p))))
6669 (not (org-in-item-p))))
6671 (when (or force-heading (not (org-insert-item)))
6672 (let* ((empty-line-p nil)
6673 (head (save-excursion
6674 (condition-case nil
6675 (progn
6676 (org-back-to-heading invisible-ok)
6677 (setq empty-line-p (org-previous-line-empty-p))
6678 (match-string 0))
6679 (error "*"))))
6680 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6681 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6682 pos hide-previous previous-pos)
6683 (cond
6684 ((and (org-on-heading-p) (bolp)
6685 (or (bobp)
6686 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6687 ;; insert before the current line
6688 (open-line (if blank 2 1)))
6689 ((and (bolp)
6690 (not org-insert-heading-respect-content)
6691 (or (bobp)
6692 (save-excursion
6693 (backward-char 1) (not (org-invisible-p)))))
6694 ;; insert right here
6695 nil)
6696 (t
6697 ;; somewhere in the line
6698 (save-excursion
6699 (setq previous-pos (point-at-bol))
6700 (end-of-line)
6701 (setq hide-previous (org-invisible-p)))
6702 (and org-insert-heading-respect-content (org-show-subtree))
6703 (let ((split
6704 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6705 (save-excursion
6706 (let ((p (point)))
6707 (goto-char (point-at-bol))
6708 (and (looking-at org-complex-heading-regexp)
6709 (> p (match-beginning 4)))))))
6710 tags pos)
6711 (cond
6712 (org-insert-heading-respect-content
6713 (org-end-of-subtree nil t)
6714 (or (bolp) (newline))
6715 (or (org-previous-line-empty-p)
6716 (and blank (newline)))
6717 (open-line 1))
6718 ((org-on-heading-p)
6719 (when hide-previous
6720 (show-children)
6721 (org-show-entry))
6723 (setq tags (and (match-end 2) (match-string 2)))
6724 (and (match-end 1)
6725 (delete-region (match-beginning 1) (match-end 1)))
6726 (setq pos (point-at-bol))
6727 (or split (end-of-line 1))
6728 (delete-horizontal-space)
6730 (buffer-substring (point-at-bol) (point)))
6731 (insert " "))
6732 (newline (if blank 2 1))
6733 (when tags
6734 (save-excursion
6735 (goto-char pos)
6736 (end-of-line 1)
6737 (insert " " tags)
6738 (org-set-tags nil 'align))))
6739 (t
6740 (or split (end-of-line 1))
6741 (newline (if blank 2 1)))))))
6742 (insert head) (just-one-space)
6743 (setq pos (point))
6744 (end-of-line 1)
6745 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6746 (when (and org-insert-heading-respect-content hide-previous)
6747 (save-excursion
6748 (goto-char previous-pos)
6749 (hide-subtree)))
6750 (run-hooks 'org-insert-heading-hook)))))
6752 (defun org-get-heading (&optional no-tags)
6753 "Return the heading of the current entry, without the stars."
6754 (save-excursion
6755 (org-back-to-heading t)
6756 (if (looking-at
6757 (if no-tags
6760 (match-string 1) "")))
6762 (defun org-heading-components ()
6763 "Return the components of the current heading.
6764 This is a list with the following elements:
6765 - the level as an integer
6766 - the reduced level, different if `org-odd-levels-only' is set.
6767 - the TODO keyword, or nil
6768 - the priority character, like ?A, or nil if no priority is given
6769 - the headline text itself, or the tags string if no headline text
6770 - the tags string, or nil."
6771 (save-excursion
6772 (org-back-to-heading t)
6773 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6774 (list (length (match-string 1))
6775 (org-reduced-level (length (match-string 1)))
6776 (org-match-string-no-properties 2)
6777 (and (match-end 3) (aref (match-string 3) 2))
6778 (org-match-string-no-properties 4)
6779 (org-match-string-no-properties 5)))))
6781 (defun org-get-entry ()
6782 "Get the entry text, after heading, entire subtree."
6783 (save-excursion
6784 (org-back-to-heading t)
6785 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6787 (defun org-insert-heading-after-current ()
6788 "Insert a new heading with same level as current, after current subtree."
6789 (interactive)
6790 (org-back-to-heading)
6791 (org-insert-heading)
6792 (org-move-subtree-down)
6793 (end-of-line 1))
6795 (defun org-insert-heading-respect-content ()
6796 (interactive)
6797 (let ((org-insert-heading-respect-content t))
6798 (org-insert-heading t)))
6800 (defun org-insert-todo-heading-respect-content (&optional force-state)
6801 (interactive "P")
6802 (let ((org-insert-heading-respect-content t))
6803 (org-insert-todo-heading force-state t)))
6805 (defun org-insert-todo-heading (arg &optional force-heading)
6806 "Insert a new heading with the same level and TODO state as current heading.
6807 If the heading has no TODO state, or if the state is DONE, use the first
6808 state (TODO by default). Also with prefix arg, force first state."
6809 (interactive "P")
6810 (when (or force-heading (not (org-insert-item 'checkbox)))
6811 (org-insert-heading force-heading)
6812 (save-excursion
6813 (org-back-to-heading)
6814 (outline-previous-heading)
6815 (looking-at org-todo-line-regexp))
6816 (let*
6817 ((new-mark-x
6818 (if (or arg
6819 (not (match-beginning 2))
6820 (member (match-string 2) org-done-keywords))
6821 (car org-todo-keywords-1)
6822 (match-string 2)))
6823 (new-mark
6824 (or
6825 (run-hook-with-args-until-success
6826 'org-todo-get-default-hook new-mark-x nil)
6827 new-mark-x)))
6828 (beginning-of-line 1)
6830 (if org-treat-insert-todo-heading-as-state-change
6831 (org-todo new-mark)
6832 (insert new-mark " "))))
6833 (when org-provide-todo-statistics
6834 (org-update-parent-todo-statistics))))
6836 (defun org-insert-subheading (arg)
6837 "Insert a new subheading and demote it.
6838 Works for outline headings and for plain lists alike."
6839 (interactive "P")
6840 (org-insert-heading arg)
6841 (cond
6842 ((org-on-heading-p) (org-do-demote))
6843 ((org-at-item-p) (org-indent-item 1))))
6845 (defun org-insert-todo-subheading (arg)
6846 "Insert a new subheading with TODO keyword or checkbox and demote it.
6847 Works for outline headings and for plain lists alike."
6848 (interactive "P")
6849 (org-insert-todo-heading arg)
6850 (cond
6851 ((org-on-heading-p) (org-do-demote))
6852 ((org-at-item-p) (org-indent-item 1))))
6854 ;;; Promotion and Demotion
6856 (defvar org-after-demote-entry-hook nil
6857 "Hook run after an entry has been demoted.
6858 The cursor will be at the beginning of the entry.
6859 When a subtree is being demoted, the hook will be called for each node.")
6861 (defvar org-after-promote-entry-hook nil
6862 "Hook run after an entry has been promoted.
6863 The cursor will be at the beginning of the entry.
6864 When a subtree is being promoted, the hook will be called for each node.")
6866 (defun org-promote-subtree ()
6867 "Promote the entire subtree.
6868 See also `org-promote'."
6869 (interactive)
6870 (save-excursion
6871 (org-map-tree 'org-promote))
6872 (org-fix-position-after-promote))
6874 (defun org-demote-subtree ()
6875 "Demote the entire subtree. See `org-demote'.
6876 See also `org-promote'."
6877 (interactive)
6878 (save-excursion
6879 (org-map-tree 'org-demote))
6880 (org-fix-position-after-promote))
6883 (defun org-do-promote ()
6884 "Promote the current heading higher up the tree.
6885 If the region is active in `transient-mark-mode', promote all headings
6886 in the region."
6887 (interactive)
6888 (save-excursion
6889 (if (org-region-active-p)
6890 (org-map-region 'org-promote (region-beginning) (region-end))
6891 (org-promote)))
6892 (org-fix-position-after-promote))
6894 (defun org-do-demote ()
6895 "Demote the current heading lower down the tree.
6896 If the region is active in `transient-mark-mode', demote all headings
6897 in the region."
6898 (interactive)
6899 (save-excursion
6900 (if (org-region-active-p)
6901 (org-map-region 'org-demote (region-beginning) (region-end))
6902 (org-demote)))
6903 (org-fix-position-after-promote))
6905 (defun org-fix-position-after-promote ()
6906 "Make sure that after pro/demotion cursor position is right."
6907 (let ((pos (point)))
6908 (when (save-excursion
6909 (beginning-of-line 1)
6910 (looking-at org-todo-line-regexp)
6911 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6912 (cond ((eobp) (insert " "))
6913 ((eolp) (insert " "))
6914 ((equal (char-after) ?\ ) (forward-char 1))))))
6916 (defun org-current-level ()
6917 "Return the level of the current entry, or nil if before the first headline.
6918 The level is the number of stars at the beginning of the headline."
6919 (save-excursion
6920 (condition-case nil
6921 (progn
6922 (org-back-to-heading t)
6923 (funcall outline-level))
6924 (error nil))))
6926 (defun org-get-previous-line-level ()
6927 "Return the outline depth of the last headline before the current line.
6928 Returns 0 for the first headline in the buffer, and nil if before the
6929 first headline."
6930 (let ((current-level (org-current-level))
6931 (prev-level (when (> (line-number-at-pos) 1)
6932 (save-excursion
6933 (beginning-of-line 0)
6934 (org-current-level)))))
6935 (cond ((null current-level) nil) ; Before first headline
6936 ((null prev-level) 0) ; At first headline
6937 (prev-level))))
6939 (defun org-reduced-level (l)
6940 "Compute the effective level of a heading.
6941 This takes into account the setting of `org-odd-levels-only'."
6942 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6944 (defun org-level-increment ()
6945 "Return the number of stars that will be added or removed at a
6946 time to headlines when structure editing, based on the value of
6947 `org-odd-levels-only'."
6948 (if org-odd-levels-only 2 1))
6950 (defun org-get-valid-level (level &optional change)
6951 "Rectify a level change under the influence of `org-odd-levels-only'
6952 LEVEL is a current level, CHANGE is by how much the level should be
6953 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6954 even level numbers will become the next higher odd number."
6955 (if org-odd-levels-only
6956 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6957 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6958 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6959 (max 1 (+ level (or change 0)))))
6961 (if (boundp 'define-obsolete-function-alias)
6962 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6963 (define-obsolete-function-alias 'org-get-legal-level
6964 'org-get-valid-level)
6965 (define-obsolete-function-alias 'org-get-legal-level
6966 'org-get-valid-level "23.1")))
6968 (defun org-promote ()
6969 "Promote the current heading higher up the tree.
6970 If the region is active in `transient-mark-mode', promote all headings
6971 in the region."
6972 (org-back-to-heading t)
6973 (let* ((level (save-match-data (funcall outline-level)))
6974 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6975 (diff (abs (- level (length up-head) -1))))
6976 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6977 (replace-match up-head nil t)
6978 ;; Fixup tag positioning
6979 (and org-auto-align-tags (org-set-tags nil t))
6980 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6981 (run-hooks 'org-after-promote-entry-hook)))
6983 (defun org-demote ()
6984 "Demote the current heading lower down the tree.
6985 If the region is active in `transient-mark-mode', demote all headings
6986 in the region."
6987 (org-back-to-heading t)
6988 (let* ((level (save-match-data (funcall outline-level)))
6989 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6990 (diff (abs (- level (length down-head) -1))))
6991 (replace-match down-head nil t)
6992 ;; Fixup tag positioning
6993 (and org-auto-align-tags (org-set-tags nil t))
6994 (if org-adapt-indentation (org-fixup-indentation diff))
6995 (run-hooks 'org-after-demote-entry-hook)))
6997 (defun org-cycle-level ()
6998 "Cycle the level of an empty headline through possible states.
6999 This goes first to child, then to parent, level, then up the hierarchy.
7000 After top level, it switches back to sibling level."
7001 (interactive)
7002 (let ((org-adapt-indentation nil))
7003 (when (org-point-at-end-of-empty-headline)
7004 (setq this-command 'org-cycle-level) ; Only needed for caching
7005 (let ((cur-level (org-current-level))
7006 (prev-level (org-get-previous-line-level)))
7007 (cond
7008 ;; If first headline in file, promote to top-level.
7009 ((= prev-level 0)
7010 (loop repeat (/ (- cur-level 1) (org-level-increment))
7011 do (org-do-promote)))
7012 ;; If same level as prev, demote one.
7013 ((= prev-level cur-level)
7014 (org-do-demote))
7015 ;; If parent is top-level, promote to top level if not already.
7016 ((= prev-level 1)
7017 (loop repeat (/ (- cur-level 1) (org-level-increment))
7018 do (org-do-promote)))
7019 ;; If top-level, return to prev-level.
7020 ((= cur-level 1)
7021 (loop repeat (/ (- prev-level 1) (org-level-increment))
7022 do (org-do-demote)))
7023 ;; If less than prev-level, promote one.
7024 ((< cur-level prev-level)
7025 (org-do-promote))
7026 ;; If deeper than prev-level, promote until higher than
7027 ;; prev-level.
7028 ((> cur-level prev-level)
7029 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7030 do (org-do-promote))))
7031 t))))
7033 (defun org-map-tree (fun)
7034 "Call FUN for every heading underneath the current one."
7035 (org-back-to-heading)
7036 (let ((level (funcall outline-level)))
7037 (save-excursion
7038 (funcall fun)
7039 (while (and (progn
7040 (outline-next-heading)
7041 (> (funcall outline-level) level))
7042 (not (eobp)))
7043 (funcall fun)))))
7045 (defun org-map-region (fun beg end)
7046 "Call FUN for every heading between BEG and END."
7047 (let ((org-ignore-region t))
7048 (save-excursion
7049 (setq end (copy-marker end))
7050 (goto-char beg)
7051 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7052 (< (point) end))
7053 (funcall fun))
7054 (while (and (progn
7055 (outline-next-heading)
7056 (< (point) end))
7057 (not (eobp)))
7058 (funcall fun)))))
7060 (defun org-fixup-indentation (diff)
7061 "Change the indentation in the current entry by DIFF.
7062 However, if any line in the current entry has no indentation, or if it
7063 would end up with no indentation after the change, nothing at all is done."
7064 (save-excursion
7065 (let ((end (save-excursion (outline-next-heading)
7066 (point-marker)))
7067 (prohibit (if (> diff 0)
7070 col)
7071 (unless (save-excursion (end-of-line 1)
7072 (re-search-forward prohibit end t))
7073 (while (and (< (point) end)
7075 (goto-char (match-end 0))
7076 (setq col (current-column))
7077 (if (< diff 0) (replace-match ""))
7078 (org-indent-to-column (+ diff col))))
7079 (move-marker end nil))))
7081 (defun org-convert-to-odd-levels ()
7082 "Convert an org-mode file with all levels allowed to one with odd levels.
7083 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7084 level 5 etc."
7085 (interactive)
7086 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7087 (let ((outline-regexp org-outline-regexp)
7088 (outline-level 'org-outline-level)
7089 (org-odd-levels-only nil) n)
7090 (save-excursion
7091 (goto-char (point-min))
7093 (setq n (- (length (match-string 0)) 2))
7094 (while (>= (setq n (1- n)) 0)
7095 (org-demote))
7096 (end-of-line 1))))))
7098 (defun org-convert-to-oddeven-levels ()
7099 "Convert an org-mode file with only odd levels to one with odd/even levels.
7100 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7101 file contains a section with an even level, conversion would
7102 destroy the structure of the file. An error is signaled in this
7103 case."
7104 (interactive)
7105 (goto-char (point-min))
7106 ;; First check if there are no even levels
7108 (org-show-context t)
7109 (error "Not all levels are odd in this file. Conversion not possible"))
7110 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7111 (let ((outline-regexp org-outline-regexp)
7112 (outline-level 'org-outline-level)
7113 (org-odd-levels-only nil) n)
7114 (save-excursion
7115 (goto-char (point-min))
7117 (setq n (/ (1- (length (match-string 0))) 2))
7118 (while (>= (setq n (1- n)) 0)
7119 (org-promote))
7120 (end-of-line 1))))))
7122 (defun org-tr-level (n)
7123 "Make N odd if required."
7124 (if org-odd-levels-only (1+ (/ n 2)) n))
7126 ;;; Vertical tree motion, cutting and pasting of subtrees
7128 (defun org-move-subtree-up (&optional arg)
7129 "Move the current subtree up past ARG headlines of the same level."
7130 (interactive "p")
7131 (org-move-subtree-down (- (prefix-numeric-value arg))))
7133 (defun org-move-subtree-down (&optional arg)
7134 "Move the current subtree down past ARG headlines of the same level."
7135 (interactive "p")
7136 (setq arg (prefix-numeric-value arg))
7137 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7138 'org-get-last-sibling))
7139 (ins-point (make-marker))
7140 (cnt (abs arg))
7141 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7142 ;; Select the tree
7143 (org-back-to-heading)
7144 (setq beg0 (point))
7145 (save-excursion
7146 (setq ne-beg (org-back-over-empty-lines))
7147 (setq beg (point)))
7148 (save-match-data
7149 (save-excursion (outline-end-of-heading)
7150 (setq folded (org-invisible-p)))
7151 (outline-end-of-subtree))
7152 (outline-next-heading)
7153 (setq ne-end (org-back-over-empty-lines))
7154 (setq end (point))
7155 (goto-char beg0)
7156 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7157 ;; include less whitespace
7158 (save-excursion
7159 (goto-char beg)
7160 (forward-line (- ne-beg ne-end))
7161 (setq beg (point))))
7162 ;; Find insertion point, with error handling
7163 (while (> cnt 0)
7164 (or (and (funcall movfunc) (looking-at outline-regexp))
7165 (progn (goto-char beg0)
7166 (error "Cannot move past superior level or buffer limit")))
7167 (setq cnt (1- cnt)))
7168 (if (> arg 0)
7169 ;; Moving forward - still need to move over subtree
7170 (progn (org-end-of-subtree t t)
7171 (save-excursion
7172 (org-back-over-empty-lines)
7173 (or (bolp) (newline)))))
7174 (setq ne-ins (org-back-over-empty-lines))
7175 (move-marker ins-point (point))
7176 (setq txt (buffer-substring beg end))
7177 (org-save-markers-in-region beg end)
7178 (delete-region beg end)
7179 (org-remove-empty-overlays-at beg)
7180 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7181 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7183 (let ((bbb (point)))
7184 (insert-before-markers txt)
7185 (org-reinstall-markers-in-region bbb)
7186 (move-marker ins-point bbb))
7188 (setq ins-end (point))
7189 (goto-char ins-point)
7190 (org-skip-whitespace)
7191 (when (and (< arg 0)
7192 (org-first-sibling-p)
7193 (> ne-ins ne-beg))
7194 ;; Move whitespace back to beginning
7195 (save-excursion
7196 (goto-char ins-end)
7197 (let ((kill-whole-line t))
7198 (kill-line (- ne-ins ne-beg)) (point)))
7200 (move-marker ins-point nil)
7201 (if folded
7202 (hide-subtree)
7203 (org-show-entry)
7204 (show-children)
7205 (org-cycle-hide-drawers 'children))
7206 (org-clean-visibility-after-subtree-move)))
7208 (defvar org-subtree-clip ""
7209 "Clipboard for cut and paste of subtrees.
7210 This is actually only a copy of the kill, because we use the normal kill
7211 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7213 (defvar org-subtree-clip-folded nil
7214 "Was the last copied subtree folded?
7215 This is used to fold the tree back after pasting.")
7217 (defun org-cut-subtree (&optional n)
7218 "Cut the current subtree into the clipboard.
7219 With prefix arg N, cut this many sequential subtrees.
7220 This is a short-hand for marking the subtree and then cutting it."
7221 (interactive "p")
7222 (org-copy-subtree n 'cut))
7224 (defun org-copy-subtree (&optional n cut force-store-markers)
7225 "Cut the current subtree into the clipboard.
7226 With prefix arg N, cut this many sequential subtrees.
7227 This is a short-hand for marking the subtree and then copying it.
7228 If CUT is non-nil, actually cut the subtree.
7229 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7230 of some markers in the region, even if CUT is non-nil. This is
7231 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7232 (interactive "p")
7233 (let (beg end folded (beg0 (point)))
7234 (if (interactive-p)
7235 (org-back-to-heading nil) ; take what looks like a subtree
7236 (org-back-to-heading t)) ; take what is really there
7237 (org-back-over-empty-lines)
7238 (setq beg (point))
7240 (save-match-data
7241 (save-excursion (outline-end-of-heading)
7242 (setq folded (org-invisible-p)))
7243 (condition-case nil
7244 (org-forward-same-level (1- n) t)
7245 (error nil))
7246 (org-end-of-subtree t t))
7247 (org-back-over-empty-lines)
7248 (setq end (point))
7249 (goto-char beg0)
7250 (when (> end beg)
7251 (setq org-subtree-clip-folded folded)
7252 (when (or cut force-store-markers)
7253 (org-save-markers-in-region beg end))
7254 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7255 (setq org-subtree-clip (current-kill 0))
7256 (message "%s: Subtree(s) with %d characters"
7257 (if cut "Cut" "Copied")
7258 (length org-subtree-clip)))))
7260 (defun org-paste-subtree (&optional level tree for-yank)
7261 "Paste the clipboard as a subtree, with modification of headline level.
7262 The entire subtree is promoted or demoted in order to match a new headline
7263 level.
7265 If the cursor is at the beginning of a headline, the same level as
7266 that headline is used to paste the tree
7268 If not, the new level is derived from the *visible* headings
7269 before and after the insertion point, and taken to be the inferior headline
7270 level of the two. So if the previous visible heading is level 3 and the
7271 next is level 4 (or vice versa), level 4 will be used for insertion.
7272 This makes sure that the subtree remains an independent subtree and does
7273 not swallow low level entries.
7275 You can also force a different level, either by using a numeric prefix
7276 argument, or by inserting the heading marker by hand. For example, if the
7279 If optional TREE is given, use this text instead of the kill ring.
7281 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7282 move back over whitespace before inserting, and move point to the end of
7283 the inserted text when done."
7284 (interactive "P")
7285 (setq tree (or tree (and kill-ring (current-kill 0))))
7286 (unless (org-kill-is-subtree-p tree)
7287 (error "%s"
7288 (substitute-command-keys
7290 (let* ((visp (not (org-invisible-p)))
7291 (txt tree)
7296 (old-level (if (string-match ^re txt)
7297 (- (match-end 0) (match-beginning 0) 1)
7298 -1))
7299 (force-level (cond (level (prefix-numeric-value level))
7301 (string-match
7302 ^re_ (buffer-substring
7303 (point-at-bol) (point))))
7304 (- (match-end 1) (match-beginning 1)))
7305 ((and (bolp)
7306 (looking-at org-outline-regexp))
7307 (- (match-end 0) (point) 1))
7308 (t nil)))
7309 (previous-level (save-excursion
7310 (condition-case nil
7311 (progn
7312 (outline-previous-visible-heading 1)
7313 (if (looking-at re)
7314 (- (match-end 0) (match-beginning 0) 1)
7315 1))
7316 (error 1))))
7317 (next-level (save-excursion
7318 (condition-case nil
7319 (progn
7320 (or (looking-at outline-regexp)
7321 (outline-next-visible-heading 1))
7322 (if (looking-at re)
7323 (- (match-end 0) (match-beginning 0) 1)
7324 1))
7325 (error 1))))
7326 (new-level (or force-level (max previous-level next-level)))
7327 (shift (if (or (= old-level -1)
7328 (= new-level -1)
7329 (= old-level new-level))
7330 0
7331 (- new-level old-level)))
7332 (delta (if (> shift 0) -1 1))
7333 (func (if (> shift 0) 'org-demote 'org-promote))
7334 (org-odd-levels-only nil)
7335 beg end newend)
7336 ;; Remove the forced level indicator
7337 (if force-level
7338 (delete-region (point-at-bol) (point)))
7339 ;; Paste
7340 (beginning-of-line 1)
7341 (unless for-yank (org-back-over-empty-lines))
7342 (setq beg (point))
7343 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7344 (insert-before-markers txt)
7346 (setq newend (point))
7347 (org-reinstall-markers-in-region beg)
7348 (setq end (point))
7349 (goto-char beg)
7351 (setq beg (point))
7352 (if (and (org-invisible-p) visp)
7353 (save-excursion (outline-show-heading)))
7354 ;; Shift if necessary
7355 (unless (= shift 0)
7356 (save-restriction
7357 (narrow-to-region beg end)
7358 (while (not (= shift 0))
7359 (org-map-region func (point-min) (point-max))
7360 (setq shift (+ delta shift)))
7361 (goto-char (point-min))
7362 (setq newend (point-max))))
7363 (when (or (interactive-p) for-yank)
7364 (message "Clipboard pasted as level %d subtree" new-level))
7365 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7366 kill-ring
7367 (eq org-subtree-clip (current-kill 0))
7368 org-subtree-clip-folded)
7369 ;; The tree was folded before it was killed/copied
7370 (hide-subtree))
7371 (and for-yank (goto-char newend))))
7373 (defun org-kill-is-subtree-p (&optional txt)
7374 "Check if the current kill is an outline subtree, or a set of trees.
7375 Returns nil if kill does not start with a headline, or if the first
7376 headline level is not the largest headline level in the tree.
7377 So this will actually accept several entries of equal levels as well,
7378 which is OK for `org-paste-subtree'.
7379 If optional TXT is given, check this string instead of the current kill."
7380 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7381 (start-level (and kill
7384 kill)
7385 (- (match-end 2) (match-beginning 2) 1)))
7386 (re (concat "^" org-outline-regexp))
7387 (start (1+ (or (match-beginning 2) -1))))
7388 (if (not start-level)
7389 (progn
7390 nil) ;; does not even start with a heading
7391 (catch 'exit
7392 (while (setq start (string-match re kill (1+ start)))
7393 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7394 (throw 'exit nil)))
7395 t))))
7397 (defvar org-markers-to-move nil
7398 "Markers that should be moved with a cut-and-paste operation.
7399 Those markers are stored together with their positions relative to
7400 the start of the region.")
7402 (defun org-save-markers-in-region (beg end)
7403 "Check markers in region.
7404 If these markers are between BEG and END, record their position relative
7405 to BEG, so that after moving the block of text, we can put the markers back
7406 into place.
7407 This function gets called just before an entry or tree gets cut from the
7408 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7409 called immediately, to move the markers with the entries."
7410 (setq org-markers-to-move nil)
7411 (when (featurep 'org-clock)
7412 (org-clock-save-markers-for-cut-and-paste beg end))
7413 (when (featurep 'org-agenda)
7414 (org-agenda-save-markers-for-cut-and-paste beg end)))
7416 (defun org-check-and-save-marker (marker beg end)
7417 "Check if MARKER is between BEG and END.
7418 If yes, remember the marker and the distance to BEG."
7419 (when (and (marker-buffer marker)
7420 (equal (marker-buffer marker) (current-buffer)))
7421 (if (and (>= marker beg) (< marker end))
7422 (push (cons marker (- marker beg)) org-markers-to-move))))
7424 (defun org-reinstall-markers-in-region (beg)
7425 "Move all remembered markers to their position relative to BEG."
7426 (mapc (lambda (x)
7427 (move-marker (car x) (+ beg (cdr x))))
7428 org-markers-to-move)
7429 (setq org-markers-to-move nil))
7431 (defun org-narrow-to-subtree ()
7432 "Narrow buffer to the current subtree."
7433 (interactive)
7434 (save-excursion
7435 (save-match-data
7436 (narrow-to-region
7437 (progn (org-back-to-heading t) (point))
7438 (progn (org-end-of-subtree t t)
7439 (if (org-on-heading-p) (backward-char 1))
7440 (point))))))
7442 (eval-when-compile
7443 (defvar org-property-drawer-re))
7445 (defun org-clone-subtree-with-time-shift (n &optional shift)
7446 "Clone the task (subtree) at point N times.
7447 The clones will be inserted as siblings.
7449 In interactive use, the user will be prompted for the number of
7450 clones to be produced, and for a time SHIFT, which may be a
7451 repeater as used in time stamps, for example `+3d'.
7453 When a valid repeater is given and the entry contains any time
7454 stamps, the clones will become a sequence in time, with time
7455 stamps in the subtree shifted for each clone produced. If SHIFT
7456 is nil or the empty string, time stamps will be left alone. The
7457 ID property of the original subtree is removed.
7459 If the original subtree did contain time stamps with a repeater,
7460 the following will happen:
7461 - the repeater will be removed in each clone
7462 - an additional clone will be produced, with the current, unshifted
7463 date(s) in the entry.
7464 - the original entry will be placed *after* all the clones, with
7465 repeater intact.
7466 - the start days in the repeater in the original entry will be shifted
7467 to past the last clone.
7468 I this way you can spell out a number of instances of a repeating task,
7469 and still retain the repeater to cover future instances of the task."
7470 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7471 (let (beg end template task idprop
7472 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7473 (if (not (and (integerp n) (> n 0)))
7474 (error "Invalid number of replications %s" n))
7477 shift)))
7478 (error "Invalid shift specification %s" shift))
7479 (when doshift
7480 (setq shift-n (string-to-number (match-string 1 shift))
7481 shift-what (cdr (assoc (match-string 2 shift)
7482 '(("d" . day) ("w" . week)
7483 ("m" . month) ("y" . year))))))
7484 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7485 (setq nmin 1 nmax n)
7486 (org-back-to-heading t)
7487 (setq beg (point))
7488 (setq idprop (org-entry-get nil "ID"))
7489 (org-end-of-subtree t t)
7491 (setq end (point))
7492 (setq template (buffer-substring beg end))
7493 (when (and doshift
7495 (delete-region beg end)
7496 (setq end beg)
7497 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7498 (goto-char end)
7499 (loop for n from nmin to nmax do
7500 ;; prepare clone
7501 (with-temp-buffer
7502 (insert template)
7503 (org-mode)
7504 (goto-char (point-min))
7505 (and idprop (if org-clone-delete-id
7506 (org-entry-delete nil "ID")
7507 (org-id-get-create t)))
7508 (while (re-search-forward org-property-drawer-re nil t)
7509 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7510 (goto-char (point-min))
7511 (when doshift
7512 (while (re-search-forward org-ts-regexp-both nil t)
7513 (org-timestamp-change (* n shift-n) shift-what))
7514 (unless (= n n-no-remove)
7515 (goto-char (point-min))
7516 (while (re-search-forward org-ts-regexp nil t)
7517 (save-excursion
7518 (goto-char (match-beginning 0))
7520 (delete-region (match-beginning 1) (match-end 1)))))))
7521 (setq task (buffer-string)))
7522 (insert task))
7523 (goto-char beg)))
7525 ;;; Outline Sorting
7527 (defun org-sort (with-case)
7528 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
7529 Optional argument WITH-CASE means sort case-sensitively.
7530 With a double prefix argument, also remove duplicate entries."
7531 (interactive "P")
7532 (if (org-at-table-p)
7533 (org-call-with-arg 'org-table-sort-lines with-case)
7534 (org-call-with-arg 'org-sort-entries-or-items with-case)))
7536 (defun org-sort-remove-invisible (s)
7537 (remove-text-properties 0 (length s) org-rm-props s)
7538 (while (string-match org-bracket-link-regexp s)
7539 (setq s (replace-match (if (match-end 2)
7540 (match-string 3 s)
7541 (match-string 1 s)) t t s)))
7542 s)
7544 (defvar org-priority-regexp) ; defined later in the file
7546 (defvar org-after-sorting-entries-or-items-hook nil
7547 "Hook that is run after a bunch of entries or items have been sorted.
7548 When children are sorted, the cursor is in the parent line when this
7549 hook gets called. When a region or a plain list is sorted, the cursor
7550 will be in the first entry of the sorted region/list.")
7552 (defun org-sort-entries-or-items
7553 (&optional with-case sorting-type getkey-func compare-func property)
7554 "Sort entries on a certain level of an outline tree, or plain list items.
7555 If there is an active region, the entries in the region are sorted.
7556 Else, if the cursor is before the first entry, sort the top-level items.
7557 Else, the children of the entry at point are sorted.
7558 If the cursor is at the first item in a plain list, the list items will be
7559 sorted.
7561 Sorting can be alphabetically, numerically, by date/time as given by
7562 a time stamp, by a property or by priority.
7564 The command prompts for the sorting type unless it has been given to the
7565 function through the SORTING-TYPE argument, which needs to be a character,
7566 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7567 precise meaning of each character:
7569 n Numerically, by converting the beginning of the entry/item to a number.
7570 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7571 t By date/time, either the first active time stamp in the entry, or, if
7572 none exist, by the first inactive one.
7573 In items, only the first line will be checked.
7574 s By the scheduled date/time.
7575 d By deadline date/time.
7576 c By creation time, which is assumed to be the first inactive time stamp
7577 at the beginning of a line.
7578 p By priority according to the cookie.
7579 r By the value of a property.
7581 Capital letters will reverse the sort order.
7583 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7584 called with point at the beginning of the record. It must return either
7585 a string or a number that should serve as the sorting key for that record.
7587 Comparing entries ignores case by default. However, with an optional argument
7588 WITH-CASE, the sorting considers case as well."
7589 (interactive "P")
7590 (let ((case-func (if with-case 'identity 'downcase))
7591 start beg end stars re re2
7592 txt what tmp plain-list-p)
7593 ;; Find beginning and end of region to sort
7594 (cond
7595 ((org-region-active-p)
7596 ;; we will sort the region
7597 (setq end (region-end)
7598 what "region")
7599 (goto-char (region-beginning))
7600 (if (not (org-on-heading-p)) (outline-next-heading))
7601 (setq start (point)))
7602 ((org-at-item-p)
7603 ;; we will sort this plain list
7604 (org-beginning-of-item-list) (setq start (point))
7605 (org-end-of-item-list)
7607 (setq end (point))
7608 (goto-char start)
7609 (setq plain-list-p t
7610 what "plain list"))
7611 ((or (org-on-heading-p)
7612 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7613 ;; we will sort the children of the current headline
7614 (org-back-to-heading)
7615 (setq start (point)
7616 end (progn (org-end-of-subtree t t)
7618 (org-back-over-empty-lines)
7619 (point))
7620 what "children")
7621 (goto-char start)
7622 (show-subtree)
7623 (outline-next-heading))
7624 (t
7625 ;; we will sort the top-level entries in this file
7626 (goto-char (point-min))
7627 (or (org-on-heading-p) (outline-next-heading))
7628 (setq start (point))
7629 (goto-char (point-max))
7630 (beginning-of-line 1)
7632 ;; File ends in a non-white line
7633 (end-of-line 1)
7635 (setq end (point-max))
7636 (setq what "top-level")
7637 (goto-char start)
7638 (show-all)))
7640 (setq beg (point))
7641 (if (>= beg end) (error "Nothing to sort"))
7643 (unless plain-list-p
7645 (setq stars (match-string 1)
7646 re (concat "^" (regexp-quote stars) " +")
7647 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7648 txt (buffer-substring beg end))
7650 (if (and (not (equal stars "*")) (string-match re2 txt))
7651 (error "Region to sort contains a level above the first entry")))
7653 (unless sorting-type
7654 (message
7655 (if plain-list-p
7657 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7658 [t]ime [s]cheduled [d]eadline [c]reated
7659 A/N/T/S/D/C/P/O/F means reversed:")
7660 what)
7661 (setq sorting-type (read-char-exclusive))
7663 (and (= (downcase sorting-type) ?f)
7664 (setq getkey-func
7665 (org-icompleting-read "Sort using function: "
7666 obarray 'fboundp t nil nil))
7667 (setq getkey-func (intern getkey-func)))
7669 (and (= (downcase sorting-type) ?r)
7670 (setq property
7671 (org-icompleting-read "Property: "
7672 (mapcar 'list (org-buffer-property-keys t))
7673 nil t))))
7675 (message "Sorting entries...")
7677 (save-restriction
7678 (narrow-to-region start end)
7680 (let ((dcst (downcase sorting-type))
7681 (case-fold-search nil)
7682 (now (current-time)))
7683 (sort-subr
7684 (/= dcst sorting-type)
7685 ;; This function moves to the beginning character of the "record" to
7686 ;; be sorted.
7687 (if plain-list-p
7688 (lambda nil
7689 (if (org-at-item-p) t (goto-char (point-max))))
7690 (lambda nil
7691 (if (re-search-forward re nil t)
7692 (goto-char (match-beginning 0))
7693 (goto-char (point-max)))))
7694 ;; This function moves to the last character of the "record" being
7695 ;; sorted.
7696 (if plain-list-p
7697 'org-end-of-item
7698 (lambda nil
7699 (save-match-data
7700 (condition-case nil
7701 (outline-forward-same-level 1)
7702 (error
7703 (goto-char (point-max)))))))
7705 ;; This function returns the value that gets sorted against.
7706 (if plain-list-p
7707 (lambda nil
7709 (cond
7710 ((= dcst ?n)
7711 (string-to-number (buffer-substring (match-end 0)
7712 (point-at-eol))))
7713 ((= dcst ?a)
7714 (buffer-substring (match-end 0) (point-at-eol)))
7715 ((= dcst ?t)
7716 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
7717 (re-search-forward org-ts-regexp-both
7718 (point-at-eol) t))
7719 (org-time-string-to-seconds (match-string 0))
7720 (org-float-time now)))
7721 ((= dcst ?f)
7722 (if getkey-func
7723 (progn
7724 (setq tmp (funcall getkey-func))
7725 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7726 tmp)
7727 (error "Invalid key function `%s'" getkey-func)))
7728 (t (error "Invalid sorting type `%c'" sorting-type)))))
7729 (lambda nil
7730 (cond
7731 ((= dcst ?n)
7732 (if (looking-at org-complex-heading-regexp)
7733 (string-to-number (match-string 4))
7734 nil))
7735 ((= dcst ?a)
7736 (if (looking-at org-complex-heading-regexp)
7737 (funcall case-func (match-string 4))
7738 nil))
7739 ((= dcst ?t)
7740 (let ((end (save-excursion (outline-next-heading) (point))))
7741 (if (or (re-search-forward org-ts-regexp end t)
7742 (re-search-forward org-ts-regexp-both end t))
7743 (org-time-string-to-seconds (match-string 0))
7744 (org-float-time now))))
7745 ((= dcst ?c)
7746 (let ((end (save-excursion (outline-next-heading) (point))))
7747 (if (re-search-forward
7749 end t)
7750 (org-time-string-to-seconds (match-string 0))
7751 (org-float-time now))))
7752 ((= dcst ?s)
7753 (let ((end (save-excursion (outline-next-heading) (point))))
7754 (if (re-search-forward org-scheduled-time-regexp end t)
7755 (org-time-string-to-seconds (match-string 1))
7756 (org-float-time now))))
7757 ((= dcst ?d)
7758 (let ((end (save-excursion (outline-next-heading) (point))))
7759 (if (re-search-forward org-deadline-time-regexp end t)
7760 (org-time-string-to-seconds (match-string 1))
7761 (org-float-time now))))
7762 ((= dcst ?p)
7763 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7764 (string-to-char (match-string 2))
7765 org-default-priority))
7766 ((= dcst ?r)
7767 (or (org-entry-get nil property) ""))
7768 ((= dcst ?o)
7769 (if (looking-at org-complex-heading-regexp)
7770 (- 9999 (length (member (match-string 2)
7771 org-todo-keywords-1)))))
7772 ((= dcst ?f)
7773 (if getkey-func
7774 (progn
7775 (setq tmp (funcall getkey-func))
7776 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7777 tmp)
7778 (error "Invalid key function `%s'" getkey-func)))
7779 (t (error "Invalid sorting type `%c'" sorting-type)))))
7780 nil
7781 (cond
7782 ((= dcst ?a) 'string<)
7783 ((= dcst ?f) compare-func)
7784 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7785 (t nil)))))
7786 (run-hooks 'org-after-sorting-entries-or-items-hook)
7787 (message "Sorting entries...done")))
7789 (defun org-do-sort (table what &optional with-case sorting-type)
7790 "Sort TABLE of WHAT according to SORTING-TYPE.
7791 The user will be prompted for the SORTING-TYPE if the call to this
7792 function does not specify it. WHAT is only for the prompt, to indicate
7793 what is being sorted. The sorting key will be extracted from
7794 the car of the elements of the table.
7795 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7796 (unless sorting-type
7797 (message
7799 what)
7800 (setq sorting-type (read-char-exclusive)))
7801 (let ((dcst (downcase sorting-type))
7802 extractfun comparefun)
7803 ;; Define the appropriate functions
7804 (cond
7805 ((= dcst ?n)
7806 (setq extractfun 'string-to-number
7807 comparefun (if (= dcst sorting-type) '< '>)))
7808 ((= dcst ?a)
7809 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7810 (lambda(x) (downcase (org-sort-remove-invisible x))))
7811 comparefun (if (= dcst sorting-type)
7812 'string<
7813 (lambda (a b) (and (not (string< a b))
7814 (not (string= a b)))))))
7815 ((= dcst ?t)
7816 (setq extractfun
7817 (lambda (x)
7818 (if (or (string-match org-ts-regexp x)
7819 (string-match org-ts-regexp-both x))
7820 (org-float-time
7821 (org-time-string-to-time (match-string 0 x)))
7822 0))
7823 comparefun (if (= dcst sorting-type) '< '>)))
7826 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7827 table)
7828 (lambda (a b) (funcall comparefun (car a) (car b))))))
7831 ;;; The orgstruct minor mode
7833 ;; Define a minor mode which can be used in other modes in order to
7834 ;; integrate the org-mode structure editing commands.
7836 ;; This is really a hack, because the org-mode structure commands use
7837 ;; keys which normally belong to the major mode. Here is how it
7838 ;; works: The minor mode defines all the keys necessary to operate the
7839 ;; structure commands, but wraps the commands into a function which
7840 ;; tests if the cursor is currently at a headline or a plain list
7841 ;; item. If that is the case, the structure command is used,
7842 ;; temporarily setting many Org-mode variables like regular
7843 ;; expressions for filling etc. However, when any of those keys is
7844 ;; used at a different location, function uses `key-binding' to look
7845 ;; up if the key has an associated command in another currently active
7846 ;; keymap (minor modes, major mode, global), and executes that
7847 ;; command. There might be problems if any of the keys is otherwise
7848 ;; used as a prefix key.
7850 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7851 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7852 ;; addresses this by checking explicitly for both bindings.
7854 (defvar orgstruct-mode-map (make-sparse-keymap)
7857 (defvar org-local-vars nil
7860 ;;;###autoload
7861 (define-minor-mode orgstruct-mode
7863 This mode is for using Org-mode structure commands in other
7864 modes. The following keys behave as if Org-mode were active, if
7866 defined by Org-mode).
7868 M-up Move entry/item up
7869 M-down Move entry/item down
7870 M-left Promote
7871 M-right Demote
7872 M-S-up Move entry/item up
7873 M-S-down Move entry/item down
7874 M-S-left Promote subtree
7875 M-S-right Demote subtree
7876 M-q Fill paragraph and items like in Org-mode
7877 C-c ^ Sort entries
7878 C-c - Cycle list bullet
7879 TAB Cycle item visibility
7880 M-RET Insert new heading/item
7881 S-M-RET Insert new TODO heading / Checkbox item
7884 (org-load-modules-maybe)
7885 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7887 ;;;###autoload
7888 (defun turn-on-orgstruct ()
7890 (orgstruct-mode 1))
7892 (defun orgstruct++-mode (&optional arg)
7894 In addition to setting orgstruct-mode, this also exports all indentation
7895 and autofilling variables from org-mode into the buffer. It will also
7896 recognize item context in multiline items.
7898 indentation/paragraph settings. This can only be done by refreshing the
7901 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7902 (if (< arg 1)
7903 (orgstruct-mode -1)
7904 (orgstruct-mode 1)
7905 (let (var val)
7906 (mapc
7907 (lambda (x)
7908 (when (string-match
7910 (symbol-name (car x)))
7911 (setq var (car x) val (nth 1 x))
7912 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7913 org-local-vars)
7914 (org-set-local 'orgstruct-is-++ t))))
7916 (defvar orgstruct-is-++ nil
7918 (make-variable-buffer-local 'orgstruct-is-++)
7920 ;;;###autoload
7921 (defun turn-on-orgstruct++ ()
7923 (orgstruct++-mode 1))
7925 (defun orgstruct-error ()
7927 (interactive)
7930 (defun orgstruct-setup ()
7932 (let ((nfunc 0)
7933 (bindings
7934 (list
7935 '([(meta up)] org-metaup)
7936 '([(meta down)] org-metadown)
7937 '([(meta left)] org-metaleft)
7938 '([(meta right)] org-metaright)
7939 '([(meta shift up)] org-shiftmetaup)
7940 '([(meta shift down)] org-shiftmetadown)
7941 '([(meta shift left)] org-shiftmetaleft)
7942 '([(meta shift right)] org-shiftmetaright)
7943 '([?\e (up)] org-metaup)
7944 '([?\e (down)] org-metadown)
7945 '([?\e (left)] org-metaleft)
7946 '([?\e (right)] org-metaright)
7947 '([?\e (shift up)] org-shiftmetaup)
7948 '([?\e (shift down)] org-shiftmetadown)
7949 '([?\e (shift left)] org-shiftmetaleft)
7950 '([?\e (shift right)] org-shiftmetaright)
7951 '([(shift up)] org-shiftup)
7952 '([(shift down)] org-shiftdown)
7953 '([(shift left)] org-shiftleft)
7954 '([(shift right)] org-shiftright)
7959 elt key fun cmd)
7960 (while (setq elt (pop bindings))
7961 (setq nfunc (1+ nfunc))
7962 (setq key (org-key (car elt))
7963 fun (nth 1 elt)
7964 cmd (orgstruct-make-binding fun nfunc key))
7965 (org-defkey orgstruct-mode-map key cmd))
7967 ;; Special treatment needed for TAB and RET
7968 (org-defkey orgstruct-mode-map [(tab)]
7974 (orgstruct-make-binding 'org-insert-heading 105
7976 (org-defkey orgstruct-mode-map [(meta return)]
7977 (orgstruct-make-binding 'org-insert-heading 106
7980 (org-defkey orgstruct-mode-map [(shift meta return)]
7981 (orgstruct-make-binding 'org-insert-todo-heading 107
7985 (orgstruct-make-binding 'org-insert-heading 108
7987 (org-defkey orgstruct-mode-map [?\e (return)]
7988 (orgstruct-make-binding 'org-insert-heading 109
7990 (org-defkey orgstruct-mode-map [?\e (shift return)]
7991 (orgstruct-make-binding 'org-insert-todo-heading 110
7994 (unless org-local-vars
7995 (setq org-local-vars (org-get-local-variables)))
7997 t))
7999 (defun orgstruct-make-binding (fun n &rest keys)
8000 "Create a function for binding in the structure minor mode.
8001 FUN is the command to call inside a table. N is used to create a unique
8002 command name. KEYS are keys that should be checked in for a command
8003 to execute outside of tables."
8004 (eval
8005 (list 'defun
8007 '(arg)
8013 (list 'if
8014 `(org-context-p 'headline 'item
8015 (and orgstruct-is-++
8016 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8017 'item-body))
8018 (list 'org-run-like-in-org-mode (list 'quote fun))
8019 (list 'let '(orgstruct-mode)
8020 (list 'call-interactively
8021 (append '(or)
8022 (mapcar (lambda (k)
8023 (list 'key-binding k))
8024 keys)
8025 '('orgstruct-error))))))))
8027 (defun org-context-p (&rest contexts)
8028 "Check if local context is any of CONTEXTS.
8030 (let ((pos (point)))
8031 (goto-char (point-at-bol))
8032 (prog1 (or (and (memq 'table contexts)
8034 (and (memq 'headline contexts)
8036 (looking-at outline-regexp))
8037 (and (memq 'item contexts)
8039 (and (memq 'item-body contexts)
8040 (org-in-item-p)))
8041 (goto-char pos))))
8043 (defun org-get-local-variables ()
8045 (let (varlist)
8047 (erase-buffer)
8048 (org-mode)
8049 (setq varlist (buffer-local-variables)))
8051 (delq nil
8052 (mapcar
8053 (lambda (x)
8054 (setq x
8055 (if (symbolp x)
8056 (list x)
8057 (list (car x) (list 'quote (cdr x)))))
8058 (if (string-match
8059 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8060 (symbol-name (car x)))
8061 x nil))
8062 varlist))))
8064 ;;;###autoload
8065 (defun org-run-like-in-org-mode (cmd)
8067 This will temporarily bind local variables that are typically bound in
8068 Org-mode to the values they have in Org-mode, and then interactively
8069 call CMD."
8070 (org-load-modules-maybe)
8071 (unless org-local-vars
8072 (setq org-local-vars (org-get-local-variables)))
8073 (eval (list 'let org-local-vars
8074 (list 'call-interactively (list 'quote cmd)))))
8076 ;;;; Archiving
8078 (defun org-get-category (&optional pos)
8080 (get-text-property (or pos (point)) 'org-category))
8082 (defun org-refresh-category-properties ()
8084 (let ((def-cat (cond
8085 ((null org-category)
8086 (if buffer-file-name
8087 (file-name-sans-extension
8088 (file-name-nondirectory buffer-file-name))
8090 ((symbolp org-category) (symbol-name org-category))
8091 (t org-category)))
8092 beg end cat pos optionp)
8093 (org-unmodified
8094 (save-excursion
8095 (save-restriction
8096 (widen)
8097 (goto-char (point-min))
8098 (put-text-property (point) (point-max) 'org-category def-cat)
8099 (while (re-search-forward
8101 (setq pos (match-end 0)
8102 optionp (equal (char-after (match-beginning 0)) ?#)
8103 cat (org-trim (match-string 2)))
8104 (if optionp
8105 (setq beg (point-at-bol) end (point-max))
8106 (org-back-to-heading t)
8107 (setq beg (point) end (org-end-of-subtree t t)))
8108 (put-text-property beg end 'org-category cat)
8109 (goto-char pos)))))))
8112 ;;;; Link Stuff
8114 ;;; Link abbreviations
8116 (defun org-link-expand-abbrev (link)
8119 (let* ((key (match-string 1 link))
8120 (as (or (assoc key org-link-abbrev-alist-local)
8121 (assoc key org-link-abbrev-alist)))
8122 (tag (and (match-end 2) (match-string 3 link)))
8123 rpl)
8124 (if (not as)
8125 link
8126 (setq rpl (cdr as))
8127 (cond
8128 ((symbolp rpl) (funcall rpl tag))
8132 (t (concat rpl tag)))))
8133 link))
8135 ;;; Storing and inserting links
8137 (defvar org-insert-link-history nil
8140 (defvar org-stored-links nil
8143 (defvar org-store-link-plist nil
8146 (defvar org-link-protocols nil
8149 (defvar org-store-link-functions nil
8150 "List of functions that are called to create and store a link.
8151 Each function will be called in turn until one returns a non-nil
8152 value. Each function should check if it is responsible for creating
8154 If not, it must exit and return nil.
8155 If yes, it should return a non-nil value after a calling
8157 Special properties are:
8161 This is obligatory as well.
8162 :description Optional default description for the second pair
8163 of brackets in an Org-mode link. The user can still change
8164 this when inserting this link into an Org-mode buffer.
8166 In addition to these, any additional properties can be specified
8167 and then used in remember templates.")
8169 (defun org-add-link-type (type &optional follow export)
8173 FOLLOW and EXPORT are two functions.
8175 FOLLOW should take the link path as the single argument and do whatever
8176 is necessary to follow the link, for example find a file or display
8177 a mail message.
8179 EXPORT should format the link path for export to one of the export formats.
8180 It should be a function accepting three arguments:
8186 The function may use the FORMAT information to return different values
8187 depending on the format. The return value will be put literally into
8188 the exported file.
8189 Org-mode has a built-in default for exporting links. If you are happy with
8190 this default, there is no need to define an export function for the link
8192 (add-to-list 'org-link-types type t)
8193 (org-make-link-regexps)
8194 (if (assoc type org-link-protocols)
8195 (setcdr (assoc type org-link-protocols) (list follow export))
8196 (push (list type follow export) org-link-protocols)))
8198 (defvar org-agenda-buffer-name)
8200 ;;;###autoload
8201 (defun org-store-link (arg)
8210 (org-load-modules-maybe)
8211 (setq org-store-link-plist nil) ; reset
8212 (let ((outline-regexp (org-get-limited-outline-regexp))
8213 link cpltxt desc description search txt custom-id)
8214 (cond
8216 ((run-hook-with-args-until-success 'org-store-link-functions)
8217 (setq link (plist-get org-store-link-plist :link)
8218 desc (or (plist-get org-store-link-plist :description) link)))
8221 (let (label gc)
8222 (while (or (not label)
8223 (save-excursion
8224 (save-restriction
8225 (widen)
8226 (goto-char (point-min))
8227 (re-search-forward
8228 (regexp-quote (format org-coderef-label-format label))
8229 nil t))))
8232 (end-of-line 1)
8233 (setq link (format org-coderef-label-format label))
8234 (setq gc (- 79 (length link)))
8236 (insert link)
8239 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8240 ;; We are in the agenda, link to referenced location
8241 (let ((m (or (get-text-property (point) 'org-hd-marker)
8242 (get-text-property (point) 'org-marker))))
8243 (when m
8244 (org-with-point-at m
8245 (if (interactive-p)
8246 (call-interactively 'org-store-link)
8247 (org-store-link nil))))))
8249 ((eq major-mode 'calendar-mode)
8250 (let ((cd (calendar-cursor-to-date)))
8251 (setq link
8252 (format-time-string
8253 (car org-time-stamp-formats)
8254 (apply 'encode-time
8255 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8256 nil nil nil))))
8259 ((eq major-mode 'w3-mode)
8260 (setq cpltxt (if (and (buffer-name)
8262 (buffer-name)
8263 (url-view-url t))
8264 link (org-make-link (url-view-url t)))
8267 ((eq major-mode 'w3m-mode)
8268 (setq cpltxt (or w3m-current-title w3m-current-url)
8269 link (org-make-link w3m-current-url))
8272 ((setq search (run-hook-with-args-until-success
8273 'org-create-file-search-functions))
8276 (setq cpltxt (or description link)))
8278 ((eq major-mode 'image-mode)
8280 (abbreviate-file-name buffer-file-name))
8281 link (org-make-link cpltxt))
8284 ((eq major-mode 'dired-mode)
8285 ;; link to the file in the current line
8286 (let ((file (dired-get-filename nil t)))
8287 (setq file (if file
8288 (abbreviate-file-name
8289 (expand-file-name (dired-get-filename nil t)))
8290 ;; otherwise, no file so use current directory.
8291 default-directory))
8293 link (org-make-link cpltxt))))
8295 ((and buffer-file-name (org-mode-p))
8297 (cond
8299 (setq cpltxt
8301 (abbreviate-file-name buffer-file-name)
8303 link (org-make-link cpltxt)))
8304 ((and (featurep 'org-id)
8305 (or (eq org-link-to-org-use-id t)
8306 (and (eq org-link-to-org-use-id 'create-if-interactive)
8307 (interactive-p))
8308 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8309 (interactive-p)
8310 (not custom-id))
8311 (and org-link-to-org-use-id
8312 (condition-case nil
8314 (error nil)))))
8315 ;; We can make a link using the ID.
8316 (setq link (condition-case nil
8317 (prog1 (org-id-store-link)
8318 (setq desc (plist-get org-store-link-plist
8319 :description)))
8320 (error
8321 ;; probably before first headline, link to file only
8323 (abbreviate-file-name buffer-file-name))))))
8324 (t
8325 ;; Just link to current headline
8327 (abbreviate-file-name buffer-file-name)))
8328 ;; Add a context search string
8329 (when (org-xor org-context-in-file-links arg)
8330 (setq txt (cond
8331 ((org-on-heading-p) nil)
8332 ((org-region-active-p)
8333 (buffer-substring (region-beginning) (region-end)))
8334 (t nil)))
8336 (setq cpltxt
8338 (condition-case nil
8339 (org-make-org-heading-search-string txt)
8341 desc (or (nth 4 (ignore-errors
8344 (setq cpltxt (substring cpltxt 0 -2)))
8345 (setq link (org-make-link cpltxt)))))
8347 ((buffer-file-name (buffer-base-buffer))
8348 ;; Just link to this file here.
8350 (abbreviate-file-name
8351 (buffer-file-name (buffer-base-buffer)))))
8352 ;; Add a context string
8353 (when (org-xor org-context-in-file-links arg)
8354 (setq txt (if (org-region-active-p)
8355 (buffer-substring (region-beginning) (region-end))
8356 (buffer-substring (point-at-bol) (point-at-eol))))
8357 ;; Only use search option if there is some text.
8359 (setq cpltxt
8362 (setq link (org-make-link cpltxt)))
8364 ((interactive-p)
8367 (t (setq link nil)))
8369 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8370 (setq link (or link cpltxt)
8371 desc (or desc cpltxt))
8374 (if (and (or (interactive-p) executing-kbd-macro) link)
8375 (progn
8376 (setq org-stored-links
8377 (cons (list link desc) org-stored-links))
8379 (when custom-id
8382 (setq org-stored-links
8383 (cons (list link desc) org-stored-links))))
8384 (and link (org-make-link-string link desc)))))
8386 (defun org-store-link-props (&rest plist)
8388 (let (x adr)
8389 (when (setq x (plist-get plist :from))
8390 (setq adr (mail-extract-address-components x))
8391 (setq plist (plist-put plist :fromname (car adr)))
8392 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8393 (when (setq x (plist-get plist :to))
8394 (setq adr (mail-extract-address-components x))
8395 (setq plist (plist-put plist :toname (car adr)))
8396 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8397 (let ((from (plist-get plist :from))
8398 (to (plist-get plist :to)))
8399 (when (and from to org-from-is-user-regexp)
8400 (setq plist
8401 (plist-put plist :fromto
8402 (if (string-match org-from-is-user-regexp from)
8405 (setq org-store-link-plist plist))
8407 (defun org-add-link-props (&rest plist)
8409 (let (key value)
8410 (while plist
8411 (setq key (pop plist) value (pop plist))
8412 (setq org-store-link-plist
8413 (plist-put org-store-link-plist key value)))))
8415 (defun org-email-link-description (&optional fmt)
8416 "Return the description part of an email link.
8419 (setq fmt (or fmt org-email-link-description-format))
8420 (let* ((p org-store-link-plist)
8421 (to (plist-get p :toaddress))
8422 (from (plist-get p :fromaddress))
8423 (table
8424 (list
8433 ;; Check if the user wrote this message
8434 (if (and org-from-is-user-regexp from to
8435 (save-match-data (string-match org-from-is-user-regexp from)))
8438 (org-replace-escapes fmt table)))
8440 (defun org-make-org-heading-search-string (&optional string heading)
8442 (interactive)
8443 (let ((s (or string (org-get-heading))))
8444 (unless (and string (not heading))
8445 ;; We are using a headline, clean up garbage in there.
8446 (if (string-match org-todo-regexp s)
8450 (setq s (org-trim s))
8454 (while (string-match org-ts-regexp s)
8461 (defun org-make-link (&rest strings)
8463 (apply 'concat strings))
8465 (defun org-make-link-string (link &optional description)
8469 (when (and description
8470 (stringp description)
8472 (setq description nil))
8473 (when (stringp description)
8474 ;; Remove brackets from the description, they are fatal.
8479 (when (equal (org-link-escape link) description)
8480 ;; No description needed, it is identical
8481 (setq description nil))
8482 (when (and (not description)
8483 (not (equal link (org-link-escape link))))
8484 (setq description (org-extract-attributes link)))
8489 (defconst org-link-escape-chars
8507 )
8508 "Association list of escapes for some characters problematic in links.
8509 This is the list that is used for internal purposes.")
8511 (defvar org-url-encoding-use-url-hexify nil)
8513 (defconst org-link-escape-chars-browser
8515 "Association list of escapes for some characters problematic in links.
8516 This is the list that is used before handing over to the browser.")
8518 (defun org-link-escape (text &optional table)
8520 (if (and org-url-encoding-use-url-hexify (not table))
8521 (url-hexify-string text)
8522 (setq table (or table org-link-escape-chars))
8523 (when text
8524 (let ((re (mapconcat (lambda (x) (regexp-quote
8525 (char-to-string (car x))))
8527 (while (string-match re text)
8528 (setq text
8529 (replace-match
8530 (cdr (assoc (string-to-char (match-string 0 text))
8531 table))
8532 t t text)))
8533 text))))
8535 (defun org-link-unescape (text &optional table)
8537 (if (and org-url-encoding-use-url-hexify (not table))
8538 (url-unhex-string text)
8539 (setq table (or table org-link-escape-chars))
8540 (when text
8541 (let ((case-fold-search t)
8542 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8544 (while (string-match re text)
8545 (setq text
8546 (replace-match
8547 (char-to-string (car (rassoc (upcase (match-string 0 text))
8548 table)))
8549 t t text)))
8550 text))))
8552 (defun org-xor (a b)
8554 (if a (not b) b))
8556 (defun org-fixup-message-id-for-http (s)
8559 (setq s (mapconcat (lambda (c)
8560 (if (eq c ?%)
8562 (char-to-string c)))
8570 s)
8572 ;;;###autoload
8573 (defun org-insert-link-global ()
8574 "Insert a link like Org-mode does.
8575 This command can be called in any mode to insert a link in Org-mode syntax."
8576 (interactive)
8577 (org-load-modules-maybe)
8578 (org-run-like-in-org-mode 'org-insert-link))
8580 (defun org-insert-link (&optional complete-file link-location)
8583 Completion can be used to insert any of the link protocol prefixes like
8584 http or ftp in use.
8586 The history can be used to select a link previously stored with
8588 press RET at the prompt), the link defaults to the most recently
8589 stored link. As SPC triggers completion in the minibuffer, you need to
8590 use M-SPC or C-q SPC to force the insertion of a space character.
8593 be displayed in the buffer instead of the link.
8595 If there is already a link at point, this command will allow you to edit link
8596 and description parts.
8599 be selected using completion. The path to the file will be relative to the
8600 current directory if the file is in the current directory or a subdirectory.
8601 Otherwise, the link will be the absolute path as completed in the minibuffer
8606 the current directory or below.
8612 called with the link target, and the result will be the default
8613 link description.
8615 If the LINK-LOCATION parameter is non-nil, this value will be
8616 used as the link location instead of reading one interactively."
8618 (let* ((wcf (current-window-configuration))
8619 (region (if (org-region-active-p)
8620 (buffer-substring (region-beginning) (region-end))))
8621 (remove (and region (list (region-beginning) (region-end))))
8622 (desc region)
8623 tmphist ; byte-compile incorrectly complains about this
8624 (link link-location)
8625 entry file all-prefixes)
8626 (cond
8627 (link-location) ; specified by arg, just use it.
8628 ((org-in-regexp org-bracket-link-regexp 1)
8629 ;; We do have a link at point, and we are going to edit it.
8630 (setq remove (list (match-beginning 0) (match-end 0)))
8631 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8633 (org-link-unescape
8634 (org-match-string-no-properties 1)))))
8635 ((or (org-in-regexp org-angle-link-re)
8636 (org-in-regexp org-plain-link-re))
8637 ;; Convert to bracket link
8638 (setq remove (list (match-beginning 0) (match-end 0))
8640 (org-remove-angle-brackets (match-string 0)))))
8641 ((member complete-file '((4) (16)))
8642 ;; Completing read for file names.
8643 (setq link (org-file-complete-link complete-file)))
8644 (t
8645 ;; Read link, with completion for stored links.
8647 (princ "Insert a link.
8649 (when org-stored-links
8651 (princ (mapconcat
8652 (lambda (x)
8655 (let ((cw (selected-window)))
8657 (setq truncate-lines t)
8658 (unless (pos-visible-in-window-p (point-max))
8659 (org-fit-window-to-buffer))
8660 (and (window-live-p cw) (select-window cw)))
8661 ;; Fake a link history, containing the stored links.
8662 (setq tmphist (append (mapcar 'car org-stored-links)
8663 org-insert-link-history))
8664 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8665 (mapcar 'car org-link-abbrev-alist)
8666 org-link-types))
8667 (unwind-protect
8668 (progn
8669 (setq link
8670 (let ((org-completion-use-ido nil)
8671 (org-completion-use-iswitchb nil))
8672 (org-completing-read
8674 (append
8676 all-prefixes)
8677 (mapcar 'car org-stored-links))
8678 nil nil nil
8679 'tmphist
8680 (car (car org-stored-links)))))
8683 (if (or (member link all-prefixes)
8685 (member (substring link 0 -1) all-prefixes)
8686 (setq link (substring link 0 -1))))
8687 (setq link (org-link-try-special-completion link))))
8688 (set-window-configuration wcf)
8690 (setq entry (assoc link org-stored-links))
8691 (or entry (push link org-insert-link-history))
8692 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8693 (not org-keep-stored-link-after-insertion))
8694 (setq org-stored-links (delq (assoc link org-stored-links)
8695 org-stored-links)))
8696 (setq desc (or desc (nth 1 entry)))))
8698 (if (string-match org-plain-link-re link)
8699 ;; URL-like link, normalize the use of angular brackets.
8700 (setq link (org-make-link (org-remove-angle-brackets link))))
8702 ;; Check if we are linking to the current file with a search option
8703 ;; If yes, simplify the link by using only the search option.
8704 (when (and buffer-file-name
8706 (let* ((path (match-string 1 link))
8707 (case-fold-search nil)
8708 (search (match-string 2 link)))
8709 (save-match-data
8710 (if (equal (file-truename buffer-file-name) (file-truename path))
8711 ;; We are linking to this same file, with a search option
8712 (setq link search)))))
8714 ;; Check if we can/should use a relative path. If yes, simplify the link
8716 (let* ((type (match-string 1 link))
8717 (path (match-string 2 link))
8718 (origpath path)
8719 (case-fold-search nil))
8720 (cond
8721 ((or (eq org-link-file-path-type 'absolute)
8722 (equal complete-file '(16)))
8723 (setq path (abbreviate-file-name (expand-file-name path))))
8724 ((eq org-link-file-path-type 'noabbrev)
8725 (setq path (expand-file-name path)))
8726 ((eq org-link-file-path-type 'relative)
8727 (setq path (file-relative-name path)))
8728 (t
8729 (save-match-data
8731 (expand-file-name
8732 (file-name-as-directory
8733 default-directory))))
8734 (expand-file-name path))
8735 ;; We are linking a file with relative path name.
8736 (setq path (substring (expand-file-name path)
8737 (match-end 0)))
8738 (setq path (abbreviate-file-name (expand-file-name path)))))))
8739 (setq link (concat type path))
8740 (if (equal desc origpath)
8741 (setq desc path))))
8743 (if org-make-link-description-function
8744 (setq desc (funcall org-make-link-description-function link desc)))
8748 (if remove (apply 'delete-region remove))
8749 (insert (org-make-link-string link desc))))
8751 (defun org-link-try-special-completion (type)
8754 (if (functionp fun)
8755 (funcall fun)
8758 (defun org-file-complete-link (&optional arg)
8760 (let (file link)
8763 (pwd1 (file-name-as-directory (abbreviate-file-name
8765 (cond
8766 ((equal arg '(16))
8767 (setq link (org-make-link
8769 (abbreviate-file-name (expand-file-name file)))))
8773 (expand-file-name file))
8774 (setq link (org-make-link
8777 link))
8779 (defun org-completing-read (&rest args)
8781 (let ((minibuffer-local-completion-map
8782 (copy-keymap minibuffer-local-completion-map)))
8785 (apply 'org-icompleting-read args)))
8787 (defun org-completing-read-no-i (&rest args)
8788 (let (org-completion-use-ido org-completion-use-iswitchb)
8789 (apply 'org-completing-read args)))
8791 (defun org-iswitchb-completing-read (prompt choices &rest args)
8792 "Use iswitch as a completing-read replacement to choose from choices.
8793 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8794 from."
8795 (let* ((iswitchb-use-virtual-buffers nil)
8796 (iswitchb-make-buflist-hook
8797 (lambda ()
8798 (setq iswitchb-temp-buflist choices))))
8799 (iswitchb-read-buffer prompt)))
8801 (defun org-icompleting-read (&rest args)
8803 (org-without-partial-completion
8804 (if (and org-completion-use-ido
8805 (fboundp 'ido-completing-read)
8806 (boundp 'ido-mode) ido-mode
8807 (listp (second args)))
8808 (let ((ido-enter-matching-directory nil))
8809 (apply 'ido-completing-read (concat (car args))
8810 (if (consp (car (nth 1 args)))
8811 (mapcar (lambda (x) (car x)) (nth 1 args))
8812 (nth 1 args))
8813 (cddr args)))
8814 (if (and org-completion-use-iswitchb
8815 (boundp 'iswitchb-mode) iswitchb-mode
8816 (listp (second args)))
8817 (apply 'org-iswitchb-completing-read (concat (car args))
8818 (if (consp (car (nth 1 args)))
8819 (mapcar (lambda (x) (car x)) (nth 1 args))
8820 (nth 1 args))
8821 (cddr args))
8822 (apply 'completing-read args)))))
8824 (defun org-extract-attributes (s)
8826 (let (a attr (start 0) key value)
8827 (save-match-data
8829 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8831 (setq key (match-string 1 a) value (match-string 2 a)
8832 start (match-end 0)
8833 attr (plist-put attr (intern key) value))))
8834 (org-add-props s nil 'org-attr attr))
8835 s))
8837 (defun org-extract-attributes-from-string (tag)
8838 (let (key value attr)
8840 (setq key (match-string 1 tag) value (match-string 2 tag)
8842 attr (plist-put attr (intern key) value)))
8843 (cons tag attr)))
8845 (defun org-attributes-to-string (plist)
8848 (while plist
8849 (setq key (pop plist) value (pop plist))
8850 (and value
8852 s))
8854 ;;; Opening/following a link
8856 (defvar org-link-search-failed nil)
8858 (defvar org-open-link-functions nil
8859 "Hook for functions finding a plain text link.
8860 These functions must take a single argument, the link content.
8865 These functions will be called *before* Org attempts to resolve the
8866 link by doing text searches in the current buffer - so if you want a
8868 handle this as a special case.
8870 When the function does handle the link, it must return a non-nil value.
8871 If it decides that it is not responsible for this link, it must return
8872 nil to indicate that that Org-mode can continue with other options
8873 like exact and fuzzy text search.")
8875 (defun org-next-link ()
8876 "Move forward to the next link.
8877 If the link is in hidden text, expose it."
8878 (interactive)
8879 (when (and org-link-search-failed (eq this-command last-command))
8880 (goto-char (point-min))
8881 (message "Link search wrapped back to beginning of buffer"))
8882 (setq org-link-search-failed nil)
8883 (let* ((pos (point))
8884 (ct (org-context))
8885 (a (assoc :link ct)))
8886 (if a (goto-char (nth 2 a)))
8887 (if (re-search-forward org-any-link-re nil t)
8888 (progn
8889 (goto-char (match-beginning 0))
8890 (if (org-invisible-p) (org-show-context)))
8891 (goto-char pos)
8892 (setq org-link-search-failed t)
8893 (error "No further link found"))))
8895 (defun org-previous-link ()
8896 "Move backward to the previous link.
8897 If the link is in hidden text, expose it."
8898 (interactive)
8899 (when (and org-link-search-failed (eq this-command last-command))
8900 (goto-char (point-max))
8901 (message "Link search wrapped back to end of buffer"))
8902 (setq org-link-search-failed nil)
8903 (let* ((pos (point))
8904 (ct (org-context))
8905 (a (assoc :link ct)))
8906 (if a (goto-char (nth 1 a)))
8907 (if (re-search-backward org-any-link-re nil t)
8908 (progn
8909 (goto-char (match-beginning 0))
8910 (if (org-invisible-p) (org-show-context)))
8911 (goto-char pos)
8912 (setq org-link-search-failed t)
8913 (error "No further link found"))))
8915 (defun org-translate-link (s)
8916 "Translate a link string if a translation function has been defined."
8917 (if (and org-link-translation-function
8918 (fboundp org-link-translation-function)
8920 (progn
8921 (setq s (funcall org-link-translation-function
8922 (match-string 1) (match-string 2)))
8923 (concat (car s) ":" (cdr s)))
8924 s))
8926 (defun org-translate-link-from-planner (type path)
8927 "Translate a link from Emacs Planner syntax so that Org can follow it.
8928 This is still an experimental function, your mileage may vary."
8929 (cond
8930 ((member type '("http" "https" "news" "ftp"))
8931 ;; standard Internet links are the same.
8932 nil)
8933 ((and (equal type "irc") (string-match "^//" path))
8934 ;; Planner has two / at the beginning of an irc link, we have 1.
8935 ;; We should have zero, actually....
8936 (setq path (substring path 1)))
8937 ((and (equal type "lisp") (string-match "^/" path))
8938 ;; Planner has a slash, we do not.
8939 (setq type "elisp" path (substring path 1)))
8941 ;; A typical message link. Planner has the id after the final slash,
8942 ;; we separate it with a hash mark
8943 (setq path (concat (match-string 1 path) "#"
8944 (org-remove-angle-brackets (match-string 2 path)))))
8945 )
8946 (cons type path))
8948 (defun org-find-file-at-mouse (ev)
8949 "Open file link or URL at mouse."
8950 (interactive "e")
8951 (mouse-set-point ev)
8952 (org-open-at-point 'in-emacs))
8954 (defun org-open-at-mouse (ev)
8955 "Open file link or URL at mouse."
8956 (interactive "e")
8957 (mouse-set-point ev)
8958 (if (eq major-mode 'org-agenda-mode)
8959 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8960 (org-open-at-point))
8962 (defvar org-window-config-before-follow-link nil
8963 "The window configuration before following a link.
8964 This is saved in case the need arises to restore it.")
8966 (defvar org-open-link-marker (make-marker)
8967 "Marker pointing to the location where `org-open-at-point; was called.")
8969 ;;;###autoload
8970 (defun org-open-at-point-global ()
8971 "Follow a link like Org-mode does.
8972 This command can be called in any mode to follow a link that has
8973 Org-mode syntax."
8974 (interactive)
8975 (org-run-like-in-org-mode 'org-open-at-point))
8977 ;;;###autoload
8978 (defun org-open-link-from-string (s &optional arg reference-buffer)
8979 "Open a link in the string S, as if it was in Org-mode."
8981 (let ((reference-buffer (or reference-buffer (current-buffer))))
8982 (with-temp-buffer
8983 (let ((org-inhibit-startup t))
8984 (org-mode)
8985 (insert s)
8986 (goto-char (point-min))
8987 (when reference-buffer
8988 (setq org-link-abbrev-alist-local
8989 (with-current-buffer reference-buffer
8990 org-link-abbrev-alist-local)))
8991 (org-open-at-point arg reference-buffer)))))
8993 (defvar org-open-at-point-functions nil
8994 "Hook that is run when following a link at point.
8996 Functions in this hook must return t if they identify and follow
8997 a link at point. If they don't find anything interesting at point,
8998 they must return nil.")
9000 (defun org-open-at-point (&optional in-emacs reference-buffer)
9001 "Open link at or after point.
9002 If there is no link at point, this function will search forward up to
9003 the end of the current line.
9004 Normally, files will be opened by an appropriate application. If the
9005 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9006 With a double prefix argument, try to open outside of Emacs, in the
9007 application the system uses for this file type."
9008 (interactive "P")
9009 ;; if in a code block, then open the block's results
9010 (unless (call-interactively #'org-babel-open-src-block-result)
9011 (org-load-modules-maybe)
9012 (move-marker org-open-link-marker (point))
9013 (setq org-window-config-before-follow-link (current-window-configuration))
9014 (org-remove-occur-highlights nil nil t)
9015 (cond
9016 ((and (org-on-heading-p)
9017 (not (org-in-regexp
9022 (not (get-text-property (point) 'org-linked-text)))
9023 (or (org-offer-links-in-entry in-emacs)
9024 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9025 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9026 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9027 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9028 (org-footnote-action))
9029 (t
9030 (let (type path link line search (pos (point)))
9031 (catch 'match
9032 (save-excursion
9034 (when (org-in-regexp org-bracket-link-regexp 1)
9035 (setq link (org-extract-attributes
9036 (org-link-unescape (org-match-string-no-properties 1))))
9038 (setq link (replace-match " " t t link)))
9039 (setq link (org-link-expand-abbrev link))
9040 (cond
9041 ((or (file-name-absolute-p link)
9043 (setq type "file" path link))
9044 ((string-match org-link-re-with-space3 link)
9045 (setq type (match-string 1 link) path (match-string 2 link)))
9046 (t (setq type "thisfile" path link)))
9047 (throw 'match t)))
9049 (when (get-text-property (point) 'org-linked-text)
9050 (setq type "thisfile"
9051 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9052 (1+ (point)) (point))
9053 path (buffer-substring
9054 (previous-single-property-change pos 'org-linked-text)
9055 (next-single-property-change pos 'org-linked-text)))
9056 (throw 'match t))
9058 (save-excursion
9059 (when (or (org-in-regexp org-angle-link-re)
9060 (org-in-regexp org-plain-link-re))
9061 (setq type (match-string 1) path (match-string 2))
9062 (throw 'match t)))
9063 (save-excursion
9065 (setq type "tags"
9066 path (match-string 1))
9067 (while (string-match ":" path)
9068 (setq path (replace-match "+" t t path)))
9069 (throw 'match t)))
9071 (setq type "tree-match"
9072 path (match-string 1))
9073 (throw 'match t)))
9074 (unless path
9075 (error "No link found"))
9077 ;; switch back to reference buffer
9078 ;; needed when if called in a temporary buffer through
9079 ;; org-open-link-from-string
9080 (with-current-buffer (or reference-buffer (current-buffer))
9082 ;; Remove any trailing spaces in path
9084 (setq path (replace-match "" t t path)))
9085 (if (and org-link-translation-function
9086 (fboundp org-link-translation-function))
9087 ;; Check if we need to translate the link
9088 (let ((tmp (funcall org-link-translation-function type path)))
9089 (setq type (car tmp) path (cdr tmp))))
9091 (cond
9093 ((assoc type org-link-protocols)
9094 (funcall (nth 1 (assoc type org-link-protocols)) path))
9096 ((equal type "mailto")
9097 (let ((cmd (car org-link-mailto-program))
9098 (args (cdr org-link-mailto-program)) args1
9099 (address path) (subject "") a)
9101 (setq address (match-string 1 path)
9102 subject (org-link-escape (match-string 2 path))))
9103 (while args
9104 (cond
9105 ((not (stringp (car args))) (push (pop args) args1))
9106 (t (setq a (pop args))
9107 (if (string-match "%a" a)
9108 (setq a (replace-match address t t a)))
9109 (if (string-match "%s" a)
9110 (setq a (replace-match subject t t a)))
9111 (push a args1))))
9112 (apply cmd (nreverse args1))))
9114 ((member type '("http" "https" "ftp" "news"))
9115 (browse-url (concat type ":" (org-link-escape
9116 path org-link-escape-chars-browser))))
9118 ((string= type "doi")
9119 (browse-url (concat "http://dx.doi.org/"
9120 (org-link-escape
9121 path org-link-escape-chars-browser))))
9123 ((member type '("message"))
9124 (browse-url (concat type ":" path)))
9126 ((string= type "tags")
9127 (org-tags-view in-emacs path))
9129 ((string= type "tree-match")
9132 ((string= type "file")
9134 (setq line (string-to-number (match-string 1 path))
9135 path (substring path 0 (match-beginning 0)))
9137 (setq search (match-string 1 path)
9138 path (substring path 0 (match-beginning 0)))))
9139 (if (string-match "[*?{]" (file-name-nondirectory path))
9140 (dired path)
9141 (org-open-file path in-emacs line search)))
9143 ((string= type "news")
9144 (require 'org-gnus)
9145 (org-gnus-follow-link path))
9147 ((string= type "shell")
9148 (let ((cmd path))
9149 (if (or (not org-confirm-shell-link-function)
9150 (funcall org-confirm-shell-link-function
9152 (org-add-props cmd nil
9153 'face 'org-warning))))
9154 (progn
9155 (message "Executing %s" cmd)
9156 (shell-command cmd))
9157 (error "Abort"))))
9159 ((string= type "elisp")
9160 (let ((cmd path))
9161 (if (or (not org-confirm-elisp-link-function)
9162 (funcall org-confirm-elisp-link-function
9164 (org-add-props cmd nil
9165 'face 'org-warning))))
9166 (message "%s => %s" cmd
9167 (if (equal (string-to-char cmd) ?\()
9168 (eval (read cmd))
9169 (call-interactively (read cmd))))
9170 (error "Abort"))))
9172 ((and (string= type "thisfile")
9173 (run-hook-with-args-until-success
9174 'org-open-link-functions path)))
9176 ((string= type "thisfile")
9177 (if in-emacs
9178 (switch-to-buffer-other-window
9179 (org-get-buffer-for-internal-link (current-buffer)))
9180 (org-mark-ring-push))
9181 (let ((cmd `(org-link-search
9182 ,path
9183 ,(cond ((equal in-emacs '(4)) 'occur)
9184 ((equal in-emacs '(16)) 'org-occur)
9185 (t nil))
9186 ,pos)))
9187 (condition-case nil (eval cmd)
9188 (error (progn (widen) (eval cmd))))))
9190 (t
9191 (browse-url-at-point)))))))
9192 (move-marker org-open-link-marker nil)
9193 (run-hook-with-args 'org-follow-link-hook)))
9195 (defun org-offer-links-in-entry (&optional nth zero)
9196 "Offer links in the current entry and follow the selected link.
9197 If there is only one link, follow it immediately as well.
9198 If NTH is an integer, immediately pick the NTH link found.
9199 If ZERO is a string, check also this string for a link, and if
9200 there is one, offer it as link number zero."
9204 (cnt ?0)
9205 (in-emacs (if (integerp nth) nil nth))
9206 have-zero end links link c)
9207 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9208 (push (match-string 0 zero) links)
9209 (setq cnt (1- cnt) have-zero t))
9210 (save-excursion
9211 (org-back-to-heading t)
9212 (setq end (save-excursion (outline-next-heading) (point)))
9213 (while (re-search-forward re end t)
9214 (push (match-string 0) links))
9215 (setq links (org-uniquify (reverse links))))
9217 (cond
9218 ((null links)
9219 (message "No links"))
9220 ((equal (length links) 1)
9221 (setq link (list (car links))))
9222 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9223 (setq link (nth (if have-zero nth (1- nth)) links)))
9224 (t ; we have to select a link
9225 (save-excursion
9226 (save-window-excursion
9227 (delete-other-windows)
9228 (with-output-to-temp-buffer "*Select Link*"
9229 (mapc (lambda (l)
9230 (if (not (string-match org-bracket-link-regexp l))
9232 (org-remove-angle-brackets l)))
9233 (if (match-end 3)
9235 (match-string 3 l) (match-string 1 l)))
9237 (match-string 1 l))))))
9238 links))
9239 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9240 (message "Select link to open, RET to open all:")
9241 (setq c (read-char-exclusive))
9242 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9243 (when (equal c ?q) (error "Abort"))
9244 (if (equal c ?\C-m)
9245 (setq link links)
9246 (setq nth (- c ?0))
9247 (if have-zero (setq nth (1+ nth)))
9248 (unless (and (integerp nth) (>= (length links) nth))
9249 (error "Invalid link selection"))
9250 (setq link (list (nth (1- nth) links))))))
9251 (if link
9252 (let ((buf (current-buffer)))
9253 (dolist (l link)
9254 (org-open-link-from-string l in-emacs buf))
9255 t)
9256 nil)))
9258 ;; Add special file links that specify the way of opening
9260 (org-add-link-type "file+sys" 'org-open-file-with-system)
9261 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9262 (defun org-open-file-with-system (path)
9263 "Open file at PATH using the system way of opening it."
9264 (org-open-file path 'system))
9265 (defun org-open-file-with-emacs (path)
9266 "Open file at PATH in Emacs."
9267 (org-open-file path 'emacs))
9268 (defun org-remove-file-link-modifiers ()
9269 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9270 (goto-char (point-min))
9272 (org-if-unprotected
9273 (replace-match "file:" t t))))
9274 (eval-after-load "org-exp"
9275 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9276 'org-remove-file-link-modifiers))
9278 ;;;; Time estimates
9280 (defun org-get-effort (&optional pom)
9281 "Get the effort estimate for the current entry."
9282 (org-entry-get pom org-effort-property))
9284 ;;; File search
9286 (defvar org-create-file-search-functions nil
9287 "List of functions to construct the right search string for a file link.
9288 These functions are called in turn with point at the location to
9289 which the link should point.
9291 A function in the hook should first test if it would like to
9292 handle this file type, for example by checking the `major-mode'
9293 or the file extension. If it decides not to handle this file, it
9294 should just return nil to give other functions a chance. If it
9295 does handle the file, it must return the search string to be used
9296 when following the link. The search string will be part of the
9297 file link, given after a double colon, and `org-open-at-point'
9298 will automatically search for it. If special measures must be
9299 taken to make the search successful, another function should be
9300 added to the companion hook `org-execute-file-search-functions',
9301 which see.
9303 A function in this hook may also use `setq' to set the variable
9304 `description' to provide a suggestion for the descriptive text to
9305 be used for this link when it gets inserted into an Org-mode
9308 (defvar org-execute-file-search-functions nil
9309 "List of functions to execute a file search triggered by a link.
9311 Functions added to this hook must accept a single argument, the
9312 search string that was part of the file link, the part after the
9313 double colon. The function must first check if it would like to
9314 handle this search, for example by checking the `major-mode' or
9315 the file extension. If it decides not to handle this search, it
9316 should just return nil to give other functions a chance. If it
9317 does handle the search, it must return a non-nil value to keep
9318 other functions from trying.
9320 Each function can access the current prefix argument through the
9321 variable `current-prefix-argument'. Note that a single prefix is
9322 used to force opening a link in Emacs, so it may be good to only
9323 use a numeric or double prefix to guide the search function.
9325 In case this is needed, a function in this hook can also restore
9326 the window configuration before `org-open-at-point' was called using:
9328 (set-window-configuration org-window-config-before-follow-link)")
9330 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9331 (defun org-link-search (s &optional type avoid-pos)
9332 "Search for a link search option.
9333 If S is surrounded by forward slashes, it is interpreted as a
9334 regular expression. In org-mode files, this will create an `org-occur'
9335 sparse tree. In ordinary files, `occur' will be used to list matches.
9336 If the current buffer is in `dired-mode', grep will be used to search
9337 in all files. If AVOID-POS is given, ignore matches near that position."
9338 (let ((case-fold-search t)
9342 org-emphasis-alist)
9344 (pos (point))
9345 (pre nil) (post nil)
9346 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9347 (cond
9348 ;; First check if there are any special search functions
9349 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9350 ;; Now try the builtin stuff
9351 ((and (equal (string-to-char s0) ?#)
9352 (> (length s0) 1)
9353 (save-excursion
9354 (goto-char (point-min))
9355 (and
9356 (re-search-forward
9358 (setq type 'dedicated
9359 pos (match-beginning 0))))
9360 ;; There is an exact target for this
9361 (goto-char pos)
9362 (org-back-to-heading t)))
9363 ((save-excursion
9364 (goto-char (point-min))
9365 (and
9366 (re-search-forward
9367 (concat "<<" (regexp-quote s0) ">>") nil t)
9368 (setq type 'dedicated
9369 pos (match-beginning 0))))
9370 ;; There is an exact target for this
9371 (goto-char pos))
9373 (save-excursion
9374 (goto-char (point-min))
9375 (and
9376 (re-search-forward
9377 (concat "[^[]" (regexp-quote
9378 (format org-coderef-label-format
9379 (match-string 1 s0))))
9380 nil t)
9381 (setq type 'dedicated
9382 pos (1+ (match-beginning 0))))))
9383 ;; There is a coderef target for this
9384 (goto-char pos))
9386 ;; A regular expression
9387 (cond
9388 ((org-mode-p)
9389 (org-occur (match-string 1 s)))
9390 ;;((eq major-mode 'dired-mode)
9391 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9392 (t (org-do-occur (match-string 1 s)))))
9393 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9394 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9395 (goto-char (point-min))
9396 (cond
9397 ((let (case-fold-search)
9398 (re-search-forward (format org-complex-heading-regexp-format
9399 (regexp-quote s))
9400 nil t))
9401 ;; OK, found a match
9402 (goto-char (match-beginning 0)))
9403 ((and (not org-link-search-inhibit-query)
9404 (eq org-link-search-must-match-exact-headline 'query-to-create)
9405 (y-or-n-p "No match - create this as a new heading? "))
9406 (goto-char (point-max))
9407 (or (bolp) (newline))
9409 (beginning-of-line 0))
9410 (t
9411 (goto-char pos)
9412 (error "No match"))))
9413 (t
9414 ;; A normal search string
9415 (when (equal (string-to-char s) ?*)
9416 ;; Anchor on headlines, post may include tags.
9419 s (substring s 1)))
9420 (remove-text-properties
9421 0 (length s)
9422 '(face nil mouse-face nil keymap nil fontified nil) s)
9423 ;; Make a series of regular expressions to find a match
9432 re4 (concat "[^a-zA-Z_]" re4_)
9434 re1 (concat pre re2 post)
9435 re3 (concat pre (if pre re4_ re4) post)
9436 re5 (concat pre ".*" re4)
9437 re2 (concat pre re2)
9438 re2a (concat pre (if pre re2a_ re2a))
9439 re4 (concat pre (if pre re4_ re4))
9443 ))
9444 (cond
9445 ((eq type 'org-occur) (org-occur reall))
9446 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9447 (t (goto-char (point-min))
9448 (setq type 'fuzzy)
9449 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9450 (org-search-not-self 1 re1 nil t)
9451 (org-search-not-self 1 re2 nil t)
9452 (org-search-not-self 1 re2a nil t)
9453 (org-search-not-self 1 re3 nil t)
9454 (org-search-not-self 1 re4 nil t)
9455 (org-search-not-self 1 re5 nil t)
9456 )
9457 (goto-char (match-beginning 1))
9458 (goto-char pos)
9459 (error "No match"))))))
9460 (and (org-mode-p) (org-show-context 'link-search))
9461 type))
9463 (defun org-search-not-self (group &rest args)
9464 "Execute `re-search-forward', but only accept matches that do not
9465 enclose the position of `org-open-link-marker'."
9466 (let ((m org-open-link-marker))
9467 (catch 'exit
9468 (while (apply 're-search-forward args)
9469 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9470 (goto-char (match-end group))
9471 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9472 (> (match-beginning 0) (marker-position m))
9473 (< (match-end 0) (marker-position m)))
9474 (save-match-data
9475 (or (not (org-in-regexp
9476 org-bracket-link-analytic-regexp 1))
9477 (not (match-end 4)) ; no description
9478 (and (<= (match-beginning 4) (point))
9479 (>= (match-end 4) (point))))))
9480 (throw 'exit (point))))))))
9482 (defun org-get-buffer-for-internal-link (buffer)
9483 "Return a buffer to be used for displaying the link target of internal links."
9484 (cond
9485 ((not org-display-internal-link-with-indirect-buffer)
9486 buffer)
9487 ((string-match "(Clone)$" (buffer-name buffer))
9488 (message "Buffer is already a clone, not making another one")
9489 ;; we also do not modify visibility in this case
9490 buffer)
9491 (t ; make a new indirect buffer for displaying the link
9492 (let* ((bn (buffer-name buffer))
9493 (ibn (concat bn "(Clone)"))
9494 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9495 (with-current-buffer ib (org-overview))
9496 ib))))
9498 (defun org-do-occur (regexp &optional cleanup)
9499 "Call the Emacs command `occur'.
9500 If CLEANUP is non-nil, remove the printout of the regular expression
9501 in the *Occur* buffer. This is useful if the regex is long and not useful
9502 to read."
9503 (occur regexp)
9504 (when cleanup
9505 (let ((cwin (selected-window)) win beg end)
9506 (when (setq win (get-buffer-window "*Occur*"))
9507 (select-window win))
9508 (goto-char (point-min))
9509 (when (re-search-forward "match[a-z]+" nil t)
9510 (setq beg (match-end 0))
9512 (setq end (1- (match-beginning 0)))))
9513 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9514 (goto-char (point-min))
9515 (select-window cwin))))
9517 ;;; The mark ring for links jumps
9519 (defvar org-mark-ring nil
9520 "Mark ring for positions before jumps in Org-mode.")
9521 (defvar org-mark-ring-last-goto nil
9522 "Last position in the mark ring used to go back.")
9523 ;; Fill and close the ring
9524 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9525 (loop for i from 1 to org-mark-ring-length do
9526 (push (make-marker) org-mark-ring))
9527 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9528 org-mark-ring)
9530 (defun org-mark-ring-push (&optional pos buffer)
9531 "Put the current position or POS into the mark ring and rotate it."
9532 (interactive)
9533 (setq pos (or pos (point)))
9534 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9535 (move-marker (car org-mark-ring)
9536 (or pos (point))
9537 (or buffer (current-buffer)))
9538 (message "%s"
9539 (substitute-command-keys
9542 (defun org-mark-ring-goto (&optional n)
9543 "Jump to the previous position in the mark ring.
9544 With prefix arg N, jump back that many stored positions. When
9545 called several times in succession, walk through the entire ring.
9546 Org-mode commands jumping to a different position in the current file,
9547 or to another Org-mode file, automatically push the old position
9548 onto the ring."
9549 (interactive "p")
9550 (let (p m)
9551 (if (eq last-command this-command)
9552 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9553 (setq p org-mark-ring))
9554 (setq org-mark-ring-last-goto p)
9555 (setq m (car p))
9556 (switch-to-buffer (marker-buffer m))
9557 (goto-char m)
9558 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9560 (defun org-remove-angle-brackets (s)
9561 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9562 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9563 s)
9564 (defun org-add-angle-brackets (s)
9565 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9566 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9567 s)
9568 (defun org-remove-double-quotes (s)
9571 s)
9573 ;;; Following specific links
9575 (defun org-follow-timestamp-link ()
9576 (cond
9577 ((org-at-date-range-p t)
9578 (let ((org-agenda-start-on-weekday)
9579 (t1 (match-string 1))
9580 (t2 (match-string 2)))
9581 (setq t1 (time-to-days (org-time-string-to-time t1))
9582 t2 (time-to-days (org-time-string-to-time t2)))
9583 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9584 ((org-at-timestamp-p t)
9585 (org-agenda-list nil (time-to-days (org-time-string-to-time
9586 (substring (match-string 1) 0 10)))
9587 1))
9588 (t (error "This should not happen"))))
9591 ;;; Following file links
9592 (defvar org-wait nil)
9593 (defun org-open-file (path &optional in-emacs line search)
9594 "Open the file at PATH.
9595 First, this expands any special file name abbreviations. Then the
9596 configuration variable `org-file-apps' is checked if it contains an
9597 entry for this file type, and if yes, the corresponding command is launched.
9599 If no application is found, Emacs simply visits the file.
9601 With optional prefix argument IN-EMACS, Emacs will visit the file.
9603 prefix arg, Org tries to avoid opening in Emacs
9604 and to use an external application to visit the file.
9606 Optional LINE specifies a line to go to, optional SEARCH a string
9607 to search for. If LINE or SEARCH is given, the file will be
9608 opened in Emacs, unless an entry from org-file-apps that makes
9609 use of groups in a regexp matches.
9610 If the file does not exist, an error is thrown."
9611 (let* ((file (if (equal path "")
9612 buffer-file-name
9613 (substitute-in-file-name (expand-file-name path))))
9614 (file-apps (append org-file-apps (org-default-apps)))
9615 (apps (org-remove-if
9616 'org-file-apps-entry-match-against-dlink-p file-apps))
9617 (apps-dlink (org-remove-if-not
9618 'org-file-apps-entry-match-against-dlink-p file-apps))
9619 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9620 (dirp (if remp nil (file-directory-p file)))
9621 (file (if (and dirp org-open-directory-means-index-dot-org)
9622 (concat (file-name-as-directory file) "index.org")
9623 file))
9624 (a-m-a-p (assq 'auto-mode apps))
9625 (dfile (downcase file))
9626 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9627 (link (cond ((and (eq line nil)
9628 (eq search nil))
9629 file)
9630 (line
9631 (concat file "::" (number-to-string line)))
9632 (search
9633 (concat file "::" search))))
9634 (dlink (downcase link))
9635 (old-buffer (current-buffer))
9636 (old-pos (point))
9637 (old-mode major-mode)
9638 ext cmd link-match-data)
9640 (setq ext (match-string 1 dfile))
9642 (setq ext (match-string 1 dfile))))
9643 (cond
9644 ((member in-emacs '((16) system))
9645 (setq cmd (cdr (assoc 'system apps))))
9646 (in-emacs (setq cmd 'emacs))
9647 (t
9648 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9649 (and dirp (cdr (assoc 'directory apps)))
9650 ; first, try matching against apps-dlink
9651 ; if we get a match here, store the match data for later
9652 (let ((match (assoc-default dlink apps-dlink
9653 'string-match)))
9654 (if match
9655 (progn (setq link-match-data (match-data))
9656 match)
9657 (progn (setq in-emacs (or in-emacs line search))
9658 nil))) ; if we have no match in apps-dlink,
9659 ; always open the file in emacs if line or search
9660 ; is given (for backwards compatibility)
9661 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9662 'string-match)
9663 (cdr (assoc ext apps))
9664 (cdr (assoc t apps))))))
9665 (when (eq cmd 'system)
9666 (setq cmd (cdr (assoc 'system apps))))
9667 (when (eq cmd 'default)
9668 (setq cmd (cdr (assoc t apps))))
9669 (when (eq cmd 'mailcap)
9670 (require 'mailcap)
9671 (mailcap-parse-mailcaps)
9672 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9673 (command (mailcap-mime-info mime-type)))
9674 (if (stringp command)
9675 (setq cmd command)
9676 (setq cmd 'emacs))))
9677 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9678 (not (file-exists-p file))
9679 (not org-open-non-existing-files))
9680 (error "No such file: %s" file))
9681 (cond
9683 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9685 (setq cmd (replace-match "%s" t t cmd)))
9686 (while (string-match "%s" cmd)
9687 (setq cmd (replace-match
9688 (save-match-data
9689 (shell-quote-argument
9690 (convert-standard-filename file)))
9691 t t cmd)))
9693 ;; Replace "%1", "%2" etc. in command with group matches from regex
9694 (save-match-data
9695 (let ((match-index 1)
9696 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9697 (set-match-data link-match-data)
9698 (while (<= match-index number-of-groups)
9699 (let ((regex (concat "%" (number-to-string match-index)))
9700 (replace-with (match-string match-index dlink)))
9701 (while (string-match regex cmd)
9702 (setq cmd (replace-match replace-with t t cmd))))
9703 (setq match-index (+ match-index 1)))))
9705 (save-window-excursion
9706 (start-process-shell-command cmd nil cmd)
9707 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9708 ))
9709 ((or (stringp cmd)
9710 (eq cmd 'emacs))
9711 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9712 (widen)
9713 (if line (org-goto-line line)
9714 (if search (org-link-search search))))
9715 ((consp cmd)
9716 (let ((file (convert-standard-filename file)))
9717 (save-match-data
9718 (set-match-data link-match-data)
9719 (eval cmd))))
9720 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9721 (and (org-mode-p) (eq old-mode 'org-mode)
9722 (or (not (equal old-buffer (current-buffer)))
9723 (not (equal old-pos (point))))
9724 (org-mark-ring-push old-pos old-buffer))))
9726 (defun org-file-apps-entry-match-against-dlink-p (entry)
9727 "This function returns non-nil if `entry' uses a regular
9728 expression which should be matched against the whole link by
9729 org-open-file.
9731 It assumes that is the case when the entry uses a regular
9732 expression which has at least one grouping construct and the
9733 action is either a lisp form or a command string containing
9734 '%1', i.e. using at least one subexpression match as a
9735 parameter."
9736 (let ((selector (car entry))
9737 (action (cdr entry)))
9738 (if (stringp selector)
9739 (and (> (regexp-opt-depth selector) 0)
9740 (or (and (stringp action)
9741 (string-match "%[0-9]" action))
9742 (consp action)))
9743 nil)))
9745 (defun org-default-apps ()
9746 "Return the default applications for this operating system."
9747 (cond
9748 ((eq system-type 'darwin)
9749 org-file-apps-defaults-macosx)
9750 ((eq system-type 'windows-nt)
9751 org-file-apps-defaults-windowsnt)
9752 (t org-file-apps-defaults-gnu)))
9754 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9755 "Convert extensions to regular expressions in the cars of LIST.
9756 Also, weed out any non-string entries, because the return value is used
9757 only for regexp matching.
9758 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9759 point to the symbol `emacs', indicating that the file should
9760 be opened in Emacs."
9761 (append
9762 (delq nil
9763 (mapcar (lambda (x)
9764 (if (not (stringp (car x)))
9765 nil
9767 x
9769 list))
9770 (if add-auto-mode
9771 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9773 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9774 (defun org-file-remote-p (file)
9775 "Test whether FILE specifies a location on a remote system.
9776 Return non-nil if the location is indeed remote.
9780 (cond ((fboundp 'file-remote-p)
9781 (file-remote-p file))
9782 ((fboundp 'tramp-handle-file-remote-p)
9783 (tramp-handle-file-remote-p file))
9784 ((and (boundp 'ange-ftp-name-format)
9785 (string-match (car ange-ftp-name-format) file))
9786 t)
9787 (t nil)))
9790 ;;;; Refiling
9792 (defun org-get-org-file ()
9793 "Read a filename, with default directory `org-directory'."
9794 (let ((default (or org-default-notes-file remember-data-file)))
9795 (read-file-name (format "File name [%s]: " default)
9796 (file-name-as-directory org-directory)
9797 default)))
9799 (defun org-notes-order-reversed-p ()
9800 "Check if the current file should receive notes in reversed order."
9801 (cond
9802 ((not org-reverse-note-order) nil)
9803 ((eq t org-reverse-note-order) t)
9804 ((not (listp org-reverse-note-order)) nil)
9805 (t (catch 'exit
9806 (let ((all org-reverse-note-order)
9807 entry)
9808 (while (setq entry (pop all))
9809 (if (string-match (car entry) buffer-file-name)
9810 (throw 'exit (cdr entry))))
9811 nil)))))
9813 (defvar org-refile-target-table nil
9814 "The list of refile targets, created by `org-refile'.")
9816 (defvar org-agenda-new-buffers nil
9817 "Buffers created to visit agenda files.")
9819 (defvar org-refile-cache nil
9820 "Cache for refile targets.")
9823 (defvar org-refile-markers nil
9824 "All the markers used for caching refile locations.")
9826 (defun org-refile-marker (pos)
9827 "Get a new refile marker, but only if caching is in use."
9828 (if (not org-refile-use-cache)
9829 pos
9830 (let ((m (make-marker)))
9831 (move-marker m pos)
9832 (push m org-refile-markers)
9833 m)))
9835 (defun org-refile-cache-clear ()
9836 "Clear the refile cache and disable all the markers."
9837 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9838 (setq org-refile-markers nil)
9839 (setq org-refile-cache nil)
9840 (message "Refile cache has been cleared"))
9842 (defun org-refile-cache-check-set (set)
9843 "Check if all the markers in the cache still have live buffers."
9844 (let (marker)
9845 (catch 'exit
9846 (while (and set (setq marker (nth 3 (pop set))))
9847 ;; if org-refile-use-outline-path is 'file, marker may be nil
9848 (when (and marker (null (marker-buffer marker)))
9849 (message "not found") (sit-for 3)
9850 (throw 'exit nil)))
9851 t)))
9853 (defun org-refile-cache-put (set &rest identifiers)
9854 "Push the refile targets SET into the cache, under IDENTIFIERS."
9855 (let* ((key (sha1 (prin1-to-string identifiers)))
9856 (entry (assoc key org-refile-cache)))
9857 (if entry
9858 (setcdr entry set)
9859 (push (cons key set) org-refile-cache))))
9861 (defun org-refile-cache-get (&rest identifiers)
9862 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9863 (cond
9864 ((not org-refile-cache) nil)
9865 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9866 (t
9867 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9868 org-refile-cache))))
9869 (and set (org-refile-cache-check-set set) set)))))
9871 (defun org-get-refile-targets (&optional default-buffer)
9872 "Produce a table with refile targets."
9873 (let ((case-fold-search nil)
9874 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9875 (entries (or org-refile-targets '((nil . (:level . 1)))))
9876 targets tgs txt re files f desc descre fast-path-p level pos0)
9877 (message "Getting targets...")
9878 (with-current-buffer (or default-buffer (current-buffer))
9879 (while (setq entry (pop entries))
9880 (setq files (car entry) desc (cdr entry))
9881 (setq fast-path-p nil)
9882 (cond
9883 ((null files) (setq files (list (current-buffer))))
9884 ((eq files 'org-agenda-files)
9885 (setq files (org-agenda-files 'unrestricted)))
9886 ((and (symbolp files) (fboundp files))
9887 (setq files (funcall files)))
9888 ((and (symbolp files) (boundp files))
9889 (setq files (symbol-value files))))
9890 (if (stringp files) (setq files (list files)))
9891 (cond
9892 ((eq (car desc) :tag)
9894 ((eq (car desc) :todo)
9896 ((eq (car desc) :regexp)
9897 (setq descre (cdr desc)))
9898 ((eq (car desc) :level)
9900 (if org-odd-levels-only
9901 (1- (* 2 (cdr desc)))
9902 (cdr desc)))
9904 ((eq (car desc) :maxlevel)
9905 (setq fast-path-p t)
9907 (if org-odd-levels-only
9908 (1- (* 2 (cdr desc)))
9909 (cdr desc)))
9911 (t (error "Bad refiling target description %s" desc)))
9912 (while (setq f (pop files))
9913 (with-current-buffer
9914 (if (bufferp f) f (org-get-agenda-file-buffer f))
9915 (or
9916 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9917 (progn
9918 (if (bufferp f) (setq f (buffer-file-name
9919 (buffer-base-buffer f))))
9920 (setq f (and f (expand-file-name f)))
9921 (if (eq org-refile-use-outline-path 'file)
9922 (push (list (file-name-nondirectory f) f nil nil) tgs))
9923 (save-excursion
9924 (save-restriction
9925 (widen)
9926 (goto-char (point-min))
9927 (while (re-search-forward descre nil t)
9928 (goto-char (setq pos0 (point-at-bol)))
9929 (catch 'next
9930 (when org-refile-target-verify-function
9931 (save-match-data
9932 (or (funcall org-refile-target-verify-function)
9933 (throw 'next t))))
9934 (when (looking-at org-complex-heading-regexp)
9935 (setq level (org-reduced-level
9936 (- (match-end 1) (match-beginning 1)))
9937 txt (org-link-display-format (match-string 4))
9938 re (concat "^" (regexp-quote
9939 (buffer-substring
9940 (match-beginning 1)
9941 (match-end 4)))))
9942 (if (match-end 5) (setq re (concat
9944 (regexp-quote
9945 (match-string 5)))))
9947 (when org-refile-use-outline-path
9948 (setq txt (mapconcat
9949 'org-protect-slash
9950 (append
9951 (if (eq org-refile-use-outline-path
9952 'file)
9953 (list (file-name-nondirectory
9954 (buffer-file-name
9955 (buffer-base-buffer))))
9956 (if (eq org-refile-use-outline-path
9957 'full-file-path)
9958 (list (buffer-file-name
9959 (buffer-base-buffer)))))
9960 (org-get-outline-path fast-path-p
9961 level txt)
9962 (list txt))
9963 "/")))
9964 (push (list txt f re (org-refile-marker (point)))
9965 tgs)))
9966 (when (= (point) pos0)
9967 ;; verification function has not moved point
9968 (goto-char (point-at-eol))))))))
9969 (when org-refile-use-cache
9970 (org-refile-cache-put tgs (buffer-file-name) descre))
9971 (setq targets (append tgs targets))
9972 ))))
9973 (message "Getting targets...done")
9974 (nreverse targets)))
9976 (defun org-protect-slash (s)
9977 (while (string-match "/" s)
9979 s)
9981 (defvar org-olpa (make-vector 20 nil))
9983 (defun org-get-outline-path (&optional fastp level heading)
9984 "Return the outline path to the current entry, as a list.
9986 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
9987 routine which makes outline path derivations for an entire file,
9988 avoiding backtracing. Refile target collection makes use of that."
9989 (if fastp
9990 (progn
9991 (if (> level 19)
9992 (error "Outline path failure, more than 19 levels"))
9993 (loop for i from level upto 19 do
9994 (aset org-olpa i nil))
9995 (prog1
9996 (delq nil (append org-olpa nil))
9997 (aset org-olpa level heading)))
9998 (let (rtn case-fold-search)
9999 (save-excursion
10000 (save-restriction
10001 (widen)
10002 (while (org-up-heading-safe)
10003 (when (looking-at org-complex-heading-regexp)
10004 (push (org-match-string-no-properties 4) rtn)))
10005 rtn)))))
10007 (defun org-format-outline-path (path &optional width prefix)
10008 "Format the outline path PATH for display.
10009 Width is the maximum number of characters that is available.
10010 Prefix is a prefix to be included in the returned string,
10011 such as the file name."
10012 (setq width (or width 79))
10013 (if prefix (setq width (- width (length prefix))))
10014 (if (not path)
10015 (or prefix "")
10016 (let* ((nsteps (length path))
10017 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10018 (maxwidth (if (<= total-width width)
10019 10000 ;; everything fits
10020 ;; we need to shorten the level headings
10021 (/ (- width nsteps) nsteps)))
10022 (org-odd-levels-only nil)
10023 (n 0)
10024 (total (1+ (length prefix))))
10025 (setq maxwidth (max maxwidth 10))
10026 (concat prefix
10027 (mapconcat
10028 (lambda (h)
10029 (setq n (1+ n))
10030 (if (and (= n nsteps) (< maxwidth 10000))
10031 (setq maxwidth (- total-width total)))
10032 (if (< (length h) maxwidth)
10033 (progn (setq total (+ total (length h) 1)) h)
10034 (setq h (substring h 0 (- maxwidth 2))
10035 total (+ total maxwidth 1))
10037 (setq h (substring h 0 (match-beginning 0))))
10038 (setq h (concat h "..")))
10039 (org-add-props h nil 'face
10040 (nth (% (1- n) org-n-level-faces)
10041 org-level-faces))
10042 h)
10043 path "/")))))
10045 (defun org-display-outline-path (&optional file current)
10046 "Display the current outline path in the echo area."
10047 (interactive "P")
10048 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10049 (case-fold-search nil)
10050 (path (and (org-mode-p) (org-get-outline-path))))
10051 (if current (setq path (append path
10052 (save-excursion
10053 (org-back-to-heading t)
10054 (if (looking-at org-complex-heading-regexp)
10055 (list (match-string 4)))))))
10056 (message "%s"
10057 (org-format-outline-path
10058 path
10059 (1- (frame-width))
10060 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10062 (defvar org-refile-history nil
10063 "History for refiling operations.")
10065 (defvar org-after-refile-insert-hook nil
10066 "Hook run after `org-refile' has inserted its stuff at the new location.
10067 Note that this is still *before* the stuff will be removed from
10068 the *old* location.")
10070 (defvar org-capture-last-stored-marker)
10071 (defun org-refile (&optional goto default-buffer rfloc)
10072 "Move the entry at point to another heading.
10073 The list of target headings is compiled using the information in
10074 `org-refile-targets', which see. This list is created before each use
10075 and will therefore always be up-to-date.
10077 At the target location, the entry is filed as a subitem of the target heading.
10078 Depending on `org-reverse-note-order', the new subitem will either be the
10079 first or the last subitem.
10081 If there is an active region, all entries in that region will be moved.
10082 However, the region must fulfill the requirement that the first heading
10083 is the first one sets the top-level of the moved text - at most siblings
10084 below it are allowed.
10086 With prefix arg GOTO, the command will only visit the target location,
10087 not actually move anything.
10089 go to the location where the last refiling
10090 operation has put the subtree.
10091 With a prefix argument of `2', refile to the running clock.
10093 RFLOC can be a refile location obtained in a different way.
10095 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10097 If you are using target caching (see `org-refile-use-cache'),
10098 You have to clear the target cache in order to find new targets.
10099 This can be done with a 0 prefix: `C-0 C-c C-w'"
10100 (interactive "P")
10101 (if (member goto '(0 (64)))
10102 (org-refile-cache-clear)
10103 (let* ((cbuf (current-buffer))
10104 (regionp (org-region-active-p))
10105 (region-start (and regionp (region-beginning)))
10106 (region-end (and regionp (region-end)))
10107 (region-length (and regionp (- region-end region-start)))
10108 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10109 pos it nbuf file re level reversed)
10110 (setq last-command nil)
10111 (when regionp
10112 (goto-char region-start)
10113 (or (bolp) (goto-char (point-at-bol)))
10114 (setq region-start (point))
10115 (unless (org-kill-is-subtree-p
10116 (buffer-substring region-start region-end))
10117 (error "The region is not a (sequence of) subtree(s)")))
10118 (if (equal goto '(16))
10119 (org-refile-goto-last-stored)
10120 (when (or
10121 (and (equal goto 2)
10122 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10123 (prog1
10124 (setq it (list (or org-clock-heading "running clock")
10125 (buffer-file-name
10126 (marker-buffer org-clock-hd-marker))
10127 ""
10128 (marker-position org-clock-hd-marker)))
10129 (setq goto nil)))
10130 (setq it (or rfloc
10131 (save-excursion
10132 (org-refile-get-location
10133 (if goto "Goto: " "Refile to: ") default-buffer
10134 org-refile-allow-creating-parent-nodes)))))
10135 (setq file (nth 1 it)
10136 re (nth 2 it)
10137 pos (nth 3 it))
10138 (if (and (not goto)
10139 pos
10140 (equal (buffer-file-name) file)
10141 (if regionp
10142 (and (>= pos region-start)
10143 (<= pos region-end))
10144 (and (>= pos (point))
10145 (< pos (save-excursion
10146 (org-end-of-subtree t t))))))
10147 (error "Cannot refile to position inside the tree or region"))
10149 (setq nbuf (or (find-buffer-visiting file)
10150 (find-file-noselect file)))
10151 (if goto
10152 (progn
10153 (switch-to-buffer nbuf)
10154 (goto-char pos)
10155 (org-show-context 'org-goto))
10156 (if regionp
10157 (progn
10158 (org-kill-new (buffer-substring region-start region-end))
10159 (org-save-markers-in-region region-start region-end))
10160 (org-copy-subtree 1 nil t))
10161 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10162 (find-file-noselect file)))
10163 (setq reversed (org-notes-order-reversed-p))
10164 (save-excursion
10165 (save-restriction
10166 (widen)
10167 (if pos
10168 (progn
10169 (goto-char pos)
10170 (looking-at outline-regexp)
10171 (setq level (org-get-valid-level (funcall outline-level) 1))
10172 (goto-char
10173 (if reversed
10174 (or (outline-next-heading) (point-max))
10175 (or (save-excursion (org-get-next-sibling))
10176 (org-end-of-subtree t t)
10177 (point-max)))))
10178 (setq level 1)
10179 (if (not reversed)
10180 (goto-char (point-max))
10181 (goto-char (point-min))
10182 (or (outline-next-heading) (goto-char (point-max)))))
10183 (if (not (bolp)) (newline))
10184 (org-paste-subtree level)
10185 (when org-log-refile
10186 (org-add-log-setup 'refile nil nil 'findpos
10187 org-log-refile)
10188 (unless (eq org-log-refile 'note)
10189 (save-excursion (org-add-log-note))))
10190 (and org-auto-align-tags (org-set-tags nil t))
10191 (bookmark-set "org-refile-last-stored")
10192 ;; If we are refiling for capture, make sure that the
10193 ;; last-capture pointers point here
10194 (when (org-bound-and-true-p org-refile-for-capture)
10195 (bookmark-set "org-capture-last-stored-marker")
10196 (move-marker org-capture-last-stored-marker (point)))
10197 (if (fboundp 'deactivate-mark) (deactivate-mark))
10198 (run-hooks 'org-after-refile-insert-hook))))
10199 (if regionp
10200 (delete-region (point) (+ (point) region-length))
10201 (org-cut-subtree))
10202 (when (featurep 'org-inlinetask)
10203 (org-inlinetask-remove-END-maybe))
10204 (setq org-markers-to-move nil)
10207 (defun org-refile-goto-last-stored ()
10208 "Go to the location where the last refile was stored."
10209 (interactive)
10210 (bookmark-jump "org-refile-last-stored")
10211 (message "This is the location of the last refile"))
10213 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10214 "Prompt the user for a refile location, using PROMPT."
10215 (let ((org-refile-targets org-refile-targets)
10216 (org-refile-use-outline-path org-refile-use-outline-path))
10217 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10218 (unless org-refile-target-table
10219 (error "No refile targets"))
10220 (let* ((cbuf (current-buffer))
10221 (partial-completion-mode nil)
10222 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10223 (cfunc (if (and org-refile-use-outline-path
10224 org-outline-path-complete-in-steps)
10225 'org-olpath-completing-read
10226 'org-icompleting-read))
10227 (extra (if org-refile-use-outline-path "/" ""))
10228 (filename (and cfn (expand-file-name cfn)))
10229 (tbl (mapcar
10230 (lambda (x)
10231 (if (and (not (member org-refile-use-outline-path
10232 '(file full-file-path)))
10233 (not (equal filename (nth 1 x))))
10234 (cons (concat (car x) extra " ("
10235 (file-name-nondirectory (nth 1 x)) ")")
10236 (cdr x))
10237 (cons (concat (car x) extra) (cdr x))))
10238 org-refile-target-table))
10239 (completion-ignore-case t)
10240 pa answ parent-target child parent old-hist)
10241 (setq old-hist org-refile-history)
10242 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10243 nil 'org-refile-history))
10244 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10245 (if pa
10246 (progn
10247 (when (or (not org-refile-history)
10248 (not (eq old-hist org-refile-history))
10249 (not (equal (car pa) (car org-refile-history))))
10250 (setq org-refile-history
10251 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10252 org-refile-history
10253 (cdr org-refile-history))))
10254 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10255 (pop org-refile-history)))
10256 pa)
10258 (progn
10259 (setq parent (match-string 1 answ)
10260 child (match-string 2 answ))
10261 (setq parent-target (or (assoc parent tbl)
10262 (assoc (concat parent "/") tbl)))
10263 (when (and parent-target
10264 (or (eq new-nodes t)
10265 (and (eq new-nodes 'confirm)
10267 child)))))
10268 (org-refile-new-child parent-target child)))
10269 (error "Invalid target location")))))
10271 (defun org-refile-new-child (parent-target child)
10272 "Use refile target PARENT-TARGET to add new CHILD below it."
10273 (unless parent-target
10274 (error "Cannot find parent for new node"))
10275 (let ((file (nth 1 parent-target))
10276 (pos (nth 3 parent-target))
10277 level)
10278 (with-current-buffer (or (find-buffer-visiting file)
10279 (find-file-noselect file))
10280 (save-excursion
10281 (save-restriction
10282 (widen)
10283 (if pos
10284 (goto-char pos)
10285 (goto-char (point-max))
10286 (if (not (bolp)) (newline)))
10287 (when (looking-at outline-regexp)
10288 (setq level (funcall outline-level))
10289 (org-end-of-subtree t t))
10290 (org-back-over-empty-lines)
10292 (if pos (org-get-valid-level level 1) 1) ?*)
10294 (beginning-of-line 0)
10295 (list (concat (car parent-target) "/" child) file "" (point)))))))
10297 (defun org-olpath-completing-read (prompt collection &rest args)
10298 "Read an outline path like a file name."
10299 (let ((thetable collection)
10300 (org-completion-use-ido nil) ; does not work with ido.
10301 (org-completion-use-iswitchb nil)) ; or iswitchb
10302 (apply
10303 'org-icompleting-read prompt
10304 (lambda (string predicate &optional flag)
10305 (let (rtn r f (l (length string)))
10306 (cond
10307 ((eq flag nil)
10308 ;; try completion
10309 (try-completion string thetable))
10310 ((eq flag t)
10311 ;; all-completions
10312 (setq rtn (all-completions string thetable predicate))
10313 (mapcar
10314 (lambda (x)
10315 (setq r (substring x l))
10316 (if (string-match " ([^)]*)$" x)
10317 (setq f (match-string 0 x))
10318 (setq f ""))
10319 (if (string-match "/" r)
10320 (concat string (substring r 0 (match-end 0)) f)
10321 x))
10322 rtn))
10323 ((eq flag 'lambda)
10324 ;; exact match?
10325 (assoc string thetable)))
10326 ))
10327 args)))
10329 ;;;; Dynamic blocks
10331 (defun org-find-dblock (name)
10332 "Find the first dynamic block with name NAME in the buffer.
10333 If not found, stay at current position and return nil."
10334 (let (pos)
10335 (save-excursion
10336 (goto-char (point-min))
10338 nil t)
10339 (match-beginning 0))))
10340 (if pos (goto-char pos))
10341 pos))
10343 (defconst org-dblock-start-re
10345 "Matches the start line of a dynamic block, with parameters.")
10348 "Matches the end of a dynamic block.")
10350 (defun org-create-dblock (plist)
10351 "Create a dynamic block section, with parameters taken from PLIST.
10352 PLIST must contain a :name entry which is used as name of the block."
10354 (end-of-line 1)
10355 (newline))
10356 (let ((col (current-column))
10357 (name (plist-get plist :name)))
10358 (insert "#+BEGIN: " name)
10359 (while plist
10360 (if (eq (car plist) :name)
10361 (setq plist (cddr plist))
10362 (insert " " (prin1-to-string (pop plist)))))
10364 (beginning-of-line -2)))
10366 (defun org-prepare-dblock ()
10367 "Prepare dynamic block for refresh.
10368 This empties the block, puts the cursor at the insert position and returns
10369 the property list including an extra property :name with the block name."
10370 (unless (looking-at org-dblock-start-re)
10371 (error "Not at a dynamic block"))
10372 (let* ((begdel (1+ (match-end 0)))
10373 (name (org-no-properties (match-string 1)))
10374 (params (append (list :name name)
10375 (read (concat "(" (match-string 3) ")")))))
10376 (save-excursion
10377 (beginning-of-line 1)
10379 (setq params (plist-put params :indentation-column (current-column))))
10380 (unless (re-search-forward org-dblock-end-re nil t)
10381 (error "Dynamic block not terminated"))
10382 (setq params
10383 (append params
10384 (list :content (buffer-substring
10385 begdel (match-beginning 0)))))
10386 (delete-region begdel (match-beginning 0))
10387 (goto-char begdel)
10388 (open-line 1)
10389 params))
10391 (defun org-map-dblocks (&optional command)
10392 "Apply COMMAND to all dynamic blocks in the current buffer.
10393 If COMMAND is not given, use `org-update-dblock'."
10394 (let ((cmd (or command 'org-update-dblock)))
10395 (save-excursion
10396 (goto-char (point-min))
10397 (while (re-search-forward org-dblock-start-re nil t)
10398 (goto-char (match-beginning 0))
10399 (save-excursion
10400 (condition-case nil
10401 (funcall cmd)
10402 (error (message "Error during update of dynamic block"))))
10403 (unless (re-search-forward org-dblock-end-re nil t)
10404 (error "Dynamic block not terminated"))))))
10406 (defun org-dblock-update (&optional arg)
10407 "User command for updating dynamic blocks.
10408 Update the dynamic block at point. With prefix ARG, update all dynamic
10409 blocks in the buffer."
10410 (interactive "P")
10411 (if arg
10412 (org-update-all-dblocks)
10413 (or (looking-at org-dblock-start-re)
10414 (org-beginning-of-dblock))
10415 (org-update-dblock)))
10417 (defun org-update-dblock ()
10418 "Update the dynamic block at point.
10419 This means to empty the block, parse for parameters and then call
10420 the correct writing function."
10421 (save-window-excursion
10422 (let* ((pos (point))
10423 (line (org-current-line))
10424 (params (org-prepare-dblock))
10425 (name (plist-get params :name))
10426 (indent (plist-get params :indentation-column))
10427 (cmd (intern (concat "org-dblock-write:" name))))
10428 (message "Updating dynamic block `%s' at line %d..." name line)
10429 (funcall cmd params)
10430 (message "Updating dynamic block `%s' at line %d...done" name line)
10431 (goto-char pos)
10432 (when (and indent (> indent 0))
10433 (setq indent (make-string indent ?\ ))
10434 (save-excursion
10435 (org-beginning-of-dblock)
10436 (forward-line 1)
10437 (while (not (looking-at org-dblock-end-re))
10438 (insert indent)
10439 (beginning-of-line 2))
10440 (when (looking-at org-dblock-end-re)
10442 (replace-match ""))
10443 (insert indent)))))))
10445 (defun org-beginning-of-dblock ()
10446 "Find the beginning of the dynamic block at point.
10447 Error if there is no such block at point."
10448 (let ((pos (point))
10449 beg)
10450 (end-of-line 1)
10451 (if (and (re-search-backward org-dblock-start-re nil t)
10452 (setq beg (match-beginning 0))
10453 (re-search-forward org-dblock-end-re nil t)
10454 (> (match-end 0) pos))
10455 (goto-char beg)
10456 (goto-char pos)
10457 (error "Not in a dynamic block"))))
10459 (defun org-update-all-dblocks ()
10460 "Update all dynamic blocks in the buffer.
10461 This function can be used in a hook."
10462 (when (org-mode-p)
10463 (org-map-dblocks 'org-update-dblock)))
10466 ;;;; Completion
10468 (defconst org-additional-option-like-keywords
10469 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
10470 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
10471 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10472 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
10473 "BEGIN:" "END:"
10474 "ORGTBL" "TBLFM:" "TBLNAME:"
10475 "BEGIN_EXAMPLE" "END_EXAMPLE"
10476 "BEGIN_QUOTE" "END_QUOTE"
10477 "BEGIN_VERSE" "END_VERSE"
10478 "BEGIN_CENTER" "END_CENTER"
10479 "BEGIN_SRC" "END_SRC"
10480 "CATEGORY" "COLUMNS"
10481 "CAPTION" "LABEL"
10482 "SETUPFILE"
10483 "BIND"
10484 "MACRO"))
10486 (defcustom org-structure-template-alist
10487 '(
10500 ("L" "#+latex: "
10504 ("H" "#+html: "
10507 ("A" "#+ascii: ")
10508 ("i" "#+include %file ?"
10510 )
10511 "Structure completion elements.
10512 This is a list of abbreviation keys and values. The value gets inserted
10513 if you type `<' followed by the key and then press the completion key,
10514 usually `M-TAB'. %file will be replaced by a file name after prompting
10515 for the file using completion.
10516 There are two templates for each key, the first uses the original Org syntax,
10517 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10518 the default when the /org-mtags.el/ module has been loaded. See also the
10519 variable `org-mtags-prefer-muse-templates'.
10520 This is an experimental feature, it is undecided if it is going to stay in."
10521 :group 'org-completion
10522 :type '(repeat
10523 (string :tag "Key")
10524 (string :tag "Template")
10525 (string :tag "Muse Template")))
10527 (defun org-try-structure-completion ()
10528 "Try to complete a structure template before point.
10530 expands them."
10531 (let ((l (buffer-substring (point-at-bol) (point)))
10532 a)
10535 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10536 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10537 (match-beginning 1)) a)
10538 t)))
10540 (defun org-complete-expand-structure-template (start cell)
10541 "Expand a structure template."
10542 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10543 (rpl (nth (if musep 2 1) cell))
10544 (ind ""))
10545 (delete-region start (point))
10547 (cond
10548 ((bolp))
10550 (setq ind (buffer-substring (point-at-bol) (point))))
10551 (t (newline))))
10552 (setq start (point))
10553 (if (string-match "%file" rpl)
10554 (setq rpl (replace-match
10555 (concat
10557 (save-match-data
10558 (abbreviate-file-name (read-file-name "Include file: ")))
10560 t t rpl)))
10563 (insert rpl)
10567 (defun org-complete (&optional arg)
10568 "Perform completion on word at point.
10569 At the beginning of a headline, this completes TODO keywords as given in
10570 `org-todo-keywords'.
10571 If the current word is preceded by a backslash, completes the TeX symbols
10572 that are supported for HTML support.
10574 setting file options.
10576 At all other locations, this simply calls the value of
10577 `org-completion-fallback-command'."
10578 (interactive "P")
10579 (org-without-partial-completion
10580 (catch 'exit
10581 (let* ((a nil)
10582 (end (point))
10583 (beg1 (save-excursion
10584 (skip-chars-backward (org-re "[:alnum:]_@"))
10585 (point)))
10586 (beg (save-excursion
10587 (skip-chars-backward "a-zA-Z0-9_:$")
10588 (point)))
10589 (confirm (lambda (x) (stringp (car x))))
10590 (searchhead (equal (char-before beg) ?*))
10591 (struct
10592 (when (and (member (char-before beg1) '(?. ?<))
10593 (setq a (assoc (buffer-substring beg1 (point))
10594 org-structure-template-alist)))
10595 (org-complete-expand-structure-template (1- beg1) a)
10596 (throw 'exit t)))
10597 (tag (and (equal (char-before beg1) ?:)
10598 (equal (char-after (point-at-bol)) ?*)))
10599 (prop (and (equal (char-before beg1) ?:)
10600 (not (equal (char-after (point-at-bol)) ?*))))
10602 (link (equal (char-before beg) ?\[))
10603 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10604 beg)
10605 "#+"))
10607 (buffer-substring (point-at-bol) (point))))
10608 (completion-ignore-case opt)
10609 (type nil)
10610 (tbl nil)
10611 (table (cond
10612 (opt
10613 (setq type :opt)
10614 (require 'org-exp)
10615 (append
10616 (delq nil
10617 (mapcar
10618 (lambda (x)
10619 (if (string-match
10621 (cons (match-string 2 x)
10622 (match-string 1 x))))
10624 (mapcar 'list org-additional-option-like-keywords)))
10625 (startup
10626 (setq type :startup)
10627 org-startup-options)
10628 (link (append org-link-abbrev-alist-local
10629 org-link-abbrev-alist))
10630 (texp
10631 (setq type :tex)
10632 (append org-entities-user org-entities))
10634 (buffer-substring (point-at-bol) beg))
10635 (setq type :todo)
10636 (mapcar 'list org-todo-keywords-1))
10637 (searchhead
10638 (setq type :searchhead)
10639 (save-excursion
10640 (goto-char (point-min))
10641 (while (re-search-forward org-todo-line-regexp nil t)
10642 (push (list
10643 (org-make-org-heading-search-string
10644 (match-string 3) t))
10645 tbl)))
10646 tbl)
10647 (tag (setq type :tag beg beg1)
10648 (or org-tag-alist (org-get-buffer-tags)))
10649 (prop (setq type :prop beg beg1)
10650 (mapcar 'list (org-buffer-property-keys nil t t)))
10651 (t (progn
10652 (call-interactively org-completion-fallback-command)
10653 (throw 'exit nil)))))
10654 (pattern (buffer-substring-no-properties beg end))
10655 (completion (try-completion pattern table confirm)))
10656 (cond ((eq completion t)
10657 (if (not (assoc (upcase pattern) table))
10658 (message "Already complete")
10659 (if (and (equal type :opt)
10660 (not (member (car (assoc (upcase pattern) table))
10661 org-additional-option-like-keywords)))
10662 (insert (substring (cdr (assoc (upcase pattern) table))
10663 (length pattern)))
10664 (if (memq type '(:tag :prop)) (insert ":")))))
10665 ((null completion)
10667 (ding))
10668 ((not (string= pattern completion))
10669 (delete-region beg end)
10670 (if (string-match " +$" completion)
10671 (setq completion (replace-match "" t t completion)))
10672 (insert completion)
10673 (if (get-buffer-window "*Completions*")
10674 (delete-window (get-buffer-window "*Completions*")))
10675 (if (assoc completion table)
10676 (if (eq type :todo) (insert " ")
10677 (if (memq type '(:tag :prop)) (insert ":"))))
10678 (if (and (equal type :opt) (assoc completion table))
10679 (message "%s" (substitute-command-keys
10681 (t
10682 (message "Making completion list...")
10683 (let ((list (sort (all-completions pattern table confirm)
10684 'string<)))
10685 (with-output-to-temp-buffer "*Completions*"
10686 (condition-case nil
10687 ;; Protection needed for XEmacs and emacs 21
10688 (display-completion-list list pattern)
10689 (error (display-completion-list list)))))
10690 (message "Making completion list...%s" "done")))))))
10692 ;;;; TODO, DEADLINE, Comments
10694 (defun org-toggle-comment ()
10695 "Change the COMMENT state of an entry."
10696 (interactive)
10697 (save-excursion
10698 (org-back-to-heading)
10699 (let (case-fold-search)
10700 (if (looking-at (concat outline-regexp
10702 (replace-match "" t t nil 1)
10703 (if (looking-at outline-regexp)
10704 (progn
10705 (goto-char (match-end 0))
10706 (insert org-comment-string " ")))))))
10708 (defvar org-last-todo-state-is-todo nil
10709 "This is non-nil when the last TODO state change led to a TODO state.
10710 If the last change removed the TODO tag or switched to DONE, then
10711 this is nil.")
10713 (defvar org-setting-tags nil) ; dynamically skipped
10715 (defun org-parse-local-options (string var)
10716 "Parse STRING for startup setting relevant for variable VAR."
10717 (let ((rtn (symbol-value var))
10718 e opts)
10719 (save-match-data
10721 rtn
10722 (setq opts (delq nil (mapcar (lambda (x)
10723 (setq e (assoc x org-startup-options))
10724 (if (eq (nth 1 e) var) e nil))
10726 (if (not opts)
10727 rtn
10728 (setq rtn nil)
10729 (while (setq e (pop opts))
10730 (if (not (nth 3 e))
10731 (setq rtn (nth 2 e))
10732 (if (not (listp rtn)) (setq rtn nil))
10733 (push (nth 2 e) rtn)))
10734 rtn)))))
10736 (defvar org-todo-setup-filter-hook nil
10737 "Hook for functions that pre-filter todo specs.
10738 Each function takes a todo spec and returns either nil or the spec
10739 transformed into canonical form." )
10741 (defvar org-todo-get-default-hook nil
10742 "Hook for functions that get a default item for todo.
10743 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10744 nil or a string to be used for the todo mark." )
10746 (defvar org-agenda-headline-snapshot-before-repeat)
10748 (defun org-todo (&optional arg)
10749 "Change the TODO state of an item.
10750 The state of an item is given by a keyword at the start of the heading,
10751 like
10752 *** TODO Write paper
10753 *** DONE Call mom
10755 The different keywords are specified in the variable `org-todo-keywords'.
10757 So for this example: when the item starts with TODO, it is changed to DONE.
10758 When it starts with DONE, the DONE is removed. And when neither TODO nor
10759 DONE are present, add TODO at the beginning of the heading.
10762 state.
10763 With numeric prefix arg, switch to that state.
10765 keywords (nextset).
10768 For calling through lisp, arg is also interpreted in the following way:
10769 'none -> empty state
10771 'done -> switch to DONE
10772 'nextset -> switch to the next set of keywords
10773 'previousset -> switch to the previous set of keywords
10775 really is a member of `org-todo-keywords'."
10776 (interactive "P")
10777 (if (equal arg '(16)) (setq arg 'nextset))
10778 (let ((org-blocker-hook org-blocker-hook)
10779 (case-fold-search nil))
10780 (when (equal arg '(64))
10781 (setq arg nil org-blocker-hook nil))
10782 (when (and org-blocker-hook
10783 (or org-inhibit-blocking
10784 (org-entry-get nil "NOBLOCKING")))
10785 (setq org-blocker-hook nil))
10786 (save-excursion
10787 (catch 'exit
10788 (org-back-to-heading t)
10789 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10791 (looking-at " *"))
10792 (let* ((match-data (match-data))
10793 (startpos (point-at-bol))
10794 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10795 (org-log-done org-log-done)
10796 (org-log-repeat org-log-repeat)
10797 (org-todo-log-states org-todo-log-states)
10798 (this (match-string 1))
10799 (hl-pos (match-beginning 0))
10800 (head (org-get-todo-sequence-head this))
10801 (ass (assoc head org-todo-kwd-alist))
10802 (interpret (nth 1 ass))
10803 (done-word (nth 3 ass))
10804 (final-done-word (nth 4 ass))
10805 (last-state (or this ""))
10806 (completion-ignore-case t)
10807 (member (member this org-todo-keywords-1))
10808 (tail (cdr member))
10809 (state (cond
10810 ((and org-todo-key-trigger
10811 (or (and (equal arg '(4))
10812 (eq org-use-fast-todo-selection 'prefix))
10813 (and (not arg) org-use-fast-todo-selection
10814 (not (eq org-use-fast-todo-selection
10815 'prefix)))))
10816 ;; Use fast selection
10817 (org-fast-todo-selection))
10818 ((and (equal arg '(4))
10819 (or (not org-use-fast-todo-selection)
10820 (not org-todo-key-trigger)))
10821 ;; Read a state with completion
10822 (org-icompleting-read
10823 "State: " (mapcar (lambda(x) (list x))
10824 org-todo-keywords-1)
10825 nil t))
10826 ((eq arg 'right)
10827 (if this
10828 (if tail (car tail) nil)
10829 (car org-todo-keywords-1)))
10830 ((eq arg 'left)
10831 (if (equal member org-todo-keywords-1)
10832 nil
10833 (if this
10834 (nth (- (length org-todo-keywords-1)
10835 (length tail) 2)
10836 org-todo-keywords-1)
10837 (org-last org-todo-keywords-1))))
10838 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10839 (setq arg nil))) ; hack to fall back to cycling
10840 (arg
10841 ;; user or caller requests a specific state
10842 (cond
10843 ((equal arg "") nil)
10844 ((eq arg 'none) nil)
10845 ((eq arg 'done) (or done-word (car org-done-keywords)))
10846 ((eq arg 'nextset)
10847 (or (car (cdr (member head org-todo-heads)))
10848 (car org-todo-heads)))
10849 ((eq arg 'previousset)
10850 (let ((org-todo-heads (reverse org-todo-heads)))
10851 (or (car (cdr (member head org-todo-heads)))
10852 (car org-todo-heads))))
10853 ((car (member arg org-todo-keywords-1)))
10854 ((stringp arg)
10855 (error "State `%s' not valid in this file" arg))
10856 ((nth (1- (prefix-numeric-value arg))
10857 org-todo-keywords-1))))
10858 ((null member) (or head (car org-todo-keywords-1)))
10859 ((equal this final-done-word) nil) ;; -> make empty
10860 ((null tail) nil) ;; -> first entry
10861 ((memq interpret '(type priority))
10862 (if (eq this-command last-command)
10863 (car tail)
10864 (if (> (length tail) 0)
10865 (or done-word (car org-done-keywords))
10866 nil)))
10867 (t
10868 (car tail))))
10869 (state (or
10870 (run-hook-with-args-until-success
10871 'org-todo-get-default-hook state last-state)
10872 state))
10873 (next (if state (concat " " state " ") " "))
10874 (change-plist (list :type 'todo-state-change :from this :to state
10875 :position startpos))
10876 dolog now-done-p)
10877 (when org-blocker-hook
10878 (setq org-last-todo-state-is-todo
10879 (not (member this org-done-keywords)))
10880 (unless (save-excursion
10881 (save-match-data
10882 (run-hook-with-args-until-failure
10883 'org-blocker-hook change-plist)))
10884 (if (interactive-p)
10885 (error "TODO state change from %s to %s blocked" this state)
10886 ;; fail silently
10887 (message "TODO state change from %s to %s blocked" this state)
10888 (throw 'exit nil))))
10889 (store-match-data match-data)
10890 (replace-match next t t)
10891 (unless (pos-visible-in-window-p hl-pos)
10892 (message "TODO state changed to %s" (org-trim next)))
10893 (unless head
10894 (setq head (org-get-todo-sequence-head state)
10895 ass (assoc head org-todo-kwd-alist)
10896 interpret (nth 1 ass)
10897 done-word (nth 3 ass)
10898 final-done-word (nth 4 ass)))
10899 (when (memq arg '(nextset previousset))
10900 (message "Keyword-Set %d/%d: %s"
10901 (- (length org-todo-sets) -1
10902 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10903 (length org-todo-sets)
10904 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10905 (setq org-last-todo-state-is-todo
10906 (not (member state org-done-keywords)))
10907 (setq now-done-p (and (member state org-done-keywords)
10908 (not (member this org-done-keywords))))
10909 (and logging (org-local-logging logging))
10910 (when (and (or org-todo-log-states org-log-done)
10911 (not (eq org-inhibit-logging t))
10912 (not (memq arg '(nextset previousset))))
10913 ;; we need to look at recording a time and note
10914 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10915 (nth 2 (assoc this org-todo-log-states))))
10916 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10917 (setq dolog 'time))
10918 (when (and state
10919 (member state org-not-done-keywords)
10920 (not (member this org-not-done-keywords)))
10921 ;; This is now a todo state and was not one before
10922 ;; If there was a CLOSED time stamp, get rid of it.
10923 (org-add-planning-info nil nil 'closed))
10924 (when (and now-done-p org-log-done)
10925 ;; It is now done, and it was not done before
10926 (org-add-planning-info 'closed (org-current-time))
10927 (if (and (not dolog) (eq 'note org-log-done))
10928 (org-add-log-setup 'done state this 'findpos 'note)))
10929 (when (and state dolog)
10930 ;; This is a non-nil state, and we need to log it
10931 (org-add-log-setup 'state state this 'findpos dolog)))
10932 ;; Fixup tag positioning
10933 (org-todo-trigger-tag-changes state)
10934 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10935 (when org-provide-todo-statistics
10936 (org-update-parent-todo-statistics))
10937 (run-hooks 'org-after-todo-state-change-hook)
10938 (if (and arg (not (member state org-done-keywords)))
10939 (setq head (org-get-todo-sequence-head state)))
10940 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10941 ;; Do we need to trigger a repeat?
10942 (when now-done-p
10943 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10944 ;; This is for the agenda, take a snapshot of the headline.
10945 (save-match-data
10946 (setq org-agenda-headline-snapshot-before-repeat
10947 (org-get-heading))))
10948 (org-auto-repeat-maybe state))
10949 ;; Fixup cursor location if close to the keyword
10950 (if (and (outline-on-heading-p)
10951 (not (bolp))
10952 (save-excursion (beginning-of-line 1)
10953 (looking-at org-todo-line-regexp))
10954 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10955 (progn
10956 (goto-char (or (match-end 2) (match-end 1)))
10957 (and (looking-at " ") (just-one-space))))
10958 (when org-trigger-hook
10959 (save-excursion
10960 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10962 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10963 "Block turning an entry into a TODO, using the hierarchy.
10964 This checks whether the current task should be blocked from state
10965 changes. Such blocking occurs when:
10967 1. The task has children which are not all in a completed state.
10969 2. A task has a parent with the property :ORDERED:, and there
10970 are siblings prior to the current task with incomplete
10971 status.
10973 3. The parent of the task is blocked because it has siblings that should
10974 be done first, or is child of a block grandparent TODO entry."
10976 (if (not org-enforce-todo-dependencies)
10977 t ; if locally turned off don't block
10978 (catch 'dont-block
10979 ;; If this is not a todo state change, or if this entry is already DONE,
10980 ;; do not block
10981 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10982 (member (plist-get change-plist :from)
10983 (cons 'done org-done-keywords))
10984 (member (plist-get change-plist :to)
10985 (cons 'todo org-not-done-keywords))
10986 (not (plist-get change-plist :to)))
10987 (throw 'dont-block t))
10988 ;; If this task has children, and any are undone, it's blocked
10989 (save-excursion
10990 (org-back-to-heading t)
10991 (let ((this-level (funcall outline-level)))
10992 (outline-next-heading)
10993 (let ((child-level (funcall outline-level)))
10994 (while (and (not (eobp))
10995 (> child-level this-level))
10996 ;; this todo has children, check whether they are all
10997 ;; completed
10998 (if (and (not (org-entry-is-done-p))
10999 (org-entry-is-todo-p))
11000 (throw 'dont-block nil))
11001 (outline-next-heading)
11002 (setq child-level (funcall outline-level))))))
11003 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11004 ;; any previous siblings are undone, it's blocked
11005 (save-excursion
11006 (org-back-to-heading t)
11007 (let* ((pos (point))
11008 (parent-pos (and (org-up-heading-safe) (point))))
11009 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11010 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11011 (forward-line 1)
11012 (re-search-forward org-not-done-heading-regexp pos t))
11013 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11014 ;; Search further up the hierarchy, to see if an anchestor is blocked
11015 (while t
11016 (goto-char parent-pos)
11017 (if (not (looking-at org-not-done-heading-regexp))
11018 (throw 'dont-block t)) ; do not block, parent is not a TODO
11019 (setq pos (point))
11020 (setq parent-pos (and (org-up-heading-safe) (point)))
11021 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11022 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11023 (forward-line 1)
11024 (re-search-forward org-not-done-heading-regexp pos t))
11025 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11027 (defcustom org-track-ordered-property-with-tag nil
11028 "Should the ORDERED property also be shown as a tag?
11029 The ORDERED property decides if an entry should require subtasks to be
11030 completed in sequence. Since a property is not very visible, setting
11031 this option means that toggling the ORDERED property with the command
11032 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11033 not relevant for the behavior, but it makes things more visible.
11035 Note that toggling the tag with tags commands will not change the property
11036 and therefore not influence behavior!
11038 This can be t, meaning the tag ORDERED should be used, It can also be a
11039 string to select a different tag for this task."
11040 :group 'org-todo
11041 :type '(choice
11042 (const :tag "No tracking" nil)
11043 (const :tag "Track with ORDERED tag" t)
11044 (string :tag "Use other tag")))
11046 (defun org-toggle-ordered-property ()
11047 "Toggle the ORDERED property of the current entry.
11048 For better visibility, you can track the value of this property with a tag.
11049 See variable `org-track-ordered-property-with-tag'."
11050 (interactive)
11051 (let* ((t1 org-track-ordered-property-with-tag)
11052 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11053 (save-excursion
11054 (org-back-to-heading)
11055 (if (org-entry-get nil "ORDERED")
11056 (progn
11057 (org-delete-property "ORDERED")
11058 (and tag (org-toggle-tag tag 'off))
11059 (message "Subtasks can be completed in arbitrary order"))
11060 (org-entry-put nil "ORDERED" "t")
11061 (and tag (org-toggle-tag tag 'on))
11062 (message "Subtasks must be completed in sequence")))))
11064 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11065 (defun org-block-todo-from-checkboxes (change-plist)
11066 "Block turning an entry into a TODO, using checkboxes.
11067 This checks whether the current task should be blocked from state
11068 changes because there are unchecked boxes in this entry."
11069 (if (not org-enforce-todo-checkbox-dependencies)
11070 t ; if locally turned off don't block
11071 (catch 'dont-block
11072 ;; If this is not a todo state change, or if this entry is already DONE,
11073 ;; do not block
11074 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11075 (member (plist-get change-plist :from)
11076 (cons 'done org-done-keywords))
11077 (member (plist-get change-plist :to)
11078 (cons 'todo org-not-done-keywords))
11079 (not (plist-get change-plist :to)))
11080 (throw 'dont-block t))
11081 ;; If this task has checkboxes that are not checked, it's blocked
11082 (save-excursion
11083 (org-back-to-heading t)
11084 (let ((beg (point)) end)
11085 (outline-next-heading)
11086 (setq end (point))
11087 (goto-char beg)
11089 end t)
11090 (progn
11091 (if (boundp 'org-blocked-by-checkboxes)
11092 (setq org-blocked-by-checkboxes t))
11093 (throw 'dont-block nil)))))
11094 t))) ; do not block
11096 (defun org-entry-blocked-p ()
11097 "Is the current entry blocked?"
11098 (if (org-entry-get nil "NOBLOCKING")
11099 nil ;; Never block this entry
11100 (not
11101 (run-hook-with-args-until-failure
11102 'org-blocker-hook
11103 (list :type 'todo-state-change
11104 :position (point)
11105 :from 'todo
11106 :to 'done)))))
11108 (defun org-update-statistics-cookies (all)
11109 "Update the statistics cookie, either from TODO or from checkboxes.
11110 This should be called with the cursor in a line with a statistics cookie."
11111 (interactive "P")
11112 (if all
11113 (progn
11114 (org-update-checkbox-count 'all)
11115 (org-map-entries 'org-update-parent-todo-statistics))
11116 (if (not (org-on-heading-p))
11117 (org-update-checkbox-count)
11118 (let ((pos (move-marker (make-marker) (point)))
11119 end l1 l2)
11120 (ignore-errors (org-back-to-heading t))
11121 (if (not (org-on-heading-p))
11122 (org-update-checkbox-count)
11123 (setq l1 (org-outline-level))
11124 (setq end (save-excursion
11125 (outline-next-heading)
11126 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11127 (point)))
11128 (if (and (save-excursion
11129 (re-search-forward
11131 (not (save-excursion (re-search-forward
11133 (org-update-checkbox-count)
11134 (if (and l2 (> l2 l1))
11135 (progn
11136 (goto-char end)
11137 (org-update-parent-todo-statistics))
11138 (goto-char pos)
11139 (beginning-of-line 1)
11140 (while (re-search-forward
11142 (point-at-eol) t)
11143 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11144 (goto-char pos)
11145 (move-marker pos nil)))))
11147 (defvar org-entry-property-inherited-from) ;; defined below
11148 (defun org-update-parent-todo-statistics ()
11149 "Update any statistics cookie in the parent of the current headline.
11150 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11151 the entire subtree and this will travel up the hierarchy and update
11152 statistics everywhere."
11153 (interactive)
11154 (let* ((lim 0) prop
11155 (recursive (or (not org-hierarchical-todo-statistics)
11156 (string-match
11158 (or (setq prop (org-entry-get
11159 nil "COOKIE_DATA" 'inherit)) ""))))
11160 (lim (or (and prop (marker-position
11161 org-entry-property-inherited-from))
11162 lim))
11163 (first t)
11165 level ltoggle l1 new ndel
11166 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11167 (catch 'exit
11168 (save-excursion
11169 (beginning-of-line 1)
11170 (if (org-at-heading-p)
11171 (setq ltoggle (funcall outline-level))
11172 (error "This should not happen"))
11173 (while (and (setq level (org-up-heading-safe))
11174 (or recursive first)
11175 (>= (point) lim))
11176 (setq first nil cookie-present nil)
11177 (unless (and level
11178 (not (string-match
11180 (downcase
11181 (or (org-entry-get
11182 nil "COOKIE_DATA")
11183 "")))))
11184 (throw 'exit nil))
11185 (while (re-search-forward box-re (point-at-eol) t)
11186 (setq cnt-all 0 cnt-done 0 cookie-present t)
11187 (setq is-percent (match-end 2))
11188 (save-match-data
11189 (unless (outline-next-heading) (throw 'exit nil))
11190 (while (and (looking-at org-complex-heading-regexp)
11191 (> (setq l1 (length (match-string 1))) level))
11192 (setq kwd (and (or recursive (= l1 ltoggle))
11193 (match-string 2)))
11194 (if (or (eq org-provide-todo-statistics 'all-headlines)
11195 (and (listp org-provide-todo-statistics)
11196 (or (member kwd org-provide-todo-statistics)
11197 (member kwd org-done-keywords))))
11198 (setq cnt-all (1+ cnt-all))
11199 (if (eq org-provide-todo-statistics t)
11200 (and kwd (setq cnt-all (1+ cnt-all)))))
11201 (and (member kwd org-done-keywords)
11202 (setq cnt-done (1+ cnt-done)))
11203 (outline-next-heading)))
11204 (setq new
11205 (if is-percent
11206 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11207 (format "[%d/%d]" cnt-done cnt-all))
11208 ndel (- (match-end 0) (match-beginning 0)))
11209 (goto-char (match-beginning 0))
11210 (insert new)
11211 (delete-region (point) (+ (point) ndel)))
11212 (when cookie-present
11213 (run-hook-with-args 'org-after-todo-statistics-hook
11214 cnt-done (- cnt-all cnt-done))))))
11215 (run-hooks 'org-todo-statistics-hook)))
11217 (defvar org-after-todo-statistics-hook nil
11218 "Hook that is called after a TODO statistics cookie has been updated.
11219 Each function is called with two arguments: the number of not-done entries
11220 and the number of done entries.
11222 For example, the following function, when added to this hook, will switch
11223 an entry to DONE when all children are done, and back to TODO when new
11224 entries are set to a TODO status. Note that this hook is only called
11225 when there is a statistics cookie in the headline!
11227 (defun org-summary-todo (n-done n-not-done)
11229 (let (org-log-done org-log-states) ; turn off logging
11231 ")
11233 (defvar org-todo-statistics-hook nil
11234 "Hook that is run whenever Org thinks TODO statistics should be updated.
11235 This hook runs even if there is no statistics cookie present, in which case
11236 `org-after-todo-statistics-hook' would not run.")
11238 (defun org-todo-trigger-tag-changes (state)
11239 "Apply the changes defined in `org-todo-state-tags-triggers'."
11240 (let ((l org-todo-state-tags-triggers)
11241 changes)
11242 (when (or (not state) (equal state ""))
11243 (setq changes (append changes (cdr (assoc "" l)))))
11244 (when (and (stringp state) (> (length state) 0))
11245 (setq changes (append changes (cdr (assoc state l)))))
11246 (when (member state org-not-done-keywords)
11247 (setq changes (append changes (cdr (assoc 'todo l)))))
11248 (when (member state org-done-keywords)
11249 (setq changes (append changes (cdr (assoc 'done l)))))
11250 (dolist (c changes)
11251 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11253 (defun org-local-logging (value)
11254 "Get logging settings from a property VALUE."
11255 (let* (words w a)
11256 ;; directly set the variables, they are already local.
11257 (setq org-log-done nil
11258 org-log-repeat nil
11259 org-todo-log-states nil)
11260 (setq words (org-split-string value))
11261 (while (setq w (pop words))
11262 (cond
11263 ((setq a (assoc w org-startup-options))
11264 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11265 (set (nth 1 a) (nth 2 a))))
11266 ((setq a (org-extract-log-state-settings w))
11267 (and (member (car a) org-todo-keywords-1)
11268 (push a org-todo-log-states)))))))
11270 (defun org-get-todo-sequence-head (kwd)
11271 "Return the head of the TODO sequence to which KWD belongs.
11272 If KWD is not set, check if there is a text property remembering the
11273 right sequence."
11274 (let (p)
11275 (cond
11276 ((not kwd)
11277 (or (get-text-property (point-at-bol) 'org-todo-head)
11278 (progn
11279 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11280 nil (point-at-eol)))
11281 (get-text-property p 'org-todo-head))))
11282 ((not (member kwd org-todo-keywords-1))
11283 (car org-todo-keywords-1))
11284 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11286 (defun org-fast-todo-selection ()
11287 "Fast TODO keyword selection with single keys.
11288 Returns the new TODO keyword, or nil if no state change should occur."
11289 (let* ((fulltable org-todo-key-alist)
11290 (done-keywords org-done-keywords) ;; needed for the faces.
11291 (maxlen (apply 'max (mapcar
11292 (lambda (x)
11293 (if (stringp (car x)) (string-width (car x)) 0))
11294 fulltable)))
11295 (expert nil)
11296 (fwidth (+ maxlen 3 1 3))
11297 (ncol (/ (- (window-width) 4) fwidth))
11298 tg cnt e c tbl
11299 groups ingroup)
11300 (save-excursion
11301 (save-window-excursion
11302 (if expert
11303 (set-buffer (get-buffer-create " *Org todo*"))
11304 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11305 (erase-buffer)
11306 (org-set-local 'org-done-keywords done-keywords)
11307 (setq tbl fulltable cnt 0)
11308 (while (setq e (pop tbl))
11309 (cond
11310 ((equal e '(:startgroup))
11311 (push '() groups) (setq ingroup t)
11312 (when (not (= cnt 0))
11313 (setq cnt 0)
11315 (insert "{ "))
11316 ((equal e '(:endgroup))
11317 (setq ingroup nil cnt 0)
11319 ((equal e '(:newline))
11320 (when (not (= cnt 0))
11321 (setq cnt 0)
11323 (setq e (car tbl))
11324 (while (equal (car tbl) '(:newline))
11326 (setq tbl (cdr tbl)))))
11327 (t
11328 (setq tg (car e) c (cdr e))
11329 (if ingroup (push tg (car groups)))
11330 (setq tg (org-add-props tg nil 'face
11331 (org-get-todo-face tg)))
11332 (if (and (= cnt 0) (not ingroup)) (insert " "))
11333 (insert "[" c "] " tg (make-string
11334 (- fwidth 4 (length tg)) ?\ ))
11335 (when (= (setq cnt (1+ cnt)) ncol)
11337 (if ingroup (insert " "))
11338 (setq cnt 0)))))
11340 (goto-char (point-min))
11341 (if (not expert) (org-fit-window-to-buffer))
11342 (message "[a-z..]:Set [SPC]:clear")
11343 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11344 (cond
11345 ((or (= c ?\C-g)
11346 (and (= c ?q) (not (rassoc c fulltable))))
11347 (setq quit-flag t))
11348 ((= c ?\ ) nil)
11349 ((setq e (rassoc c fulltable) tg (car e))
11350 tg)
11351 (t (setq quit-flag t)))))))
11353 (defun org-entry-is-todo-p ()
11354 (member (org-get-todo-state) org-not-done-keywords))
11356 (defun org-entry-is-done-p ()
11357 (member (org-get-todo-state) org-done-keywords))
11359 (defun org-get-todo-state ()
11360 (save-excursion
11361 (org-back-to-heading t)
11362 (and (looking-at org-todo-line-regexp)
11363 (match-end 2)
11364 (match-string 2))))
11366 (defun org-at-date-range-p (&optional inactive-ok)
11367 "Is the cursor inside a date range?"
11368 (interactive)
11369 (save-excursion
11370 (catch 'exit
11371 (let ((pos (point)))
11373 (skip-chars-backward "<[")
11374 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11375 (>= (match-end 0) pos)
11376 (throw 'exit t))
11378 (skip-chars-backward "<[")
11379 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11380 (>= (match-end 0) pos)
11381 (throw 'exit t)))
11382 nil)))
11384 (defun org-get-repeat (&optional tagline)
11385 "Check if there is a deadline/schedule with repeater in this entry."
11386 (save-match-data
11387 (save-excursion
11388 (org-back-to-heading t)
11389 (and (re-search-forward (if tagline
11391 org-repeat-re)
11392 (org-entry-end-position) t)
11393 (match-string-no-properties 1)))))
11395 (defvar org-last-changed-timestamp)
11396 (defvar org-last-inserted-timestamp)
11397 (defvar org-log-post-message)
11398 (defvar org-log-note-purpose)
11399 (defvar org-log-note-how)
11400 (defvar org-log-note-extra)
11401 (defun org-auto-repeat-maybe (done-word)
11402 "Check if the current headline contains a repeated deadline/schedule.
11403 If yes, set TODO state back to what it was and change the base date
11404 of repeating deadline/scheduled time stamps to new date.
11405 This function is run automatically after each state change to a DONE state."
11406 ;; last-state is dynamically scoped into this function
11407 (let* ((repeat (org-get-repeat))
11408 (aa (assoc last-state org-todo-kwd-alist))
11409 (interpret (nth 1 aa))
11410 (head (nth 2 aa))
11411 (whata '(("d" . day) ("m" . month) ("y" . year)))
11412 (msg "Entry repeats: ")
11413 (org-log-done nil)
11414 (org-todo-log-states nil)
11415 (nshiftmax 10) (nshift 0)
11416 re type n what ts time to-state)
11417 (when repeat
11418 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11419 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11420 org-todo-repeat-to-state))
11421 (unless (and to-state (member to-state org-todo-keywords-1))
11422 (setq to-state (if (eq interpret 'type) last-state head)))
11423 (org-todo to-state)
11424 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11425 (org-entry-put nil "LAST_REPEAT" (format-time-string
11426 (org-time-stamp-format t t))))
11427 (when org-log-repeat
11428 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11429 (memq 'org-add-log-note post-command-hook))
11430 ;; OK, we are already setup for some record
11431 (if (eq org-log-repeat 'note)
11432 ;; make sure we take a note, not only a time stamp
11433 (setq org-log-note-how 'note))
11434 ;; Set up for taking a record
11435 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11436 last-state
11437 'findpos org-log-repeat)))
11438 (org-back-to-heading t)
11439 (org-add-planning-info nil nil 'closed)
11443 (while (re-search-forward
11444 re (save-excursion (outline-next-heading) (point)) t)
11445 (setq type (if (match-end 1) org-scheduled-string
11446 (if (match-end 3) org-deadline-string "Plain:"))
11447 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11449 (setq n (string-to-number (match-string 2 ts))
11450 what (match-string 3 ts))
11451 (if (equal what "w") (setq n (* n 7) what "d"))
11452 ;; Preparation, see if we need to modify the start date for the change
11453 (when (match-end 1)
11454 (setq time (save-match-data (org-time-string-to-time ts)))
11455 (cond
11456 ((equal (match-string 1 ts) ".")
11457 ;; Shift starting date to today
11458 (org-timestamp-change
11459 (- (time-to-days (current-time)) (time-to-days time))
11460 'day))
11461 ((equal (match-string 1 ts) "+")
11462 (while (or (= nshift 0)
11463 (<= (time-to-days time) (time-to-days (current-time))))
11464 (when (= (incf nshift) nshiftmax)
11465 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11466 (error "Abort")))
11467 (org-timestamp-change n (cdr (assoc what whata)))
11468 (org-at-timestamp-p t)
11469 (setq ts (match-string 1))
11470 (setq time (save-match-data (org-time-string-to-time ts))))
11471 (org-timestamp-change (- n) (cdr (assoc what whata)))
11472 ;; rematch, so that we have everything in place for the real shift
11473 (org-at-timestamp-p t)
11474 (setq ts (match-string 1))
11476 (org-timestamp-change n (cdr (assoc what whata)))
11477 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11478 (setq org-log-post-message msg)
11479 (message "%s" msg))))
11481 (defun org-show-todo-tree (arg)
11482 "Make a compact tree which shows all headlines marked with TODO.
11483 The tree will show the lines where the regexp matches, and all higher
11484 headlines above the match.
11486 With a numeric prefix N, construct a sparse tree for the Nth element
11487 of `org-todo-keywords-1'."
11488 (interactive "P")
11489 (let ((case-fold-search nil)
11490 (kwd-re
11491 (cond ((null arg) org-not-done-regexp)
11492 ((equal arg '(4))
11493 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11494 (mapcar 'list org-todo-keywords-1))))
11498 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11499 (regexp-quote (nth (1- (prefix-numeric-value arg))
11500 org-todo-keywords-1)))
11501 (t (error "Invalid prefix argument: %s" arg)))))
11502 (message "%d TODO entries found"
11503 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11505 (defun org-deadline (&optional remove time)
11507 With argument REMOVE, remove any deadline from the item.
11508 When TIME is set, it should be an internal time specification, and the
11509 scheduling will use the corresponding date."
11510 (interactive "P")
11511 (let* ((old-date (org-entry-get nil "DEADLINE"))
11512 (repeater (and old-date
11514 (match-string 1 old-date))))
11515 (if remove
11516 (progn
11517 (when (and old-date org-log-redeadline)
11518 (org-add-log-setup 'deldeadline nil old-date 'findpos
11519 org-log-redeadline))
11520 (org-remove-timestamp-with-keyword org-deadline-string)
11521 (message "Item no longer has a deadline."))
11522 (org-add-planning-info 'deadline time 'closed)
11523 (when (and old-date org-log-redeadline
11524 (not (equal old-date
11525 (substring org-last-inserted-timestamp 1 -1))))
11526 (org-add-log-setup 'redeadline nil old-date 'findpos
11527 org-log-redeadline))
11528 (when repeater
11529 (save-excursion
11530 (org-back-to-heading t)
11531 (when (re-search-forward (concat org-deadline-string " "
11532 org-last-inserted-timestamp)
11533 (save-excursion
11534 (outline-next-heading) (point)) t)
11535 (goto-char (1- (match-end 0)))
11536 (insert " " repeater)
11537 (setq org-last-inserted-timestamp
11538 (concat (substring org-last-inserted-timestamp 0 -1)
11539 " " repeater
11540 (substring org-last-inserted-timestamp -1))))))
11541 (message "Deadline on %s" org-last-inserted-timestamp))))
11543 (defun org-schedule (&optional remove time)
11544 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11545 With argument REMOVE, remove any scheduling date from the item.
11546 When TIME is set, it should be an internal time specification, and the
11547 scheduling will use the corresponding date."
11548 (interactive "P")
11549 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11550 (repeater (and old-date
11552 (match-string 1 old-date))))
11553 (if remove
11554 (progn
11555 (when (and old-date org-log-reschedule)
11556 (org-add-log-setup 'delschedule nil old-date 'findpos
11557 org-log-reschedule))
11558 (org-remove-timestamp-with-keyword org-scheduled-string)
11559 (message "Item is no longer scheduled."))
11560 (org-add-planning-info 'scheduled time 'closed)
11561 (when (and old-date org-log-reschedule
11562 (not (equal old-date
11563 (substring org-last-inserted-timestamp 1 -1))))
11564 (org-add-log-setup 'reschedule nil old-date 'findpos
11565 org-log-reschedule))
11566 (when repeater
11567 (save-excursion
11568 (org-back-to-heading t)
11569 (when (re-search-forward (concat org-scheduled-string " "
11570 org-last-inserted-timestamp)
11571 (save-excursion
11572 (outline-next-heading) (point)) t)
11573 (goto-char (1- (match-end 0)))
11574 (insert " " repeater)
11575 (setq org-last-inserted-timestamp
11576 (concat (substring org-last-inserted-timestamp 0 -1)
11577 " " repeater
11578 (substring org-last-inserted-timestamp -1))))))
11579 (message "Scheduled to %s" org-last-inserted-timestamp))))
11581 (defun org-get-scheduled-time (pom &optional inherit)
11582 "Get the scheduled time as a time tuple, of a format suitable
11583 for calling org-schedule with, or if there is no scheduling,
11584 returns nil."
11585 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11586 (when time
11587 (apply 'encode-time (org-parse-time-string time)))))
11589 (defun org-get-deadline-time (pom &optional inherit)
11590 "Get the deadline as a time tuple, of a format suitable for
11591 calling org-deadline with, or if there is no scheduling, returns
11592 nil."
11593 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11594 (when time
11595 (apply 'encode-time (org-parse-time-string time)))))
11597 (defun org-remove-timestamp-with-keyword (keyword)
11598 "Remove all time stamps with KEYWORD in the current entry."
11600 beg)
11601 (save-excursion
11602 (org-back-to-heading t)
11603 (setq beg (point))
11604 (outline-next-heading)
11605 (while (re-search-backward re beg t)
11606 (replace-match "")
11608 (equal (char-before) ?\ ))
11609 (backward-delete-char 1)
11611 (point-at-bol) (point-at-eol)))
11612 (delete-region (point-at-bol)
11613 (min (point-max) (1+ (point-at-eol))))))))))
11615 (defun org-add-planning-info (what &optional time &rest remove)
11616 "Insert new timestamp with keyword in the line directly after the headline.
11617 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11618 If non is given, the user is prompted for a date.
11619 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11620 be removed."
11621 (interactive)
11622 (let (org-time-was-given org-end-time-was-given ts
11623 end default-time default-input)
11625 (catch 'exit
11626 (when (and (not time) (memq what '(scheduled deadline)))
11627 ;; Try to get a default date/time from existing timestamp
11628 (save-excursion
11629 (org-back-to-heading t)
11630 (setq end (save-excursion (outline-next-heading) (point)))
11631 (when (re-search-forward (if (eq what 'scheduled)
11632 org-scheduled-time-regexp
11633 org-deadline-time-regexp)
11634 end t)
11635 (setq ts (match-string 1)
11636 default-time
11637 (apply 'encode-time (org-parse-time-string ts))
11638 default-input (and ts (org-get-compact-tod ts))))))
11639 (when what
11640 ;; If necessary, get the time from the user
11641 (setq time (or time (org-read-date nil 'to-time nil nil
11642 default-time default-input))))
11644 (when (and org-insert-labeled-timestamps-at-point
11645 (member what '(scheduled deadline)))
11646 (insert
11647 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11648 (org-insert-time-stamp time org-time-was-given
11649 nil nil nil (list org-end-time-was-given))
11650 (setq what nil))
11651 (save-excursion
11652 (save-restriction
11653 (let (col list elt ts buffer-invisibility-spec)
11654 (org-back-to-heading t)
11656 (goto-char (match-end 1))
11657 (setq col (current-column))
11658 (goto-char (match-end 0))
11660 (when (and (not what)
11661 (not (looking-at
11663 org-keyword-time-not-clock-regexp))))
11664 ;; Nothing to add, nothing to remove...... :-)
11665 (throw 'exit nil))
11666 (if (and (not (looking-at outline-regexp))
11669 (not (equal (match-string 1) org-clock-string)))
11670 (narrow-to-region (match-beginning 0) (match-end 0))
11672 (backward-char 1)
11673 (narrow-to-region (point) (point))
11674 (and org-adapt-indentation (org-indent-to-column col)))
11675 ;; Check if we have to remove something.
11676 (setq list (cons what remove))
11677 (while list
11678 (setq elt (pop list))
11679 (goto-char (point-min))
11680 (when (or (and (eq elt 'scheduled)
11681 (re-search-forward org-scheduled-time-regexp nil t))
11682 (and (eq elt 'deadline)
11683 (re-search-forward org-deadline-time-regexp nil t))
11684 (and (eq elt 'closed)
11685 (re-search-forward org-closed-time-regexp nil t)))
11686 (replace-match "")
11687 (if (looking-at "--+<[^>]+>") (replace-match ""))
11688 (skip-chars-backward " ")
11689 (if (looking-at " +") (replace-match ""))))
11690 (goto-char (point-max))
11691 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11692 (when what
11693 (insert
11694 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11695 (cond ((eq what 'scheduled) org-scheduled-string)
11696 ((eq what 'deadline) org-deadline-string)
11697 ((eq what 'closed) org-closed-string))
11698 " ")
11699 (setq ts (org-insert-time-stamp
11700 time
11701 (or org-time-was-given
11702 (and (eq what 'closed) org-log-done-with-time))
11703 (eq what 'closed)
11704 nil nil (list org-end-time-was-given)))
11705 (end-of-line 1))
11706 (goto-char (point-min))
11707 (widen)
11710 (delete-region (1- (point)) (point-at-eol)))
11711 ts))))))
11713 (defvar org-log-note-marker (make-marker))
11714 (defvar org-log-note-purpose nil)
11715 (defvar org-log-note-state nil)
11716 (defvar org-log-note-previous-state nil)
11717 (defvar org-log-note-how nil)
11718 (defvar org-log-note-extra nil)
11719 (defvar org-log-note-window-configuration nil)
11720 (defvar org-log-note-return-to (make-marker))
11721 (defvar org-log-post-message nil
11722 "Message to be displayed after a log note has been stored.
11723 The auto-repeater uses this.")
11725 (defun org-add-note ()
11726 "Add a note to the current entry.
11727 This is done in the same way as adding a state change note."
11728 (interactive)
11729 (org-add-log-setup 'note nil nil 'findpos nil))
11731 (defvar org-property-end-re)
11732 (defun org-add-log-setup (&optional purpose state prev-state
11733 findpos how &optional extra)
11734 "Set up the post command hook to take a note.
11735 If this is about to TODO state change, the new state is expected in STATE.
11736 When FINDPOS is non-nil, find the correct position for the note in
11737 the current entry. If not, assume that it can be inserted at point.
11738 HOW is an indicator what kind of note should be created.
11739 EXTRA is additional text that will be inserted into the notes buffer."
11740 (let* ((org-log-into-drawer (org-log-into-drawer))
11741 (drawer (cond ((stringp org-log-into-drawer)
11742 org-log-into-drawer)
11743 (org-log-into-drawer "LOGBOOK")
11744 (t nil))))
11745 (save-restriction
11746 (save-excursion
11747 (when findpos
11748 (org-back-to-heading t)
11749 (narrow-to-region (point) (save-excursion
11750 (outline-next-heading) (point)))
11754 (goto-char (match-end 0))
11755 (cond
11756 (drawer
11758 nil t)
11759 (progn
11760 (goto-char (match-end 0))
11761 (or org-log-states-order-reversed
11762 (and (re-search-forward org-property-end-re nil t)
11763 (goto-char (1- (match-beginning 0))))))
11765 (beginning-of-line 0)
11766 (org-indent-line-function)
11767 (beginning-of-line 2)
11768 (org-indent-line-function)
11769 (end-of-line 0)))
11770 ((and org-log-state-notes-insert-after-drawers
11771 (save-excursion
11772 (forward-line) (looking-at org-drawer-regexp)))
11773 (forward-line)
11774 (while (looking-at org-drawer-regexp)
11775 (goto-char (match-end 0))
11776 (re-search-forward org-property-end-re (point-max) t)
11777 (forward-line))
11778 (forward-line -1)))
11779 (unless org-log-states-order-reversed
11781 (org-skip-over-state-notes)
11783 (move-marker org-log-note-marker (point))
11784 (setq org-log-note-purpose purpose
11785 org-log-note-state state
11786 org-log-note-previous-state prev-state
11787 org-log-note-how how
11788 org-log-note-extra extra)
11789 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11791 (defun org-skip-over-state-notes ()
11792 "Skip past the list of State notes in an entry."
11795 (condition-case nil
11796 (org-next-item)
11797 (error (org-end-of-item)))))
11799 (defun org-add-log-note (&optional purpose)
11800 "Pop up a window for taking a note, and add this note later at point."
11801 (remove-hook 'post-command-hook 'org-add-log-note)
11802 (setq org-log-note-window-configuration (current-window-configuration))
11803 (delete-other-windows)
11804 (move-marker org-log-note-return-to (point))
11805 (switch-to-buffer (marker-buffer org-log-note-marker))
11806 (goto-char org-log-note-marker)
11807 (org-switch-to-buffer-other-window "*Org Note*")
11808 (erase-buffer)
11809 (if (memq org-log-note-how '(time state))
11810 (let (current-prefix-arg) (org-store-log-note))
11811 (let ((org-inhibit-startup t)) (org-mode))
11812 (insert (format "# Insert note for %s.
11814 (cond
11815 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11816 ((eq org-log-note-purpose 'done) "closed todo item")
11817 ((eq org-log-note-purpose 'state)
11819 (or org-log-note-previous-state "")
11820 (or org-log-note-state "")))
11821 ((eq org-log-note-purpose 'reschedule)
11822 "rescheduling")
11823 ((eq org-log-note-purpose 'delschedule)
11824 "no longer scheduled")
11825 ((eq org-log-note-purpose 'redeadline)
11826 "changing deadline")
11827 ((eq org-log-note-purpose 'deldeadline)
11828 "removing deadline")
11829 ((eq org-log-note-purpose 'refile)
11830 "refiling")
11831 ((eq org-log-note-purpose 'note)
11832 "this entry")
11833 (t (error "This should not happen")))))
11834 (if org-log-note-extra (insert org-log-note-extra))
11835 (org-set-local 'org-finish-function 'org-store-log-note)))
11837 (defvar org-note-abort nil) ; dynamically scoped
11838 (defun org-store-log-note ()
11839 "Finish taking a log note, and insert it to where it belongs."
11840 (let ((txt (buffer-string))
11841 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11842 lines ind)
11843 (kill-buffer (current-buffer))
11845 (setq txt (replace-match "" t t txt)))
11847 (setq txt (replace-match "" t t txt)))
11850 (setq note
11851 (org-replace-escapes
11852 note
11853 (list (cons "%u" (user-login-name))
11854 (cons "%U" user-full-name)
11855 (cons "%t" (format-time-string
11856 (org-time-stamp-format 'long 'inactive)
11857 (current-time)))
11858 (cons "%T" (format-time-string
11859 (org-time-stamp-format 'long nil)
11860 (current-time)))
11861 (cons "%s" (if org-log-note-state
11863 ""))
11864 (cons "%S" (if org-log-note-previous-state
11868 (push note lines))
11869 (when (or current-prefix-arg org-note-abort)
11870 (when org-log-into-drawer
11871 (org-remove-empty-drawer-at
11872 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11873 org-log-note-marker))
11874 (setq lines nil))
11875 (when lines
11876 (with-current-buffer (marker-buffer org-log-note-marker)
11877 (save-excursion
11878 (goto-char org-log-note-marker)
11879 (move-marker org-log-note-marker nil)
11880 (end-of-line 1)
11882 (insert "- " (pop lines))
11883 (org-indent-line-function)
11884 (beginning-of-line 1)
11886 (setq ind (concat (match-string 0) " "))
11887 (end-of-line 1)
11889 (message "Note stored")
11890 (org-back-to-heading t)
11891 (org-cycle-hide-drawers 'children)))))
11892 (set-window-configuration org-log-note-window-configuration)
11893 (with-current-buffer (marker-buffer org-log-note-return-to)
11894 (goto-char org-log-note-return-to))
11895 (move-marker org-log-note-return-to nil)
11896 (and org-log-post-message (message "%s" org-log-post-message)))
11898 (defun org-remove-empty-drawer-at (drawer pos)
11899 "Remove an empty drawer DRAWER at position POS.
11900 POS may also be a marker."
11901 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11902 (save-excursion
11903 (save-restriction
11904 (widen)
11905 (goto-char pos)
11906 (if (org-in-regexp
11908 (replace-match ""))))))
11910 (defun org-sparse-tree (&optional arg)
11911 "Create a sparse tree, prompt for the details.
11912 This command can create sparse trees. You first need to select the type
11913 of match used to create the tree:
11915 t Show all TODO entries.
11916 T Show entries with a specific TODO keyword.
11917 m Show entries selected by a tags/property match.
11918 p Enter a property name and its value (both with completion on existing
11919 names/values) and show entries with that property.
11920 / Show entries matching a regular expression (`r' can be used as well)
11921 d Show deadlines due within `org-deadline-warning-days'.
11922 b Show deadlines and scheduled items before a date.
11923 a Show deadlines and scheduled items after a date."
11924 (interactive "P")
11925 (let (ans kwd value)
11926 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
11927 (setq ans (read-char-exclusive))
11928 (cond
11929 ((equal ans ?d)
11930 (call-interactively 'org-check-deadlines))
11931 ((equal ans ?b)
11932 (call-interactively 'org-check-before-date))
11933 ((equal ans ?a)
11934 (call-interactively 'org-check-after-date))
11935 ((equal ans ?t)
11936 (org-show-todo-tree nil))
11937 ((equal ans ?T)
11938 (org-show-todo-tree '(4)))
11939 ((member ans '(?T ?m))
11940 (call-interactively 'org-match-sparse-tree))
11941 ((member ans '(?p ?P))
11942 (setq kwd (org-icompleting-read "Property: "
11943 (mapcar 'list (org-buffer-property-keys))))
11944 (setq value (org-icompleting-read "Value: "
11945 (mapcar 'list (org-property-values kwd))))
11948 (org-match-sparse-tree arg (concat kwd "=" value)))
11949 ((member ans '(?r ?R ?/))
11950 (call-interactively 'org-occur))
11953 (defvar org-occur-highlights nil
11954 "List of overlays used for occur matches.")
11955 (make-variable-buffer-local 'org-occur-highlights)
11956 (defvar org-occur-parameters nil
11957 "Parameters of the active org-occur calls.
11958 This is a list, each call to org-occur pushes as cons cell,
11959 containing the regular expression and the callback, onto the list.
11960 The list can contain several entries if `org-occur' has been called
11961 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11962 will only contain one set of parameters. When the highlights are
11963 removed (for example with `C-c C-c', or with the next edit (depending
11964 on `org-remove-highlights-with-change'), this variable is emptied
11965 as well.")
11966 (make-variable-buffer-local 'org-occur-parameters)
11968 (defun org-occur (regexp &optional keep-previous callback)
11969 "Make a compact tree which shows all matches of REGEXP.
11970 The tree will show the lines where the regexp matches, and all higher
11971 headlines above the match. It will also show the heading after the match,
11972 to make sure editing the matching entry is easy.
11973 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11974 call to `org-occur' will be kept, to allow stacking of calls to this
11975 command.
11976 If CALLBACK is non-nil, it is a function which is called to confirm
11977 that the match should indeed be shown."
11979 (when (equal regexp "")
11980 (error "Regexp cannot be empty"))
11981 (unless keep-previous
11982 (org-remove-occur-highlights nil nil t))
11983 (push (cons regexp callback) org-occur-parameters)
11984 (let ((cnt 0))
11985 (save-excursion
11986 (goto-char (point-min))
11987 (if (or (not keep-previous) ; do not want to keep
11988 (not org-occur-highlights)) ; no previous matches
11989 ;; hide everything
11990 (org-overview))
11991 (while (re-search-forward regexp nil t)
11992 (when (or (not callback)
11993 (save-match-data (funcall callback)))
11994 (setq cnt (1+ cnt))
11995 (when org-highlight-sparse-tree-matches
11996 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11997 (org-show-context 'occur-tree))))
11998 (when org-remove-highlights-with-change
11999 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12000 nil 'local))
12001 (unless org-sparse-tree-open-archived-trees
12002 (org-hide-archived-subtrees (point-min) (point-max)))
12003 (run-hooks 'org-occur-hook)
12004 (if (interactive-p)
12005 (message "%d match(es) for regexp %s" cnt regexp))
12006 cnt))
12008 (defun org-show-context (&optional key)
12009 "Make sure point and context are visible.
12010 How much context is shown depends upon the variables
12011 `org-show-hierarchy-above', `org-show-following-heading'. and
12012 `org-show-siblings'."
12013 (let ((heading-p (org-on-heading-p t))
12014 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12015 (following-p (org-get-alist-option org-show-following-heading key))
12016 (entry-p (org-get-alist-option org-show-entry-below key))
12017 (siblings-p (org-get-alist-option org-show-siblings key)))
12018 (catch 'exit
12019 ;; Show heading or entry text
12020 (if (and heading-p (not entry-p))
12021 (org-flag-heading nil) ; only show the heading
12022 (and (or entry-p (org-invisible-p) (org-invisible-p2))
12023 (org-show-hidden-entry))) ; show entire entry
12024 (when following-p
12025 ;; Show next sibling, or heading below text
12026 (save-excursion
12027 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12028 (org-flag-heading nil))))
12029 (when siblings-p (org-show-siblings))
12030 (when hierarchy-p
12031 ;; show all higher headings, possibly with siblings
12032 (save-excursion
12033 (while (and (condition-case nil
12034 (progn (org-up-heading-all 1) t)
12035 (error nil))
12036 (not (bobp)))
12037 (org-flag-heading nil)
12038 (when siblings-p (org-show-siblings))))))))
12040 (defvar org-reveal-start-hook nil
12041 "Hook run before revealing a location.")
12043 (defun org-reveal (&optional siblings)
12044 "Show current entry, hierarchy above it, and the following headline.
12045 This can be used to show a consistent set of context around locations
12046 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12047 not t for the search context.
12049 With optional argument SIBLINGS, on each level of the hierarchy all
12050 siblings are shown. This repairs the tree structure to what it would
12051 look like when opened with hierarchical calls to `org-cycle'.
12053 go to the parent and show the
12054 entire tree."
12055 (interactive "P")
12056 (run-hooks 'org-reveal-start-hook)
12057 (let ((org-show-hierarchy-above t)
12058 (org-show-following-heading t)
12059 (org-show-siblings (if siblings t org-show-siblings)))
12060 (org-show-context nil))
12061 (when (equal siblings '(16))
12062 (save-excursion
12063 (when (org-up-heading-safe)
12064 (org-show-subtree)
12065 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12067 (defun org-highlight-new-match (beg end)
12068 "Highlight from BEG to END and mark the highlight is an occur headline."
12069 (let ((ov (make-overlay beg end)))
12070 (overlay-put ov 'face 'secondary-selection)
12071 (push ov org-occur-highlights)))
12073 (defun org-remove-occur-highlights (&optional beg end noremove)
12074 "Remove the occur highlights from the buffer.
12075 BEG and END are ignored. If NOREMOVE is nil, remove this function
12076 from the `before-change-functions' in the current buffer."
12077 (interactive)
12078 (unless org-inhibit-highlight-removal
12079 (mapc 'delete-overlay org-occur-highlights)
12080 (setq org-occur-highlights nil)
12081 (setq org-occur-parameters nil)
12082 (unless noremove
12083 (remove-hook 'before-change-functions
12084 'org-remove-occur-highlights 'local))))
12086 ;;;; Priorities
12089 "Regular expression matching the priority indicator.")
12091 (defvar org-remove-priority-next-time nil)
12093 (defun org-priority-up ()
12094 "Increase the priority of the current item."
12095 (interactive)
12096 (org-priority 'up))
12098 (defun org-priority-down ()
12099 "Decrease the priority of the current item."
12100 (interactive)
12101 (org-priority 'down))
12103 (defun org-priority (&optional action)
12104 "Change the priority of an item by ARG.
12105 ACTION can be `set', `up', `down', or a character."
12106 (interactive)
12107 (unless org-enable-priority-commands
12108 (error "Priority commands are disabled"))
12109 (setq action (or action 'set))
12110 (let (current new news have remove)
12111 (save-excursion
12112 (org-back-to-heading t)
12113 (if (looking-at org-priority-regexp)
12114 (setq current (string-to-char (match-string 2))
12115 have t)
12116 (setq current org-default-priority))
12117 (cond
12118 ((eq action 'remove)
12119 (setq remove t new ?\ ))
12120 ((or (eq action 'set)
12121 (if (featurep 'xemacs) (characterp action) (integerp action)))
12122 (if (not (eq action 'set))
12123 (setq new action)
12124 (message "Priority %c-%c, SPC to remove: "
12125 org-highest-priority org-lowest-priority)
12126 (setq new (read-char-exclusive)))
12127 (if (and (= (upcase org-highest-priority) org-highest-priority)
12128 (= (upcase org-lowest-priority) org-lowest-priority))
12129 (setq new (upcase new)))
12130 (cond ((equal new ?\ ) (setq remove t))
12131 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12132 (error "Priority must be between `%c' and `%c'"
12133 org-highest-priority org-lowest-priority))))
12134 ((eq action 'up)
12135 (if (and (not have) (eq last-command this-command))
12136 (setq new org-lowest-priority)
12137 (setq new (if (and org-priority-start-cycle-with-default (not have))
12138 org-default-priority (1- current)))))
12139 ((eq action 'down)
12140 (if (and (not have) (eq last-command this-command))
12141 (setq new org-highest-priority)
12142 (setq new (if (and org-priority-start-cycle-with-default (not have))
12143 org-default-priority (1+ current)))))
12144 (t (error "Invalid action")))
12145 (if (or (< (upcase new) org-highest-priority)
12146 (> (upcase new) org-lowest-priority))
12147 (setq remove t))
12148 (setq news (format "%c" new))
12149 (if have
12150 (if remove
12151 (replace-match "" t t nil 1)
12152 (replace-match news t t nil 2))
12153 (if remove
12154 (error "No priority cookie found in line")
12155 (let ((case-fold-search nil))
12156 (looking-at org-todo-line-regexp))
12157 (if (match-end 2)
12158 (progn
12159 (goto-char (match-end 2))
12160 (insert " [#" news "]"))
12161 (goto-char (match-beginning 3))
12162 (insert "[#" news "] "))))
12163 (org-preserve-lc (org-set-tags nil 'align)))
12164 (if remove
12165 (message "Priority removed")
12166 (message "Priority of current item set to %s" news))))
12168 (defun org-get-priority (s)
12169 "Find priority cookie and return priority."
12170 (save-match-data
12171 (if (not (string-match org-priority-regexp s))
12172 (* 1000 (- org-lowest-priority org-default-priority))
12173 (* 1000 (- org-lowest-priority
12174 (string-to-char (match-string 2 s)))))))
12176 ;;;; Tags
12178 (defvar org-agenda-archives-mode)
12179 (defvar org-map-continue-from nil
12180 "Position from where mapping should continue.
12181 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12183 (defvar org-scanner-tags nil
12184 "The current tag list while the tags scanner is running.")
12185 (defvar org-trust-scanner-tags nil
12186 "Should `org-get-tags-at' use the tags fro the scanner.
12187 This is for internal dynamical scoping only.
12188 When this is non-nil, the function `org-get-tags-at' will return the value
12189 of `org-scanner-tags' instead of building the list by itself. This
12190 can lead to large speed-ups when the tags scanner is used in a file with
12191 many entries, and when the list of tags is retrieved, for example to
12192 obtain a list of properties. Building the tags list for each entry in such
12193 a file becomes an N^2 operation - but with this variable set, it scales
12194 as N.")
12196 (defun org-scan-tags (action matcher &optional todo-only)
12197 "Scan headline tags with inheritance and produce output ACTION.
12199 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12200 or `agenda' to produce an entry list for an agenda view. It can also be
12201 a Lisp form or a function that should be called at each matched headline, in
12202 this case the return value is a list of all return values from these calls.
12204 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12205 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12206 only lines with a TODO keyword are included in the output."
12207 (require 'org-agenda)
12210 (org-re
12212 (props (list 'face 'default
12213 'done-face 'org-agenda-done
12214 'undone-face 'default
12215 'mouse-face 'highlight
12216 'org-not-done-regexp org-not-done-regexp
12217 'org-todo-regexp org-todo-regexp
12218 'help-echo
12219 (format "mouse-2 or RET jump to org file %s"
12220 (abbreviate-file-name
12221 (or (buffer-file-name (buffer-base-buffer))
12222 (buffer-name (buffer-base-buffer)))))))
12223 (case-fold-search nil)
12224 (org-map-continue-from nil)
12225 lspos tags tags-list
12226 (tags-alist (list (cons 0 org-file-tags)))
12227 (llast 0) rtn rtn1 level category i txt
12228 todo marker entry priority)
12229 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12230 (setq action (list 'lambda nil action)))
12231 (save-excursion
12232 (goto-char (point-min))
12233 (when (eq action 'sparse-tree)
12234 (org-overview)
12235 (org-remove-occur-highlights))
12236 (while (re-search-forward re nil t)
12237 (catch :skip
12238 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12239 tags (if (match-end 4) (org-match-string-no-properties 4)))
12240 (goto-char (setq lspos (match-beginning 0)))
12241 (setq level (org-reduced-level (funcall outline-level))
12242 category (org-get-category))
12243 (setq i llast llast level)
12244 ;; remove tag lists from same and sublevels
12245 (while (>= i level)
12246 (when (setq entry (assoc i tags-alist))
12247 (setq tags-alist (delete entry tags-alist)))
12248 (setq i (1- i)))
12249 ;; add the next tags
12250 (when tags
12251 (setq tags (org-split-string tags ":")
12252 tags-alist
12253 (cons (cons level tags) tags-alist)))
12254 ;; compile tags for current headline
12255 (setq tags-list
12256 (if org-use-tag-inheritance
12257 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12258 tags)
12259 org-scanner-tags tags-list)
12260 (when org-use-tag-inheritance
12261 (setcdr (car tags-alist)
12262 (mapcar (lambda (x)
12263 (setq x (copy-sequence x))
12264 (org-add-prop-inherited x))
12265 (cdar tags-alist))))
12266 (when (and tags org-use-tag-inheritance
12267 (or (not (eq t org-use-tag-inheritance))
12268 org-tags-exclude-from-inheritance))
12269 ;; selective inheritance, remove uninherited ones
12270 (setcdr (car tags-alist)
12271 (org-remove-uniherited-tags (cdar tags-alist))))
12272 (when (and (or (not todo-only)
12273 (and (member todo org-not-done-keywords)
12274 (or (not org-agenda-tags-todo-honor-ignore-options)
12275 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12276 (let ((case-fold-search t)) (eval matcher))
12277 (or
12278 (not (member org-archive-tag tags-list))
12279 ;; we have an archive tag, should we use this anyway?
12280 (or (not org-agenda-skip-archived-trees)
12281 (and (eq action 'agenda) org-agenda-archives-mode))))
12282 (unless (eq action 'sparse-tree) (org-agenda-skip))
12284 ;; select this headline
12286 (cond
12287 ((eq action 'sparse-tree)
12288 (and org-highlight-sparse-tree-matches
12289 (org-get-heading) (match-end 0)
12290 (org-highlight-new-match
12291 (match-beginning 0) (match-beginning 1)))
12292 (org-show-context 'tags-tree))
12293 ((eq action 'agenda)
12294 (setq txt (org-format-agenda-item
12295 ""
12296 (concat
12297 (if (eq org-tags-match-list-sublevels 'indented)
12298 (make-string (1- level) ?.) "")
12299 (org-get-heading))
12300 category
12301 tags-list
12302 )
12303 priority (org-get-priority txt))
12304 (goto-char lspos)
12305 (setq marker (org-agenda-new-marker))
12306 (org-add-props txt props
12307 'org-marker marker 'org-hd-marker marker 'org-category category
12308 'todo-state todo
12309 'priority priority 'type "tagsmatch")
12310 (push txt rtn))
12311 ((functionp action)
12312 (setq org-map-continue-from nil)
12313 (save-excursion
12314 (setq rtn1 (funcall action))
12315 (push rtn1 rtn)))
12316 (t (error "Invalid action")))
12318 ;; if we are to skip sublevels, jump to end of subtree
12319 (unless org-tags-match-list-sublevels
12320 (org-end-of-subtree t)
12321 (backward-char 1))))
12322 ;; Get the correct position from where to continue
12323 (if org-map-continue-from
12324 (goto-char org-map-continue-from)
12325 (and (= (point) lspos) (end-of-line 1)))))
12326 (when (and (eq action 'sparse-tree)
12327 (not org-sparse-tree-open-archived-trees))
12328 (org-hide-archived-subtrees (point-min) (point-max)))
12329 (nreverse rtn)))
12331 (defun org-remove-uniherited-tags (tags)
12332 "Remove all tags that are not inherited from the list TAGS."
12333 (cond
12334 ((eq org-use-tag-inheritance t)
12335 (if org-tags-exclude-from-inheritance
12336 (org-delete-all org-tags-exclude-from-inheritance tags)
12337 tags))
12338 ((not org-use-tag-inheritance) nil)
12339 ((stringp org-use-tag-inheritance)
12340 (delq nil (mapcar
12341 (lambda (x)
12342 (if (and (string-match org-use-tag-inheritance x)
12343 (not (member x org-tags-exclude-from-inheritance)))
12344 x nil))
12345 tags)))
12346 ((listp org-use-tag-inheritance)
12347 (delq nil (mapcar
12348 (lambda (x)
12349 (if (member x org-use-tag-inheritance) x nil))
12350 tags)))))
12352 (defvar todo-only) ;; dynamically scoped
12354 (defun org-match-sparse-tree (&optional todo-only match)
12355 "Create a sparse tree according to tags string MATCH.
12356 MATCH can contain positive and negative selection of tags, like
12358 If optional argument TODO-ONLY is non-nil, only select lines that are
12359 also TODO lines."
12360 (interactive "P")
12361 (org-prepare-agenda-buffers (list (current-buffer)))
12362 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12364 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12366 (defvar org-cached-props nil)
12367 (defun org-cached-entry-get (pom property)
12368 (if (or (eq t org-use-property-inheritance)
12369 (and (stringp org-use-property-inheritance)
12370 (string-match org-use-property-inheritance property))
12371 (and (listp org-use-property-inheritance)
12372 (member property org-use-property-inheritance)))
12373 ;; Caching is not possible, check it directly
12374 (org-entry-get pom property 'inherit)
12375 ;; Get all properties, so that we can do complicated checks easily
12376 (cdr (assoc property (or org-cached-props
12377 (setq org-cached-props
12378 (org-entry-properties pom)))))))
12380 (defun org-global-tags-completion-table (&optional files)
12381 "Return the list of all tags in all agenda buffer/files."
12382 (save-excursion
12383 (org-uniquify
12384 (delq nil
12385 (apply 'append
12386 (mapcar
12387 (lambda (file)
12388 (set-buffer (find-file-noselect file))
12389 (append (org-get-buffer-tags)
12390 (mapcar (lambda (x) (if (stringp (car-safe x))
12391 (list (car-safe x)) nil))
12392 org-tag-alist)))
12393 (if (and files (car files))
12394 files
12395 (org-agenda-files))))))))
12397 (defun org-make-tags-matcher (match)
12398 "Create the TAGS//TODO matcher form for the selection string MATCH."
12399 ;; todo-only is scoped dynamically into this function, and the function
12400 ;; may change it if the matcher asks for it.
12401 (unless match
12402 ;; Get a new match request, with completion
12403 (let ((org-last-tags-completion-table
12404 (org-global-tags-completion-table)))
12405 (setq match (org-completing-read-no-i
12406 "Match: " 'org-tags-completion-function nil nil nil
12407 'org-tags-history))))
12409 ;; Parse the string and create a lisp form
12410 (let ((match0 match)
12411 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
12412 minus tag mm
12413 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12414 orterms term orlist re-p str-p level-p level-op time-p
12415 prop-p pn pv po cat-p gv rest)
12416 (if (string-match "/+" match)
12417 ;; match contains also a todo-matching request
12418 (progn
12419 (setq tagsmatch (substring match 0 (match-beginning 0))
12420 todomatch (substring match (match-end 0)))
12421 (if (string-match "^!" todomatch)
12422 (setq todo-only t todomatch (substring todomatch 1)))
12424 (setq todomatch nil)))
12425 ;; only matching tags
12426 (setq tagsmatch match todomatch nil))
12428 ;; Make the tags matcher
12430 (setq tagsmatcher t)
12431 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12432 (while (setq term (pop orterms))
12434 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12435 (while (string-match re term)
12436 (setq rest (substring term (match-end 0))
12437 minus (and (match-end 1)
12438 (equal (match-string 1 term) "-"))
12439 tag (match-string 2 term)
12440 re-p (equal (string-to-char tag) ?{)
12441 level-p (match-end 4)
12442 prop-p (match-end 5)
12443 mm (cond
12444 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12445 (level-p
12446 (setq level-op (org-op-to-function (match-string 3 term)))
12447 `(,level-op level ,(string-to-number
12448 (match-string 4 term))))
12449 (prop-p
12450 (setq pn (match-string 5 term)
12451 po (match-string 6 term)
12452 pv (match-string 7 term)
12453 cat-p (equal pn "CATEGORY")
12454 re-p (equal (string-to-char pv) ?{)
12456 time-p (save-match-data
12458 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12459 (if time-p (setq pv (org-matcher-time pv)))
12460 (setq po (org-op-to-function po (if time-p 'time str-p)))
12461 (cond
12462 ((equal pn "CATEGORY")
12463 (setq gv '(get-text-property (point) 'org-category)))
12464 ((equal pn "TODO")
12465 (setq gv 'todo))
12466 (t
12467 (setq gv `(org-cached-entry-get nil ,pn))))
12468 (if re-p
12469 (if (eq po 'org<>)
12470 `(not (string-match ,pv (or ,gv "")))
12471 `(string-match ,pv (or ,gv "")))
12472 (if str-p
12473 `(,po (or ,gv "") ,pv)
12474 `(,po (string-to-number (or ,gv ""))
12475 ,(string-to-number pv) ))))
12476 (t `(member ,tag tags-list)))
12477 mm (if minus (list 'not mm) mm)
12478 term rest)
12479 (push mm tagsmatcher))
12480 (push (if (> (length tagsmatcher) 1)
12481 (cons 'and tagsmatcher)
12482 (car tagsmatcher))
12483 orlist)
12484 (setq tagsmatcher nil))
12485 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12486 (setq tagsmatcher
12487 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12488 ;; Make the todo matcher
12490 (setq todomatcher t)
12491 (setq orterms (org-split-string todomatch "|") orlist nil)
12492 (while (setq term (pop orterms))
12493 (while (string-match re term)
12494 (setq minus (and (match-end 1)
12495 (equal (match-string 1 term) "-"))
12496 kwd (match-string 2 term)
12497 re-p (equal (string-to-char kwd) ?{)
12498 term (substring term (match-end 0))
12499 mm (if re-p
12500 `(string-match ,(substring kwd 1 -1) todo)
12501 (list 'equal 'todo kwd))
12502 mm (if minus (list 'not mm) mm))
12503 (push mm todomatcher))
12504 (push (if (> (length todomatcher) 1)
12505 (cons 'and todomatcher)
12506 (car todomatcher))
12507 orlist)
12508 (setq todomatcher nil))
12509 (setq todomatcher (if (> (length orlist) 1)
12510 (cons 'or orlist) (car orlist))))
12512 ;; Return the string and lisp forms of the matcher
12513 (setq matcher (if todomatcher
12514 (list 'and tagsmatcher todomatcher)
12515 tagsmatcher))
12516 (cons match0 matcher)))
12518 (defun org-op-to-function (op &optional stringp)
12519 "Turn an operator into the appropriate function."
12520 (setq op
12521 (cond
12522 ((equal op "<" ) '(< string< org-time<))
12523 ((equal op ">" ) '(> org-string> org-time>))
12524 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12525 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12526 ((member op '("=" "==")) '(= string= org-time=))
12527 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12528 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12530 (defun org<> (a b) (not (= a b)))
12531 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12532 (defun org-string>= (a b) (not (string< a b)))
12533 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12534 (defun org-string<> (a b) (not (string= a b)))
12535 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12536 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12537 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12538 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12539 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12540 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12541 (defun org-2ft (s)
12542 "Convert S to a floating point time.
12543 If S is already a number, just return it. If it is a string, parse
12544 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12545 (cond
12546 ((numberp s) s)
12547 ((stringp s)
12548 (condition-case nil
12549 (float-time (apply 'encode-time (org-parse-time-string s)))
12550 (error 0.)))
12551 (t 0.)))
12553 (defun org-time-today ()
12554 "Time in seconds today at 0:00.
12555 Returns the float number of seconds since the beginning of the
12556 epoch to the beginning of today (00:00)."
12557 (float-time (apply 'encode-time
12558 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12560 (defun org-matcher-time (s)
12561 "Interpret a time comparison value."
12562 (save-match-data
12563 (cond
12564 ((string= s "<now>") (float-time))
12565 ((string= s "<today>") (org-time-today))
12566 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12567 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12569 (+ (org-time-today)
12570 (* (string-to-number (match-string 1 s))
12571 (cdr (assoc (match-string 2 s)
12572 '(("d" . 86400.0) ("w" . 604800.0)
12573 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12574 (t (org-2ft s)))))
12576 (defun org-match-any-p (re list)
12577 "Does re match any element of list?"
12578 (setq list (mapcar (lambda (x) (string-match re x)) list))
12579 (delq nil list))
12581 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12582 (defvar org-tags-overlay (make-overlay 1 1))
12583 (org-detach-overlay org-tags-overlay)
12585 (defun org-get-local-tags-at (&optional pos)
12586 "Get a list of tags defined in the current headline."
12587 (org-get-tags-at pos 'local))
12589 (defun org-get-local-tags ()
12590 "Get a list of tags defined in the current headline."
12591 (org-get-tags-at nil 'local))
12593 (defun org-get-tags-at (&optional pos local)
12594 "Get a list of all headline tags applicable at POS.
12595 POS defaults to point. If tags are inherited, the list contains
12596 the targets in the same sequence as the headlines appear, i.e.
12597 the tags of the current headline come last.
12598 When LOCAL is non-nil, only return tags from the current headline,
12599 ignore inherited ones."
12600 (interactive)
12601 (if (and org-trust-scanner-tags
12602 (or (not pos) (equal pos (point)))
12603 (not local))
12604 org-scanner-tags
12605 (let (tags ltags lastpos parent)
12606 (save-excursion
12607 (save-restriction
12608 (widen)
12609 (goto-char (or pos (point)))
12610 (save-match-data
12611 (catch 'done
12612 (condition-case nil
12613 (progn
12614 (org-back-to-heading t)
12615 (while (not (equal lastpos (point)))
12616 (setq lastpos (point))
12617 (when (looking-at
12619 (setq ltags (org-split-string
12620 (org-match-string-no-properties 1) ":"))
12621 (when parent
12622 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12623 (setq tags (append
12624 (if parent
12625 (org-remove-uniherited-tags ltags)
12626 ltags)
12627 tags)))
12628 (or org-use-tag-inheritance (throw 'done t))
12629 (if local (throw 'done t))
12630 (or (org-up-heading-safe) (error nil))
12631 (setq parent t)))
12632 (error nil)))))
12633 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12635 (defun org-add-prop-inherited (s)
12636 (add-text-properties 0 (length s) '(inherited t) s)
12637 s)
12639 (defun org-toggle-tag (tag &optional onoff)
12640 "Toggle the tag TAG for the current line.
12641 If ONOFF is `on' or `off', don't toggle but set to this state."
12642 (let (res current)
12643 (save-excursion
12644 (org-back-to-heading t)
12646 (point-at-eol) t)
12647 (progn
12648 (setq current (match-string 1))
12649 (replace-match ""))
12650 (setq current ""))
12651 (setq current (nreverse (org-split-string current ":")))
12652 (cond
12653 ((eq onoff 'on)
12654 (setq res t)
12655 (or (member tag current) (push tag current)))
12656 ((eq onoff 'off)
12657 (or (not (member tag current)) (setq current (delete tag current))))
12658 (t (if (member tag current)
12659 (setq current (delete tag current))
12660 (setq res t)
12661 (push tag current))))
12662 (end-of-line 1)
12663 (if current
12664 (progn
12665 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12666 (org-set-tags nil t))
12667 (delete-horizontal-space))
12668 (run-hooks 'org-after-tags-change-hook))
12669 res))
12671 (defun org-align-tags-here (to-col)
12672 ;; Assumes that this is a headline
12673 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12674 (beginning-of-line 1)
12676 (< pos (match-beginning 2)))
12677 (progn
12678 (setq tags-l (- (match-end 2) (match-beginning 2)))
12679 (goto-char (match-beginning 1))
12680 (insert " ")
12681 (delete-region (point) (1+ (match-beginning 2)))
12682 (setq ncol (max (1+ (current-column))
12683 (1+ col)
12684 (if (> to-col 0)
12685 to-col
12686 (- (abs to-col) tags-l))))
12687 (setq p (point))
12688 (insert (make-string (- ncol (current-column)) ?\ ))
12689 (setq ncol (current-column))
12690 (when indent-tabs-mode (tabify p (point-at-eol)))
12691 (org-move-to-column (min ncol col) t))
12692 (goto-char pos))))
12694 (defun org-set-tags-command (&optional arg just-align)
12695 "Call the set-tags command for the current entry."
12696 (interactive "P")
12697 (if (org-on-heading-p)
12698 (org-set-tags arg just-align)
12699 (save-excursion
12700 (org-back-to-heading t)
12701 (org-set-tags arg just-align))))
12703 (defun org-set-tags-to (data)
12704 "Set the tags of the current entry to DATA, replacing the current tags.
12705 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12706 If DATA is nil or the empty string, any tags will be removed."
12707 (interactive "sTags: ")
12708 (setq data
12709 (cond
12710 ((eq data nil) "")
12711 ((equal data "") "")
12712 ((stringp data)
12713 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12714 ":"))
12715 ((listp data)
12716 (concat ":" (mapconcat 'identity data ":") ":"))
12717 (t nil)))
12718 (when data
12719 (save-excursion
12720 (org-back-to-heading t)
12721 (when (looking-at org-complex-heading-regexp)
12722 (if (match-end 5)
12723 (progn
12724 (goto-char (match-beginning 5))
12725 (insert data)
12726 (delete-region (point) (point-at-eol))
12727 (org-set-tags nil 'align))
12728 (goto-char (point-at-eol))
12729 (insert " " data)
12730 (org-set-tags nil 'align)))
12731 (beginning-of-line 1)
12733 (delete-region (match-beginning 1) (match-end 1))))))
12735 (defun org-align-all-tags ()
12736 "Align the tags i all headings."
12737 (interactive)
12738 (save-excursion
12739 (or (ignore-errors (org-back-to-heading t))
12740 (outline-next-heading))
12741 (if (org-on-heading-p)
12742 (org-set-tags t)
12743 (message "No headings"))))
12745 (defun org-set-tags (&optional arg just-align)
12746 "Set the tags for the current headline.
12747 With prefix ARG, realign all tags in headings in the current buffer."
12748 (interactive "P")
12749 (let* ((re (concat "^" outline-regexp))
12750 (current (org-get-tags-string))
12751 (col (current-column))
12752 (org-setting-tags t)
12753 table current-tags inherited-tags ; computed below when needed
12754 tags p0 c0 c1 rpl)
12755 (if arg
12756 (save-excursion
12757 (goto-char (point-min))
12758 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12759 (while (re-search-forward re nil t)
12760 (org-set-tags nil t)
12761 (end-of-line 1)))
12762 (message "All tags realigned to column %d" org-tags-column))
12763 (if just-align
12764 (setq tags current)
12765 ;; Get a new set of tags from the user
12766 (save-excursion
12767 (setq table (append org-tag-persistent-alist
12768 (or org-tag-alist (org-get-buffer-tags))
12769 (and org-complete-tags-always-offer-all-agenda-tags
12770 (org-global-tags-completion-table (org-agenda-files))))
12771 org-last-tags-completion-table table
12772 current-tags (org-split-string current ":")
12773 inherited-tags (nreverse
12774 (nthcdr (length current-tags)
12775 (nreverse (org-get-tags-at))))
12776 tags
12777 (if (or (eq t org-use-fast-tag-selection)
12778 (and org-use-fast-tag-selection
12779 (delq nil (mapcar 'cdr table))))
12780 (org-fast-tag-selection
12781 current-tags inherited-tags table
12782 (if org-fast-tag-selection-include-todo org-todo-key-alist))
12783 (let ((org-add-colon-after-tag-completion t))
12784 (org-trim
12785 (org-without-partial-completion
12786 (org-icompleting-read "Tags: " 'org-tags-completion-function
12787 nil nil current 'org-tags-history)))))))
12788 (while (string-match "[-+&]+" tags)
12789 ;; No boolean logic, just a list
12790 (setq tags (replace-match ":" t t tags))))
12792 (if org-tags-sort-function
12793 (setq tags (mapconcat 'identity
12794 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
12795 org-tags-sort-function) ":")))
12798 (setq tags "")
12799 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12800 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12802 ;; Insert new tags at the correct column
12803 (beginning-of-line 1)
12804 (cond
12805 ((and (equal current "") (equal tags "")))
12806 ((re-search-forward
12808 (point-at-eol) t)
12809 (if (equal tags "")
12810 (setq rpl "")
12811 (goto-char (match-beginning 0))
12812 (setq c0 (current-column) p0 (if (equal (char-before) ?*)
12813 (1+ (point)) (point))
12814 c1 (max (1+ c0) (if (> org-tags-column 0)
12815 org-tags-column
12816 (- (- org-tags-column) (length tags))))
12817 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12818 (replace-match rpl t t)
12819 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12820 tags)
12821 (t (error "Tags alignment failed")))
12822 (org-move-to-column col)
12823 (unless just-align
12824 (run-hooks 'org-after-tags-change-hook)))))
12826 (defun org-change-tag-in-region (beg end tag off)
12827 "Add or remove TAG for each entry in the region.
12828 This works in the agenda, and also in an org-mode buffer."
12829 (interactive
12830 (list (region-beginning) (region-end)
12831 (let ((org-last-tags-completion-table
12832 (if (org-mode-p)
12833 (org-get-buffer-tags)
12834 (org-global-tags-completion-table))))
12835 (org-icompleting-read
12836 "Tag: " 'org-tags-completion-function nil nil nil
12837 'org-tags-history))
12838 (progn
12839 (message "[s]et or [r]emove? ")
12840 (equal (read-char-exclusive) ?r))))
12841 (if (fboundp 'deactivate-mark) (deactivate-mark))
12842 (let ((agendap (equal major-mode 'org-agenda-mode))
12843 l1 l2 m buf pos newhead (cnt 0))
12844 (goto-char end)
12845 (setq l2 (1- (org-current-line)))
12846 (goto-char beg)
12847 (setq l1 (org-current-line))
12848 (loop for l from l1 to l2 do
12849 (org-goto-line l)
12850 (setq m (get-text-property (point) 'org-hd-marker))
12851 (when (or (and (org-mode-p) (org-on-heading-p))
12852 (and agendap m))
12853 (setq buf (if agendap (marker-buffer m) (current-buffer))
12854 pos (if agendap m (point)))
12855 (with-current-buffer buf
12856 (save-excursion
12857 (save-restriction
12858 (goto-char pos)
12859 (setq cnt (1+ cnt))
12860 (org-toggle-tag tag (if off 'off 'on))
12861 (setq newhead (org-get-heading)))))
12862 (and agendap (org-agenda-change-all-lines newhead m))))
12863 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12865 (defun org-tags-completion-function (string predicate &optional flag)
12866 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12867 (confirm (lambda (x) (stringp (car x)))))
12869 (setq s1 (match-string 1 string)
12870 s2 (match-string 2 string))
12871 (setq s1 "" s2 string))
12872 (cond
12873 ((eq flag nil)
12874 ;; try completion
12875 (setq rtn (try-completion s2 ctable confirm))
12876 (if (stringp rtn)
12877 (setq rtn
12878 (concat s1 s2 (substring rtn (length s2))
12879 (if (and org-add-colon-after-tag-completion
12880 (assoc rtn ctable))
12881 ":" ""))))
12882 rtn)
12883 ((eq flag t)
12884 ;; all-completions
12885 (all-completions s2 ctable confirm)
12886 )
12887 ((eq flag 'lambda)
12888 ;; exact match?
12889 (assoc s2 ctable)))
12890 ))
12892 (defun org-fast-tag-insert (kwd tags face &optional end)
12893 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12894 (insert (format "%-12s" (concat kwd ":"))
12895 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12896 (or end "")))
12898 (defun org-fast-tag-show-exit (flag)
12899 (save-excursion
12900 (org-goto-line 3)
12902 (replace-match ""))
12903 (when flag
12904 (end-of-line 1)
12905 (org-move-to-column (- (window-width) 19) t)
12906 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12908 (defun org-set-current-tags-overlay (current prefix)
12909 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12910 (if (featurep 'xemacs)
12911 (org-overlay-display org-tags-overlay (concat prefix s)
12912 'secondary-selection)
12913 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12914 (org-overlay-display org-tags-overlay (concat prefix s)))))
12916 (defvar org-last-tag-selection-key nil)
12917 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12918 "Fast tag selection with single keys.
12919 CURRENT is the current list of tags in the headline, INHERITED is the
12920 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12921 possibly with grouping information. TODO-TABLE is a similar table with
12922 TODO keywords, should these have keys assigned to them.
12923 If the keys are nil, a-z are automatically assigned.
12924 Returns the new tags string, or nil to not change the current settings."
12925 (let* ((fulltable (append table todo-table))
12926 (maxlen (apply 'max (mapcar
12927 (lambda (x)
12928 (if (stringp (car x)) (string-width (car x)) 0))
12929 fulltable)))
12930 (buf (current-buffer))
12931 (expert (eq org-fast-tag-selection-single-key 'expert))
12932 (buffer-tags nil)
12933 (fwidth (+ maxlen 3 1 3))
12934 (ncol (/ (- (window-width) 4) fwidth))
12935 (i-face 'org-done)
12936 (c-face 'org-todo)
12937 tg cnt e c char c1 c2 ntable tbl rtn
12938 ov-start ov-end ov-prefix
12939 (exit-after-next org-fast-tag-selection-single-key)
12940 (done-keywords org-done-keywords)
12941 groups ingroup)
12942 (save-excursion
12943 (beginning-of-line 1)
12944 (if (looking-at
12946 (setq ov-start (match-beginning 1)
12947 ov-end (match-end 1)
12948 ov-prefix "")
12949 (setq ov-start (1- (point-at-eol))
12950 ov-end (1+ ov-start))
12952 (setq ov-prefix
12953 (concat
12954 (buffer-substring (1- (point)) (point))
12955 (if (> (current-column) org-tags-column)
12956 " "
12957 (make-string (- org-tags-column (current-column)) ?\ ))))))
12958 (move-overlay org-tags-overlay ov-start ov-end)
12959 (save-window-excursion
12960 (if expert
12961 (set-buffer (get-buffer-create " *Org tags*"))
12962 (delete-other-windows)
12963 (split-window-vertically)
12964 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12965 (erase-buffer)
12966 (org-set-local 'org-done-keywords done-keywords)
12969 (org-fast-tag-show-exit exit-after-next)
12970 (org-set-current-tags-overlay current ov-prefix)
12971 (setq tbl fulltable char ?a cnt 0)
12972 (while (setq e (pop tbl))
12973 (cond
12974 ((equal (car e) :startgroup)
12975 (push '() groups) (setq ingroup t)
12976 (when (not (= cnt 0))
12977 (setq cnt 0)
12979 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12980 ((equal (car e) :endgroup)
12981 (setq ingroup nil cnt 0)
12983 ((equal e '(:newline))
12984 (when (not (= cnt 0))
12985 (setq cnt 0)
12987 (setq e (car tbl))
12988 (while (equal (car tbl) '(:newline))
12990 (setq tbl (cdr tbl)))))
12991 (t
12992 (setq tg (copy-sequence (car e)) c2 nil)
12993 (if (cdr e)
12994 (setq c (cdr e))
12995 ;; automatically assign a character.
12996 (setq c1 (string-to-char
12997 (downcase (substring
12998 tg (if (= (string-to-char tg) ?@) 1 0)))))
12999 (if (or (rassoc c1 ntable) (rassoc c1 table))
13000 (while (or (rassoc char ntable) (rassoc char table))
13001 (setq char (1+ char)))
13002 (setq c2 c1))
13003 (setq c (or c2 char)))
13004 (if ingroup (push tg (car groups)))
13005 (setq tg (org-add-props tg nil 'face
13006 (cond
13007 ((not (assoc tg table))
13008 (org-get-todo-face tg))
13009 ((member tg current) c-face)
13010 ((member tg inherited) i-face)
13011 (t nil))))
13012 (if (and (= cnt 0) (not ingroup)) (insert " "))
13013 (insert "[" c "] " tg (make-string
13014 (- fwidth 4 (length tg)) ?\ ))
13015 (push (cons tg c) ntable)
13016 (when (= (setq cnt (1+ cnt)) ncol)
13018 (if ingroup (insert " "))
13019 (setq cnt 0)))))
13020 (setq ntable (nreverse ntable))
13022 (goto-char (point-min))
13023 (if (not expert) (org-fit-window-to-buffer))
13024 (setq rtn
13025 (catch 'exit
13026 (while t
13027 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13028 (if (not groups) "no " "")
13029 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13030 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13031 (setq org-last-tag-selection-key c)
13032 (cond
13034 ((= c ?!)
13035 (setq groups (not groups))
13036 (goto-char (point-min))
13037 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13038 ((= c ?\C-c)
13039 (if (not expert)
13040 (org-fast-tag-show-exit
13041 (setq exit-after-next (not exit-after-next)))
13042 (setq expert nil)
13043 (delete-other-windows)
13044 (split-window-vertically)
13045 (org-switch-to-buffer-other-window " *Org tags*")
13046 (org-fit-window-to-buffer)))
13047 ((or (= c ?\C-g)
13048 (and (= c ?q) (not (rassoc c ntable))))
13049 (org-detach-overlay org-tags-overlay)
13050 (setq quit-flag t))
13051 ((= c ?\ )
13052 (setq current nil)
13053 (if exit-after-next (setq exit-after-next 'now)))
13055 (condition-case nil
13056 (setq tg (org-icompleting-read
13057 "Tag: "
13058 (or buffer-tags
13059 (with-current-buffer buf
13060 (org-get-buffer-tags)))))
13061 (quit (setq tg "")))
13063 (add-to-list 'buffer-tags (list tg))
13064 (if (member tg current)
13065 (setq current (delete tg current))
13066 (push tg current)))
13067 (if exit-after-next (setq exit-after-next 'now)))
13068 ((setq e (rassoc c todo-table) tg (car e))
13069 (with-current-buffer buf
13070 (save-excursion (org-todo tg)))
13071 (if exit-after-next (setq exit-after-next 'now)))
13072 ((setq e (rassoc c ntable) tg (car e))
13073 (if (member tg current)
13074 (setq current (delete tg current))
13075 (loop for g in groups do
13076 (if (member tg g)
13077 (mapc (lambda (x)
13078 (setq current (delete x current)))
13079 g)))
13080 (push tg current))
13081 (if exit-after-next (setq exit-after-next 'now))))
13083 ;; Create a sorted list
13084 (setq current
13085 (sort current
13086 (lambda (a b)
13087 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13088 (if (eq exit-after-next 'now) (throw 'exit t))
13089 (goto-char (point-min))
13090 (beginning-of-line 2)
13091 (delete-region (point) (point-at-eol))
13092 (org-fast-tag-insert "Current" current c-face)
13093 (org-set-current-tags-overlay current ov-prefix)
13094 (while (re-search-forward
13096 (setq tg (match-string 1))
13097 (add-text-properties
13098 (match-beginning 1) (match-end 1)
13099 (list 'face
13100 (cond
13101 ((member tg current) c-face)
13102 ((member tg inherited) i-face)
13103 (t (get-text-property (match-beginning 1) 'face))))))
13104 (goto-char (point-min)))))
13105 (org-detach-overlay org-tags-overlay)
13106 (if rtn
13107 (mapconcat 'identity current ":")
13108 nil))))
13110 (defun org-get-tags-string ()
13111 "Get the TAGS string in the current headline."
13112 (unless (org-on-heading-p t)
13113 (error "Not on a heading"))
13114 (save-excursion
13115 (beginning-of-line 1)
13117 (org-match-string-no-properties 1)
13118 "")))
13120 (defun org-get-tags ()
13121 "Get the list of tags specified in the current headline."
13122 (org-split-string (org-get-tags-string) ":"))
13124 (defun org-get-buffer-tags ()
13125 "Get a table of all tags used in the buffer, for completion."
13126 (let (tags)
13127 (save-excursion
13128 (goto-char (point-min))
13129 (while (re-search-forward
13131 (when (equal (char-after (point-at-bol 0)) ?*)
13132 (mapc (lambda (x) (add-to-list 'tags x))
13133 (org-split-string (org-match-string-no-properties 1) ":")))))
13134 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13135 (mapcar 'list tags)))
13137 ;;;; The mapping API
13139 ;;;###autoload
13140 (defun org-map-entries (func &optional match scope &rest skip)
13141 "Call FUNC at each headline selected by MATCH in SCOPE.
13143 FUNC is a function or a lisp form. The function will be called without
13144 arguments, with the cursor positioned at the beginning of the headline.
13145 The return values of all calls to the function will be collected and
13146 returned as a list.
13148 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13149 does not need to preserve point. After evaluation, the cursor will be
13150 moved to the end of the line (presumably of the headline of the
13151 processed entry) and search continues from there. Under some
13152 circumstances, this may not produce the wanted results. For example,
13153 if you have removed (e.g. archived) the current (sub)tree it could
13154 mean that the next entry will be skipped entirely. In such cases, you
13155 can specify the position from where search should continue by making
13156 FUNC set the variable `org-map-continue-from' to the desired buffer
13157 position.
13159 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13160 Only headlines that are matched by this query will be considered during
13161 the iteration. When MATCH is nil or t, all headlines will be
13162 visited by the iteration.
13164 SCOPE determines the scope of this command. It can be any of:
13166 nil The current buffer, respecting the restriction if any
13167 tree The subtree started with the entry at point
13168 file The current buffer, without restriction
13169 file-with-archives
13170 The current buffer, and any archives associated with it
13171 agenda All agenda files
13172 agenda-with-archives
13173 All agenda files with any archive files associated with them
13174 \(file1 file2 ...)
13175 If this is a list, all files in the list will be scanned
13177 The remaining args are treated as settings for the skipping facilities of
13178 the scanner. The following items can be given here:
13180 archive skip trees with the archive tag.
13181 comment skip trees with the COMMENT keyword
13182 function or Emacs Lisp form:
13183 will be used as value for `org-agenda-skip-function', so whenever
13184 the function returns t, FUNC will not be called for that
13185 entry and search will continue from the point where the
13186 function leaves it.
13188 If your function needs to retrieve the tags including inherited tags
13189 at the *current* entry, you can use the value of the variable
13190 `org-scanner-tags' which will be much faster than getting the value
13191 with `org-get-tags-at'. If your function gets properties with
13192 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13193 to t around the call to `org-entry-properties' to get the same speedup.
13194 Note that if your function moves around to retrieve tags and properties at
13195 a *different* entry, you cannot use these techniques."
13196 (let* ((org-agenda-archives-mode nil) ; just to make sure
13197 (org-agenda-skip-archived-trees (memq 'archive skip))
13198 (org-agenda-skip-comment-trees (memq 'comment skip))
13199 (org-agenda-skip-function
13200 (car (org-delete-all '(comment archive) skip)))
13201 (org-tags-match-list-sublevels t)
13202 matcher file res
13203 org-todo-keywords-for-agenda
13204 org-done-keywords-for-agenda
13205 org-todo-keyword-alist-for-agenda
13206 org-drawers-for-agenda
13207 org-tag-alist-for-agenda)
13209 (cond
13210 ((eq match t) (setq matcher t))
13211 ((eq match nil) (setq matcher t))
13212 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13214 (save-excursion
13215 (save-restriction
13216 (when (eq scope 'tree)
13217 (org-back-to-heading t)
13218 (org-narrow-to-subtree)
13219 (setq scope nil))
13221 (if (not scope)
13222 (progn
13223 (org-prepare-agenda-buffers
13224 (list (buffer-file-name (current-buffer))))
13225 (setq res (org-scan-tags func matcher)))
13226 ;; Get the right scope
13227 (cond
13228 ((and scope (listp scope) (symbolp (car scope)))
13229 (setq scope (eval scope)))
13230 ((eq scope 'agenda)
13231 (setq scope (org-agenda-files t)))
13232 ((eq scope 'agenda-with-archives)
13233 (setq scope (org-agenda-files t))
13234 (setq scope (org-add-archive-files scope)))
13235 ((eq scope 'file)
13236 (setq scope (list (buffer-file-name))))
13237 ((eq scope 'file-with-archives)
13238 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13239 (org-prepare-agenda-buffers scope)
13240 (while (setq file (pop scope))
13241 (with-current-buffer (org-find-base-buffer-visiting file)
13242 (save-excursion
13243 (save-restriction
13244 (widen)
13245 (goto-char (point-min))
13246 (setq res (append res (org-scan-tags func matcher))))))))))
13247 res))
13249 ;;;; Properties
13251 ;;; Setting and retrieving properties
13253 (defconst org-special-properties
13254 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13255 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13256 "The special properties valid in Org-mode.
13258 These are properties that are not defined in the property drawer,
13259 but in some other way.")
13261 (defconst org-default-properties
13262 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13263 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13264 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13265 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13266 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13267 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13268 "Some properties that are used by Org-mode for various purposes.
13269 Being in this list makes sure that they are offered for completion.")
13272 "Regular expression matching the first line of a property drawer.")
13275 "Regular expression matching the last line of a property drawer.")
13278 "Regular expression matching the first line of a property drawer.")
13281 "Regular expression matching the first line of a property drawer.")
13283 (defconst org-property-drawer-re
13286 "Matches an entire property drawer.")
13288 (defconst org-clock-drawer-re
13291 "Matches an entire clock drawer.")
13293 (defun org-property-action ()
13294 "Do an action on properties."
13295 (interactive)
13296 (let (c)
13297 (org-at-property-p)
13298 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13299 (setq c (read-char-exclusive))
13300 (cond
13301 ((equal c ?s)
13302 (call-interactively 'org-set-property))
13303 ((equal c ?d)
13304 (call-interactively 'org-delete-property))
13305 ((equal c ?D)
13306 (call-interactively 'org-delete-property-globally))
13307 ((equal c ?c)
13308 (call-interactively 'org-compute-property-at-point))
13309 (t (error "No such property action %c" c)))))
13311 (defun org-set-effort (&optional value)
13312 "Set the effort property of the current entry.
13313 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13314 allowed value."
13315 (interactive "P")
13316 (if (equal value 0) (setq value 10))
13317 (let* ((completion-ignore-case t)
13318 (prop org-effort-property)
13319 (cur (org-entry-get nil prop))
13320 (allowed (org-property-get-allowed-values nil prop 'table))
13321 (existing (mapcar 'list (org-property-values prop)))
13322 rpl
13323 (val (cond
13324 ((stringp value) value)
13325 ((and allowed (integerp value))
13326 (or (car (nth (1- value) allowed))
13327 (car (org-last allowed))))
13328 (allowed
13329 (message "Select 1-9,0, [RET%s]: %s"
13330 (if cur (concat "=" cur) "")
13331 (mapconcat 'car allowed " "))
13332 (setq rpl (read-char-exclusive))
13334 cur
13335 (setq rpl (- rpl ?0))
13336 (if (equal rpl 0) (setq rpl 10))
13337 (if (and (> rpl 0) (<= rpl (length allowed)))
13338 (car (nth (1- rpl) allowed))
13339 (org-completing-read "Effort: " allowed nil))))
13340 (t
13341 (let (org-completion-use-ido org-completion-use-iswitchb)
13342 (org-completing-read
13344 (concat "[" cur "]") "")
13345 ": ")
13346 existing nil nil "" nil cur))))))
13347 (unless (equal (org-entry-get nil prop) val)
13348 (org-entry-put nil prop val))
13349 (message "%s is now %s" prop val)))
13351 (defun org-at-property-p ()
13352 "Is cursor inside a property drawer?"
13353 (save-excursion
13354 (beginning-of-line 1)
13356 (save-match-data ;; Used by calling procedures
13357 (let ((p (point))
13358 (range (unless (org-before-first-heading-p)
13359 (org-get-property-block))))
13360 (and range (<= (car range) p) (< p (cdr range))))))))
13362 (defun org-get-property-block (&optional beg end force)
13363 "Return the (beg . end) range of the body of the property drawer.
13364 BEG and END can be beginning and end of subtree, if not given
13365 they will be found.
13366 If the drawer does not exist and FORCE is non-nil, create the drawer."
13367 (catch 'exit
13368 (save-excursion
13369 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13370 (end (or end (progn (outline-next-heading) (point)))))
13371 (goto-char beg)
13372 (if (re-search-forward org-property-start-re end t)
13373 (setq beg (1+ (match-end 0)))
13374 (if force
13375 (save-excursion
13376 (org-insert-property-drawer)
13377 (setq end (progn (outline-next-heading) (point))))
13378 (throw 'exit nil))
13379 (goto-char beg)
13380 (if (re-search-forward org-property-start-re end t)
13381 (setq beg (1+ (match-end 0)))))
13382 (if (re-search-forward org-property-end-re end t)
13383 (setq end (match-beginning 0))
13384 (or force (throw 'exit nil))
13385 (goto-char beg)
13386 (setq end beg)
13387 (org-indent-line-function)
13389 (cons beg end)))))
13391 (defun org-entry-properties (&optional pom which specific)
13392 "Get all properties of the entry at point-or-marker POM.
13393 This includes the TODO keyword, the tags, time strings for deadline,
13394 scheduled, and clocking, and any additional properties defined in the
13395 entry. The return value is an alist, keys may occur multiple times
13396 if the property key was used several times.
13397 POM may also be nil, in which case the current entry is used.
13398 If WHICH is nil or `all', get all properties. If WHICH is
13399 `special' or `standard', only get that subclass. If WHICH
13400 is a string only get exactly this property. Specific can be a string, the
13401 specific property we are interested in. Specifying it can speed
13402 things up because then unnecessary parsing is avoided."
13403 (setq which (or which 'all))
13404 (org-with-point-at pom
13405 (let ((clockstr (substring org-clock-string 0 -1))
13406 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13407 (case-fold-search nil)
13408 beg end range props sum-props key key1 value string clocksum)
13409 (save-excursion
13410 (when (condition-case nil
13411 (and (org-mode-p) (org-back-to-heading t))
13412 (error nil))
13413 (setq beg (point))
13414 (setq sum-props (get-text-property (point) 'org-summaries))
13415 (setq clocksum (get-text-property (point) :org-clock-minutes))
13416 (outline-next-heading)
13417 (setq end (point))
13418 (when (memq which '(all special))
13419 ;; Get the special properties, like TODO and tags
13420 (goto-char beg)
13421 (when (and (or (not specific) (string= specific "TODO"))
13422 (looking-at org-todo-line-regexp) (match-end 2))
13423 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13424 (when (and (or (not specific) (string= specific "PRIORITY"))
13425 (looking-at org-priority-regexp))
13426 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13427 (when (and (or (not specific) (string= specific "TAGS"))
13428 (setq value (org-get-tags-string))
13430 (push (cons "TAGS" value) props))
13431 (when (and (or (not specific) (string= specific "ALLTAGS"))
13432 (setq value (org-get-tags-at)))
13433 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13434 ":"))
13435 props))
13436 (when (or (not specific) (string= specific "BLOCKED"))
13437 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13438 (when (or (not specific)
13439 (member specific
13440 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13441 "TIMESTAMP" "TIMESTAMP_IA")))
13442 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13443 (setq key (if (match-end 1)
13444 (substring (org-match-string-no-properties 1)
13445 0 -1))
13446 string (if (equal key clockstr)
13447 (org-no-properties
13448 (org-trim
13449 (buffer-substring
13450 (match-beginning 3) (goto-char
13451 (point-at-eol)))))
13452 (substring (org-match-string-no-properties 3)
13453 1 -1)))
13454 ;; Get the correct property name from the key. This is
13455 ;; necessary if the user has configured time keywords.
13456 (setq key1 (concat key ":"))
13457 (cond
13458 ((not key)
13459 (setq key
13460 (if (= (char-after (match-beginning 3)) ?\[)
13461 "TIMESTAMP_IA" "TIMESTAMP")))
13462 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13463 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13464 ((equal key1 org-closed-string) (setq key "CLOSED"))
13465 ((equal key1 org-clock-string) (setq key "CLOCK")))
13466 (when (or (equal key "CLOCK") (not (assoc key props)))
13467 (push (cons key string) props))))
13468 )
13470 (when (memq which '(all standard))
13471 ;; Get the standard properties, like :PROP: ...
13472 (setq range (org-get-property-block beg end))
13473 (when range
13474 (goto-char (car range))
13475 (while (re-search-forward
13477 (cdr range) t)
13478 (setq key (org-match-string-no-properties 1)
13479 value (org-trim (or (org-match-string-no-properties 2) "")))
13480 (unless (member key excluded)
13481 (push (cons key (or value "")) props)))))
13482 (if clocksum
13483 (push (cons "CLOCKSUM"
13484 (org-columns-number-to-string (/ (float clocksum) 60.)
13485 'add_times))
13486 props))
13487 (unless (assoc "CATEGORY" props)
13488 (setq value (or (org-get-category)
13489 (progn (org-refresh-category-properties)
13490 (org-get-category))))
13491 (push (cons "CATEGORY" value) props))
13492 (append sum-props (nreverse props)))))))
13494 (defun org-entry-get (pom property &optional inherit literal-nil)
13495 "Get value of PROPERTY for entry at point-or-marker POM.
13496 If INHERIT is non-nil and the entry does not have the property,
13497 then also check higher levels of the hierarchy.
13498 If INHERIT is the symbol `selective', use inheritance only if the setting
13499 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13500 If the property is present but empty, the return value is the empty string.
13501 If the property is not present at all, nil is returned.
13504 do not interpret it as the list atom nil. This is used for inheritance
13506 (org-with-point-at pom
13507 (if (and inherit (if (eq inherit 'selective)
13508 (org-property-inherit-p property)
13509 t))
13510 (org-entry-get-with-inheritance property literal-nil)
13511 (if (member property org-special-properties)
13512 ;; We need a special property. Use `org-entry-properties' to
13513 ;; retrieve it, but specify the wanted property
13514 (cdr (assoc property (org-entry-properties nil 'special property)))
13515 (let ((range (org-get-property-block)))
13516 (if (and range
13517 (goto-char (car range))
13518 (re-search-forward
13520 (cdr range) t))
13521 ;; Found the property, return it.
13522 (if (match-end 1)
13523 (if literal-nil
13524 (org-match-string-no-properties 1)
13525 (org-not-nil (org-match-string-no-properties 1)))
13526 "")))))))
13528 (defun org-property-or-variable-value (var &optional inherit)
13529 "Check if there is a property fixing the value of VAR.
13530 If yes, return this value. If not, return the current value of the variable."
13531 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13533 (read prop)
13534 (symbol-value var))))
13536 (defun org-entry-delete (pom property)
13537 "Delete the property PROPERTY from entry at point-or-marker POM."
13538 (org-with-point-at pom
13539 (if (member property org-special-properties)
13540 nil ; cannot delete these properties.
13541 (let ((range (org-get-property-block)))
13542 (if (and range
13543 (goto-char (car range))
13544 (re-search-forward
13546 (cdr range) t))
13547 (progn
13548 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13549 t)
13550 nil)))))
13552 ;; Multi-values properties are properties that contain multiple values
13553 ;; These values are assumed to be single words, separated by whitespace.
13554 (defun org-entry-add-to-multivalued-property (pom property value)
13555 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13556 (let* ((old (org-entry-get pom property))
13558 (setq value (org-entry-protect-space value))
13559 (unless (member value values)
13560 (setq values (cons value values))
13561 (org-entry-put pom property
13562 (mapconcat 'identity values " ")))))
13564 (defun org-entry-remove-from-multivalued-property (pom property value)
13565 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13566 (let* ((old (org-entry-get pom property))
13568 (setq value (org-entry-protect-space value))
13569 (when (member value values)
13570 (setq values (delete value values))
13571 (org-entry-put pom property
13572 (mapconcat 'identity values " ")))))
13574 (defun org-entry-member-in-multivalued-property (pom property value)
13575 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13576 (let* ((old (org-entry-get pom property))
13578 (setq value (org-entry-protect-space value))
13579 (member value values)))
13581 (defun org-entry-get-multivalued-property (pom property)
13582 "Return a list of values in a multivalued property."
13583 (let* ((value (org-entry-get pom property))
13585 (mapcar 'org-entry-restore-space values)))
13587 (defun org-entry-put-multivalued-property (pom property &rest values)
13588 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13589 VALUES should be a list of strings. Spaces will be protected."
13590 (org-entry-put pom property
13591 (mapconcat 'org-entry-protect-space values " "))
13592 (let* ((value (org-entry-get pom property))
13594 (mapcar 'org-entry-restore-space values)))
13596 (defun org-entry-protect-space (s)
13597 "Protect spaces and newline in string S."
13598 (while (string-match " " s)
13599 (setq s (replace-match "%20" t t s)))
13601 (setq s (replace-match "%0A" t t s)))
13602 s)
13604 (defun org-entry-restore-space (s)
13605 "Restore spaces and newline in string S."
13606 (while (string-match "%20" s)
13607 (setq s (replace-match " " t t s)))
13608 (while (string-match "%0A" s)
13610 s)
13612 (defvar org-entry-property-inherited-from (make-marker)
13613 "Marker pointing to the entry from where a property was inherited.
13614 Each call to `org-entry-get-with-inheritance' will set this marker to the
13615 location of the entry where the inheritance search matched. If there was
13616 no match, the marker will point nowhere.
13617 Note that also `org-entry-get' calls this function, if the INHERIT flag
13618 is set.")
13620 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13621 "Get entry property, and search higher levels if not present.
13622 The search will stop at the first ancestor which has the property defined.
13624 should be considered as undefined (this is the meaning of nil here).
13626 (move-marker org-entry-property-inherited-from nil)
13627 (let (tmp)
13628 (save-excursion
13629 (save-restriction
13630 (widen)
13631 (catch 'ex
13632 (while t
13633 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13634 (org-back-to-heading t)
13635 (move-marker org-entry-property-inherited-from (point))
13636 (throw 'ex tmp))
13637 (or (org-up-heading-safe) (throw 'ex nil)))))
13638 (setq tmp (or tmp
13639 (cdr (assoc property org-file-properties))
13640 (cdr (assoc property org-global-properties))
13641 (cdr (assoc property org-global-properties-fixed))))
13642 (if literal-nil tmp (org-not-nil tmp)))))
13644 (defvar org-property-changed-functions nil
13645 "Hook called when the value of a property has changed.
13646 Each hook function should accept two arguments, the name of the property
13647 and the new value.")
13649 (defun org-entry-put (pom property value)
13650 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13651 (org-with-point-at pom
13652 (org-back-to-heading t)
13653 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13654 range)
13655 (cond
13656 ((equal property "TODO")
13658 (not (member value org-todo-keywords-1)))
13660 (if (or (not value)
13662 (setq value 'none))
13663 (org-todo value)
13664 (org-set-tags nil 'align))
13665 ((equal property "PRIORITY")
13667 (string-to-char value) ?\ ))
13668 (org-set-tags nil 'align))
13669 ((equal property "SCHEDULED")
13670 (if (re-search-forward org-scheduled-time-regexp end t)
13671 (cond
13672 ((eq value 'earlier) (org-timestamp-change -1 'day))
13673 ((eq value 'later) (org-timestamp-change 1 'day))
13674 (t (call-interactively 'org-schedule)))
13675 (call-interactively 'org-schedule)))
13676 ((equal property "DEADLINE")
13677 (if (re-search-forward org-deadline-time-regexp end t)
13678 (cond
13679 ((eq value 'earlier) (org-timestamp-change -1 'day))
13680 ((eq value 'later) (org-timestamp-change 1 'day))
13681 (t (call-interactively 'org-deadline)))
13682 (call-interactively 'org-deadline)))
13683 ((member property org-special-properties)
13684 (error "The %s property can not yet be set with `org-entry-put'"
13685 property))
13686 (t ; a non-special property
13687 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13688 (setq range (org-get-property-block beg end 'force))
13689 (goto-char (car range))
13690 (if (re-search-forward
13692 (progn
13693 (delete-region (match-beginning 1) (match-end 1))
13694 (goto-char (match-beginning 1)))
13695 (goto-char (cdr range))
13697 (backward-char 1)
13698 (org-indent-line-function)
13699 (insert ":" property ":"))
13700 (and value (insert " " value))
13701 (org-indent-line-function)))))
13702 (run-hook-with-args 'org-property-changed-functions property value)))
13704 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13705 "Get all property keys in the current buffer.
13706 With INCLUDE-SPECIALS, also list the special properties that reflect things
13707 like tags and TODO state.
13708 With INCLUDE-DEFAULTS, also include properties that has special meaning
13709 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13710 With INCLUDE-COLUMNS, also include property names given in COLUMN
13711 formats in the current buffer."
13712 (let (rtn range cfmt s p)
13713 (save-excursion
13714 (save-restriction
13715 (widen)
13716 (goto-char (point-min))
13717 (while (re-search-forward org-property-start-re nil t)
13718 (setq range (org-get-property-block))
13719 (goto-char (car range))
13720 (while (re-search-forward
13722 (cdr range) t)
13723 (add-to-list 'rtn (org-match-string-no-properties 1)))
13724 (outline-next-heading))))
13726 (when include-specials
13727 (setq rtn (append org-special-properties rtn)))
13729 (when include-defaults
13730 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13731 (add-to-list 'rtn org-effort-property))
13733 (when include-columns
13734 (save-excursion
13735 (save-restriction
13736 (widen)
13737 (goto-char (point-min))
13738 (while (re-search-forward
13740 nil t)
13741 (setq cfmt (match-string 2) s 0)
13743 cfmt s)
13744 (setq s (match-end 0)
13745 p (match-string 1 cfmt))
13746 (unless (or (equal p "ITEM")
13747 (member p org-special-properties))
13748 (add-to-list 'rtn (match-string 1 cfmt))))))))
13750 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13752 (defun org-property-values (key)
13753 "Return a list of all values of property KEY."
13754 (save-excursion
13755 (save-restriction
13756 (widen)
13757 (goto-char (point-min))
13759 values)
13760 (while (re-search-forward re nil t)
13761 (add-to-list 'values (org-trim (match-string 1))))
13762 (delete "" values)))))
13764 (defun org-insert-property-drawer ()
13765 "Insert a property drawer into the current entry."
13766 (interactive)
13767 (org-back-to-heading t)
13768 (looking-at outline-regexp)
13769 (let ((indent (if org-adapt-indentation
13770 (- (match-end 0)(match-beginning 0))
13771 0))
13772 (beg (point))
13774 end hiddenp)
13775 (outline-next-heading)
13776 (setq end (point))
13777 (goto-char beg)
13778 (while (re-search-forward re end t))
13779 (setq hiddenp (org-invisible-p))
13780 (end-of-line 1)
13783 (if (member (match-string 1) '("CLOCK:" ":END:"))
13784 ;; just skip this line
13785 (beginning-of-line 2)
13786 ;; Drawer start, find the end
13788 (beginning-of-line 1)))
13789 (org-skip-over-state-notes)
13791 (if (eq (char-before) ?*) (forward-char 1))
13793 (beginning-of-line 0)
13794 (org-indent-to-column indent)
13795 (beginning-of-line 2)
13796 (org-indent-to-column indent)
13797 (beginning-of-line 0)
13798 (if hiddenp
13799 (save-excursion
13800 (org-back-to-heading t)
13801 (hide-entry))
13802 (org-flag-drawer t))))
13804 (defun org-set-property (property value)
13805 "In the current entry, set PROPERTY to VALUE.
13806 When called interactively, this will prompt for a property name, offering
13807 completion on existing and default properties. And then it will prompt
13808 for a value, offering completion either on allowed values (via an inherited
13809 xxx_ALL property) or on existing values in other instances of this property
13810 in the current file."
13811 (interactive
13812 (let* ((completion-ignore-case t)
13813 (keys (org-buffer-property-keys nil t t))
13814 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13815 (prop (if (member prop0 keys)
13816 prop0
13817 (or (cdr (assoc (downcase prop0)
13818 (mapcar (lambda (x) (cons (downcase x) x))
13819 keys)))
13820 prop0)))
13821 (cur (org-entry-get nil prop))
13822 (prompt (concat prop " value"
13824 (concat " [" cur "]") "") ": "))
13825 (allowed (org-property-get-allowed-values nil prop 'table))
13826 (existing (mapcar 'list (org-property-values prop)))
13827 (val (if allowed
13828 (org-completing-read prompt allowed nil
13829 (not (get-text-property 0 'org-unrestricted
13830 (caar allowed))))
13831 (let (org-completion-use-ido org-completion-use-iswitchb)
13832 (org-completing-read prompt existing nil nil "" nil cur)))))
13833 (list prop (if (equal val "") cur val))))
13834 (unless (equal (org-entry-get nil property) value)
13835 (org-entry-put nil property value)))
13837 (defun org-delete-property (property)
13838 "In the current entry, delete PROPERTY."
13839 (interactive
13840 (let* ((completion-ignore-case t)
13841 (prop (org-icompleting-read "Property: "
13842 (org-entry-properties nil 'standard))))
13843 (list prop)))
13844 (message "Property %s %s" property
13845 (if (org-entry-delete nil property)
13846 "deleted"
13847 "was not present in the entry")))
13849 (defun org-delete-property-globally (property)
13850 "Remove PROPERTY globally, from all entries."
13851 (interactive
13852 (let* ((completion-ignore-case t)
13853 (prop (org-icompleting-read
13854 "Globally remove property: "
13855 (mapcar 'list (org-buffer-property-keys)))))
13856 (list prop)))
13857 (save-excursion
13858 (save-restriction
13859 (widen)
13860 (goto-char (point-min))
13861 (let ((cnt 0))
13862 (while (re-search-forward
13864 nil t)
13865 (setq cnt (1+ cnt))
13866 (replace-match ""))
13869 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13871 (defun org-compute-property-at-point ()
13872 "Compute the property at point.
13873 This looks for an enclosing column format, extracts the operator and
13874 then applies it to the property in the column format's scope."
13875 (interactive)
13876 (unless (org-at-property-p)
13877 (error "Not at a property"))
13878 (let ((prop (org-match-string-no-properties 2)))
13879 (org-columns-get-format-and-top-level)
13880 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13881 (error "No operator defined for property %s" prop))
13882 (org-columns-compute prop)))
13884 (defvar org-property-allowed-value-functions nil
13885 "Hook for functions supplying allowed values for a specific property.
13886 The functions must take a single argument, the name of the property, and
13888 the values, this means that these values are intended as defaults for
13889 completion, but that other values should be allowed too.
13890 The functions must return nil if they are not responsible for this
13891 property.")
13893 (defun org-property-get-allowed-values (pom property &optional table)
13894 "Get allowed values for the property PROPERTY.
13895 When TABLE is non-nil, return an alist that can directly be used for
13896 completion."
13897 (let (vals)
13898 (cond
13899 ((equal property "TODO")
13900 (setq vals (org-with-point-at pom
13901 (append org-todo-keywords-1 '("")))))
13902 ((equal property "PRIORITY")
13903 (let ((n org-lowest-priority))
13904 (while (>= n org-highest-priority)
13905 (push (char-to-string n) vals)
13906 (setq n (1- n)))))
13907 ((member property org-special-properties))
13908 ((setq vals (run-hook-with-args-until-success
13909 'org-property-allowed-value-functions property)))
13910 (t
13911 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13913 (setq vals (car (read-from-string (concat "(" vals ")"))))
13914 (setq vals (mapcar (lambda (x)
13915 (cond ((stringp x) x)
13916 ((numberp x) (number-to-string x))
13917 ((symbolp x) (symbol-name x))
13918 (t "???")))
13919 vals)))))
13920 (when (member ":ETC" vals)
13921 (setq vals (remove ":ETC" vals))
13922 (org-add-props (car vals) '(org-unrestricted t)))
13923 (if table (mapcar 'list vals) vals)))
13925 (defun org-property-previous-allowed-value (&optional previous)
13926 "Switch to the next allowed value for this property."
13927 (interactive)
13928 (org-property-next-allowed-value t))
13930 (defun org-property-next-allowed-value (&optional previous)
13931 "Switch to the next allowed value for this property."
13932 (interactive)
13933 (unless (org-at-property-p)
13934 (error "Not at a property"))
13935 (let* ((key (match-string 2))
13936 (value (match-string 3))
13937 (allowed (or (org-property-get-allowed-values (point) key)
13938 (and (member value '("[ ]" "[-]" "[X]"))
13939 '("[ ]" "[X]"))))
13940 nval)
13941 (unless allowed
13942 (error "Allowed values for this property have not been defined"))
13943 (if previous (setq allowed (reverse allowed)))
13944 (if (member value allowed)
13945 (setq nval (car (cdr (member value allowed)))))
13946 (setq nval (or nval (car allowed)))
13947 (if (equal nval value)
13948 (error "Only one allowed value for this property"))
13949 (org-at-property-p)
13950 (replace-match (concat " :" key ": " nval) t t)
13951 (org-indent-line-function)
13952 (beginning-of-line 1)
13954 (run-hook-with-args 'org-property-changed-functions key nval)))
13956 (defun org-find-olp (path &optional this-buffer)
13957 "Return a marker pointing to the entry at outline path OLP.
13958 If anything goes wrong, throw an error.
13959 You can wrap this call to catch the error like this:
13961 (condition-case msg
13962 (org-mobile-locate-entry (match-string 4))
13963 (error (nth 1 msg)))
13965 The return value will then be either a string with the error message,
13966 or a marker if everything is OK.
13968 If THIS-BUFFER is set, the outline path does not contain a file,
13969 only headings."
13970 (let* ((file (if this-buffer buffer-file-name (pop path)))
13971 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13972 (level 1)
13973 (lmin 1)
13974 (lmax 1)
13975 limit re end found pos heading cnt)
13976 (unless buffer (error "File not found :%s" file))
13977 (with-current-buffer buffer
13978 (save-excursion
13979 (save-restriction
13980 (widen)
13981 (setq limit (point-max))
13982 (goto-char (point-min))
13983 (while (setq heading (pop path))
13984 (setq re (format org-complex-heading-regexp-format
13985 (regexp-quote heading)))
13986 (setq cnt 0 pos (point))
13987 (while (re-search-forward re end t)
13988 (setq level (- (match-end 1) (match-beginning 1)))
13989 (if (and (>= level lmin) (<= level lmax))
13990 (setq found (match-beginning 0) cnt (1+ cnt))))
13991 (when (= cnt 0) (error "Heading not found on level %d: %s"
13992 lmax heading))
13993 (when (> cnt 1) (error "Heading not unique on level %d: %s"
13994 lmax heading))
13995 (goto-char found)
13996 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
13997 (setq end (save-excursion (org-end-of-subtree t t))))
13998 (when (org-on-heading-p)
13999 (move-marker (make-marker) (point))))))))
14001 (defun org-find-exact-headling-in-buffer (heading &optional buffer pos-only)
14002 "Find node HEADING in BUFFER.
14003 Return a marker to the heading if it was found, or nil if not.
14004 If POS-ONLY is set, return just the position instead of a marker.
14006 The heading text must match exact, but it may have a TODO keyword,
14007 a priority cookie and tags in the standard locations."
14008 (with-current-buffer (or buffer (current-buffer))
14009 (save-excursion
14010 (save-restriction
14011 (widen)
14012 (goto-char (point-min))
14013 (let (case-fold-search)
14014 (if (setq p (re-search-forward
14015 (format org-complex-heading-regexp-format
14016 (regexp-quote heading)) nil t))
14017 (if pos-only
14018 (match-beginning 0)
14019 (move-marker (make-marker) (match-beginning 0)))))))))
14021 (defun org-find-exact-heading-in-directory (heading &optional dir)
14022 "Find Org node headline HEADING in all .org files in directory DIR.
14023 When the target headline is found, return a marker to this location."
14024 (let ((files (directory-files (or dir default-directory)
14026 file visiting m buffer)
14027 (catch 'found
14028 (while (setq file (pop files))
14029 (message "trying %s" file)
14030 (setq visiting (org-find-base-buffer-visiting file))
14031 (setq buffer (or visiting (find-file-noselect file)))
14032 (setq m (org-find-exact-headling-in-buffer
14033 target buffer))
14034 (when (and (not m) (not visiting)) (kill-buffer buffer))
14035 (and m (throw 'found m))))))
14037 (defun org-find-entry-with-id (ident)
14038 "Locate the entry that contains the ID property with exact value IDENT.
14039 IDENT can be a string, a symbol or a number, this function will search for
14040 the string representation of it.
14041 Return the position where this entry starts, or nil if there is no such entry."
14042 (interactive "sID: ")
14043 (let ((id (cond
14044 ((stringp ident) ident)
14045 ((symbol-name ident) (symbol-name ident))
14046 ((numberp ident) (number-to-string ident))
14047 (t (error "IDENT %s must be a string, symbol or number" ident))))
14048 (case-fold-search nil))
14049 (save-excursion
14050 (save-restriction
14051 (widen)
14052 (goto-char (point-min))
14053 (when (re-search-forward
14055 nil t)
14056 (org-back-to-heading t)
14057 (point))))))
14059 ;;;; Timestamps
14061 (defvar org-last-changed-timestamp nil)
14062 (defvar org-last-inserted-timestamp nil
14063 "The last time stamp inserted with `org-insert-time-stamp'.")
14064 (defvar org-time-was-given) ; dynamically scoped parameter
14065 (defvar org-end-time-was-given) ; dynamically scoped parameter
14066 (defvar org-ts-what) ; dynamically scoped parameter
14068 (defun org-time-stamp (arg &optional inactive)
14069 "Prompt for a date/time and insert a time stamp.
14070 If the user specifies a time like HH:MM, or if this command is called
14071 with a prefix argument, the time stamp will contain date and time.
14072 Otherwise, only the date will be included. All parts of a date not
14073 specified by the user will be filled in from the current date/time.
14074 So if you press just return without typing anything, the time stamp
14075 will represent the current date/time. If there is already a timestamp
14076 at the cursor, it will be modified."
14077 (interactive "P")
14078 (let* ((ts nil)
14079 (default-time
14080 ;; Default time is either today, or, when entering a range,
14081 ;; the range start.
14082 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14083 (save-excursion
14084 (re-search-backward
14086 (- (point) 20) t)))
14087 (apply 'encode-time (org-parse-time-string (match-string 1)))
14088 (current-time)))
14089 (default-input (and ts (org-get-compact-tod ts)))
14090 org-time-was-given org-end-time-was-given time)
14091 (cond
14092 ((and (org-at-timestamp-p t)
14093 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14094 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14095 (insert "--")
14096 (setq time (let ((this-command this-command))
14097 (org-read-date arg 'totime nil nil
14098 default-time default-input)))
14099 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14100 ((org-at-timestamp-p t)
14101 (setq time (let ((this-command this-command))
14102 (org-read-date arg 'totime nil nil default-time default-input)))
14103 (when (org-at-timestamp-p t) ; just to get the match data
14104 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14105 (replace-match "")
14106 (setq org-last-changed-timestamp
14107 (org-insert-time-stamp
14108 time (or org-time-was-given arg)
14109 inactive nil nil (list org-end-time-was-given))))
14110 (message "Timestamp updated"))
14111 (t
14112 (setq time (let ((this-command this-command))
14113 (org-read-date arg 'totime nil nil default-time default-input)))
14114 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14115 nil nil (list org-end-time-was-given))))))
14117 ;; FIXME: can we use this for something else, like computing time differences?
14118 (defun org-get-compact-tod (s)
14119 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14120 (let* ((t1 (match-string 1 s))
14121 (h1 (string-to-number (match-string 2 s)))
14122 (m1 (string-to-number (match-string 3 s)))
14123 (t2 (and (match-end 4) (match-string 5 s)))
14124 (h2 (and t2 (string-to-number (match-string 6 s))))
14125 (m2 (and t2 (string-to-number (match-string 7 s))))
14126 dh dm)
14127 (if (not t2)
14128 t1
14129 (setq dh (- h2 h1) dm (- m2 m1))
14130 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14131 (concat t1 "+" (number-to-string dh)
14132 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14134 (defun org-time-stamp-inactive (&optional arg)
14135 "Insert an inactive time stamp.
14136 An inactive time stamp is enclosed in square brackets instead of angle
14137 brackets. It is inactive in the sense that it does not trigger agenda entries,
14138 does not link to the calendar and cannot be changed with the S-cursor keys.
14139 So these are more for recording a certain time/date."
14140 (interactive "P")
14141 (org-time-stamp arg 'inactive))
14143 (defvar org-date-ovl (make-overlay 1 1))
14144 (overlay-put org-date-ovl 'face 'org-warning)
14145 (org-detach-overlay org-date-ovl)
14147 (defvar org-ans1) ; dynamically scoped parameter
14148 (defvar org-ans2) ; dynamically scoped parameter
14150 (defvar org-plain-time-of-day-regexp) ; defined below
14152 (defvar org-overriding-default-time nil) ; dynamically scoped
14153 (defvar org-read-date-overlay nil)
14154 (defvar org-dcst nil) ; dynamically scoped
14155 (defvar org-read-date-history nil)
14156 (defvar org-read-date-final-answer nil)
14158 (defun org-read-date (&optional with-time to-time from-string prompt
14159 default-time default-input)
14160 "Read a date, possibly a time, and make things smooth for the user.
14161 The prompt will suggest to enter an ISO date, but you can also enter anything
14162 which will at least partially be understood by `parse-time-string'.
14163 Unrecognized parts of the date will default to the current day, month, year,
14164 hour and minute. If this command is called to replace a timestamp at point,
14165 of to enter the second timestamp of a range, the default time is taken
14166 from the existing stamp. Furthermore, the command prefers the future,
14167 so if you are giving a date where the year is not given, and the day-month
14168 combination is already past in the current year, it will assume you
14169 mean next year. For details, see the manual. A few examples:
14171 3-2-5 --> 2003-02-05
14172 feb 15 --> currentyear-02-15
14173 2/15 --> currentyear-02-15
14174 sep 12 9 --> 2009-09-12
14175 12:45 --> today 12:45
14176 22 sept 0:34 --> currentyear-09-22 0:34
14177 12 --> currentyear-currentmonth-12
14178 Fri --> nearest Friday (today or later)
14179 etc.
14181 Furthermore you can specify a relative date by giving, as the *first* thing
14182 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14183 change in days weeks, months, years.
14184 With a single plus or minus, the date is relative to today. With a double
14185 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14186 +4d --> four days from today
14187 +4 --> same as above
14188 +2w --> two weeks from today
14189 ++5 --> five days from default date
14191 The function understands only English month and weekday abbreviations,
14192 but this can be configured with the variables `parse-time-months' and
14193 `parse-time-weekdays'.
14195 While prompting, a calendar is popped up - you can also select the
14196 date with the mouse (button 1). The calendar shows a period of three
14197 months. To scroll it to other months, use the keys `>' and `<'.
14198 If you don't like the calendar, turn it off with
14199 \(setq org-read-date-popup-calendar nil)
14201 With optional argument TO-TIME, the date will immediately be converted
14202 to an internal time.
14203 With an optional argument WITH-TIME, the prompt will suggest to also
14204 insert a time. Note that when WITH-TIME is not set, you can still
14205 enter a time, and this function will inform the calling routine about
14206 this change. The calling routine may then choose to change the format
14207 used to insert the time stamp into the buffer to include the time.
14208 With optional argument FROM-STRING, read from this string instead from
14209 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14210 the time/date that is used for everything that is not specified by the
14211 user."
14212 (require 'parse-time)
14213 (let* ((org-time-stamp-rounding-minutes
14214 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14215 (org-dcst org-display-custom-times)
14216 (ct (org-current-time))
14217 (def (or org-overriding-default-time default-time ct))
14218 (defdecode (decode-time def))
14219 (dummy (progn
14220 (when (< (nth 2 defdecode) org-extend-today-until)
14221 (setcar (nthcdr 2 defdecode) -1)
14222 (setcar (nthcdr 1 defdecode) 59)
14223 (setq def (apply 'encode-time defdecode)
14224 defdecode (decode-time def)))))
14225 (calendar-frame-setup nil)
14226 (calendar-setup nil)
14227 (calendar-move-hook nil)
14228 (calendar-view-diary-initially-flag nil)
14229 (calendar-view-holidays-initially-flag nil)
14230 (timestr (format-time-string
14231 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14232 (prompt (concat (if prompt (concat prompt " ") "")
14233 (format "Date+time [%s]: " timestr)))
14234 ans (org-ans0 "") org-ans1 org-ans2 final)
14236 (cond
14237 (from-string (setq ans from-string))
14238 (org-read-date-popup-calendar
14239 (save-excursion
14240 (save-window-excursion
14241 (calendar)
14242 (calendar-forward-day (- (time-to-days def)
14243 (calendar-absolute-from-gregorian
14244 (calendar-current-date))))
14245 (org-eval-in-calendar nil t)
14246 (let* ((old-map (current-local-map))
14247 (map (copy-keymap calendar-mode-map))
14248 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14249 (org-defkey map (kbd "RET") 'org-calendar-select)
14250 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14251 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14252 (org-defkey minibuffer-local-map [(meta shift left)]
14253 (lambda () (interactive)
14254 (org-eval-in-calendar '(calendar-backward-month 1))))
14255 (org-defkey minibuffer-local-map [(meta shift right)]
14256 (lambda () (interactive)
14257 (org-eval-in-calendar '(calendar-forward-month 1))))
14258 (org-defkey minibuffer-local-map [(meta shift up)]
14259 (lambda () (interactive)
14260 (org-eval-in-calendar '(calendar-backward-year 1))))
14261 (org-defkey minibuffer-local-map [(meta shift down)]
14262 (lambda () (interactive)
14263 (org-eval-in-calendar '(calendar-forward-year 1))))
14264 (org-defkey minibuffer-local-map [?\e (shift left)]
14265 (lambda () (interactive)
14266 (org-eval-in-calendar '(calendar-backward-month 1))))
14267 (org-defkey minibuffer-local-map [?\e (shift right)]
14268 (lambda () (interactive)
14269 (org-eval-in-calendar '(calendar-forward-month 1))))
14270 (org-defkey minibuffer-local-map [?\e (shift up)]
14271 (lambda () (interactive)
14272 (org-eval-in-calendar '(calendar-backward-year 1))))
14273 (org-defkey minibuffer-local-map [?\e (shift down)]
14274 (lambda () (interactive)
14275 (org-eval-in-calendar '(calendar-forward-year 1))))
14276 (org-defkey minibuffer-local-map [(shift up)]
14277 (lambda () (interactive)
14278 (org-eval-in-calendar '(calendar-backward-week 1))))
14279 (org-defkey minibuffer-local-map [(shift down)]
14280 (lambda () (interactive)
14281 (org-eval-in-calendar '(calendar-forward-week 1))))
14282 (org-defkey minibuffer-local-map [(shift left)]
14283 (lambda () (interactive)
14284 (org-eval-in-calendar '(calendar-backward-day 1))))
14285 (org-defkey minibuffer-local-map [(shift right)]
14286 (lambda () (interactive)
14287 (org-eval-in-calendar '(calendar-forward-day 1))))
14288 (org-defkey minibuffer-local-map ">"
14289 (lambda () (interactive)
14290 (org-eval-in-calendar '(scroll-calendar-left 1))))
14291 (org-defkey minibuffer-local-map "<"
14292 (lambda () (interactive)
14293 (org-eval-in-calendar '(scroll-calendar-right 1))))
14294 (org-defkey minibuffer-local-map "\C-v"
14295 (lambda () (interactive)
14296 (org-eval-in-calendar
14297 '(calendar-scroll-left-three-months 1))))
14298 (org-defkey minibuffer-local-map "\M-v"
14299 (lambda () (interactive)
14300 (org-eval-in-calendar
14301 '(calendar-scroll-right-three-months 1))))
14302 (run-hooks 'org-read-date-minibuffer-setup-hook)
14303 (unwind-protect
14304 (progn
14305 (use-local-map map)
14306 (add-hook 'post-command-hook 'org-read-date-display)
14307 (setq org-ans0 (read-string prompt default-input
14308 'org-read-date-history nil))
14309 ;; org-ans0: from prompt
14310 ;; org-ans1: from mouse click
14311 ;; org-ans2: from calendar motion
14312 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14313 (remove-hook 'post-command-hook 'org-read-date-display)
14314 (use-local-map old-map)
14315 (when org-read-date-overlay
14316 (delete-overlay org-read-date-overlay)
14317 (setq org-read-date-overlay nil)))))))
14319 (t ; Naked prompt only
14320 (unwind-protect
14321 (setq ans (read-string prompt default-input
14322 'org-read-date-history timestr))
14323 (when org-read-date-overlay
14324 (delete-overlay org-read-date-overlay)
14325 (setq org-read-date-overlay nil)))))
14327 (setq final (org-read-date-analyze ans def defdecode))
14328 (setq org-read-date-final-answer ans)
14330 (if to-time
14331 (apply 'encode-time final)
14332 (if (and (boundp 'org-time-was-given) org-time-was-given)
14333 (format "%04d-%02d-%02d %02d:%02d"
14334 (nth 5 final) (nth 4 final) (nth 3 final)
14335 (nth 2 final) (nth 1 final))
14336 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14338 (defvar def)
14339 (defvar defdecode)
14340 (defvar with-time)
14341 (defvar org-read-date-analyze-futurep nil)
14342 (defun org-read-date-display ()
14343 "Display the current date prompt interpretation in the minibuffer."
14344 (when org-read-date-display-live
14345 (when org-read-date-overlay
14346 (delete-overlay org-read-date-overlay))
14347 (let ((p (point)))
14348 (end-of-line 1)
14349 (while (not (equal (buffer-substring
14350 (max (point-min) (- (point) 4)) (point))
14351 " "))
14352 (insert " "))
14353 (goto-char p))
14354 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14355 " " (or org-ans1 org-ans2)))
14356 (org-end-time-was-given nil)
14357 (f (org-read-date-analyze ans def defdecode))
14358 (fmts (if org-dcst
14359 org-time-stamp-custom-formats
14360 org-time-stamp-formats))
14361 (fmt (if (or with-time
14362 (and (boundp 'org-time-was-given) org-time-was-given))
14363 (cdr fmts)
14364 (car fmts)))
14365 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14366 (when (and org-end-time-was-given
14367 (string-match org-plain-time-of-day-regexp txt))
14368 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14369 org-end-time-was-given
14370 (substring txt (match-end 0)))))
14371 (when org-read-date-analyze-futurep
14372 (setq txt (concat txt " (=>F)")))
14373 (setq org-read-date-overlay
14374 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14375 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14377 (defun org-read-date-analyze (ans def defdecode)
14378 "Analyze the combined answer of the date prompt."
14379 ;; FIXME: cleanup and comment
14380 (let ((nowdecode (decode-time (current-time)))
14381 delta deltan deltaw deltadef year month day
14382 hour minute second wday pm h2 m2 tl wday1
14383 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14384 (setq org-read-date-analyze-futurep nil)
14386 (setq ans "+0"))
14388 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14389 (setq ans (replace-match "" t t ans)
14390 deltan (car delta)
14391 deltaw (nth 1 delta)
14392 deltadef (nth 2 delta)))
14394 ;; Check if there is an iso week date in there
14395 ;; If yes, store the info and postpone interpreting it until the rest
14396 ;; of the parsing is done
14397 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14398 (setq iso-year (if (match-end 1)
14399 (org-small-year-to-year
14400 (string-to-number (match-string 1 ans))))
14401 iso-weekday (if (match-end 3)
14402 (string-to-number (match-string 3 ans)))
14403 iso-week (string-to-number (match-string 2 ans)))
14404 (setq ans (replace-match "" t t ans)))
14406 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14407 (when (string-match
14409 (setq year (if (match-end 2)
14410 (string-to-number (match-string 2 ans))
14411 (progn (setq kill-year t)
14412 (string-to-number (format-time-string "%Y"))))
14413 month (string-to-number (match-string 3 ans))
14414 day (string-to-number (match-string 4 ans)))
14415 (if (< year 100) (setq year (+ 2000 year)))
14417 t nil ans)))
14418 ;; Help matching american dates, like 5/30 or 5/30/7
14419 (when (string-match
14420 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14421 (setq year (if (match-end 4)
14422 (string-to-number (match-string 4 ans))
14423 (progn (setq kill-year t)
14424 (string-to-number (format-time-string "%Y"))))
14425 month (string-to-number (match-string 1 ans))
14426 day (string-to-number (match-string 2 ans)))
14427 (if (< year 100) (setq year (+ 2000 year)))
14429 t nil ans)))
14430 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14431 ;; If there is a time with am/pm, and *no* time without it, we convert
14432 ;; so that matching will be successful.
14433 (loop for i from 1 to 2 do ; twice, for end time as well
14436 (setq hour (string-to-number (match-string 1 ans))
14437 minute (if (match-end 3)
14438 (string-to-number (match-string 3 ans))
14439 0)
14440 pm (equal ?p
14441 (string-to-char (downcase (match-string 4 ans)))))
14442 (if (and (= hour 12) (not pm))
14443 (setq hour 0)
14444 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14445 (setq ans (replace-match (format "%02d:%02d" hour minute)
14446 t t ans))))
14448 ;; Check if a time range is given as a duration
14449 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14450 (setq hour (string-to-number (match-string 1 ans))
14451 h2 (+ hour (string-to-number (match-string 3 ans)))
14452 minute (string-to-number (match-string 2 ans))
14453 m2 (+ minute (if (match-end 5) (string-to-number
14454 (match-string 5 ans))0)))
14455 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14456 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14457 t t ans)))
14459 ;; Check if there is a time range
14460 (when (boundp 'org-end-time-was-given)
14461 (setq org-time-was-given nil)
14462 (when (and (string-match org-plain-time-of-day-regexp ans)
14463 (match-end 8))
14464 (setq org-end-time-was-given (match-string 8 ans))
14465 (setq ans (concat (substring ans 0 (match-beginning 7))
14466 (substring ans (match-end 7))))))
14468 (setq tl (parse-time-string ans)
14469 day (or (nth 3 tl) (nth 3 defdecode))
14470 month (or (nth 4 tl)
14471 (if (and org-read-date-prefer-future
14472 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14473 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14474 (nth 4 defdecode)))
14475 year (or (and (not kill-year) (nth 5 tl))
14476 (if (and org-read-date-prefer-future
14477 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14478 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14479 (nth 5 defdecode)))
14480 hour (or (nth 2 tl) (nth 2 defdecode))
14481 minute (or (nth 1 tl) (nth 1 defdecode))
14482 second (or (nth 0 tl) 0)
14483 wday (nth 6 tl))
14485 (when (and (eq org-read-date-prefer-future 'time)
14486 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14487 (equal day (nth 3 nowdecode))
14488 (equal month (nth 4 nowdecode))
14489 (equal year (nth 5 nowdecode))
14490 (nth 2 tl)
14491 (or (< (nth 2 tl) (nth 2 nowdecode))
14492 (and (= (nth 2 tl) (nth 2 nowdecode))
14493 (nth 1 tl)
14494 (< (nth 1 tl) (nth 1 nowdecode)))))
14495 (setq day (1+ day)
14496 futurep t))
14498 ;; Special date definitions below
14499 (cond
14500 (iso-week
14501 ;; There was an iso week
14502 (require 'cal-iso)
14503 (setq futurep nil)
14504 (setq year (or iso-year year)
14505 day (or iso-weekday wday 1)
14506 wday nil ; to make sure that the trigger below does not match
14507 iso-date (calendar-gregorian-from-absolute
14508 (calendar-absolute-from-iso
14509 (list iso-week day year))))
14510 ; FIXME: Should we also push ISO weeks into the future?
14511 ; (when (and org-read-date-prefer-future
14512 ; (not iso-year)
14513 ; (< (calendar-absolute-from-gregorian iso-date)
14514 ; (time-to-days (current-time))))
14515 ; (setq year (1+ year)
14516 ; iso-date (calendar-gregorian-from-absolute
14517 ; (calendar-absolute-from-iso
14518 ; (list iso-week day year)))))
14519 (setq month (car iso-date)
14520 year (nth 2 iso-date)
14521 day (nth 1 iso-date)))
14522 (deltan
14523 (setq futurep nil)
14524 (unless deltadef
14525 (let ((now (decode-time (current-time))))
14526 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14527 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14528 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14529 ((equal deltaw "m") (setq month (+ month deltan)))
14530 ((equal deltaw "y") (setq year (+ year deltan)))))
14531 ((and wday (not (nth 3 tl)))
14532 (setq futurep nil)
14533 ;; Weekday was given, but no day, so pick that day in the week
14534 ;; on or after the derived date.
14535 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14536 (unless (equal wday wday1)
14537 (setq day (+ day (% (- wday wday1 -7) 7))))))
14538 (if (and (boundp 'org-time-was-given)
14539 (nth 2 tl))
14540 (setq org-time-was-given t))
14541 (if (< year 100) (setq year (+ 2000 year)))
14542 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14543 (setq org-read-date-analyze-futurep futurep)
14544 (list second minute hour day month year)))
14546 (defvar parse-time-weekdays)
14548 (defun org-read-date-get-relative (s today default)
14549 "Check string S for special relative date string.
14550 TODAY and DEFAULT are internal times, for today and for a default.
14551 Return shift list (N what def-flag)
14553 N is the number of WHATs to shift.
14554 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14555 the DEFAULT date rather than TODAY."
14556 (when (and
14557 (string-match
14558 (concat
14563 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14564 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14565 (string-to-char (substring (match-string 1 s) -1))
14566 ?+))
14567 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14568 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14569 (what (if (match-end 3) (match-string 3 s) "d"))
14570 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14571 (date (if rel default today))
14572 (wday (nth 6 (decode-time date)))
14573 delta)
14574 (if wday1
14575 (progn
14576 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14577 (if (= dir ?-) (setq delta (- delta 7)))
14578 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14579 (list delta "d" rel))
14580 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14582 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14583 "Turn a user-specified date into the internal representation.
14584 The internal representation needed by the calendar is (month day year).
14585 This is a wrapper to handle the brain-dead convention in calendar that
14586 user function argument order change dependent on argument order."
14587 (if (boundp 'calendar-date-style)
14588 (cond
14589 ((eq calendar-date-style 'american)
14590 (list arg1 arg2 arg3))
14591 ((eq calendar-date-style 'european)
14592 (list arg2 arg1 arg3))
14593 ((eq calendar-date-style 'iso)
14594 (list arg2 arg3 arg1)))
14595 (if (org-bound-and-true-p european-calendar-style)
14596 (list arg2 arg1 arg3)
14597 (list arg1 arg2 arg3))))
14599 (defun org-eval-in-calendar (form &optional keepdate)
14600 "Eval FORM in the calendar window and return to current window.
14601 Also, store the cursor date in variable org-ans2."
14602 (let ((sf (selected-frame))
14603 (sw (selected-window)))
14604 (select-window (get-buffer-window "*Calendar*" t))
14605 (eval form)
14606 (when (and (not keepdate) (calendar-cursor-to-date))
14607 (let* ((date (calendar-cursor-to-date))
14608 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14609 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14610 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14611 (select-window sw)
14612 (org-select-frame-set-input-focus sf)))
14614 (defun org-calendar-select ()
14615 "Return to `org-read-date' with the date currently selected.
14616 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14617 (interactive)
14618 (when (calendar-cursor-to-date)
14619 (let* ((date (calendar-cursor-to-date))
14620 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14621 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14622 (if (active-minibuffer-window) (exit-minibuffer))))
14624 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14625 "Insert a date stamp for the date given by the internal TIME.
14626 WITH-HM means use the stamp format that includes the time of the day.
14627 INACTIVE means use square brackets instead of angular ones, so that the
14628 stamp will not contribute to the agenda.
14629 PRE and POST are optional strings to be inserted before and after the
14630 stamp.
14631 The command returns the inserted time stamp."
14632 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14633 stamp)
14634 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14635 (insert-before-markers (or pre ""))
14636 (when (listp extra)
14637 (setq extra (car extra))
14638 (if (and (stringp extra)
14640 (setq extra (format "-%02d:%02d"
14641 (string-to-number (match-string 1 extra))
14642 (string-to-number (match-string 2 extra))))
14643 (setq extra nil)))
14644 (when extra
14645 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14646 (insert-before-markers (setq stamp (format-time-string fmt time)))
14647 (insert-before-markers (or post ""))
14648 (setq org-last-inserted-timestamp stamp)))
14650 (defun org-toggle-time-stamp-overlays ()
14651 "Toggle the use of custom time stamp formats."
14652 (interactive)
14653 (setq org-display-custom-times (not org-display-custom-times))
14654 (unless org-display-custom-times
14655 (let ((p (point-min)) (bmp (buffer-modified-p)))
14656 (while (setq p (next-single-property-change p 'display))
14657 (if (and (get-text-property p 'display)
14658 (eq (get-text-property p 'face) 'org-date))
14659 (remove-text-properties
14660 p (setq p (next-single-property-change p 'display))
14661 '(display t))))
14662 (set-buffer-modified-p bmp)))
14663 (if (featurep 'xemacs)
14664 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14665 (org-restart-font-lock)
14666 (setq org-table-may-need-update t)
14667 (if org-display-custom-times
14668 (message "Time stamps are overlayed with custom format")
14669 (message "Time stamp overlays removed")))
14671 (defun org-display-custom-time (beg end)
14672 "Overlay modified time stamp format over timestamp between BEG and END."
14673 (let* ((ts (buffer-substring beg end))
14674 t1 w1 with-hm tf time str w2 (off 0))
14675 (save-match-data
14676 (setq t1 (org-parse-time-string ts t))
14677 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14678 (setq off (- (match-end 0) (match-beginning 0)))))
14679 (setq end (- end off))
14680 (setq w1 (- end beg)
14681 with-hm (and (nth 1 t1) (nth 2 t1))
14682 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14683 time (org-fix-decoded-time t1)
14684 str (org-add-props
14685 (format-time-string
14686 (substring tf 1 -1) (apply 'encode-time time))
14687 nil 'mouse-face 'highlight)
14688 w2 (length str))
14689 (if (not (= w2 w1))
14690 (add-text-properties (1+ beg) (+ 2 beg)
14691 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14692 (if (featurep 'xemacs)
14693 (progn
14694 (put-text-property beg end 'invisible t)
14695 (put-text-property beg end 'end-glyph (make-glyph str)))
14696 (put-text-property beg end 'display str))))
14698 (defun org-translate-time (string)
14699 "Translate all timestamps in STRING to custom format.
14700 But do this only if the variable `org-display-custom-times' is set."
14701 (when org-display-custom-times
14702 (save-match-data
14703 (let* ((start 0)
14704 (re org-ts-regexp-both)
14705 t1 with-hm inactive tf time str beg end)
14706 (while (setq start (string-match re string start))
14707 (setq beg (match-beginning 0)
14708 end (match-end 0)
14709 t1 (save-match-data
14710 (org-parse-time-string (substring string beg end) t))
14711 with-hm (and (nth 1 t1) (nth 2 t1))
14712 inactive (equal (substring string beg (1+ beg)) "[")
14713 tf (funcall (if with-hm 'cdr 'car)
14714 org-time-stamp-custom-formats)
14715 time (org-fix-decoded-time t1)
14716 str (format-time-string
14717 (concat
14718 (if inactive "[" "<") (substring tf 1 -1)
14719 (if inactive "]" ">"))
14720 (apply 'encode-time time))
14721 string (replace-match str t t string)
14722 start (+ start (length str)))))))
14723 string)
14725 (defun org-fix-decoded-time (time)
14726 "Set 0 instead of nil for the first 6 elements of time.
14727 Don't touch the rest."
14728 (let ((n 0))
14729 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14731 (defun org-days-to-time (timestamp-string)
14732 "Difference between TIMESTAMP-STRING and now in days."
14733 (- (time-to-days (org-time-string-to-time timestamp-string))
14734 (time-to-days (current-time))))
14736 (defun org-deadline-close (timestamp-string &optional ndays)
14737 "Is the time in TIMESTAMP-STRING close to the current date?"
14738 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14739 (and (< (org-days-to-time timestamp-string) ndays)
14740 (not (org-entry-is-done-p))))
14742 (defun org-get-wdays (ts)
14743 "Get the deadline lead time appropriate for timestring TS."
14744 (cond
14745 ((<= org-deadline-warning-days 0)
14746 ;; 0 or negative, enforce this value no matter what
14747 (- org-deadline-warning-days))
14749 ;; lead time is specified.
14750 (floor (* (string-to-number (match-string 1 ts))
14751 (cdr (assoc (match-string 2 ts)
14752 '(("d" . 1) ("w" . 7)
14753 ("m" . 30.4) ("y" . 365.25)))))))
14754 ;; go for the default.
14755 (t org-deadline-warning-days)))
14757 (defun org-calendar-select-mouse (ev)
14758 "Return to `org-read-date' with the date currently selected.
14759 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14760 (interactive "e")
14761 (mouse-set-point ev)
14762 (when (calendar-cursor-to-date)
14763 (let* ((date (calendar-cursor-to-date))
14764 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14765 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14766 (if (active-minibuffer-window) (exit-minibuffer))))
14768 (defun org-check-deadlines (ndays)
14769 "Check if there are any deadlines due or past due.
14770 A deadline is considered due if it happens within `org-deadline-warning-days'
14771 days from today's date. If the deadline appears in an entry marked DONE,
14772 it is not shown. The prefix arg NDAYS can be used to test that many
14774 (interactive "P")
14775 (let* ((org-warn-days
14776 (cond
14777 ((equal ndays '(4)) 100000)
14778 (ndays (prefix-numeric-value ndays))
14779 (t (abs org-deadline-warning-days))))
14780 (case-fold-search nil)
14782 (callback
14783 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14785 (message "%d deadlines past-due or due within %d days"
14786 (org-occur regexp nil callback)
14787 org-warn-days)))
14789 (defun org-check-before-date (date)
14790 "Check if there are deadlines or scheduled entries before DATE."
14791 (interactive (list (org-read-date)))
14792 (let ((case-fold-search nil)
14796 (callback
14797 (lambda () (time-less-p
14798 (org-time-string-to-time (match-string 2))
14799 (org-time-string-to-time date)))))
14800 (message "%d entries before %s"
14801 (org-occur regexp nil callback) date)))
14803 (defun org-check-after-date (date)
14804 "Check if there are deadlines or scheduled entries after DATE."
14805 (interactive (list (org-read-date)))
14806 (let ((case-fold-search nil)
14810 (callback
14811 (lambda () (not
14812 (time-less-p
14813 (org-time-string-to-time (match-string 2))
14814 (org-time-string-to-time date))))))
14815 (message "%d entries after %s"
14816 (org-occur regexp nil callback) date)))
14818 (defun org-evaluate-time-range (&optional to-buffer)
14819 "Evaluate a time range by computing the difference between start and end.
14820 Normally the result is just printed in the echo area, but with prefix arg
14821 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14822 If the time range is actually in a table, the result is inserted into the
14823 next column.
14824 For time difference computation, a year is assumed to be exactly 365
14825 days in order to avoid rounding problems."
14826 (interactive "P")
14827 (or
14828 (org-clock-update-time-maybe)
14829 (save-excursion
14830 (unless (org-at-date-range-p t)
14831 (goto-char (point-at-bol))
14832 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14833 (if (not (org-at-date-range-p t))
14834 (error "Not at a time-stamp range, and none found in current line")))
14835 (let* ((ts1 (match-string 1))
14836 (ts2 (match-string 2))
14837 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14838 (match-end (match-end 0))
14839 (time1 (org-time-string-to-time ts1))
14840 (time2 (org-time-string-to-time ts2))
14841 (t1 (org-float-time time1))
14842 (t2 (org-float-time time2))
14843 (diff (abs (- t2 t1)))
14844 (negative (< (- t2 t1) 0))
14845 ;; (ys (floor (* 365 24 60 60)))
14846 (ds (* 24 60 60))
14847 (hs (* 60 60))
14848 (fy "%dy %dd %02d:%02d")
14849 (fy1 "%dy %dd")
14850 (fd "%dd %02d:%02d")
14851 (fd1 "%dd")
14852 (fh "%02d:%02d")
14853 y d h m align)
14854 (if havetime
14855 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14856 y 0
14857 d (floor (/ diff ds)) diff (mod diff ds)
14858 h (floor (/ diff hs)) diff (mod diff hs)
14859 m (floor (/ diff 60)))
14860 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14861 y 0
14862 d (floor (+ (/ diff ds) 0.5))
14863 h 0 m 0))
14864 (if (not to-buffer)
14865 (message "%s" (org-make-tdiff-string y d h m))
14866 (if (org-at-table-p)
14867 (progn
14868 (goto-char match-end)
14869 (setq align t)
14870 (and (looking-at " *|") (goto-char (match-end 0))))
14871 (goto-char match-end))
14872 (if (looking-at
14874 (replace-match ""))
14875 (if negative (insert " -"))
14876 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14877 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14878 (insert " " (format fh h m))))
14879 (if align (org-table-align))
14880 (message "Time difference inserted")))))
14882 (defun org-make-tdiff-string (y d h m)
14883 (let ((fmt "")
14884 (l nil))
14885 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14886 l (push y l)))
14887 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14888 l (push d l)))
14889 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14890 l (push h l)))
14891 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14892 l (push m l)))
14893 (apply 'format fmt (nreverse l))))
14895 (defun org-time-string-to-time (s)
14896 (apply 'encode-time (org-parse-time-string s)))
14897 (defun org-time-string-to-seconds (s)
14898 (org-float-time (org-time-string-to-time s)))
14900 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14901 "Convert a time stamp to an absolute day number.
14902 If there is a specifier for a cyclic time stamp, get the closest date to
14903 DAYNR.
14904 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14905 the variable date is bound by the calendar when this is called."
14906 (cond
14908 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14909 daynr
14910 (+ daynr 1000)))
14912 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14913 (time-to-days (current-time))) (match-string 0 s)
14914 prefer show-all))
14915 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14917 (defun org-days-to-iso-week (days)
14918 "Return the iso week number."
14919 (require 'cal-iso)
14920 (car (calendar-iso-from-absolute days)))
14922 (defun org-small-year-to-year (year)
14923 "Convert 2-digit years into 4-digit years.
14924 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14925 The year 2000 cannot be abbreviated. Any year larger than 99
14926 is returned unchanged."
14927 (if (< year 38)
14928 (setq year (+ 2000 year))
14929 (if (< year 100)
14930 (setq year (+ 1900 year))))
14931 year)
14933 (defun org-time-from-absolute (d)
14934 "Return the time corresponding to date D.
14935 D may be an absolute day number, or a calendar-type list (month day year)."
14936 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14937 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14939 (defun org-calendar-holiday ()
14940 "List of holidays, for Diary display in Org-mode."
14941 (require 'holidays)
14942 (let ((hl (funcall
14943 (if (fboundp 'calendar-check-holidays)
14944 'calendar-check-holidays 'check-calendar-holidays) date)))
14945 (if hl (mapconcat 'identity hl "; "))))
14947 (defun org-diary-sexp-entry (sexp entry date)
14948 "Process a SEXP diary ENTRY for DATE."
14949 (require 'diary-lib)
14950 (let ((result (if calendar-debug-sexp
14951 (let ((stack-trace-on-error t))
14952 (eval (car (read-from-string sexp))))
14953 (condition-case nil
14954 (eval (car (read-from-string sexp)))
14955 (error
14956 (beep)
14957 (message "Bad sexp at line %d in %s: %s"
14958 (org-current-line)
14959 (buffer-file-name) sexp)
14960 (sleep-for 2))))))
14961 (cond ((stringp result) result)
14962 ((and (consp result)
14963 (stringp (cdr result))) (cdr result))
14964 (result entry)
14965 (t nil))))
14967 (defun org-diary-to-ical-string (frombuf)
14968 "Get iCalendar entries from diary entries in buffer FROMBUF.
14969 This uses the icalendar.el library."
14970 (let* ((tmpdir (if (featurep 'xemacs)
14971 (temp-directory)
14972 temporary-file-directory))
14973 (tmpfile (make-temp-name
14974 (expand-file-name "orgics" tmpdir)))
14975 buf rtn b e)
14976 (with-current-buffer frombuf
14977 (icalendar-export-region (point-min) (point-max) tmpfile)
14978 (setq buf (find-buffer-visiting tmpfile))
14979 (set-buffer buf)
14980 (goto-char (point-min))
14981 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14982 (setq b (match-beginning 0)))
14983 (goto-char (point-max))
14984 (if (re-search-backward "^END:VEVENT" nil t)
14985 (setq e (match-end 0)))
14987 (kill-buffer buf)
14988 (delete-file tmpfile)
14989 rtn))
14991 (defun org-closest-date (start current change prefer show-all)
14992 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14993 When PREFER is `past' return a date that is either CURRENT or past.
14994 When PREFER is `future', return a date that is either CURRENT or future.
14995 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14996 ;; Make the proper lists from the dates
14997 (catch 'exit
14998 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
14999 dn dw sday cday n1 n2 n0
15000 d m y y1 y2 date1 date2 nmonths nm ny m2)
15002 (setq start (org-date-to-gregorian start)
15003 current (org-date-to-gregorian
15004 (if show-all
15005 current
15006 (time-to-days (current-time))))
15007 sday (calendar-absolute-from-gregorian start)
15008 cday (calendar-absolute-from-gregorian current))
15010 (if (<= cday sday) (throw 'exit sday))
15013 (setq dn (string-to-number (match-string 1 change))
15014 dw (cdr (assoc (match-string 2 change) a1)))
15015 (error "Invalid change specifier: %s" change))
15016 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15017 (cond
15018 ((eq dw 'day)
15019 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15020 n2 (+ n1 dn)))
15021 ((eq dw 'year)
15022 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15023 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15024 (setq date1 (list m d y1)
15025 n1 (calendar-absolute-from-gregorian date1)
15026 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15027 n2 (calendar-absolute-from-gregorian date2)))
15028 ((eq dw 'month)
15029 ;; approx number of month between the two dates
15030 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15031 ;; How often does dn fit in there?
15032 (setq d (nth 1 start) m (car start) y (nth 2 start)
15033 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15034 m (+ m nm)
15035 ny (floor (/ m 12))
15036 y (+ y ny)
15037 m (- m (* ny 12)))
15038 (while (> m 12) (setq m (- m 12) y (1+ y)))
15039 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15040 (setq m2 (+ m dn) y2 y)
15041 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15042 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15043 (while (<= n2 cday)
15044 (setq n1 n2 m m2 y y2)
15045 (setq m2 (+ m dn) y2 y)
15046 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15047 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15048 ;; Make sure n1 is the earlier date
15049 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15050 (if show-all
15051 (cond
15052 ((eq prefer 'past) (if (= cday n2) n2 n1))
15053 ((eq prefer 'future) (if (= cday n1) n1 n2))
15054 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15055 (cond
15056 ((eq prefer 'past) (if (= cday n2) n2 n1))
15057 ((eq prefer 'future) (if (= cday n1) n1 n2))
15058 (t (if (= cday n1) n1 n2)))))))
15060 (defun org-date-to-gregorian (date)
15061 "Turn any specification of DATE into a Gregorian date for the calendar."
15062 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15063 ((and (listp date) (= (length date) 3)) date)
15064 ((stringp date)
15065 (setq date (org-parse-time-string date))
15066 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15067 ((listp date)
15068 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15070 (defun org-parse-time-string (s &optional nodefault)
15071 "Parse the standard Org-mode time string.
15072 This should be a lot faster than the normal `parse-time-string'.
15073 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15074 hour and minute fields will be nil if not given."
15075 (if (string-match org-ts-regexp0 s)
15076 (list 0
15077 (if (or (match-beginning 8) (not nodefault))
15078 (string-to-number (or (match-string 8 s) "0")))
15079 (if (or (match-beginning 7) (not nodefault))
15080 (string-to-number (or (match-string 7 s) "0")))
15081 (string-to-number (match-string 4 s))
15082 (string-to-number (match-string 3 s))
15083 (string-to-number (match-string 2 s))
15084 nil nil nil)
15085 (error "Not a standard Org-mode time string: %s" s)))
15087 (defun org-timestamp-up (&optional arg)
15088 "Increase the date item at the cursor by one.
15089 If the cursor is on the year, change the year. If it is on the month or
15090 the day, change that.
15091 With prefix ARG, change by that many units."
15092 (interactive "p")
15093 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15095 (defun org-timestamp-down (&optional arg)
15096 "Decrease the date item at the cursor by one.
15097 If the cursor is on the year, change the year. If it is on the month or
15098 the day, change that.
15099 With prefix ARG, change by that many units."
15100 (interactive "p")
15101 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15103 (defun org-timestamp-up-day (&optional arg)
15104 "Increase the date in the time stamp by one day.
15105 With prefix ARG, change that many days."
15106 (interactive "p")
15107 (if (and (not (org-at-timestamp-p t))
15108 (org-on-heading-p))
15109 (org-todo 'up)
15110 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15112 (defun org-timestamp-down-day (&optional arg)
15113 "Decrease the date in the time stamp by one day.
15114 With prefix ARG, change that many days."
15115 (interactive "p")
15116 (if (and (not (org-at-timestamp-p t))
15117 (org-on-heading-p))
15118 (org-todo 'down)
15119 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15121 (defun org-at-timestamp-p (&optional inactive-ok)
15122 "Determine if the cursor is in or at a timestamp."
15123 (interactive)
15124 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15125 (pos (point))
15126 (ans (or (looking-at tsr)
15127 (save-excursion
15129 (if (> (point) (point-min)) (backward-char 1))
15130 (and (looking-at tsr)
15131 (> (- (match-end 0) pos) -1))))))
15132 (and ans
15133 (boundp 'org-ts-what)
15134 (setq org-ts-what
15135 (cond
15136 ((= pos (match-beginning 0)) 'bracket)
15137 ((= pos (1- (match-end 0))) 'bracket)
15138 ((org-pos-in-match-range pos 2) 'year)
15139 ((org-pos-in-match-range pos 3) 'month)
15140 ((org-pos-in-match-range pos 7) 'hour)
15141 ((org-pos-in-match-range pos 8) 'minute)
15142 ((or (org-pos-in-match-range pos 4)
15143 (org-pos-in-match-range pos 5)) 'day)
15144 ((and (> pos (or (match-end 8) (match-end 5)))
15145 (< pos (match-end 0)))
15146 (- pos (or (match-end 8) (match-end 5))))
15147 (t 'day))))
15148 ans))
15150 (defun org-toggle-timestamp-type ()
15151 "Toggle the type (<active> or [inactive]) of a time stamp."
15152 (interactive)
15153 (when (org-at-timestamp-p t)
15154 (let ((beg (match-beginning 0)) (end (match-end 0))
15155 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15156 (save-excursion
15157 (goto-char beg)
15158 (while (re-search-forward "[][<>]" end t)
15159 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15160 t t)))
15161 (message "Timestamp is now %sactive"
15162 (if (equal (char-after beg) ?<) "" "in")))))
15164 (defun org-timestamp-change (n &optional what updown)
15165 "Change the date in the time stamp at point.
15166 The date will be changed by N times WHAT. WHAT can be `day', `month',
15167 `year', `minute', `second'. If WHAT is not given, the cursor position
15168 in the timestamp determines what will be changed."
15169 (let ((pos (point))
15170 with-hm inactive
15171 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15172 org-ts-what
15173 extra rem
15174 ts time time0)
15175 (if (not (org-at-timestamp-p t))
15176 (error "Not at a timestamp"))
15177 (if (and (not what) (eq org-ts-what 'bracket))
15178 (org-toggle-timestamp-type)
15179 (if (and (not what) (not (eq org-ts-what 'day))
15180 org-display-custom-times
15181 (get-text-property (point) 'display)
15182 (not (get-text-property (1- (point)) 'display)))
15183 (setq org-ts-what 'day))
15184 (setq org-ts-what (or what org-ts-what)
15185 inactive (= (char-after (match-beginning 0)) ?\[)
15186 ts (match-string 0))
15187 (replace-match "")
15188 (if (string-match
15190 ts)
15191 (setq extra (match-string 1 ts)))
15193 (setq with-hm t))
15194 (setq time0 (org-parse-time-string ts))
15195 (when (and updown
15196 (eq org-ts-what 'minute)
15197 (not current-prefix-arg))
15198 ;; This looks like s-up and s-down. Change by one rounding step.
15199 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15200 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15201 (setcar (cdr time0) (+ (nth 1 time0)
15202 (if (> n 0) (- rem) (- dm rem))))))
15203 (setq time
15204 (encode-time (or (car time0) 0)
15205 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15206 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15207 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15208 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15209 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15210 (nthcdr 6 time0)))
15211 (when (and (member org-ts-what '(hour minute))
15212 extra
15214 (setq extra (org-modify-ts-extra
15215 extra
15216 (if (eq org-ts-what 'hour) 2 5)
15217 n dm)))
15218 (when (integerp org-ts-what)
15219 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15220 (if (eq what 'calendar)
15221 (let ((cal-date (org-get-date-from-calendar)))
15222 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15223 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15224 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15225 (setcar time0 (or (car time0) 0))
15226 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15227 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15228 (setq time (apply 'encode-time time0))))
15229 (setq org-last-changed-timestamp
15230 (org-insert-time-stamp time with-hm inactive nil nil extra))
15231 (org-clock-update-time-maybe)
15232 (goto-char pos)
15233 ;; Try to recenter the calendar window, if any
15234 (if (and org-calendar-follow-timestamp-change
15235 (get-buffer-window "*Calendar*" t)
15236 (memq org-ts-what '(day month year)))
15237 (org-recenter-calendar (time-to-days time))))))
15239 (defun org-modify-ts-extra (s pos n dm)
15240 "Change the different parts of the lead-time and repeat fields in timestamp."
15241 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15242 ng h m new rem)
15243 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15244 (cond
15245 ((or (org-pos-in-match-range pos 2)
15246 (org-pos-in-match-range pos 3))
15247 (setq m (string-to-number (match-string 3 s))
15248 h (string-to-number (match-string 2 s)))
15249 (if (org-pos-in-match-range pos 2)
15250 (setq h (+ h n))
15251 (setq n (* dm (org-no-warnings (signum n))))
15252 (when (not (= 0 (setq rem (% m dm))))
15253 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15254 (setq m (+ m n)))
15255 (if (< m 0) (setq m (+ m 60) h (1- h)))
15256 (if (> m 59) (setq m (- m 60) h (1+ h)))
15257 (setq h (min 24 (max 0 h)))
15258 (setq ng 1 new (format "-%02d:%02d" h m)))
15259 ((org-pos-in-match-range pos 6)
15260 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15261 ((org-pos-in-match-range pos 5)
15262 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15264 ((org-pos-in-match-range pos 9)
15265 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15266 ((org-pos-in-match-range pos 8)
15267 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15269 (when ng
15270 (setq s (concat
15271 (substring s 0 (match-beginning ng))
15272 new
15273 (substring s (match-end ng))))))
15274 s))
15276 (defun org-recenter-calendar (date)
15277 "If the calendar is visible, recenter it to DATE."
15278 (let* ((win (selected-window))
15279 (cwin (get-buffer-window "*Calendar*" t))
15280 (calendar-move-hook nil))
15281 (when cwin
15282 (select-window cwin)
15283 (calendar-goto-date (if (listp date) date
15284 (calendar-gregorian-from-absolute date)))
15285 (select-window win))))
15287 (defun org-goto-calendar (&optional arg)
15288 "Go to the Emacs calendar at the current date.
15289 If there is a time stamp in the current line, go to that date.
15290 A prefix ARG can be used to force the current date."
15291 (interactive "P")
15292 (let ((tsr org-ts-regexp) diff
15293 (calendar-move-hook nil)
15294 (calendar-view-holidays-initially-flag nil)
15295 (calendar-view-diary-initially-flag nil))
15296 (if (or (org-at-timestamp-p)
15297 (save-excursion
15298 (beginning-of-line 1)
15299 (looking-at (concat ".*" tsr))))
15300 (let ((d1 (time-to-days (current-time)))
15301 (d2 (time-to-days
15302 (org-time-string-to-time (match-string 1)))))
15303 (setq diff (- d2 d1))))
15304 (calendar)
15305 (calendar-goto-today)
15306 (if (and diff (not arg)) (calendar-forward-day diff))))
15308 (defun org-get-date-from-calendar ()
15309 "Return a list (month day year) of date at point in calendar."
15310 (with-current-buffer "*Calendar*"
15311 (save-match-data
15312 (calendar-cursor-to-date))))
15314 (defun org-date-from-calendar ()
15315 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15316 If there is already a time stamp at the cursor position, update it."
15317 (interactive)
15318 (if (org-at-timestamp-p t)
15319 (org-timestamp-change 0 'calendar)
15320 (let ((cal-date (org-get-date-from-calendar)))
15321 (org-insert-time-stamp
15322 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15324 (defun org-minutes-to-hh:mm-string (m)
15325 "Compute H:MM from a number of minutes."
15326 (let ((h (/ m 60)))
15327 (setq m (- m (* 60 h)))
15328 (format org-time-clocksum-format h m)))
15330 (defun org-hh:mm-string-to-minutes (s)
15331 "Convert a string H:MM to a number of minutes.
15332 If the string is just a number, interpret it as minutes.
15333 In fact, the first hh:mm or number in the string will be taken,
15334 there can be extra stuff in the string.
15335 If no number is found, the return value is 0."
15336 (cond
15338 (+ (* (string-to-number (match-string 1 s)) 60)
15339 (string-to-number (match-string 2 s))))
15341 (string-to-number (match-string 1 s)))
15342 (t 0)))
15344 ;;;; Files
15346 (defun org-save-all-org-buffers ()
15347 "Save all Org-mode buffers without user confirmation."
15348 (interactive)
15349 (message "Saving all Org-mode buffers...")
15350 (save-some-buffers t 'org-mode-p)
15351 (when (featurep 'org-id) (org-id-locations-save))
15352 (message "Saving all Org-mode buffers... done"))
15354 (defun org-revert-all-org-buffers ()
15355 "Revert all Org-mode buffers.
15356 Prompt for confirmation when there are unsaved changes.
15357 Be sure you know what you are doing before letting this function
15358 overwrite your changes.
15360 This function is useful in a setup where one tracks org files
15361 with a version control system, to revert on one machine after pulling
15362 changes from another. I believe the procedure must be like this:
15364 1. M-x org-save-all-org-buffers
15365 2. Pull changes from the other machine, resolve conflicts
15366 3. M-x org-revert-all-org-buffers"
15367 (interactive)
15368 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15369 (error "Abort"))
15370 (save-excursion
15371 (save-window-excursion
15372 (mapc
15373 (lambda (b)
15374 (when (and (with-current-buffer b (org-mode-p))
15375 (with-current-buffer b buffer-file-name))
15376 (switch-to-buffer b)
15377 (revert-buffer t 'no-confirm)))
15378 (buffer-list))
15379 (when (and (featurep 'org-id) org-id-track-globally)
15380 (org-id-locations-load)))))
15382 ;;;; Agenda files
15384 ;;;###autoload
15385 (defun org-switchb (&optional arg)
15386 "Switch between Org buffers.
15387 With a prefix argument, restrict available to files.
15388 With two prefix arguments, restrict available buffers to agenda files.
15390 Defaults to `iswitchb' for buffer name completion.
15391 Set `org-completion-use-ido' to make it use ido instead."
15392 (interactive "P")
15393 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15394 ((equal arg '(16)) (org-buffer-list 'agenda))
15395 (t (org-buffer-list))))
15396 (org-completion-use-iswitchb org-completion-use-iswitchb)
15397 (org-completion-use-ido org-completion-use-ido))
15398 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15399 (setq org-completion-use-iswitchb t))
15400 (switch-to-buffer
15401 (org-icompleting-read "Org buffer: "
15402 (mapcar 'list (mapcar 'buffer-name blist))
15403 nil t))))
15405 ;;; Define some older names previously used for this functionality
15406 ;;;###autoload
15407 (defalias 'org-ido-switchb 'org-switchb)
15408 ;;;###autoload
15409 (defalias 'org-iswitchb 'org-switchb)
15411 (defun org-buffer-list (&optional predicate exclude-tmp)
15412 "Return a list of Org buffers.
15413 PREDICATE can be `export', `files' or `agenda'.
15415 export restrict the list to Export buffers.
15416 files restrict the list to buffers visiting Org files.
15417 agenda restrict the list to buffers visiting agenda files.
15419 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15420 (let* ((bfn nil)
15421 (agenda-files (and (eq predicate 'agenda)
15422 (mapcar 'file-truename (org-agenda-files t))))
15423 (filter
15424 (cond
15425 ((eq predicate 'files)
15426 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15427 ((eq predicate 'export)
15428 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15429 ((eq predicate 'agenda)
15430 (lambda (b)
15431 (with-current-buffer b
15432 (and (eq major-mode 'org-mode)
15433 (setq bfn (buffer-file-name b))
15434 (member (file-truename bfn) agenda-files)))))
15435 (t (lambda (b) (with-current-buffer b
15436 (or (eq major-mode 'org-mode)
15437 (string-match "\*Org .*Export"
15438 (buffer-name b)))))))))
15439 (delq nil
15440 (mapcar
15441 (lambda(b)
15442 (if (and (funcall filter b)
15443 (or (not exclude-tmp)
15444 (not (string-match "tmp" (buffer-name b)))))
15445 b
15446 nil))
15447 (buffer-list)))))
15449 (defun org-agenda-files (&optional unrestricted archives)
15450 "Get the list of agenda files.
15451 Optional UNRESTRICTED means return the full list even if a restriction
15452 is currently in place.
15453 When ARCHIVES is t, include all archive files that are really being
15454 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15455 `org-agenda-archives-mode' is t."
15456 (let ((files
15457 (cond
15458 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15459 ((stringp org-agenda-files) (org-read-agenda-file-list))
15460 ((listp org-agenda-files) org-agenda-files)
15461 (t (error "Invalid value of `org-agenda-files'")))))
15462 (setq files (apply 'append
15463 (mapcar (lambda (f)
15464 (if (file-directory-p f)
15465 (directory-files
15466 f t org-agenda-file-regexp)
15467 (list f)))
15468 files)))
15469 (when org-agenda-skip-unavailable-files
15470 (setq files (delq nil
15471 (mapcar (function
15472 (lambda (file)
15473 (and (file-readable-p file) file)))
15474 files))))
15475 (when (or (eq archives t)
15476 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15477 (setq files (org-add-archive-files files)))
15478 files))
15480 (defun org-agenda-file-p (&optional file)
15481 "Return non-nil, if FILE is an agenda file.
15482 If FILE is omitted, use the file associated with the current
15483 buffer."
15484 (member (or file (buffer-file-name))
15485 (org-agenda-files t)))
15487 (defun org-edit-agenda-file-list ()
15488 "Edit the list of agenda files.
15489 Depending on setup, this either uses customize to edit the variable
15490 `org-agenda-files', or it visits the file that is holding the list. In the
15491 latter case, the buffer is set up in a way that saving it automatically kills
15492 the buffer and restores the previous window configuration."
15493 (interactive)
15494 (if (stringp org-agenda-files)
15495 (let ((cw (current-window-configuration)))
15496 (find-file org-agenda-files)
15497 (org-set-local 'org-window-configuration cw)
15498 (org-add-hook 'after-save-hook
15499 (lambda ()
15500 (set-window-configuration
15501 (prog1 org-window-configuration
15502 (kill-buffer (current-buffer))))
15503 (org-install-agenda-files-menu)
15504 (message "New agenda file list installed"))
15505 nil 'local)
15506 (message "%s" (substitute-command-keys
15508 (customize-variable 'org-agenda-files)))
15510 (defun org-store-new-agenda-file-list (list)
15511 "Set new value for the agenda file list and save it correctly."
15512 (if (stringp org-agenda-files)
15513 (let ((fe (org-read-agenda-file-list t)) b u)
15514 (while (setq b (find-buffer-visiting org-agenda-files))
15515 (kill-buffer b))
15516 (with-temp-file org-agenda-files
15517 (insert
15518 (mapconcat
15519 (lambda (f) ;; Keep un-expanded entries.
15520 (if (setq u (assoc f fe))
15521 (cdr u)
15522 f))
15525 (let ((org-mode-hook nil) (org-inhibit-startup t)
15526 (org-insert-mode-line-in-empty-file nil))
15527 (setq org-agenda-files list)
15528 (customize-save-variable 'org-agenda-files org-agenda-files))))
15530 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15531 "Read the list of agenda files from a file.
15532 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15533 filenames, used by `org-store-new-agenda-file-list' to write back
15534 un-expanded file names."
15535 (when (file-directory-p org-agenda-files)
15536 (error "`org-agenda-files' cannot be a single directory"))
15537 (when (stringp org-agenda-files)
15538 (with-temp-buffer
15539 (insert-file-contents org-agenda-files)
15540 (mapcar
15541 (lambda (f)
15542 (let ((e (expand-file-name (substitute-in-file-name f)
15543 org-directory)))
15544 (if pair-with-expansion
15545 (cons e f)
15546 e)))
15549 ;;;###autoload
15550 (defun org-cycle-agenda-files ()
15551 "Cycle through the files in `org-agenda-files'.
15552 If the current buffer visits an agenda file, find the next one in the list.
15553 If the current buffer does not, find the first agenda file."
15554 (interactive)
15555 (let* ((fs (org-agenda-files t))
15556 (files (append fs (list (car fs))))
15557 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15558 file)
15559 (unless files (error "No agenda files"))
15560 (catch 'exit
15561 (while (setq file (pop files))
15562 (if (equal (file-truename file) tcf)
15563 (when (car files)
15564 (find-file (car files))
15565 (throw 'exit t))))
15566 (find-file (car fs)))
15567 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15569 (defun org-agenda-file-to-front (&optional to-end)
15570 "Move/add the current file to the top of the agenda file list.
15571 If the file is not present in the list, it is added to the front. If it is
15572 present, it is moved there. With optional argument TO-END, add/move to the
15573 end of the list."
15574 (interactive "P")
15575 (let ((org-agenda-skip-unavailable-files nil)
15576 (file-alist (mapcar (lambda (x)
15577 (cons (file-truename x) x))
15578 (org-agenda-files t)))
15579 (ctf (file-truename buffer-file-name))
15580 x had)
15581 (setq x (assoc ctf file-alist) had x)
15583 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15584 (if to-end
15585 (setq file-alist (append (delq x file-alist) (list x)))
15586 (setq file-alist (cons x (delq x file-alist))))
15587 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15588 (org-install-agenda-files-menu)
15589 (message "File %s to %s of agenda file list"
15590 (if had "moved" "added") (if to-end "end" "front"))))
15592 (defun org-remove-file (&optional file)
15593 "Remove current file from the list of files in variable `org-agenda-files'.
15594 These are the files which are being checked for agenda entries.
15595 Optional argument FILE means use this file instead of the current."
15596 (interactive)
15597 (let* ((org-agenda-skip-unavailable-files nil)
15598 (file (or file buffer-file-name))
15599 (true-file (file-truename file))
15600 (afile (abbreviate-file-name file))
15601 (files (delq nil (mapcar
15602 (lambda (x)
15603 (if (equal true-file
15604 (file-truename x))
15605 nil x))
15606 (org-agenda-files t)))))
15607 (if (not (= (length files) (length (org-agenda-files t))))
15608 (progn
15609 (org-store-new-agenda-file-list files)
15610 (org-install-agenda-files-menu)
15611 (message "Removed file: %s" afile))
15612 (message "File was not in list: %s (not removed)" afile))))
15614 (defun org-file-menu-entry (file)
15615 (vector file (list 'find-file file) t))
15617 (defun org-check-agenda-file (file)
15618 "Make sure FILE exists. If not, ask user what to do."
15619 (when (not (file-exists-p file))
15620 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15621 (abbreviate-file-name file))
15622 (let ((r (downcase (read-char-exclusive))))
15623 (cond
15624 ((equal r ?r)
15625 (org-remove-file file)
15626 (throw 'nextfile t))
15627 (t (error "Abort"))))))
15629 (defun org-get-agenda-file-buffer (file)
15630 "Get a buffer visiting FILE. If the buffer needs to be created, add
15631 it to the list of buffers which might be released later."
15632 (let ((buf (org-find-base-buffer-visiting file)))
15633 (if buf
15634 buf ; just return it
15635 ;; Make a new buffer and remember it
15636 (setq buf (find-file-noselect file))
15637 (if buf (push buf org-agenda-new-buffers))
15638 buf)))
15640 (defun org-release-buffers (blist)
15641 "Release all buffers in list, asking the user for confirmation when needed.
15642 When a buffer is unmodified, it is just killed. When modified, it is saved
15643 \(if the user agrees) and then killed."
15644 (let (buf file)
15645 (while (setq buf (pop blist))
15646 (setq file (buffer-file-name buf))
15647 (when (and (buffer-modified-p buf)
15648 file
15649 (y-or-n-p (format "Save file %s? " file)))
15650 (with-current-buffer buf (save-buffer)))
15651 (kill-buffer buf))))
15653 (defun org-prepare-agenda-buffers (files)
15654 "Create buffers for all agenda files, protect archived trees and comments."
15655 (interactive)
15656 (let ((pa '(:org-archived t))
15657 (pc '(:org-comment t))
15658 (pall '(:org-archived t :org-comment t))
15659 (inhibit-read-only t)
15660 (rea (concat ":" org-archive-tag ":"))
15661 bmp file re)
15662 (save-excursion
15663 (save-restriction
15664 (while (setq file (pop files))
15665 (catch 'nextfile
15666 (if (bufferp file)
15667 (set-buffer file)
15668 (org-check-agenda-file file)
15669 (set-buffer (org-get-agenda-file-buffer file)))
15670 (widen)
15671 (setq bmp (buffer-modified-p))
15672 (org-refresh-category-properties)
15673 (setq org-todo-keywords-for-agenda
15674 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15675 (setq org-done-keywords-for-agenda
15676 (append org-done-keywords-for-agenda org-done-keywords))
15677 (setq org-todo-keyword-alist-for-agenda
15678 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15679 (setq org-drawers-for-agenda
15680 (append org-drawers-for-agenda org-drawers))
15681 (setq org-tag-alist-for-agenda
15682 (append org-tag-alist-for-agenda org-tag-alist))
15684 (save-excursion
15685 (remove-text-properties (point-min) (point-max) pall)
15686 (when org-agenda-skip-archived-trees
15687 (goto-char (point-min))
15688 (while (re-search-forward rea nil t)
15689 (if (org-on-heading-p t)
15690 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15691 (goto-char (point-min))
15693 (while (re-search-forward re nil t)
15694 (add-text-properties
15695 (match-beginning 0) (org-end-of-subtree t) pc)))
15696 (set-buffer-modified-p bmp)))))
15697 (setq org-todo-keywords-for-agenda
15698 (org-uniquify org-todo-keywords-for-agenda))
15699 (setq org-todo-keyword-alist-for-agenda
15700 (org-uniquify org-todo-keyword-alist-for-agenda)
15701 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15703 ;;;; Embedded LaTeX
15705 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15706 "Keymap for the minor `org-cdlatex-mode'.")
15708 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15709 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15710 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15711 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15712 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15714 (defvar org-cdlatex-texmathp-advice-is-done nil
15715 "Flag remembering if we have applied the advice to texmathp already.")
15717 (define-minor-mode org-cdlatex-mode
15718 "Toggle the minor `org-cdlatex-mode'.
15719 This mode supports entering LaTeX environment and math in LaTeX fragments
15720 in Org-mode.
15722 nil " OCDL" nil
15723 (when org-cdlatex-mode (require 'cdlatex))
15724 (unless org-cdlatex-texmathp-advice-is-done
15725 (setq org-cdlatex-texmathp-advice-is-done t)
15726 (defadvice texmathp (around org-math-always-on activate)
15727 "Always return t in org-mode buffers.
15728 This is because we want to insert math symbols without dollars even outside
15729 the LaTeX math segments. If Orgmode thinks that point is actually inside
15730 an embedded LaTeX fragment, let texmathp do its job.
15732 (interactive)
15733 (let (p)
15734 (cond
15735 ((not (org-mode-p)) ad-do-it)
15736 ((eq this-command 'cdlatex-math-symbol)
15737 (setq ad-return-value t
15738 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15739 (t
15740 (let ((p (org-inside-LaTeX-fragment-p)))
15741 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15742 (setq ad-return-value t
15743 texmathp-why '("Org-mode embedded math" . 0))
15744 (if p ad-do-it)))))))))
15746 (defun turn-on-org-cdlatex ()
15747 "Unconditionally turn on `org-cdlatex-mode'."
15748 (org-cdlatex-mode 1))
15750 (defun org-inside-LaTeX-fragment-p ()
15751 "Test if point is inside a LaTeX fragment.
15753 sequence appearing also before point.
15754 Even though the matchers for math are configurable, this function assumes
15756 delimiters are skipped when they have been removed by customization.
15757 The return value is nil, or a cons cell with the delimiter and
15758 and the position of this delimiter.
15760 This function does a reasonably good job, but can locally be fooled by
15761 for example currency specifications. For example it will assume being in
15763 fragments that are properly closed, but during editing, we have to live
15764 with the uncertainty caused by missing closing delimiters. This function
15765 looks only before point, not after."
15766 (catch 'exit
15767 (let ((pos (point))
15768 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15769 (lim (progn
15771 (point)))
15772 dd-on str (start 0) m re)
15773 (goto-char pos)
15774 (when dodollar
15776 re (nth 1 (assoc "$" org-latex-regexps)))
15777 (while (string-match re str start)
15778 (cond
15779 ((= (match-end 0) (length str))
15780 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15781 ((= (match-end 0) (- (length str) 5))
15782 (throw 'exit nil))
15783 (t (setq start (match-end 0))))))
15784 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15785 (goto-char pos)
15786 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15787 (and (match-beginning 2) (throw 'exit nil))
15788 ;; count $$
15790 (setq dd-on (not dd-on)))
15791 (goto-char pos)
15792 (if dd-on (cons "$$" m))))))
15794 (defun org-inside-latex-macro-p ()
15795 "Is point inside a LaTeX macro or its arguments?"
15796 (save-match-data
15797 (org-in-regexp
15800 (defun org-try-cdlatex-tab ()
15801 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15802 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15803 - inside a LaTeX fragment, or
15804 - after the first word in a line, where an abbreviation expansion could
15805 insert a LaTeX environment."
15806 (when org-cdlatex-mode
15807 (cond
15808 ((save-excursion
15809 (skip-chars-backward "a-zA-Z0-9*")
15811 (bolp))
15812 (cdlatex-tab) t)
15813 ((org-inside-LaTeX-fragment-p)
15814 (cdlatex-tab) t)
15815 (t nil))))
15817 (defun org-cdlatex-underscore-caret (&optional arg)
15818 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15819 Revert to the normal definition outside of these fragments."
15820 (interactive "P")
15821 (if (org-inside-LaTeX-fragment-p)
15822 (call-interactively 'cdlatex-sub-superscript)
15823 (let (org-cdlatex-mode)
15824 (call-interactively (key-binding (vector last-input-event))))))
15826 (defun org-cdlatex-math-modify (&optional arg)
15827 "Execute `cdlatex-math-modify' in LaTeX fragments.
15828 Revert to the normal definition outside of these fragments."
15829 (interactive "P")
15830 (if (org-inside-LaTeX-fragment-p)
15831 (call-interactively 'cdlatex-math-modify)
15832 (let (org-cdlatex-mode)
15833 (call-interactively (key-binding (vector last-input-event))))))
15835 (defvar org-latex-fragment-image-overlays nil
15836 "List of overlays carrying the images of latex fragments.")
15837 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15839 (defun org-remove-latex-fragment-image-overlays ()
15840 "Remove all overlays with LaTeX fragment images in current buffer."
15841 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15842 (setq org-latex-fragment-image-overlays nil))
15844 (defun org-preview-latex-fragment (&optional subtree)
15845 "Preview the LaTeX fragment at point, or all locally or globally.
15846 If the cursor is in a LaTeX fragment, create the image and overlay
15847 it over the source code. If there is no fragment at point, display
15848 all fragments in the current text, from one headline to the next. With
15849 prefix SUBTREE, display all fragments in the current subtree. With a
15851 the cursor is before the first headline,
15852 display all fragments in the buffer.
15854 (interactive "P")
15855 (org-remove-latex-fragment-image-overlays)
15856 (save-excursion
15857 (save-restriction
15858 (let (beg end at msg)
15859 (cond
15860 ((or (equal subtree '(16))
15861 (not (save-excursion
15862 (re-search-backward (concat "^" outline-regexp) nil t))))
15863 (setq beg (point-min) end (point-max)
15864 msg "Creating images for buffer...%s"))
15865 ((equal subtree '(4))
15866 (org-back-to-heading)
15867 (setq beg (point) end (org-end-of-subtree t)
15868 msg "Creating images for subtree...%s"))
15869 (t
15870 (if (setq at (org-inside-LaTeX-fragment-p))
15871 (goto-char (max (point-min) (- (cdr at) 2)))
15872 (org-back-to-heading))
15873 (setq beg (point) end (progn (outline-next-heading) (point))
15874 msg (if at "Creating image...%s"
15875 "Creating images for entry...%s"))))
15876 (message msg "")
15877 (narrow-to-region beg end)
15878 (goto-char beg)
15879 (org-format-latex
15880 (concat "ltxpng/" (file-name-sans-extension
15881 (file-name-nondirectory
15882 buffer-file-name)))
15883 default-directory 'overlays msg at 'forbuffer)
15884 (message msg "done. Use `C-c C-c' to remove images.")))))
15886 (defvar org-latex-regexps
15888 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15891 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15895 "Regular expressions for matching embedded LaTeX.")
15897 (defun org-format-latex (prefix &optional dir overlays msg at
15898 forbuffer protect-only)
15899 "Replace LaTeX fragments with links to an image, and produce images.
15900 Some of the options can be changed using the variable
15901 `org-format-latex-options'."
15902 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15903 (let* ((prefixnodir (file-name-nondirectory prefix))
15904 (absprefix (expand-file-name prefix dir))
15905 (todir (file-name-directory absprefix))
15906 (opt org-format-latex-options)
15907 (matchers (plist-get opt :matchers))
15908 (re-list org-latex-regexps)
15909 (org-format-latex-header-extra
15910 (plist-get (org-infile-export-plist) :latex-header-extra))
15911 (cnt 0) txt hash link beg end re e checkdir
15912 executables-checked
15913 m n block linkfile movefile ov)
15914 ;; Check the different regular expressions
15915 (while (setq e (pop re-list))
15916 (setq m (car e) re (nth 1 e) n (nth 2 e)
15918 (when (member m matchers)
15919 (goto-char (point-min))
15920 (while (re-search-forward re nil t)
15921 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15922 (not (get-text-property (match-beginning n)
15923 'org-protected))
15924 (or (not overlays)
15925 (not (eq (get-char-property (match-beginning n)
15926 'org-overlay-type)
15927 'org-latex-overlay))))
15928 (if protect-only
15929 (add-text-properties (match-beginning n) (match-end n)
15930 '(org-protected t))
15931 (setq txt (match-string n)
15932 beg (match-beginning n) end (match-end n)
15933 cnt (1+ cnt))
15934 (let (print-length print-level) ; make sure full list is printed
15935 (setq hash (sha1 (prin1-to-string
15936 (list org-format-latex-header
15937 org-format-latex-header-extra
15938 org-export-latex-default-packages-alist
15939 org-export-latex-packages-alist
15940 org-format-latex-options
15941 forbuffer txt)))
15942 linkfile (format "%s_%s.png" prefix hash)
15943 movefile (format "%s_%s.png" absprefix hash)))
15944 (setq link (concat block "[[file:" linkfile "]]" block))
15945 (if msg (message msg cnt))
15946 (goto-char beg)
15947 (unless checkdir ; make sure the directory exists
15948 (setq checkdir t)
15949 (or (file-directory-p todir) (make-directory todir t)))
15951 (unless executables-checked
15952 (org-check-external-command
15953 "latex" "needed to convert LaTeX fragments to images")
15954 (org-check-external-command
15955 "dvipng" "needed to convert LaTeX fragments to images")
15956 (setq executables-checked t))
15958 (unless (file-exists-p movefile)
15959 (org-create-formula-image
15960 txt movefile opt forbuffer))
15961 (if overlays
15962 (progn
15963 (mapc (lambda (o)
15964 (if (eq (overlay-get o 'org-overlay-type)
15965 'org-latex-overlay)
15966 (delete-overlay o)))
15967 (overlays-in beg end))
15968 (setq ov (make-overlay beg end))
15969 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15970 (if (featurep 'xemacs)
15971 (progn
15972 (overlay-put ov 'invisible t)
15973 (overlay-put
15974 ov 'end-glyph
15975 (make-glyph (vector 'png :file movefile))))
15976 (overlay-put
15977 ov 'display
15978 (list 'image :type 'png :file movefile :ascent 'center)))
15979 (push ov org-latex-fragment-image-overlays)
15980 (goto-char end))
15981 (delete-region beg end)
15982 (insert (org-add-props link
15983 (list 'org-latex-src
15986 ;; This function borrows from Ganesh Swami's latex2png.el
15987 (defun org-create-formula-image (string tofile options buffer)
15988 "This calls dvipng."
15989 (require 'org-latex)
15990 (let* ((tmpdir (if (featurep 'xemacs)
15991 (temp-directory)
15992 temporary-file-directory))
15993 (texfilebase (make-temp-name
15994 (expand-file-name "orgtex" tmpdir)))
15995 (texfile (concat texfilebase ".tex"))
15996 (dvifile (concat texfilebase ".dvi"))
15997 (pngfile (concat texfilebase ".png"))
15998 (fnh (if (featurep 'xemacs)
15999 (font-height (get-face-font 'default))
16000 (face-attribute 'default :height nil)))
16001 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16002 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16003 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16004 "Black"))
16005 (bg (or (plist-get options (if buffer :background :html-background))
16006 "Transparent")))
16007 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16008 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16009 (with-temp-file texfile
16010 (insert (org-splice-latex-header
16011 org-format-latex-header
16012 org-export-latex-default-packages-alist
16013 org-export-latex-packages-alist t
16014 org-format-latex-header-extra))
16016 (require 'org-latex)
16017 (org-export-latex-fix-inputenc))
16018 (let ((dir default-directory))
16019 (condition-case nil
16020 (progn
16021 (cd tmpdir)
16022 (call-process "latex" nil nil nil texfile))
16023 (error nil))
16024 (cd dir))
16025 (if (not (file-exists-p dvifile))
16026 (progn (message "Failed to create dvi file from %s" texfile) nil)
16027 (condition-case nil
16028 (call-process "dvipng" nil nil nil
16029 "-fg" fg "-bg" bg
16030 "-D" dpi
16031 ;;"-x" scale "-y" scale
16032 "-T" "tight"
16033 "-o" pngfile
16034 dvifile)
16035 (error nil))
16036 (if (not (file-exists-p pngfile))
16037 (if org-format-latex-signal-error
16038 (error "Failed to create png file from %s" texfile)
16039 (message "Failed to create png file from %s" texfile)
16040 nil)
16041 ;; Use the requested file name and clean up
16042 (copy-file pngfile tofile 'replace)
16043 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16044 (delete-file (concat texfilebase e)))
16045 pngfile))))
16047 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16048 "Fill a LaTeX header template TPL.
16049 In the template, the following place holders will be recognized:
16052 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16054 [NO-PACKAGES] do not include PKG
16055 [EXTRA] the string EXTRA
16056 [NO-EXTRA] do not include EXTRA
16058 For backward compatibility, if both the positive and the negative place
16060 assumed to be present at the end of the template.
16061 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16062 EXTRA is a string.
16063 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16064 (let (rpl (end ""))
16066 (setq rpl (if (or (match-end 1) (not def-pkg))
16067 "" (org-latex-packages-to-string def-pkg snippets-p t))
16068 tpl (replace-match rpl t t tpl))
16069 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16072 (setq rpl (if (or (match-end 1) (not pkg))
16073 "" (org-latex-packages-to-string pkg snippets-p t))
16074 tpl (replace-match rpl t t tpl))
16075 (if pkg (setq end
16077 (org-latex-packages-to-string pkg snippets-p)))))
16080 (setq rpl (if (or (match-end 1) (not extra))
16082 tpl (replace-match rpl t t tpl))
16088 tpl)))
16090 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16092 (setq pkg (mapconcat (lambda(p)
16093 (cond
16094 ((stringp p) p)
16095 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16096 (format "%% Package %s omitted" (cadr p)))
16097 ((equal "" (car p))
16099 (t
16101 (car p) (cadr p)))))
16102 pkg
16106 (defun org-dvipng-color (attr)
16107 "Return an rgb color specification for dvipng."
16108 (apply 'format "rgb %s %s %s"
16109 (mapcar 'org-normalize-color
16110 (color-values (face-attribute 'default attr nil)))))
16112 (defun org-normalize-color (value)
16113 "Return string to be used as color value for an RGB component."
16114 (format "%g" (/ value 65535.0)))
16116 ;; Image display
16119 (defvar org-inline-image-overlays nil)
16120 (make-variable-buffer-local 'org-inline-image-overlays)
16122 (defun org-toggle-inline-images (&optional include-linked)
16123 "Toggle the display of inline images.
16124 INCLUDE-LINKED is passed to `org-display-inline-images'."
16125 (interactive "P")
16126 (if org-inline-image-overlays
16127 (progn
16128 (org-remove-inline-images)
16129 (message "Inline image display turned off"))
16130 (org-display-inline-images include-linked)
16131 (if org-inline-image-overlays
16132 (message "%d images displayed inline"
16133 (length org-inline-image-overlays))
16134 (message "No images to display inline"))))
16136 (defun org-display-inline-images (&optional include-linked refresh beg end)
16137 "Display inline images.
16138 Normally only links without a description part are inlined, because this
16139 is how it will work for export. When INCLUDE-LINKED is set, also links
16140 with a description part will be inlined. This can be nice for a quick
16141 look at those images, but it does not reflect what exported files will look
16142 like.
16143 When REFRESH is set, refresh existing images between BEG and END.
16144 This will create new image displays only if necessary.
16145 BEG and END default to the buffer boundaries."
16146 (interactive "P")
16147 (unless refresh
16148 (org-remove-inline-images)
16149 (clear-image-cache))
16150 (save-excursion
16151 (save-restriction
16152 (widen)
16153 (setq beg (or beg (point-min)) end (or end (point-max)))
16154 (goto-char (point-min))
16156 (substring (org-image-file-name-regexp) 0 -2)
16158 old file ov img)
16159 (while (re-search-forward re end t)
16160 (setq old (get-char-property-and-overlay (match-beginning 1)
16161 'org-image-overlay))
16162 (setq file (expand-file-name
16163 (concat (or (match-string 3) "") (match-string 4))))
16164 (when (file-exists-p file)
16165 (if (and (car-safe old) refresh)
16166 (image-refresh (overlay-get (cdr old) 'display))
16167 (setq img (create-image file))
16168 (when img
16169 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16170 (overlay-put ov 'display img)
16171 (overlay-put ov 'face 'default)
16172 (overlay-put ov 'org-image-overlay t)
16173 (overlay-put ov 'modification-hooks
16174 (list 'org-display-inline-modification-hook))
16175 (push ov org-inline-image-overlays)))))))))
16177 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16178 "Remove inline-display overlay if a corresponding region is modified."
16179 (let ((inhibit-modification-hooks t))
16180 (when (and ov after)
16181 (delete ov org-inline-image-overlays)
16182 (delete-overlay ov))))
16184 (defun org-remove-inline-images ()
16185 "Remove inline display of images."
16186 (interactive)
16187 (mapc 'delete-overlay org-inline-image-overlays)
16188 (setq org-inline-image-overlays nil))
16190 ;;;; Key bindings
16192 ;; Make `C-c C-x' a prefix key
16193 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16195 ;; TAB key with modifiers
16196 (org-defkey org-mode-map "\C-i" 'org-cycle)
16197 (org-defkey org-mode-map [(tab)] 'org-cycle)
16198 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16199 (org-defkey org-mode-map [(meta tab)] 'org-complete)
16201 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
16202 ;; The following line is necessary under Suse GNU/Linux
16203 (unless (featurep 'xemacs)
16204 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16205 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16206 (define-key org-mode-map [backtab] 'org-shifttab)
16208 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16209 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16210 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16212 ;; Cursor keys with modifiers
16213 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16214 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16215 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16216 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16218 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16219 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16220 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16221 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16223 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16224 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16225 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16226 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16228 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16229 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16231 ;; Babel keys
16232 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16233 (mapc (lambda (pair)
16234 (define-key org-babel-map (car pair) (cdr pair)))
16235 org-babel-key-bindings)
16237 ;;; Extra keys for tty access.
16238 ;; We only set them when really needed because otherwise the
16239 ;; menus don't show the simple keys
16241 (when (or org-use-extra-keys
16242 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16243 (not window-system))
16244 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16245 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16246 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16247 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16248 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16249 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16250 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16251 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16252 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16253 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16254 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16255 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16256 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16257 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16258 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16259 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16260 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16261 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16262 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16263 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16264 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16265 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16266 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
16267 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16268 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16269 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16270 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16271 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16273 ;; All the other keys
16275 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16276 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16277 (if (boundp 'narrow-map)
16278 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16279 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16280 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16281 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16282 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16283 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16284 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16285 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16286 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16287 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16288 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16289 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16290 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16291 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16292 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16293 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16294 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16295 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16297 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16298 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16299 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16300 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16301 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16302 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16303 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16304 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16305 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16306 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16307 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16308 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16309 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16310 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16311 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16312 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16313 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16314 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16315 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16317 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16318 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16319 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16320 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16321 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16322 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16323 (org-defkey org-mode-map "\C-c^" 'org-sort)
16324 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16325 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16326 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16327 (org-defkey org-mode-map "\C-m" 'org-return)
16328 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16329 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16330 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16331 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16332 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16333 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16334 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16335 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16336 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16337 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16338 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16339 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16340 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16341 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16342 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16343 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16344 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16345 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16346 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16347 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16348 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16350 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16351 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16352 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16353 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16355 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16356 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16357 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16358 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16359 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16360 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16361 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16362 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16363 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16364 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16366 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16367 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16368 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16369 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16370 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16371 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16373 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16374 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16375 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16376 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16378 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16380 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16382 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16383 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16385 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16388 (when (featurep 'xemacs)
16389 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16392 (defconst org-speed-commands-default
16393 '(
16394 ("Outline Navigation")
16395 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16396 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16397 ("f" . (org-speed-move-safe 'org-forward-same-level))
16398 ("b" . (org-speed-move-safe 'org-backward-same-level))
16399 ("u" . (org-speed-move-safe 'outline-up-heading))
16400 ("j" . org-goto)
16401 ("g" . (org-refile t))
16402 ("Outline Visibility")
16403 ("c" . org-cycle)
16404 ("C" . org-shifttab)
16405 (" " . org-display-outline-path)
16406 ("Outline Structure Editing")
16407 ("U" . org-shiftmetaup)
16408 ("D" . org-shiftmetadown)
16409 ("r" . org-metaright)
16410 ("l" . org-metaleft)
16411 ("R" . org-shiftmetaright)
16412 ("L" . org-shiftmetaleft)
16413 ("i" . (progn (forward-char 1) (call-interactively
16414 'org-insert-heading-respect-content)))
16415 ("^" . org-sort)
16416 ("w" . org-refile)
16417 ("a" . org-archive-subtree-default-with-confirmation)
16418 ("." . outline-mark-subtree)
16419 ("Clock Commands")
16420 ("I" . org-clock-in)
16421 ("O" . org-clock-out)
16422 ("Meta Data Editing")
16423 ("t" . org-todo)
16424 ("0" . (org-priority ?\ ))
16425 ("1" . (org-priority ?A))
16426 ("2" . (org-priority ?B))
16427 ("3" . (org-priority ?C))
16428 (";" . org-set-tags-command)
16429 ("e" . org-set-effort)
16430 ("Agenda Views etc")
16431 ("v" . org-agenda)
16432 ("/" . org-sparse-tree)
16433 ("Misc")
16434 ("o" . org-open-at-point)
16435 ("?" . org-speed-command-help)
16436 ("<" . (org-agenda-set-restriction-lock 'subtree))
16437 (">" . (org-agenda-remove-restriction-lock))
16438 )
16439 "The default speed commands.")
16441 (defun org-print-speed-command (e)
16442 (if (> (length (car e)) 1)
16443 (progn
16445 (princ (car e))
16447 (princ (make-string (length (car e)) ?-))
16449 (princ (car e))
16450 (princ " ")
16451 (if (symbolp (cdr e))
16452 (princ (symbol-name (cdr e)))
16453 (prin1 (cdr e)))
16456 (defun org-speed-command-help ()
16457 "Show the available speed commands."
16458 (interactive)
16459 (if (not org-use-speed-commands)
16460 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16461 (with-output-to-temp-buffer "*Help*"
16463 (mapc 'org-print-speed-command org-speed-commands-user)
16466 (mapc 'org-print-speed-command org-speed-commands-default))
16467 (with-current-buffer "*Help*"
16468 (setq truncate-lines t))))
16470 (defun org-speed-move-safe (cmd)
16471 "Execute CMD, but make sure that the cursor always ends up in a headline.
16472 If not, return to the original position and throw an error."
16473 (interactive)
16474 (let ((pos (point)))
16475 (call-interactively cmd)
16476 (unless (and (bolp) (org-on-heading-p))
16477 (goto-char pos)
16478 (error "Boundary reached while executing %s" cmd))))
16480 (defvar org-self-insert-command-undo-counter 0)
16482 (defvar org-table-auto-blank-field) ; defined in org-table.el
16483 (defvar org-speed-command nil)
16484 (defun org-self-insert-command (N)
16485 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16486 If the cursor is in a table looking at whitespace, the whitespace is
16487 overwritten, and the table is not marked as requiring realignment."
16488 (interactive "p")
16489 (cond
16490 ((and org-use-speed-commands
16491 (or (and (bolp) (looking-at outline-regexp))
16492 (and (functionp org-use-speed-commands)
16493 (funcall org-use-speed-commands)))
16494 (setq
16495 org-speed-command
16496 (or (cdr (assoc (this-command-keys) org-speed-commands-user))
16497 (cdr (assoc (this-command-keys) org-speed-commands-default)))))
16498 (cond
16499 ((commandp org-speed-command)
16500 (setq this-command org-speed-command)
16501 (call-interactively org-speed-command))
16502 ((functionp org-speed-command)
16503 (funcall org-speed-command))
16504 ((and org-speed-command (listp org-speed-command))
16505 (eval org-speed-command))
16506 (t (let (org-use-speed-commands)
16507 (call-interactively 'org-self-insert-command)))))
16508 ((and
16509 (org-table-p)
16510 (progn
16511 ;; check if we blank the field, and if that triggers align
16512 (and (featurep 'org-table) org-table-auto-blank-field
16513 (member last-command
16514 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16516 ;; got extra space, this field does not determine column width
16517 (let (org-table-may-need-update) (org-table-blank-field))
16518 ;; no extra space, this field may determine column width
16519 (org-table-blank-field)))
16520 t)
16521 (eq N 1)
16523 (let (org-table-may-need-update)
16524 (goto-char (1- (match-end 0)))
16525 (delete-backward-char 1)
16526 (goto-char (match-beginning 0))
16527 (self-insert-command N)))
16528 (t
16529 (setq org-table-may-need-update t)
16530 (self-insert-command N)
16531 (org-fix-tags-on-the-fly)
16532 (if org-self-insert-cluster-for-undo
16533 (if (not (eq last-command 'org-self-insert-command))
16534 (setq org-self-insert-command-undo-counter 1)
16535 (if (>= org-self-insert-command-undo-counter 20)
16536 (setq org-self-insert-command-undo-counter 1)
16537 (and (> org-self-insert-command-undo-counter 0)
16538 buffer-undo-list
16539 (not (cadr buffer-undo-list)) ; remove nil entry
16540 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16541 (setq org-self-insert-command-undo-counter
16542 (1+ org-self-insert-command-undo-counter))))))))
16544 (defun org-fix-tags-on-the-fly ()
16545 (when (and (equal (char-after (point-at-bol)) ?*)
16546 (org-on-heading-p))
16547 (org-align-tags-here org-tags-column)))
16549 (defun org-delete-backward-char (N)
16550 "Like `delete-backward-char', insert whitespace at field end in tables.
16551 When deleting backwards, in tables this function will insert whitespace in
16553 still be marked for re-alignment if the field did fill the entire column,
16554 because, in this case the deletion might narrow the column."
16555 (interactive "p")
16556 (if (and (org-table-p)
16557 (eq N 1)
16558 (string-match "|" (buffer-substring (point-at-bol) (point)))
16559 (looking-at ".*?|"))
16560 (let ((pos (point))
16562 (c org-table-may-need-update))
16563 (backward-delete-char N)
16564 (skip-chars-forward "^|")
16565 (insert " ")
16566 (goto-char (1- pos))
16567 ;; noalign: if there were two spaces at the end, this field
16568 ;; does not determine the width of the column.
16569 (if noalign (setq org-table-may-need-update c)))
16570 (backward-delete-char N)
16571 (org-fix-tags-on-the-fly)))
16573 (defun org-delete-char (N)
16574 "Like `delete-char', but insert whitespace at field end in tables.
16575 When deleting characters, in tables this function will insert whitespace in
16577 still be marked for re-alignment if the field did fill the entire column,
16578 because, in this case the deletion might narrow the column."
16579 (interactive "p")
16580 (if (and (org-table-p)
16581 (not (bolp))
16582 (not (= (char-after) ?|))
16583 (eq N 1))
16584 (if (looking-at ".*?|")
16585 (let ((pos (point))
16587 (c org-table-may-need-update))
16588 (replace-match (concat
16589 (substring (match-string 0) 1 -1)
16590 " |"))
16591 (goto-char pos)
16592 ;; noalign: if there were two spaces at the end, this field
16593 ;; does not determine the width of the column.
16594 (if noalign (setq org-table-may-need-update c)))
16595 (delete-char N))
16596 (delete-char N)
16597 (org-fix-tags-on-the-fly)))
16599 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16600 (put 'org-self-insert-command 'delete-selection t)
16601 (put 'orgtbl-self-insert-command 'delete-selection t)
16602 (put 'org-delete-char 'delete-selection 'supersede)
16603 (put 'org-delete-backward-char 'delete-selection 'supersede)
16604 (put 'org-yank 'delete-selection 'yank)
16606 ;; Make `flyspell-mode' delay after some commands
16607 (put 'org-self-insert-command 'flyspell-delayed t)
16608 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16609 (put 'org-delete-char 'flyspell-delayed t)
16610 (put 'org-delete-backward-char 'flyspell-delayed t)
16612 ;; Make pabbrev-mode expand after org-mode commands
16613 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16614 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16616 ;; How to do this: Measure non-white length of current string
16617 ;; If equal to column width, we should realign.
16619 (defun org-remap (map &rest commands)
16620 "In MAP, remap the functions given in COMMANDS.
16621 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16622 (let (new old)
16623 (while commands
16624 (setq old (pop commands) new (pop commands))
16625 (if (fboundp 'command-remapping)
16626 (org-defkey map (vector 'remap old) new)
16627 (substitute-key-definition old new map global-map)))))
16629 (when (eq org-enable-table-editor 'optimized)
16630 ;; If the user wants maximum table support, we need to hijack
16631 ;; some standard editing functions
16632 (org-remap org-mode-map
16633 'self-insert-command 'org-self-insert-command
16634 'delete-char 'org-delete-char
16635 'delete-backward-char 'org-delete-backward-char)
16636 (org-defkey org-mode-map "|" 'org-force-self-insert))
16638 (defvar org-ctrl-c-ctrl-c-hook nil
16639 "Hook for functions attaching themselves to `C-c C-c'.
16640 This can be used to add additional functionality to the C-c C-c key which
16641 executes context-dependent commands.
16642 Each function will be called with no arguments. The function must check
16643 if the context is appropriate for it to act. If yes, it should do its
16644 thing and then return a non-nil value. If the context is wrong,
16645 just do nothing and return nil.")
16647 (defvar org-tab-first-hook nil
16648 "Hook for functions to attach themselves to TAB.
16649 See `org-ctrl-c-ctrl-c-hook' for more information.
16650 This hook runs as the first action when TAB is pressed, even before
16651 `org-cycle' messes around with the `outline-regexp' to cater for
16652 inline tasks and plain list item folding.
16653 If any function in this hook returns t, any other actions that
16654 would have been caused by TAB (such as table field motion or visibility
16655 cycling) will not occur.")
16657 (defvar org-tab-after-check-for-table-hook nil
16658 "Hook for functions to attach themselves to TAB.
16659 See `org-ctrl-c-ctrl-c-hook' for more information.
16660 This hook runs after it has been established that the cursor is not in a
16661 table, but before checking if the cursor is in a headline or if global cycling
16662 should be done.
16663 If any function in this hook returns t, not other actions like visibility
16664 cycling will be done.")
16666 (defvar org-tab-after-check-for-cycling-hook nil
16667 "Hook for functions to attach themselves to TAB.
16668 See `org-ctrl-c-ctrl-c-hook' for more information.
16669 This hook runs after it has been established that not table field motion and
16670 not visibility should be done because of current context. This is probably
16671 the place where a package like yasnippets can hook in.")
16673 (defvar org-tab-before-tab-emulation-hook nil
16674 "Hook for functions to attach themselves to TAB.
16675 See `org-ctrl-c-ctrl-c-hook' for more information.
16676 This hook runs after every other options for TAB have been exhausted, but
16679 (defvar org-metaleft-hook nil
16680 "Hook for functions attaching themselves to `M-left'.
16681 See `org-ctrl-c-ctrl-c-hook' for more information.")
16682 (defvar org-metaright-hook nil
16683 "Hook for functions attaching themselves to `M-right'.
16684 See `org-ctrl-c-ctrl-c-hook' for more information.")
16685 (defvar org-metaup-hook nil
16686 "Hook for functions attaching themselves to `M-up'.
16687 See `org-ctrl-c-ctrl-c-hook' for more information.")
16688 (defvar org-metadown-hook nil
16689 "Hook for functions attaching themselves to `M-down'.
16690 See `org-ctrl-c-ctrl-c-hook' for more information.")
16691 (defvar org-shiftmetaleft-hook nil
16692 "Hook for functions attaching themselves to `M-S-left'.
16693 See `org-ctrl-c-ctrl-c-hook' for more information.")
16694 (defvar org-shiftmetaright-hook nil
16695 "Hook for functions attaching themselves to `M-S-right'.
16696 See `org-ctrl-c-ctrl-c-hook' for more information.")
16697 (defvar org-shiftmetaup-hook nil
16698 "Hook for functions attaching themselves to `M-S-up'.
16699 See `org-ctrl-c-ctrl-c-hook' for more information.")
16700 (defvar org-shiftmetadown-hook nil
16701 "Hook for functions attaching themselves to `M-S-down'.
16702 See `org-ctrl-c-ctrl-c-hook' for more information.")
16703 (defvar org-metareturn-hook nil
16704 "Hook for functions attaching themselves to `M-RET'.
16705 See `org-ctrl-c-ctrl-c-hook' for more information.")
16706 (defvar org-shiftup-hook nil
16707 "Hook for functions attaching themselves to `S-up'.
16708 See `org-ctrl-c-ctrl-c-hook' for more information.")
16709 (defvar org-shiftup-final-hook nil
16710 "Hook for functions attaching themselves to `S-up'.
16711 This one runs after all other options except shift-select have been excluded.
16712 See `org-ctrl-c-ctrl-c-hook' for more information.")
16713 (defvar org-shiftdown-hook nil
16714 "Hook for functions attaching themselves to `S-down'.
16715 See `org-ctrl-c-ctrl-c-hook' for more information.")
16716 (defvar org-shiftdown-final-hook nil
16717 "Hook for functions attaching themselves to `S-down'.
16718 This one runs after all other options except shift-select have been excluded.
16719 See `org-ctrl-c-ctrl-c-hook' for more information.")
16720 (defvar org-shiftleft-hook nil
16721 "Hook for functions attaching themselves to `S-left'.
16722 See `org-ctrl-c-ctrl-c-hook' for more information.")
16723 (defvar org-shiftleft-final-hook nil
16724 "Hook for functions attaching themselves to `S-left'.
16725 This one runs after all other options except shift-select have been excluded.
16726 See `org-ctrl-c-ctrl-c-hook' for more information.")
16727 (defvar org-shiftright-hook nil
16728 "Hook for functions attaching themselves to `S-right'.
16729 See `org-ctrl-c-ctrl-c-hook' for more information.")
16730 (defvar org-shiftright-final-hook nil
16731 "Hook for functions attaching themselves to `S-right'.
16732 This one runs after all other options except shift-select have been excluded.
16733 See `org-ctrl-c-ctrl-c-hook' for more information.")
16735 (defun org-modifier-cursor-error ()
16736 "Throw an error, a modified cursor command was applied in wrong context."
16737 (error "This command is active in special context like tables, headlines or items"))
16739 (defun org-shiftselect-error ()
16740 "Throw an error because Shift-Cursor command was applied in wrong context."
16741 (if (and (boundp 'shift-select-mode) shift-select-mode)
16742 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16743 (error "This command works only in special context like headlines or timestamps")))
16745 (defun org-call-for-shift-select (cmd)
16746 (let ((this-command-keys-shift-translated t))
16747 (call-interactively cmd)))
16749 (defun org-shifttab (&optional arg)
16750 "Global visibility cycling or move to previous table field.
16751 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16752 on context.
16753 See the individual commands for more information."
16754 (interactive "P")
16755 (cond
16756 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16757 ((integerp arg)
16758 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16759 (message "Content view to level: %d" arg)
16760 (org-content (prefix-numeric-value arg2))
16761 (setq org-cycle-global-status 'overview)))
16762 (t (call-interactively 'org-global-cycle))))
16764 (defun org-shiftmetaleft ()
16765 "Promote subtree or delete table column.
16766 Calls `org-promote-subtree', `org-outdent-item',
16767 or `org-table-delete-column', depending on context.
16768 See the individual commands for more information."
16769 (interactive)
16770 (cond
16771 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16772 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16773 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16774 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16775 (t (org-modifier-cursor-error))))
16777 (defun org-shiftmetaright ()
16778 "Demote subtree or insert table column.
16779 Calls `org-demote-subtree', `org-indent-item',
16780 or `org-table-insert-column', depending on context.
16781 See the individual commands for more information."
16782 (interactive)
16783 (cond
16784 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16785 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16786 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16787 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16788 (t (org-modifier-cursor-error))))
16790 (defun org-shiftmetaup (&optional arg)
16791 "Move subtree up or kill table row.
16792 Calls `org-move-subtree-up' or `org-table-kill-row' or
16793 `org-move-item-up' depending on context. See the individual commands
16794 for more information."
16795 (interactive "P")
16796 (cond
16797 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16798 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16799 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16800 ((org-at-item-p) (call-interactively 'org-move-item-up))
16801 (t (org-modifier-cursor-error))))
16803 (defun org-shiftmetadown (&optional arg)
16804 "Move subtree down or insert table row.
16805 Calls `org-move-subtree-down' or `org-table-insert-row' or
16806 `org-move-item-down', depending on context. See the individual
16807 commands for more information."
16808 (interactive "P")
16809 (cond
16810 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16811 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16812 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16813 ((org-at-item-p) (call-interactively 'org-move-item-down))
16814 (t (org-modifier-cursor-error))))
16816 (defsubst org-hidden-tree-error ()
16817 (error
16818 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16820 (defun org-metaleft (&optional arg)
16821 "Promote heading or move table column to left.
16822 Calls `org-do-promote' or `org-table-move-column', depending on context.
16823 With no specific context, calls the Emacs default `backward-word'.
16824 See the individual commands for more information."
16825 (interactive "P")
16826 (cond
16827 ((run-hook-with-args-until-success 'org-metaleft-hook))
16828 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16829 ((or (org-on-heading-p)
16830 (and (org-region-active-p)
16831 (save-excursion
16832 (goto-char (region-beginning))
16833 (org-on-heading-p))))
16834 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16835 (call-interactively 'org-do-promote))
16836 ((or (org-at-item-p)
16837 (and (org-region-active-p)
16838 (save-excursion
16839 (goto-char (region-beginning))
16840 (org-at-item-p))))
16841 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16842 (call-interactively 'org-outdent-item))
16843 (t (call-interactively 'backward-word))))
16845 (defun org-metaright (&optional arg)
16846 "Demote subtree or move table column to right.
16847 Calls `org-do-demote' or `org-table-move-column', depending on context.
16848 With no specific context, calls the Emacs default `forward-word'.
16849 See the individual commands for more information."
16850 (interactive "P")
16851 (cond
16852 ((run-hook-with-args-until-success 'org-metaright-hook))
16853 ((org-at-table-p) (call-interactively 'org-table-move-column))
16854 ((or (org-on-heading-p)
16855 (and (org-region-active-p)
16856 (save-excursion
16857 (goto-char (region-beginning))
16858 (org-on-heading-p))))
16859 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16860 (call-interactively 'org-do-demote))
16861 ((or (org-at-item-p)
16862 (and (org-region-active-p)
16863 (save-excursion
16864 (goto-char (region-beginning))
16865 (org-at-item-p))))
16866 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16867 (call-interactively 'org-indent-item))
16868 (t (call-interactively 'forward-word))))
16870 (defun org-check-for-hidden (what)
16871 "Check if there are hidden headlines/items in the current visual line.
16872 WHAT can be either `headlines' or `items'. If the current line is
16873 an outline or item heading and it has a folded subtree below it,
16874 this function returns t, nil otherwise."
16875 (let ((re (cond
16876 ((eq what 'headlines) (concat "^" org-outline-regexp))
16877 ((eq what 'items) (concat "^" (org-item-re t)))
16878 (t (error "This should not happen"))))
16879 beg end)
16880 (save-excursion
16881 (catch 'exit
16882 (unless (org-region-active-p)
16883 (setq beg (point-at-bol))
16884 (beginning-of-line 2)
16885 (while (and (not (eobp)) ;; this is like `next-line'
16886 (get-char-property (1- (point)) 'invisible))
16887 (beginning-of-line 2))
16888 (setq end (point))
16889 (goto-char beg)
16890 (goto-char (point-at-eol))
16891 (setq end (max end (point)))
16892 (while (re-search-forward re end t)
16893 (if (get-char-property (match-beginning 0) 'invisible)
16894 (throw 'exit t))))
16895 nil))))
16897 (defun org-metaup (&optional arg)
16898 "Move subtree up or move table row up.
16899 Calls `org-move-subtree-up' or `org-table-move-row' or
16900 `org-move-item-up', depending on context. See the individual commands
16901 for more information."
16902 (interactive "P")
16903 (cond
16904 ((run-hook-with-args-until-success 'org-metaup-hook))
16905 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16906 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16907 ((org-at-item-p) (call-interactively 'org-move-item-up))
16908 (t (transpose-lines 1) (beginning-of-line -1))))
16910 (defun org-metadown (&optional arg)
16911 "Move subtree down or move table row down.
16912 Calls `org-move-subtree-down' or `org-table-move-row' or
16913 `org-move-item-down', depending on context. See the individual
16914 commands for more information."
16915 (interactive "P")
16916 (cond
16917 ((run-hook-with-args-until-success 'org-metadown-hook))
16918 ((org-at-table-p) (call-interactively 'org-table-move-row))
16919 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16920 ((org-at-item-p) (call-interactively 'org-move-item-down))
16921 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16923 (defun org-shiftup (&optional arg)
16924 "Increase item in timestamp or increase priority of current headline.
16925 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16926 depending on context. See the individual commands for more information."
16927 (interactive "P")
16928 (cond
16929 ((run-hook-with-args-until-success 'org-shiftup-hook))
16930 ((and org-support-shift-select (org-region-active-p))
16931 (org-call-for-shift-select 'previous-line))
16932 ((org-at-timestamp-p t)
16933 (call-interactively (if org-edit-timestamp-down-means-later
16934 'org-timestamp-down 'org-timestamp-up)))
16935 ((and (not (eq org-support-shift-select 'always))
16936 org-enable-priority-commands
16937 (org-on-heading-p))
16938 (call-interactively 'org-priority-up))
16939 ((and (not org-support-shift-select) (org-at-item-p))
16940 (call-interactively 'org-previous-item))
16941 ((org-clocktable-try-shift 'up arg))
16942 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
16943 (org-support-shift-select
16944 (org-call-for-shift-select 'previous-line))
16945 (t (org-shiftselect-error))))
16947 (defun org-shiftdown (&optional arg)
16948 "Decrease item in timestamp or decrease priority of current headline.
16949 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
16950 depending on context. See the individual commands for more information."
16951 (interactive "P")
16952 (cond
16953 ((run-hook-with-args-until-success 'org-shiftdown-hook))
16954 ((and org-support-shift-select (org-region-active-p))
16955 (org-call-for-shift-select 'next-line))
16956 ((org-at-timestamp-p t)
16957 (call-interactively (if org-edit-timestamp-down-means-later
16958 'org-timestamp-up 'org-timestamp-down)))
16959 ((and (not (eq org-support-shift-select 'always))
16960 org-enable-priority-commands
16961 (org-on-heading-p))
16962 (call-interactively 'org-priority-down))
16963 ((and (not org-support-shift-select) (org-at-item-p))
16964 (call-interactively 'org-next-item))
16965 ((org-clocktable-try-shift 'down arg))
16966 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
16967 (org-support-shift-select
16968 (org-call-for-shift-select 'next-line))
16969 (t (org-shiftselect-error))))
16971 (defun org-shiftright (&optional arg)
16972 "Cycle the thing at point or in the current line, depending on context.
16973 Depending on context, this does one of the following:
16975 - switch a timestamp at point one day into the future
16976 - on a headline, switch to the next TODO keyword.
16977 - on an item, switch entire list to the next bullet type
16978 - on a property line, switch to the next allowed value
16979 - on a clocktable definition line, move time block into the future"
16980 (interactive "P")
16981 (cond
16982 ((run-hook-with-args-until-success 'org-shiftright-hook))
16983 ((and org-support-shift-select (org-region-active-p))
16984 (org-call-for-shift-select 'forward-char))
16985 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
16986 ((and (not (eq org-support-shift-select 'always))
16987 (org-on-heading-p))
16988 (let ((org-inhibit-logging
16989 (not org-treat-S-cursor-todo-selection-as-state-change))
16990 (org-inhibit-blocking
16991 (not org-treat-S-cursor-todo-selection-as-state-change)))
16992 (org-call-with-arg 'org-todo 'right)))
16993 ((or (and org-support-shift-select
16994 (not (eq org-support-shift-select 'always))
16995 (org-at-item-bullet-p))
16996 (and (not org-support-shift-select) (org-at-item-p)))
16997 (org-call-with-arg 'org-cycle-list-bullet nil))
16998 ((and (not (eq org-support-shift-select 'always))
16999 (org-at-property-p))
17000 (call-interactively 'org-property-next-allowed-value))
17001 ((org-clocktable-try-shift 'right arg))
17002 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17003 (org-support-shift-select
17004 (org-call-for-shift-select 'forward-char))
17005 (t (org-shiftselect-error))))
17007 (defun org-shiftleft (&optional arg)
17008 "Cycle the thing at point or in the current line, depending on context.
17009 Depending on context, this does one of the following:
17011 - switch a timestamp at point one day into the past
17012 - on a headline, switch to the previous TODO keyword.
17013 - on an item, switch entire list to the previous bullet type
17014 - on a property line, switch to the previous allowed value
17015 - on a clocktable definition line, move time block into the past"
17016 (interactive "P")
17017 (cond
17018 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17019 ((and org-support-shift-select (org-region-active-p))
17020 (org-call-for-shift-select 'backward-char))
17021 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17022 ((and (not (eq org-support-shift-select 'always))
17023 (org-on-heading-p))
17024 (let ((org-inhibit-logging
17025 (not org-treat-S-cursor-todo-selection-as-state-change))
17026 (org-inhibit-blocking
17027 (not org-treat-S-cursor-todo-selection-as-state-change)))
17028 (org-call-with-arg 'org-todo 'left)))
17029 ((or (and org-support-shift-select
17030 (not (eq org-support-shift-select 'always))
17031 (org-at-item-bullet-p))
17032 (and (not org-support-shift-select) (org-at-item-p)))
17033 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17034 ((and (not (eq org-support-shift-select 'always))
17035 (org-at-property-p))
17036 (call-interactively 'org-property-previous-allowed-value))
17037 ((org-clocktable-try-shift 'left arg))
17038 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17039 (org-support-shift-select
17040 (org-call-for-shift-select 'backward-char))
17041 (t (org-shiftselect-error))))
17043 (defun org-shiftcontrolright ()
17044 "Switch to next TODO set."
17045 (interactive)
17046 (cond
17047 ((and org-support-shift-select (org-region-active-p))
17048 (org-call-for-shift-select 'forward-word))
17049 ((and (not (eq org-support-shift-select 'always))
17050 (org-on-heading-p))
17051 (org-call-with-arg 'org-todo 'nextset))
17052 (org-support-shift-select
17053 (org-call-for-shift-select 'forward-word))
17054 (t (org-shiftselect-error))))
17056 (defun org-shiftcontrolleft ()
17057 "Switch to previous TODO set."
17058 (interactive)
17059 (cond
17060 ((and org-support-shift-select (org-region-active-p))
17061 (org-call-for-shift-select 'backward-word))
17062 ((and (not (eq org-support-shift-select 'always))
17063 (org-on-heading-p))
17064 (org-call-with-arg 'org-todo 'previousset))
17065 (org-support-shift-select
17066 (org-call-for-shift-select 'backward-word))
17067 (t (org-shiftselect-error))))
17069 (defun org-ctrl-c-ret ()
17070 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17071 (interactive)
17072 (cond
17073 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17074 (t (call-interactively 'org-insert-heading))))
17076 (defun org-copy-special ()
17077 "Copy region in table or copy current subtree.
17078 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17079 See the individual commands for more information."
17080 (interactive)
17081 (call-interactively
17082 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17084 (defun org-cut-special ()
17085 "Cut region in table or cut current subtree.
17086 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17087 See the individual commands for more information."
17088 (interactive)
17089 (call-interactively
17090 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17092 (defun org-paste-special (arg)
17093 "Paste rectangular region into table, or past subtree relative to level.
17094 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17095 See the individual commands for more information."
17096 (interactive "P")
17097 (if (org-at-table-p)
17098 (org-table-paste-rectangle)
17099 (org-paste-subtree arg)))
17101 (defun org-edit-special (&optional arg)
17102 "Call a special editor for the stuff at point.
17103 When at a table, call the formula editor with `org-table-edit-formulas'.
17104 When at the first line of an src example, call `org-edit-src-code'.
17105 When in an #+include line, visit the include file. Otherwise call
17106 `ffap' to visit the file at point."
17107 (interactive)
17108 ;; possibly prep session before editing source
17109 (when arg
17110 (let* ((info (org-babel-get-src-block-info))
17111 (lang (nth 0 info))
17112 (params (nth 2 info))
17113 (session (cdr (assoc :session params))))
17114 (when (and info session) ;; we are in a source-code block with a session
17115 (funcall
17116 (intern (concat "org-babel-prep-session:" lang)) session params))))
17117 (cond ;; proceed with `org-edit-special'
17118 ((save-excursion
17119 (beginning-of-line 1)
17120 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17121 (find-file (org-trim (match-string 1))))
17122 ((org-edit-src-code))
17123 ((org-edit-fixed-width-region))
17124 ((org-at-table.el-p)
17125 (org-edit-src-code))
17126 ((org-at-table-p)
17127 (call-interactively 'org-table-edit-formulas))
17128 (t (call-interactively 'ffap))))
17131 (defun org-ctrl-c-ctrl-c (&optional arg)
17132 "Set tags in headline, or update according to changed information at point.
17134 This command does many different things, depending on context:
17136 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17137 this is what we do.
17139 - If the cursor is on a statistics cookie, update it.
17141 - If the cursor is in a headline, prompt for tags and insert them
17142 into the current line, aligned to `org-tags-column'. When called
17143 with prefix arg, realign all tags in the current buffer.
17145 - If the cursor is in one of the special #+KEYWORD lines, this
17146 triggers scanning the buffer for these lines and updating the
17147 information.
17149 - If the cursor is inside a table, realign the table. This command
17150 works even if the automatic table editor has been turned off.
17152 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17153 the entire table.
17155 - If the cursor is at a footnote reference or definition, jump to
17156 the corresponding definition or references, respectively.
17158 - If the cursor is a the beginning of a dynamic block, update it.
17160 - If the current buffer is a remember buffer, close note and file
17161 it. A prefix argument of 1 files to the default location
17162 without further interaction. A prefix argument of 2 files to
17163 the currently clocking task.
17165 - If the cursor is on a <<<target>>>, update radio targets and corresponding
17166 links in this buffer.
17168 - If the cursor is on a numbered item in a plain list, renumber the
17169 ordered list.
17171 - If the cursor is on a checkbox, toggle it.
17173 - If the cursor is on a code block, evaluate it. The variable
17174 `org-confirm-babel-evaluate' can be used to control prompting
17175 before code block evaluation, by default every code block
17176 evaluation requires confirmation. Code block evaluation can be
17177 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17178 (interactive "P")
17179 (let ((org-enable-table-editor t))
17180 (cond
17181 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17182 org-occur-highlights
17183 org-latex-fragment-image-overlays)
17184 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17185 (org-remove-occur-highlights)
17186 (org-remove-latex-fragment-image-overlays)
17187 (message "Temporary highlights/overlays removed from current buffer"))
17188 ((and (local-variable-p 'org-finish-function (current-buffer))
17189 (fboundp org-finish-function))
17190 (funcall org-finish-function))
17191 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17192 ((or (looking-at org-property-start-re)
17193 (org-at-property-p))
17194 (call-interactively 'org-property-action))
17195 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17197 (or (org-on-heading-p) (org-at-item-p)))
17198 (call-interactively 'org-update-statistics-cookies))
17199 ((org-on-heading-p) (call-interactively 'org-set-tags))
17200 ((org-at-table.el-p)
17201 (message "Use C-c ' to edit table.el tables"))
17202 ((org-at-table-p)
17203 (org-table-maybe-eval-formula)
17204 (if arg
17205 (call-interactively 'org-table-recalculate)
17206 (org-table-maybe-recalculate-line))
17207 (call-interactively 'org-table-align))
17208 ((or (org-footnote-at-reference-p)
17209 (org-footnote-at-definition-p))
17210 (call-interactively 'org-footnote-action))
17211 ((org-at-item-checkbox-p)
17212 (call-interactively 'org-toggle-checkbox)
17213 (org-list-send-list 'maybe))
17214 ((org-at-item-p)
17215 (if arg
17216 (call-interactively 'org-toggle-checkbox)
17217 (call-interactively 'org-maybe-renumber-ordered-list))
17218 (org-list-send-list 'maybe))
17219 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17220 ;; Dynamic block
17221 (beginning-of-line 1)
17222 (save-excursion (org-update-dblock)))
17223 ((save-excursion
17224 (beginning-of-line 1)
17226 (cond
17227 ((equal (match-string 1) "TBLFM")
17228 ;; Recalculate the table before this line
17229 (save-excursion
17230 (beginning-of-line 1)
17232 (if (org-at-table-p)
17233 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17234 (t
17235 (let ((org-inhibit-startup-visibility-stuff t)
17236 (org-startup-align-all-tables nil))
17237 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17238 (message "Local setup has been refreshed"))))
17239 ((org-clock-update-time-maybe))
17240 (t (error "C-c C-c can do nothing useful at this location")))))
17242 (defun org-mode-restart ()
17243 "Restart Org-mode, to scan again for special lines.
17244 Also updates the keyword regular expressions."
17245 (interactive)
17246 (org-mode)
17247 (message "Org-mode restarted"))
17249 (defun org-kill-note-or-show-branches ()
17250 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17251 (interactive)
17252 (if (not org-finish-function)
17253 (progn
17254 (hide-subtree)
17255 (call-interactively 'show-branches))
17256 (let ((org-note-abort t))
17257 (funcall org-finish-function))))
17259 (defun org-return (&optional indent)
17260 "Goto next table row or insert a newline.
17261 Calls `org-table-next-row' or `newline', depending on context.
17262 See the individual commands for more information."
17263 (interactive)
17264 (cond
17265 ((bobp) (if indent (newline-and-indent) (newline)))
17266 ((org-at-table-p)
17267 (org-table-justify-field-maybe)
17268 (call-interactively 'org-table-next-row))
17269 ((and org-return-follows-link
17270 (eq (get-text-property (point) 'face) 'org-link))
17271 (call-interactively 'org-open-at-point))
17272 ((and (org-at-heading-p)
17273 (looking-at
17275 (org-show-entry)
17276 (end-of-line 1)
17277 (newline))
17278 (t (if indent (newline-and-indent) (newline)))))
17280 (defun org-return-indent ()
17281 "Goto next table row or insert a newline and indent.
17282 Calls `org-table-next-row' or `newline-and-indent', depending on
17283 context. See the individual commands for more information."
17284 (interactive)
17285 (org-return t))
17287 (defun org-ctrl-c-star ()
17288 "Compute table, or change heading status of lines.
17289 Calls `org-table-recalculate' or `org-toggle-heading',
17290 depending on context."
17291 (interactive)
17292 (cond
17293 ((org-at-table-p)
17294 (call-interactively 'org-table-recalculate))
17295 (t
17296 ;; Convert all lines in region to list items
17297 (call-interactively 'org-toggle-heading))))
17299 (defun org-ctrl-c-minus ()
17300 "Insert separator line in table or modify bullet status of line.
17301 Also turns a plain line or a region of lines into list items.
17302 Calls `org-table-insert-hline', `org-toggle-item', or
17303 `org-cycle-list-bullet', depending on context."
17304 (interactive)
17305 (cond
17306 ((org-at-table-p)
17307 (call-interactively 'org-table-insert-hline))
17308 ((org-region-active-p)
17309 (call-interactively 'org-toggle-item))
17310 ((org-in-item-p)
17311 (call-interactively 'org-cycle-list-bullet))
17312 (t
17313 (call-interactively 'org-toggle-item))))
17315 (defun org-toggle-item ()
17316 "Convert headings or normal lines to items, items to normal lines.
17317 If there is no active region, only the current line is considered.
17319 If the first line in the region is a headline, convert all headlines to items.
17321 If the first line in the region is an item, convert all items to normal lines.
17323 If the first line is normal text, add an item bullet to each line."
17324 (interactive)
17325 (let (l2 l beg end)
17326 (if (org-region-active-p)
17327 (setq beg (region-beginning) end (region-end))
17328 (setq beg (point-at-bol)
17329 end (min (1+ (point-at-eol)) (point-max))))
17330 (save-excursion
17331 (goto-char end)
17332 (setq l2 (org-current-line))
17333 (goto-char beg)
17334 (beginning-of-line 1)
17335 (setq l (1- (org-current-line)))
17336 (if (org-at-item-p)
17337 ;; We already have items, de-itemize
17338 (while (< (setq l (1+ l)) l2)
17339 (when (org-at-item-p)
17340 (goto-char (match-beginning 2))
17341 (delete-region (match-beginning 2) (match-end 2))
17343 (beginning-of-line 2))
17344 (if (org-on-heading-p)
17345 ;; Headings, convert to items
17346 (while (< (setq l (1+ l)) l2)
17347 (if (looking-at org-outline-regexp)
17348 (replace-match "- " t t))
17349 (beginning-of-line 2))
17350 ;; normal lines, turn them into items
17351 (while (< (setq l (1+ l)) l2)
17352 (unless (org-at-item-p)
17355 (beginning-of-line 2)))))))
17357 (defun org-toggle-heading (&optional nstars)
17358 "Convert headings to normal text, or items or text to headings.
17359 If there is no active region, only the current line is considered.
17361 If the first line is a heading, remove the stars from all headlines
17362 in the region.
17364 If the first line is a plain list item, turn all plain list items
17365 into headings.
17367 If the first line is a normal line, turn each and every line in the
17368 region into a heading.
17370 When converting a line into a heading, the number of stars is chosen
17371 such that the lines become children of the current entry. However,
17372 when a prefix argument is given, its value determines the number of
17373 stars to add."
17374 (interactive "P")
17375 (let (l2 l itemp beg end)
17376 (if (org-region-active-p)
17377 (setq beg (region-beginning) end (region-end))
17378 (setq beg (point-at-bol)
17379 end (min (1+ (point-at-eol)) (point-max))))
17380 (save-excursion
17381 (goto-char end)
17382 (setq l2 (org-current-line))
17383 (goto-char beg)
17384 (beginning-of-line 1)
17385 (setq l (1- (org-current-line)))
17386 (if (org-on-heading-p)
17387 ;; We already have headlines, de-star them
17388 (while (< (setq l (1+ l)) l2)
17389 (when (org-on-heading-p t)
17390 (and (looking-at outline-regexp) (replace-match "")))
17391 (beginning-of-line 2))
17392 (setq itemp (org-at-item-p))
17393 (let* ((stars
17394 (if nstars
17395 (make-string (prefix-numeric-value current-prefix-arg)
17396 ?*)
17397 (save-excursion
17398 (if (re-search-backward org-complex-heading-regexp nil t)
17399 (match-string 1) ""))))
17400 (add-stars (cond (nstars "")
17401 ((equal stars "") "*")
17402 (org-odd-levels-only "**")
17403 (t "*")))
17404 (rpl (concat stars add-stars " ")))
17405 (while (< (setq l (1+ l)) l2)
17406 (if itemp
17407 (and (org-at-item-p) (replace-match rpl t t))
17408 (unless (org-on-heading-p)
17410 (replace-match (concat rpl (match-string 2))))))
17411 (beginning-of-line 2)))))))
17413 (defun org-meta-return (&optional arg)
17414 "Insert a new heading or wrap a region in a table.
17415 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17416 See the individual commands for more information."
17417 (interactive "P")
17418 (cond
17419 ((run-hook-with-args-until-success 'org-metareturn-hook))
17420 ((org-at-table-p)
17421 (call-interactively 'org-table-wrap-region))
17422 (t (call-interactively 'org-insert-heading))))
17424 ;;; Menu entries
17426 ;; Define the Org-mode menus
17427 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17428 '("Tbl"
17429 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17430 ["Next Field" org-cycle (org-at-table-p)]
17431 ["Previous Field" org-shifttab (org-at-table-p)]
17432 ["Next Row" org-return (org-at-table-p)]
17433 "--"
17434 ["Blank Field" org-table-blank-field (org-at-table-p)]
17435 ["Edit Field" org-table-edit-field (org-at-table-p)]
17436 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17437 "--"
17438 ("Column"
17439 ["Move Column Left" org-metaleft (org-at-table-p)]
17440 ["Move Column Right" org-metaright (org-at-table-p)]
17441 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17442 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17443 ("Row"
17444 ["Move Row Up" org-metaup (org-at-table-p)]
17445 ["Move Row Down" org-metadown (org-at-table-p)]
17446 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17447 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17448 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17449 "--"
17450 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17451 ("Rectangle"
17452 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17453 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17454 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17455 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17456 "--"
17457 ("Calculate"
17458 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17459 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17460 ["Edit Formulas" org-edit-special (org-at-table-p)]
17461 "--"
17462 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17463 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17464 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17465 "--"
17466 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17467 "--"
17468 ["Sum Column/Rectangle" org-table-sum
17469 (or (org-at-table-p) (org-region-active-p))]
17470 ["Which Column?" org-table-current-column (org-at-table-p)])
17471 ["Debug Formulas"
17472 org-table-toggle-formula-debugger
17473 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17474 ["Show Col/Row Numbers"
17475 org-table-toggle-coordinate-overlays
17476 :style toggle
17477 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17478 "--"
17479 ["Create" org-table-create (and (not (org-at-table-p))
17480 org-enable-table-editor)]
17481 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17482 ["Import from File" org-table-import (not (org-at-table-p))]
17483 ["Export to File" org-table-export (org-at-table-p)]
17484 "--"
17485 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17487 (easy-menu-define org-org-menu org-mode-map "Org menu"
17488 '("Org"
17489 ("Show/Hide"
17490 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17491 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17492 ["Sparse Tree..." org-sparse-tree t]
17493 ["Reveal Context" org-reveal t]
17494 ["Show All" show-all t]
17495 "--"
17496 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17497 "--"
17498 ["New Heading" org-insert-heading t]
17499 ("Navigate Headings"
17500 ["Up" outline-up-heading t]
17501 ["Next" outline-next-visible-heading t]
17502 ["Previous" outline-previous-visible-heading t]
17503 ["Next Same Level" outline-forward-same-level t]
17504 ["Previous Same Level" outline-backward-same-level t]
17505 "--"
17506 ["Jump" org-goto t])
17507 ("Edit Structure"
17508 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17509 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17510 "--"
17511 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17512 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17513 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17514 "--"
17515 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17516 "--"
17517 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17518 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17519 ["Demote Heading" org-metaright (not (org-at-table-p))]
17520 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17521 "--"
17522 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17523 "--"
17524 ["Convert to odd levels" org-convert-to-odd-levels t]
17525 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17526 ("Editing"
17527 ["Emphasis..." org-emphasize t]
17528 ["Edit Source Example" org-edit-special t]
17529 "--"
17530 ["Footnote new/jump" org-footnote-action t]
17531 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17532 ("Archive"
17533 ["Archive (default method)" org-archive-subtree-default t]
17534 "--"
17535 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17536 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17537 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17538 )
17539 "--"
17540 ("Hyperlinks"
17541 ["Store Link (Global)" org-store-link t]
17542 ["Find existing link to here" org-occur-link-in-agenda-files t]
17543 ["Insert Link" org-insert-link t]
17544 ["Follow Link" org-open-at-point t]
17545 "--"
17546 ["Next link" org-next-link t]
17547 ["Previous link" org-previous-link t]
17548 "--"
17549 ["Descriptive Links"
17550 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17551 :style radio
17552 :selected (member '(org-link) buffer-invisibility-spec)]
17553 ["Literal Links"
17554 (progn
17555 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17556 :style radio
17557 :selected (not (member '(org-link) buffer-invisibility-spec))])
17558 "--"
17559 ("TODO Lists"
17560 ["TODO/DONE/-" org-todo t]
17561 ("Select keyword"
17562 ["Next keyword" org-shiftright (org-on-heading-p)]
17563 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17564 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
17565 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17566 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17567 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17568 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17569 "--"
17570 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17571 :selected org-enforce-todo-dependencies :style toggle :active t]
17572 "Settings for tree at point"
17573 ["Do Children sequentially" org-toggle-ordered-property :style radio
17574 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17575 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17576 ["Do Children parallel" org-toggle-ordered-property :style radio
17577 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17578 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17579 "--"
17580 ["Set Priority" org-priority t]
17581 ["Priority Up" org-shiftup t]
17582 ["Priority Down" org-shiftdown t]
17583 "--"
17584 ["Get news from all feeds" org-feed-update-all t]
17585 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17586 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17587 ("TAGS and Properties"
17588 ["Set Tags" org-set-tags-command t]
17589 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17590 "--"
17591 ["Set property" org-set-property t]
17592 ["Column view of properties" org-columns t]
17593 ["Insert Column View DBlock" org-insert-columns-dblock t])
17594 ("Dates and Scheduling"
17595 ["Timestamp" org-time-stamp t]
17596 ["Timestamp (inactive)" org-time-stamp-inactive t]
17597 ("Change Date"
17598 ["1 Day Later" org-shiftright t]
17599 ["1 Day Earlier" org-shiftleft t]
17600 ["1 ... Later" org-shiftup t]
17601 ["1 ... Earlier" org-shiftdown t])
17602 ["Compute Time Range" org-evaluate-time-range t]
17603 ["Schedule Item" org-schedule t]
17604 ["Deadline" org-deadline t]
17605 "--"
17606 ["Custom time format" org-toggle-time-stamp-overlays
17607 :style radio :selected org-display-custom-times]
17608 "--"
17609 ["Goto Calendar" org-goto-calendar t]
17610 ["Date from Calendar" org-date-from-calendar t]
17611 "--"
17612 ["Start/Restart Timer" org-timer-start t]
17613 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17614 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17615 ["Insert Timer String" org-timer t]
17616 ["Insert Timer Item" org-timer-item t])
17617 ("Logging work"
17618 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17619 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17620 ["Clock out" org-clock-out t]
17621 ["Clock cancel" org-clock-cancel t]
17622 "--"
17623 ["Mark as default task" org-clock-mark-default-task t]
17624 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17625 ["Goto running clock" org-clock-goto t]
17626 "--"
17627 ["Display times" org-clock-display t]
17628 ["Create clock table" org-clock-report t]
17629 "--"
17630 ["Record DONE time"
17631 (progn (setq org-log-done (not org-log-done))
17632 (message "Switching to %s will %s record a timestamp"
17633 (car org-done-keywords)
17634 (if org-log-done "automatically" "not")))
17635 :style toggle :selected org-log-done])
17636 "--"
17637 ["Agenda Command..." org-agenda t]
17638 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17639 ("File List for Agenda")
17640 ("Special views current file"
17641 ["TODO Tree" org-show-todo-tree t]
17642 ["Check Deadlines" org-check-deadlines t]
17643 ["Timeline" org-timeline t]
17644 ["Tags/Property tree" org-match-sparse-tree t])
17645 "--"
17646 ["Export/Publish..." org-export t]
17647 ("LaTeX"
17648 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17649 :selected org-cdlatex-mode]
17650 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17651 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17652 ["Modify math symbol" org-cdlatex-math-modify
17653 (org-inside-LaTeX-fragment-p)]
17654 ["Insert citation" org-reftex-citation t]
17655 "--"
17656 ["Export LaTeX fragments as images"
17657 (if (featurep 'org-exp)
17658 (setq org-export-with-LaTeX-fragments
17659 (not org-export-with-LaTeX-fragments))
17660 (require 'org-exp))
17661 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
17662 org-export-with-LaTeX-fragments)]
17663 "--"
17664 ["Template for BEAMER" org-insert-beamer-options-template t])
17665 "--"
17666 ("MobileOrg"
17667 ["Push Files and Views" org-mobile-push t]
17668 ["Get Captured and Flagged" org-mobile-pull t]
17669 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17670 "--"
17671 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17672 "--"
17673 ("Documentation"
17674 ["Show Version" org-version t]
17675 ["Info Documentation" org-info t])
17676 ("Customize"
17677 ["Browse Org Group" org-customize t]
17678 "--"
17679 ["Expand This Menu" org-create-customize-menu
17680 (fboundp 'customize-menu-create)])
17681 ["Send bug report" org-submit-bug-report t]
17682 "--"
17683 ("Refresh/Reload"
17684 ["Refresh setup current buffer" org-mode-restart t]
17685 ["Reload Org (after update)" org-reload t]
17686 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17687 ))
17689 (defun org-info (&optional node)
17690 "Read documentation for Org-mode in the info system.
17691 With optional NODE, go directly to that node."
17692 (interactive)
17693 (info (format "(org)%s" (or node ""))))
17695 ;;;###autoload
17696 (defun org-submit-bug-report ()
17697 "Submit a bug report on Org-mode via mail.
17699 Don't hesitate to report any problems or inaccurate documentation.
17701 If you don't have setup sending mail from (X)Emacs, please copy the
17702 output buffer into your mail program, as it gives us important
17703 information about your Org-mode version and configuration."
17704 (interactive)
17705 (require 'reporter)
17706 (org-load-modules-maybe)
17707 (org-require-autoloaded-modules)
17708 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17709 (reporter-submit-bug-report
17710 "emacs-orgmode@gnu.org"
17711 (org-version)
17712 (let (list)
17713 (save-window-excursion
17714 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17715 (delete-other-windows)
17716 (erase-buffer)
17717 (insert "You are about to submit a bug report to the Org-mode mailing list.
17719 We would like to add your full Org-mode and Outline configuration to the
17720 bug report. This greatly simplifies the work of the maintainer and
17721 other experts on the mailing list.
17723 HOWEVER, some variables you have customized may contain private
17724 information. The names of customers, colleagues, or friends, might
17725 appear in the form of file names, tags, todo states, or search strings.
17726 If you answer yes to the prompt, you might want to check and remove
17727 such private information before sending the email.")
17728 (add-text-properties (point-min) (point-max) '(face org-warning))
17729 (when (yes-or-no-p "Include your Org-mode configuration ")
17730 (mapatoms
17731 (lambda (v)
17732 (and (boundp v)
17734 (or (and (symbol-value v)
17736 (and
17737 (get v 'custom-type) (get v 'standard-value)
17738 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17739 (push v list)))))
17740 (kill-buffer (get-buffer "*Warn about privacy*"))
17741 list))
17742 nil nil
17743 "Remember to cover the basics, that is, what you expected to happen and
17744 what in fact did happen. You don't know how to make a good report? See
17746 http://orgmode.org/manual/Feedback.html#Feedback
17748 Your bug report will be posted to the Org-mode mailing list.
17749 ------------------------------------------------------------------------")
17750 (save-excursion
17755 (defun org-install-agenda-files-menu ()
17756 (let ((bl (buffer-list)))
17757 (save-excursion
17758 (while bl
17759 (set-buffer (pop bl))
17760 (if (org-mode-p) (setq bl nil)))
17761 (when (org-mode-p)
17762 (easy-menu-change
17763 '("Org") "File List for Agenda"
17764 (append
17765 (list
17766 ["Edit File List" (org-edit-agenda-file-list) t]
17767 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17768 ["Remove Current File from List" org-remove-file t]
17769 ["Cycle through agenda files" org-cycle-agenda-files t]
17770 ["Occur in all agenda files" org-occur-in-agenda-files t]
17771 "--")
17772 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17774 ;;;; Documentation
17776 ;;;###autoload
17777 (defun org-require-autoloaded-modules ()
17778 (interactive)
17779 (mapc 'require
17780 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17781 org-docbook org-exp org-html org-icalendar
17782 org-id org-latex
17783 org-publish org-remember org-table
17784 org-timer org-xoxo)))
17786 ;;;###autoload
17787 (defun org-reload (&optional uncompiled)
17788 "Reload all org lisp files.
17789 With prefix arg UNCOMPILED, load the uncompiled versions."
17790 (interactive "P")
17791 (require 'find-func)
17793 (dir-org (file-name-directory (org-find-library-name "org")))
17794 (dir-org-contrib (ignore-errors
17795 (file-name-directory
17796 (org-find-library-name "org-contribdir"))))
17797 (babel-files
17798 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17799 (append (list nil "comint" "eval" "exp" "keys"
17800 "lob" "ref" "table" "tangle")
17801 (delq nil
17802 (mapcar
17803 (lambda (lang)
17804 (when (cdr lang) (symbol-name (car lang))))
17805 org-babel-load-languages)))))
17806 (files
17807 (append (directory-files dir-org t file-re)
17808 babel-files
17809 (and dir-org-contrib
17810 (directory-files dir-org-contrib t file-re))))
17811 (remove-re (concat (if (featurep 'xemacs)
17812 "org-colview" "org-colview-xemacs")
17814 (setq files (mapcar 'file-name-sans-extension files))
17815 (setq files (mapcar
17816 (lambda (x) (if (string-match remove-re x) nil x))
17817 files))
17818 (setq files (delq nil files))
17819 (mapc
17820 (lambda (f)
17821 (when (featurep (intern (file-name-nondirectory f)))
17822 (if (and (not uncompiled)
17823 (file-exists-p (concat f ".elc")))
17824 (load (concat f ".elc") nil nil t)
17825 (load (concat f ".el") nil nil t))))
17826 files))
17827 (org-version))
17829 ;;;###autoload
17830 (defun org-customize ()
17831 "Call the customize function with org as argument."
17832 (interactive)
17833 (org-load-modules-maybe)
17834 (org-require-autoloaded-modules)
17835 (customize-browse 'org))
17837 (defun org-create-customize-menu ()
17838 "Create a full customization menu for Org-mode, insert it into the menu."
17839 (interactive)
17840 (org-load-modules-maybe)
17841 (org-require-autoloaded-modules)
17842 (if (fboundp 'customize-menu-create)
17843 (progn
17844 (easy-menu-change
17845 '("Org") "Customize"
17846 `(["Browse Org group" org-customize t]
17847 "--"
17848 ,(customize-menu-create 'org)
17849 ["Set" Custom-set t]
17850 ["Save" Custom-save t]
17851 ["Reset to Current" Custom-reset-current t]
17852 ["Reset to Saved" Custom-reset-saved t]
17853 ["Reset to Standard Settings" Custom-reset-standard t]))
17855 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17857 ;;;; Miscellaneous stuff
17859 ;;; Generally useful functions
17861 (defun org-get-at-bol (property)
17862 "Get text property PROPERTY at beginning of line."
17863 (get-text-property (point-at-bol) property))
17865 (defun org-find-text-property-in-string (prop s)
17866 "Return the first non-nil value of property PROP in string S."
17867 (or (get-text-property 0 prop s)
17868 (get-text-property (or (next-single-property-change 0 prop s) 0)
17869 prop s)))
17871 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17872 "Display the given MESSAGE as a warning."
17873 (if (fboundp 'display-warning)
17874 (display-warning 'org message
17875 (if (featurep 'xemacs) 'warning :warning))
17876 (let ((buf (get-buffer-create "*Org warnings*")))
17877 (with-current-buffer buf
17878 (goto-char (point-max))
17879 (insert "Warning (Org): " message)
17880 (unless (bolp)
17881 (newline)))
17882 (display-buffer buf)
17883 (sit-for 0))))
17885 (defun org-in-commented-line ()
17886 "Is point in a line starting with `#'?"
17887 (equal (char-after (point-at-bol)) ?#))
17889 (defun org-in-indented-comment-line ()
17890 "Is point in a line starting with `#' after some white space?"
17891 (save-excursion
17892 (save-match-data
17893 (goto-char (point-at-bol))
17896 (defun org-in-verbatim-emphasis ()
17897 (save-match-data
17898 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17900 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17901 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17902 (if (and marker (marker-buffer marker)
17903 (buffer-live-p (marker-buffer marker)))
17904 (progn
17905 (switch-to-buffer (marker-buffer marker))
17906 (if (or (> marker (point-max)) (< marker (point-min)))
17907 (widen))
17908 (goto-char marker)
17909 (org-show-context 'org-goto))
17910 (if bookmark
17911 (bookmark-jump bookmark)
17912 (error "Cannot find location"))))
17914 (defun org-quote-csv-field (s)
17915 "Quote field for inclusion in CSV material."
17918 s))
17920 (defun org-plist-delete (plist property)
17921 "Delete PROPERTY from PLIST.
17922 This is in contrast to merely setting it to 0."
17923 (let (p)
17924 (while plist
17925 (if (not (eq property (car plist)))
17926 (setq p (plist-put p (car plist) (nth 1 plist))))
17927 (setq plist (cddr plist)))
17928 p))
17930 (defun org-force-self-insert (N)
17931 "Needed to enforce self-insert under remapping."
17932 (interactive "p")
17933 (self-insert-command N))
17935 (defun org-string-width (s)
17936 "Compute width of string, ignoring invisible characters.
17937 This ignores character with invisibility property `org-link', and also
17938 characters with property `org-cwidth', because these will become invisible
17939 upon the next fontification round."
17940 (let (b l)
17941 (when (or (eq t buffer-invisibility-spec)
17942 (assq 'org-link buffer-invisibility-spec))
17943 (while (setq b (text-property-any 0 (length s)
17944 'invisible 'org-link s))
17945 (setq s (concat (substring s 0 b)
17946 (substring s (or (next-single-property-change
17947 b 'invisible s) (length s)))))))
17948 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17949 (setq s (concat (substring s 0 b)
17950 (substring s (or (next-single-property-change
17951 b 'org-cwidth s) (length s))))))
17952 (setq l (string-width s) b -1)
17953 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
17954 (setq l (- l (get-text-property b 'org-dwidth-n s))))
17955 l))
17957 (defun org-get-indentation (&optional line)
17958 "Get the indentation of the current line, interpreting tabs.
17959 When LINE is given, assume it represents a line and compute its indentation."
17960 (if line
17961 (if (string-match "^ *" (org-remove-tabs line))
17962 (match-end 0))
17963 (save-excursion
17964 (beginning-of-line 1)
17966 (current-column))))
17968 (defun org-remove-tabs (s &optional width)
17969 "Replace tabulators in S with spaces.
17970 Assumes that s is a single line, starting in column 0."
17971 (setq width (or width tab-width))
17973 (setq s (replace-match
17974 (make-string
17975 (- (* width (/ (+ (match-beginning 0) width) width))
17976 (match-beginning 0)) ?\ )
17977 t t s)))
17978 s)
17980 (defun org-fix-indentation (line ind)
17981 "Fix indentation in LINE.
17982 IND is a cons cell with target and minimum indentation.
17983 If the current indentation in LINE is smaller than the minimum,
17984 leave it alone. If it is larger than ind, set it to the target."
17985 (let* ((l (org-remove-tabs line))
17986 (i (org-get-indentation l))
17987 (i1 (car ind)) (i2 (cdr ind)))
17988 (if (>= i i2) (setq l (substring line i2)))
17989 (if (> i1 0)
17990 (concat (make-string i1 ?\ ) l)
17991 l)))
17993 (defun org-remove-indentation (code &optional n)
17994 "Remove the maximum common indentation from the lines in CODE.
17995 N may optionally be the number of spaces to remove."
17996 (with-temp-buffer
17997 (insert code)
17998 (org-do-remove-indentation n)
17999 (buffer-string)))
18001 (defun org-do-remove-indentation (&optional n)
18002 "Remove the maximum common indentation from the buffer."
18003 (untabify (point-min) (point-max))
18004 (let ((min 10000) re)
18005 (if n
18006 (setq min n)
18007 (goto-char (point-min))
18009 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18010 (unless (or (= min 0) (= min 10000))
18012 (goto-char (point-min))
18013 (while (re-search-forward re nil t)
18014 (replace-match "")
18015 (end-of-line 1))
18016 min)))
18018 (defun org-fill-template (template alist)
18019 "Find each %key of ALIST in TEMPLATE and replace it."
18020 (let ((case-fold-search nil)
18021 entry key value)
18022 (setq alist (sort (copy-sequence alist)
18023 (lambda (a b) (< (length (car a)) (length (car b))))))
18024 (while (setq entry (pop alist))
18025 (setq template
18026 (replace-regexp-in-string
18027 (concat "%" (regexp-quote (car entry)))
18028 (cdr entry) template t t)))
18029 template))
18031 (defun org-base-buffer (buffer)
18032 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18033 (if (not buffer)
18034 buffer
18035 (or (buffer-base-buffer buffer)
18036 buffer)))
18038 (defun org-trim (s)
18039 "Remove whitespace at beginning and end of string."
18042 s)
18044 (defun org-wrap (string &optional width lines)
18045 "Wrap string to either a number of lines, or a width in characters.
18046 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18047 that costs. If there is a word longer than WIDTH, the text is actually
18048 wrapped to the length of that word.
18049 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18050 many lines, whatever width that takes.
18051 The return value is a list of lines, without newlines at the end."
18053 (maxword (apply 'max (mapcar 'org-string-width words)))
18054 w ll)
18055 (cond (width
18056 (org-do-wrap words (max maxword width)))
18057 (lines
18058 (setq w maxword)
18059 (setq ll (org-do-wrap words maxword))
18060 (if (<= (length ll) lines)
18061 ll
18062 (setq ll words)
18063 (while (> (length ll) lines)
18064 (setq w (1+ w))
18065 (setq ll (org-do-wrap words w)))
18066 ll))
18067 (t (error "Cannot wrap this")))))
18069 (defun org-do-wrap (words width)
18070 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18071 (let (lines line)
18072 (while words
18073 (setq line (pop words))
18074 (while (and words (< (+ (length line) (length (car words))) width))
18075 (setq line (concat line " " (pop words))))
18076 (setq lines (push line lines)))
18077 (nreverse lines)))
18079 (defun org-split-string (string &optional separators)
18080 "Splits STRING into substrings at SEPARATORS.
18081 No empty strings are returned if there are matches at the beginning
18082 and end of string."
18084 (start 0)
18085 notfirst
18086 (list nil))
18087 (while (and (string-match rexp string
18088 (if (and notfirst
18089 (= start (match-beginning 0))
18090 (< start (length string)))
18091 (1+ start) start))
18092 (< (match-beginning 0) (length string)))
18093 (setq notfirst t)
18094 (or (eq (match-beginning 0) 0)
18095 (and (eq (match-beginning 0) (match-end 0))
18096 (eq (match-beginning 0) start))
18097 (setq list
18098 (cons (substring string start (match-beginning 0))
18099 list)))
18100 (setq start (match-end 0)))
18101 (or (eq start (length string))
18102 (setq list
18103 (cons (substring string start)
18104 list)))
18105 (nreverse list)))
18107 (defun org-quote-vert (s)
18109 (while (string-match "|" s)
18111 s)
18113 (defun org-uuidgen-p (s)
18114 "Is S an ID created by UUIDGEN?"
18115 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18117 (defun org-context ()
18118 "Return a list of contexts of the current cursor position.
18119 If several contexts apply, all are returned.
18120 Each context entry is a list with a symbol naming the context, and
18121 two positions indicating start and end of the context. Possible
18122 contexts are:
18124 :headline anywhere in a headline
18125 :headline-stars on the leading stars in a headline
18126 :todo-keyword on a TODO keyword (including DONE) in a headline
18127 :tags on the TAGS in a headline
18128 :priority on the priority cookie in a headline
18129 :item on the first line of a plain list item
18130 :item-bullet on the bullet/number of a plain list item
18131 :checkbox on the checkbox in a plain list item
18132 :table in an org-mode table
18133 :table-special on a special filed in a table
18134 :table-table in a table.el table
18135 :link on a hyperlink
18136 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18137 :target on a <<target>>
18138 :radio-target on a <<<radio-target>>>
18139 :latex-fragment on a LaTeX fragment
18140 :latex-preview on a LaTeX fragment with overlayed preview image
18142 This function expects the position to be visible because it uses font-lock
18143 faces as a help to recognize the following contexts: :table-special, :link,
18144 and :keyword."
18145 (let* ((f (get-text-property (point) 'face))
18146 (faces (if (listp f) f (list f)))
18147 (p (point)) clist o)
18148 ;; First the large context
18149 (cond
18150 ((org-on-heading-p t)
18151 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18152 (when (progn
18153 (beginning-of-line 1)
18154 (looking-at org-todo-line-tags-regexp))
18155 (push (org-point-in-group p 1 :headline-stars) clist)
18156 (push (org-point-in-group p 2 :todo-keyword) clist)
18157 (push (org-point-in-group p 4 :tags) clist))
18158 (goto-char p)
18161 (push (org-point-in-group p 0 :priority) clist)))
18163 ((org-at-item-p)
18164 (push (org-point-in-group p 2 :item-bullet) clist)
18165 (push (list :item (point-at-bol)
18166 (save-excursion (org-end-of-item) (point)))
18167 clist)
18168 (and (org-at-item-checkbox-p)
18169 (push (org-point-in-group p 0 :checkbox) clist)))
18171 ((org-at-table-p)
18172 (push (list :table (org-table-begin) (org-table-end)) clist)
18173 (if (memq 'org-formula faces)
18174 (push (list :table-special
18175 (previous-single-property-change p 'face)
18176 (next-single-property-change p 'face)) clist)))
18177 ((org-at-table-p 'any)
18178 (push (list :table-table) clist)))
18179 (goto-char p)
18181 ;; Now the small context
18182 (cond
18183 ((org-at-timestamp-p)
18184 (push (org-point-in-group p 0 :timestamp) clist))
18185 ((memq 'org-link faces)
18186 (push (list :link
18187 (previous-single-property-change p 'face)
18188 (next-single-property-change p 'face)) clist))
18189 ((memq 'org-special-keyword faces)
18190 (push (list :keyword
18191 (previous-single-property-change p 'face)
18192 (next-single-property-change p 'face)) clist))
18193 ((org-on-target-p)
18194 (push (org-point-in-group p 0 :target) clist)
18195 (goto-char (1- (match-beginning 0)))
18196 (if (looking-at org-radio-target-regexp)
18197 (push (org-point-in-group p 0 :radio-target) clist))
18198 (goto-char p))
18199 ((setq o (car (delq nil
18200 (mapcar
18201 (lambda (x)
18202 (if (memq x org-latex-fragment-image-overlays) x))
18203 (overlays-at (point))))))
18204 (push (list :latex-fragment
18205 (overlay-start o) (overlay-end o)) clist)
18206 (push (list :latex-preview
18207 (overlay-start o) (overlay-end o)) clist))
18208 ((org-inside-LaTeX-fragment-p)
18209 ;; FIXME: positions wrong.
18210 (push (list :latex-fragment (point) (point)) clist)))
18212 (setq clist (nreverse (delq nil clist)))
18213 clist))
18215 ;; FIXME: Compare with at-regexp-p Do we need both?
18216 (defun org-in-regexp (re &optional nlines visually)
18217 "Check if point is inside a match of regexp.
18218 Normally only the current line is checked, but you can include NLINES extra
18219 lines both before and after point into the search.
18220 If VISUALLY is set, require that the cursor is not after the match but
18221 really on, so that the block visually is on the match."
18222 (catch 'exit
18223 (let ((pos (point))
18224 (eol (point-at-eol (+ 1 (or nlines 0))))
18225 (inc (if visually 1 0)))
18226 (save-excursion
18227 (beginning-of-line (- 1 (or nlines 0)))
18228 (while (re-search-forward re eol t)
18229 (if (and (<= (match-beginning 0) pos)
18230 (>= (+ inc (match-end 0)) pos))
18231 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18233 (defun org-at-regexp-p (regexp)
18234 "Is point inside a match of REGEXP in the current line?"
18235 (catch 'exit
18236 (save-excursion
18237 (let ((pos (point)) (end (point-at-eol)))
18238 (beginning-of-line 1)
18239 (while (re-search-forward regexp end t)
18240 (if (and (<= (match-beginning 0) pos)
18241 (>= (match-end 0) pos))
18242 (throw 'exit t)))
18243 nil))))
18245 (defun org-in-regexps-block-p (start-re end-re)
18246 "Return t if the current point is between matches of START-RE and END-RE.
18247 This will also return to if point is on one of the two matches."
18248 (interactive)
18249 (let ((p (point)))
18250 (save-excursion
18251 (and (or (org-at-regexp-p start-re)
18252 (re-search-backward start-re nil t))
18253 (re-search-forward end-re nil t)
18254 (>= (point) p)))))
18256 (defun org-occur-in-agenda-files (regexp &optional nlines)
18257 "Call `multi-occur' with buffers for all agenda files."
18259 (let* ((files (org-agenda-files))
18260 (tnames (mapcar 'file-truename files))
18261 (extra org-agenda-text-search-extra-files)
18262 f)
18263 (when (eq (car extra) 'agenda-archives)
18264 (setq extra (cdr extra))
18265 (setq files (org-add-archive-files files)))
18266 (while (setq f (pop extra))
18267 (unless (member (file-truename f) tnames)
18268 (add-to-list 'files f 'append)
18269 (add-to-list 'tnames (file-truename f) 'append)))
18270 (multi-occur
18271 (mapcar (lambda (x)
18272 (with-current-buffer
18273 (or (get-file-buffer x) (find-file-noselect x))
18274 (widen)
18275 (current-buffer)))
18276 files)
18277 regexp)))
18279 (if (boundp 'occur-mode-find-occurrence-hook)
18280 ;; Emacs 23
18281 (add-hook 'occur-mode-find-occurrence-hook
18282 (lambda ()
18283 (when (org-mode-p)
18284 (org-reveal))))
18285 ;; Emacs 22
18286 (defadvice occur-mode-goto-occurrence
18287 (after org-occur-reveal activate)
18288 (and (org-mode-p) (org-reveal)))
18289 (defadvice occur-mode-goto-occurrence-other-window
18290 (after org-occur-reveal activate)
18291 (and (org-mode-p) (org-reveal)))
18292 (defadvice occur-mode-display-occurrence
18293 (after org-occur-reveal activate)
18294 (when (org-mode-p)
18295 (let ((pos (occur-mode-find-occurrence)))
18296 (with-current-buffer (marker-buffer pos)
18297 (save-excursion
18298 (goto-char pos)
18299 (org-reveal)))))))
18301 (defun org-occur-link-in-agenda-files ()
18302 "Create a link and search for it in the agendas.
18303 The link is not stored in `org-stored-links', it is just created
18304 for the search purpose."
18305 (interactive)
18306 (let ((link (condition-case nil
18307 (org-store-link nil)
18308 (error "Unable to create a link to here"))))
18309 (org-occur-in-agenda-files (regexp-quote link))))
18311 (defun org-uniquify (list)
18312 "Remove duplicate elements from LIST."
18313 (let (res)
18314 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18315 res))
18317 (defun org-delete-all (elts list)
18318 "Remove all elements in ELTS from LIST."
18319 (while elts
18320 (setq list (delete (pop elts) list)))
18321 list)
18323 (defun org-count (cl-item cl-seq)
18324 "Count the number of occurrences of ITEM in SEQ.
18325 Taken from `count' in cl-seq.el with all keyword arguments removed."
18326 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18327 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18328 (while (< cl-start cl-end)
18329 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18330 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18331 (setq cl-start (1+ cl-start)))
18332 cl-count))
18334 (defun org-remove-if (predicate seq)
18335 "Remove everything from SEQ that fulfills PREDICATE."
18336 (let (res e)
18337 (while seq
18338 (setq e (pop seq))
18339 (if (not (funcall predicate e)) (push e res)))
18340 (nreverse res)))
18342 (defun org-remove-if-not (predicate seq)
18343 "Remove everything from SEQ that does not fulfill PREDICATE."
18344 (let (res e)
18345 (while seq
18346 (setq e (pop seq))
18347 (if (funcall predicate e) (push e res)))
18348 (nreverse res)))
18350 (defun org-back-over-empty-lines ()
18351 "Move backwards over whitespace, to the beginning of the first empty line.
18352 Returns the number of empty lines passed."
18353 (let ((pos (point)))
18355 (beginning-of-line 2)
18356 (goto-char (min (point) pos))
18357 (count-lines (point) pos)))
18359 (defun org-skip-whitespace ()
18362 (defun org-point-in-group (point group &optional context)
18363 "Check if POINT is in match-group GROUP.
18364 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18365 match. If the match group does not exist or point is not inside it,
18366 return nil."
18367 (and (match-beginning group)
18368 (>= point (match-beginning group))
18369 (<= point (match-end group))
18370 (if context
18371 (list context (match-beginning group) (match-end group))
18372 t)))
18374 (defun org-switch-to-buffer-other-window (&rest args)
18375 "Switch to buffer in a second window on the current frame.
18376 In particular, do not allow pop-up frames.
18377 Returns the newly created buffer."
18378 (let (pop-up-frames special-display-buffer-names special-display-regexps
18379 special-display-function)
18380 (apply 'switch-to-buffer-other-window args)))
18382 (defun org-combine-plists (&rest plists)
18383 "Create a single property list from all plists in PLISTS.
18384 The process starts by copying the first list, and then setting properties
18385 from the other lists. Settings in the last list are the most significant
18386 ones and overrule settings in the other lists."
18387 (let ((rtn (copy-sequence (pop plists)))
18388 p v ls)
18389 (while plists
18390 (setq ls (pop plists))
18391 (while ls
18392 (setq p (pop ls) v (pop ls))
18393 (setq rtn (plist-put rtn p v))))
18394 rtn))
18396 (defun org-move-line-down (arg)
18397 "Move the current line down. With prefix argument, move it past ARG lines."
18398 (interactive "p")
18399 (let ((col (current-column))
18400 beg end pos)
18401 (beginning-of-line 1) (setq beg (point))
18402 (beginning-of-line 2) (setq end (point))
18403 (beginning-of-line (+ 1 arg))
18404 (setq pos (move-marker (make-marker) (point)))
18405 (insert (delete-and-extract-region beg end))
18406 (goto-char pos)
18407 (org-move-to-column col)))
18409 (defun org-move-line-up (arg)
18410 "Move the current line up. With prefix argument, move it past ARG lines."
18411 (interactive "p")
18412 (let ((col (current-column))
18413 beg end pos)
18414 (beginning-of-line 1) (setq beg (point))
18415 (beginning-of-line 2) (setq end (point))
18416 (beginning-of-line (- arg))
18417 (setq pos (move-marker (make-marker) (point)))
18418 (insert (delete-and-extract-region beg end))
18419 (goto-char pos)
18420 (org-move-to-column col)))
18422 (defun org-replace-escapes (string table)
18423 "Replace %-escapes in STRING with values in TABLE.
18425 The sequences in STRING may contain normal field width and padding information,
18427 so values can contain further %-escapes if they are define later in TABLE."
18428 (let ((tbl (copy-alist table))
18429 (case-fold-search nil)
18430 (pchg 0)
18431 e re rpl)
18432 (while (setq e (pop tbl))
18433 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18434 (when (and (cdr e) (string-match re (cdr e)))
18435 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18436 (safe "SREF"))
18437 (add-text-properties 0 3 (list 'sref sref) safe)
18438 (setcdr e (replace-match safe t t (cdr e)))))
18439 (while (string-match re string)
18440 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18441 (cdr e)))
18442 (setq string (replace-match rpl t t string))))
18443 (while (setq pchg (next-property-change pchg string))
18444 (let ((sref (get-text-property pchg 'sref string)))
18445 (when (and sref (string-match "SREF" string pchg))
18446 (setq string (replace-match sref t t string)))))
18447 string))
18449 (defun org-sublist (list start end)
18450 "Return a section of LIST, from START to END.
18451 Counting starts at 1."
18452 (let (rtn (c start))
18453 (setq list (nthcdr (1- start) list))
18454 (while (and list (<= c end))
18455 (push (pop list) rtn)
18456 (setq c (1+ c)))
18457 (nreverse rtn)))
18459 (defun org-find-base-buffer-visiting (file)
18460 "Like `find-buffer-visiting' but always return the base buffer and
18461 not an indirect buffer."
18462 (let ((buf (or (get-file-buffer file)
18463 (find-buffer-visiting file))))
18464 (if buf
18465 (or (buffer-base-buffer buf) buf)
18466 nil)))
18468 (defun org-image-file-name-regexp (&optional extensions)
18469 "Return regexp matching the file names of images.
18470 If EXTENSIONS is given, only match these."
18471 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18472 (image-file-name-regexp)
18473 (let ((image-file-name-extensions
18474 (or extensions
18475 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18476 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18478 (regexp-opt (nconc (mapcar 'upcase
18479 image-file-name-extensions)
18480 image-file-name-extensions)
18481 t)
18484 (defun org-file-image-p (file &optional extensions)
18485 "Return non-nil if FILE is an image."
18486 (save-match-data
18487 (string-match (org-image-file-name-regexp extensions) file)))
18489 (defun org-get-cursor-date ()
18490 "Return the date at cursor in as a time.
18491 This works in the calendar and in the agenda, anywhere else it just
18492 returns the current time."
18493 (let (date day defd)
18494 (cond
18495 ((eq major-mode 'calendar-mode)
18496 (setq date (calendar-cursor-to-date)
18497 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18498 ((eq major-mode 'org-agenda-mode)
18499 (setq day (get-text-property (point) 'day))
18500 (if day
18501 (setq date (calendar-gregorian-from-absolute day)
18502 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18503 (nth 2 date))))))
18504 (or defd (current-time))))
18506 (defvar org-agenda-action-marker (make-marker)
18507 "Marker pointing to the entry for the next agenda action.")
18509 (defun org-mark-entry-for-agenda-action ()
18510 "Mark the current entry as target of an agenda action.
18511 Agenda actions are actions executed from the agenda with the key `k',
18512 which make use of the date at the cursor."
18513 (interactive)
18514 (move-marker org-agenda-action-marker
18515 (save-excursion (org-back-to-heading t) (point))
18516 (current-buffer))
18517 (message
18518 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18520 ;;; Paragraph filling stuff.
18521 ;; We want this to be just right, so use the full arsenal.
18523 (defun org-indent-line-function ()
18524 "Indent line like previous, but further if previous was headline or item."
18525 (interactive)
18526 (let* ((pos (point))
18527 (itemp (org-at-item-p))
18528 (case-fold-search t)
18530 column bpos bcol tpos tcol bullet btype bullet-type)
18531 ;; Find the previous relevant line
18532 (beginning-of-line 1)
18533 (cond
18534 ((looking-at "#") (setq column 0))
18537 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18538 (save-excursion
18539 (goto-char (1- (match-beginning 1)))
18540 (setq column (current-column))))
18542 (save-excursion
18543 (re-search-backward
18545 (setq column (org-get-indentation (match-string 0))))
18546 (t
18547 (beginning-of-line 0)
18550 (not (looking-at org-drawer-regexp)))
18551 (beginning-of-line 0))
18552 (cond
18554 (if (not org-adapt-indentation)
18555 (setq column 0)
18556 (goto-char (match-end 0))
18557 (setq column (current-column))))
18558 ((looking-at org-drawer-regexp)
18559 (goto-char (1- (match-beginning 1)))
18560 (setq column (current-column)))
18562 (goto-char (match-end 1))
18563 (setq column (current-column)))
18564 ((org-in-item-p)
18565 (org-beginning-of-item)
18567 (setq bpos (match-beginning 1) tpos (match-end 0)
18568 bcol (progn (goto-char bpos) (current-column))
18569 tcol (progn (goto-char tpos) (current-column))
18570 bullet (match-string 1)
18571 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
18572 (if (> tcol (+ bcol org-description-max-indent))
18573 (setq tcol (+ bcol 5)))
18574 (if (not itemp)
18575 (setq column tcol)
18576 (goto-char pos)
18577 (beginning-of-line 1)
18579 (progn
18581 (setq bullet (match-string 1)
18582 btype (if (string-match "[0-9]" bullet) "n" bullet))
18583 (setq column (if (equal btype bullet-type) bcol tcol)))
18584 (setq column (org-get-indentation)))))
18585 (t (setq column (org-get-indentation))))))
18586 (goto-char pos)
18587 (if (<= (current-column) (current-indentation))
18588 (org-indent-line-to column)
18589 (save-excursion (org-indent-line-to column)))
18590 (setq column (current-column))
18591 (beginning-of-line 1)
18592 (if (looking-at
18594 (replace-match (concat (match-string 1)
18595 (format org-property-format
18596 (match-string 2) (match-string 3)))
18597 t t))
18598 (org-move-to-column column)))
18600 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18601 "Variable to store copy of `adaptive-fill-regexp'.
18602 Since `adaptive-fill-regexp' is set to never match, we need to
18603 store a backup of its value before entering `org-mode' so that
18604 the functionality can be provided as a fall-back.")
18606 (defun org-set-autofill-regexps ()
18607 (interactive)
18608 ;; In the paragraph separator we include headlines, because filling
18609 ;; text in a line directly attached to a headline would otherwise
18610 ;; fill the headline as well.
18613 ;; The paragraph starter includes hand-formatted lists.
18614 (org-set-local
18615 'paragraph-start
18616 (concat
18625 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18626 ;; But only if the user has not turned off tables or fixed-width regions
18627 (org-set-local
18628 'auto-fill-inhibit-regexp
18631 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18632 (concat
18634 (if org-enable-table-editor "|" "")
18635 (if org-enable-fixed-width-editor ":" "")
18636 "]"))))
18637 ;; We use our own fill-paragraph function, to make sure that tables
18638 ;; and fixed-width regions are not wrapped. That function will pass
18639 ;; through to `fill-paragraph' when appropriate.
18640 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18641 ;; Adaptive filling: To get full control, first make sure that
18642 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18643 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18644 (org-set-local 'org-adaptive-fill-regexp-backup
18645 adaptive-fill-regexp))
18647 (org-set-local 'adaptive-fill-function
18648 'org-adaptive-fill-function)
18649 (org-set-local
18650 'align-mode-rules-list
18651 '((org-in-buffer-settings
18653 (modes . '(org-mode))))))
18655 (defun org-fill-paragraph (&optional justify)
18656 "Re-align a table, pass through to fill-paragraph if no table."
18657 (let ((table-p (org-at-table-p))
18658 (table.el-p (org-at-table.el-p)))
18659 (cond ((and (equal (char-after (point-at-bol)) ?*)
18660 (save-excursion (goto-char (point-at-bol))
18661 (looking-at outline-regexp)))
18662 t) ; skip headlines
18663 (table.el-p t) ; skip table.el tables
18664 (table-p (org-table-align) t) ; align org-mode tables
18665 (t nil)))) ; call paragraph-fill
18667 ;; For reference, this is the default value of adaptive-fill-regexp
18670 (defun org-adaptive-fill-function ()
18671 "Return a fill prefix for org-mode files.
18672 In particular, this makes sure hanging paragraphs for hand-formatted lists
18673 work correctly."
18674 (cond
18675 ;; Comment line
18677 (match-string-no-properties 0))
18678 ;; Description list
18680 (save-excursion
18681 (if (> (match-end 1) (+ (match-beginning 1)
18682 org-description-max-indent))
18683 (goto-char (+ (match-beginning 1) 5))
18684 (goto-char (match-end 0)))
18685 (make-string (current-column) ?\ )))
18686 ;; Ordered or unordered list
18688 (save-excursion
18689 (goto-char (match-end 0))
18690 (make-string (current-column) ?\ )))
18691 ;; Other text
18692 ((looking-at org-adaptive-fill-regexp-backup)
18693 (match-string-no-properties 0))))
18695 ;;; Other stuff.
18697 (defun org-toggle-fixed-width-section (arg)
18698 "Toggle the fixed-width export.
18699 If there is no active region, the QUOTE keyword at the current headline is
18700 inserted or removed. When present, it causes the text between this headline
18701 and the next to be exported as fixed-width text, and unmodified.
18702 If there is an active region, this command adds or removes a colon as the
18703 first character of this line. If the first character of a line is a colon,
18704 this line is also exported in fixed-width font."
18705 (interactive "P")
18706 (let* ((cc 0)
18707 (regionp (org-region-active-p))
18708 (beg (if regionp (region-beginning) (point)))
18709 (end (if regionp (region-end)))
18710 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18711 (case-fold-search nil)
18713 off)
18714 (if regionp
18715 (save-excursion
18716 (goto-char beg)
18717 (setq cc (current-column))
18718 (beginning-of-line 1)
18719 (setq off (looking-at re))
18720 (while (> nlines 0)
18721 (setq nlines (1- nlines))
18722 (beginning-of-line 1)
18723 (cond
18724 (arg
18725 (org-move-to-column cc t)
18727 (forward-line -1))
18728 ((and off (looking-at re))
18729 (replace-match "" t t nil 1))
18730 ((not off) (org-move-to-column cc t) (insert ": ")))
18731 (forward-line 1)))
18732 (save-excursion
18733 (org-back-to-heading)
18734 (if (looking-at (concat outline-regexp
18736 (replace-match "" t t nil 1)
18737 (if (looking-at outline-regexp)
18738 (progn
18739 (goto-char (match-end 0))
18740 (insert org-quote-string " "))))))))
18742 (defun org-reftex-citation ()
18743 "Use reftex-citation to insert a citation into the buffer.
18744 This looks for a line like
18746 #+BIBLIOGRAPHY: foo plain option:-d
18748 and derives from it that foo.bib is the bibliography file relevant
18749 for this document. It then installs the necessary environment for RefTeX
18750 to work in this buffer and calls `reftex-citation' to insert a citation
18751 into the buffer.
18753 Export of such citations to both LaTeX and HTML is handled by the contributed
18754 package org-exp-bibtex by Taru Karttunen."
18755 (interactive)
18756 (let ((reftex-docstruct-symbol 'rds)
18758 rds bib)
18759 (save-excursion
18760 (save-restriction
18761 (widen)
18762 (let ((case-fold-search t)
18764 (if (not (save-excursion
18765 (or (re-search-forward re nil t)
18766 (re-search-backward re nil t))))
18767 (error "No bibliography defined in file")
18768 (setq bib (concat (match-string 1) ".bib")
18769 rds (list (list 'bib bib)))))))
18770 (call-interactively 'reftex-citation)))
18772 ;;;; Functions extending outline functionality
18774 (defun org-beginning-of-line (&optional arg)
18775 "Go to the beginning of the current line. If that is invisible, continue
18776 to a visible line beginning. This makes the function of C-a more intuitive.
18777 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18778 first attempt, and only move to after the tags when the cursor is already
18779 beyond the end of the headline."
18780 (interactive "P")
18781 (let ((pos (point))
18782 (special (if (consp org-special-ctrl-a/e)
18783 (car org-special-ctrl-a/e)
18784 org-special-ctrl-a/e))
18785 refpos)
18786 (if (org-bound-and-true-p line-move-visual)
18787 (beginning-of-visual-line 1)
18788 (beginning-of-line 1))
18789 (if (and arg (fboundp 'move-beginning-of-line))
18790 (call-interactively 'move-beginning-of-line)
18791 (if (bobp)
18792 nil
18793 (backward-char 1)
18794 (if (org-truely-invisible-p)
18795 (while (and (not (bobp)) (org-truely-invisible-p))
18796 (backward-char 1)
18797 (beginning-of-line 1))
18798 (forward-char 1))))
18799 (when special
18800 (cond
18801 ((and (looking-at org-complex-heading-regexp)
18802 (= (char-after (match-end 1)) ?\ ))
18803 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18804 (point-at-eol)))
18805 (goto-char
18806 (if (eq special t)
18807 (cond ((> pos refpos) refpos)
18808 ((= pos (point)) refpos)
18809 (t (point)))
18810 (cond ((> pos (point)) (point))
18811 ((not (eq last-command this-command)) (point))
18812 (t refpos)))))
18813 ((org-at-item-p)
18814 (goto-char
18815 (if (eq special t)
18816 (cond ((> pos (match-end 4)) (match-end 4))
18817 ((= pos (point)) (match-end 4))
18818 (t (point)))
18819 (cond ((> pos (point)) (point))
18820 ((not (eq last-command this-command)) (point))
18821 (t (match-end 4))))))))
18822 (org-no-warnings
18823 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18825 (defun org-end-of-line (&optional arg)
18826 "Go to the end of the line.
18827 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18828 first attempt, and only move to after the tags when the cursor is already
18829 beyond the end of the headline."
18830 (interactive "P")
18831 (let ((special (if (consp org-special-ctrl-a/e)
18832 (cdr org-special-ctrl-a/e)
18833 org-special-ctrl-a/e)))
18834 (if (or (not special)
18835 (not (org-on-heading-p))
18836 arg)
18837 (call-interactively
18838 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18839 ((fboundp 'move-end-of-line) 'move-end-of-line)
18840 (t 'end-of-line)))
18841 (let ((pos (point)))
18842 (beginning-of-line 1)
18844 (if (eq special t)
18845 (if (or (< pos (match-beginning 1))
18846 (= pos (match-end 0)))
18847 (goto-char (match-beginning 1))
18848 (goto-char (match-end 0)))
18849 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18850 (goto-char (match-end 0))
18851 (goto-char (match-beginning 1))))
18852 (call-interactively (if (fboundp 'move-end-of-line)
18853 'move-end-of-line
18854 'end-of-line)))))
18855 (org-no-warnings
18856 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18858 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18859 (define-key org-mode-map "\C-e" 'org-end-of-line)
18860 (define-key org-mode-map [home] 'org-beginning-of-line)
18861 (define-key org-mode-map [end] 'org-end-of-line)
18863 (defun org-backward-sentence (&optional arg)
18864 "Go to beginning of sentence, or beginning of table field.
18865 This will call `backward-sentence' or `org-table-beginning-of-field',
18866 depending on context."
18867 (interactive "P")
18868 (cond
18869 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18870 (t (call-interactively 'backward-sentence))))
18872 (defun org-forward-sentence (&optional arg)
18873 "Go to end of sentence, or end of table field.
18874 This will call `forward-sentence' or `org-table-end-of-field',
18875 depending on context."
18876 (interactive "P")
18877 (cond
18878 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18879 (t (call-interactively 'forward-sentence))))
18881 (define-key org-mode-map "\M-a" 'org-backward-sentence)
18882 (define-key org-mode-map "\M-e" 'org-forward-sentence)
18884 (defun org-kill-line (&optional arg)
18885 "Kill line, to tags or end of line."
18886 (interactive "P")
18887 (cond
18888 ((or (not org-special-ctrl-k)
18889 (bolp)
18890 (not (org-on-heading-p)))
18891 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
18892 org-ctrl-k-protect-subtree)
18893 (if (or (eq org-ctrl-k-protect-subtree 'error)
18894 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
18895 (error "C-k aborted - would kill hidden subtree")))
18896 (call-interactively 'kill-line))
18898 (kill-region (point) (match-beginning 1))
18899 (org-set-tags nil t))
18900 (t (kill-region (point) (point-at-eol)))))
18902 (define-key org-mode-map "\C-k" 'org-kill-line)
18904 (defun org-yank (&optional arg)
18905 "Yank. If the kill is a subtree, treat it specially.
18906 This command will look at the current kill and check if is a single
18907 subtree, or a series of subtrees[1]. If it passes the test, and if the
18908 cursor is at the beginning of a line or after the stars of a currently
18909 empty headline, then the yank is handled specially. How exactly depends
18910 on the value of the following variables, both set by default.
18912 org-yank-folded-subtrees
18913 When set, the subtree(s) will be folded after insertion, but only
18914 if doing so would now swallow text after the yanked text.
18916 org-yank-adjusted-subtrees
18917 When set, the subtree will be promoted or demoted in order to
18918 fit into the local outline tree structure, which means that the level
18919 will be adjusted so that it becomes the smaller one of the two
18920 *visible* surrounding headings.
18922 Any prefix to this command will cause `yank' to be called directly with
18924 will just
18925 plainly yank the text as it is.
18927 \[1] The test checks if the first non-white line is a heading
18928 and if there are no other headings with fewer stars."
18929 (interactive "P")
18930 (org-yank-generic 'yank arg))
18932 (defun org-yank-generic (command arg)
18933 "Perform some yank-like command.
18935 This function implements the behavior described in the `org-yank'
18936 documentation. However, it has been generalized to work for any
18937 interactive command with similar behavior."
18939 ;; pretend to be command COMMAND
18940 (setq this-command command)
18942 (if arg
18943 (call-interactively command)
18945 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
18946 (and (org-kill-is-subtree-p)
18947 (or (bolp)
18949 (string-match
18951 (buffer-substring (point-at-bol) (point)))))))
18952 swallowp)
18953 (cond
18954 ((and subtreep org-yank-folded-subtrees)
18955 (let ((beg (point))
18956 end)
18957 (if (and subtreep org-yank-adjusted-subtrees)
18958 (org-paste-subtree nil nil 'for-yank)
18959 (call-interactively command))
18961 (setq end (point))
18962 (goto-char beg)
18963 (when (and (bolp) subtreep
18964 (not (setq swallowp
18965 (org-yank-folding-would-swallow-text beg end))))
18966 (or (looking-at outline-regexp)
18967 (re-search-forward (concat "^" outline-regexp) end t))
18968 (while (and (< (point) end) (looking-at outline-regexp))
18969 (hide-subtree)
18970 (org-cycle-show-empty-lines 'folded)
18971 (condition-case nil
18972 (outline-forward-same-level 1)
18973 (error (goto-char end)))))
18974 (when swallowp
18975 (message
18976 "Inserted text not folded because that would swallow text"))
18978 (goto-char end)
18980 (beginning-of-line 1)
18981 (push-mark beg 'nomsg)))
18982 ((and subtreep org-yank-adjusted-subtrees)
18983 (let ((beg (point-at-bol)))
18984 (org-paste-subtree nil nil 'for-yank)
18985 (push-mark beg 'nomsg)))
18986 (t
18987 (call-interactively command))))))
18989 (defun org-yank-folding-would-swallow-text (beg end)
18990 "Would hide-subtree at BEG swallow any text after END?"
18991 (let (level)
18992 (save-excursion
18993 (goto-char beg)
18994 (when (or (looking-at outline-regexp)
18995 (re-search-forward (concat "^" outline-regexp) end t))
18996 (setq level (org-outline-level)))
18997 (goto-char end)
18999 (if (or (eobp)
19000 (and (bolp) (looking-at org-outline-regexp)
19001 (<= (org-outline-level) level)))
19002 nil ; Nothing would be swallowed
19003 t)))) ; something would swallow
19005 (define-key org-mode-map "\C-y" 'org-yank)
19007 (defun org-invisible-p ()
19008 "Check if point is at a character currently not visible."
19009 ;; Early versions of noutline don't have `outline-invisible-p'.
19010 (if (fboundp 'outline-invisible-p)
19011 (outline-invisible-p)
19012 (get-char-property (point) 'invisible)))
19014 (defun org-truely-invisible-p ()
19015 "Check if point is at a character currently not visible.
19016 This version does not only check the character property, but also
19017 `visible-mode'."
19018 ;; Early versions of noutline don't have `outline-invisible-p'.
19019 (if (org-bound-and-true-p visible-mode)
19020 nil
19021 (if (fboundp 'outline-invisible-p)
19022 (outline-invisible-p)
19023 (get-char-property (point) 'invisible))))
19025 (defun org-invisible-p2 ()
19026 "Check if point is at a character currently not visible."
19027 (save-excursion
19028 (if (and (eolp) (not (bobp))) (backward-char 1))
19029 ;; Early versions of noutline don't have `outline-invisible-p'.
19030 (if (fboundp 'outline-invisible-p)
19031 (outline-invisible-p)
19032 (get-char-property (point) 'invisible))))
19034 (defun org-back-to-heading (&optional invisible-ok)
19035 "Call `outline-back-to-heading', but provide a better error message."
19036 (condition-case nil
19037 (outline-back-to-heading invisible-ok)
19038 (error (error "Before first headline at position %d in buffer %s"
19039 (point) (current-buffer)))))
19041 (defun org-beginning-of-defun ()
19042 "Go to the beginning of the subtree, i.e. back to the heading."
19043 (org-back-to-heading))
19044 (defun org-end-of-defun ()
19045 "Go to the end of the subtree."
19046 (org-end-of-subtree nil t))
19048 (defun org-before-first-heading-p ()
19049 "Before first heading?"
19050 (save-excursion
19053 (defun org-on-heading-p (&optional ignored)
19054 (outline-on-heading-p t))
19055 (defun org-at-heading-p (&optional ignored)
19056 (outline-on-heading-p t))
19058 (defun org-point-at-end-of-empty-headline ()
19059 "If point is at the end of an empty headline, return t, else nil.
19060 If the heading only contains a TODO keyword, it is still still considered
19061 empty."
19063 (save-excursion
19064 (beginning-of-line 1)
19067 (defun org-at-heading-or-item-p ()
19068 (or (org-on-heading-p) (org-at-item-p)))
19070 (defun org-on-target-p ()
19071 (or (org-in-regexp org-radio-target-regexp)
19072 (org-in-regexp org-target-regexp)))
19074 (defun org-up-heading-all (arg)
19075 "Move to the heading line of which the present line is a subheading.
19076 This function considers both visible and invisible heading lines.
19077 With argument, move up ARG levels."
19078 (if (fboundp 'outline-up-heading-all)
19079 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19080 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19082 (defun org-up-heading-safe ()
19083 "Move to the heading line of which the present line is a subheading.
19084 This version will not throw an error. It will return the level of the
19085 headline found, or nil if no higher level is found.
19087 Also, this function will be a lot faster than `outline-up-heading',
19088 because it relies on stars being the outline starters. This can really
19089 make a significant difference in outlines with very many siblings."
19090 (let (start-level re)
19091 (org-back-to-heading t)
19092 (setq start-level (funcall outline-level))
19093 (if (equal start-level 1)
19094 nil
19096 (if (re-search-backward re nil t)
19097 (funcall outline-level)))))
19099 (defun org-first-sibling-p ()
19100 "Is this heading the first child of its parents?"
19101 (interactive)
19102 (let ((re (concat "^" outline-regexp))
19103 level l)
19104 (unless (org-at-heading-p t)
19105 (error "Not at a heading"))
19106 (setq level (funcall outline-level))
19107 (save-excursion
19108 (if (not (re-search-backward re nil t))
19109 t
19110 (setq l (funcall outline-level))
19111 (< l level)))))
19113 (defun org-goto-sibling (&optional previous)
19114 "Goto the next sibling, even if it is invisible.
19115 When PREVIOUS is set, go to the previous sibling instead. Returns t
19116 when a sibling was found. When none is found, return nil and don't
19117 move point."
19118 (let ((fun (if previous 're-search-backward 're-search-forward))
19119 (pos (point))
19120 (re (concat "^" outline-regexp))
19121 level l)
19122 (when (condition-case nil (org-back-to-heading t) (error nil))
19123 (setq level (funcall outline-level))
19124 (catch 'exit
19125 (or previous (forward-char 1))
19126 (while (funcall fun re nil t)
19127 (setq l (funcall outline-level))
19128 (when (< l level) (goto-char pos) (throw 'exit nil))
19129 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19130 (goto-char pos)
19131 nil))))
19133 (defun org-show-siblings ()
19134 "Show all siblings of the current headline."
19135 (save-excursion
19136 (while (org-goto-sibling) (org-flag-heading nil)))
19137 (save-excursion
19138 (while (org-goto-sibling 'previous)
19139 (org-flag-heading nil))))
19141 (defun org-show-hidden-entry ()
19142 "Show an entry where even the heading is hidden."
19143 (save-excursion
19144 (org-show-entry)))
19146 (defun org-flag-heading (flag &optional entry)
19147 "Flag the current heading. FLAG non-nil means make invisible.
19148 When ENTRY is non-nil, show the entire entry."
19149 (save-excursion
19150 (org-back-to-heading t)
19151 ;; Check if we should show the entire entry
19152 (if entry
19153 (progn
19154 (org-show-entry)
19155 (save-excursion
19156 (and (outline-next-heading)
19157 (org-flag-heading nil))))
19158 (outline-flag-region (max (point-min) (1- (point)))
19159 (save-excursion (outline-end-of-heading) (point))
19160 flag))))
19162 (defun org-get-next-sibling ()
19163 "Move to next heading of the same level, and return point.
19164 If there is no such heading, return nil.
19165 This is like outline-next-sibling, but invisible headings are ok."
19166 (let ((level (funcall outline-level)))
19167 (outline-next-heading)
19168 (while (and (not (eobp)) (> (funcall outline-level) level))
19169 (outline-next-heading))
19170 (if (or (eobp) (< (funcall outline-level) level))
19171 nil
19172 (point))))
19174 (defun org-get-last-sibling ()
19175 "Move to previous heading of the same level, and return point.
19176 If there is no such heading, return nil."
19177 (let ((opoint (point))
19178 (level (funcall outline-level)))
19179 (outline-previous-heading)
19180 (when (and (/= (point) opoint) (outline-on-heading-p t))
19181 (while (and (> (funcall outline-level) level)
19182 (not (bobp)))
19183 (outline-previous-heading))
19184 (if (< (funcall outline-level) level)
19185 nil
19186 (point)))))
19188 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19189 ;; This contains an exact copy of the original function, but it uses
19190 ;; `org-back-to-heading', to make it work also in invisible
19191 ;; trees. And is uses an invisible-OK argument.
19192 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19193 ;; Furthermore, when used inside Org, finding the end of a large subtree
19194 ;; with many children and grandchildren etc, this can be much faster
19195 ;; than the outline version.
19196 (org-back-to-heading invisible-OK)
19197 (let ((first t)
19198 (level (funcall outline-level)))
19199 (if (and (org-mode-p) (< level 1000))
19200 ;; A true heading (not a plain list item), in Org-mode
19201 ;; This means we can easily find the end by looking
19202 ;; only for the right number of stars. Using a regexp to do
19203 ;; this is so much faster than using a Lisp loop.
19205 (forward-char 1)
19206 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19207 ;; something else, do it the slow way
19208 (while (and (not (eobp))
19209 (or first (> (funcall outline-level) level)))
19210 (setq first nil)
19211 (outline-next-heading)))
19212 (unless to-heading
19214 (progn
19215 ;; Go to end of line before heading
19216 (forward-char -1)
19218 ;; leave blank line before heading
19219 (forward-char -1))))))
19220 (point))
19222 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19223 "Use Org version in org-mode, for dramatic speed-up."
19224 (if (eq major-mode 'org-mode)
19225 (progn
19226 (org-end-of-subtree nil t)
19227 (unless (eobp) (backward-char 1)))
19228 ad-do-it))
19230 (defun org-forward-same-level (arg &optional invisible-ok)
19231 "Move forward to the arg'th subheading at same level as this one.
19232 Stop at the first and last subheadings of a superior heading."
19233 (interactive "p")
19234 (org-back-to-heading invisible-ok)
19235 (org-on-heading-p)
19236 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19238 l)
19239 (forward-char 1)
19240 (while (> arg 0)
19241 (while (and (re-search-forward re nil 'move)
19242 (setq l (- (match-end 0) (match-beginning 0) 1))
19243 (= l level)
19244 (not invisible-ok)
19245 (progn (backward-char 1) (org-invisible-p)))
19246 (if (< l level) (setq arg 1)))
19247 (setq arg (1- arg)))
19248 (beginning-of-line 1)))
19250 (defun org-backward-same-level (arg &optional invisible-ok)
19251 "Move backward to the arg'th subheading at same level as this one.
19252 Stop at the first and last subheadings of a superior heading."
19253 (interactive "p")
19254 (org-back-to-heading)
19255 (org-on-heading-p)
19256 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19258 l)
19259 (while (> arg 0)
19260 (while (and (re-search-backward re nil 'move)
19261 (setq l (- (match-end 0) (match-beginning 0) 1))
19262 (= l level)
19263 (not invisible-ok)
19264 (org-invisible-p))
19265 (if (< l level) (setq arg 1)))
19266 (setq arg (1- arg)))))
19268 (defun org-show-subtree ()
19269 "Show everything after this heading at deeper levels."
19270 (outline-flag-region
19271 (point)
19272 (save-excursion
19273 (org-end-of-subtree t t))
19274 nil))
19276 (defun org-show-entry ()
19277 "Show the body directly following this heading.
19278 Show the heading too, if it is currently invisible."
19279 (interactive)
19280 (save-excursion
19281 (condition-case nil
19282 (progn
19283 (org-back-to-heading t)
19284 (outline-flag-region
19285 (max (point-min) (1- (point)))
19286 (save-excursion
19287 (if (re-search-forward
19289 (match-beginning 1)
19290 (point-max)))
19291 nil)
19292 (org-cycle-hide-drawers 'children))
19293 (error nil))))
19295 (defun org-make-options-regexp (kwds &optional extra)
19296 "Make a regular expression for keyword lines."
19297 (concat
19298 "^"
19305 ;; Make isearch reveal the necessary context
19306 (defun org-isearch-end ()
19307 "Reveal context after isearch exits."
19308 (when isearch-success ; only if search was successful
19309 (if (featurep 'xemacs)
19310 ;; Under XEmacs, the hook is run in the correct place,
19311 ;; we directly show the context.
19312 (org-show-context 'isearch)
19313 ;; In Emacs the hook runs *before* restoring the overlays.
19314 ;; So we have to use a one-time post-command-hook to do this.
19315 ;; (Emacs 22 has a special variable, see function `org-mode')
19316 (unless (and (boundp 'isearch-mode-end-hook-quit)
19317 isearch-mode-end-hook-quit)
19318 ;; Only when the isearch was not quitted.
19319 (org-add-hook 'post-command-hook 'org-isearch-post-command
19320 'append 'local)))))
19322 (defun org-isearch-post-command ()
19323 "Remove self from hook, and show context."
19324 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19325 (org-show-context 'isearch))
19328 ;;;; Integration with and fixes for other packages
19330 ;;; Imenu support
19332 (defvar org-imenu-markers nil
19333 "All markers currently used by Imenu.")
19334 (make-variable-buffer-local 'org-imenu-markers)
19336 (defun org-imenu-new-marker (&optional pos)
19337 "Return a new marker for use by Imenu, and remember the marker."
19338 (let ((m (make-marker)))
19339 (move-marker m (or pos (point)))
19340 (push m org-imenu-markers)
19341 m))
19343 (defun org-imenu-get-tree ()
19344 "Produce the index for Imenu."
19345 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19346 (setq org-imenu-markers nil)
19347 (let* ((n org-imenu-depth)
19348 (re (concat "^" outline-regexp))
19349 (subs (make-vector (1+ n) nil))
19350 (last-level 0)
19351 m level head)
19352 (save-excursion
19353 (save-restriction
19354 (widen)
19355 (goto-char (point-max))
19356 (while (re-search-backward re nil t)
19357 (setq level (org-reduced-level (funcall outline-level)))
19358 (when (<= level n)
19359 (looking-at org-complex-heading-regexp)
19360 (setq head (org-link-display-format
19361 (org-match-string-no-properties 4))
19362 m (org-imenu-new-marker))
19363 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19364 (if (>= level last-level)
19365 (push (cons head m) (aref subs level))
19366 (push (cons head (aref subs (1+ level))) (aref subs level))
19367 (loop for i from (1+ level) to n do (aset subs i nil)))
19368 (setq last-level level)))))
19369 (aref subs 1)))
19371 (eval-after-load "imenu"
19372 '(progn
19373 (add-hook 'imenu-after-jump-hook
19374 (lambda ()
19375 (if (eq major-mode 'org-mode)
19376 (org-show-context 'org-goto))))))
19378 (defun org-link-display-format (link)
19379 "Replace a link with either the description, or the link target
19380 if no description is present"
19381 (save-match-data
19382 (if (string-match org-bracket-link-analytic-regexp link)
19383 (replace-match (if (match-end 5)
19384 (match-string 5 link)
19385 (concat (match-string 1 link)
19386 (match-string 3 link)))
19387 nil t link)
19388 link)))
19390 ;; Speedbar support
19392 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19393 "Overlay marking the agenda restriction line in speedbar.")
19394 (overlay-put org-speedbar-restriction-lock-overlay
19395 'face 'org-agenda-restriction-lock)
19396 (overlay-put org-speedbar-restriction-lock-overlay
19397 'help-echo "Agendas are currently limited to this item.")
19398 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19400 (defun org-speedbar-set-agenda-restriction ()
19401 "Restrict future agenda commands to the location at point in speedbar.
19403 (interactive)
19404 (require 'org-agenda)
19405 (let (p m tp np dir txt)
19406 (cond
19407 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19408 'org-imenu t))
19409 (setq m (get-text-property p 'org-imenu-marker))
19410 (with-current-buffer (marker-buffer m)
19411 (goto-char m)
19412 (org-agenda-set-restriction-lock 'subtree)))
19413 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19414 'speedbar-function 'speedbar-find-file))
19415 (setq tp (previous-single-property-change
19416 (1+ p) 'speedbar-function)
19417 np (next-single-property-change
19418 tp 'speedbar-function)
19419 dir (speedbar-line-directory)
19420 txt (buffer-substring-no-properties (or tp (point-min))
19421 (or np (point-max))))
19422 (with-current-buffer (find-file-noselect
19423 (let ((default-directory dir))
19424 (expand-file-name txt)))
19425 (unless (org-mode-p)
19426 (error "Cannot restrict to non-Org-mode file"))
19427 (org-agenda-set-restriction-lock 'file)))
19428 (t (error "Don't know how to restrict Org-mode's agenda")))
19429 (move-overlay org-speedbar-restriction-lock-overlay
19430 (point-at-bol) (point-at-eol))
19431 (setq current-prefix-arg nil)
19432 (org-agenda-maybe-redo)))
19434 (eval-after-load "speedbar"
19435 '(progn
19436 (speedbar-add-supported-extension ".org")
19437 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19438 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19439 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19440 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19441 (add-hook 'speedbar-visiting-tag-hook
19442 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19444 ;;; Fixes and Hacks for problems with other packages
19446 ;; Make flyspell not check words in links, to not mess up our keymap
19447 (defun org-mode-flyspell-verify ()
19448 "Don't let flyspell put overlays at active buttons."
19449 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19450 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19452 (defun org-remove-flyspell-overlays-in (beg end)
19453 "Remove flyspell overlays in region."
19454 (and (org-bound-and-true-p flyspell-mode)
19455 (fboundp 'flyspell-delete-region-overlays)
19456 (flyspell-delete-region-overlays beg end))
19457 (add-text-properties beg end '(org-no-flyspell t)))
19459 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19460 (eval-after-load "bookmark"
19461 '(if (boundp 'bookmark-after-jump-hook)
19462 ;; We can use the hook
19463 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19464 ;; Hook not available, use advice
19465 (defadvice bookmark-jump (after org-make-visible activate)
19466 "Make the position visible."
19467 (org-bookmark-jump-unhide))))
19469 ;; Make sure saveplace shows the location if it was hidden
19470 (eval-after-load "saveplace"
19471 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19472 "Make the position visible."
19473 (org-bookmark-jump-unhide)))
19475 ;; Make sure ecb shows the location if it was hidden
19476 (eval-after-load "ecb"
19477 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19478 "Make hierarchy visible when jumping into location from ECB tree buffer."
19479 (if (eq major-mode 'org-mode)
19480 (org-show-context))))
19482 (defun org-bookmark-jump-unhide ()
19483 "Unhide the current position, to show the bookmark location."
19484 (and (org-mode-p)
19485 (or (org-invisible-p)
19486 (save-excursion (goto-char (max (point-min) (1- (point))))
19487 (org-invisible-p)))
19488 (org-show-context 'bookmark-jump)))
19490 ;; Make session.el ignore our circular variable
19491 (eval-after-load "session"
19492 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19494 ;;;; Experimental code
19496 (defun org-closed-in-range ()
19497 "Sparse tree of items closed in a certain time range.
19498 Still experimental, may disappear in the future."
19499 (interactive)
19500 ;; Get the time interval from the user.
19501 (let* ((time1 (org-float-time
19502 (org-read-date nil 'to-time nil "Starting date: ")))
19503 (time2 (org-float-time
19504 (org-read-date nil 'to-time nil "End date:")))
19505 ;; callback function
19506 (callback (lambda ()
19507 (let ((time
19508 (org-float-time
19509 (apply 'encode-time
19510 (org-parse-time-string
19511 (match-string 1))))))
19512 ;; check if time in interval
19513 (and (>= time time1) (<= time time2))))))
19514 ;; make tree, check each match with the callback
19517 ;;;; Finish up
19519 (provide 'org)
19521 (run-hooks 'org-load-hook)
19523 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19525 ;;; org.el ends here