| blob | 0e933e20bf83f8aa3345d52c4b5707c65c2480ae |
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
90 ;; Other stuff we need.
104 ;; babel
113 ;; load languages based on value of `org-babel-load-languages'
115 ;;;###autoload
117 "Load the languages defined in `org-babel-load-languages'."
129 org-babel-load-languages))
132 "Languages which can be evaluated in Org-mode buffers.
133 This list can be used to load support for any of the languages
134 below, note that each language will depend on a different set of
135 system executables and/or Emacs modes. When a language is
137 with `org-babel-execute-src-block' bound by default to C-c
138 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
139 be set to remove code block evaluation from the C-c C-c
140 keybinding. By default only Emacs Lisp (which has no
141 requirements) is loaded."
145 :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".
3186 )
3187 "Alist of default packages to be inserted in the header.
3188 Change this only if one of the packages here causes an incompatibility
3189 with another package you are using.
3190 The packages in this list are needed by one part or another of Org-mode
3191 to function properly.
3193 - inputenc, fontenc: for basic font and character selection
3194 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3195 for interpreting the entities in `org-entities'. You can skip some of these
3196 packages if you don't use any of the symbols in it.
3197 - graphicx: for including images
3198 - float, wrapfig: for figure placement
3199 - longtable: for long tables
3200 - hyperref: for cross references
3202 Therefore you should not modify this variable unless you know what you
3203 are doing. The one reason to change it anyway is that you might be loading
3204 some other package that conflicts with one of the default packages.
3206 If SNIPPET-FLAG is t, the package also needs to be included when
3207 compiling LaTeX snippets into images for inclusion into HTML."
3220 "Alist of packages to be inserted in every LaTeX header.
3221 These will be inserted after `org-export-latex-default-packages-alist'.
3223 SNIPPET-FLAG, when t, indicates that this package is also needed when
3224 turning LaTeX snippets into images for inclusion into HTML.
3225 Make sure that you only list packages here which:
3226 - you want in every file
3227 - do not conflict with the default packages in
3228 `org-export-latex-default-packages-alist'
3229 - do not conflict with the setup in `org-format-latex-header'."
3243 "Settings for Org-mode appearance."
3248 "Non-nil means fontify only the stars in each headline.
3249 When nil, the entire headline is fontified.
3250 Changing it requires restart of `font-lock-mode' to become effective
3251 also in regions already fontified."
3256 "Non-nil means hide the first N-1 stars in a headline.
3257 This works by using the face `org-hide' for these stars. This
3258 face is white for a light background, and black for a dark
3259 background. You may have to customize the face `org-hide' to
3260 make this work.
3261 Changing it requires restart of `font-lock-mode' to become effective
3262 also in regions already fontified.
3263 You may also set this on a per-file basis by adding one of the following
3264 lines to the buffer:
3266 #+STARTUP: hidestars
3267 #+STARTUP: showstars"
3272 "List of keywords that should be hidden when typed in the org buffer.
3273 For example, add #+TITLE to this list in order to make the
3274 document title appear in the buffer without the initial #+TITLE:
3275 keyword."
3283 "Non-nil means change the face of a headline if it is marked DONE.
3284 Normally, only the TODO/DONE keyword indicates the state of a headline.
3285 When this is non-nil, the headline after the keyword is set to the
3286 `org-headline-done' as an additional indication."
3291 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3292 Changing this variable requires a restart of Emacs to take effect."
3297 "Non-nil means fontify the whole line for headings.
3298 This is useful when setting a background color for the
3299 org-level-* faces."
3304 "Non-nil means fontify what is treated specially by the exporters."
3309 "Non-nil mean font-lock should hide the emphasis marker characters."
3314 "Non-nil means show entities as UTF8 characters.
3320 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3325 "Regular expression for matching emphasis.
3326 After a match, the match groups contain these elements:
3327 0 The match of the full regular expression, including the characters
3328 before and after the proper match
3329 1 The character before the proper match, or empty at beginning of line
3330 2 The proper match, including the leading and trailing markers
3331 3 The leading marker like * or /, indicating the type of highlighting
3332 4 The text between the emphasis markers, not including the markers
3339 "Set variable and compute the emphasis regular expression."
3343 org-emphasis-alist org-emphasis-regexp-components)
3355 ;; make sure special characters appear at the right position in the class
3367 ;; Make the regexp
3375 body1
3387 body1
3395 "Components used to build the regular expression for emphasis.
3396 This is a list with 6 entries. Terminology: In an emphasis string
3400 specify what is allowed/forbidden in each part:
3402 pre Chars allowed as prematch. Beginning of line will be allowed too.
3403 post Chars allowed as postmatch. End of line will be allowed too.
3404 border The chars *forbidden* as border characters.
3406 non-shy groups here, and don't allow newline here.
3407 newline The maximum number of newlines allowed in an emphasis exp.
3409 Use customize to modify this, or restart Emacs after changing it."
3428 )
3429 "Special syntax for emphasized text.
3430 Text starting and ending with a special character will be emphasized, for
3431 example *bold*, _underlined_ and /italic/. This variable sets the marker
3432 characters, the face to be used by font-lock for highlighting in Org-mode
3433 Emacs buffers, and the HTML tags to be used for this.
3434 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3435 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3436 Use customize to modify this, or restart Emacs after changing it."
3451 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3454 ;;; Miscellaneous options
3457 "Completion in Org-mode."
3462 "Non-nil means use ido completion wherever possible.
3463 Note that `ido-mode' must be active for this variable to be relevant.
3464 If you decide to turn this variable on, you might well want to turn off
3465 `org-outline-path-complete-in-steps'.
3466 See also `org-completion-use-iswitchb'."
3471 "Non-nil means use iswitchb completion wherever possible.
3472 Note that `iswitchb-mode' must be active for this variable to be relevant.
3473 If you decide to turn this variable on, you might well want to turn off
3474 `org-outline-path-complete-in-steps'.
3475 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3481 Normal means no org-mode-specific context."
3485 ;;; Functions and variables from their packages
3486 ;; Declared here to avoid compiler warnings
3488 ;; XEmacs only
3494 ;; Emacs only
3497 ;; Various packages
3515 org-format-agenda-item "org-agenda"
3542 ;;; Autoload and prepare some org modules
3544 ;; Some table stuff that needs to be defined here, because it is used
3545 ;; by the functions setting up org-mode or checking for table context.
3558 "Detect the first line outside a table when searching from within it.
3561 ;; Autoload the functions in org-table.el that are needed by functions here.
3566 org-table-convert org-table-convert-region org-table-copy-down
3567 org-table-copy-region org-table-create
3568 org-table-create-or-convert-from-region
3569 org-table-create-with-table.el org-table-current-dline
3570 org-table-cut-region org-table-delete-column org-table-edit-field
3571 org-table-edit-formulas org-table-end org-table-eval-formula
3572 org-table-export org-table-field-info
3573 org-table-get-stored-formulas org-table-goto-column
3574 org-table-hline-and-move org-table-import org-table-insert-column
3575 org-table-insert-hline org-table-insert-row org-table-iterate
3576 org-table-justify-field-maybe org-table-kill-row
3577 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3578 org-table-move-column org-table-move-column-left
3579 org-table-move-column-right org-table-move-row
3580 org-table-move-row-down org-table-move-row-up
3581 org-table-next-field org-table-next-row org-table-paste-rectangle
3582 org-table-previous-field org-table-recalculate
3583 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3584 org-table-toggle-coordinate-overlays
3585 org-table-toggle-formula-debugger org-table-wrap-region
3586 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3587 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3588 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3591 "Return t if the cursor is inside an org-type table.
3592 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3597 org-table-line-regexp)))
3598 nil))
3602 "Return t if and only if we are at a table.el table."
3608 "If there is a table.el table nearby, recognize it and move into it."
3614 nil
3624 t
3629 t)
3630 nil)
3631 nil))
3634 "Return t if the cursor is inside a hline in a table."
3639 nil))
3644 "Apply FUNCTION to the start of all tables in the buffer."
3660 ;; Declare and autoload functions from org-exp.el & Co
3668 org-insert-export-options-template
3669 org-table-clean-before-export))
3672 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3673 org-export-region-as-ascii))
3676 org-replace-region-by-latex org-export-region-as-latex
3677 org-export-as-latex org-export-as-pdf
3678 org-export-as-pdf-and-open))
3681 org-export-as-html-batch org-export-as-html-to-buffer
3682 org-replace-region-by-html org-export-region-as-html
3683 org-export-as-html))
3686 org-replace-region-by-docbook org-export-region-as-docbook
3687 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3688 org-export-as-docbook))
3691 org-export-icalendar-all-agenda-files
3692 org-export-icalendar-combine-agenda-files))
3696 ;; Declare and autoload functions from org-agenda.el
3701 org-todo-list org-tags-view org-agenda-list-stuck-projects
3702 org-diary org-agenda-to-appt
3703 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3705 ;; Autoload org-remember
3710 org-remember-apply-template org-remember org-remember-handler)))
3715 org-capture-import-remember-templates)))
3717 ;; Autoload org-clock.el
3733 "Return non-nil if clock is currently running.
3734 The return value is actually the clock marker."
3739 "org-clock"
3741 org-clock-goto org-clock-sum org-clock-display
3742 org-clock-remove-overlays org-clock-report
3743 org-clocktable-shift org-dblock-write:clocktable
3744 org-get-clocktable org-resolve-clocks)))
3747 "If this is a CLOCK line, update it and return t.
3748 Otherwise, return nil."
3757 ts te h m s neg)
3760 nil)
3765 ;; The clock is running here
3786 t))))))
3789 "Check if the current buffer contains the running clock.
3790 If yes, offer to stop it and to save the buffer with the changes."
3799 "Check if this line starts a clock table, if yes, shift the time block."
3803 ;; Autoload org-timer.el
3807 "org-timer"
3809 org-timer-change-times-in-region
3810 org-timer-set-timer
3811 org-timer-reset-timers
3812 org-timer-show-remaining-time)))
3814 ;; Autoload org-feed.el
3818 "org-feed"
3822 ;; Autoload org-indent.el
3824 ;; Define the variable already here, to make sure we have it.
3826 "Non-nil if Org-Indent mode is enabled.
3831 "org-indent"
3834 ;; Autoload org-mobile.el
3838 "org-mobile"
3841 ;; Autoload archiving code
3842 ;; The stuff that is needed for cycling and tags has to be defined here.
3845 "Options concerning archiving in Org-mode."
3850 "The location where subtrees should be archived.
3852 The value of this variable is a string, consisting of two parts,
3853 separated by a double-colon. The first part is a filename and
3854 the second part is a headline.
3856 When the filename is omitted, archiving happens in the same file.
3857 %s in the filename will be replaced by the current file
3858 name (without the directory part). Archiving to a different file
3859 is useful to keep archived entries from contributing to the
3860 Org-mode Agenda.
3862 The archived entries will be filed as subtrees of the specified
3863 headline. When the headline is omitted, the subtrees are simply
3864 filed away at the end of the file, as top-level entries. Also in
3865 the heading you can use %s to represent the file name, this can be
3866 useful when using the same archive for a number of different files.
3868 Here are a few examples:
3870 If the current file is Projects.org, archive in file
3871 Projects.org_archive, as top-level trees. This is the default.
3874 Archive in the current file, under the top-level headline
3878 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3881 Archive in file ~/org/archive.org (absolute path), under headlines
3885 Archive in file ./basement (relative path), as level 3 trees
3888 You may set this option on a per-file basis by adding to the buffer a
3889 line like
3891 #+ARCHIVE: basement::** Finished Tasks
3893 You may also define it locally for a subtree by setting an ARCHIVE property
3894 in the entry. If such a property is found in an entry, or anywhere up
3895 the hierarchy, it will be used."
3900 "The tag that marks a subtree as archived.
3901 An archived subtree does not open during visibility cycling, and does
3902 not contribute to the agenda listings.
3903 After changing this, font-lock must be restarted in the relevant buffers to
3904 get the proper fontification."
3910 "Non-nil means the agenda will skip any items located in archived trees.
3911 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3912 variable is no longer recommended, you should leave it at the value t.
3913 Instead, use the key `v' to cycle the archives-mode in the agenda."
3919 "Non-nil means ignore archived trees when creating column view."
3925 "Non-nil means `org-cycle' will open archived trees.
3926 An archived tree is a tree marked with the tag ARCHIVE.
3927 When nil, archived trees will stay folded. You can still open them with
3928 normal outline commands like `show-all', but not with the cycling commands."
3934 "Non-nil means sparse tree construction shows matches in archived trees.
3935 When nil, matches in these trees are highlighted, but the trees are kept in
3936 collapsed state."
3942 "Re-hide all archived subtrees after a visibility state change."
3953 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3956 "Cycle subtree even if it is archived."
3963 "Re-hide all archived subtrees after a visibility state change."
3978 flag)))
3985 org-archive-to-archive-sibling org-toggle-archive-tag
3986 org-archive-subtree-default
3987 org-archive-subtree-default-with-confirmation)))
3989 ;; Autoload Column View Code
3997 org-columns-compute org-agenda-columns org-columns-remove-overlays
4000 ;; Autoload ID code
4008 org-id-get-with-outline-path-completion
4009 org-id-get-with-outline-drilling org-id-store-link
4010 org-id-goto org-id-find org-id-store-link))
4012 ;; Autoload Plotting Code
4017 ;;; Variables for pre-computed regular expressions, all buffer local
4035 "Matches a headline and puts everything into groups:
4036 group 1: the stars
4037 group 2: The todo keyword, maybe
4038 group 3: Priority cookie
4039 group 4: True headline
4043 "Printf format to make regexp to match an exact headline.
4044 This regexp will match the headline of any node which hase the exact
4045 headline text that is put into the format, but may have any TODO state,
4049 "Matches a headline and puts TODO state into group 2 if present.
4104 "Regular expression to match a plain time or time range.
4105 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4106 groups carry important information:
4107 0 the full match
4108 1 the first time, range or not
4116 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4117 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4118 groups carry important information:
4119 0 the full match
4120 7 hours of duration
4129 "Regular expression to match a timestamp time or time range.
4130 After a match, the following groups carry important information:
4131 0 the full match
4132 1 date plus weekday, for back referencing to make sure both times are on the same day
4133 2 the first time, range or not
4186 "Variable associated with STARTUP options for org-mode.
4187 Each element is a list of three items: The startup options as written
4188 in the #+STARTUP line, the corresponding variable, and the value to
4189 set this variable to if the option is found. An optional forth element PUSH
4193 "Precompute regular expressions for current buffer."
4213 kwds kws0 kwsa key log value cat arch tags const links hw dws
4214 tail sep kws1 prio props ftags drawers beamer-p
4236 ;; general TODO-like setup
4248 links)))
4254 props)))
4259 ftags
4269 l var val)
4299 ))))
4316 ;; Process the TODO keywords
4318 ;; Use the global values as if they had been given locally.
4330 kws)))
4333 kwsa nil
4336 ;; 1 2
4344 kw)
4346 kws0)
4363 ;; Process the constants
4371 ;; Process the tags.
4382 tgs))
4390 ;; Compute the regular expressions and other local variables
4398 org-drawer-regexp
4402 org-not-done-keywords
4404 org-todo-regexp
4407 org-not-done-regexp
4411 org-not-done-heading-regexp
4415 org-todo-line-regexp
4419 org-complex-heading-regexp
4424 org-complex-heading-regexp-format
4433 org-nl-done-regexp
4437 org-todo-line-tags-regexp
4442 org-looking-at-done-regexp
4447 org-deadline-time-regexp
4449 org-deadline-line-regexp
4451 org-scheduled-regexp
4453 org-scheduled-time-regexp
4455 org-closed-time-regexp
4457 org-keyword-time-regexp
4463 org-keyword-time-not-clock-regexp
4469 org-maybe-keyword-time-regexp
4475 org-planning-or-clock-line-re
4480 org-all-time-keywords
4483 org-clock-string org-closed-string))
4484 )
4489 "Return the contents of FILE, as a string."
4503 "Extract the log state setting from a TODO keyword string.
4517 "Remove a pair of parenthesis at the end of each string in LIST."
4521 x))
4522 list))
4525 "Assign fast keys to a keyword-key alist.
4526 Respect keys that are already there."
4544 ;;; Some variables used in various places
4551 "Function to be called when `C-c C-c' is used.
4555 ;; FIXME: Occasionally check by commenting these, to make sure
4556 ;; no other functions uses these, forgetting to let-bind them.
4561 ;; Defined somewhere in this file, but used before definition.
4567 ;;;; Define the Org-mode
4570 (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"))
4573 ;; We use a before-change function to check if a table might need
4574 ;; an update.
4576 "Indicates that a table might need an update.
4577 This variable is set by `org-before-change-function'.
4580 "Every change indicates that a table might need an update."
4591 ;;;###autoload
4593 "Outline-based notes management and organizer, alias
4596 Org-mode develops organizational tasks around a NOTES file which
4597 contains information about projects as plain text. Org-mode is
4598 implemented on top of outline-mode, which is ideal to keep the content
4599 of large files well structured. It supports ToDo items, deadlines and
4600 time stamps, which magically appear in the diary listing of the Emacs
4601 calendar. Tables are easily created with a built-in table editor.
4602 Plain text URL-like links connect to websites, emails (VM), Usenet
4603 messages (Gnus), BBDB entries, and any files related to the project.
4604 For printing and sharing of notes, an Org-mode file (or a part of it)
4605 can be exported as a structured ASCII or HTML file.
4607 The following commands are available:
4611 ;; Get rid of Outline menus, they are not needed
4612 ;; Need to do this here because define-derived-mode sets up
4613 ;; the keymap so late. Still, it is a waste to call this each time
4614 ;; we switch another buffer into org-mode.
4617 ;; Assume this is Greg's port, it uses easymenu
4642 org-display-table 4
4645 org-ellipsis)))
4650 ;; tag faces set outside customize.... force initialization.
4652 ;; Calc embedded
4658 ;; Activate before-change-function
4662 ;; Check for running clock before killing a buffer
4664 ;; Paragraphs and auto-filling
4668 ;; Beginning/end of defun
4671 ;; Make sure dependence stuff works reliably, even for users who set it
4672 ;; too late :-(
4684 ;; Comment characters
4688 ;; Align options lines
4690 'align-mode-rules-list
4695 ;; Imenu
4699 ;; Make isearch reveal context
4702 ;; Emacs 21 and XEmacs make use of the hook
4704 ;; Emacs 22 deals with this through a special variable
4708 ;; Turn on org-beamer-mode?
4711 ;; If empty file that did not turn on org-mode automatically, make it to.
4734 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4743 ;;;; Font-Lock stuff, including the activators
4774 "Regular expression used to analyze links.
4775 Here is what the match groups contain after a match:
4776 1: http:
4777 2: http
4778 3: path
4779 4: [desc]
4787 "Number of stacked braces for sub/superscript matching.
4788 This has to be set before loading org.el to be effective."
4793 "Create a regular expression which will match a balanced sexp.
4794 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4795 as single character strings.
4796 The regexp returned will match the entire expression including the
4797 delimiters. It will also define a single group which contains the
4798 match except for the outermost delimiters. The maximum depth of
4799 stacked delimiters is N. Escaping delimiters is not possible."
4828 "Update the link regular expressions.
4829 This should be called after the variable `org-link-types' has changed."
4833 org-link-re-with-space
4839 org-link-re-with-space2
4845 org-link-re-with-space3
4850 org-angle-link-re
4856 org-plain-link-re
4860 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4861 org-bracket-link-regexp
4863 org-bracket-link-analytic-regexp
4871 org-bracket-link-analytic-regexp++
4879 org-any-link-re
4890 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4891 "Regular expression matching time strings for analysis.
4892 This one does not require the space after the date, so it can be used
4894 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4910 "Regular expression matching a time stamp or time stamp range.
4916 "Run through the buffer and add overlays to links."
4925 'face
4938 rtn))
4941 "Insert or change an emphasis, i.e. a font like bold or italic.
4942 If there is an active region, change that region to a new emphasis.
4943 If there is no region, just insert the marker characters and position
4944 the cursor between them.
4945 CHAR should be either the marker character, or the first character of the
4946 HTML tag associated with that emphasis. If CHAR is a space, the means
4947 to remove the emphasis of the selected region.
4948 If char is not given (for example in an interactive call) it
4949 will be prompted for."
5000 "Run through the buffer and add overlays to links."
5009 nil
5015 t)))))
5023 t)))
5026 "When non-nil, fontify code in code blocks."
5032 "Fontify #+ lines and blocks, in the correct ways."
5035 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5036 limit t)
5044 end end1 quoting block-type)
5047 ;; a single line of backend-specific content
5055 ; for backend-specific code
5056 t)
5058 ;; Truly a block
5070 beg end
5074 ; for end_src
5080 org-block)))
5081 ; end of source block
5087 t))
5100 ;; just any other in-buffer setting, but not indented
5104 t)
5112 t)
5120 "Run through the buffer and add overlays to links."
5128 t)))
5131 "Run through the buffer and add overlays to links."
5133 limit t)
5138 'keymap org-mouse-map
5139 'help-echo
5141 "Footnote definition"
5143 ))
5145 t)))
5148 "Run through the buffer and add overlays to bracketed links."
5152 ;; FIXME: above we should remove the escapes.
5153 ;; but that requires another match, protecting match data,
5154 ;; a lot of overhead for font-lock.
5161 ;; We need to remove the invisible property here. Table narrowing
5162 ;; may have made some of this invisible.
5180 t)))
5183 "Run through the buffer and add overlays to dates."
5195 t)))
5204 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5208 "Run through the buffer and add overlays to target matches."
5216 'keymap org-mouse-map
5220 t)))))
5223 "Find all radio targets in this file and update the regular expression."
5238 t)))
5245 ;; This should be with the exporter code, but we also use if for font-locking
5255 "Compute regular expression for stuff treated specially by exporters."
5262 org-latex-regexps)))
5290 org-entities)))
5294 org-latex-entities)
5295 nil))
5297 ))
5298 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5301 org-export-html-special-string-regexps)))
5306 ))))
5308 'org-latex-and-specials-regexp
5313 "Run through the buffer and add overlays to links."
5317 limit t))
5331 rtn)))
5334 "Restart `font-lock-mode', to force refontification."
5340 "Return a list of all targets in this file.
5341 With optional argument RADIO, only find radio targets."
5343 rtn)
5348 rtn)))
5351 "Make regular expression matching all strings in TARGETS.
5352 The regular expression finds the targets also if there is a line break
5353 between words."
5361 x)
5362 targets
5374 t)))
5377 "Compute the outline level of the heading at point.
5378 This function assumes that the cursor is at the beginning of a line matched
5379 by `outline-regexp'. Otherwise it returns garbage.
5380 If this is called at a normal headline, the level is the number of stars.
5381 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5382 For plain list items, if they are matched by `outline-regexp', this returns
5383 1000 plus the line indentation."
5392 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5399 "Functions that can manipulate `org-font-lock-extra-keywords'.
5400 This is calles after `org-font-lock-extra-keywords' is defined, but before
5401 it is installed to be used by font lock. This can be useful if something
5412 ;; Call the hook
5414 ;; Headlines
5421 ;; Table lines
5424 ;; Table internals
5429 ;; Drawers
5432 ;; Properties
5436 ;; Links
5447 ;; TODO lines
5450 ;; DONE
5456 nil)
5457 ;; Priorities
5459 ;; Tags
5461 ;; Special keywords
5466 ;; Emphasis
5471 ;; Checkboxes
5472 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5477 ;; Description list items
5480 ;; ARCHIVEd headings
5483 ;; Specials
5487 ;; Code
5489 ;; COMMENT
5494 ;; Blocks and meta lines
5496 )))
5499 ;; Now set the full font-lock-keywords
5506 "Toggle the composition display of entities as UTF8 characters."
5518 "Find an entity to fontify."
5524 limit t)
5536 nil))))
5539 "Fontify string S like in Org-mode."
5551 "Get the right face for match N in font-lock matching of headlines."
5561 "Get the right face for a TODO keyword KWD.
5562 If KWD is a number, get the corresponding match group."
5570 "Create a face list that inherits INHERIT, but sets the foreground color.
5571 When FACE-OR-COLOR is not a string, just return it."
5575 face-or-color)
5576 face-or-color))
5579 "Add the special tag faces."
5588 "Add the special priority faces."
5595 org-priority-faces)))
5600 "Get the right face for a TODO keyword KWD.
5601 If KWD is a number, get the corresponding match group."
5608 "Remove fontification and activation overlays from links."
5613 deactivate-mark buffer-file-name buffer-file-truename)
5616 beg end
5618 ;; also remove line-prefix and wrap-prefix properties
5620 invisible t intangible t
5621 line-prefix t wrap-prefix t
5622 org-no-flyspell t org-emphasis t)
5624 invisible t intangible t
5625 org-no-flyspell t org-emphasis t)))
5635 "Remove specific display properties that have been added by font lock.
5636 The will remove the raise properties that are used to show superscripts
5637 and subscripts."
5647 "Add raise properties to sub/superscripts."
5651 org-match-substring-regexp
5652 org-match-substring-with-braces-regexp)
5653 limit t)
5663 ;; FIXME: Should we go back one character here, for a_b^c
5664 ;; (goto-char (1- pos)) ;????????????????????
5666 t
5668 'display
5684 t)))))
5686 ;;;; Visibility cycling, including org-goto and indirect buffer
5688 ;;; Cycling
5695 ;;;###autoload
5700 "TAB-action and visibility cycling for Org-mode.
5702 This is the command invoked in Org-mode by the TAB key. Its main purpose
5703 is outline visibility cycling, but it also invokes other actions
5704 in special contexts.
5706 - When this function is called with a prefix argument, rotate the entire
5707 buffer through 3 states (global cycling)
5708 1. OVERVIEW: Show only top-level headlines.
5709 2. CONTENTS: Show all headlines of all levels, but no body text.
5710 3. SHOW ALL: Show everything.
5711 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5712 determined by the variable `org-startup-folded', and by any VISIBILITY
5713 properties in the buffer.
5714 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5715 including any drawers.
5717 - When inside a table, re-align the table and move to the next field.
5719 - When point is at the beginning of a headline, rotate the subtree started
5720 by this line through 3 different states (local cycling)
5721 1. FOLDED: Only the main headline is shown.
5722 2. CHILDREN: The main headline and the direct children are shown.
5723 From this state, you can move to one of the children
5724 and zoom in further.
5725 3. SUBTREE: Show the entire subtree, including body text.
5726 If there is no subtree, switch directly from CHILDREN to FOLDED.
5728 - When point is at the beginning of an empty headline and the variable
5729 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5730 of the headline by demoting and promoting it to likely levels. This
5731 speeds up creation document structure by pressing TAB once or several
5732 times right after creating a new headline.
5734 - When there is a numeric prefix, go up to a heading with level ARG, do
5735 a `show-subtree' and return to the previous cursor position. If ARG
5736 is negative, go up that many levels.
5738 - When point is not at the beginning of a headline, execute the global
5739 binding for TAB, which is re-indenting the line. See the option
5740 `org-cycle-emulate-tab' for details.
5742 - Special case: if point is at the beginning of the buffer and there is
5743 no headline in line 1, this function will act as if called with prefix arg.
5744 But only if also the variable `org-cycle-global-at-bob' is t."
5754 org-inlinetask-min-level
5759 limit-level)))
5775 org-cycle-hook))
5779 ;; special case: use global cycling
5793 ;; Enter the table or move to the next field in the table
5810 ;; Toggle block visibility
5815 ;; Show-subtree, ARG levels up from here.
5827 ;; TAB emulation and template completion
5851 t
5860 "Do the global cycling action."
5864 ;; We just created the overview - now do table of contents
5865 ;; This can be slow in very large buffers, so indicate action
5875 ;; We just showed the table of contents - now show everything
5883 ;; Default action: go to overview
5891 "Do the local cycling action."
5893 ;; First, some boundaries
5900 ; XEmacs does not have `next-single-char-property-change'
5901 ; I'm not sure about Emacs 21.
5915 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5924 ;; Find out what to do next and set `this-command'
5927 ;; Nothing is hidden behind this heading
5939 org-cycle-skip-children-state-if-no-children))))
5940 ;; Entire subtree is hidden in one line: children view
5954 ;; We just showed the children, or no children are there,
5955 ;; now show everything.
5962 ;; Default action: hide the subtree.
5969 ;;;###autoload
5971 "Cycle the global visibility. For details see `org-cycle'.
5973 With a numeric prefix, show all headlines up to that level."
5989 "Set the visibility required by startup options and properties."
6004 "Switch subtree visibilities according to :VISIBILITY: property."
6011 nil t)
6036 "Switch to overview mode, showing only top-level headlines.
6037 Really, this shows all headlines with level equal or greater than the level
6038 of the first headline in the buffer. This is important, because if the
6039 first headline is not level one, then (hide-sublevels 1) gives confusing
6040 results."
6051 "Show all headlines in the buffer, like a table of contents.
6052 With numerical argument N, show content up to level N."
6055 ;; Visit all headings and show their offspring
6062 t)
6071 "Adjust the window after a change in outline visibility.
6072 This function is the default value of the hook `org-cycle-hook'."
6082 "Remove outline overlays that do not contain non-white stuff."
6092 "Fix visibility issues after moving a subtree."
6093 ;; First, find a reasonable region to look at:
6094 ;; Start two siblings above, end three below
6112 ;; Properly fold already folded siblings
6123 "Show empty lines above all visible headlines.
6124 The region to be covered depends on STATE when called through
6125 `org-cycle-hook'. Lisp program can use t for STATE to get the
6126 entire buffer covered. Note that an empty line is only shown if there
6127 are at least `org-cycle-separator-lines' empty lines before the headline."
6137 beg end b e)
6161 ;; Never hide empty lines at the end of the file.
6171 "Move to the parent and re-show empty lines before visible headlines."
6177 "Return `org-agenda-files' list, plus all open org-mode files.
6178 This is useful for operations that need to scan all of a user's
6179 open and agenda-wise Org files."
6187 files))
6190 "Return the beginning position of the current entry."
6194 "Return the end position of the current entry."
6198 "Re-hide all drawers after a visibility state change."
6225 "Is the end of the current subtree visible?"
6230 "Move cursor to the first headline and recenter the headline.
6231 Optional argument N means put the headline into the Nth line of the window."
6237 ;;; Saving and restoring visibility
6240 "Return a list of the locations of all outline overlays.
6241 These are overlays with the `invisible' property value `outline'.
6242 The return value is a list of cons cells, with start and stop
6243 positions for each overlay.
6244 If USE-MARKERS is set, return the positions as markers."
6262 "Create visibility overlays for all positions in DATA.
6263 DATA should have been made by `org-outline-overlay-data'."
6272 data)))))
6274 ;;; Folding of blocks
6286 "Call FUNCTION at the head of all source blocks in the current buffer.
6287 Optional arguments START and END can be used to limit the range."
6299 "Toggle the visibility of all blocks in the current buffer."
6303 "Fold all blocks in the current buffer."
6309 "Unfold all blocks in the current buffer."
6315 "Toggle visibility of block at point."
6326 "Toggle the visibility of the current block."
6333 ov)
6349 ;; make the block accessible to isearch
6351 ov 'isearch-open-invisible
6362 ;; org-tab-after-check-for-cycling-hook
6364 ;; Remove overlays when changing major mode
6369 ;;; Org-goto
6375 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6391 nil)
6392 (org-defkey map "q" 'org-goto-quit)
6393 (org-defkey map "n" 'outline-next-visible-heading)
6394 (org-defkey map "p" 'outline-previous-visible-heading)
6395 (org-defkey map "f" 'outline-forward-same-level)
6396 (org-defkey map "b" 'outline-backward-same-level)
6397 (org-defkey map "u" 'outline-up-heading))
6398 (org-defkey map "/" 'org-occur)
6399 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6400 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6401 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6402 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6403 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6404 map))
6406 (defconst org-goto-help
6407 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6408 RET=jump to location [Q]uit and return to previous location
6409 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6411 (defvar org-goto-start-pos) ; dynamically scoped parameter
6413 ;; FIXME: Docstring does not mention both interfaces
6414 (defun org-goto (&optional alternative-interface)
6415 "Look up a different location in the current file, keeping current visibility.
6417 When you want look-up or go to a different location in a document, the
6418 fastest way is often to fold the entire buffer and then dive into the tree.
6419 This method has the disadvantage, that the previous location will be folded,
6420 which may not be what you want.
6422 This command works around this by showing a copy of the current buffer
6423 in an indirect buffer, in overview mode. You can dive into the tree in
6424 that copy, use org-occur and incremental search to find a location.
6425 When pressing RET or `Q', the command returns to the original buffer in
6426 which the visibility is still unchanged. After RET is will also jump to
6427 the location selected in the indirect buffer and expose the
6428 the headline hierarchy above."
6429 (interactive "P")
6430 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6431 (org-refile-use-outline-path t)
6432 (org-refile-target-verify-function nil)
6433 (interface
6434 (if (not alternative-interface)
6435 org-goto-interface
6436 (if (eq org-goto-interface 'outline)
6437 'outline-path-completion
6438 'outline)))
6439 (org-goto-start-pos (point))
6440 (selected-point
6441 (if (eq interface 'outline)
6442 (car (org-get-location (current-buffer) org-goto-help))
6443 (let ((pa (org-refile-get-location "Goto: ")))
6444 (org-refile-check-position pa)
6445 (nth 3 pa)))))
6446 (if selected-point
6447 (progn
6448 (org-mark-ring-push org-goto-start-pos)
6449 (goto-char selected-point)
6450 (if (or (org-invisible-p) (org-invisible-p2))
6451 (org-show-context 'org-goto)))
6452 (message "Quit"))))
6454 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6455 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6456 (defvar org-goto-local-auto-isearch-map) ; defined below
6458 (defun org-get-location (buf help)
6459 "Let the user select a location in the Org-mode buffer BUF.
6460 This function uses a recursive edit. It returns the selected position
6461 or nil."
6462 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6463 (isearch-hide-immediately nil)
6464 (isearch-search-fun-function
6465 (lambda () 'org-goto-local-search-headings))
6466 (org-goto-selected-point org-goto-exit-command)
6467 (pop-up-frames nil)
6468 (special-display-buffer-names nil)
6469 (special-display-regexps nil)
6470 (special-display-function nil))
6471 (save-excursion
6472 (save-window-excursion
6473 (delete-other-windows)
6474 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6475 (switch-to-buffer
6476 (condition-case nil
6477 (make-indirect-buffer (current-buffer) "*org-goto*")
6478 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6479 (with-output-to-temp-buffer "*Help*"
6480 (princ help))
6481 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6482 (setq buffer-read-only nil)
6483 (let ((org-startup-truncated t)
6484 (org-startup-folded nil)
6485 (org-startup-align-all-tables nil))
6486 (org-mode)
6487 (org-overview))
6488 (setq buffer-read-only t)
6489 (if (and (boundp 'org-goto-start-pos)
6490 (integer-or-marker-p org-goto-start-pos))
6491 (let ((org-show-hierarchy-above t)
6492 (org-show-siblings t)
6493 (org-show-following-heading t))
6494 (goto-char org-goto-start-pos)
6495 (and (org-invisible-p) (org-show-context)))
6496 (goto-char (point-min)))
6497 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6498 (message "Select location and press RET")
6499 (use-local-map org-goto-map)
6500 (recursive-edit)
6501 ))
6502 (kill-buffer "*org-goto*")
6503 (cons org-goto-selected-point org-goto-exit-command)))
6505 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6506 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6507 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6508 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6510 (defun org-goto-local-search-headings (string bound noerror)
6511 "Search and make sure that any matches are in headlines."
6512 (catch 'return
6513 (while (if isearch-forward
6514 (search-forward string bound noerror)
6515 (search-backward string bound noerror))
6516 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6517 (and (member :headline context)
6518 (not (member :tags context))))
6519 (throw 'return (point))))))
6521 (defun org-goto-local-auto-isearch ()
6522 "Start isearch."
6523 (interactive)
6524 (goto-char (point-min))
6525 (let ((keys (this-command-keys)))
6526 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6527 (isearch-mode t)
6528 (isearch-process-search-char (string-to-char keys)))))
6530 (defun org-goto-ret (&optional arg)
6531 "Finish `org-goto' by going to the new location."
6532 (interactive "P")
6533 (setq org-goto-selected-point (point)
6534 org-goto-exit-command 'return)
6535 (throw 'exit nil))
6537 (defun org-goto-left ()
6538 "Finish `org-goto' by going to the new location."
6539 (interactive)
6540 (if (org-on-heading-p)
6541 (progn
6542 (beginning-of-line 1)
6543 (setq org-goto-selected-point (point)
6544 org-goto-exit-command 'left)
6545 (throw 'exit nil))
6546 (error "Not on a heading")))
6548 (defun org-goto-right ()
6549 "Finish `org-goto' by going to the new location."
6550 (interactive)
6551 (if (org-on-heading-p)
6552 (progn
6553 (setq org-goto-selected-point (point)
6554 org-goto-exit-command 'right)
6555 (throw 'exit nil))
6556 (error "Not on a heading")))
6558 (defun org-goto-quit ()
6559 "Finish `org-goto' without cursor motion."
6560 (interactive)
6561 (setq org-goto-selected-point nil)
6562 (setq org-goto-exit-command 'quit)
6563 (throw 'exit nil))
6565 ;;; Indirect buffer display of subtrees
6567 (defvar org-indirect-dedicated-frame nil
6568 "This is the frame being used for indirect tree display.")
6569 (defvar org-last-indirect-buffer nil)
6571 (defun org-tree-to-indirect-buffer (&optional arg)
6572 "Create indirect buffer and narrow it to current subtree.
6573 With numerical prefix ARG, go up to this level and then take that tree.
6574 If ARG is negative, go up that many levels.
6575 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6576 indirect buffer previously made with this command, to avoid proliferation of
6577 indirect buffers. However, when you call the command with a \
6579 when `org-indirect-buffer-display' is `new-frame', the last buffer
6580 is kept so that you can work with several indirect buffers at the same time.
6581 If `org-indirect-buffer-display' is `dedicated-frame', the \
6583 requests that a new frame be made for the new buffer, so that the dedicated
6584 frame is not changed."
6585 (interactive "P")
6586 (let ((cbuf (current-buffer))
6587 (cwin (selected-window))
6588 (pos (point))
6589 beg end level heading ibuf)
6590 (save-excursion
6591 (org-back-to-heading t)
6592 (when (numberp arg)
6593 (setq level (org-outline-level))
6594 (if (< arg 0) (setq arg (+ level arg)))
6595 (while (> (setq level (org-outline-level)) arg)
6596 (outline-up-heading 1 t)))
6597 (setq beg (point)
6598 heading (org-get-heading))
6599 (org-end-of-subtree t t)
6600 (if (org-on-heading-p) (backward-char 1))
6601 (setq end (point)))
6602 (if (and (buffer-live-p org-last-indirect-buffer)
6603 (not (eq org-indirect-buffer-display 'new-frame))
6604 (not arg))
6605 (kill-buffer org-last-indirect-buffer))
6606 (setq ibuf (org-get-indirect-buffer cbuf)
6607 org-last-indirect-buffer ibuf)
6608 (cond
6609 ((or (eq org-indirect-buffer-display 'new-frame)
6610 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6611 (select-frame (make-frame))
6612 (delete-other-windows)
6613 (switch-to-buffer ibuf)
6614 (org-set-frame-title heading))
6615 ((eq org-indirect-buffer-display 'dedicated-frame)
6616 (raise-frame
6617 (select-frame (or (and org-indirect-dedicated-frame
6618 (frame-live-p org-indirect-dedicated-frame)
6619 org-indirect-dedicated-frame)
6620 (setq org-indirect-dedicated-frame (make-frame)))))
6621 (delete-other-windows)
6622 (switch-to-buffer ibuf)
6623 (org-set-frame-title (concat "Indirect: " heading)))
6624 ((eq org-indirect-buffer-display 'current-window)
6625 (switch-to-buffer ibuf))
6626 ((eq org-indirect-buffer-display 'other-window)
6627 (pop-to-buffer ibuf))
6628 (t (error "Invalid value")))
6629 (if (featurep 'xemacs)
6630 (save-excursion (org-mode) (turn-on-font-lock)))
6631 (narrow-to-region beg end)
6632 (show-all)
6633 (goto-char pos)
6634 (and (window-live-p cwin) (select-window cwin))))
6636 (defun org-get-indirect-buffer (&optional buffer)
6637 (setq buffer (or buffer (current-buffer)))
6638 (let ((n 1) (base (buffer-name buffer)) bname)
6639 (while (buffer-live-p
6640 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6641 (setq n (1+ n)))
6642 (condition-case nil
6643 (make-indirect-buffer buffer bname 'clone)
6644 (error (make-indirect-buffer buffer bname)))))
6646 (defun org-set-frame-title (title)
6647 "Set the title of the current frame to the string TITLE."
6648 ;; FIXME: how to name a single frame in XEmacs???
6649 (unless (featurep 'xemacs)
6650 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6652 ;;;; Structure editing
6654 ;;; Inserting headlines
6656 (defun org-previous-line-empty-p ()
6657 (save-excursion
6658 (and (not (bobp))
6659 (or (beginning-of-line 0) t)
6660 (save-match-data
6663 (defun org-insert-heading (&optional force-heading invisible-ok)
6664 "Insert a new heading or item with same depth at point.
6665 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6666 If point is at the beginning of a headline, insert a sibling before the
6667 current headline. If point is not at the beginning, do not split the line,
6668 but create the new headline after the current line.
6669 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6670 This is important for non-interactive uses of the command."
6671 (interactive "P")
6672 (if (or (= (buffer-size) 0)
6673 (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
6674 (org-on-heading-p))))
6675 (not (org-in-item-p))))
6677 (when (or force-heading (not (org-insert-item)))
6678 (let* ((empty-line-p nil)
6679 (head (save-excursion
6680 (condition-case nil
6681 (progn
6682 (org-back-to-heading invisible-ok)
6683 (setq empty-line-p (org-previous-line-empty-p))
6684 (match-string 0))
6685 (error "*"))))
6686 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6687 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6688 pos hide-previous previous-pos)
6689 (cond
6690 ((and (org-on-heading-p) (bolp)
6691 (or (bobp)
6692 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6693 ;; insert before the current line
6694 (open-line (if blank 2 1)))
6695 ((and (bolp)
6696 (not org-insert-heading-respect-content)
6697 (or (bobp)
6698 (save-excursion
6699 (backward-char 1) (not (org-invisible-p)))))
6700 ;; insert right here
6701 nil)
6702 (t
6703 ;; somewhere in the line
6704 (save-excursion
6705 (setq previous-pos (point-at-bol))
6706 (end-of-line)
6707 (setq hide-previous (org-invisible-p)))
6708 (and org-insert-heading-respect-content (org-show-subtree))
6709 (let ((split
6710 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6711 (save-excursion
6712 (let ((p (point)))
6713 (goto-char (point-at-bol))
6714 (and (looking-at org-complex-heading-regexp)
6715 (> p (match-beginning 4)))))))
6716 tags pos)
6717 (cond
6718 (org-insert-heading-respect-content
6719 (org-end-of-subtree nil t)
6720 (or (bolp) (newline))
6721 (or (org-previous-line-empty-p)
6722 (and blank (newline)))
6723 (open-line 1))
6724 ((org-on-heading-p)
6725 (when hide-previous
6726 (show-children)
6727 (org-show-entry))
6729 (setq tags (and (match-end 2) (match-string 2)))
6730 (and (match-end 1)
6731 (delete-region (match-beginning 1) (match-end 1)))
6732 (setq pos (point-at-bol))
6733 (or split (end-of-line 1))
6734 (delete-horizontal-space)
6736 (buffer-substring (point-at-bol) (point)))
6737 (insert " "))
6738 (newline (if blank 2 1))
6739 (when tags
6740 (save-excursion
6741 (goto-char pos)
6742 (end-of-line 1)
6743 (insert " " tags)
6744 (org-set-tags nil 'align))))
6745 (t
6746 (or split (end-of-line 1))
6747 (newline (if blank 2 1)))))))
6748 (insert head) (just-one-space)
6749 (setq pos (point))
6750 (end-of-line 1)
6751 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6752 (when (and org-insert-heading-respect-content hide-previous)
6753 (save-excursion
6754 (goto-char previous-pos)
6755 (hide-subtree)))
6756 (run-hooks 'org-insert-heading-hook)))))
6758 (defun org-get-heading (&optional no-tags)
6759 "Return the heading of the current entry, without the stars."
6760 (save-excursion
6761 (org-back-to-heading t)
6762 (if (looking-at
6763 (if no-tags
6766 (match-string 1) "")))
6768 (defun org-heading-components ()
6769 "Return the components of the current heading.
6770 This is a list with the following elements:
6771 - the level as an integer
6772 - the reduced level, different if `org-odd-levels-only' is set.
6773 - the TODO keyword, or nil
6774 - the priority character, like ?A, or nil if no priority is given
6775 - the headline text itself, or the tags string if no headline text
6776 - the tags string, or nil."
6777 (save-excursion
6778 (org-back-to-heading t)
6779 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6780 (list (length (match-string 1))
6781 (org-reduced-level (length (match-string 1)))
6782 (org-match-string-no-properties 2)
6783 (and (match-end 3) (aref (match-string 3) 2))
6784 (org-match-string-no-properties 4)
6785 (org-match-string-no-properties 5)))))
6787 (defun org-get-entry ()
6788 "Get the entry text, after heading, entire subtree."
6789 (save-excursion
6790 (org-back-to-heading t)
6791 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6793 (defun org-insert-heading-after-current ()
6794 "Insert a new heading with same level as current, after current subtree."
6795 (interactive)
6796 (org-back-to-heading)
6797 (org-insert-heading)
6798 (org-move-subtree-down)
6799 (end-of-line 1))
6801 (defun org-insert-heading-respect-content ()
6802 (interactive)
6803 (let ((org-insert-heading-respect-content t))
6804 (org-insert-heading t)))
6806 (defun org-insert-todo-heading-respect-content (&optional force-state)
6807 (interactive "P")
6808 (let ((org-insert-heading-respect-content t))
6809 (org-insert-todo-heading force-state t)))
6811 (defun org-insert-todo-heading (arg &optional force-heading)
6812 "Insert a new heading with the same level and TODO state as current heading.
6813 If the heading has no TODO state, or if the state is DONE, use the first
6814 state (TODO by default). Also with prefix arg, force first state."
6815 (interactive "P")
6816 (when (or force-heading (not (org-insert-item 'checkbox)))
6817 (org-insert-heading force-heading)
6818 (save-excursion
6819 (org-back-to-heading)
6820 (outline-previous-heading)
6821 (looking-at org-todo-line-regexp))
6822 (let*
6823 ((new-mark-x
6824 (if (or arg
6825 (not (match-beginning 2))
6826 (member (match-string 2) org-done-keywords))
6827 (car org-todo-keywords-1)
6828 (match-string 2)))
6829 (new-mark
6830 (or
6831 (run-hook-with-args-until-success
6832 'org-todo-get-default-hook new-mark-x nil)
6833 new-mark-x)))
6834 (beginning-of-line 1)
6836 (if org-treat-insert-todo-heading-as-state-change
6837 (org-todo new-mark)
6838 (insert new-mark " "))))
6839 (when org-provide-todo-statistics
6840 (org-update-parent-todo-statistics))))
6842 (defun org-insert-subheading (arg)
6843 "Insert a new subheading and demote it.
6844 Works for outline headings and for plain lists alike."
6845 (interactive "P")
6846 (org-insert-heading arg)
6847 (cond
6848 ((org-on-heading-p) (org-do-demote))
6849 ((org-at-item-p) (org-indent-item))))
6851 (defun org-insert-todo-subheading (arg)
6852 "Insert a new subheading with TODO keyword or checkbox and demote it.
6853 Works for outline headings and for plain lists alike."
6854 (interactive "P")
6855 (org-insert-todo-heading arg)
6856 (cond
6857 ((org-on-heading-p) (org-do-demote))
6858 ((org-at-item-p) (org-indent-item))))
6860 ;;; Promotion and Demotion
6862 (defvar org-after-demote-entry-hook nil
6863 "Hook run after an entry has been demoted.
6864 The cursor will be at the beginning of the entry.
6865 When a subtree is being demoted, the hook will be called for each node.")
6867 (defvar org-after-promote-entry-hook nil
6868 "Hook run after an entry has been promoted.
6869 The cursor will be at the beginning of the entry.
6870 When a subtree is being promoted, the hook will be called for each node.")
6872 (defun org-promote-subtree ()
6873 "Promote the entire subtree.
6874 See also `org-promote'."
6875 (interactive)
6876 (save-excursion
6877 (org-map-tree 'org-promote))
6878 (org-fix-position-after-promote))
6880 (defun org-demote-subtree ()
6881 "Demote the entire subtree. See `org-demote'.
6882 See also `org-promote'."
6883 (interactive)
6884 (save-excursion
6885 (org-map-tree 'org-demote))
6886 (org-fix-position-after-promote))
6889 (defun org-do-promote ()
6890 "Promote the current heading higher up the tree.
6891 If the region is active in `transient-mark-mode', promote all headings
6892 in the region."
6893 (interactive)
6894 (save-excursion
6895 (if (org-region-active-p)
6896 (org-map-region 'org-promote (region-beginning) (region-end))
6897 (org-promote)))
6898 (org-fix-position-after-promote))
6900 (defun org-do-demote ()
6901 "Demote the current heading lower down the tree.
6902 If the region is active in `transient-mark-mode', demote all headings
6903 in the region."
6904 (interactive)
6905 (save-excursion
6906 (if (org-region-active-p)
6907 (org-map-region 'org-demote (region-beginning) (region-end))
6908 (org-demote)))
6909 (org-fix-position-after-promote))
6911 (defun org-fix-position-after-promote ()
6912 "Make sure that after pro/demotion cursor position is right."
6913 (let ((pos (point)))
6914 (when (save-excursion
6915 (beginning-of-line 1)
6916 (looking-at org-todo-line-regexp)
6917 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6918 (cond ((eobp) (insert " "))
6919 ((eolp) (insert " "))
6920 ((equal (char-after) ?\ ) (forward-char 1))))))
6922 (defun org-current-level ()
6923 "Return the level of the current entry, or nil if before the first headline.
6924 The level is the number of stars at the beginning of the headline."
6925 (save-excursion
6926 (condition-case nil
6927 (progn
6928 (org-back-to-heading t)
6929 (funcall outline-level))
6930 (error nil))))
6932 (defun org-get-previous-line-level ()
6933 "Return the outline depth of the last headline before the current line.
6934 Returns 0 for the first headline in the buffer, and nil if before the
6935 first headline."
6936 (let ((current-level (org-current-level))
6937 (prev-level (when (> (line-number-at-pos) 1)
6938 (save-excursion
6939 (beginning-of-line 0)
6940 (org-current-level)))))
6941 (cond ((null current-level) nil) ; Before first headline
6942 ((null prev-level) 0) ; At first headline
6943 (prev-level))))
6945 (defun org-reduced-level (l)
6946 "Compute the effective level of a heading.
6947 This takes into account the setting of `org-odd-levels-only'."
6948 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6950 (defun org-level-increment ()
6951 "Return the number of stars that will be added or removed at a
6952 time to headlines when structure editing, based on the value of
6953 `org-odd-levels-only'."
6954 (if org-odd-levels-only 2 1))
6956 (defun org-get-valid-level (level &optional change)
6957 "Rectify a level change under the influence of `org-odd-levels-only'
6958 LEVEL is a current level, CHANGE is by how much the level should be
6959 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6960 even level numbers will become the next higher odd number."
6961 (if org-odd-levels-only
6962 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6963 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6964 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6965 (max 1 (+ level (or change 0)))))
6967 (if (boundp 'define-obsolete-function-alias)
6968 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6969 (define-obsolete-function-alias 'org-get-legal-level
6970 'org-get-valid-level)
6971 (define-obsolete-function-alias 'org-get-legal-level
6972 'org-get-valid-level "23.1")))
6974 (defun org-promote ()
6975 "Promote the current heading higher up the tree.
6976 If the region is active in `transient-mark-mode', promote all headings
6977 in the region."
6978 (org-back-to-heading t)
6979 (let* ((level (save-match-data (funcall outline-level)))
6980 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6981 (diff (abs (- level (length up-head) -1))))
6982 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6983 (replace-match up-head nil t)
6984 ;; Fixup tag positioning
6985 (and org-auto-align-tags (org-set-tags nil t))
6986 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6987 (run-hooks 'org-after-promote-entry-hook)))
6989 (defun org-demote ()
6990 "Demote the current heading lower down the tree.
6991 If the region is active in `transient-mark-mode', demote all headings
6992 in the region."
6993 (org-back-to-heading t)
6994 (let* ((level (save-match-data (funcall outline-level)))
6995 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6996 (diff (abs (- level (length down-head) -1))))
6997 (replace-match down-head nil t)
6998 ;; Fixup tag positioning
6999 (and org-auto-align-tags (org-set-tags nil t))
7000 (if org-adapt-indentation (org-fixup-indentation diff))
7001 (run-hooks 'org-after-demote-entry-hook)))
7003 (defun org-cycle-level ()
7004 "Cycle the level of an empty headline through possible states.
7005 This goes first to child, then to parent, level, then up the hierarchy.
7006 After top level, it switches back to sibling level."
7007 (interactive)
7008 (let ((org-adapt-indentation nil))
7009 (when (org-point-at-end-of-empty-headline)
7010 (setq this-command 'org-cycle-level) ; Only needed for caching
7011 (let ((cur-level (org-current-level))
7012 (prev-level (org-get-previous-line-level)))
7013 (cond
7014 ;; If first headline in file, promote to top-level.
7015 ((= prev-level 0)
7016 (loop repeat (/ (- cur-level 1) (org-level-increment))
7017 do (org-do-promote)))
7018 ;; If same level as prev, demote one.
7019 ((= prev-level cur-level)
7020 (org-do-demote))
7021 ;; If parent is top-level, promote to top level if not already.
7022 ((= prev-level 1)
7023 (loop repeat (/ (- cur-level 1) (org-level-increment))
7024 do (org-do-promote)))
7025 ;; If top-level, return to prev-level.
7026 ((= cur-level 1)
7027 (loop repeat (/ (- prev-level 1) (org-level-increment))
7028 do (org-do-demote)))
7029 ;; If less than prev-level, promote one.
7030 ((< cur-level prev-level)
7031 (org-do-promote))
7032 ;; If deeper than prev-level, promote until higher than
7033 ;; prev-level.
7034 ((> cur-level prev-level)
7035 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7036 do (org-do-promote))))
7037 t))))
7039 (defun org-map-tree (fun)
7040 "Call FUN for every heading underneath the current one."
7041 (org-back-to-heading)
7042 (let ((level (funcall outline-level)))
7043 (save-excursion
7044 (funcall fun)
7045 (while (and (progn
7046 (outline-next-heading)
7047 (> (funcall outline-level) level))
7048 (not (eobp)))
7049 (funcall fun)))))
7051 (defun org-map-region (fun beg end)
7052 "Call FUN for every heading between BEG and END."
7053 (let ((org-ignore-region t))
7054 (save-excursion
7055 (setq end (copy-marker end))
7056 (goto-char beg)
7057 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7058 (< (point) end))
7059 (funcall fun))
7060 (while (and (progn
7061 (outline-next-heading)
7062 (< (point) end))
7063 (not (eobp)))
7064 (funcall fun)))))
7066 (defun org-fixup-indentation (diff)
7067 "Change the indentation in the current entry by DIFF.
7068 However, if any line in the current entry has no indentation, or if it
7069 would end up with no indentation after the change, nothing at all is done."
7070 (save-excursion
7071 (let ((end (save-excursion (outline-next-heading)
7072 (point-marker)))
7073 (prohibit (if (> diff 0)
7076 col)
7077 (unless (save-excursion (end-of-line 1)
7078 (re-search-forward prohibit end t))
7079 (while (and (< (point) end)
7081 (goto-char (match-end 0))
7082 (setq col (current-column))
7083 (if (< diff 0) (replace-match ""))
7084 (org-indent-to-column (+ diff col))))
7085 (move-marker end nil))))
7087 (defun org-convert-to-odd-levels ()
7088 "Convert an org-mode file with all levels allowed to one with odd levels.
7089 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7090 level 5 etc."
7091 (interactive)
7092 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7093 (let ((outline-regexp org-outline-regexp)
7094 (outline-level 'org-outline-level)
7095 (org-odd-levels-only nil) n)
7096 (save-excursion
7097 (goto-char (point-min))
7099 (setq n (- (length (match-string 0)) 2))
7100 (while (>= (setq n (1- n)) 0)
7101 (org-demote))
7102 (end-of-line 1))))))
7104 (defun org-convert-to-oddeven-levels ()
7105 "Convert an org-mode file with only odd levels to one with odd/even levels.
7106 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7107 file contains a section with an even level, conversion would
7108 destroy the structure of the file. An error is signaled in this
7109 case."
7110 (interactive)
7111 (goto-char (point-min))
7112 ;; First check if there are no even levels
7114 (org-show-context t)
7115 (error "Not all levels are odd in this file. Conversion not possible"))
7116 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7117 (let ((outline-regexp org-outline-regexp)
7118 (outline-level 'org-outline-level)
7119 (org-odd-levels-only nil) n)
7120 (save-excursion
7121 (goto-char (point-min))
7123 (setq n (/ (1- (length (match-string 0))) 2))
7124 (while (>= (setq n (1- n)) 0)
7125 (org-promote))
7126 (end-of-line 1))))))
7128 (defun org-tr-level (n)
7129 "Make N odd if required."
7130 (if org-odd-levels-only (1+ (/ n 2)) n))
7132 ;;; Vertical tree motion, cutting and pasting of subtrees
7134 (defun org-move-subtree-up (&optional arg)
7135 "Move the current subtree up past ARG headlines of the same level."
7136 (interactive "p")
7137 (org-move-subtree-down (- (prefix-numeric-value arg))))
7139 (defun org-move-subtree-down (&optional arg)
7140 "Move the current subtree down past ARG headlines of the same level."
7141 (interactive "p")
7142 (setq arg (prefix-numeric-value arg))
7143 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7144 'org-get-last-sibling))
7145 (ins-point (make-marker))
7146 (cnt (abs arg))
7147 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7148 ;; Select the tree
7149 (org-back-to-heading)
7150 (setq beg0 (point))
7151 (save-excursion
7152 (setq ne-beg (org-back-over-empty-lines))
7153 (setq beg (point)))
7154 (save-match-data
7155 (save-excursion (outline-end-of-heading)
7156 (setq folded (org-invisible-p)))
7157 (outline-end-of-subtree))
7158 (outline-next-heading)
7159 (setq ne-end (org-back-over-empty-lines))
7160 (setq end (point))
7161 (goto-char beg0)
7162 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7163 ;; include less whitespace
7164 (save-excursion
7165 (goto-char beg)
7166 (forward-line (- ne-beg ne-end))
7167 (setq beg (point))))
7168 ;; Find insertion point, with error handling
7169 (while (> cnt 0)
7170 (or (and (funcall movfunc) (looking-at outline-regexp))
7171 (progn (goto-char beg0)
7172 (error "Cannot move past superior level or buffer limit")))
7173 (setq cnt (1- cnt)))
7174 (if (> arg 0)
7175 ;; Moving forward - still need to move over subtree
7176 (progn (org-end-of-subtree t t)
7177 (save-excursion
7178 (org-back-over-empty-lines)
7179 (or (bolp) (newline)))))
7180 (setq ne-ins (org-back-over-empty-lines))
7181 (move-marker ins-point (point))
7182 (setq txt (buffer-substring beg end))
7183 (org-save-markers-in-region beg end)
7184 (delete-region beg end)
7185 (org-remove-empty-overlays-at beg)
7186 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7187 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7189 (let ((bbb (point)))
7190 (insert-before-markers txt)
7191 (org-reinstall-markers-in-region bbb)
7192 (move-marker ins-point bbb))
7194 (setq ins-end (point))
7195 (goto-char ins-point)
7196 (org-skip-whitespace)
7197 (when (and (< arg 0)
7198 (org-first-sibling-p)
7199 (> ne-ins ne-beg))
7200 ;; Move whitespace back to beginning
7201 (save-excursion
7202 (goto-char ins-end)
7203 (let ((kill-whole-line t))
7204 (kill-line (- ne-ins ne-beg)) (point)))
7206 (move-marker ins-point nil)
7207 (if folded
7208 (hide-subtree)
7209 (org-show-entry)
7210 (show-children)
7211 (org-cycle-hide-drawers 'children))
7212 (org-clean-visibility-after-subtree-move)))
7214 (defvar org-subtree-clip ""
7215 "Clipboard for cut and paste of subtrees.
7216 This is actually only a copy of the kill, because we use the normal kill
7217 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7219 (defvar org-subtree-clip-folded nil
7220 "Was the last copied subtree folded?
7221 This is used to fold the tree back after pasting.")
7223 (defun org-cut-subtree (&optional n)
7224 "Cut the current subtree into the clipboard.
7225 With prefix arg N, cut this many sequential subtrees.
7226 This is a short-hand for marking the subtree and then cutting it."
7227 (interactive "p")
7228 (org-copy-subtree n 'cut))
7230 (defun org-copy-subtree (&optional n cut force-store-markers)
7231 "Cut the current subtree into the clipboard.
7232 With prefix arg N, cut this many sequential subtrees.
7233 This is a short-hand for marking the subtree and then copying it.
7234 If CUT is non-nil, actually cut the subtree.
7235 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7236 of some markers in the region, even if CUT is non-nil. This is
7237 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7238 (interactive "p")
7239 (let (beg end folded (beg0 (point)))
7240 (if (interactive-p)
7241 (org-back-to-heading nil) ; take what looks like a subtree
7242 (org-back-to-heading t)) ; take what is really there
7243 (org-back-over-empty-lines)
7244 (setq beg (point))
7246 (save-match-data
7247 (save-excursion (outline-end-of-heading)
7248 (setq folded (org-invisible-p)))
7249 (condition-case nil
7250 (org-forward-same-level (1- n) t)
7251 (error nil))
7252 (org-end-of-subtree t t))
7253 (org-back-over-empty-lines)
7254 (setq end (point))
7255 (goto-char beg0)
7256 (when (> end beg)
7257 (setq org-subtree-clip-folded folded)
7258 (when (or cut force-store-markers)
7259 (org-save-markers-in-region beg end))
7260 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7261 (setq org-subtree-clip (current-kill 0))
7262 (message "%s: Subtree(s) with %d characters"
7263 (if cut "Cut" "Copied")
7264 (length org-subtree-clip)))))
7266 (defun org-paste-subtree (&optional level tree for-yank)
7267 "Paste the clipboard as a subtree, with modification of headline level.
7268 The entire subtree is promoted or demoted in order to match a new headline
7269 level.
7271 If the cursor is at the beginning of a headline, the same level as
7272 that headline is used to paste the tree
7274 If not, the new level is derived from the *visible* headings
7275 before and after the insertion point, and taken to be the inferior headline
7276 level of the two. So if the previous visible heading is level 3 and the
7277 next is level 4 (or vice versa), level 4 will be used for insertion.
7278 This makes sure that the subtree remains an independent subtree and does
7279 not swallow low level entries.
7281 You can also force a different level, either by using a numeric prefix
7282 argument, or by inserting the heading marker by hand. For example, if the
7285 If optional TREE is given, use this text instead of the kill ring.
7287 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7288 move back over whitespace before inserting, and move point to the end of
7289 the inserted text when done."
7290 (interactive "P")
7291 (setq tree (or tree (and kill-ring (current-kill 0))))
7292 (unless (org-kill-is-subtree-p tree)
7293 (error "%s"
7294 (substitute-command-keys
7296 (let* ((visp (not (org-invisible-p)))
7297 (txt tree)
7302 (old-level (if (string-match ^re txt)
7303 (- (match-end 0) (match-beginning 0) 1)
7304 -1))
7305 (force-level (cond (level (prefix-numeric-value level))
7307 (string-match
7308 ^re_ (buffer-substring
7309 (point-at-bol) (point))))
7310 (- (match-end 1) (match-beginning 1)))
7311 ((and (bolp)
7312 (looking-at org-outline-regexp))
7313 (- (match-end 0) (point) 1))
7314 (t nil)))
7315 (previous-level (save-excursion
7316 (condition-case nil
7317 (progn
7318 (outline-previous-visible-heading 1)
7319 (if (looking-at re)
7320 (- (match-end 0) (match-beginning 0) 1)
7321 1))
7322 (error 1))))
7323 (next-level (save-excursion
7324 (condition-case nil
7325 (progn
7326 (or (looking-at outline-regexp)
7327 (outline-next-visible-heading 1))
7328 (if (looking-at re)
7329 (- (match-end 0) (match-beginning 0) 1)
7330 1))
7331 (error 1))))
7332 (new-level (or force-level (max previous-level next-level)))
7333 (shift (if (or (= old-level -1)
7334 (= new-level -1)
7335 (= old-level new-level))
7336 0
7337 (- new-level old-level)))
7338 (delta (if (> shift 0) -1 1))
7339 (func (if (> shift 0) 'org-demote 'org-promote))
7340 (org-odd-levels-only nil)
7341 beg end newend)
7342 ;; Remove the forced level indicator
7343 (if force-level
7344 (delete-region (point-at-bol) (point)))
7345 ;; Paste
7346 (beginning-of-line 1)
7347 (unless for-yank (org-back-over-empty-lines))
7348 (setq beg (point))
7349 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7350 (insert-before-markers txt)
7352 (setq newend (point))
7353 (org-reinstall-markers-in-region beg)
7354 (setq end (point))
7355 (goto-char beg)
7357 (setq beg (point))
7358 (if (and (org-invisible-p) visp)
7359 (save-excursion (outline-show-heading)))
7360 ;; Shift if necessary
7361 (unless (= shift 0)
7362 (save-restriction
7363 (narrow-to-region beg end)
7364 (while (not (= shift 0))
7365 (org-map-region func (point-min) (point-max))
7366 (setq shift (+ delta shift)))
7367 (goto-char (point-min))
7368 (setq newend (point-max))))
7369 (when (or (interactive-p) for-yank)
7370 (message "Clipboard pasted as level %d subtree" new-level))
7371 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7372 kill-ring
7373 (eq org-subtree-clip (current-kill 0))
7374 org-subtree-clip-folded)
7375 ;; The tree was folded before it was killed/copied
7376 (hide-subtree))
7377 (and for-yank (goto-char newend))))
7379 (defun org-kill-is-subtree-p (&optional txt)
7380 "Check if the current kill is an outline subtree, or a set of trees.
7381 Returns nil if kill does not start with a headline, or if the first
7382 headline level is not the largest headline level in the tree.
7383 So this will actually accept several entries of equal levels as well,
7384 which is OK for `org-paste-subtree'.
7385 If optional TXT is given, check this string instead of the current kill."
7386 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7387 (start-level (and kill
7390 kill)
7391 (- (match-end 2) (match-beginning 2) 1)))
7392 (re (concat "^" org-outline-regexp))
7393 (start (1+ (or (match-beginning 2) -1))))
7394 (if (not start-level)
7395 (progn
7396 nil) ;; does not even start with a heading
7397 (catch 'exit
7398 (while (setq start (string-match re kill (1+ start)))
7399 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7400 (throw 'exit nil)))
7401 t))))
7403 (defvar org-markers-to-move nil
7404 "Markers that should be moved with a cut-and-paste operation.
7405 Those markers are stored together with their positions relative to
7406 the start of the region.")
7408 (defun org-save-markers-in-region (beg end)
7409 "Check markers in region.
7410 If these markers are between BEG and END, record their position relative
7411 to BEG, so that after moving the block of text, we can put the markers back
7412 into place.
7413 This function gets called just before an entry or tree gets cut from the
7414 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7415 called immediately, to move the markers with the entries."
7416 (setq org-markers-to-move nil)
7417 (when (featurep 'org-clock)
7418 (org-clock-save-markers-for-cut-and-paste beg end))
7419 (when (featurep 'org-agenda)
7420 (org-agenda-save-markers-for-cut-and-paste beg end)))
7422 (defun org-check-and-save-marker (marker beg end)
7423 "Check if MARKER is between BEG and END.
7424 If yes, remember the marker and the distance to BEG."
7425 (when (and (marker-buffer marker)
7426 (equal (marker-buffer marker) (current-buffer)))
7427 (if (and (>= marker beg) (< marker end))
7428 (push (cons marker (- marker beg)) org-markers-to-move))))
7430 (defun org-reinstall-markers-in-region (beg)
7431 "Move all remembered markers to their position relative to BEG."
7432 (mapc (lambda (x)
7433 (move-marker (car x) (+ beg (cdr x))))
7434 org-markers-to-move)
7435 (setq org-markers-to-move nil))
7437 (defun org-narrow-to-subtree ()
7438 "Narrow buffer to the current subtree."
7439 (interactive)
7440 (save-excursion
7441 (save-match-data
7442 (narrow-to-region
7443 (progn (org-back-to-heading t) (point))
7444 (progn (org-end-of-subtree t t)
7445 (if (org-on-heading-p) (backward-char 1))
7446 (point))))))
7448 (eval-when-compile
7449 (defvar org-property-drawer-re))
7451 (defun org-clone-subtree-with-time-shift (n &optional shift)
7452 "Clone the task (subtree) at point N times.
7453 The clones will be inserted as siblings.
7455 In interactive use, the user will be prompted for the number of
7456 clones to be produced, and for a time SHIFT, which may be a
7457 repeater as used in time stamps, for example `+3d'.
7459 When a valid repeater is given and the entry contains any time
7460 stamps, the clones will become a sequence in time, with time
7461 stamps in the subtree shifted for each clone produced. If SHIFT
7462 is nil or the empty string, time stamps will be left alone. The
7463 ID property of the original subtree is removed.
7465 If the original subtree did contain time stamps with a repeater,
7466 the following will happen:
7467 - the repeater will be removed in each clone
7468 - an additional clone will be produced, with the current, unshifted
7469 date(s) in the entry.
7470 - the original entry will be placed *after* all the clones, with
7471 repeater intact.
7472 - the start days in the repeater in the original entry will be shifted
7473 to past the last clone.
7474 I this way you can spell out a number of instances of a repeating task,
7475 and still retain the repeater to cover future instances of the task."
7476 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7477 (let (beg end template task idprop
7478 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7479 (if (not (and (integerp n) (> n 0)))
7480 (error "Invalid number of replications %s" n))
7483 shift)))
7484 (error "Invalid shift specification %s" shift))
7485 (when doshift
7486 (setq shift-n (string-to-number (match-string 1 shift))
7487 shift-what (cdr (assoc (match-string 2 shift)
7488 '(("d" . day) ("w" . week)
7489 ("m" . month) ("y" . year))))))
7490 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7491 (setq nmin 1 nmax n)
7492 (org-back-to-heading t)
7493 (setq beg (point))
7494 (setq idprop (org-entry-get nil "ID"))
7495 (org-end-of-subtree t t)
7497 (setq end (point))
7498 (setq template (buffer-substring beg end))
7499 (when (and doshift
7501 (delete-region beg end)
7502 (setq end beg)
7503 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7504 (goto-char end)
7505 (loop for n from nmin to nmax do
7506 ;; prepare clone
7507 (with-temp-buffer
7508 (insert template)
7509 (org-mode)
7510 (goto-char (point-min))
7511 (and idprop (if org-clone-delete-id
7512 (org-entry-delete nil "ID")
7513 (org-id-get-create t)))
7514 (while (re-search-forward org-property-drawer-re nil t)
7515 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7516 (goto-char (point-min))
7517 (when doshift
7518 (while (re-search-forward org-ts-regexp-both nil t)
7519 (org-timestamp-change (* n shift-n) shift-what))
7520 (unless (= n n-no-remove)
7521 (goto-char (point-min))
7522 (while (re-search-forward org-ts-regexp nil t)
7523 (save-excursion
7524 (goto-char (match-beginning 0))
7526 (delete-region (match-beginning 1) (match-end 1)))))))
7527 (setq task (buffer-string)))
7528 (insert task))
7529 (goto-char beg)))
7531 ;;; Outline Sorting
7533 (defun org-sort (with-case)
7534 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7535 Optional argument WITH-CASE means sort case-sensitively.
7536 With a double prefix argument, also remove duplicate entries."
7537 (interactive "P")
7538 (cond
7539 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7540 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7541 (t
7542 (org-call-with-arg 'org-sort-entries with-case))))
7544 (defun org-sort-remove-invisible (s)
7545 (remove-text-properties 0 (length s) org-rm-props s)
7546 (while (string-match org-bracket-link-regexp s)
7547 (setq s (replace-match (if (match-end 2)
7548 (match-string 3 s)
7549 (match-string 1 s)) t t s)))
7550 s)
7552 (defvar org-priority-regexp) ; defined later in the file
7554 (defvar org-after-sorting-entries-or-items-hook nil
7555 "Hook that is run after a bunch of entries or items have been sorted.
7556 When children are sorted, the cursor is in the parent line when this
7557 hook gets called. When a region or a plain list is sorted, the cursor
7558 will be in the first entry of the sorted region/list.")
7560 (defun org-sort-entries
7561 (&optional with-case sorting-type getkey-func compare-func property)
7562 "Sort entries on a certain level of an outline tree.
7563 If there is an active region, the entries in the region are sorted.
7564 Else, if the cursor is before the first entry, sort the top-level items.
7565 Else, the children of the entry at point are sorted.
7567 Sorting can be alphabetically, numerically, by date/time as given by
7568 a time stamp, by a property or by priority.
7570 The command prompts for the sorting type unless it has been given to the
7571 function through the SORTING-TYPE argument, which needs to be a character,
7572 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7573 precise meaning of each character:
7575 n Numerically, by converting the beginning of the entry/item to a number.
7576 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7577 t By date/time, either the first active time stamp in the entry, or, if
7578 none exist, by the first inactive one.
7579 s By the scheduled date/time.
7580 d By deadline date/time.
7581 c By creation time, which is assumed to be the first inactive time stamp
7582 at the beginning of a line.
7583 p By priority according to the cookie.
7584 r By the value of a property.
7586 Capital letters will reverse the sort order.
7588 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7589 called with point at the beginning of the record. It must return either
7590 a string or a number that should serve as the sorting key for that record.
7592 Comparing entries ignores case by default. However, with an optional argument
7593 WITH-CASE, the sorting considers case as well."
7594 (interactive "P")
7595 (let ((case-func (if with-case 'identity 'downcase))
7596 start beg end stars re re2
7597 txt what tmp)
7598 ;; Find beginning and end of region to sort
7599 (cond
7600 ((org-region-active-p)
7601 ;; we will sort the region
7602 (setq end (region-end)
7603 what "region")
7604 (goto-char (region-beginning))
7605 (if (not (org-on-heading-p)) (outline-next-heading))
7606 (setq start (point)))
7607 ((or (org-on-heading-p)
7608 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7609 ;; we will sort the children of the current headline
7610 (org-back-to-heading)
7611 (setq start (point)
7612 end (progn (org-end-of-subtree t t)
7614 (org-back-over-empty-lines)
7615 (point))
7616 what "children")
7617 (goto-char start)
7618 (show-subtree)
7619 (outline-next-heading))
7620 (t
7621 ;; we will sort the top-level entries in this file
7622 (goto-char (point-min))
7623 (or (org-on-heading-p) (outline-next-heading))
7624 (setq start (point))
7625 (goto-char (point-max))
7626 (beginning-of-line 1)
7628 ;; File ends in a non-white line
7629 (end-of-line 1)
7631 (setq end (point-max))
7632 (setq what "top-level")
7633 (goto-char start)
7634 (show-all)))
7636 (setq beg (point))
7637 (if (>= beg end) (error "Nothing to sort"))
7640 (setq stars (match-string 1)
7641 re (concat "^" (regexp-quote stars) " +")
7642 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7643 txt (buffer-substring beg end))
7645 (if (and (not (equal stars "*")) (string-match re2 txt))
7646 (error "Region to sort contains a level above the first entry"))
7648 (unless sorting-type
7649 (message
7650 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7652 A/N/T/S/D/C/P/O/F means reversed:"
7653 what)
7654 (setq sorting-type (read-char-exclusive))
7656 (and (= (downcase sorting-type) ?f)
7657 (setq getkey-func
7658 (org-icompleting-read "Sort using function: "
7659 obarray 'fboundp t nil nil))
7660 (setq getkey-func (intern getkey-func)))
7662 (and (= (downcase sorting-type) ?r)
7663 (setq property
7664 (org-icompleting-read "Property: "
7665 (mapcar 'list (org-buffer-property-keys t))
7666 nil t))))
7668 (message "Sorting entries...")
7670 (save-restriction
7671 (narrow-to-region start end)
7672 (let ((dcst (downcase sorting-type))
7673 (case-fold-search nil)
7674 (now (current-time)))
7675 (sort-subr
7676 (/= dcst sorting-type)
7677 ;; This function moves to the beginning character of the "record" to
7678 ;; be sorted.
7679 (lambda nil
7680 (if (re-search-forward re nil t)
7681 (goto-char (match-beginning 0))
7682 (goto-char (point-max))))
7683 ;; This function moves to the last character of the "record" being
7684 ;; sorted.
7685 (lambda nil
7686 (save-match-data
7687 (condition-case nil
7688 (outline-forward-same-level 1)
7689 (error
7690 (goto-char (point-max))))))
7691 ;; This function returns the value that gets sorted against.
7692 (lambda nil
7693 (cond
7694 ((= dcst ?n)
7695 (if (looking-at org-complex-heading-regexp)
7696 (string-to-number (match-string 4))
7697 nil))
7698 ((= dcst ?a)
7699 (if (looking-at org-complex-heading-regexp)
7700 (funcall case-func (match-string 4))
7701 nil))
7702 ((= dcst ?t)
7703 (let ((end (save-excursion (outline-next-heading) (point))))
7704 (if (or (re-search-forward org-ts-regexp end t)
7705 (re-search-forward org-ts-regexp-both end t))
7706 (org-time-string-to-seconds (match-string 0))
7707 (org-float-time now))))
7708 ((= dcst ?c)
7709 (let ((end (save-excursion (outline-next-heading) (point))))
7710 (if (re-search-forward
7712 end t)
7713 (org-time-string-to-seconds (match-string 0))
7714 (org-float-time now))))
7715 ((= dcst ?s)
7716 (let ((end (save-excursion (outline-next-heading) (point))))
7717 (if (re-search-forward org-scheduled-time-regexp end t)
7718 (org-time-string-to-seconds (match-string 1))
7719 (org-float-time now))))
7720 ((= dcst ?d)
7721 (let ((end (save-excursion (outline-next-heading) (point))))
7722 (if (re-search-forward org-deadline-time-regexp end t)
7723 (org-time-string-to-seconds (match-string 1))
7724 (org-float-time now))))
7725 ((= dcst ?p)
7726 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7727 (string-to-char (match-string 2))
7728 org-default-priority))
7729 ((= dcst ?r)
7730 (or (org-entry-get nil property) ""))
7731 ((= dcst ?o)
7732 (if (looking-at org-complex-heading-regexp)
7733 (- 9999 (length (member (match-string 2)
7734 org-todo-keywords-1)))))
7735 ((= dcst ?f)
7736 (if getkey-func
7737 (progn
7738 (setq tmp (funcall getkey-func))
7739 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7740 tmp)
7741 (error "Invalid key function `%s'" getkey-func)))
7742 (t (error "Invalid sorting type `%c'" sorting-type))))
7743 nil
7744 (cond
7745 ((= dcst ?a) 'string<)
7746 ((= dcst ?f) compare-func)
7747 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7748 (t nil)))))
7749 (run-hooks 'org-after-sorting-entries-or-items-hook)
7750 (message "Sorting entries...done")))
7752 (defun org-do-sort (table what &optional with-case sorting-type)
7753 "Sort TABLE of WHAT according to SORTING-TYPE.
7754 The user will be prompted for the SORTING-TYPE if the call to this
7755 function does not specify it. WHAT is only for the prompt, to indicate
7756 what is being sorted. The sorting key will be extracted from
7757 the car of the elements of the table.
7758 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7759 (unless sorting-type
7760 (message
7761 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7762 what)
7763 (setq sorting-type (read-char-exclusive)))
7764 (let ((dcst (downcase sorting-type))
7765 extractfun comparefun)
7766 ;; Define the appropriate functions
7767 (cond
7768 ((= dcst ?n)
7769 (setq extractfun 'string-to-number
7770 comparefun (if (= dcst sorting-type) '< '>)))
7771 ((= dcst ?a)
7772 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7773 (lambda(x) (downcase (org-sort-remove-invisible x))))
7774 comparefun (if (= dcst sorting-type)
7775 'string<
7776 (lambda (a b) (and (not (string< a b))
7777 (not (string= a b)))))))
7778 ((= dcst ?t)
7779 (setq extractfun
7780 (lambda (x)
7781 (if (or (string-match org-ts-regexp x)
7782 (string-match org-ts-regexp-both x))
7783 (org-float-time
7784 (org-time-string-to-time (match-string 0 x)))
7785 0))
7786 comparefun (if (= dcst sorting-type) '< '>)))
7787 (t (error "Invalid sorting type `%c'" sorting-type)))
7789 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7790 table)
7791 (lambda (a b) (funcall comparefun (car a) (car b))))))
7794 ;;; The orgstruct minor mode
7796 ;; Define a minor mode which can be used in other modes in order to
7797 ;; integrate the org-mode structure editing commands.
7799 ;; This is really a hack, because the org-mode structure commands use
7800 ;; keys which normally belong to the major mode. Here is how it
7801 ;; works: The minor mode defines all the keys necessary to operate the
7802 ;; structure commands, but wraps the commands into a function which
7803 ;; tests if the cursor is currently at a headline or a plain list
7804 ;; item. If that is the case, the structure command is used,
7805 ;; temporarily setting many Org-mode variables like regular
7806 ;; expressions for filling etc. However, when any of those keys is
7807 ;; used at a different location, function uses `key-binding' to look
7808 ;; up if the key has an associated command in another currently active
7809 ;; keymap (minor modes, major mode, global), and executes that
7810 ;; command. There might be problems if any of the keys is otherwise
7811 ;; used as a prefix key.
7813 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7814 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7815 ;; addresses this by checking explicitly for both bindings.
7817 (defvar orgstruct-mode-map (make-sparse-keymap)
7818 "Keymap for the minor `orgstruct-mode'.")
7820 (defvar org-local-vars nil
7821 "List of local variables, for use by `orgstruct-mode'.")
7823 ;;;###autoload
7824 (define-minor-mode orgstruct-mode
7825 "Toggle the minor mode `orgstruct-mode'.
7826 This mode is for using Org-mode structure commands in other
7827 modes. The following keys behave as if Org-mode were active, if
7828 the cursor is on a headline, or on a plain list item (both as
7829 defined by Org-mode).
7831 M-up Move entry/item up
7832 M-down Move entry/item down
7833 M-left Promote
7834 M-right Demote
7835 M-S-up Move entry/item up
7836 M-S-down Move entry/item down
7837 M-S-left Promote subtree
7838 M-S-right Demote subtree
7839 M-q Fill paragraph and items like in Org-mode
7840 C-c ^ Sort entries
7841 C-c - Cycle list bullet
7842 TAB Cycle item visibility
7843 M-RET Insert new heading/item
7844 S-M-RET Insert new TODO heading / Checkbox item
7845 C-c C-c Set tags / toggle checkbox"
7846 nil " OrgStruct" nil
7847 (org-load-modules-maybe)
7848 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7850 ;;;###autoload
7851 (defun turn-on-orgstruct ()
7852 "Unconditionally turn on `orgstruct-mode'."
7853 (orgstruct-mode 1))
7855 (defun orgstruct++-mode (&optional arg)
7856 "Toggle `orgstruct-mode', the enhanced version of it.
7857 In addition to setting orgstruct-mode, this also exports all indentation
7858 and autofilling variables from org-mode into the buffer. It will also
7859 recognize item context in multiline items.
7860 Note that turning off orgstruct-mode will *not* remove the
7861 indentation/paragraph settings. This can only be done by refreshing the
7863 (interactive "P")
7864 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7865 (if (< arg 1)
7866 (orgstruct-mode -1)
7867 (orgstruct-mode 1)
7868 (let (var val)
7869 (mapc
7870 (lambda (x)
7871 (when (string-match
7873 (symbol-name (car x)))
7874 (setq var (car x) val (nth 1 x))
7875 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7876 org-local-vars)
7877 (org-set-local 'orgstruct-is-++ t))))
7879 (defvar orgstruct-is-++ nil
7880 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7881 (make-variable-buffer-local 'orgstruct-is-++)
7883 ;;;###autoload
7884 (defun turn-on-orgstruct++ ()
7885 "Unconditionally turn on `orgstruct++-mode'."
7886 (orgstruct++-mode 1))
7888 (defun orgstruct-error ()
7889 "Error when there is no default binding for a structure key."
7890 (interactive)
7891 (error "This key has no function outside structure elements"))
7893 (defun orgstruct-setup ()
7894 "Setup orgstruct keymaps."
7895 (let ((nfunc 0)
7896 (bindings
7897 (list
7898 '([(meta up)] org-metaup)
7899 '([(meta down)] org-metadown)
7900 '([(meta left)] org-metaleft)
7901 '([(meta right)] org-metaright)
7902 '([(meta shift up)] org-shiftmetaup)
7903 '([(meta shift down)] org-shiftmetadown)
7904 '([(meta shift left)] org-shiftmetaleft)
7905 '([(meta shift right)] org-shiftmetaright)
7906 '([?\e (up)] org-metaup)
7907 '([?\e (down)] org-metadown)
7908 '([?\e (left)] org-metaleft)
7909 '([?\e (right)] org-metaright)
7910 '([?\e (shift up)] org-shiftmetaup)
7911 '([?\e (shift down)] org-shiftmetadown)
7912 '([?\e (shift left)] org-shiftmetaleft)
7913 '([?\e (shift right)] org-shiftmetaright)
7914 '([(shift up)] org-shiftup)
7915 '([(shift down)] org-shiftdown)
7916 '([(shift left)] org-shiftleft)
7917 '([(shift right)] org-shiftright)
7918 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7919 '("\M-q" fill-paragraph)
7920 '("\C-c^" org-sort)
7921 '("\C-c-" org-cycle-list-bullet)))
7922 elt key fun cmd)
7923 (while (setq elt (pop bindings))
7924 (setq nfunc (1+ nfunc))
7925 (setq key (org-key (car elt))
7926 fun (nth 1 elt)
7927 cmd (orgstruct-make-binding fun nfunc key))
7928 (org-defkey orgstruct-mode-map key cmd))
7930 ;; Special treatment needed for TAB and RET
7931 (org-defkey orgstruct-mode-map [(tab)]
7932 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7933 (org-defkey orgstruct-mode-map "\C-i"
7934 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7936 (org-defkey orgstruct-mode-map "\M-\C-m"
7937 (orgstruct-make-binding 'org-insert-heading 105
7938 "\M-\C-m" [(meta return)]))
7939 (org-defkey orgstruct-mode-map [(meta return)]
7940 (orgstruct-make-binding 'org-insert-heading 106
7941 [(meta return)] "\M-\C-m"))
7943 (org-defkey orgstruct-mode-map [(shift meta return)]
7944 (orgstruct-make-binding 'org-insert-todo-heading 107
7945 [(meta return)] "\M-\C-m"))
7947 (org-defkey orgstruct-mode-map "\e\C-m"
7948 (orgstruct-make-binding 'org-insert-heading 108
7949 "\e\C-m" [?\e (return)]))
7950 (org-defkey orgstruct-mode-map [?\e (return)]
7951 (orgstruct-make-binding 'org-insert-heading 109
7952 [?\e (return)] "\e\C-m"))
7953 (org-defkey orgstruct-mode-map [?\e (shift return)]
7954 (orgstruct-make-binding 'org-insert-todo-heading 110
7955 [?\e (return)] "\e\C-m"))
7957 (unless org-local-vars
7958 (setq org-local-vars (org-get-local-variables)))
7960 t))
7962 (defun orgstruct-make-binding (fun n &rest keys)
7963 "Create a function for binding in the structure minor mode.
7964 FUN is the command to call inside a table. N is used to create a unique
7965 command name. KEYS are keys that should be checked in for a command
7966 to execute outside of tables."
7967 (eval
7968 (list 'defun
7969 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7970 '(arg)
7972 "Outside of structure, run the binding of `"
7973 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7974 "'.")
7975 '(interactive "p")
7976 (list 'if
7977 `(org-context-p 'headline 'item
7978 (and orgstruct-is-++
7979 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
7980 'item-body))
7981 (list 'org-run-like-in-org-mode (list 'quote fun))
7982 (list 'let '(orgstruct-mode)
7983 (list 'call-interactively
7984 (append '(or)
7985 (mapcar (lambda (k)
7986 (list 'key-binding k))
7987 keys)
7988 '('orgstruct-error))))))))
7990 (defun org-context-p (&rest contexts)
7991 "Check if local context is any of CONTEXTS.
7992 Possible values in the list of contexts are `table', `headline', and `item'."
7993 (let ((pos (point)))
7994 (goto-char (point-at-bol))
7995 (prog1 (or (and (memq 'table contexts)
7997 (and (memq 'headline contexts)
7999 (looking-at outline-regexp))
8000 (and (memq 'item contexts)
8002 (and (memq 'item-body contexts)
8003 (org-in-item-p)))
8004 (goto-char pos))))
8006 (defun org-get-local-variables ()
8007 "Return a list of all local variables in an org-mode buffer."
8008 (let (varlist)
8009 (with-current-buffer (get-buffer-create "*Org tmp*")
8010 (erase-buffer)
8011 (org-mode)
8012 (setq varlist (buffer-local-variables)))
8013 (kill-buffer "*Org tmp*")
8014 (delq nil
8015 (mapcar
8016 (lambda (x)
8017 (setq x
8018 (if (symbolp x)
8019 (list x)
8020 (list (car x) (list 'quote (cdr x)))))
8021 (if (string-match
8022 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8023 (symbol-name (car x)))
8024 x nil))
8025 varlist))))
8027 ;;;###autoload
8028 (defun org-run-like-in-org-mode (cmd)
8029 "Run a command, pretending that the current buffer is in Org-mode.
8030 This will temporarily bind local variables that are typically bound in
8031 Org-mode to the values they have in Org-mode, and then interactively
8032 call CMD."
8033 (org-load-modules-maybe)
8034 (unless org-local-vars
8035 (setq org-local-vars (org-get-local-variables)))
8036 (eval (list 'let org-local-vars
8037 (list 'call-interactively (list 'quote cmd)))))
8039 ;;;; Archiving
8041 (defun org-get-category (&optional pos)
8042 "Get the category applying to position POS."
8043 (get-text-property (or pos (point)) 'org-category))
8045 (defun org-refresh-category-properties ()
8046 "Refresh category text properties in the buffer."
8047 (let ((def-cat (cond
8048 ((null org-category)
8049 (if buffer-file-name
8050 (file-name-sans-extension
8051 (file-name-nondirectory buffer-file-name))
8052 "???"))
8053 ((symbolp org-category) (symbol-name org-category))
8054 (t org-category)))
8055 beg end cat pos optionp)
8056 (org-unmodified
8057 (save-excursion
8058 (save-restriction
8059 (widen)
8060 (goto-char (point-min))
8061 (put-text-property (point) (point-max) 'org-category def-cat)
8062 (while (re-search-forward
8064 (setq pos (match-end 0)
8065 optionp (equal (char-after (match-beginning 0)) ?#)
8066 cat (org-trim (match-string 2)))
8067 (if optionp
8068 (setq beg (point-at-bol) end (point-max))
8069 (org-back-to-heading t)
8070 (setq beg (point) end (org-end-of-subtree t t)))
8071 (put-text-property beg end 'org-category cat)
8072 (goto-char pos)))))))
8075 ;;;; Link Stuff
8077 ;;; Link abbreviations
8079 (defun org-link-expand-abbrev (link)
8080 "Apply replacements as defined in `org-link-abbrev-alist."
8082 (let* ((key (match-string 1 link))
8083 (as (or (assoc key org-link-abbrev-alist-local)
8084 (assoc key org-link-abbrev-alist)))
8085 (tag (and (match-end 2) (match-string 3 link)))
8086 rpl)
8087 (if (not as)
8088 link
8089 (setq rpl (cdr as))
8090 (cond
8091 ((symbolp rpl) (funcall rpl tag))
8092 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8093 ((string-match "%h" rpl)
8094 (replace-match (url-hexify-string (or tag "")) t t rpl))
8095 (t (concat rpl tag)))))
8096 link))
8098 ;;; Storing and inserting links
8100 (defvar org-insert-link-history nil
8101 "Minibuffer history for links inserted with `org-insert-link'.")
8103 (defvar org-stored-links nil
8104 "Contains the links stored with `org-store-link'.")
8106 (defvar org-store-link-plist nil
8107 "Plist with info about the most recently link created with `org-store-link'.")
8109 (defvar org-link-protocols nil
8110 "Link protocols added to Org-mode using `org-add-link-type'.")
8112 (defvar org-store-link-functions nil
8113 "List of functions that are called to create and store a link.
8114 Each function will be called in turn until one returns a non-nil
8115 value. Each function should check if it is responsible for creating
8116 this link (for example by looking at the major mode).
8117 If not, it must exit and return nil.
8118 If yes, it should return a non-nil value after a calling
8119 `org-store-link-props' with a list of properties and values.
8120 Special properties are:
8124 This is obligatory as well.
8125 :description Optional default description for the second pair
8126 of brackets in an Org-mode link. The user can still change
8127 this when inserting this link into an Org-mode buffer.
8129 In addition to these, any additional properties can be specified
8130 and then used in remember templates.")
8132 (defun org-add-link-type (type &optional follow export)
8133 "Add TYPE to the list of `org-link-types'.
8134 Re-compute all regular expressions depending on `org-link-types'
8136 FOLLOW and EXPORT are two functions.
8138 FOLLOW should take the link path as the single argument and do whatever
8139 is necessary to follow the link, for example find a file or display
8140 a mail message.
8142 EXPORT should format the link path for export to one of the export formats.
8143 It should be a function accepting three arguments:
8146 desc the description of the link, if any, nil if there was no description
8147 format the export format, a symbol like `html' or `latex' or `ascii'..
8149 The function may use the FORMAT information to return different values
8150 depending on the format. The return value will be put literally into
8151 the exported file. If the return value is nil, this means Org should
8152 do what it normally does with links which do not have EXPORT defined.
8154 Org-mode has a built-in default for exporting links. If you are happy with
8155 this default, there is no need to define an export function for the link
8156 type. For a simple example of an export function, see `org-bbdb.el'."
8157 (add-to-list 'org-link-types type t)
8158 (org-make-link-regexps)
8159 (if (assoc type org-link-protocols)
8160 (setcdr (assoc type org-link-protocols) (list follow export))
8161 (push (list type follow export) org-link-protocols)))
8163 (defvar org-agenda-buffer-name)
8165 ;;;###autoload
8166 (defun org-store-link (arg)
8168 This link is added to `org-stored-links' and can later be inserted
8171 For some link types, a prefix arg is interpreted:
8172 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8173 For file links, arg negates `org-context-in-file-links'."
8174 (interactive "P")
8175 (org-load-modules-maybe)
8176 (setq org-store-link-plist nil) ; reset
8177 (let ((outline-regexp (org-get-limited-outline-regexp))
8178 link cpltxt desc description search txt custom-id agenda-link)
8179 (cond
8181 ((run-hook-with-args-until-success 'org-store-link-functions)
8182 (setq link (plist-get org-store-link-plist :link)
8183 desc (or (plist-get org-store-link-plist :description) link)))
8185 ((equal (buffer-name) "*Org Edit Src Example*")
8186 (let (label gc)
8187 (while (or (not label)
8188 (save-excursion
8189 (save-restriction
8190 (widen)
8191 (goto-char (point-min))
8192 (re-search-forward
8193 (regexp-quote (format org-coderef-label-format label))
8194 nil t))))
8195 (when label (message "Label exists already") (sit-for 2))
8196 (setq label (read-string "Code line label: " label)))
8197 (end-of-line 1)
8198 (setq link (format org-coderef-label-format label))
8199 (setq gc (- 79 (length link)))
8200 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8201 (insert link)
8202 (setq link (concat "(" label ")") desc nil)))
8204 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8205 ;; We are in the agenda, link to referenced location
8206 (let ((m (or (get-text-property (point) 'org-hd-marker)
8207 (get-text-property (point) 'org-marker))))
8208 (when m
8209 (org-with-point-at m
8210 (setq agenda-link
8211 (if (interactive-p)
8212 (call-interactively 'org-store-link)
8213 (org-store-link nil)))))))
8215 ((eq major-mode 'calendar-mode)
8216 (let ((cd (calendar-cursor-to-date)))
8217 (setq link
8218 (format-time-string
8219 (car org-time-stamp-formats)
8220 (apply 'encode-time
8221 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8222 nil nil nil))))
8223 (org-store-link-props :type "calendar" :date cd)))
8225 ((eq major-mode 'w3-mode)
8226 (setq cpltxt (if (and (buffer-name)
8227 (not (string-match "Untitled" (buffer-name))))
8228 (buffer-name)
8229 (url-view-url t))
8230 link (org-make-link (url-view-url t)))
8231 (org-store-link-props :type "w3" :url (url-view-url t)))
8233 ((eq major-mode 'w3m-mode)
8234 (setq cpltxt (or w3m-current-title w3m-current-url)
8235 link (org-make-link w3m-current-url))
8236 (org-store-link-props :type "w3m" :url (url-view-url t)))
8238 ((setq search (run-hook-with-args-until-success
8239 'org-create-file-search-functions))
8240 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8241 "::" search))
8242 (setq cpltxt (or description link)))
8244 ((eq major-mode 'image-mode)
8245 (setq cpltxt (concat "file:"
8246 (abbreviate-file-name buffer-file-name))
8247 link (org-make-link cpltxt))
8248 (org-store-link-props :type "image" :file buffer-file-name))
8250 ((eq major-mode 'dired-mode)
8251 ;; link to the file in the current line
8252 (let ((file (dired-get-filename nil t)))
8253 (setq file (if file
8254 (abbreviate-file-name
8255 (expand-file-name (dired-get-filename nil t)))
8256 ;; otherwise, no file so use current directory.
8257 default-directory))
8258 (setq cpltxt (concat "file:" file)
8259 link (org-make-link cpltxt))))
8261 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8262 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8263 (cond
8265 (setq cpltxt
8266 (concat "file:"
8267 (abbreviate-file-name
8268 (buffer-file-name (buffer-base-buffer)))
8269 "::" (match-string 1))
8270 link (org-make-link cpltxt)))
8271 ((and (featurep 'org-id)
8272 (or (eq org-link-to-org-use-id t)
8273 (and (eq org-link-to-org-use-id 'create-if-interactive)
8274 (interactive-p))
8275 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8276 (interactive-p)
8277 (not custom-id))
8278 (and org-link-to-org-use-id
8279 (condition-case nil
8280 (org-entry-get nil "ID")
8281 (error nil)))))
8282 ;; We can make a link using the ID.
8283 (setq link (condition-case nil
8284 (prog1 (org-id-store-link)
8285 (setq desc (plist-get org-store-link-plist
8286 :description)))
8287 (error
8288 ;; probably before first headline, link to file only
8289 (concat "file:"
8290 (abbreviate-file-name
8291 (buffer-file-name (buffer-base-buffer))))))))
8292 (t
8293 ;; Just link to current headline
8294 (setq cpltxt (concat "file:"
8295 (abbreviate-file-name
8296 (buffer-file-name (buffer-base-buffer)))))
8297 ;; Add a context search string
8298 (when (org-xor org-context-in-file-links arg)
8299 (setq txt (cond
8300 ((org-on-heading-p) nil)
8301 ((org-region-active-p)
8302 (buffer-substring (region-beginning) (region-end)))
8303 (t nil)))
8305 (setq cpltxt
8306 (concat cpltxt "::"
8307 (condition-case nil
8308 (org-make-org-heading-search-string txt)
8309 (error "")))
8310 desc (or (nth 4 (ignore-errors
8311 (org-heading-components))) "NONE"))))
8313 (setq cpltxt (substring cpltxt 0 -2)))
8314 (setq link (org-make-link cpltxt)))))
8316 ((buffer-file-name (buffer-base-buffer))
8317 ;; Just link to this file here.
8318 (setq cpltxt (concat "file:"
8319 (abbreviate-file-name
8320 (buffer-file-name (buffer-base-buffer)))))
8321 ;; Add a context string
8322 (when (org-xor org-context-in-file-links arg)
8323 (setq txt (if (org-region-active-p)
8324 (buffer-substring (region-beginning) (region-end))
8325 (buffer-substring (point-at-bol) (point-at-eol))))
8326 ;; Only use search option if there is some text.
8328 (setq cpltxt
8329 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8330 desc "NONE")))
8331 (setq link (org-make-link cpltxt)))
8333 ((interactive-p)
8334 (error "Cannot link to a buffer which is not visiting a file"))
8336 (t (setq link nil)))
8338 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8339 (setq link (or link cpltxt)
8340 desc (or desc cpltxt))
8341 (if (equal desc "NONE") (setq desc nil))
8343 (if (and (or (interactive-p) executing-kbd-macro) link)
8344 (progn
8345 (setq org-stored-links
8346 (cons (list link desc) org-stored-links))
8347 (message "Stored: %s" (or desc link))
8348 (when custom-id
8349 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8350 "::#" custom-id))
8351 (setq org-stored-links
8352 (cons (list link desc) org-stored-links))))
8353 (or agenda-link (and link (org-make-link-string link desc))))))
8355 (defun org-store-link-props (&rest plist)
8356 "Store link properties, extract names and addresses."
8357 (let (x adr)
8358 (when (setq x (plist-get plist :from))
8359 (setq adr (mail-extract-address-components x))
8360 (setq plist (plist-put plist :fromname (car adr)))
8361 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8362 (when (setq x (plist-get plist :to))
8363 (setq adr (mail-extract-address-components x))
8364 (setq plist (plist-put plist :toname (car adr)))
8365 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8366 (let ((from (plist-get plist :from))
8367 (to (plist-get plist :to)))
8368 (when (and from to org-from-is-user-regexp)
8369 (setq plist
8370 (plist-put plist :fromto
8371 (if (string-match org-from-is-user-regexp from)
8372 (concat "to %t")
8373 (concat "from %f"))))))
8374 (setq org-store-link-plist plist))
8376 (defun org-add-link-props (&rest plist)
8377 "Add these properties to the link property list."
8378 (let (key value)
8379 (while plist
8380 (setq key (pop plist) value (pop plist))
8381 (setq org-store-link-plist
8382 (plist-put org-store-link-plist key value)))))
8384 (defun org-email-link-description (&optional fmt)
8385 "Return the description part of an email link.
8386 This takes information from `org-store-link-plist' and formats it
8387 according to FMT (default from `org-email-link-description-format')."
8388 (setq fmt (or fmt org-email-link-description-format))
8389 (let* ((p org-store-link-plist)
8390 (to (plist-get p :toaddress))
8391 (from (plist-get p :fromaddress))
8392 (table
8393 (list
8394 (cons "%c" (plist-get p :fromto))
8395 (cons "%F" (plist-get p :from))
8396 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8397 (cons "%T" (plist-get p :to))
8398 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8399 (cons "%s" (plist-get p :subject))
8400 (cons "%m" (plist-get p :message-id)))))
8401 (when (string-match "%c" fmt)
8402 ;; Check if the user wrote this message
8403 (if (and org-from-is-user-regexp from to
8404 (save-match-data (string-match org-from-is-user-regexp from)))
8405 (setq fmt (replace-match "to %t" t t fmt))
8406 (setq fmt (replace-match "from %f" t t fmt))))
8407 (org-replace-escapes fmt table)))
8409 (defun org-make-org-heading-search-string (&optional string heading)
8410 "Make search string for STRING or current headline."
8411 (interactive)
8412 (let ((s (or string (org-get-heading))))
8413 (unless (and string (not heading))
8414 ;; We are using a headline, clean up garbage in there.
8415 (if (string-match org-todo-regexp s)
8416 (setq s (replace-match "" t t s)))
8418 (setq s (replace-match "" t t s)))
8419 (setq s (org-trim s))
8422 (setq s (replace-match "" t t s)))
8423 (while (string-match org-ts-regexp s)
8424 (setq s (replace-match "" t t s))))
8426 (setq s (replace-match " " t t s)))
8427 (or string (setq s (concat "*" s))) ; Add * for headlines
8430 (defun org-make-link (&rest strings)
8431 "Concatenate STRINGS."
8432 (apply 'concat strings))
8434 (defun org-make-link-string (link &optional description)
8435 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8437 (error "Empty link"))
8438 (when (and description
8439 (stringp description)
8441 (setq description nil))
8442 (when (stringp description)
8443 ;; Remove brackets from the description, they are fatal.
8445 (setq description (replace-match "{" t t description)))
8447 (setq description (replace-match "}" t t description))))
8448 (when (equal (org-link-escape link) description)
8449 ;; No description needed, it is identical
8450 (setq description nil))
8451 (when (and (not description)
8452 (not (equal link (org-link-escape link))))
8453 (setq description (org-extract-attributes link)))
8454 (concat "[[" (org-link-escape link) "]"
8455 (if description (concat "[" description "]") "")
8456 "]"))
8458 (defconst org-link-escape-chars
8459 '((?\ . "%20")
8460 (?\[ . "%5B")
8461 (?\] . "%5D")
8472 (?\; . "%3B")
8473 ;; (?? . "%3F")
8474 (?= . "%3D")
8475 (?+ . "%2B")
8476 )
8477 "Association list of escapes for some characters problematic in links.
8478 This is the list that is used for internal purposes.")
8480 (defvar org-url-encoding-use-url-hexify nil)
8482 (defconst org-link-escape-chars-browser
8483 '((?\ . "%20")) ; 32 for the SPC char
8484 "Association list of escapes for some characters problematic in links.
8485 This is the list that is used before handing over to the browser.")
8487 (defun org-link-escape (text &optional table)
8488 "Escape characters in TEXT that are problematic for links."
8489 (if (and org-url-encoding-use-url-hexify (not table))
8490 (url-hexify-string text)
8491 (setq table (or table org-link-escape-chars))
8492 (when text
8493 (let ((re (mapconcat (lambda (x) (regexp-quote
8494 (char-to-string (car x))))
8496 (while (string-match re text)
8497 (setq text
8498 (replace-match
8499 (cdr (assoc (string-to-char (match-string 0 text))
8500 table))
8501 t t text)))
8502 text))))
8504 (defun org-link-unescape (text &optional table)
8505 "Reverse the action of `org-link-escape'."
8506 (if (and org-url-encoding-use-url-hexify (not table))
8507 (url-unhex-string text)
8508 (setq table (or table org-link-escape-chars))
8509 (when text
8510 (let ((case-fold-search t)
8511 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8513 (while (string-match re text)
8514 (setq text
8515 (replace-match
8516 (char-to-string (car (rassoc (upcase (match-string 0 text))
8517 table)))
8518 t t text)))
8519 text))))
8521 (defun org-xor (a b)
8522 "Exclusive or."
8523 (if a (not b) b))
8525 (defun org-fixup-message-id-for-http (s)
8526 "Replace special characters in a message id, so it can be used in an http query."
8527 (when (string-match "%" s)
8528 (setq s (mapconcat (lambda (c)
8529 (if (eq c ?%)
8530 "%25"
8531 (char-to-string c)))
8532 s "")))
8533 (while (string-match "<" s)
8534 (setq s (replace-match "%3C" t t s)))
8535 (while (string-match ">" s)
8536 (setq s (replace-match "%3E" t t s)))
8537 (while (string-match "@" s)
8538 (setq s (replace-match "%40" t t s)))
8539 s)
8541 ;;;###autoload
8542 (defun org-insert-link-global ()
8543 "Insert a link like Org-mode does.
8544 This command can be called in any mode to insert a link in Org-mode syntax."
8545 (interactive)
8546 (org-load-modules-maybe)
8547 (org-run-like-in-org-mode 'org-insert-link))
8549 (defun org-insert-link (&optional complete-file link-location)
8550 "Insert a link. At the prompt, enter the link.
8552 Completion can be used to insert any of the link protocol prefixes like
8553 http or ftp in use.
8555 The history can be used to select a link previously stored with
8556 `org-store-link'. When the empty string is entered (i.e. if you just
8557 press RET at the prompt), the link defaults to the most recently
8558 stored link. As SPC triggers completion in the minibuffer, you need to
8559 use M-SPC or C-q SPC to force the insertion of a space character.
8561 You will also be prompted for a description, and if one is given, it will
8562 be displayed in the buffer instead of the link.
8564 If there is already a link at point, this command will allow you to edit link
8565 and description parts.
8568 be selected using completion. The path to the file will be relative to the
8569 current directory if the file is in the current directory or a subdirectory.
8570 Otherwise, the link will be the absolute path as completed in the minibuffer
8571 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8572 option `org-link-file-path-type'.
8575 the current directory or below.
8578 `org-keep-stored-link-after-insertion'.
8580 If `org-make-link-description-function' is non-nil, this function will be
8581 called with the link target, and the result will be the default
8582 link description.
8584 If the LINK-LOCATION parameter is non-nil, this value will be
8585 used as the link location instead of reading one interactively."
8586 (interactive "P")
8587 (let* ((wcf (current-window-configuration))
8588 (region (if (org-region-active-p)
8589 (buffer-substring (region-beginning) (region-end))))
8590 (remove (and region (list (region-beginning) (region-end))))
8591 (desc region)
8592 tmphist ; byte-compile incorrectly complains about this
8593 (link link-location)
8594 entry file all-prefixes)
8595 (cond
8596 (link-location) ; specified by arg, just use it.
8597 ((org-in-regexp org-bracket-link-regexp 1)
8598 ;; We do have a link at point, and we are going to edit it.
8599 (setq remove (list (match-beginning 0) (match-end 0)))
8600 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8601 (setq link (read-string "Link: "
8602 (org-link-unescape
8603 (org-match-string-no-properties 1)))))
8604 ((or (org-in-regexp org-angle-link-re)
8605 (org-in-regexp org-plain-link-re))
8606 ;; Convert to bracket link
8607 (setq remove (list (match-beginning 0) (match-end 0))
8608 link (read-string "Link: "
8609 (org-remove-angle-brackets (match-string 0)))))
8610 ((member complete-file '((4) (16)))
8611 ;; Completing read for file names.
8612 (setq link (org-file-complete-link complete-file)))
8613 (t
8614 ;; Read link, with completion for stored links.
8615 (with-output-to-temp-buffer "*Org Links*"
8616 (princ "Insert a link.
8618 (when org-stored-links
8620 (princ (mapconcat
8621 (lambda (x)
8622 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8624 (let ((cw (selected-window)))
8625 (select-window (get-buffer-window "*Org Links*" 'visible))
8626 (setq truncate-lines t)
8627 (unless (pos-visible-in-window-p (point-max))
8628 (org-fit-window-to-buffer))
8629 (and (window-live-p cw) (select-window cw)))
8630 ;; Fake a link history, containing the stored links.
8631 (setq tmphist (append (mapcar 'car org-stored-links)
8632 org-insert-link-history))
8633 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8634 (mapcar 'car org-link-abbrev-alist)
8635 org-link-types))
8636 (unwind-protect
8637 (progn
8638 (setq link
8639 (let ((org-completion-use-ido nil)
8640 (org-completion-use-iswitchb nil))
8641 (org-completing-read
8642 "Link: "
8643 (append
8644 (mapcar (lambda (x) (list (concat x ":")))
8645 all-prefixes)
8646 (mapcar 'car org-stored-links))
8647 nil nil nil
8648 'tmphist
8649 (car (car org-stored-links)))))
8651 (error "No link selected"))
8652 (if (or (member link all-prefixes)
8653 (and (equal ":" (substring link -1))
8654 (member (substring link 0 -1) all-prefixes)
8655 (setq link (substring link 0 -1))))
8656 (setq link (org-link-try-special-completion link))))
8657 (set-window-configuration wcf)
8658 (kill-buffer "*Org Links*"))
8659 (setq entry (assoc link org-stored-links))
8660 (or entry (push link org-insert-link-history))
8661 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8662 (not org-keep-stored-link-after-insertion))
8663 (setq org-stored-links (delq (assoc link org-stored-links)
8664 org-stored-links)))
8665 (setq desc (or desc (nth 1 entry)))))
8667 (if (string-match org-plain-link-re link)
8668 ;; URL-like link, normalize the use of angular brackets.
8669 (setq link (org-make-link (org-remove-angle-brackets link))))
8671 ;; Check if we are linking to the current file with a search option
8672 ;; If yes, simplify the link by using only the search option.
8673 (when (and buffer-file-name
8675 (let* ((path (match-string 1 link))
8676 (case-fold-search nil)
8677 (search (match-string 2 link)))
8678 (save-match-data
8679 (if (equal (file-truename buffer-file-name) (file-truename path))
8680 ;; We are linking to this same file, with a search option
8681 (setq link search)))))
8683 ;; Check if we can/should use a relative path. If yes, simplify the link
8685 (let* ((type (match-string 1 link))
8686 (path (match-string 2 link))
8687 (origpath path)
8688 (case-fold-search nil))
8689 (cond
8690 ((or (eq org-link-file-path-type 'absolute)
8691 (equal complete-file '(16)))
8692 (setq path (abbreviate-file-name (expand-file-name path))))
8693 ((eq org-link-file-path-type 'noabbrev)
8694 (setq path (expand-file-name path)))
8695 ((eq org-link-file-path-type 'relative)
8696 (setq path (file-relative-name path)))
8697 (t
8698 (save-match-data
8699 (if (string-match (concat "^" (regexp-quote
8700 (expand-file-name
8701 (file-name-as-directory
8702 default-directory))))
8703 (expand-file-name path))
8704 ;; We are linking a file with relative path name.
8705 (setq path (substring (expand-file-name path)
8706 (match-end 0)))
8707 (setq path (abbreviate-file-name (expand-file-name path)))))))
8708 (setq link (concat type path))
8709 (if (equal desc origpath)
8710 (setq desc path))))
8712 (if org-make-link-description-function
8713 (setq desc (funcall org-make-link-description-function link desc)))
8715 (setq desc (read-string "Description: " desc))
8717 (if remove (apply 'delete-region remove))
8718 (insert (org-make-link-string link desc))))
8720 (defun org-link-try-special-completion (type)
8721 "If there is completion support for link type TYPE, offer it."
8722 (let ((fun (intern (concat "org-" type "-complete-link"))))
8723 (if (functionp fun)
8724 (funcall fun)
8725 (read-string "Link (no completion support): " (concat type ":")))))
8727 (defun org-file-complete-link (&optional arg)
8728 "Create a file link using completion."
8729 (let (file link)
8730 (setq file (read-file-name "File: "))
8731 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8732 (pwd1 (file-name-as-directory (abbreviate-file-name
8733 (expand-file-name ".")))))
8734 (cond
8735 ((equal arg '(16))
8736 (setq link (org-make-link
8737 "file:"
8738 (abbreviate-file-name (expand-file-name file)))))
8740 (setq link (org-make-link "file:" (match-string 1 file))))
8742 (expand-file-name file))
8743 (setq link (org-make-link
8744 "file:" (match-string 1 (expand-file-name file)))))
8745 (t (setq link (org-make-link "file:" file)))))
8746 link))
8748 (defun org-completing-read (&rest args)
8749 "Completing-read with SPACE being a normal character."
8750 (let ((minibuffer-local-completion-map
8751 (copy-keymap minibuffer-local-completion-map)))
8752 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8753 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8754 (apply 'org-icompleting-read args)))
8756 (defun org-completing-read-no-i (&rest args)
8757 (let (org-completion-use-ido org-completion-use-iswitchb)
8758 (apply 'org-completing-read args)))
8760 (defun org-iswitchb-completing-read (prompt choices &rest args)
8761 "Use iswitch as a completing-read replacement to choose from choices.
8762 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8763 from."
8764 (let* ((iswitchb-use-virtual-buffers nil)
8765 (iswitchb-make-buflist-hook
8766 (lambda ()
8767 (setq iswitchb-temp-buflist choices))))
8768 (iswitchb-read-buffer prompt)))
8770 (defun org-icompleting-read (&rest args)
8771 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8772 (org-without-partial-completion
8773 (if (and org-completion-use-ido
8774 (fboundp 'ido-completing-read)
8775 (boundp 'ido-mode) ido-mode
8776 (listp (second args)))
8777 (let ((ido-enter-matching-directory nil))
8778 (apply 'ido-completing-read (concat (car args))
8779 (if (consp (car (nth 1 args)))
8780 (mapcar (lambda (x) (car x)) (nth 1 args))
8781 (nth 1 args))
8782 (cddr args)))
8783 (if (and org-completion-use-iswitchb
8784 (boundp 'iswitchb-mode) iswitchb-mode
8785 (listp (second args)))
8786 (apply 'org-iswitchb-completing-read (concat (car args))
8787 (if (consp (car (nth 1 args)))
8788 (mapcar (lambda (x) (car x)) (nth 1 args))
8789 (nth 1 args))
8790 (cddr args))
8791 (apply 'completing-read args)))))
8793 (defun org-extract-attributes (s)
8794 "Extract the attributes cookie from a string and set as text property."
8795 (let (a attr (start 0) key value)
8796 (save-match-data
8798 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8800 (setq key (match-string 1 a) value (match-string 2 a)
8801 start (match-end 0)
8802 attr (plist-put attr (intern key) value))))
8803 (org-add-props s nil 'org-attr attr))
8804 s))
8806 (defun org-extract-attributes-from-string (tag)
8807 (let (key value attr)
8809 (setq key (match-string 1 tag) value (match-string 2 tag)
8810 tag (replace-match "" t t tag)
8811 attr (plist-put attr (intern key) value)))
8812 (cons tag attr)))
8814 (defun org-attributes-to-string (plist)
8815 "Format a property list into an HTML attribute list."
8816 (let ((s "") key value)
8817 (while plist
8818 (setq key (pop plist) value (pop plist))
8819 (and value
8821 s))
8823 ;;; Opening/following a link
8825 (defvar org-link-search-failed nil)
8827 (defvar org-open-link-functions nil
8828 "Hook for functions finding a plain text link.
8829 These functions must take a single argument, the link content.
8830 They will be called for links that look like [[link text][description]]
8834 These functions will be called *before* Org attempts to resolve the
8835 link by doing text searches in the current buffer - so if you want a
8837 handle this as a special case.
8839 When the function does handle the link, it must return a non-nil value.
8840 If it decides that it is not responsible for this link, it must return
8841 nil to indicate that that Org-mode can continue with other options
8842 like exact and fuzzy text search.")
8844 (defun org-next-link ()
8845 "Move forward to the next link.
8846 If the link is in hidden text, expose it."
8847 (interactive)
8848 (when (and org-link-search-failed (eq this-command last-command))
8849 (goto-char (point-min))
8850 (message "Link search wrapped back to beginning of buffer"))
8851 (setq org-link-search-failed nil)
8852 (let* ((pos (point))
8853 (ct (org-context))
8854 (a (assoc :link ct)))
8855 (if a (goto-char (nth 2 a)))
8856 (if (re-search-forward org-any-link-re nil t)
8857 (progn
8858 (goto-char (match-beginning 0))
8859 (if (org-invisible-p) (org-show-context)))
8860 (goto-char pos)
8861 (setq org-link-search-failed t)
8862 (error "No further link found"))))
8864 (defun org-previous-link ()
8865 "Move backward to the previous link.
8866 If the link is in hidden text, expose it."
8867 (interactive)
8868 (when (and org-link-search-failed (eq this-command last-command))
8869 (goto-char (point-max))
8870 (message "Link search wrapped back to end of buffer"))
8871 (setq org-link-search-failed nil)
8872 (let* ((pos (point))
8873 (ct (org-context))
8874 (a (assoc :link ct)))
8875 (if a (goto-char (nth 1 a)))
8876 (if (re-search-backward org-any-link-re nil t)
8877 (progn
8878 (goto-char (match-beginning 0))
8879 (if (org-invisible-p) (org-show-context)))
8880 (goto-char pos)
8881 (setq org-link-search-failed t)
8882 (error "No further link found"))))
8884 (defun org-translate-link (s)
8885 "Translate a link string if a translation function has been defined."
8886 (if (and org-link-translation-function
8887 (fboundp org-link-translation-function)
8889 (progn
8890 (setq s (funcall org-link-translation-function
8891 (match-string 1) (match-string 2)))
8892 (concat (car s) ":" (cdr s)))
8893 s))
8895 (defun org-translate-link-from-planner (type path)
8896 "Translate a link from Emacs Planner syntax so that Org can follow it.
8897 This is still an experimental function, your mileage may vary."
8898 (cond
8899 ((member type '("http" "https" "news" "ftp"))
8900 ;; standard Internet links are the same.
8901 nil)
8902 ((and (equal type "irc") (string-match "^//" path))
8903 ;; Planner has two / at the beginning of an irc link, we have 1.
8904 ;; We should have zero, actually....
8905 (setq path (substring path 1)))
8906 ((and (equal type "lisp") (string-match "^/" path))
8907 ;; Planner has a slash, we do not.
8908 (setq type "elisp" path (substring path 1)))
8910 ;; A typical message link. Planner has the id after the final slash,
8911 ;; we separate it with a hash mark
8912 (setq path (concat (match-string 1 path) "#"
8913 (org-remove-angle-brackets (match-string 2 path)))))
8914 )
8915 (cons type path))
8917 (defun org-find-file-at-mouse (ev)
8918 "Open file link or URL at mouse."
8919 (interactive "e")
8920 (mouse-set-point ev)
8921 (org-open-at-point 'in-emacs))
8923 (defun org-open-at-mouse (ev)
8924 "Open file link or URL at mouse."
8925 (interactive "e")
8926 (mouse-set-point ev)
8927 (if (eq major-mode 'org-agenda-mode)
8928 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8929 (org-open-at-point))
8931 (defvar org-window-config-before-follow-link nil
8932 "The window configuration before following a link.
8933 This is saved in case the need arises to restore it.")
8935 (defvar org-open-link-marker (make-marker)
8936 "Marker pointing to the location where `org-open-at-point; was called.")
8938 ;;;###autoload
8939 (defun org-open-at-point-global ()
8940 "Follow a link like Org-mode does.
8941 This command can be called in any mode to follow a link that has
8942 Org-mode syntax."
8943 (interactive)
8944 (org-run-like-in-org-mode 'org-open-at-point))
8946 ;;;###autoload
8947 (defun org-open-link-from-string (s &optional arg reference-buffer)
8948 "Open a link in the string S, as if it was in Org-mode."
8950 (let ((reference-buffer (or reference-buffer (current-buffer))))
8951 (with-temp-buffer
8952 (let ((org-inhibit-startup t))
8953 (org-mode)
8954 (insert s)
8955 (goto-char (point-min))
8956 (when reference-buffer
8957 (setq org-link-abbrev-alist-local
8958 (with-current-buffer reference-buffer
8959 org-link-abbrev-alist-local)))
8960 (org-open-at-point arg reference-buffer)))))
8962 (defvar org-open-at-point-functions nil
8963 "Hook that is run when following a link at point.
8965 Functions in this hook must return t if they identify and follow
8966 a link at point. If they don't find anything interesting at point,
8967 they must return nil.")
8969 (defun org-open-at-point (&optional in-emacs reference-buffer)
8970 "Open link at or after point.
8971 If there is no link at point, this function will search forward up to
8972 the end of the current line.
8973 Normally, files will be opened by an appropriate application. If the
8974 optional argument IN-EMACS is non-nil, Emacs will visit the file.
8975 With a double prefix argument, try to open outside of Emacs, in the
8976 application the system uses for this file type."
8977 (interactive "P")
8978 ;; if in a code block, then open the block's results
8979 (unless (call-interactively #'org-babel-open-src-block-result)
8980 (org-load-modules-maybe)
8981 (move-marker org-open-link-marker (point))
8982 (setq org-window-config-before-follow-link (current-window-configuration))
8983 (org-remove-occur-highlights nil nil t)
8984 (cond
8985 ((and (org-on-heading-p)
8986 (not (org-in-regexp
8991 (not (get-text-property (point) 'org-linked-text)))
8992 (or (org-offer-links-in-entry in-emacs)
8993 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
8994 ((run-hook-with-args-until-success 'org-open-at-point-functions))
8995 ((org-at-timestamp-p t) (org-follow-timestamp-link))
8996 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
8997 (org-footnote-action))
8998 (t
8999 (let (type path link line search (pos (point)))
9000 (catch 'match
9001 (save-excursion
9003 (when (org-in-regexp org-bracket-link-regexp 1)
9004 (setq link (org-extract-attributes
9005 (org-link-unescape (org-match-string-no-properties 1))))
9007 (setq link (replace-match " " t t link)))
9008 (setq link (org-link-expand-abbrev link))
9009 (cond
9010 ((or (file-name-absolute-p link)
9012 (setq type "file" path link))
9013 ((string-match org-link-re-with-space3 link)
9014 (setq type (match-string 1 link) path (match-string 2 link)))
9015 (t (setq type "thisfile" path link)))
9016 (throw 'match t)))
9018 (when (get-text-property (point) 'org-linked-text)
9019 (setq type "thisfile"
9020 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9021 (1+ (point)) (point))
9022 path (buffer-substring
9023 (previous-single-property-change pos 'org-linked-text)
9024 (next-single-property-change pos 'org-linked-text)))
9025 (throw 'match t))
9027 (save-excursion
9028 (when (or (org-in-regexp org-angle-link-re)
9029 (org-in-regexp org-plain-link-re))
9030 (setq type (match-string 1) path (match-string 2))
9031 (throw 'match t)))
9032 (save-excursion
9034 (setq type "tags"
9035 path (match-string 1))
9036 (while (string-match ":" path)
9037 (setq path (replace-match "+" t t path)))
9038 (throw 'match t)))
9040 (setq type "tree-match"
9041 path (match-string 1))
9042 (throw 'match t)))
9043 (unless path
9044 (error "No link found"))
9046 ;; switch back to reference buffer
9047 ;; needed when if called in a temporary buffer through
9048 ;; org-open-link-from-string
9049 (with-current-buffer (or reference-buffer (current-buffer))
9051 ;; Remove any trailing spaces in path
9053 (setq path (replace-match "" t t path)))
9054 (if (and org-link-translation-function
9055 (fboundp org-link-translation-function))
9056 ;; Check if we need to translate the link
9057 (let ((tmp (funcall org-link-translation-function type path)))
9058 (setq type (car tmp) path (cdr tmp))))
9060 (cond
9062 ((assoc type org-link-protocols)
9063 (funcall (nth 1 (assoc type org-link-protocols)) path))
9065 ((equal type "mailto")
9066 (let ((cmd (car org-link-mailto-program))
9067 (args (cdr org-link-mailto-program)) args1
9068 (address path) (subject "") a)
9070 (setq address (match-string 1 path)
9071 subject (org-link-escape (match-string 2 path))))
9072 (while args
9073 (cond
9074 ((not (stringp (car args))) (push (pop args) args1))
9075 (t (setq a (pop args))
9076 (if (string-match "%a" a)
9077 (setq a (replace-match address t t a)))
9078 (if (string-match "%s" a)
9079 (setq a (replace-match subject t t a)))
9080 (push a args1))))
9081 (apply cmd (nreverse args1))))
9083 ((member type '("http" "https" "ftp" "news"))
9084 (browse-url (concat type ":" (org-link-escape
9085 path org-link-escape-chars-browser))))
9087 ((string= type "doi")
9088 (browse-url (concat "http://dx.doi.org/"
9089 (org-link-escape
9090 path org-link-escape-chars-browser))))
9092 ((member type '("message"))
9093 (browse-url (concat type ":" path)))
9095 ((string= type "tags")
9096 (org-tags-view in-emacs path))
9098 ((string= type "tree-match")
9101 ((string= type "file")
9103 (setq line (string-to-number (match-string 1 path))
9104 path (substring path 0 (match-beginning 0)))
9106 (setq search (match-string 1 path)
9107 path (substring path 0 (match-beginning 0)))))
9108 (if (string-match "[*?{]" (file-name-nondirectory path))
9109 (dired path)
9110 (org-open-file path in-emacs line search)))
9112 ((string= type "news")
9113 (require 'org-gnus)
9114 (org-gnus-follow-link path))
9116 ((string= type "shell")
9117 (let ((cmd path))
9118 (if (or (not org-confirm-shell-link-function)
9119 (funcall org-confirm-shell-link-function
9121 (org-add-props cmd nil
9122 'face 'org-warning))))
9123 (progn
9124 (message "Executing %s" cmd)
9125 (shell-command cmd))
9126 (error "Abort"))))
9128 ((string= type "elisp")
9129 (let ((cmd path))
9130 (if (or (not org-confirm-elisp-link-function)
9131 (funcall org-confirm-elisp-link-function
9133 (org-add-props cmd nil
9134 'face 'org-warning))))
9135 (message "%s => %s" cmd
9136 (if (equal (string-to-char cmd) ?\()
9137 (eval (read cmd))
9138 (call-interactively (read cmd))))
9139 (error "Abort"))))
9141 ((and (string= type "thisfile")
9142 (run-hook-with-args-until-success
9143 'org-open-link-functions path)))
9145 ((string= type "thisfile")
9146 (if in-emacs
9147 (switch-to-buffer-other-window
9148 (org-get-buffer-for-internal-link (current-buffer)))
9149 (org-mark-ring-push))
9150 (let ((cmd `(org-link-search
9151 ,path
9152 ,(cond ((equal in-emacs '(4)) 'occur)
9153 ((equal in-emacs '(16)) 'org-occur)
9154 (t nil))
9155 ,pos)))
9156 (condition-case nil (eval cmd)
9157 (error (progn (widen) (eval cmd))))))
9159 (t
9160 (browse-url-at-point)))))))
9161 (move-marker org-open-link-marker nil)
9162 (run-hook-with-args 'org-follow-link-hook)))
9164 (defun org-offer-links-in-entry (&optional nth zero)
9165 "Offer links in the current entry and follow the selected link.
9166 If there is only one link, follow it immediately as well.
9167 If NTH is an integer, immediately pick the NTH link found.
9168 If ZERO is a string, check also this string for a link, and if
9169 there is one, offer it as link number zero."
9173 (cnt ?0)
9174 (in-emacs (if (integerp nth) nil nth))
9175 have-zero end links link c)
9176 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9177 (push (match-string 0 zero) links)
9178 (setq cnt (1- cnt) have-zero t))
9179 (save-excursion
9180 (org-back-to-heading t)
9181 (setq end (save-excursion (outline-next-heading) (point)))
9182 (while (re-search-forward re end t)
9183 (push (match-string 0) links))
9184 (setq links (org-uniquify (reverse links))))
9186 (cond
9187 ((null links)
9188 (message "No links"))
9189 ((equal (length links) 1)
9190 (setq link (list (car links))))
9191 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9192 (setq link (nth (if have-zero nth (1- nth)) links)))
9193 (t ; we have to select a link
9194 (save-excursion
9195 (save-window-excursion
9196 (delete-other-windows)
9197 (with-output-to-temp-buffer "*Select Link*"
9198 (mapc (lambda (l)
9199 (if (not (string-match org-bracket-link-regexp l))
9201 (org-remove-angle-brackets l)))
9202 (if (match-end 3)
9204 (match-string 3 l) (match-string 1 l)))
9206 (match-string 1 l))))))
9207 links))
9208 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9209 (message "Select link to open, RET to open all:")
9210 (setq c (read-char-exclusive))
9211 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9212 (when (equal c ?q) (error "Abort"))
9213 (if (equal c ?\C-m)
9214 (setq link links)
9215 (setq nth (- c ?0))
9216 (if have-zero (setq nth (1+ nth)))
9217 (unless (and (integerp nth) (>= (length links) nth))
9218 (error "Invalid link selection"))
9219 (setq link (list (nth (1- nth) links))))))
9220 (if link
9221 (let ((buf (current-buffer)))
9222 (dolist (l link)
9223 (org-open-link-from-string l in-emacs buf))
9224 t)
9225 nil)))
9227 ;; Add special file links that specify the way of opening
9229 (org-add-link-type "file+sys" 'org-open-file-with-system)
9230 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9231 (defun org-open-file-with-system (path)
9232 "Open file at PATH using the system way of opening it."
9233 (org-open-file path 'system))
9234 (defun org-open-file-with-emacs (path)
9235 "Open file at PATH in Emacs."
9236 (org-open-file path 'emacs))
9237 (defun org-remove-file-link-modifiers ()
9238 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9239 (goto-char (point-min))
9241 (org-if-unprotected
9242 (replace-match "file:" t t))))
9243 (eval-after-load "org-exp"
9244 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9245 'org-remove-file-link-modifiers))
9247 ;;;; Time estimates
9249 (defun org-get-effort (&optional pom)
9250 "Get the effort estimate for the current entry."
9251 (org-entry-get pom org-effort-property))
9253 ;;; File search
9255 (defvar org-create-file-search-functions nil
9256 "List of functions to construct the right search string for a file link.
9257 These functions are called in turn with point at the location to
9258 which the link should point.
9260 A function in the hook should first test if it would like to
9261 handle this file type, for example by checking the `major-mode'
9262 or the file extension. If it decides not to handle this file, it
9263 should just return nil to give other functions a chance. If it
9264 does handle the file, it must return the search string to be used
9265 when following the link. The search string will be part of the
9266 file link, given after a double colon, and `org-open-at-point'
9267 will automatically search for it. If special measures must be
9268 taken to make the search successful, another function should be
9269 added to the companion hook `org-execute-file-search-functions',
9270 which see.
9272 A function in this hook may also use `setq' to set the variable
9273 `description' to provide a suggestion for the descriptive text to
9274 be used for this link when it gets inserted into an Org-mode
9277 (defvar org-execute-file-search-functions nil
9278 "List of functions to execute a file search triggered by a link.
9280 Functions added to this hook must accept a single argument, the
9281 search string that was part of the file link, the part after the
9282 double colon. The function must first check if it would like to
9283 handle this search, for example by checking the `major-mode' or
9284 the file extension. If it decides not to handle this search, it
9285 should just return nil to give other functions a chance. If it
9286 does handle the search, it must return a non-nil value to keep
9287 other functions from trying.
9289 Each function can access the current prefix argument through the
9290 variable `current-prefix-argument'. Note that a single prefix is
9291 used to force opening a link in Emacs, so it may be good to only
9292 use a numeric or double prefix to guide the search function.
9294 In case this is needed, a function in this hook can also restore
9295 the window configuration before `org-open-at-point' was called using:
9297 (set-window-configuration org-window-config-before-follow-link)")
9299 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9300 (defun org-link-search (s &optional type avoid-pos)
9301 "Search for a link search option.
9302 If S is surrounded by forward slashes, it is interpreted as a
9303 regular expression. In org-mode files, this will create an `org-occur'
9304 sparse tree. In ordinary files, `occur' will be used to list matches.
9305 If the current buffer is in `dired-mode', grep will be used to search
9306 in all files. If AVOID-POS is given, ignore matches near that position."
9307 (let ((case-fold-search t)
9311 org-emphasis-alist)
9313 (pos (point))
9314 (pre nil) (post nil)
9315 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9316 (cond
9317 ;; First check if there are any special search functions
9318 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9319 ;; Now try the builtin stuff
9320 ((and (equal (string-to-char s0) ?#)
9321 (> (length s0) 1)
9322 (save-excursion
9323 (goto-char (point-min))
9324 (and
9325 (re-search-forward
9327 (setq type 'dedicated
9328 pos (match-beginning 0))))
9329 ;; There is an exact target for this
9330 (goto-char pos)
9331 (org-back-to-heading t)))
9332 ((save-excursion
9333 (goto-char (point-min))
9334 (and
9335 (re-search-forward
9336 (concat "<<" (regexp-quote s0) ">>") nil t)
9337 (setq type 'dedicated
9338 pos (match-beginning 0))))
9339 ;; There is an exact target for this
9340 (goto-char pos))
9342 (save-excursion
9343 (goto-char (point-min))
9344 (and
9345 (re-search-forward
9346 (concat "[^[]" (regexp-quote
9347 (format org-coderef-label-format
9348 (match-string 1 s0))))
9349 nil t)
9350 (setq type 'dedicated
9351 pos (1+ (match-beginning 0))))))
9352 ;; There is a coderef target for this
9353 (goto-char pos))
9355 ;; A regular expression
9356 (cond
9357 ((org-mode-p)
9358 (org-occur (match-string 1 s)))
9359 ;;((eq major-mode 'dired-mode)
9360 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9361 (t (org-do-occur (match-string 1 s)))))
9362 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9363 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9364 (goto-char (point-min))
9365 (cond
9366 ((let (case-fold-search)
9367 (re-search-forward (format org-complex-heading-regexp-format
9368 (regexp-quote s))
9369 nil t))
9370 ;; OK, found a match
9371 (goto-char (match-beginning 0)))
9372 ((and (not org-link-search-inhibit-query)
9373 (eq org-link-search-must-match-exact-headline 'query-to-create)
9374 (y-or-n-p "No match - create this as a new heading? "))
9375 (goto-char (point-max))
9376 (or (bolp) (newline))
9378 (beginning-of-line 0))
9379 (t
9380 (goto-char pos)
9381 (error "No match"))))
9382 (t
9383 ;; A normal search string
9384 (when (equal (string-to-char s) ?*)
9385 ;; Anchor on headlines, post may include tags.
9388 s (substring s 1)))
9389 (remove-text-properties
9390 0 (length s)
9391 '(face nil mouse-face nil keymap nil fontified nil) s)
9392 ;; Make a series of regular expressions to find a match
9401 re4 (concat "[^a-zA-Z_]" re4_)
9403 re1 (concat pre re2 post)
9404 re3 (concat pre (if pre re4_ re4) post)
9405 re5 (concat pre ".*" re4)
9406 re2 (concat pre re2)
9407 re2a (concat pre (if pre re2a_ re2a))
9408 re4 (concat pre (if pre re4_ re4))
9412 ))
9413 (cond
9414 ((eq type 'org-occur) (org-occur reall))
9415 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9416 (t (goto-char (point-min))
9417 (setq type 'fuzzy)
9418 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9419 (org-search-not-self 1 re1 nil t)
9420 (org-search-not-self 1 re2 nil t)
9421 (org-search-not-self 1 re2a nil t)
9422 (org-search-not-self 1 re3 nil t)
9423 (org-search-not-self 1 re4 nil t)
9424 (org-search-not-self 1 re5 nil t)
9425 )
9426 (goto-char (match-beginning 1))
9427 (goto-char pos)
9428 (error "No match"))))))
9429 (and (org-mode-p) (org-show-context 'link-search))
9430 type))
9432 (defun org-search-not-self (group &rest args)
9433 "Execute `re-search-forward', but only accept matches that do not
9434 enclose the position of `org-open-link-marker'."
9435 (let ((m org-open-link-marker))
9436 (catch 'exit
9437 (while (apply 're-search-forward args)
9438 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9439 (goto-char (match-end group))
9440 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9441 (> (match-beginning 0) (marker-position m))
9442 (< (match-end 0) (marker-position m)))
9443 (save-match-data
9444 (or (not (org-in-regexp
9445 org-bracket-link-analytic-regexp 1))
9446 (not (match-end 4)) ; no description
9447 (and (<= (match-beginning 4) (point))
9448 (>= (match-end 4) (point))))))
9449 (throw 'exit (point))))))))
9451 (defun org-get-buffer-for-internal-link (buffer)
9452 "Return a buffer to be used for displaying the link target of internal links."
9453 (cond
9454 ((not org-display-internal-link-with-indirect-buffer)
9455 buffer)
9456 ((string-match "(Clone)$" (buffer-name buffer))
9457 (message "Buffer is already a clone, not making another one")
9458 ;; we also do not modify visibility in this case
9459 buffer)
9460 (t ; make a new indirect buffer for displaying the link
9461 (let* ((bn (buffer-name buffer))
9462 (ibn (concat bn "(Clone)"))
9463 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9464 (with-current-buffer ib (org-overview))
9465 ib))))
9467 (defun org-do-occur (regexp &optional cleanup)
9468 "Call the Emacs command `occur'.
9469 If CLEANUP is non-nil, remove the printout of the regular expression
9470 in the *Occur* buffer. This is useful if the regex is long and not useful
9471 to read."
9472 (occur regexp)
9473 (when cleanup
9474 (let ((cwin (selected-window)) win beg end)
9475 (when (setq win (get-buffer-window "*Occur*"))
9476 (select-window win))
9477 (goto-char (point-min))
9478 (when (re-search-forward "match[a-z]+" nil t)
9479 (setq beg (match-end 0))
9481 (setq end (1- (match-beginning 0)))))
9482 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9483 (goto-char (point-min))
9484 (select-window cwin))))
9486 ;;; The mark ring for links jumps
9488 (defvar org-mark-ring nil
9489 "Mark ring for positions before jumps in Org-mode.")
9490 (defvar org-mark-ring-last-goto nil
9491 "Last position in the mark ring used to go back.")
9492 ;; Fill and close the ring
9493 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9494 (loop for i from 1 to org-mark-ring-length do
9495 (push (make-marker) org-mark-ring))
9496 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9497 org-mark-ring)
9499 (defun org-mark-ring-push (&optional pos buffer)
9500 "Put the current position or POS into the mark ring and rotate it."
9501 (interactive)
9502 (setq pos (or pos (point)))
9503 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9504 (move-marker (car org-mark-ring)
9505 (or pos (point))
9506 (or buffer (current-buffer)))
9507 (message "%s"
9508 (substitute-command-keys
9511 (defun org-mark-ring-goto (&optional n)
9512 "Jump to the previous position in the mark ring.
9513 With prefix arg N, jump back that many stored positions. When
9514 called several times in succession, walk through the entire ring.
9515 Org-mode commands jumping to a different position in the current file,
9516 or to another Org-mode file, automatically push the old position
9517 onto the ring."
9518 (interactive "p")
9519 (let (p m)
9520 (if (eq last-command this-command)
9521 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9522 (setq p org-mark-ring))
9523 (setq org-mark-ring-last-goto p)
9524 (setq m (car p))
9525 (switch-to-buffer (marker-buffer m))
9526 (goto-char m)
9527 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9529 (defun org-remove-angle-brackets (s)
9530 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9531 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9532 s)
9533 (defun org-add-angle-brackets (s)
9534 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9535 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9536 s)
9537 (defun org-remove-double-quotes (s)
9540 s)
9542 ;;; Following specific links
9544 (defun org-follow-timestamp-link ()
9545 (cond
9546 ((org-at-date-range-p t)
9547 (let ((org-agenda-start-on-weekday)
9548 (t1 (match-string 1))
9549 (t2 (match-string 2)))
9550 (setq t1 (time-to-days (org-time-string-to-time t1))
9551 t2 (time-to-days (org-time-string-to-time t2)))
9552 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9553 ((org-at-timestamp-p t)
9554 (org-agenda-list nil (time-to-days (org-time-string-to-time
9555 (substring (match-string 1) 0 10)))
9556 1))
9557 (t (error "This should not happen"))))
9560 ;;; Following file links
9561 (defvar org-wait nil)
9562 (defun org-open-file (path &optional in-emacs line search)
9563 "Open the file at PATH.
9564 First, this expands any special file name abbreviations. Then the
9565 configuration variable `org-file-apps' is checked if it contains an
9566 entry for this file type, and if yes, the corresponding command is launched.
9568 If no application is found, Emacs simply visits the file.
9570 With optional prefix argument IN-EMACS, Emacs will visit the file.
9572 prefix arg, Org tries to avoid opening in Emacs
9573 and to use an external application to visit the file.
9575 Optional LINE specifies a line to go to, optional SEARCH a string
9576 to search for. If LINE or SEARCH is given, the file will be
9577 opened in Emacs, unless an entry from org-file-apps that makes
9578 use of groups in a regexp matches.
9579 If the file does not exist, an error is thrown."
9580 (let* ((file (if (equal path "")
9581 buffer-file-name
9582 (substitute-in-file-name (expand-file-name path))))
9583 (file-apps (append org-file-apps (org-default-apps)))
9584 (apps (org-remove-if
9585 'org-file-apps-entry-match-against-dlink-p file-apps))
9586 (apps-dlink (org-remove-if-not
9587 'org-file-apps-entry-match-against-dlink-p file-apps))
9588 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9589 (dirp (if remp nil (file-directory-p file)))
9590 (file (if (and dirp org-open-directory-means-index-dot-org)
9591 (concat (file-name-as-directory file) "index.org")
9592 file))
9593 (a-m-a-p (assq 'auto-mode apps))
9594 (dfile (downcase file))
9595 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9596 (link (cond ((and (eq line nil)
9597 (eq search nil))
9598 file)
9599 (line
9600 (concat file "::" (number-to-string line)))
9601 (search
9602 (concat file "::" search))))
9603 (dlink (downcase link))
9604 (old-buffer (current-buffer))
9605 (old-pos (point))
9606 (old-mode major-mode)
9607 ext cmd link-match-data)
9609 (setq ext (match-string 1 dfile))
9611 (setq ext (match-string 1 dfile))))
9612 (cond
9613 ((member in-emacs '((16) system))
9614 (setq cmd (cdr (assoc 'system apps))))
9615 (in-emacs (setq cmd 'emacs))
9616 (t
9617 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9618 (and dirp (cdr (assoc 'directory apps)))
9619 ; first, try matching against apps-dlink
9620 ; if we get a match here, store the match data for later
9621 (let ((match (assoc-default dlink apps-dlink
9622 'string-match)))
9623 (if match
9624 (progn (setq link-match-data (match-data))
9625 match)
9626 (progn (setq in-emacs (or in-emacs line search))
9627 nil))) ; if we have no match in apps-dlink,
9628 ; always open the file in emacs if line or search
9629 ; is given (for backwards compatibility)
9630 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9631 'string-match)
9632 (cdr (assoc ext apps))
9633 (cdr (assoc t apps))))))
9634 (when (eq cmd 'system)
9635 (setq cmd (cdr (assoc 'system apps))))
9636 (when (eq cmd 'default)
9637 (setq cmd (cdr (assoc t apps))))
9638 (when (eq cmd 'mailcap)
9639 (require 'mailcap)
9640 (mailcap-parse-mailcaps)
9641 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9642 (command (mailcap-mime-info mime-type)))
9643 (if (stringp command)
9644 (setq cmd command)
9645 (setq cmd 'emacs))))
9646 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9647 (not (file-exists-p file))
9648 (not org-open-non-existing-files))
9649 (error "No such file: %s" file))
9650 (cond
9652 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9654 (setq cmd (replace-match "%s" t t cmd)))
9655 (while (string-match "%s" cmd)
9656 (setq cmd (replace-match
9657 (save-match-data
9658 (shell-quote-argument
9659 (convert-standard-filename file)))
9660 t t cmd)))
9662 ;; Replace "%1", "%2" etc. in command with group matches from regex
9663 (save-match-data
9664 (let ((match-index 1)
9665 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9666 (set-match-data link-match-data)
9667 (while (<= match-index number-of-groups)
9668 (let ((regex (concat "%" (number-to-string match-index)))
9669 (replace-with (match-string match-index dlink)))
9670 (while (string-match regex cmd)
9671 (setq cmd (replace-match replace-with t t cmd))))
9672 (setq match-index (+ match-index 1)))))
9674 (save-window-excursion
9675 (start-process-shell-command cmd nil cmd)
9676 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9677 ))
9678 ((or (stringp cmd)
9679 (eq cmd 'emacs))
9680 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9681 (widen)
9682 (if line (org-goto-line line)
9683 (if search (org-link-search search))))
9684 ((consp cmd)
9685 (let ((file (convert-standard-filename file)))
9686 (save-match-data
9687 (set-match-data link-match-data)
9688 (eval cmd))))
9689 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9690 (and (org-mode-p) (eq old-mode 'org-mode)
9691 (or (not (equal old-buffer (current-buffer)))
9692 (not (equal old-pos (point))))
9693 (org-mark-ring-push old-pos old-buffer))))
9695 (defun org-file-apps-entry-match-against-dlink-p (entry)
9696 "This function returns non-nil if `entry' uses a regular
9697 expression which should be matched against the whole link by
9698 org-open-file.
9700 It assumes that is the case when the entry uses a regular
9701 expression which has at least one grouping construct and the
9702 action is either a lisp form or a command string containing
9703 '%1', i.e. using at least one subexpression match as a
9704 parameter."
9705 (let ((selector (car entry))
9706 (action (cdr entry)))
9707 (if (stringp selector)
9708 (and (> (regexp-opt-depth selector) 0)
9709 (or (and (stringp action)
9710 (string-match "%[0-9]" action))
9711 (consp action)))
9712 nil)))
9714 (defun org-default-apps ()
9715 "Return the default applications for this operating system."
9716 (cond
9717 ((eq system-type 'darwin)
9718 org-file-apps-defaults-macosx)
9719 ((eq system-type 'windows-nt)
9720 org-file-apps-defaults-windowsnt)
9721 (t org-file-apps-defaults-gnu)))
9723 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9724 "Convert extensions to regular expressions in the cars of LIST.
9725 Also, weed out any non-string entries, because the return value is used
9726 only for regexp matching.
9727 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9728 point to the symbol `emacs', indicating that the file should
9729 be opened in Emacs."
9730 (append
9731 (delq nil
9732 (mapcar (lambda (x)
9733 (if (not (stringp (car x)))
9734 nil
9736 x
9738 list))
9739 (if add-auto-mode
9740 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9742 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9743 (defun org-file-remote-p (file)
9744 "Test whether FILE specifies a location on a remote system.
9745 Return non-nil if the location is indeed remote.
9749 (cond ((fboundp 'file-remote-p)
9750 (file-remote-p file))
9751 ((fboundp 'tramp-handle-file-remote-p)
9752 (tramp-handle-file-remote-p file))
9753 ((and (boundp 'ange-ftp-name-format)
9754 (string-match (car ange-ftp-name-format) file))
9755 t)
9756 (t nil)))
9759 ;;;; Refiling
9761 (defun org-get-org-file ()
9762 "Read a filename, with default directory `org-directory'."
9763 (let ((default (or org-default-notes-file remember-data-file)))
9764 (read-file-name (format "File name [%s]: " default)
9765 (file-name-as-directory org-directory)
9766 default)))
9768 (defun org-notes-order-reversed-p ()
9769 "Check if the current file should receive notes in reversed order."
9770 (cond
9771 ((not org-reverse-note-order) nil)
9772 ((eq t org-reverse-note-order) t)
9773 ((not (listp org-reverse-note-order)) nil)
9774 (t (catch 'exit
9775 (let ((all org-reverse-note-order)
9776 entry)
9777 (while (setq entry (pop all))
9778 (if (string-match (car entry) buffer-file-name)
9779 (throw 'exit (cdr entry))))
9780 nil)))))
9782 (defvar org-refile-target-table nil
9783 "The list of refile targets, created by `org-refile'.")
9785 (defvar org-agenda-new-buffers nil
9786 "Buffers created to visit agenda files.")
9788 (defvar org-refile-cache nil
9789 "Cache for refile targets.")
9792 (defvar org-refile-markers nil
9793 "All the markers used for caching refile locations.")
9795 (defun org-refile-marker (pos)
9796 "Get a new refile marker, but only if caching is in use."
9797 (if (not org-refile-use-cache)
9798 pos
9799 (let ((m (make-marker)))
9800 (move-marker m pos)
9801 (push m org-refile-markers)
9802 m)))
9804 (defun org-refile-cache-clear ()
9805 "Clear the refile cache and disable all the markers."
9806 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9807 (setq org-refile-markers nil)
9808 (setq org-refile-cache nil)
9809 (message "Refile cache has been cleared"))
9811 (defun org-refile-cache-check-set (set)
9812 "Check if all the markers in the cache still have live buffers."
9813 (let (marker)
9814 (catch 'exit
9815 (while (and set (setq marker (nth 3 (pop set))))
9816 ;; if org-refile-use-outline-path is 'file, marker may be nil
9817 (when (and marker (null (marker-buffer marker)))
9818 (message "not found") (sit-for 3)
9819 (throw 'exit nil)))
9820 t)))
9822 (defun org-refile-cache-put (set &rest identifiers)
9823 "Push the refile targets SET into the cache, under IDENTIFIERS."
9824 (let* ((key (sha1 (prin1-to-string identifiers)))
9825 (entry (assoc key org-refile-cache)))
9826 (if entry
9827 (setcdr entry set)
9828 (push (cons key set) org-refile-cache))))
9830 (defun org-refile-cache-get (&rest identifiers)
9831 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9832 (cond
9833 ((not org-refile-cache) nil)
9834 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9835 (t
9836 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9837 org-refile-cache))))
9838 (and set (org-refile-cache-check-set set) set)))))
9840 (defun org-get-refile-targets (&optional default-buffer)
9841 "Produce a table with refile targets."
9842 (let ((case-fold-search nil)
9843 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9844 (entries (or org-refile-targets '((nil . (:level . 1)))))
9845 targets tgs txt re files f desc descre fast-path-p level pos0)
9846 (message "Getting targets...")
9847 (with-current-buffer (or default-buffer (current-buffer))
9848 (while (setq entry (pop entries))
9849 (setq files (car entry) desc (cdr entry))
9850 (setq fast-path-p nil)
9851 (cond
9852 ((null files) (setq files (list (current-buffer))))
9853 ((eq files 'org-agenda-files)
9854 (setq files (org-agenda-files 'unrestricted)))
9855 ((and (symbolp files) (fboundp files))
9856 (setq files (funcall files)))
9857 ((and (symbolp files) (boundp files))
9858 (setq files (symbol-value files))))
9859 (if (stringp files) (setq files (list files)))
9860 (cond
9861 ((eq (car desc) :tag)
9863 ((eq (car desc) :todo)
9865 ((eq (car desc) :regexp)
9866 (setq descre (cdr desc)))
9867 ((eq (car desc) :level)
9869 (if org-odd-levels-only
9870 (1- (* 2 (cdr desc)))
9871 (cdr desc)))
9873 ((eq (car desc) :maxlevel)
9874 (setq fast-path-p t)
9876 (if org-odd-levels-only
9877 (1- (* 2 (cdr desc)))
9878 (cdr desc)))
9880 (t (error "Bad refiling target description %s" desc)))
9881 (while (setq f (pop files))
9882 (with-current-buffer
9883 (if (bufferp f) f (org-get-agenda-file-buffer f))
9884 (or
9885 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9886 (progn
9887 (if (bufferp f) (setq f (buffer-file-name
9888 (buffer-base-buffer f))))
9889 (setq f (and f (expand-file-name f)))
9890 (if (eq org-refile-use-outline-path 'file)
9891 (push (list (file-name-nondirectory f) f nil nil) tgs))
9892 (save-excursion
9893 (save-restriction
9894 (widen)
9895 (goto-char (point-min))
9896 (while (re-search-forward descre nil t)
9897 (goto-char (setq pos0 (point-at-bol)))
9898 (catch 'next
9899 (when org-refile-target-verify-function
9900 (save-match-data
9901 (or (funcall org-refile-target-verify-function)
9902 (throw 'next t))))
9903 (when (looking-at org-complex-heading-regexp)
9904 (setq level (org-reduced-level
9905 (- (match-end 1) (match-beginning 1)))
9906 txt (org-link-display-format (match-string 4))
9908 re (format org-complex-heading-regexp-format
9909 (regexp-quote (match-string 4))))
9910 (when org-refile-use-outline-path
9911 (setq txt (mapconcat
9912 'org-protect-slash
9913 (append
9914 (if (eq org-refile-use-outline-path
9915 'file)
9916 (list (file-name-nondirectory
9917 (buffer-file-name
9918 (buffer-base-buffer))))
9919 (if (eq org-refile-use-outline-path
9920 'full-file-path)
9921 (list (buffer-file-name
9922 (buffer-base-buffer)))))
9923 (org-get-outline-path fast-path-p
9924 level txt)
9925 (list txt))
9926 "/")))
9927 (push (list txt f re (org-refile-marker (point)))
9928 tgs)))
9929 (when (= (point) pos0)
9930 ;; verification function has not moved point
9931 (goto-char (point-at-eol))))))))
9932 (when org-refile-use-cache
9933 (org-refile-cache-put tgs (buffer-file-name) descre))
9934 (setq targets (append tgs targets))
9935 ))))
9936 (message "Getting targets...done")
9937 (nreverse targets)))
9939 (defun org-protect-slash (s)
9940 (while (string-match "/" s)
9942 s)
9944 (defvar org-olpa (make-vector 20 nil))
9946 (defun org-get-outline-path (&optional fastp level heading)
9947 "Return the outline path to the current entry, as a list.
9949 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
9950 routine which makes outline path derivations for an entire file,
9951 avoiding backtracing. Refile target collection makes use of that."
9952 (if fastp
9953 (progn
9954 (if (> level 19)
9955 (error "Outline path failure, more than 19 levels"))
9956 (loop for i from level upto 19 do
9957 (aset org-olpa i nil))
9958 (prog1
9959 (delq nil (append org-olpa nil))
9960 (aset org-olpa level heading)))
9961 (let (rtn case-fold-search)
9962 (save-excursion
9963 (save-restriction
9964 (widen)
9965 (while (org-up-heading-safe)
9966 (when (looking-at org-complex-heading-regexp)
9967 (push (org-match-string-no-properties 4) rtn)))
9968 rtn)))))
9970 (defun org-format-outline-path (path &optional width prefix)
9971 "Format the outline path PATH for display.
9972 Width is the maximum number of characters that is available.
9973 Prefix is a prefix to be included in the returned string,
9974 such as the file name."
9975 (setq width (or width 79))
9976 (if prefix (setq width (- width (length prefix))))
9977 (if (not path)
9978 (or prefix "")
9979 (let* ((nsteps (length path))
9980 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
9981 (maxwidth (if (<= total-width width)
9982 10000 ;; everything fits
9983 ;; we need to shorten the level headings
9984 (/ (- width nsteps) nsteps)))
9985 (org-odd-levels-only nil)
9986 (n 0)
9987 (total (1+ (length prefix))))
9988 (setq maxwidth (max maxwidth 10))
9989 (concat prefix
9990 (mapconcat
9991 (lambda (h)
9992 (setq n (1+ n))
9993 (if (and (= n nsteps) (< maxwidth 10000))
9994 (setq maxwidth (- total-width total)))
9995 (if (< (length h) maxwidth)
9996 (progn (setq total (+ total (length h) 1)) h)
9997 (setq h (substring h 0 (- maxwidth 2))
9998 total (+ total maxwidth 1))
10000 (setq h (substring h 0 (match-beginning 0))))
10001 (setq h (concat h "..")))
10002 (org-add-props h nil 'face
10003 (nth (% (1- n) org-n-level-faces)
10004 org-level-faces))
10005 h)
10006 path "/")))))
10008 (defun org-display-outline-path (&optional file current)
10009 "Display the current outline path in the echo area."
10010 (interactive "P")
10011 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10012 (case-fold-search nil)
10013 (path (and (org-mode-p) (org-get-outline-path))))
10014 (if current (setq path (append path
10015 (save-excursion
10016 (org-back-to-heading t)
10017 (if (looking-at org-complex-heading-regexp)
10018 (list (match-string 4)))))))
10019 (message "%s"
10020 (org-format-outline-path
10021 path
10022 (1- (frame-width))
10023 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10025 (defvar org-refile-history nil
10026 "History for refiling operations.")
10028 (defvar org-after-refile-insert-hook nil
10029 "Hook run after `org-refile' has inserted its stuff at the new location.
10030 Note that this is still *before* the stuff will be removed from
10031 the *old* location.")
10033 (defvar org-capture-last-stored-marker)
10034 (defun org-refile (&optional goto default-buffer rfloc)
10035 "Move the entry at point to another heading.
10036 The list of target headings is compiled using the information in
10037 `org-refile-targets', which see. This list is created before each use
10038 and will therefore always be up-to-date.
10040 At the target location, the entry is filed as a subitem of the target heading.
10041 Depending on `org-reverse-note-order', the new subitem will either be the
10042 first or the last subitem.
10044 If there is an active region, all entries in that region will be moved.
10045 However, the region must fulfill the requirement that the first heading
10046 is the first one sets the top-level of the moved text - at most siblings
10047 below it are allowed.
10049 With prefix arg GOTO, the command will only visit the target location,
10050 not actually move anything.
10052 go to the location where the last refiling
10053 operation has put the subtree.
10054 With a prefix argument of `2', refile to the running clock.
10056 RFLOC can be a refile location obtained in a different way.
10058 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10060 If you are using target caching (see `org-refile-use-cache'),
10061 You have to clear the target cache in order to find new targets.
10062 This can be done with a 0 prefix: `C-0 C-c C-w'"
10063 (interactive "P")
10064 (if (member goto '(0 (64)))
10065 (org-refile-cache-clear)
10066 (let* ((cbuf (current-buffer))
10067 (regionp (org-region-active-p))
10068 (region-start (and regionp (region-beginning)))
10069 (region-end (and regionp (region-end)))
10070 (region-length (and regionp (- region-end region-start)))
10071 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10072 pos it nbuf file re level reversed)
10073 (setq last-command nil)
10074 (when regionp
10075 (goto-char region-start)
10076 (or (bolp) (goto-char (point-at-bol)))
10077 (setq region-start (point))
10078 (unless (org-kill-is-subtree-p
10079 (buffer-substring region-start region-end))
10080 (error "The region is not a (sequence of) subtree(s)")))
10081 (if (equal goto '(16))
10082 (org-refile-goto-last-stored)
10083 (when (or
10084 (and (equal goto 2)
10085 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10086 (prog1
10087 (setq it (list (or org-clock-heading "running clock")
10088 (buffer-file-name
10089 (marker-buffer org-clock-hd-marker))
10090 ""
10091 (marker-position org-clock-hd-marker)))
10092 (setq goto nil)))
10093 (setq it (or rfloc
10094 (save-excursion
10095 (org-refile-get-location
10096 (if goto "Goto: " "Refile to: ") default-buffer
10097 org-refile-allow-creating-parent-nodes)))))
10098 (setq file (nth 1 it)
10099 re (nth 2 it)
10100 pos (nth 3 it))
10101 (if (and (not goto)
10102 pos
10103 (equal (buffer-file-name) file)
10104 (if regionp
10105 (and (>= pos region-start)
10106 (<= pos region-end))
10107 (and (>= pos (point))
10108 (< pos (save-excursion
10109 (org-end-of-subtree t t))))))
10110 (error "Cannot refile to position inside the tree or region"))
10112 (setq nbuf (or (find-buffer-visiting file)
10113 (find-file-noselect file)))
10114 (if goto
10115 (progn
10116 (switch-to-buffer nbuf)
10117 (goto-char pos)
10118 (org-show-context 'org-goto))
10119 (if regionp
10120 (progn
10121 (org-kill-new (buffer-substring region-start region-end))
10122 (org-save-markers-in-region region-start region-end))
10123 (org-copy-subtree 1 nil t))
10124 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10125 (find-file-noselect file)))
10126 (setq reversed (org-notes-order-reversed-p))
10127 (save-excursion
10128 (save-restriction
10129 (widen)
10130 (if pos
10131 (progn
10132 (goto-char pos)
10133 (looking-at outline-regexp)
10134 (setq level (org-get-valid-level (funcall outline-level) 1))
10135 (goto-char
10136 (if reversed
10137 (or (outline-next-heading) (point-max))
10138 (or (save-excursion (org-get-next-sibling))
10139 (org-end-of-subtree t t)
10140 (point-max)))))
10141 (setq level 1)
10142 (if (not reversed)
10143 (goto-char (point-max))
10144 (goto-char (point-min))
10145 (or (outline-next-heading) (goto-char (point-max)))))
10146 (if (not (bolp)) (newline))
10147 (org-paste-subtree level)
10148 (when org-log-refile
10149 (org-add-log-setup 'refile nil nil 'findpos
10150 org-log-refile)
10151 (unless (eq org-log-refile 'note)
10152 (save-excursion (org-add-log-note))))
10153 (and org-auto-align-tags (org-set-tags nil t))
10154 (bookmark-set "org-refile-last-stored")
10155 ;; If we are refiling for capture, make sure that the
10156 ;; last-capture pointers point here
10157 (when (org-bound-and-true-p org-refile-for-capture)
10158 (bookmark-set "org-capture-last-stored-marker")
10159 (move-marker org-capture-last-stored-marker (point)))
10160 (if (fboundp 'deactivate-mark) (deactivate-mark))
10161 (run-hooks 'org-after-refile-insert-hook))))
10162 (if regionp
10163 (delete-region (point) (+ (point) region-length))
10164 (org-cut-subtree))
10165 (when (featurep 'org-inlinetask)
10166 (org-inlinetask-remove-END-maybe))
10167 (setq org-markers-to-move nil)
10170 (defun org-refile-goto-last-stored ()
10171 "Go to the location where the last refile was stored."
10172 (interactive)
10173 (bookmark-jump "org-refile-last-stored")
10174 (message "This is the location of the last refile"))
10176 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10177 "Prompt the user for a refile location, using PROMPT."
10178 (let ((org-refile-targets org-refile-targets)
10179 (org-refile-use-outline-path org-refile-use-outline-path))
10180 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10181 (unless org-refile-target-table
10182 (error "No refile targets"))
10183 (let* ((cbuf (current-buffer))
10184 (partial-completion-mode nil)
10185 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10186 (cfunc (if (and org-refile-use-outline-path
10187 org-outline-path-complete-in-steps)
10188 'org-olpath-completing-read
10189 'org-icompleting-read))
10190 (extra (if org-refile-use-outline-path "/" ""))
10191 (filename (and cfn (expand-file-name cfn)))
10192 (tbl (mapcar
10193 (lambda (x)
10194 (if (and (not (member org-refile-use-outline-path
10195 '(file full-file-path)))
10196 (not (equal filename (nth 1 x))))
10197 (cons (concat (car x) extra " ("
10198 (file-name-nondirectory (nth 1 x)) ")")
10199 (cdr x))
10200 (cons (concat (car x) extra) (cdr x))))
10201 org-refile-target-table))
10202 (completion-ignore-case t)
10203 pa answ parent-target child parent old-hist)
10204 (setq old-hist org-refile-history)
10205 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10206 nil 'org-refile-history))
10207 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10208 (org-refile-check-position pa)
10209 (if pa
10210 (progn
10211 (when (or (not org-refile-history)
10212 (not (eq old-hist org-refile-history))
10213 (not (equal (car pa) (car org-refile-history))))
10214 (setq org-refile-history
10215 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10216 org-refile-history
10217 (cdr org-refile-history))))
10218 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10219 (pop org-refile-history)))
10220 pa)
10222 (progn
10223 (setq parent (match-string 1 answ)
10224 child (match-string 2 answ))
10225 (setq parent-target (or (assoc parent tbl)
10226 (assoc (concat parent "/") tbl)))
10227 (when (and parent-target
10228 (or (eq new-nodes t)
10229 (and (eq new-nodes 'confirm)
10231 child)))))
10232 (org-refile-new-child parent-target child)))
10233 (error "Invalid target location")))))
10235 (defun org-refile-check-position (refile-pointer)
10236 "Check if the refile pointer matches the readline to which it points."
10237 (let* ((file (nth 1 refile-pointer))
10238 (re (nth 2 refile-pointer))
10239 (pos (nth 3 refile-pointer))
10240 buffer)
10241 (when (org-string-nw-p re)
10242 (setq buffer (if (markerp pos)
10243 (marker-buffer pos)
10244 (or (find-buffer-visiting file)
10245 (find-file-noselect file))))
10246 (with-current-buffer buffer
10247 (save-excursion
10248 (save-restriction
10249 (widen)
10250 (goto-char pos)
10251 (beginning-of-line 1)
10252 (unless (org-looking-at-p re)
10253 (error "Invalid refile position, please rebuild the cache"))))))))
10255 (defun org-refile-new-child (parent-target child)
10256 "Use refile target PARENT-TARGET to add new CHILD below it."
10257 (unless parent-target
10258 (error "Cannot find parent for new node"))
10259 (let ((file (nth 1 parent-target))
10260 (pos (nth 3 parent-target))
10261 level)
10262 (with-current-buffer (or (find-buffer-visiting file)
10263 (find-file-noselect file))
10264 (save-excursion
10265 (save-restriction
10266 (widen)
10267 (if pos
10268 (goto-char pos)
10269 (goto-char (point-max))
10270 (if (not (bolp)) (newline)))
10271 (when (looking-at outline-regexp)
10272 (setq level (funcall outline-level))
10273 (org-end-of-subtree t t))
10274 (org-back-over-empty-lines)
10276 (if pos (org-get-valid-level level 1) 1) ?*)
10278 (beginning-of-line 0)
10279 (list (concat (car parent-target) "/" child) file "" (point)))))))
10281 (defun org-olpath-completing-read (prompt collection &rest args)
10282 "Read an outline path like a file name."
10283 (let ((thetable collection)
10284 (org-completion-use-ido nil) ; does not work with ido.
10285 (org-completion-use-iswitchb nil)) ; or iswitchb
10286 (apply
10287 'org-icompleting-read prompt
10288 (lambda (string predicate &optional flag)
10289 (let (rtn r f (l (length string)))
10290 (cond
10291 ((eq flag nil)
10292 ;; try completion
10293 (try-completion string thetable))
10294 ((eq flag t)
10295 ;; all-completions
10296 (setq rtn (all-completions string thetable predicate))
10297 (mapcar
10298 (lambda (x)
10299 (setq r (substring x l))
10300 (if (string-match " ([^)]*)$" x)
10301 (setq f (match-string 0 x))
10302 (setq f ""))
10303 (if (string-match "/" r)
10304 (concat string (substring r 0 (match-end 0)) f)
10305 x))
10306 rtn))
10307 ((eq flag 'lambda)
10308 ;; exact match?
10309 (assoc string thetable)))
10310 ))
10311 args)))
10313 ;;;; Dynamic blocks
10315 (defun org-find-dblock (name)
10316 "Find the first dynamic block with name NAME in the buffer.
10317 If not found, stay at current position and return nil."
10318 (let (pos)
10319 (save-excursion
10320 (goto-char (point-min))
10322 nil t)
10323 (match-beginning 0))))
10324 (if pos (goto-char pos))
10325 pos))
10327 (defconst org-dblock-start-re
10329 "Matches the start line of a dynamic block, with parameters.")
10332 "Matches the end of a dynamic block.")
10334 (defun org-create-dblock (plist)
10335 "Create a dynamic block section, with parameters taken from PLIST.
10336 PLIST must contain a :name entry which is used as name of the block."
10338 (end-of-line 1)
10339 (newline))
10340 (let ((col (current-column))
10341 (name (plist-get plist :name)))
10342 (insert "#+BEGIN: " name)
10343 (while plist
10344 (if (eq (car plist) :name)
10345 (setq plist (cddr plist))
10346 (insert " " (prin1-to-string (pop plist)))))
10348 (beginning-of-line -2)))
10350 (defun org-prepare-dblock ()
10351 "Prepare dynamic block for refresh.
10352 This empties the block, puts the cursor at the insert position and returns
10353 the property list including an extra property :name with the block name."
10354 (unless (looking-at org-dblock-start-re)
10355 (error "Not at a dynamic block"))
10356 (let* ((begdel (1+ (match-end 0)))
10357 (name (org-no-properties (match-string 1)))
10358 (params (append (list :name name)
10359 (read (concat "(" (match-string 3) ")")))))
10360 (save-excursion
10361 (beginning-of-line 1)
10363 (setq params (plist-put params :indentation-column (current-column))))
10364 (unless (re-search-forward org-dblock-end-re nil t)
10365 (error "Dynamic block not terminated"))
10366 (setq params
10367 (append params
10368 (list :content (buffer-substring
10369 begdel (match-beginning 0)))))
10370 (delete-region begdel (match-beginning 0))
10371 (goto-char begdel)
10372 (open-line 1)
10373 params))
10375 (defun org-map-dblocks (&optional command)
10376 "Apply COMMAND to all dynamic blocks in the current buffer.
10377 If COMMAND is not given, use `org-update-dblock'."
10378 (let ((cmd (or command 'org-update-dblock)))
10379 (save-excursion
10380 (goto-char (point-min))
10381 (while (re-search-forward org-dblock-start-re nil t)
10382 (goto-char (match-beginning 0))
10383 (save-excursion
10384 (condition-case nil
10385 (funcall cmd)
10386 (error (message "Error during update of dynamic block"))))
10387 (unless (re-search-forward org-dblock-end-re nil t)
10388 (error "Dynamic block not terminated"))))))
10390 (defun org-dblock-update (&optional arg)
10391 "User command for updating dynamic blocks.
10392 Update the dynamic block at point. With prefix ARG, update all dynamic
10393 blocks in the buffer."
10394 (interactive "P")
10395 (if arg
10396 (org-update-all-dblocks)
10397 (or (looking-at org-dblock-start-re)
10398 (org-beginning-of-dblock))
10399 (org-update-dblock)))
10401 (defun org-update-dblock ()
10402 "Update the dynamic block at point.
10403 This means to empty the block, parse for parameters and then call
10404 the correct writing function."
10405 (save-window-excursion
10406 (let* ((pos (point))
10407 (line (org-current-line))
10408 (params (org-prepare-dblock))
10409 (name (plist-get params :name))
10410 (indent (plist-get params :indentation-column))
10411 (cmd (intern (concat "org-dblock-write:" name))))
10412 (message "Updating dynamic block `%s' at line %d..." name line)
10413 (funcall cmd params)
10414 (message "Updating dynamic block `%s' at line %d...done" name line)
10415 (goto-char pos)
10416 (when (and indent (> indent 0))
10417 (setq indent (make-string indent ?\ ))
10418 (save-excursion
10419 (org-beginning-of-dblock)
10420 (forward-line 1)
10421 (while (not (looking-at org-dblock-end-re))
10422 (insert indent)
10423 (beginning-of-line 2))
10424 (when (looking-at org-dblock-end-re)
10426 (replace-match ""))
10427 (insert indent)))))))
10429 (defun org-beginning-of-dblock ()
10430 "Find the beginning of the dynamic block at point.
10431 Error if there is no such block at point."
10432 (let ((pos (point))
10433 beg)
10434 (end-of-line 1)
10435 (if (and (re-search-backward org-dblock-start-re nil t)
10436 (setq beg (match-beginning 0))
10437 (re-search-forward org-dblock-end-re nil t)
10438 (> (match-end 0) pos))
10439 (goto-char beg)
10440 (goto-char pos)
10441 (error "Not in a dynamic block"))))
10443 (defun org-update-all-dblocks ()
10444 "Update all dynamic blocks in the buffer.
10445 This function can be used in a hook."
10446 (when (org-mode-p)
10447 (org-map-dblocks 'org-update-dblock)))
10450 ;;;; Completion
10452 (defconst org-additional-option-like-keywords
10453 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
10454 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
10455 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10456 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
10457 "BEGIN:" "END:"
10458 "ORGTBL" "TBLFM:" "TBLNAME:"
10459 "BEGIN_EXAMPLE" "END_EXAMPLE"
10460 "BEGIN_QUOTE" "END_QUOTE"
10461 "BEGIN_VERSE" "END_VERSE"
10462 "BEGIN_CENTER" "END_CENTER"
10463 "BEGIN_SRC" "END_SRC"
10464 "CATEGORY" "COLUMNS"
10465 "CAPTION" "LABEL"
10466 "SETUPFILE"
10467 "BIND"
10468 "MACRO"))
10470 (defcustom org-structure-template-alist
10471 '(
10484 ("L" "#+latex: "
10488 ("H" "#+html: "
10491 ("A" "#+ascii: ")
10492 ("i" "#+include %file ?"
10494 )
10495 "Structure completion elements.
10496 This is a list of abbreviation keys and values. The value gets inserted
10497 if you type `<' followed by the key and then press the completion key,
10498 usually `M-TAB'. %file will be replaced by a file name after prompting
10499 for the file using completion.
10500 There are two templates for each key, the first uses the original Org syntax,
10501 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10502 the default when the /org-mtags.el/ module has been loaded. See also the
10503 variable `org-mtags-prefer-muse-templates'.
10504 This is an experimental feature, it is undecided if it is going to stay in."
10505 :group 'org-completion
10506 :type '(repeat
10507 (string :tag "Key")
10508 (string :tag "Template")
10509 (string :tag "Muse Template")))
10511 (defun org-try-structure-completion ()
10512 "Try to complete a structure template before point.
10514 expands them."
10515 (let ((l (buffer-substring (point-at-bol) (point)))
10516 a)
10519 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10520 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10521 (match-beginning 1)) a)
10522 t)))
10524 (defun org-complete-expand-structure-template (start cell)
10525 "Expand a structure template."
10526 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10527 (rpl (nth (if musep 2 1) cell))
10528 (ind ""))
10529 (delete-region start (point))
10531 (cond
10532 ((bolp))
10534 (setq ind (buffer-substring (point-at-bol) (point))))
10535 (t (newline))))
10536 (setq start (point))
10537 (if (string-match "%file" rpl)
10538 (setq rpl (replace-match
10539 (concat
10541 (save-match-data
10542 (abbreviate-file-name (read-file-name "Include file: ")))
10544 t t rpl)))
10547 (insert rpl)
10551 (defun org-complete (&optional arg)
10552 "Perform completion on word at point.
10553 At the beginning of a headline, this completes TODO keywords as given in
10554 `org-todo-keywords'.
10555 If the current word is preceded by a backslash, completes the TeX symbols
10556 that are supported for HTML support.
10558 setting file options.
10560 At all other locations, this simply calls the value of
10561 `org-completion-fallback-command'."
10562 (interactive "P")
10563 (org-without-partial-completion
10564 (catch 'exit
10565 (let* ((a nil)
10566 (end (point))
10567 (beg1 (save-excursion
10568 (skip-chars-backward (org-re "[:alnum:]_@#%"))
10569 (point)))
10570 (beg (save-excursion
10571 (skip-chars-backward "a-zA-Z0-9_:$")
10572 (point)))
10573 (confirm (lambda (x) (stringp (car x))))
10574 (searchhead (equal (char-before beg) ?*))
10575 (struct
10576 (when (and (member (char-before beg1) '(?. ?<))
10577 (setq a (assoc (buffer-substring beg1 (point))
10578 org-structure-template-alist)))
10579 (org-complete-expand-structure-template (1- beg1) a)
10580 (throw 'exit t)))
10581 (tag (and (equal (char-before beg1) ?:)
10582 (equal (char-after (point-at-bol)) ?*)))
10583 (prop (and (equal (char-before beg1) ?:)
10584 (not (equal (char-after (point-at-bol)) ?*))))
10586 (link (equal (char-before beg) ?\[))
10587 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10588 beg)
10589 "#+"))
10591 (buffer-substring (point-at-bol) (point))))
10592 (completion-ignore-case opt)
10593 (type nil)
10594 (tbl nil)
10595 (table (cond
10596 (opt
10597 (setq type :opt)
10598 (require 'org-exp)
10599 (append
10600 (delq nil
10601 (mapcar
10602 (lambda (x)
10603 (if (string-match
10605 (cons (match-string 2 x)
10606 (match-string 1 x))))
10608 (mapcar 'list org-additional-option-like-keywords)))
10609 (startup
10610 (setq type :startup)
10611 org-startup-options)
10612 (link (append org-link-abbrev-alist-local
10613 org-link-abbrev-alist))
10614 (texp
10615 (setq type :tex)
10616 (append org-entities-user org-entities))
10618 (buffer-substring (point-at-bol) beg))
10619 (setq type :todo)
10620 (mapcar 'list org-todo-keywords-1))
10621 (searchhead
10622 (setq type :searchhead)
10623 (save-excursion
10624 (goto-char (point-min))
10625 (while (re-search-forward org-todo-line-regexp nil t)
10626 (push (list
10627 (org-make-org-heading-search-string
10628 (match-string 3) t))
10629 tbl)))
10630 tbl)
10631 (tag (setq type :tag beg beg1)
10632 (or org-tag-alist (org-get-buffer-tags)))
10633 (prop (setq type :prop beg beg1)
10634 (mapcar 'list (org-buffer-property-keys nil t t)))
10635 (t (progn
10636 (call-interactively org-completion-fallback-command)
10637 (throw 'exit nil)))))
10638 (pattern (buffer-substring-no-properties beg end))
10639 (completion (try-completion pattern table confirm)))
10640 (cond ((eq completion t)
10641 (if (not (assoc (upcase pattern) table))
10642 (message "Already complete")
10643 (if (and (equal type :opt)
10644 (not (member (car (assoc (upcase pattern) table))
10645 org-additional-option-like-keywords)))
10646 (insert (substring (cdr (assoc (upcase pattern) table))
10647 (length pattern)))
10648 (if (memq type '(:tag :prop)) (insert ":")))))
10649 ((null completion)
10651 (ding))
10652 ((not (string= pattern completion))
10653 (delete-region beg end)
10654 (if (string-match " +$" completion)
10655 (setq completion (replace-match "" t t completion)))
10656 (insert completion)
10657 (if (get-buffer-window "*Completions*")
10658 (delete-window (get-buffer-window "*Completions*")))
10659 (if (assoc completion table)
10660 (if (eq type :todo) (insert " ")
10661 (if (memq type '(:tag :prop)) (insert ":"))))
10662 (if (and (equal type :opt) (assoc completion table))
10663 (message "%s" (substitute-command-keys
10665 (t
10666 (message "Making completion list...")
10667 (let ((list (sort (all-completions pattern table confirm)
10668 'string<)))
10669 (with-output-to-temp-buffer "*Completions*"
10670 (condition-case nil
10671 ;; Protection needed for XEmacs and emacs 21
10672 (display-completion-list list pattern)
10673 (error (display-completion-list list)))))
10674 (message "Making completion list...%s" "done")))))))
10676 ;;;; TODO, DEADLINE, Comments
10678 (defun org-toggle-comment ()
10679 "Change the COMMENT state of an entry."
10680 (interactive)
10681 (save-excursion
10682 (org-back-to-heading)
10683 (let (case-fold-search)
10684 (if (looking-at (concat outline-regexp
10686 (replace-match "" t t nil 1)
10687 (if (looking-at outline-regexp)
10688 (progn
10689 (goto-char (match-end 0))
10690 (insert org-comment-string " ")))))))
10692 (defvar org-last-todo-state-is-todo nil
10693 "This is non-nil when the last TODO state change led to a TODO state.
10694 If the last change removed the TODO tag or switched to DONE, then
10695 this is nil.")
10697 (defvar org-setting-tags nil) ; dynamically skipped
10699 (defvar org-todo-setup-filter-hook nil
10700 "Hook for functions that pre-filter todo specs.
10701 Each function takes a todo spec and returns either nil or the spec
10702 transformed into canonical form." )
10704 (defvar org-todo-get-default-hook nil
10705 "Hook for functions that get a default item for todo.
10706 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10707 nil or a string to be used for the todo mark." )
10709 (defvar org-agenda-headline-snapshot-before-repeat)
10711 (defun org-todo (&optional arg)
10712 "Change the TODO state of an item.
10713 The state of an item is given by a keyword at the start of the heading,
10714 like
10715 *** TODO Write paper
10716 *** DONE Call mom
10718 The different keywords are specified in the variable `org-todo-keywords'.
10720 So for this example: when the item starts with TODO, it is changed to DONE.
10721 When it starts with DONE, the DONE is removed. And when neither TODO nor
10722 DONE are present, add TODO at the beginning of the heading.
10725 state.
10726 With numeric prefix arg, switch to that state.
10728 keywords (nextset).
10731 For calling through lisp, arg is also interpreted in the following way:
10732 'none -> empty state
10734 'done -> switch to DONE
10735 'nextset -> switch to the next set of keywords
10736 'previousset -> switch to the previous set of keywords
10738 really is a member of `org-todo-keywords'."
10739 (interactive "P")
10740 (if (equal arg '(16)) (setq arg 'nextset))
10741 (let ((org-blocker-hook org-blocker-hook)
10742 (case-fold-search nil))
10743 (when (equal arg '(64))
10744 (setq arg nil org-blocker-hook nil))
10745 (when (and org-blocker-hook
10746 (or org-inhibit-blocking
10747 (org-entry-get nil "NOBLOCKING")))
10748 (setq org-blocker-hook nil))
10749 (save-excursion
10750 (catch 'exit
10751 (org-back-to-heading t)
10752 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10754 (looking-at " *"))
10755 (let* ((match-data (match-data))
10756 (startpos (point-at-bol))
10757 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10758 (org-log-done org-log-done)
10759 (org-log-repeat org-log-repeat)
10760 (org-todo-log-states org-todo-log-states)
10761 (this (match-string 1))
10762 (hl-pos (match-beginning 0))
10763 (head (org-get-todo-sequence-head this))
10764 (ass (assoc head org-todo-kwd-alist))
10765 (interpret (nth 1 ass))
10766 (done-word (nth 3 ass))
10767 (final-done-word (nth 4 ass))
10768 (last-state (or this ""))
10769 (completion-ignore-case t)
10770 (member (member this org-todo-keywords-1))
10771 (tail (cdr member))
10772 (state (cond
10773 ((and org-todo-key-trigger
10774 (or (and (equal arg '(4))
10775 (eq org-use-fast-todo-selection 'prefix))
10776 (and (not arg) org-use-fast-todo-selection
10777 (not (eq org-use-fast-todo-selection
10778 'prefix)))))
10779 ;; Use fast selection
10780 (org-fast-todo-selection))
10781 ((and (equal arg '(4))
10782 (or (not org-use-fast-todo-selection)
10783 (not org-todo-key-trigger)))
10784 ;; Read a state with completion
10785 (org-icompleting-read
10786 "State: " (mapcar (lambda(x) (list x))
10787 org-todo-keywords-1)
10788 nil t))
10789 ((eq arg 'right)
10790 (if this
10791 (if tail (car tail) nil)
10792 (car org-todo-keywords-1)))
10793 ((eq arg 'left)
10794 (if (equal member org-todo-keywords-1)
10795 nil
10796 (if this
10797 (nth (- (length org-todo-keywords-1)
10798 (length tail) 2)
10799 org-todo-keywords-1)
10800 (org-last org-todo-keywords-1))))
10801 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10802 (setq arg nil))) ; hack to fall back to cycling
10803 (arg
10804 ;; user or caller requests a specific state
10805 (cond
10806 ((equal arg "") nil)
10807 ((eq arg 'none) nil)
10808 ((eq arg 'done) (or done-word (car org-done-keywords)))
10809 ((eq arg 'nextset)
10810 (or (car (cdr (member head org-todo-heads)))
10811 (car org-todo-heads)))
10812 ((eq arg 'previousset)
10813 (let ((org-todo-heads (reverse org-todo-heads)))
10814 (or (car (cdr (member head org-todo-heads)))
10815 (car org-todo-heads))))
10816 ((car (member arg org-todo-keywords-1)))
10817 ((stringp arg)
10818 (error "State `%s' not valid in this file" arg))
10819 ((nth (1- (prefix-numeric-value arg))
10820 org-todo-keywords-1))))
10821 ((null member) (or head (car org-todo-keywords-1)))
10822 ((equal this final-done-word) nil) ;; -> make empty
10823 ((null tail) nil) ;; -> first entry
10824 ((memq interpret '(type priority))
10825 (if (eq this-command last-command)
10826 (car tail)
10827 (if (> (length tail) 0)
10828 (or done-word (car org-done-keywords))
10829 nil)))
10830 (t
10831 (car tail))))
10832 (state (or
10833 (run-hook-with-args-until-success
10834 'org-todo-get-default-hook state last-state)
10835 state))
10836 (next (if state (concat " " state " ") " "))
10837 (change-plist (list :type 'todo-state-change :from this :to state
10838 :position startpos))
10839 dolog now-done-p)
10840 (when org-blocker-hook
10841 (setq org-last-todo-state-is-todo
10842 (not (member this org-done-keywords)))
10843 (unless (save-excursion
10844 (save-match-data
10845 (run-hook-with-args-until-failure
10846 'org-blocker-hook change-plist)))
10847 (if (interactive-p)
10848 (error "TODO state change from %s to %s blocked" this state)
10849 ;; fail silently
10850 (message "TODO state change from %s to %s blocked" this state)
10851 (throw 'exit nil))))
10852 (store-match-data match-data)
10853 (replace-match next t t)
10854 (unless (pos-visible-in-window-p hl-pos)
10855 (message "TODO state changed to %s" (org-trim next)))
10856 (unless head
10857 (setq head (org-get-todo-sequence-head state)
10858 ass (assoc head org-todo-kwd-alist)
10859 interpret (nth 1 ass)
10860 done-word (nth 3 ass)
10861 final-done-word (nth 4 ass)))
10862 (when (memq arg '(nextset previousset))
10863 (message "Keyword-Set %d/%d: %s"
10864 (- (length org-todo-sets) -1
10865 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10866 (length org-todo-sets)
10867 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10868 (setq org-last-todo-state-is-todo
10869 (not (member state org-done-keywords)))
10870 (setq now-done-p (and (member state org-done-keywords)
10871 (not (member this org-done-keywords))))
10872 (and logging (org-local-logging logging))
10873 (when (and (or org-todo-log-states org-log-done)
10874 (not (eq org-inhibit-logging t))
10875 (not (memq arg '(nextset previousset))))
10876 ;; we need to look at recording a time and note
10877 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10878 (nth 2 (assoc this org-todo-log-states))))
10879 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10880 (setq dolog 'time))
10881 (when (and state
10882 (member state org-not-done-keywords)
10883 (not (member this org-not-done-keywords)))
10884 ;; This is now a todo state and was not one before
10885 ;; If there was a CLOSED time stamp, get rid of it.
10886 (org-add-planning-info nil nil 'closed))
10887 (when (and now-done-p org-log-done)
10888 ;; It is now done, and it was not done before
10889 (org-add-planning-info 'closed (org-current-time))
10890 (if (and (not dolog) (eq 'note org-log-done))
10891 (org-add-log-setup 'done state this 'findpos 'note)))
10892 (when (and state dolog)
10893 ;; This is a non-nil state, and we need to log it
10894 (org-add-log-setup 'state state this 'findpos dolog)))
10895 ;; Fixup tag positioning
10896 (org-todo-trigger-tag-changes state)
10897 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10898 (when org-provide-todo-statistics
10899 (org-update-parent-todo-statistics))
10900 (run-hooks 'org-after-todo-state-change-hook)
10901 (if (and arg (not (member state org-done-keywords)))
10902 (setq head (org-get-todo-sequence-head state)))
10903 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10904 ;; Do we need to trigger a repeat?
10905 (when now-done-p
10906 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10907 ;; This is for the agenda, take a snapshot of the headline.
10908 (save-match-data
10909 (setq org-agenda-headline-snapshot-before-repeat
10910 (org-get-heading))))
10911 (org-auto-repeat-maybe state))
10912 ;; Fixup cursor location if close to the keyword
10913 (if (and (outline-on-heading-p)
10914 (not (bolp))
10915 (save-excursion (beginning-of-line 1)
10916 (looking-at org-todo-line-regexp))
10917 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10918 (progn
10919 (goto-char (or (match-end 2) (match-end 1)))
10920 (and (looking-at " ") (just-one-space))))
10921 (when org-trigger-hook
10922 (save-excursion
10923 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10925 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10926 "Block turning an entry into a TODO, using the hierarchy.
10927 This checks whether the current task should be blocked from state
10928 changes. Such blocking occurs when:
10930 1. The task has children which are not all in a completed state.
10932 2. A task has a parent with the property :ORDERED:, and there
10933 are siblings prior to the current task with incomplete
10934 status.
10936 3. The parent of the task is blocked because it has siblings that should
10937 be done first, or is child of a block grandparent TODO entry."
10939 (if (not org-enforce-todo-dependencies)
10940 t ; if locally turned off don't block
10941 (catch 'dont-block
10942 ;; If this is not a todo state change, or if this entry is already DONE,
10943 ;; do not block
10944 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10945 (member (plist-get change-plist :from)
10946 (cons 'done org-done-keywords))
10947 (member (plist-get change-plist :to)
10948 (cons 'todo org-not-done-keywords))
10949 (not (plist-get change-plist :to)))
10950 (throw 'dont-block t))
10951 ;; If this task has children, and any are undone, it's blocked
10952 (save-excursion
10953 (org-back-to-heading t)
10954 (let ((this-level (funcall outline-level)))
10955 (outline-next-heading)
10956 (let ((child-level (funcall outline-level)))
10957 (while (and (not (eobp))
10958 (> child-level this-level))
10959 ;; this todo has children, check whether they are all
10960 ;; completed
10961 (if (and (not (org-entry-is-done-p))
10962 (org-entry-is-todo-p))
10963 (throw 'dont-block nil))
10964 (outline-next-heading)
10965 (setq child-level (funcall outline-level))))))
10966 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10967 ;; any previous siblings are undone, it's blocked
10968 (save-excursion
10969 (org-back-to-heading t)
10970 (let* ((pos (point))
10971 (parent-pos (and (org-up-heading-safe) (point))))
10972 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10973 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10974 (forward-line 1)
10975 (re-search-forward org-not-done-heading-regexp pos t))
10976 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10977 ;; Search further up the hierarchy, to see if an anchestor is blocked
10978 (while t
10979 (goto-char parent-pos)
10980 (if (not (looking-at org-not-done-heading-regexp))
10981 (throw 'dont-block t)) ; do not block, parent is not a TODO
10982 (setq pos (point))
10983 (setq parent-pos (and (org-up-heading-safe) (point)))
10984 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10985 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10986 (forward-line 1)
10987 (re-search-forward org-not-done-heading-regexp pos t))
10988 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10990 (defcustom org-track-ordered-property-with-tag nil
10991 "Should the ORDERED property also be shown as a tag?
10992 The ORDERED property decides if an entry should require subtasks to be
10993 completed in sequence. Since a property is not very visible, setting
10994 this option means that toggling the ORDERED property with the command
10995 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10996 not relevant for the behavior, but it makes things more visible.
10998 Note that toggling the tag with tags commands will not change the property
10999 and therefore not influence behavior!
11001 This can be t, meaning the tag ORDERED should be used, It can also be a
11002 string to select a different tag for this task."
11003 :group 'org-todo
11004 :type '(choice
11005 (const :tag "No tracking" nil)
11006 (const :tag "Track with ORDERED tag" t)
11007 (string :tag "Use other tag")))
11009 (defun org-toggle-ordered-property ()
11010 "Toggle the ORDERED property of the current entry.
11011 For better visibility, you can track the value of this property with a tag.
11012 See variable `org-track-ordered-property-with-tag'."
11013 (interactive)
11014 (let* ((t1 org-track-ordered-property-with-tag)
11015 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11016 (save-excursion
11017 (org-back-to-heading)
11018 (if (org-entry-get nil "ORDERED")
11019 (progn
11020 (org-delete-property "ORDERED")
11021 (and tag (org-toggle-tag tag 'off))
11022 (message "Subtasks can be completed in arbitrary order"))
11023 (org-entry-put nil "ORDERED" "t")
11024 (and tag (org-toggle-tag tag 'on))
11025 (message "Subtasks must be completed in sequence")))))
11027 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11028 (defun org-block-todo-from-checkboxes (change-plist)
11029 "Block turning an entry into a TODO, using checkboxes.
11030 This checks whether the current task should be blocked from state
11031 changes because there are unchecked boxes in this entry."
11032 (if (not org-enforce-todo-checkbox-dependencies)
11033 t ; if locally turned off don't block
11034 (catch 'dont-block
11035 ;; If this is not a todo state change, or if this entry is already DONE,
11036 ;; do not block
11037 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11038 (member (plist-get change-plist :from)
11039 (cons 'done org-done-keywords))
11040 (member (plist-get change-plist :to)
11041 (cons 'todo org-not-done-keywords))
11042 (not (plist-get change-plist :to)))
11043 (throw 'dont-block t))
11044 ;; If this task has checkboxes that are not checked, it's blocked
11045 (save-excursion
11046 (org-back-to-heading t)
11047 (let ((beg (point)) end)
11048 (outline-next-heading)
11049 (setq end (point))
11050 (goto-char beg)
11052 end t)
11053 (progn
11054 (if (boundp 'org-blocked-by-checkboxes)
11055 (setq org-blocked-by-checkboxes t))
11056 (throw 'dont-block nil)))))
11057 t))) ; do not block
11059 (defun org-entry-blocked-p ()
11060 "Is the current entry blocked?"
11061 (if (org-entry-get nil "NOBLOCKING")
11062 nil ;; Never block this entry
11063 (not
11064 (run-hook-with-args-until-failure
11065 'org-blocker-hook
11066 (list :type 'todo-state-change
11067 :position (point)
11068 :from 'todo
11069 :to 'done)))))
11071 (defun org-update-statistics-cookies (all)
11072 "Update the statistics cookie, either from TODO or from checkboxes.
11073 This should be called with the cursor in a line with a statistics cookie."
11074 (interactive "P")
11075 (if all
11076 (progn
11077 (org-update-checkbox-count 'all)
11078 (org-map-entries 'org-update-parent-todo-statistics))
11079 (if (not (org-on-heading-p))
11080 (org-update-checkbox-count)
11081 (let ((pos (move-marker (make-marker) (point)))
11082 end l1 l2)
11083 (ignore-errors (org-back-to-heading t))
11084 (if (not (org-on-heading-p))
11085 (org-update-checkbox-count)
11086 (setq l1 (org-outline-level))
11087 (setq end (save-excursion
11088 (outline-next-heading)
11089 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11090 (point)))
11091 (if (and (save-excursion
11092 (re-search-forward
11094 (not (save-excursion (re-search-forward
11096 (org-update-checkbox-count)
11097 (if (and l2 (> l2 l1))
11098 (progn
11099 (goto-char end)
11100 (org-update-parent-todo-statistics))
11101 (goto-char pos)
11102 (beginning-of-line 1)
11103 (while (re-search-forward
11105 (point-at-eol) t)
11106 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11107 (goto-char pos)
11108 (move-marker pos nil)))))
11110 (defvar org-entry-property-inherited-from) ;; defined below
11111 (defun org-update-parent-todo-statistics ()
11112 "Update any statistics cookie in the parent of the current headline.
11113 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11114 the entire subtree and this will travel up the hierarchy and update
11115 statistics everywhere."
11116 (interactive)
11117 (let* ((lim 0) prop
11118 (recursive (or (not org-hierarchical-todo-statistics)
11119 (string-match
11121 (or (setq prop (org-entry-get
11122 nil "COOKIE_DATA" 'inherit)) ""))))
11123 (lim (or (and prop (marker-position
11124 org-entry-property-inherited-from))
11125 lim))
11126 (first t)
11128 level ltoggle l1 new ndel
11129 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11130 (catch 'exit
11131 (save-excursion
11132 (beginning-of-line 1)
11133 (if (org-at-heading-p)
11134 (setq ltoggle (funcall outline-level))
11135 (error "This should not happen"))
11136 (while (and (setq level (org-up-heading-safe))
11137 (or recursive first)
11138 (>= (point) lim))
11139 (setq first nil cookie-present nil)
11140 (unless (and level
11141 (not (string-match
11143 (downcase
11144 (or (org-entry-get
11145 nil "COOKIE_DATA")
11146 "")))))
11147 (throw 'exit nil))
11148 (while (re-search-forward box-re (point-at-eol) t)
11149 (setq cnt-all 0 cnt-done 0 cookie-present t)
11150 (setq is-percent (match-end 2))
11151 (save-match-data
11152 (unless (outline-next-heading) (throw 'exit nil))
11153 (while (and (looking-at org-complex-heading-regexp)
11154 (> (setq l1 (length (match-string 1))) level))
11155 (setq kwd (and (or recursive (= l1 ltoggle))
11156 (match-string 2)))
11157 (if (or (eq org-provide-todo-statistics 'all-headlines)
11158 (and (listp org-provide-todo-statistics)
11159 (or (member kwd org-provide-todo-statistics)
11160 (member kwd org-done-keywords))))
11161 (setq cnt-all (1+ cnt-all))
11162 (if (eq org-provide-todo-statistics t)
11163 (and kwd (setq cnt-all (1+ cnt-all)))))
11164 (and (member kwd org-done-keywords)
11165 (setq cnt-done (1+ cnt-done)))
11166 (outline-next-heading)))
11167 (setq new
11168 (if is-percent
11169 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11170 (format "[%d/%d]" cnt-done cnt-all))
11171 ndel (- (match-end 0) (match-beginning 0)))
11172 (goto-char (match-beginning 0))
11173 (insert new)
11174 (delete-region (point) (+ (point) ndel)))
11175 (when cookie-present
11176 (run-hook-with-args 'org-after-todo-statistics-hook
11177 cnt-done (- cnt-all cnt-done))))))
11178 (run-hooks 'org-todo-statistics-hook)))
11180 (defvar org-after-todo-statistics-hook nil
11181 "Hook that is called after a TODO statistics cookie has been updated.
11182 Each function is called with two arguments: the number of not-done entries
11183 and the number of done entries.
11185 For example, the following function, when added to this hook, will switch
11186 an entry to DONE when all children are done, and back to TODO when new
11187 entries are set to a TODO status. Note that this hook is only called
11188 when there is a statistics cookie in the headline!
11190 (defun org-summary-todo (n-done n-not-done)
11192 (let (org-log-done org-log-states) ; turn off logging
11194 ")
11196 (defvar org-todo-statistics-hook nil
11197 "Hook that is run whenever Org thinks TODO statistics should be updated.
11198 This hook runs even if there is no statistics cookie present, in which case
11199 `org-after-todo-statistics-hook' would not run.")
11201 (defun org-todo-trigger-tag-changes (state)
11202 "Apply the changes defined in `org-todo-state-tags-triggers'."
11203 (let ((l org-todo-state-tags-triggers)
11204 changes)
11205 (when (or (not state) (equal state ""))
11206 (setq changes (append changes (cdr (assoc "" l)))))
11207 (when (and (stringp state) (> (length state) 0))
11208 (setq changes (append changes (cdr (assoc state l)))))
11209 (when (member state org-not-done-keywords)
11210 (setq changes (append changes (cdr (assoc 'todo l)))))
11211 (when (member state org-done-keywords)
11212 (setq changes (append changes (cdr (assoc 'done l)))))
11213 (dolist (c changes)
11214 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11216 (defun org-local-logging (value)
11217 "Get logging settings from a property VALUE."
11218 (let* (words w a)
11219 ;; directly set the variables, they are already local.
11220 (setq org-log-done nil
11221 org-log-repeat nil
11222 org-todo-log-states nil)
11223 (setq words (org-split-string value))
11224 (while (setq w (pop words))
11225 (cond
11226 ((setq a (assoc w org-startup-options))
11227 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11228 (set (nth 1 a) (nth 2 a))))
11229 ((setq a (org-extract-log-state-settings w))
11230 (and (member (car a) org-todo-keywords-1)
11231 (push a org-todo-log-states)))))))
11233 (defun org-get-todo-sequence-head (kwd)
11234 "Return the head of the TODO sequence to which KWD belongs.
11235 If KWD is not set, check if there is a text property remembering the
11236 right sequence."
11237 (let (p)
11238 (cond
11239 ((not kwd)
11240 (or (get-text-property (point-at-bol) 'org-todo-head)
11241 (progn
11242 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11243 nil (point-at-eol)))
11244 (get-text-property p 'org-todo-head))))
11245 ((not (member kwd org-todo-keywords-1))
11246 (car org-todo-keywords-1))
11247 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11249 (defun org-fast-todo-selection ()
11250 "Fast TODO keyword selection with single keys.
11251 Returns the new TODO keyword, or nil if no state change should occur."
11252 (let* ((fulltable org-todo-key-alist)
11253 (done-keywords org-done-keywords) ;; needed for the faces.
11254 (maxlen (apply 'max (mapcar
11255 (lambda (x)
11256 (if (stringp (car x)) (string-width (car x)) 0))
11257 fulltable)))
11258 (expert nil)
11259 (fwidth (+ maxlen 3 1 3))
11260 (ncol (/ (- (window-width) 4) fwidth))
11261 tg cnt e c tbl
11262 groups ingroup)
11263 (save-excursion
11264 (save-window-excursion
11265 (if expert
11266 (set-buffer (get-buffer-create " *Org todo*"))
11267 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11268 (erase-buffer)
11269 (org-set-local 'org-done-keywords done-keywords)
11270 (setq tbl fulltable cnt 0)
11271 (while (setq e (pop tbl))
11272 (cond
11273 ((equal e '(:startgroup))
11274 (push '() groups) (setq ingroup t)
11275 (when (not (= cnt 0))
11276 (setq cnt 0)
11278 (insert "{ "))
11279 ((equal e '(:endgroup))
11280 (setq ingroup nil cnt 0)
11282 ((equal e '(:newline))
11283 (when (not (= cnt 0))
11284 (setq cnt 0)
11286 (setq e (car tbl))
11287 (while (equal (car tbl) '(:newline))
11289 (setq tbl (cdr tbl)))))
11290 (t
11291 (setq tg (car e) c (cdr e))
11292 (if ingroup (push tg (car groups)))
11293 (setq tg (org-add-props tg nil 'face
11294 (org-get-todo-face tg)))
11295 (if (and (= cnt 0) (not ingroup)) (insert " "))
11296 (insert "[" c "] " tg (make-string
11297 (- fwidth 4 (length tg)) ?\ ))
11298 (when (= (setq cnt (1+ cnt)) ncol)
11300 (if ingroup (insert " "))
11301 (setq cnt 0)))))
11303 (goto-char (point-min))
11304 (if (not expert) (org-fit-window-to-buffer))
11305 (message "[a-z..]:Set [SPC]:clear")
11306 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11307 (cond
11308 ((or (= c ?\C-g)
11309 (and (= c ?q) (not (rassoc c fulltable))))
11310 (setq quit-flag t))
11311 ((= c ?\ ) nil)
11312 ((setq e (rassoc c fulltable) tg (car e))
11313 tg)
11314 (t (setq quit-flag t)))))))
11316 (defun org-entry-is-todo-p ()
11317 (member (org-get-todo-state) org-not-done-keywords))
11319 (defun org-entry-is-done-p ()
11320 (member (org-get-todo-state) org-done-keywords))
11322 (defun org-get-todo-state ()
11323 (save-excursion
11324 (org-back-to-heading t)
11325 (and (looking-at org-todo-line-regexp)
11326 (match-end 2)
11327 (match-string 2))))
11329 (defun org-at-date-range-p (&optional inactive-ok)
11330 "Is the cursor inside a date range?"
11331 (interactive)
11332 (save-excursion
11333 (catch 'exit
11334 (let ((pos (point)))
11336 (skip-chars-backward "<[")
11337 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11338 (>= (match-end 0) pos)
11339 (throw 'exit t))
11341 (skip-chars-backward "<[")
11342 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11343 (>= (match-end 0) pos)
11344 (throw 'exit t)))
11345 nil)))
11347 (defun org-get-repeat (&optional tagline)
11348 "Check if there is a deadline/schedule with repeater in this entry."
11349 (save-match-data
11350 (save-excursion
11351 (org-back-to-heading t)
11352 (and (re-search-forward (if tagline
11354 org-repeat-re)
11355 (org-entry-end-position) t)
11356 (match-string-no-properties 1)))))
11358 (defvar org-last-changed-timestamp)
11359 (defvar org-last-inserted-timestamp)
11360 (defvar org-log-post-message)
11361 (defvar org-log-note-purpose)
11362 (defvar org-log-note-how)
11363 (defvar org-log-note-extra)
11364 (defun org-auto-repeat-maybe (done-word)
11365 "Check if the current headline contains a repeated deadline/schedule.
11366 If yes, set TODO state back to what it was and change the base date
11367 of repeating deadline/scheduled time stamps to new date.
11368 This function is run automatically after each state change to a DONE state."
11369 ;; last-state is dynamically scoped into this function
11370 (let* ((repeat (org-get-repeat))
11371 (aa (assoc last-state org-todo-kwd-alist))
11372 (interpret (nth 1 aa))
11373 (head (nth 2 aa))
11374 (whata '(("d" . day) ("m" . month) ("y" . year)))
11375 (msg "Entry repeats: ")
11376 (org-log-done nil)
11377 (org-todo-log-states nil)
11378 (nshiftmax 10) (nshift 0)
11379 re type n what ts time to-state)
11380 (when repeat
11381 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11382 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11383 org-todo-repeat-to-state))
11384 (unless (and to-state (member to-state org-todo-keywords-1))
11385 (setq to-state (if (eq interpret 'type) last-state head)))
11386 (org-todo to-state)
11387 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11388 (org-entry-put nil "LAST_REPEAT" (format-time-string
11389 (org-time-stamp-format t t))))
11390 (when org-log-repeat
11391 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11392 (memq 'org-add-log-note post-command-hook))
11393 ;; OK, we are already setup for some record
11394 (if (eq org-log-repeat 'note)
11395 ;; make sure we take a note, not only a time stamp
11396 (setq org-log-note-how 'note))
11397 ;; Set up for taking a record
11398 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11399 last-state
11400 'findpos org-log-repeat)))
11401 (org-back-to-heading t)
11402 (org-add-planning-info nil nil 'closed)
11406 (while (re-search-forward
11407 re (save-excursion (outline-next-heading) (point)) t)
11408 (setq type (if (match-end 1) org-scheduled-string
11409 (if (match-end 3) org-deadline-string "Plain:"))
11410 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11412 (setq n (string-to-number (match-string 2 ts))
11413 what (match-string 3 ts))
11414 (if (equal what "w") (setq n (* n 7) what "d"))
11415 ;; Preparation, see if we need to modify the start date for the change
11416 (when (match-end 1)
11417 (setq time (save-match-data (org-time-string-to-time ts)))
11418 (cond
11419 ((equal (match-string 1 ts) ".")
11420 ;; Shift starting date to today
11421 (org-timestamp-change
11422 (- (time-to-days (current-time)) (time-to-days time))
11423 'day))
11424 ((equal (match-string 1 ts) "+")
11425 (while (or (= nshift 0)
11426 (<= (time-to-days time) (time-to-days (current-time))))
11427 (when (= (incf nshift) nshiftmax)
11428 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11429 (error "Abort")))
11430 (org-timestamp-change n (cdr (assoc what whata)))
11431 (org-at-timestamp-p t)
11432 (setq ts (match-string 1))
11433 (setq time (save-match-data (org-time-string-to-time ts))))
11434 (org-timestamp-change (- n) (cdr (assoc what whata)))
11435 ;; rematch, so that we have everything in place for the real shift
11436 (org-at-timestamp-p t)
11437 (setq ts (match-string 1))
11439 (org-timestamp-change n (cdr (assoc what whata)))
11440 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11441 (setq org-log-post-message msg)
11442 (message "%s" msg))))
11444 (defun org-show-todo-tree (arg)
11445 "Make a compact tree which shows all headlines marked with TODO.
11446 The tree will show the lines where the regexp matches, and all higher
11447 headlines above the match.
11449 With a numeric prefix N, construct a sparse tree for the Nth element
11450 of `org-todo-keywords-1'."
11451 (interactive "P")
11452 (let ((case-fold-search nil)
11453 (kwd-re
11454 (cond ((null arg) org-not-done-regexp)
11455 ((equal arg '(4))
11456 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11457 (mapcar 'list org-todo-keywords-1))))
11461 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11462 (regexp-quote (nth (1- (prefix-numeric-value arg))
11463 org-todo-keywords-1)))
11464 (t (error "Invalid prefix argument: %s" arg)))))
11465 (message "%d TODO entries found"
11466 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11468 (defun org-deadline (&optional remove time)
11470 With argument REMOVE, remove any deadline from the item.
11471 When TIME is set, it should be an internal time specification, and the
11472 scheduling will use the corresponding date."
11473 (interactive "P")
11474 (let* ((old-date (org-entry-get nil "DEADLINE"))
11475 (repeater (and old-date
11477 (match-string 1 old-date))))
11478 (if remove
11479 (progn
11480 (when (and old-date org-log-redeadline)
11481 (org-add-log-setup 'deldeadline nil old-date 'findpos
11482 org-log-redeadline))
11483 (org-remove-timestamp-with-keyword org-deadline-string)
11484 (message "Item no longer has a deadline."))
11485 (org-add-planning-info 'deadline time 'closed)
11486 (when (and old-date org-log-redeadline
11487 (not (equal old-date
11488 (substring org-last-inserted-timestamp 1 -1))))
11489 (org-add-log-setup 'redeadline nil old-date 'findpos
11490 org-log-redeadline))
11491 (when repeater
11492 (save-excursion
11493 (org-back-to-heading t)
11494 (when (re-search-forward (concat org-deadline-string " "
11495 org-last-inserted-timestamp)
11496 (save-excursion
11497 (outline-next-heading) (point)) t)
11498 (goto-char (1- (match-end 0)))
11499 (insert " " repeater)
11500 (setq org-last-inserted-timestamp
11501 (concat (substring org-last-inserted-timestamp 0 -1)
11502 " " repeater
11503 (substring org-last-inserted-timestamp -1))))))
11504 (message "Deadline on %s" org-last-inserted-timestamp))))
11506 (defun org-schedule (&optional remove time)
11507 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11508 With argument REMOVE, remove any scheduling date from the item.
11509 When TIME is set, it should be an internal time specification, and the
11510 scheduling will use the corresponding date."
11511 (interactive "P")
11512 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11513 (repeater (and old-date
11515 (match-string 1 old-date))))
11516 (if remove
11517 (progn
11518 (when (and old-date org-log-reschedule)
11519 (org-add-log-setup 'delschedule nil old-date 'findpos
11520 org-log-reschedule))
11521 (org-remove-timestamp-with-keyword org-scheduled-string)
11522 (message "Item is no longer scheduled."))
11523 (org-add-planning-info 'scheduled time 'closed)
11524 (when (and old-date org-log-reschedule
11525 (not (equal old-date
11526 (substring org-last-inserted-timestamp 1 -1))))
11527 (org-add-log-setup 'reschedule nil old-date 'findpos
11528 org-log-reschedule))
11529 (when repeater
11530 (save-excursion
11531 (org-back-to-heading t)
11532 (when (re-search-forward (concat org-scheduled-string " "
11533 org-last-inserted-timestamp)
11534 (save-excursion
11535 (outline-next-heading) (point)) t)
11536 (goto-char (1- (match-end 0)))
11537 (insert " " repeater)
11538 (setq org-last-inserted-timestamp
11539 (concat (substring org-last-inserted-timestamp 0 -1)
11540 " " repeater
11541 (substring org-last-inserted-timestamp -1))))))
11542 (message "Scheduled to %s" org-last-inserted-timestamp))))
11544 (defun org-get-scheduled-time (pom &optional inherit)
11545 "Get the scheduled time as a time tuple, of a format suitable
11546 for calling org-schedule with, or if there is no scheduling,
11547 returns nil."
11548 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11549 (when time
11550 (apply 'encode-time (org-parse-time-string time)))))
11552 (defun org-get-deadline-time (pom &optional inherit)
11553 "Get the deadline as a time tuple, of a format suitable for
11554 calling org-deadline with, or if there is no scheduling, returns
11555 nil."
11556 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11557 (when time
11558 (apply 'encode-time (org-parse-time-string time)))))
11560 (defun org-remove-timestamp-with-keyword (keyword)
11561 "Remove all time stamps with KEYWORD in the current entry."
11563 beg)
11564 (save-excursion
11565 (org-back-to-heading t)
11566 (setq beg (point))
11567 (outline-next-heading)
11568 (while (re-search-backward re beg t)
11569 (replace-match "")
11571 (equal (char-before) ?\ ))
11572 (backward-delete-char 1)
11574 (point-at-bol) (point-at-eol)))
11575 (delete-region (point-at-bol)
11576 (min (point-max) (1+ (point-at-eol))))))))))
11578 (defun org-add-planning-info (what &optional time &rest remove)
11579 "Insert new timestamp with keyword in the line directly after the headline.
11580 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11581 If non is given, the user is prompted for a date.
11582 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11583 be removed."
11584 (interactive)
11585 (let (org-time-was-given org-end-time-was-given ts
11586 end default-time default-input)
11588 (catch 'exit
11589 (when (and (not time) (memq what '(scheduled deadline)))
11590 ;; Try to get a default date/time from existing timestamp
11591 (save-excursion
11592 (org-back-to-heading t)
11593 (setq end (save-excursion (outline-next-heading) (point)))
11594 (when (re-search-forward (if (eq what 'scheduled)
11595 org-scheduled-time-regexp
11596 org-deadline-time-regexp)
11597 end t)
11598 (setq ts (match-string 1)
11599 default-time
11600 (apply 'encode-time (org-parse-time-string ts))
11601 default-input (and ts (org-get-compact-tod ts))))))
11602 (when what
11603 ;; If necessary, get the time from the user
11604 (setq time (or time (org-read-date nil 'to-time nil nil
11605 default-time default-input))))
11607 (when (and org-insert-labeled-timestamps-at-point
11608 (member what '(scheduled deadline)))
11609 (insert
11610 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11611 (org-insert-time-stamp time org-time-was-given
11612 nil nil nil (list org-end-time-was-given))
11613 (setq what nil))
11614 (save-excursion
11615 (save-restriction
11616 (let (col list elt ts buffer-invisibility-spec)
11617 (org-back-to-heading t)
11619 (goto-char (match-end 1))
11620 (setq col (current-column))
11621 (goto-char (match-end 0))
11623 (when (and (not what)
11624 (not (looking-at
11626 org-keyword-time-not-clock-regexp))))
11627 ;; Nothing to add, nothing to remove...... :-)
11628 (throw 'exit nil))
11629 (if (and (not (looking-at outline-regexp))
11632 (not (equal (match-string 1) org-clock-string)))
11633 (narrow-to-region (match-beginning 0) (match-end 0))
11635 (backward-char 1)
11636 (narrow-to-region (point) (point))
11637 (and org-adapt-indentation (org-indent-to-column col)))
11638 ;; Check if we have to remove something.
11639 (setq list (cons what remove))
11640 (while list
11641 (setq elt (pop list))
11642 (goto-char (point-min))
11643 (when (or (and (eq elt 'scheduled)
11644 (re-search-forward org-scheduled-time-regexp nil t))
11645 (and (eq elt 'deadline)
11646 (re-search-forward org-deadline-time-regexp nil t))
11647 (and (eq elt 'closed)
11648 (re-search-forward org-closed-time-regexp nil t)))
11649 (replace-match "")
11650 (if (looking-at "--+<[^>]+>") (replace-match ""))
11651 (skip-chars-backward " ")
11652 (if (looking-at " +") (replace-match ""))))
11653 (goto-char (point-max))
11654 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11655 (when what
11656 (insert
11657 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11658 (cond ((eq what 'scheduled) org-scheduled-string)
11659 ((eq what 'deadline) org-deadline-string)
11660 ((eq what 'closed) org-closed-string))
11661 " ")
11662 (setq ts (org-insert-time-stamp
11663 time
11664 (or org-time-was-given
11665 (and (eq what 'closed) org-log-done-with-time))
11666 (eq what 'closed)
11667 nil nil (list org-end-time-was-given)))
11668 (end-of-line 1))
11669 (goto-char (point-min))
11670 (widen)
11673 (delete-region (1- (point)) (point-at-eol)))
11674 ts))))))
11676 (defvar org-log-note-marker (make-marker))
11677 (defvar org-log-note-purpose nil)
11678 (defvar org-log-note-state nil)
11679 (defvar org-log-note-previous-state nil)
11680 (defvar org-log-note-how nil)
11681 (defvar org-log-note-extra nil)
11682 (defvar org-log-note-window-configuration nil)
11683 (defvar org-log-note-return-to (make-marker))
11684 (defvar org-log-post-message nil
11685 "Message to be displayed after a log note has been stored.
11686 The auto-repeater uses this.")
11688 (defun org-add-note ()
11689 "Add a note to the current entry.
11690 This is done in the same way as adding a state change note."
11691 (interactive)
11692 (org-add-log-setup 'note nil nil 'findpos nil))
11694 (defvar org-property-end-re)
11695 (defun org-add-log-setup (&optional purpose state prev-state
11696 findpos how extra)
11697 "Set up the post command hook to take a note.
11698 If this is about to TODO state change, the new state is expected in STATE.
11699 When FINDPOS is non-nil, find the correct position for the note in
11700 the current entry. If not, assume that it can be inserted at point.
11701 HOW is an indicator what kind of note should be created.
11702 EXTRA is additional text that will be inserted into the notes buffer."
11703 (let* ((org-log-into-drawer (org-log-into-drawer))
11704 (drawer (cond ((stringp org-log-into-drawer)
11705 org-log-into-drawer)
11706 (org-log-into-drawer "LOGBOOK")
11707 (t nil))))
11708 (save-restriction
11709 (save-excursion
11710 (when findpos
11711 (org-back-to-heading t)
11712 (narrow-to-region (point) (save-excursion
11713 (outline-next-heading) (point)))
11717 (goto-char (match-end 0))
11718 (cond
11719 (drawer
11721 nil t)
11722 (progn
11723 (goto-char (match-end 0))
11724 (or org-log-states-order-reversed
11725 (and (re-search-forward org-property-end-re nil t)
11726 (goto-char (1- (match-beginning 0))))))
11728 (beginning-of-line 0)
11729 (org-indent-line-function)
11730 (beginning-of-line 2)
11731 (org-indent-line-function)
11732 (end-of-line 0)))
11733 ((and org-log-state-notes-insert-after-drawers
11734 (save-excursion
11735 (forward-line) (looking-at org-drawer-regexp)))
11736 (forward-line)
11737 (while (looking-at org-drawer-regexp)
11738 (goto-char (match-end 0))
11739 (re-search-forward org-property-end-re (point-max) t)
11740 (forward-line))
11741 (forward-line -1)))
11742 (unless org-log-states-order-reversed
11744 (org-skip-over-state-notes)
11746 (move-marker org-log-note-marker (point))
11747 (setq org-log-note-purpose purpose
11748 org-log-note-state state
11749 org-log-note-previous-state prev-state
11750 org-log-note-how how
11751 org-log-note-extra extra)
11752 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11754 (defun org-skip-over-state-notes ()
11755 "Skip past the list of State notes in an entry."
11757 (when (org-in-item-p)
11758 (let ((limit (org-list-bottom-point)))
11760 (goto-char (or (org-get-next-item (point) limit)
11761 (org-get-end-of-item limit)))))))
11763 (defun org-add-log-note (&optional purpose)
11764 "Pop up a window for taking a note, and add this note later at point."
11765 (remove-hook 'post-command-hook 'org-add-log-note)
11766 (setq org-log-note-window-configuration (current-window-configuration))
11767 (delete-other-windows)
11768 (move-marker org-log-note-return-to (point))
11769 (switch-to-buffer (marker-buffer org-log-note-marker))
11770 (goto-char org-log-note-marker)
11771 (org-switch-to-buffer-other-window "*Org Note*")
11772 (erase-buffer)
11773 (if (memq org-log-note-how '(time state))
11774 (let (current-prefix-arg) (org-store-log-note))
11775 (let ((org-inhibit-startup t)) (org-mode))
11776 (insert (format "# Insert note for %s.
11778 (cond
11779 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11780 ((eq org-log-note-purpose 'done) "closed todo item")
11781 ((eq org-log-note-purpose 'state)
11783 (or org-log-note-previous-state "")
11784 (or org-log-note-state "")))
11785 ((eq org-log-note-purpose 'reschedule)
11786 "rescheduling")
11787 ((eq org-log-note-purpose 'delschedule)
11788 "no longer scheduled")
11789 ((eq org-log-note-purpose 'redeadline)
11790 "changing deadline")
11791 ((eq org-log-note-purpose 'deldeadline)
11792 "removing deadline")
11793 ((eq org-log-note-purpose 'refile)
11794 "refiling")
11795 ((eq org-log-note-purpose 'note)
11796 "this entry")
11797 (t (error "This should not happen")))))
11798 (if org-log-note-extra (insert org-log-note-extra))
11799 (org-set-local 'org-finish-function 'org-store-log-note)))
11801 (defvar org-note-abort nil) ; dynamically scoped
11802 (defun org-store-log-note ()
11803 "Finish taking a log note, and insert it to where it belongs."
11804 (let ((txt (buffer-string))
11805 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11806 lines ind bul)
11807 (kill-buffer (current-buffer))
11809 (setq txt (replace-match "" t t txt)))
11811 (setq txt (replace-match "" t t txt)))
11814 (setq note
11815 (org-replace-escapes
11816 note
11817 (list (cons "%u" (user-login-name))
11818 (cons "%U" user-full-name)
11819 (cons "%t" (format-time-string
11820 (org-time-stamp-format 'long 'inactive)
11821 (current-time)))
11822 (cons "%T" (format-time-string
11823 (org-time-stamp-format 'long nil)
11824 (current-time)))
11825 (cons "%s" (if org-log-note-state
11827 ""))
11828 (cons "%S" (if org-log-note-previous-state
11832 (push note lines))
11833 (when (or current-prefix-arg org-note-abort)
11834 (when org-log-into-drawer
11835 (org-remove-empty-drawer-at
11836 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11837 org-log-note-marker))
11838 (setq lines nil))
11839 (when lines
11840 (with-current-buffer (marker-buffer org-log-note-marker)
11841 (save-excursion
11842 (goto-char org-log-note-marker)
11843 (move-marker org-log-note-marker nil)
11844 (end-of-line 1)
11846 (setq ind (save-excursion
11847 (if (org-in-item-p)
11848 (progn
11849 (goto-char (org-list-top-point))
11850 (org-get-indentation))
11852 (cond
11853 ((and (org-at-heading-p)
11854 org-adapt-indentation)
11855 (1+ (org-current-level)))
11856 ((org-at-heading-p) 0)
11857 (t (org-get-indentation))))))
11858 (setq bul (org-list-bullet-string "-"))
11859 (org-indent-line-to ind)
11860 (insert bul (pop lines))
11861 (let ((ind-body (+ (length bul) ind)))
11862 (while lines
11864 (org-indent-line-to ind-body)
11865 (insert (pop lines))))
11866 (message "Note stored")
11867 (org-back-to-heading t)
11868 (org-cycle-hide-drawers 'children)))))
11869 (set-window-configuration org-log-note-window-configuration)
11870 (with-current-buffer (marker-buffer org-log-note-return-to)
11871 (goto-char org-log-note-return-to))
11872 (move-marker org-log-note-return-to nil)
11873 (and org-log-post-message (message "%s" org-log-post-message)))
11875 (defun org-remove-empty-drawer-at (drawer pos)
11876 "Remove an empty drawer DRAWER at position POS.
11877 POS may also be a marker."
11878 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11879 (save-excursion
11880 (save-restriction
11881 (widen)
11882 (goto-char pos)
11883 (if (org-in-regexp
11885 (replace-match ""))))))
11887 (defun org-sparse-tree (&optional arg)
11888 "Create a sparse tree, prompt for the details.
11889 This command can create sparse trees. You first need to select the type
11890 of match used to create the tree:
11892 t Show all TODO entries.
11893 T Show entries with a specific TODO keyword.
11894 m Show entries selected by a tags/property match.
11895 p Enter a property name and its value (both with completion on existing
11896 names/values) and show entries with that property.
11897 / Show entries matching a regular expression (`r' can be used as well)
11898 d Show deadlines due within `org-deadline-warning-days'.
11899 b Show deadlines and scheduled items before a date.
11900 a Show deadlines and scheduled items after a date."
11901 (interactive "P")
11902 (let (ans kwd value)
11903 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
11904 (setq ans (read-char-exclusive))
11905 (cond
11906 ((equal ans ?d)
11907 (call-interactively 'org-check-deadlines))
11908 ((equal ans ?b)
11909 (call-interactively 'org-check-before-date))
11910 ((equal ans ?a)
11911 (call-interactively 'org-check-after-date))
11912 ((equal ans ?t)
11913 (org-show-todo-tree nil))
11914 ((equal ans ?T)
11915 (org-show-todo-tree '(4)))
11916 ((member ans '(?T ?m))
11917 (call-interactively 'org-match-sparse-tree))
11918 ((member ans '(?p ?P))
11919 (setq kwd (org-icompleting-read "Property: "
11920 (mapcar 'list (org-buffer-property-keys))))
11921 (setq value (org-icompleting-read "Value: "
11922 (mapcar 'list (org-property-values kwd))))
11925 (org-match-sparse-tree arg (concat kwd "=" value)))
11926 ((member ans '(?r ?R ?/))
11927 (call-interactively 'org-occur))
11930 (defvar org-occur-highlights nil
11931 "List of overlays used for occur matches.")
11932 (make-variable-buffer-local 'org-occur-highlights)
11933 (defvar org-occur-parameters nil
11934 "Parameters of the active org-occur calls.
11935 This is a list, each call to org-occur pushes as cons cell,
11936 containing the regular expression and the callback, onto the list.
11937 The list can contain several entries if `org-occur' has been called
11938 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11939 will only contain one set of parameters. When the highlights are
11940 removed (for example with `C-c C-c', or with the next edit (depending
11941 on `org-remove-highlights-with-change'), this variable is emptied
11942 as well.")
11943 (make-variable-buffer-local 'org-occur-parameters)
11945 (defun org-occur (regexp &optional keep-previous callback)
11946 "Make a compact tree which shows all matches of REGEXP.
11947 The tree will show the lines where the regexp matches, and all higher
11948 headlines above the match. It will also show the heading after the match,
11949 to make sure editing the matching entry is easy.
11950 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11951 call to `org-occur' will be kept, to allow stacking of calls to this
11952 command.
11953 If CALLBACK is non-nil, it is a function which is called to confirm
11954 that the match should indeed be shown."
11956 (when (equal regexp "")
11957 (error "Regexp cannot be empty"))
11958 (unless keep-previous
11959 (org-remove-occur-highlights nil nil t))
11960 (push (cons regexp callback) org-occur-parameters)
11961 (let ((cnt 0))
11962 (save-excursion
11963 (goto-char (point-min))
11964 (if (or (not keep-previous) ; do not want to keep
11965 (not org-occur-highlights)) ; no previous matches
11966 ;; hide everything
11967 (org-overview))
11968 (while (re-search-forward regexp nil t)
11969 (when (or (not callback)
11970 (save-match-data (funcall callback)))
11971 (setq cnt (1+ cnt))
11972 (when org-highlight-sparse-tree-matches
11973 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11974 (org-show-context 'occur-tree))))
11975 (when org-remove-highlights-with-change
11976 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11977 nil 'local))
11978 (unless org-sparse-tree-open-archived-trees
11979 (org-hide-archived-subtrees (point-min) (point-max)))
11980 (run-hooks 'org-occur-hook)
11981 (if (interactive-p)
11982 (message "%d match(es) for regexp %s" cnt regexp))
11983 cnt))
11985 (defun org-show-context (&optional key)
11986 "Make sure point and context are visible.
11987 How much context is shown depends upon the variables
11988 `org-show-hierarchy-above', `org-show-following-heading'. and
11989 `org-show-siblings'."
11990 (let ((heading-p (org-on-heading-p t))
11991 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11992 (following-p (org-get-alist-option org-show-following-heading key))
11993 (entry-p (org-get-alist-option org-show-entry-below key))
11994 (siblings-p (org-get-alist-option org-show-siblings key)))
11995 (catch 'exit
11996 ;; Show heading or entry text
11997 (if (and heading-p (not entry-p))
11998 (org-flag-heading nil) ; only show the heading
11999 (and (or entry-p (org-invisible-p) (org-invisible-p2))
12000 (org-show-hidden-entry))) ; show entire entry
12001 (when following-p
12002 ;; Show next sibling, or heading below text
12003 (save-excursion
12004 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12005 (org-flag-heading nil))))
12006 (when siblings-p (org-show-siblings))
12007 (when hierarchy-p
12008 ;; show all higher headings, possibly with siblings
12009 (save-excursion
12010 (while (and (condition-case nil
12011 (progn (org-up-heading-all 1) t)
12012 (error nil))
12013 (not (bobp)))
12014 (org-flag-heading nil)
12015 (when siblings-p (org-show-siblings))))))))
12017 (defvar org-reveal-start-hook nil
12018 "Hook run before revealing a location.")
12020 (defun org-reveal (&optional siblings)
12021 "Show current entry, hierarchy above it, and the following headline.
12022 This can be used to show a consistent set of context around locations
12023 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12024 not t for the search context.
12026 With optional argument SIBLINGS, on each level of the hierarchy all
12027 siblings are shown. This repairs the tree structure to what it would
12028 look like when opened with hierarchical calls to `org-cycle'.
12030 go to the parent and show the
12031 entire tree."
12032 (interactive "P")
12033 (run-hooks 'org-reveal-start-hook)
12034 (let ((org-show-hierarchy-above t)
12035 (org-show-following-heading t)
12036 (org-show-siblings (if siblings t org-show-siblings)))
12037 (org-show-context nil))
12038 (when (equal siblings '(16))
12039 (save-excursion
12040 (when (org-up-heading-safe)
12041 (org-show-subtree)
12042 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12044 (defun org-highlight-new-match (beg end)
12045 "Highlight from BEG to END and mark the highlight is an occur headline."
12046 (let ((ov (make-overlay beg end)))
12047 (overlay-put ov 'face 'secondary-selection)
12048 (push ov org-occur-highlights)))
12050 (defun org-remove-occur-highlights (&optional beg end noremove)
12051 "Remove the occur highlights from the buffer.
12052 BEG and END are ignored. If NOREMOVE is nil, remove this function
12053 from the `before-change-functions' in the current buffer."
12054 (interactive)
12055 (unless org-inhibit-highlight-removal
12056 (mapc 'delete-overlay org-occur-highlights)
12057 (setq org-occur-highlights nil)
12058 (setq org-occur-parameters nil)
12059 (unless noremove
12060 (remove-hook 'before-change-functions
12061 'org-remove-occur-highlights 'local))))
12063 ;;;; Priorities
12066 "Regular expression matching the priority indicator.")
12068 (defvar org-remove-priority-next-time nil)
12070 (defun org-priority-up ()
12071 "Increase the priority of the current item."
12072 (interactive)
12073 (org-priority 'up))
12075 (defun org-priority-down ()
12076 "Decrease the priority of the current item."
12077 (interactive)
12078 (org-priority 'down))
12080 (defun org-priority (&optional action)
12081 "Change the priority of an item by ARG.
12082 ACTION can be `set', `up', `down', or a character."
12083 (interactive)
12084 (unless org-enable-priority-commands
12085 (error "Priority commands are disabled"))
12086 (setq action (or action 'set))
12087 (let (current new news have remove)
12088 (save-excursion
12089 (org-back-to-heading t)
12090 (if (looking-at org-priority-regexp)
12091 (setq current (string-to-char (match-string 2))
12092 have t)
12093 (setq current org-default-priority))
12094 (cond
12095 ((eq action 'remove)
12096 (setq remove t new ?\ ))
12097 ((or (eq action 'set)
12098 (if (featurep 'xemacs) (characterp action) (integerp action)))
12099 (if (not (eq action 'set))
12100 (setq new action)
12101 (message "Priority %c-%c, SPC to remove: "
12102 org-highest-priority org-lowest-priority)
12103 (save-match-data
12104 (setq new (read-char-exclusive))))
12105 (if (and (= (upcase org-highest-priority) org-highest-priority)
12106 (= (upcase org-lowest-priority) org-lowest-priority))
12107 (setq new (upcase new)))
12108 (cond ((equal new ?\ ) (setq remove t))
12109 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12110 (error "Priority must be between `%c' and `%c'"
12111 org-highest-priority org-lowest-priority))))
12112 ((eq action 'up)
12113 (if (and (not have) (eq last-command this-command))
12114 (setq new org-lowest-priority)
12115 (setq new (if (and org-priority-start-cycle-with-default (not have))
12116 org-default-priority (1- current)))))
12117 ((eq action 'down)
12118 (if (and (not have) (eq last-command this-command))
12119 (setq new org-highest-priority)
12120 (setq new (if (and org-priority-start-cycle-with-default (not have))
12121 org-default-priority (1+ current)))))
12122 (t (error "Invalid action")))
12123 (if (or (< (upcase new) org-highest-priority)
12124 (> (upcase new) org-lowest-priority))
12125 (setq remove t))
12126 (setq news (format "%c" new))
12127 (if have
12128 (if remove
12129 (replace-match "" t t nil 1)
12130 (replace-match news t t nil 2))
12131 (if remove
12132 (error "No priority cookie found in line")
12133 (let ((case-fold-search nil))
12134 (looking-at org-todo-line-regexp))
12135 (if (match-end 2)
12136 (progn
12137 (goto-char (match-end 2))
12138 (insert " [#" news "]"))
12139 (goto-char (match-beginning 3))
12140 (insert "[#" news "] "))))
12141 (org-preserve-lc (org-set-tags nil 'align)))
12142 (if remove
12143 (message "Priority removed")
12144 (message "Priority of current item set to %s" news))))
12146 (defun org-get-priority (s)
12147 "Find priority cookie and return priority."
12148 (save-match-data
12149 (if (not (string-match org-priority-regexp s))
12150 (* 1000 (- org-lowest-priority org-default-priority))
12151 (* 1000 (- org-lowest-priority
12152 (string-to-char (match-string 2 s)))))))
12154 ;;;; Tags
12156 (defvar org-agenda-archives-mode)
12157 (defvar org-map-continue-from nil
12158 "Position from where mapping should continue.
12159 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12161 (defvar org-scanner-tags nil
12162 "The current tag list while the tags scanner is running.")
12163 (defvar org-trust-scanner-tags nil
12164 "Should `org-get-tags-at' use the tags fro the scanner.
12165 This is for internal dynamical scoping only.
12166 When this is non-nil, the function `org-get-tags-at' will return the value
12167 of `org-scanner-tags' instead of building the list by itself. This
12168 can lead to large speed-ups when the tags scanner is used in a file with
12169 many entries, and when the list of tags is retrieved, for example to
12170 obtain a list of properties. Building the tags list for each entry in such
12171 a file becomes an N^2 operation - but with this variable set, it scales
12172 as N.")
12174 (defun org-scan-tags (action matcher &optional todo-only)
12175 "Scan headline tags with inheritance and produce output ACTION.
12177 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12178 or `agenda' to produce an entry list for an agenda view. It can also be
12179 a Lisp form or a function that should be called at each matched headline, in
12180 this case the return value is a list of all return values from these calls.
12182 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12183 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12184 only lines with a TODO keyword are included in the output."
12185 (require 'org-agenda)
12188 (org-re
12190 (props (list 'face 'default
12191 'done-face 'org-agenda-done
12192 'undone-face 'default
12193 'mouse-face 'highlight
12194 'org-not-done-regexp org-not-done-regexp
12195 'org-todo-regexp org-todo-regexp
12196 'help-echo
12197 (format "mouse-2 or RET jump to org file %s"
12198 (abbreviate-file-name
12199 (or (buffer-file-name (buffer-base-buffer))
12200 (buffer-name (buffer-base-buffer)))))))
12201 (case-fold-search nil)
12202 (org-map-continue-from nil)
12203 lspos tags tags-list
12204 (tags-alist (list (cons 0 org-file-tags)))
12205 (llast 0) rtn rtn1 level category i txt
12206 todo marker entry priority)
12207 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12208 (setq action (list 'lambda nil action)))
12209 (save-excursion
12210 (goto-char (point-min))
12211 (when (eq action 'sparse-tree)
12212 (org-overview)
12213 (org-remove-occur-highlights))
12214 (while (re-search-forward re nil t)
12215 (catch :skip
12216 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12217 tags (if (match-end 4) (org-match-string-no-properties 4)))
12218 (goto-char (setq lspos (match-beginning 0)))
12219 (setq level (org-reduced-level (funcall outline-level))
12220 category (org-get-category))
12221 (setq i llast llast level)
12222 ;; remove tag lists from same and sublevels
12223 (while (>= i level)
12224 (when (setq entry (assoc i tags-alist))
12225 (setq tags-alist (delete entry tags-alist)))
12226 (setq i (1- i)))
12227 ;; add the next tags
12228 (when tags
12229 (setq tags (org-split-string tags ":")
12230 tags-alist
12231 (cons (cons level tags) tags-alist)))
12232 ;; compile tags for current headline
12233 (setq tags-list
12234 (if org-use-tag-inheritance
12235 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12236 tags)
12237 org-scanner-tags tags-list)
12238 (when org-use-tag-inheritance
12239 (setcdr (car tags-alist)
12240 (mapcar (lambda (x)
12241 (setq x (copy-sequence x))
12242 (org-add-prop-inherited x))
12243 (cdar tags-alist))))
12244 (when (and tags org-use-tag-inheritance
12245 (or (not (eq t org-use-tag-inheritance))
12246 org-tags-exclude-from-inheritance))
12247 ;; selective inheritance, remove uninherited ones
12248 (setcdr (car tags-alist)
12249 (org-remove-uniherited-tags (cdar tags-alist))))
12250 (when (and (or (not todo-only)
12251 (and (member todo org-not-done-keywords)
12252 (or (not org-agenda-tags-todo-honor-ignore-options)
12253 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12254 (let ((case-fold-search t)) (eval matcher))
12255 (or
12256 (not (member org-archive-tag tags-list))
12257 ;; we have an archive tag, should we use this anyway?
12258 (or (not org-agenda-skip-archived-trees)
12259 (and (eq action 'agenda) org-agenda-archives-mode))))
12260 (unless (eq action 'sparse-tree) (org-agenda-skip))
12262 ;; select this headline
12264 (cond
12265 ((eq action 'sparse-tree)
12266 (and org-highlight-sparse-tree-matches
12267 (org-get-heading) (match-end 0)
12268 (org-highlight-new-match
12269 (match-beginning 0) (match-beginning 1)))
12270 (org-show-context 'tags-tree))
12271 ((eq action 'agenda)
12272 (setq txt (org-format-agenda-item
12273 ""
12274 (concat
12275 (if (eq org-tags-match-list-sublevels 'indented)
12276 (make-string (1- level) ?.) "")
12277 (org-get-heading))
12278 category
12279 tags-list
12280 )
12281 priority (org-get-priority txt))
12282 (goto-char lspos)
12283 (setq marker (org-agenda-new-marker))
12284 (org-add-props txt props
12285 'org-marker marker 'org-hd-marker marker 'org-category category
12286 'todo-state todo
12287 'priority priority 'type "tagsmatch")
12288 (push txt rtn))
12289 ((functionp action)
12290 (setq org-map-continue-from nil)
12291 (save-excursion
12292 (setq rtn1 (funcall action))
12293 (push rtn1 rtn)))
12294 (t (error "Invalid action")))
12296 ;; if we are to skip sublevels, jump to end of subtree
12297 (unless org-tags-match-list-sublevels
12298 (org-end-of-subtree t)
12299 (backward-char 1))))
12300 ;; Get the correct position from where to continue
12301 (if org-map-continue-from
12302 (goto-char org-map-continue-from)
12303 (and (= (point) lspos) (end-of-line 1)))))
12304 (when (and (eq action 'sparse-tree)
12305 (not org-sparse-tree-open-archived-trees))
12306 (org-hide-archived-subtrees (point-min) (point-max)))
12307 (nreverse rtn)))
12309 (defun org-remove-uniherited-tags (tags)
12310 "Remove all tags that are not inherited from the list TAGS."
12311 (cond
12312 ((eq org-use-tag-inheritance t)
12313 (if org-tags-exclude-from-inheritance
12314 (org-delete-all org-tags-exclude-from-inheritance tags)
12315 tags))
12316 ((not org-use-tag-inheritance) nil)
12317 ((stringp org-use-tag-inheritance)
12318 (delq nil (mapcar
12319 (lambda (x)
12320 (if (and (string-match org-use-tag-inheritance x)
12321 (not (member x org-tags-exclude-from-inheritance)))
12322 x nil))
12323 tags)))
12324 ((listp org-use-tag-inheritance)
12325 (delq nil (mapcar
12326 (lambda (x)
12327 (if (member x org-use-tag-inheritance) x nil))
12328 tags)))))
12330 (defvar todo-only) ;; dynamically scoped
12332 (defun org-match-sparse-tree (&optional todo-only match)
12333 "Create a sparse tree according to tags string MATCH.
12334 MATCH can contain positive and negative selection of tags, like
12336 If optional argument TODO-ONLY is non-nil, only select lines that are
12337 also TODO lines."
12338 (interactive "P")
12339 (org-prepare-agenda-buffers (list (current-buffer)))
12340 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12342 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12344 (defvar org-cached-props nil)
12345 (defun org-cached-entry-get (pom property)
12346 (if (or (eq t org-use-property-inheritance)
12347 (and (stringp org-use-property-inheritance)
12348 (string-match org-use-property-inheritance property))
12349 (and (listp org-use-property-inheritance)
12350 (member property org-use-property-inheritance)))
12351 ;; Caching is not possible, check it directly
12352 (org-entry-get pom property 'inherit)
12353 ;; Get all properties, so that we can do complicated checks easily
12354 (cdr (assoc property (or org-cached-props
12355 (setq org-cached-props
12356 (org-entry-properties pom)))))))
12358 (defun org-global-tags-completion-table (&optional files)
12359 "Return the list of all tags in all agenda buffer/files."
12360 (save-excursion
12361 (org-uniquify
12362 (delq nil
12363 (apply 'append
12364 (mapcar
12365 (lambda (file)
12366 (set-buffer (find-file-noselect file))
12367 (append (org-get-buffer-tags)
12368 (mapcar (lambda (x) (if (stringp (car-safe x))
12369 (list (car-safe x)) nil))
12370 org-tag-alist)))
12371 (if (and files (car files))
12372 files
12373 (org-agenda-files))))))))
12375 (defun org-make-tags-matcher (match)
12376 "Create the TAGS//TODO matcher form for the selection string MATCH."
12377 ;; todo-only is scoped dynamically into this function, and the function
12378 ;; may change it if the matcher asks for it.
12379 (unless match
12380 ;; Get a new match request, with completion
12381 (let ((org-last-tags-completion-table
12382 (org-global-tags-completion-table)))
12383 (setq match (org-completing-read-no-i
12384 "Match: " 'org-tags-completion-function nil nil nil
12385 'org-tags-history))))
12387 ;; Parse the string and create a lisp form
12388 (let ((match0 match)
12389 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12390 minus tag mm
12391 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12392 orterms term orlist re-p str-p level-p level-op time-p
12393 prop-p pn pv po cat-p gv rest)
12394 (if (string-match "/+" match)
12395 ;; match contains also a todo-matching request
12396 (progn
12397 (setq tagsmatch (substring match 0 (match-beginning 0))
12398 todomatch (substring match (match-end 0)))
12399 (if (string-match "^!" todomatch)
12400 (setq todo-only t todomatch (substring todomatch 1)))
12402 (setq todomatch nil)))
12403 ;; only matching tags
12404 (setq tagsmatch match todomatch nil))
12406 ;; Make the tags matcher
12408 (setq tagsmatcher t)
12409 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12410 (while (setq term (pop orterms))
12412 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12413 (while (string-match re term)
12414 (setq rest (substring term (match-end 0))
12415 minus (and (match-end 1)
12416 (equal (match-string 1 term) "-"))
12417 tag (save-match-data (replace-regexp-in-string
12419 (match-string 2 term)))
12420 re-p (equal (string-to-char tag) ?{)
12421 level-p (match-end 4)
12422 prop-p (match-end 5)
12423 mm (cond
12424 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12425 (level-p
12426 (setq level-op (org-op-to-function (match-string 3 term)))
12427 `(,level-op level ,(string-to-number
12428 (match-string 4 term))))
12429 (prop-p
12430 (setq pn (match-string 5 term)
12431 po (match-string 6 term)
12432 pv (match-string 7 term)
12433 cat-p (equal pn "CATEGORY")
12434 re-p (equal (string-to-char pv) ?{)
12436 time-p (save-match-data
12438 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12439 (if time-p (setq pv (org-matcher-time pv)))
12440 (setq po (org-op-to-function po (if time-p 'time str-p)))
12441 (cond
12442 ((equal pn "CATEGORY")
12443 (setq gv '(get-text-property (point) 'org-category)))
12444 ((equal pn "TODO")
12445 (setq gv 'todo))
12446 (t
12447 (setq gv `(org-cached-entry-get nil ,pn))))
12448 (if re-p
12449 (if (eq po 'org<>)
12450 `(not (string-match ,pv (or ,gv "")))
12451 `(string-match ,pv (or ,gv "")))
12452 (if str-p
12453 `(,po (or ,gv "") ,pv)
12454 `(,po (string-to-number (or ,gv ""))
12455 ,(string-to-number pv) ))))
12456 (t `(member ,tag tags-list)))
12457 mm (if minus (list 'not mm) mm)
12458 term rest)
12459 (push mm tagsmatcher))
12460 (push (if (> (length tagsmatcher) 1)
12461 (cons 'and tagsmatcher)
12462 (car tagsmatcher))
12463 orlist)
12464 (setq tagsmatcher nil))
12465 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12466 (setq tagsmatcher
12467 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12468 ;; Make the todo matcher
12470 (setq todomatcher t)
12471 (setq orterms (org-split-string todomatch "|") orlist nil)
12472 (while (setq term (pop orterms))
12473 (while (string-match re term)
12474 (setq minus (and (match-end 1)
12475 (equal (match-string 1 term) "-"))
12476 kwd (match-string 2 term)
12477 re-p (equal (string-to-char kwd) ?{)
12478 term (substring term (match-end 0))
12479 mm (if re-p
12480 `(string-match ,(substring kwd 1 -1) todo)
12481 (list 'equal 'todo kwd))
12482 mm (if minus (list 'not mm) mm))
12483 (push mm todomatcher))
12484 (push (if (> (length todomatcher) 1)
12485 (cons 'and todomatcher)
12486 (car todomatcher))
12487 orlist)
12488 (setq todomatcher nil))
12489 (setq todomatcher (if (> (length orlist) 1)
12490 (cons 'or orlist) (car orlist))))
12492 ;; Return the string and lisp forms of the matcher
12493 (setq matcher (if todomatcher
12494 (list 'and tagsmatcher todomatcher)
12495 tagsmatcher))
12496 (cons match0 matcher)))
12498 (defun org-op-to-function (op &optional stringp)
12499 "Turn an operator into the appropriate function."
12500 (setq op
12501 (cond
12502 ((equal op "<" ) '(< string< org-time<))
12503 ((equal op ">" ) '(> org-string> org-time>))
12504 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12505 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12506 ((member op '("=" "==")) '(= string= org-time=))
12507 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12508 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12510 (defun org<> (a b) (not (= a b)))
12511 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12512 (defun org-string>= (a b) (not (string< a b)))
12513 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12514 (defun org-string<> (a b) (not (string= a b)))
12515 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12516 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12517 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12518 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12519 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12520 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12521 (defun org-2ft (s)
12522 "Convert S to a floating point time.
12523 If S is already a number, just return it. If it is a string, parse
12524 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12525 (cond
12526 ((numberp s) s)
12527 ((stringp s)
12528 (condition-case nil
12529 (float-time (apply 'encode-time (org-parse-time-string s)))
12530 (error 0.)))
12531 (t 0.)))
12533 (defun org-time-today ()
12534 "Time in seconds today at 0:00.
12535 Returns the float number of seconds since the beginning of the
12536 epoch to the beginning of today (00:00)."
12537 (float-time (apply 'encode-time
12538 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12540 (defun org-matcher-time (s)
12541 "Interpret a time comparison value."
12542 (save-match-data
12543 (cond
12544 ((string= s "<now>") (float-time))
12545 ((string= s "<today>") (org-time-today))
12546 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12547 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12549 (+ (org-time-today)
12550 (* (string-to-number (match-string 1 s))
12551 (cdr (assoc (match-string 2 s)
12552 '(("d" . 86400.0) ("w" . 604800.0)
12553 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12554 (t (org-2ft s)))))
12556 (defun org-match-any-p (re list)
12557 "Does re match any element of list?"
12558 (setq list (mapcar (lambda (x) (string-match re x)) list))
12559 (delq nil list))
12561 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12562 (defvar org-tags-overlay (make-overlay 1 1))
12563 (org-detach-overlay org-tags-overlay)
12565 (defun org-get-local-tags-at (&optional pos)
12566 "Get a list of tags defined in the current headline."
12567 (org-get-tags-at pos 'local))
12569 (defun org-get-local-tags ()
12570 "Get a list of tags defined in the current headline."
12571 (org-get-tags-at nil 'local))
12573 (defun org-get-tags-at (&optional pos local)
12574 "Get a list of all headline tags applicable at POS.
12575 POS defaults to point. If tags are inherited, the list contains
12576 the targets in the same sequence as the headlines appear, i.e.
12577 the tags of the current headline come last.
12578 When LOCAL is non-nil, only return tags from the current headline,
12579 ignore inherited ones."
12580 (interactive)
12581 (if (and org-trust-scanner-tags
12582 (or (not pos) (equal pos (point)))
12583 (not local))
12584 org-scanner-tags
12585 (let (tags ltags lastpos parent)
12586 (save-excursion
12587 (save-restriction
12588 (widen)
12589 (goto-char (or pos (point)))
12590 (save-match-data
12591 (catch 'done
12592 (condition-case nil
12593 (progn
12594 (org-back-to-heading t)
12595 (while (not (equal lastpos (point)))
12596 (setq lastpos (point))
12597 (when (looking-at
12599 (setq ltags (org-split-string
12600 (org-match-string-no-properties 1) ":"))
12601 (when parent
12602 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12603 (setq tags (append
12604 (if parent
12605 (org-remove-uniherited-tags ltags)
12606 ltags)
12607 tags)))
12608 (or org-use-tag-inheritance (throw 'done t))
12609 (if local (throw 'done t))
12610 (or (org-up-heading-safe) (error nil))
12611 (setq parent t)))
12612 (error nil)))))
12613 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12615 (defun org-add-prop-inherited (s)
12616 (add-text-properties 0 (length s) '(inherited t) s)
12617 s)
12619 (defun org-toggle-tag (tag &optional onoff)
12620 "Toggle the tag TAG for the current line.
12621 If ONOFF is `on' or `off', don't toggle but set to this state."
12622 (let (res current)
12623 (save-excursion
12624 (org-back-to-heading t)
12626 (point-at-eol) t)
12627 (progn
12628 (setq current (match-string 1))
12629 (replace-match ""))
12630 (setq current ""))
12631 (setq current (nreverse (org-split-string current ":")))
12632 (cond
12633 ((eq onoff 'on)
12634 (setq res t)
12635 (or (member tag current) (push tag current)))
12636 ((eq onoff 'off)
12637 (or (not (member tag current)) (setq current (delete tag current))))
12638 (t (if (member tag current)
12639 (setq current (delete tag current))
12640 (setq res t)
12641 (push tag current))))
12642 (end-of-line 1)
12643 (if current
12644 (progn
12645 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12646 (org-set-tags nil t))
12647 (delete-horizontal-space))
12648 (run-hooks 'org-after-tags-change-hook))
12649 res))
12651 (defun org-align-tags-here (to-col)
12652 ;; Assumes that this is a headline
12653 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12654 (beginning-of-line 1)
12656 (< pos (match-beginning 2)))
12657 (progn
12658 (setq tags-l (- (match-end 2) (match-beginning 2)))
12659 (goto-char (match-beginning 1))
12660 (insert " ")
12661 (delete-region (point) (1+ (match-beginning 2)))
12662 (setq ncol (max (1+ (current-column))
12663 (1+ col)
12664 (if (> to-col 0)
12665 to-col
12666 (- (abs to-col) tags-l))))
12667 (setq p (point))
12668 (insert (make-string (- ncol (current-column)) ?\ ))
12669 (setq ncol (current-column))
12670 (when indent-tabs-mode (tabify p (point-at-eol)))
12671 (org-move-to-column (min ncol col) t))
12672 (goto-char pos))))
12674 (defun org-set-tags-command (&optional arg just-align)
12675 "Call the set-tags command for the current entry."
12676 (interactive "P")
12677 (if (org-on-heading-p)
12678 (org-set-tags arg just-align)
12679 (save-excursion
12680 (org-back-to-heading t)
12681 (org-set-tags arg just-align))))
12683 (defun org-set-tags-to (data)
12684 "Set the tags of the current entry to DATA, replacing the current tags.
12685 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12686 If DATA is nil or the empty string, any tags will be removed."
12687 (interactive "sTags: ")
12688 (setq data
12689 (cond
12690 ((eq data nil) "")
12691 ((equal data "") "")
12692 ((stringp data)
12693 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12694 ":"))
12695 ((listp data)
12696 (concat ":" (mapconcat 'identity data ":") ":"))
12697 (t nil)))
12698 (when data
12699 (save-excursion
12700 (org-back-to-heading t)
12701 (when (looking-at org-complex-heading-regexp)
12702 (if (match-end 5)
12703 (progn
12704 (goto-char (match-beginning 5))
12705 (insert data)
12706 (delete-region (point) (point-at-eol))
12707 (org-set-tags nil 'align))
12708 (goto-char (point-at-eol))
12709 (insert " " data)
12710 (org-set-tags nil 'align)))
12711 (beginning-of-line 1)
12713 (delete-region (match-beginning 1) (match-end 1))))))
12715 (defun org-align-all-tags ()
12716 "Align the tags i all headings."
12717 (interactive)
12718 (save-excursion
12719 (or (ignore-errors (org-back-to-heading t))
12720 (outline-next-heading))
12721 (if (org-on-heading-p)
12722 (org-set-tags t)
12723 (message "No headings"))))
12725 (defvar org-indent-indentation-per-level)
12726 (defun org-set-tags (&optional arg just-align)
12727 "Set the tags for the current headline.
12728 With prefix ARG, realign all tags in headings in the current buffer."
12729 (interactive "P")
12730 (let* ((re (concat "^" outline-regexp))
12731 (current (org-get-tags-string))
12732 (col (current-column))
12733 (org-setting-tags t)
12734 table current-tags inherited-tags ; computed below when needed
12735 tags p0 c0 c1 rpl di tc level)
12736 (if arg
12737 (save-excursion
12738 (goto-char (point-min))
12739 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12740 (while (re-search-forward re nil t)
12741 (org-set-tags nil t)
12742 (end-of-line 1)))
12743 (message "All tags realigned to column %d" org-tags-column))
12744 (if just-align
12745 (setq tags current)
12746 ;; Get a new set of tags from the user
12747 (save-excursion
12748 (setq table (append org-tag-persistent-alist
12749 (or org-tag-alist (org-get-buffer-tags))
12750 (and org-complete-tags-always-offer-all-agenda-tags
12751 (org-global-tags-completion-table (org-agenda-files))))
12752 org-last-tags-completion-table table
12753 current-tags (org-split-string current ":")
12754 inherited-tags (nreverse
12755 (nthcdr (length current-tags)
12756 (nreverse (org-get-tags-at))))
12757 tags
12758 (if (or (eq t org-use-fast-tag-selection)
12759 (and org-use-fast-tag-selection
12760 (delq nil (mapcar 'cdr table))))
12761 (org-fast-tag-selection
12762 current-tags inherited-tags table
12763 (if org-fast-tag-selection-include-todo org-todo-key-alist))
12764 (let ((org-add-colon-after-tag-completion t))
12765 (org-trim
12766 (org-without-partial-completion
12767 (org-icompleting-read "Tags: " 'org-tags-completion-function
12768 nil nil current 'org-tags-history)))))))
12769 (while (string-match "[-+&]+" tags)
12770 ;; No boolean logic, just a list
12771 (setq tags (replace-match ":" t t tags))))
12773 (if org-tags-sort-function
12774 (setq tags (mapconcat 'identity
12775 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
12776 org-tags-sort-function) ":")))
12779 (setq tags "")
12780 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12781 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12783 ;; Insert new tags at the correct column
12784 (beginning-of-line 1)
12785 (setq level (or (and (looking-at org-outline-regexp)
12786 (- (match-end 0) (point) 1))
12787 1))
12788 (cond
12789 ((and (equal current "") (equal tags "")))
12790 ((re-search-forward
12792 (point-at-eol) t)
12793 (if (equal tags "")
12794 (setq rpl "")
12795 (goto-char (match-beginning 0))
12796 (setq c0 (current-column)
12797 ;; compute offset for the case of org-indent-mode active
12798 di (if org-indent-mode
12799 (* (1- org-indent-indentation-per-level) (1- level))
12800 0)
12801 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12802 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12803 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12804 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12805 (replace-match rpl t t)
12806 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12807 tags)
12808 (t (error "Tags alignment failed")))
12809 (org-move-to-column col)
12810 (unless just-align
12811 (run-hooks 'org-after-tags-change-hook)))))
12813 (defun org-change-tag-in-region (beg end tag off)
12814 "Add or remove TAG for each entry in the region.
12815 This works in the agenda, and also in an org-mode buffer."
12816 (interactive
12817 (list (region-beginning) (region-end)
12818 (let ((org-last-tags-completion-table
12819 (if (org-mode-p)
12820 (org-get-buffer-tags)
12821 (org-global-tags-completion-table))))
12822 (org-icompleting-read
12823 "Tag: " 'org-tags-completion-function nil nil nil
12824 'org-tags-history))
12825 (progn
12827 (equal (read-char-exclusive) ?r))))
12828 (if (fboundp 'deactivate-mark) (deactivate-mark))
12829 (let ((agendap (equal major-mode 'org-agenda-mode))
12830 l1 l2 m buf pos newhead (cnt 0))
12831 (goto-char end)
12832 (setq l2 (1- (org-current-line)))
12833 (goto-char beg)
12834 (setq l1 (org-current-line))
12835 (loop for l from l1 to l2 do
12836 (org-goto-line l)
12837 (setq m (get-text-property (point) 'org-hd-marker))
12838 (when (or (and (org-mode-p) (org-on-heading-p))
12839 (and agendap m))
12840 (setq buf (if agendap (marker-buffer m) (current-buffer))
12841 pos (if agendap m (point)))
12842 (with-current-buffer buf
12843 (save-excursion
12844 (save-restriction
12845 (goto-char pos)
12846 (setq cnt (1+ cnt))
12847 (org-toggle-tag tag (if off 'off 'on))
12848 (setq newhead (org-get-heading)))))
12849 (and agendap (org-agenda-change-all-lines newhead m))))
12850 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12852 (defun org-tags-completion-function (string predicate &optional flag)
12853 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12854 (confirm (lambda (x) (stringp (car x)))))
12856 (setq s1 (match-string 1 string)
12857 s2 (match-string 2 string))
12858 (setq s1 "" s2 string))
12859 (cond
12860 ((eq flag nil)
12861 ;; try completion
12862 (setq rtn (try-completion s2 ctable confirm))
12863 (if (stringp rtn)
12864 (setq rtn
12865 (concat s1 s2 (substring rtn (length s2))
12866 (if (and org-add-colon-after-tag-completion
12867 (assoc rtn ctable))
12868 ":" ""))))
12869 rtn)
12870 ((eq flag t)
12871 ;; all-completions
12872 (all-completions s2 ctable confirm)
12873 )
12874 ((eq flag 'lambda)
12875 ;; exact match?
12876 (assoc s2 ctable)))
12877 ))
12879 (defun org-fast-tag-insert (kwd tags face &optional end)
12880 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12881 (insert (format "%-12s" (concat kwd ":"))
12882 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12883 (or end "")))
12885 (defun org-fast-tag-show-exit (flag)
12886 (save-excursion
12887 (org-goto-line 3)
12889 (replace-match ""))
12890 (when flag
12891 (end-of-line 1)
12892 (org-move-to-column (- (window-width) 19) t)
12893 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12895 (defun org-set-current-tags-overlay (current prefix)
12896 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12897 (if (featurep 'xemacs)
12898 (org-overlay-display org-tags-overlay (concat prefix s)
12899 'secondary-selection)
12900 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12901 (org-overlay-display org-tags-overlay (concat prefix s)))))
12903 (defvar org-last-tag-selection-key nil)
12904 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12905 "Fast tag selection with single keys.
12906 CURRENT is the current list of tags in the headline, INHERITED is the
12907 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12908 possibly with grouping information. TODO-TABLE is a similar table with
12909 TODO keywords, should these have keys assigned to them.
12910 If the keys are nil, a-z are automatically assigned.
12911 Returns the new tags string, or nil to not change the current settings."
12912 (let* ((fulltable (append table todo-table))
12913 (maxlen (apply 'max (mapcar
12914 (lambda (x)
12915 (if (stringp (car x)) (string-width (car x)) 0))
12916 fulltable)))
12917 (buf (current-buffer))
12918 (expert (eq org-fast-tag-selection-single-key 'expert))
12919 (buffer-tags nil)
12920 (fwidth (+ maxlen 3 1 3))
12921 (ncol (/ (- (window-width) 4) fwidth))
12922 (i-face 'org-done)
12923 (c-face 'org-todo)
12924 tg cnt e c char c1 c2 ntable tbl rtn
12925 ov-start ov-end ov-prefix
12926 (exit-after-next org-fast-tag-selection-single-key)
12927 (done-keywords org-done-keywords)
12928 groups ingroup)
12929 (save-excursion
12930 (beginning-of-line 1)
12931 (if (looking-at
12933 (setq ov-start (match-beginning 1)
12934 ov-end (match-end 1)
12935 ov-prefix "")
12936 (setq ov-start (1- (point-at-eol))
12937 ov-end (1+ ov-start))
12939 (setq ov-prefix
12940 (concat
12941 (buffer-substring (1- (point)) (point))
12942 (if (> (current-column) org-tags-column)
12943 " "
12944 (make-string (- org-tags-column (current-column)) ?\ ))))))
12945 (move-overlay org-tags-overlay ov-start ov-end)
12946 (save-window-excursion
12947 (if expert
12948 (set-buffer (get-buffer-create " *Org tags*"))
12949 (delete-other-windows)
12950 (split-window-vertically)
12951 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12952 (erase-buffer)
12953 (org-set-local 'org-done-keywords done-keywords)
12956 (org-fast-tag-show-exit exit-after-next)
12957 (org-set-current-tags-overlay current ov-prefix)
12958 (setq tbl fulltable char ?a cnt 0)
12959 (while (setq e (pop tbl))
12960 (cond
12961 ((equal (car e) :startgroup)
12962 (push '() groups) (setq ingroup t)
12963 (when (not (= cnt 0))
12964 (setq cnt 0)
12966 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12967 ((equal (car e) :endgroup)
12968 (setq ingroup nil cnt 0)
12970 ((equal e '(:newline))
12971 (when (not (= cnt 0))
12972 (setq cnt 0)
12974 (setq e (car tbl))
12975 (while (equal (car tbl) '(:newline))
12977 (setq tbl (cdr tbl)))))
12978 (t
12979 (setq tg (copy-sequence (car e)) c2 nil)
12980 (if (cdr e)
12981 (setq c (cdr e))
12982 ;; automatically assign a character.
12983 (setq c1 (string-to-char
12984 (downcase (substring
12985 tg (if (= (string-to-char tg) ?@) 1 0)))))
12986 (if (or (rassoc c1 ntable) (rassoc c1 table))
12987 (while (or (rassoc char ntable) (rassoc char table))
12988 (setq char (1+ char)))
12989 (setq c2 c1))
12990 (setq c (or c2 char)))
12991 (if ingroup (push tg (car groups)))
12992 (setq tg (org-add-props tg nil 'face
12993 (cond
12994 ((not (assoc tg table))
12995 (org-get-todo-face tg))
12996 ((member tg current) c-face)
12997 ((member tg inherited) i-face)
12998 (t nil))))
12999 (if (and (= cnt 0) (not ingroup)) (insert " "))
13000 (insert "[" c "] " tg (make-string
13001 (- fwidth 4 (length tg)) ?\ ))
13002 (push (cons tg c) ntable)
13003 (when (= (setq cnt (1+ cnt)) ncol)
13005 (if ingroup (insert " "))
13006 (setq cnt 0)))))
13007 (setq ntable (nreverse ntable))
13009 (goto-char (point-min))
13010 (if (not expert) (org-fit-window-to-buffer))
13011 (setq rtn
13012 (catch 'exit
13013 (while t
13014 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13015 (if (not groups) "no " "")
13016 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13017 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13018 (setq org-last-tag-selection-key c)
13019 (cond
13021 ((= c ?!)
13022 (setq groups (not groups))
13023 (goto-char (point-min))
13024 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13025 ((= c ?\C-c)
13026 (if (not expert)
13027 (org-fast-tag-show-exit
13028 (setq exit-after-next (not exit-after-next)))
13029 (setq expert nil)
13030 (delete-other-windows)
13031 (split-window-vertically)
13032 (org-switch-to-buffer-other-window " *Org tags*")
13033 (org-fit-window-to-buffer)))
13034 ((or (= c ?\C-g)
13035 (and (= c ?q) (not (rassoc c ntable))))
13036 (org-detach-overlay org-tags-overlay)
13037 (setq quit-flag t))
13038 ((= c ?\ )
13039 (setq current nil)
13040 (if exit-after-next (setq exit-after-next 'now)))
13042 (condition-case nil
13043 (setq tg (org-icompleting-read
13044 "Tag: "
13045 (or buffer-tags
13046 (with-current-buffer buf
13047 (org-get-buffer-tags)))))
13048 (quit (setq tg "")))
13050 (add-to-list 'buffer-tags (list tg))
13051 (if (member tg current)
13052 (setq current (delete tg current))
13053 (push tg current)))
13054 (if exit-after-next (setq exit-after-next 'now)))
13055 ((setq e (rassoc c todo-table) tg (car e))
13056 (with-current-buffer buf
13057 (save-excursion (org-todo tg)))
13058 (if exit-after-next (setq exit-after-next 'now)))
13059 ((setq e (rassoc c ntable) tg (car e))
13060 (if (member tg current)
13061 (setq current (delete tg current))
13062 (loop for g in groups do
13063 (if (member tg g)
13064 (mapc (lambda (x)
13065 (setq current (delete x current)))
13066 g)))
13067 (push tg current))
13068 (if exit-after-next (setq exit-after-next 'now))))
13070 ;; Create a sorted list
13071 (setq current
13072 (sort current
13073 (lambda (a b)
13074 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13075 (if (eq exit-after-next 'now) (throw 'exit t))
13076 (goto-char (point-min))
13077 (beginning-of-line 2)
13078 (delete-region (point) (point-at-eol))
13079 (org-fast-tag-insert "Current" current c-face)
13080 (org-set-current-tags-overlay current ov-prefix)
13081 (while (re-search-forward
13083 (setq tg (match-string 1))
13084 (add-text-properties
13085 (match-beginning 1) (match-end 1)
13086 (list 'face
13087 (cond
13088 ((member tg current) c-face)
13089 ((member tg inherited) i-face)
13090 (t (get-text-property (match-beginning 1) 'face))))))
13091 (goto-char (point-min)))))
13092 (org-detach-overlay org-tags-overlay)
13093 (if rtn
13094 (mapconcat 'identity current ":")
13095 nil))))
13097 (defun org-get-tags-string ()
13098 "Get the TAGS string in the current headline."
13099 (unless (org-on-heading-p t)
13100 (error "Not on a heading"))
13101 (save-excursion
13102 (beginning-of-line 1)
13104 (org-match-string-no-properties 1)
13105 "")))
13107 (defun org-get-tags ()
13108 "Get the list of tags specified in the current headline."
13109 (org-split-string (org-get-tags-string) ":"))
13111 (defun org-get-buffer-tags ()
13112 "Get a table of all tags used in the buffer, for completion."
13113 (let (tags)
13114 (save-excursion
13115 (goto-char (point-min))
13116 (while (re-search-forward
13118 (when (equal (char-after (point-at-bol 0)) ?*)
13119 (mapc (lambda (x) (add-to-list 'tags x))
13120 (org-split-string (org-match-string-no-properties 1) ":")))))
13121 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13122 (mapcar 'list tags)))
13124 ;;;; The mapping API
13126 ;;;###autoload
13127 (defun org-map-entries (func &optional match scope &rest skip)
13128 "Call FUNC at each headline selected by MATCH in SCOPE.
13130 FUNC is a function or a lisp form. The function will be called without
13131 arguments, with the cursor positioned at the beginning of the headline.
13132 The return values of all calls to the function will be collected and
13133 returned as a list.
13135 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13136 does not need to preserve point. After evaluation, the cursor will be
13137 moved to the end of the line (presumably of the headline of the
13138 processed entry) and search continues from there. Under some
13139 circumstances, this may not produce the wanted results. For example,
13140 if you have removed (e.g. archived) the current (sub)tree it could
13141 mean that the next entry will be skipped entirely. In such cases, you
13142 can specify the position from where search should continue by making
13143 FUNC set the variable `org-map-continue-from' to the desired buffer
13144 position.
13146 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13147 Only headlines that are matched by this query will be considered during
13148 the iteration. When MATCH is nil or t, all headlines will be
13149 visited by the iteration.
13151 SCOPE determines the scope of this command. It can be any of:
13153 nil The current buffer, respecting the restriction if any
13154 tree The subtree started with the entry at point
13155 file The current buffer, without restriction
13156 file-with-archives
13157 The current buffer, and any archives associated with it
13158 agenda All agenda files
13159 agenda-with-archives
13160 All agenda files with any archive files associated with them
13161 \(file1 file2 ...)
13162 If this is a list, all files in the list will be scanned
13164 The remaining args are treated as settings for the skipping facilities of
13165 the scanner. The following items can be given here:
13167 archive skip trees with the archive tag.
13168 comment skip trees with the COMMENT keyword
13169 function or Emacs Lisp form:
13170 will be used as value for `org-agenda-skip-function', so whenever
13171 the function returns t, FUNC will not be called for that
13172 entry and search will continue from the point where the
13173 function leaves it.
13175 If your function needs to retrieve the tags including inherited tags
13176 at the *current* entry, you can use the value of the variable
13177 `org-scanner-tags' which will be much faster than getting the value
13178 with `org-get-tags-at'. If your function gets properties with
13179 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13180 to t around the call to `org-entry-properties' to get the same speedup.
13181 Note that if your function moves around to retrieve tags and properties at
13182 a *different* entry, you cannot use these techniques."
13183 (let* ((org-agenda-archives-mode nil) ; just to make sure
13184 (org-agenda-skip-archived-trees (memq 'archive skip))
13185 (org-agenda-skip-comment-trees (memq 'comment skip))
13186 (org-agenda-skip-function
13187 (car (org-delete-all '(comment archive) skip)))
13188 (org-tags-match-list-sublevels t)
13189 matcher file res
13190 org-todo-keywords-for-agenda
13191 org-done-keywords-for-agenda
13192 org-todo-keyword-alist-for-agenda
13193 org-drawers-for-agenda
13194 org-tag-alist-for-agenda)
13196 (cond
13197 ((eq match t) (setq matcher t))
13198 ((eq match nil) (setq matcher t))
13199 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13201 (save-excursion
13202 (save-restriction
13203 (when (eq scope 'tree)
13204 (org-back-to-heading t)
13205 (org-narrow-to-subtree)
13206 (setq scope nil))
13208 (if (not scope)
13209 (progn
13210 (org-prepare-agenda-buffers
13211 (list (buffer-file-name (current-buffer))))
13212 (setq res (org-scan-tags func matcher)))
13213 ;; Get the right scope
13214 (cond
13215 ((and scope (listp scope) (symbolp (car scope)))
13216 (setq scope (eval scope)))
13217 ((eq scope 'agenda)
13218 (setq scope (org-agenda-files t)))
13219 ((eq scope 'agenda-with-archives)
13220 (setq scope (org-agenda-files t))
13221 (setq scope (org-add-archive-files scope)))
13222 ((eq scope 'file)
13223 (setq scope (list (buffer-file-name))))
13224 ((eq scope 'file-with-archives)
13225 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13226 (org-prepare-agenda-buffers scope)
13227 (while (setq file (pop scope))
13228 (with-current-buffer (org-find-base-buffer-visiting file)
13229 (save-excursion
13230 (save-restriction
13231 (widen)
13232 (goto-char (point-min))
13233 (setq res (append res (org-scan-tags func matcher))))))))))
13234 res))
13236 ;;;; Properties
13238 ;;; Setting and retrieving properties
13240 (defconst org-special-properties
13241 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13242 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13243 "The special properties valid in Org-mode.
13245 These are properties that are not defined in the property drawer,
13246 but in some other way.")
13248 (defconst org-default-properties
13249 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13250 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13251 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13252 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13253 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13254 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13255 "Some properties that are used by Org-mode for various purposes.
13256 Being in this list makes sure that they are offered for completion.")
13259 "Regular expression matching the first line of a property drawer.")
13262 "Regular expression matching the last line of a property drawer.")
13265 "Regular expression matching the first line of a property drawer.")
13268 "Regular expression matching the first line of a property drawer.")
13270 (defconst org-property-drawer-re
13273 "Matches an entire property drawer.")
13275 (defconst org-clock-drawer-re
13278 "Matches an entire clock drawer.")
13280 (defun org-property-action ()
13281 "Do an action on properties."
13282 (interactive)
13283 (let (c)
13284 (org-at-property-p)
13285 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13286 (setq c (read-char-exclusive))
13287 (cond
13288 ((equal c ?s)
13289 (call-interactively 'org-set-property))
13290 ((equal c ?d)
13291 (call-interactively 'org-delete-property))
13292 ((equal c ?D)
13293 (call-interactively 'org-delete-property-globally))
13294 ((equal c ?c)
13295 (call-interactively 'org-compute-property-at-point))
13296 (t (error "No such property action %c" c)))))
13298 (defun org-set-effort (&optional value)
13299 "Set the effort property of the current entry.
13300 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13301 allowed value."
13302 (interactive "P")
13303 (if (equal value 0) (setq value 10))
13304 (let* ((completion-ignore-case t)
13305 (prop org-effort-property)
13306 (cur (org-entry-get nil prop))
13307 (allowed (org-property-get-allowed-values nil prop 'table))
13308 (existing (mapcar 'list (org-property-values prop)))
13309 rpl
13310 (val (cond
13311 ((stringp value) value)
13312 ((and allowed (integerp value))
13313 (or (car (nth (1- value) allowed))
13314 (car (org-last allowed))))
13315 (allowed
13316 (message "Select 1-9,0, [RET%s]: %s"
13317 (if cur (concat "=" cur) "")
13318 (mapconcat 'car allowed " "))
13319 (setq rpl (read-char-exclusive))
13321 cur
13322 (setq rpl (- rpl ?0))
13323 (if (equal rpl 0) (setq rpl 10))
13324 (if (and (> rpl 0) (<= rpl (length allowed)))
13325 (car (nth (1- rpl) allowed))
13326 (org-completing-read "Effort: " allowed nil))))
13327 (t
13328 (let (org-completion-use-ido org-completion-use-iswitchb)
13329 (org-completing-read
13331 (concat "[" cur "]") "")
13332 ": ")
13333 existing nil nil "" nil cur))))))
13334 (unless (equal (org-entry-get nil prop) val)
13335 (org-entry-put nil prop val))
13336 (message "%s is now %s" prop val)))
13338 (defun org-at-property-p ()
13339 "Is cursor inside a property drawer?"
13340 (save-excursion
13341 (beginning-of-line 1)
13343 (save-match-data ;; Used by calling procedures
13344 (let ((p (point))
13345 (range (unless (org-before-first-heading-p)
13346 (org-get-property-block))))
13347 (and range (<= (car range) p) (< p (cdr range))))))))
13349 (defun org-get-property-block (&optional beg end force)
13350 "Return the (beg . end) range of the body of the property drawer.
13351 BEG and END can be beginning and end of subtree, if not given
13352 they will be found.
13353 If the drawer does not exist and FORCE is non-nil, create the drawer."
13354 (catch 'exit
13355 (save-excursion
13356 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13357 (end (or end (progn (outline-next-heading) (point)))))
13358 (goto-char beg)
13359 (if (re-search-forward org-property-start-re end t)
13360 (setq beg (1+ (match-end 0)))
13361 (if force
13362 (save-excursion
13363 (org-insert-property-drawer)
13364 (setq end (progn (outline-next-heading) (point))))
13365 (throw 'exit nil))
13366 (goto-char beg)
13367 (if (re-search-forward org-property-start-re end t)
13368 (setq beg (1+ (match-end 0)))))
13369 (if (re-search-forward org-property-end-re end t)
13370 (setq end (match-beginning 0))
13371 (or force (throw 'exit nil))
13372 (goto-char beg)
13373 (setq end beg)
13374 (org-indent-line-function)
13376 (cons beg end)))))
13378 (defun org-entry-properties (&optional pom which specific)
13379 "Get all properties of the entry at point-or-marker POM.
13380 This includes the TODO keyword, the tags, time strings for deadline,
13381 scheduled, and clocking, and any additional properties defined in the
13382 entry. The return value is an alist, keys may occur multiple times
13383 if the property key was used several times.
13384 POM may also be nil, in which case the current entry is used.
13385 If WHICH is nil or `all', get all properties. If WHICH is
13386 `special' or `standard', only get that subclass. If WHICH
13387 is a string only get exactly this property. Specific can be a string, the
13388 specific property we are interested in. Specifying it can speed
13389 things up because then unnecessary parsing is avoided."
13390 (setq which (or which 'all))
13391 (org-with-point-at pom
13392 (let ((clockstr (substring org-clock-string 0 -1))
13393 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13394 (case-fold-search nil)
13395 beg end range props sum-props key key1 value string clocksum)
13396 (save-excursion
13397 (when (condition-case nil
13398 (and (org-mode-p) (org-back-to-heading t))
13399 (error nil))
13400 (setq beg (point))
13401 (setq sum-props (get-text-property (point) 'org-summaries))
13402 (setq clocksum (get-text-property (point) :org-clock-minutes))
13403 (outline-next-heading)
13404 (setq end (point))
13405 (when (memq which '(all special))
13406 ;; Get the special properties, like TODO and tags
13407 (goto-char beg)
13408 (when (and (or (not specific) (string= specific "TODO"))
13409 (looking-at org-todo-line-regexp) (match-end 2))
13410 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13411 (when (and (or (not specific) (string= specific "PRIORITY"))
13412 (looking-at org-priority-regexp))
13413 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13414 (when (and (or (not specific) (string= specific "TAGS"))
13415 (setq value (org-get-tags-string))
13417 (push (cons "TAGS" value) props))
13418 (when (and (or (not specific) (string= specific "ALLTAGS"))
13419 (setq value (org-get-tags-at)))
13420 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13421 ":"))
13422 props))
13423 (when (or (not specific) (string= specific "BLOCKED"))
13424 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13425 (when (or (not specific)
13426 (member specific
13427 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13428 "TIMESTAMP" "TIMESTAMP_IA")))
13429 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13430 (setq key (if (match-end 1)
13431 (substring (org-match-string-no-properties 1)
13432 0 -1))
13433 string (if (equal key clockstr)
13434 (org-no-properties
13435 (org-trim
13436 (buffer-substring
13437 (match-beginning 3) (goto-char
13438 (point-at-eol)))))
13439 (substring (org-match-string-no-properties 3)
13440 1 -1)))
13441 ;; Get the correct property name from the key. This is
13442 ;; necessary if the user has configured time keywords.
13443 (setq key1 (concat key ":"))
13444 (cond
13445 ((not key)
13446 (setq key
13447 (if (= (char-after (match-beginning 3)) ?\[)
13448 "TIMESTAMP_IA" "TIMESTAMP")))
13449 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13450 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13451 ((equal key1 org-closed-string) (setq key "CLOSED"))
13452 ((equal key1 org-clock-string) (setq key "CLOCK")))
13453 (when (or (equal key "CLOCK") (not (assoc key props)))
13454 (push (cons key string) props))))
13455 )
13457 (when (memq which '(all standard))
13458 ;; Get the standard properties, like :PROP: ...
13459 (setq range (org-get-property-block beg end))
13460 (when range
13461 (goto-char (car range))
13462 (while (re-search-forward
13464 (cdr range) t)
13465 (setq key (org-match-string-no-properties 1)
13466 value (org-trim (or (org-match-string-no-properties 2) "")))
13467 (unless (member key excluded)
13468 (push (cons key (or value "")) props)))))
13469 (if clocksum
13470 (push (cons "CLOCKSUM"
13471 (org-columns-number-to-string (/ (float clocksum) 60.)
13472 'add_times))
13473 props))
13474 (unless (assoc "CATEGORY" props)
13475 (setq value (or (org-get-category)
13476 (progn (org-refresh-category-properties)
13477 (org-get-category))))
13478 (push (cons "CATEGORY" value) props))
13479 (append sum-props (nreverse props)))))))
13481 (defun org-entry-get (pom property &optional inherit literal-nil)
13482 "Get value of PROPERTY for entry at point-or-marker POM.
13483 If INHERIT is non-nil and the entry does not have the property,
13484 then also check higher levels of the hierarchy.
13485 If INHERIT is the symbol `selective', use inheritance only if the setting
13486 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13487 If the property is present but empty, the return value is the empty string.
13488 If the property is not present at all, nil is returned.
13491 do not interpret it as the list atom nil. This is used for inheritance
13493 (org-with-point-at pom
13494 (if (and inherit (if (eq inherit 'selective)
13495 (org-property-inherit-p property)
13496 t))
13497 (org-entry-get-with-inheritance property literal-nil)
13498 (if (member property org-special-properties)
13499 ;; We need a special property. Use `org-entry-properties' to
13500 ;; retrieve it, but specify the wanted property
13501 (cdr (assoc property (org-entry-properties nil 'special property)))
13502 (let ((range (org-get-property-block)))
13503 (if (and range
13504 (goto-char (car range))
13505 (re-search-forward
13507 (cdr range) t))
13508 ;; Found the property, return it.
13509 (if (match-end 1)
13510 (if literal-nil
13511 (org-match-string-no-properties 1)
13512 (org-not-nil (org-match-string-no-properties 1)))
13513 "")))))))
13515 (defun org-property-or-variable-value (var &optional inherit)
13516 "Check if there is a property fixing the value of VAR.
13517 If yes, return this value. If not, return the current value of the variable."
13518 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13520 (read prop)
13521 (symbol-value var))))
13523 (defun org-entry-delete (pom property)
13524 "Delete the property PROPERTY from entry at point-or-marker POM."
13525 (org-with-point-at pom
13526 (if (member property org-special-properties)
13527 nil ; cannot delete these properties.
13528 (let ((range (org-get-property-block)))
13529 (if (and range
13530 (goto-char (car range))
13531 (re-search-forward
13533 (cdr range) t))
13534 (progn
13535 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13536 t)
13537 nil)))))
13539 ;; Multi-values properties are properties that contain multiple values
13540 ;; These values are assumed to be single words, separated by whitespace.
13541 (defun org-entry-add-to-multivalued-property (pom property value)
13542 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13543 (let* ((old (org-entry-get pom property))
13545 (setq value (org-entry-protect-space value))
13546 (unless (member value values)
13547 (setq values (cons value values))
13548 (org-entry-put pom property
13549 (mapconcat 'identity values " ")))))
13551 (defun org-entry-remove-from-multivalued-property (pom property value)
13552 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13553 (let* ((old (org-entry-get pom property))
13555 (setq value (org-entry-protect-space value))
13556 (when (member value values)
13557 (setq values (delete value values))
13558 (org-entry-put pom property
13559 (mapconcat 'identity values " ")))))
13561 (defun org-entry-member-in-multivalued-property (pom property value)
13562 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13563 (let* ((old (org-entry-get pom property))
13565 (setq value (org-entry-protect-space value))
13566 (member value values)))
13568 (defun org-entry-get-multivalued-property (pom property)
13569 "Return a list of values in a multivalued property."
13570 (let* ((value (org-entry-get pom property))
13572 (mapcar 'org-entry-restore-space values)))
13574 (defun org-entry-put-multivalued-property (pom property &rest values)
13575 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13576 VALUES should be a list of strings. Spaces will be protected."
13577 (org-entry-put pom property
13578 (mapconcat 'org-entry-protect-space values " "))
13579 (let* ((value (org-entry-get pom property))
13581 (mapcar 'org-entry-restore-space values)))
13583 (defun org-entry-protect-space (s)
13584 "Protect spaces and newline in string S."
13585 (while (string-match " " s)
13586 (setq s (replace-match "%20" t t s)))
13588 (setq s (replace-match "%0A" t t s)))
13589 s)
13591 (defun org-entry-restore-space (s)
13592 "Restore spaces and newline in string S."
13593 (while (string-match "%20" s)
13594 (setq s (replace-match " " t t s)))
13595 (while (string-match "%0A" s)
13597 s)
13599 (defvar org-entry-property-inherited-from (make-marker)
13600 "Marker pointing to the entry from where a property was inherited.
13601 Each call to `org-entry-get-with-inheritance' will set this marker to the
13602 location of the entry where the inheritance search matched. If there was
13603 no match, the marker will point nowhere.
13604 Note that also `org-entry-get' calls this function, if the INHERIT flag
13605 is set.")
13607 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13608 "Get entry property, and search higher levels if not present.
13609 The search will stop at the first ancestor which has the property defined.
13611 should be considered as undefined (this is the meaning of nil here).
13613 (move-marker org-entry-property-inherited-from nil)
13614 (let (tmp)
13615 (save-excursion
13616 (save-restriction
13617 (widen)
13618 (catch 'ex
13619 (while t
13620 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13621 (org-back-to-heading t)
13622 (move-marker org-entry-property-inherited-from (point))
13623 (throw 'ex tmp))
13624 (or (org-up-heading-safe) (throw 'ex nil)))))
13625 (setq tmp (or tmp
13626 (cdr (assoc property org-file-properties))
13627 (cdr (assoc property org-global-properties))
13628 (cdr (assoc property org-global-properties-fixed))))
13629 (if literal-nil tmp (org-not-nil tmp)))))
13631 (defvar org-property-changed-functions nil
13632 "Hook called when the value of a property has changed.
13633 Each hook function should accept two arguments, the name of the property
13634 and the new value.")
13636 (defun org-entry-put (pom property value)
13637 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13638 (org-with-point-at pom
13639 (org-back-to-heading t)
13640 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13641 range)
13642 (cond
13643 ((equal property "TODO")
13645 (not (member value org-todo-keywords-1)))
13647 (if (or (not value)
13649 (setq value 'none))
13650 (org-todo value)
13651 (org-set-tags nil 'align))
13652 ((equal property "PRIORITY")
13654 (string-to-char value) ?\ ))
13655 (org-set-tags nil 'align))
13656 ((equal property "SCHEDULED")
13657 (if (re-search-forward org-scheduled-time-regexp end t)
13658 (cond
13659 ((eq value 'earlier) (org-timestamp-change -1 'day))
13660 ((eq value 'later) (org-timestamp-change 1 'day))
13661 (t (call-interactively 'org-schedule)))
13662 (call-interactively 'org-schedule)))
13663 ((equal property "DEADLINE")
13664 (if (re-search-forward org-deadline-time-regexp end t)
13665 (cond
13666 ((eq value 'earlier) (org-timestamp-change -1 'day))
13667 ((eq value 'later) (org-timestamp-change 1 'day))
13668 (t (call-interactively 'org-deadline)))
13669 (call-interactively 'org-deadline)))
13670 ((member property org-special-properties)
13671 (error "The %s property can not yet be set with `org-entry-put'"
13672 property))
13673 (t ; a non-special property
13674 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13675 (setq range (org-get-property-block beg end 'force))
13676 (goto-char (car range))
13677 (if (re-search-forward
13679 (progn
13680 (delete-region (match-beginning 1) (match-end 1))
13681 (goto-char (match-beginning 1)))
13682 (goto-char (cdr range))
13684 (backward-char 1)
13685 (org-indent-line-function)
13686 (insert ":" property ":"))
13687 (and value (insert " " value))
13688 (org-indent-line-function)))))
13689 (run-hook-with-args 'org-property-changed-functions property value)))
13691 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13692 "Get all property keys in the current buffer.
13693 With INCLUDE-SPECIALS, also list the special properties that reflect things
13694 like tags and TODO state.
13695 With INCLUDE-DEFAULTS, also include properties that has special meaning
13696 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13697 With INCLUDE-COLUMNS, also include property names given in COLUMN
13698 formats in the current buffer."
13699 (let (rtn range cfmt s p)
13700 (save-excursion
13701 (save-restriction
13702 (widen)
13703 (goto-char (point-min))
13704 (while (re-search-forward org-property-start-re nil t)
13705 (setq range (org-get-property-block))
13706 (goto-char (car range))
13707 (while (re-search-forward
13709 (cdr range) t)
13710 (add-to-list 'rtn (org-match-string-no-properties 1)))
13711 (outline-next-heading))))
13713 (when include-specials
13714 (setq rtn (append org-special-properties rtn)))
13716 (when include-defaults
13717 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13718 (add-to-list 'rtn org-effort-property))
13720 (when include-columns
13721 (save-excursion
13722 (save-restriction
13723 (widen)
13724 (goto-char (point-min))
13725 (while (re-search-forward
13727 nil t)
13728 (setq cfmt (match-string 2) s 0)
13730 cfmt s)
13731 (setq s (match-end 0)
13732 p (match-string 1 cfmt))
13733 (unless (or (equal p "ITEM")
13734 (member p org-special-properties))
13735 (add-to-list 'rtn (match-string 1 cfmt))))))))
13737 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13739 (defun org-property-values (key)
13740 "Return a list of all values of property KEY."
13741 (save-excursion
13742 (save-restriction
13743 (widen)
13744 (goto-char (point-min))
13746 values)
13747 (while (re-search-forward re nil t)
13748 (add-to-list 'values (org-trim (match-string 1))))
13749 (delete "" values)))))
13751 (defun org-insert-property-drawer ()
13752 "Insert a property drawer into the current entry."
13753 (interactive)
13754 (org-back-to-heading t)
13755 (looking-at outline-regexp)
13756 (let ((indent (if org-adapt-indentation
13757 (- (match-end 0)(match-beginning 0))
13758 0))
13759 (beg (point))
13761 end hiddenp)
13762 (outline-next-heading)
13763 (setq end (point))
13764 (goto-char beg)
13765 (while (re-search-forward re end t))
13766 (setq hiddenp (org-invisible-p))
13767 (end-of-line 1)
13770 (if (member (match-string 1) '("CLOCK:" ":END:"))
13771 ;; just skip this line
13772 (beginning-of-line 2)
13773 ;; Drawer start, find the end
13775 (beginning-of-line 1)))
13776 (org-skip-over-state-notes)
13778 (if (eq (char-before) ?*) (forward-char 1))
13780 (beginning-of-line 0)
13781 (org-indent-to-column indent)
13782 (beginning-of-line 2)
13783 (org-indent-to-column indent)
13784 (beginning-of-line 0)
13785 (if hiddenp
13786 (save-excursion
13787 (org-back-to-heading t)
13788 (hide-entry))
13789 (org-flag-drawer t))))
13791 (defun org-set-property (property value)
13792 "In the current entry, set PROPERTY to VALUE.
13793 When called interactively, this will prompt for a property name, offering
13794 completion on existing and default properties. And then it will prompt
13795 for a value, offering completion either on allowed values (via an inherited
13796 xxx_ALL property) or on existing values in other instances of this property
13797 in the current file."
13798 (interactive
13799 (let* ((completion-ignore-case t)
13800 (keys (org-buffer-property-keys nil t t))
13801 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13802 (prop (if (member prop0 keys)
13803 prop0
13804 (or (cdr (assoc (downcase prop0)
13805 (mapcar (lambda (x) (cons (downcase x) x))
13806 keys)))
13807 prop0)))
13808 (cur (org-entry-get nil prop))
13809 (prompt (concat prop " value"
13811 (concat " [" cur "]") "") ": "))
13812 (allowed (org-property-get-allowed-values nil prop 'table))
13813 (existing (mapcar 'list (org-property-values prop)))
13814 (val (if allowed
13815 (org-completing-read prompt allowed nil
13816 (not (get-text-property 0 'org-unrestricted
13817 (caar allowed))))
13818 (let (org-completion-use-ido org-completion-use-iswitchb)
13819 (org-completing-read prompt existing nil nil "" nil cur)))))
13820 (list prop (if (equal val "") cur val))))
13821 (unless (equal (org-entry-get nil property) value)
13822 (org-entry-put nil property value)))
13824 (defun org-delete-property (property)
13825 "In the current entry, delete PROPERTY."
13826 (interactive
13827 (let* ((completion-ignore-case t)
13828 (prop (org-icompleting-read "Property: "
13829 (org-entry-properties nil 'standard))))
13830 (list prop)))
13831 (message "Property %s %s" property
13832 (if (org-entry-delete nil property)
13833 "deleted"
13834 "was not present in the entry")))
13836 (defun org-delete-property-globally (property)
13837 "Remove PROPERTY globally, from all entries."
13838 (interactive
13839 (let* ((completion-ignore-case t)
13840 (prop (org-icompleting-read
13841 "Globally remove property: "
13842 (mapcar 'list (org-buffer-property-keys)))))
13843 (list prop)))
13844 (save-excursion
13845 (save-restriction
13846 (widen)
13847 (goto-char (point-min))
13848 (let ((cnt 0))
13849 (while (re-search-forward
13851 nil t)
13852 (setq cnt (1+ cnt))
13853 (replace-match ""))
13856 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13858 (defun org-compute-property-at-point ()
13859 "Compute the property at point.
13860 This looks for an enclosing column format, extracts the operator and
13861 then applies it to the property in the column format's scope."
13862 (interactive)
13863 (unless (org-at-property-p)
13864 (error "Not at a property"))
13865 (let ((prop (org-match-string-no-properties 2)))
13866 (org-columns-get-format-and-top-level)
13867 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13868 (error "No operator defined for property %s" prop))
13869 (org-columns-compute prop)))
13871 (defvar org-property-allowed-value-functions nil
13872 "Hook for functions supplying allowed values for a specific property.
13873 The functions must take a single argument, the name of the property, and
13875 the values, this means that these values are intended as defaults for
13876 completion, but that other values should be allowed too.
13877 The functions must return nil if they are not responsible for this
13878 property.")
13880 (defun org-property-get-allowed-values (pom property &optional table)
13881 "Get allowed values for the property PROPERTY.
13882 When TABLE is non-nil, return an alist that can directly be used for
13883 completion."
13884 (let (vals)
13885 (cond
13886 ((equal property "TODO")
13887 (setq vals (org-with-point-at pom
13888 (append org-todo-keywords-1 '("")))))
13889 ((equal property "PRIORITY")
13890 (let ((n org-lowest-priority))
13891 (while (>= n org-highest-priority)
13892 (push (char-to-string n) vals)
13893 (setq n (1- n)))))
13894 ((member property org-special-properties))
13895 ((setq vals (run-hook-with-args-until-success
13896 'org-property-allowed-value-functions property)))
13897 (t
13898 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13900 (setq vals (car (read-from-string (concat "(" vals ")"))))
13901 (setq vals (mapcar (lambda (x)
13902 (cond ((stringp x) x)
13903 ((numberp x) (number-to-string x))
13904 ((symbolp x) (symbol-name x))
13905 (t "???")))
13906 vals)))))
13907 (when (member ":ETC" vals)
13908 (setq vals (remove ":ETC" vals))
13909 (org-add-props (car vals) '(org-unrestricted t)))
13910 (if table (mapcar 'list vals) vals)))
13912 (defun org-property-previous-allowed-value (&optional previous)
13913 "Switch to the next allowed value for this property."
13914 (interactive)
13915 (org-property-next-allowed-value t))
13917 (defun org-property-next-allowed-value (&optional previous)
13918 "Switch to the next allowed value for this property."
13919 (interactive)
13920 (unless (org-at-property-p)
13921 (error "Not at a property"))
13922 (let* ((key (match-string 2))
13923 (value (match-string 3))
13924 (allowed (or (org-property-get-allowed-values (point) key)
13925 (and (member value '("[ ]" "[-]" "[X]"))
13926 '("[ ]" "[X]"))))
13927 nval)
13928 (unless allowed
13929 (error "Allowed values for this property have not been defined"))
13930 (if previous (setq allowed (reverse allowed)))
13931 (if (member value allowed)
13932 (setq nval (car (cdr (member value allowed)))))
13933 (setq nval (or nval (car allowed)))
13934 (if (equal nval value)
13935 (error "Only one allowed value for this property"))
13936 (org-at-property-p)
13937 (replace-match (concat " :" key ": " nval) t t)
13938 (org-indent-line-function)
13939 (beginning-of-line 1)
13941 (run-hook-with-args 'org-property-changed-functions key nval)))
13943 (defun org-find-olp (path &optional this-buffer)
13944 "Return a marker pointing to the entry at outline path OLP.
13945 If anything goes wrong, throw an error.
13946 You can wrap this call to catch the error like this:
13948 (condition-case msg
13949 (org-mobile-locate-entry (match-string 4))
13950 (error (nth 1 msg)))
13952 The return value will then be either a string with the error message,
13953 or a marker if everything is OK.
13955 If THIS-BUFFER is set, the outline path does not contain a file,
13956 only headings."
13957 (let* ((file (if this-buffer buffer-file-name (pop path)))
13958 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13959 (level 1)
13960 (lmin 1)
13961 (lmax 1)
13962 limit re end found pos heading cnt)
13963 (unless buffer (error "File not found :%s" file))
13964 (with-current-buffer buffer
13965 (save-excursion
13966 (save-restriction
13967 (widen)
13968 (setq limit (point-max))
13969 (goto-char (point-min))
13970 (while (setq heading (pop path))
13971 (setq re (format org-complex-heading-regexp-format
13972 (regexp-quote heading)))
13973 (setq cnt 0 pos (point))
13974 (while (re-search-forward re end t)
13975 (setq level (- (match-end 1) (match-beginning 1)))
13976 (if (and (>= level lmin) (<= level lmax))
13977 (setq found (match-beginning 0) cnt (1+ cnt))))
13978 (when (= cnt 0) (error "Heading not found on level %d: %s"
13979 lmax heading))
13980 (when (> cnt 1) (error "Heading not unique on level %d: %s"
13981 lmax heading))
13982 (goto-char found)
13983 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
13984 (setq end (save-excursion (org-end-of-subtree t t))))
13985 (when (org-on-heading-p)
13986 (move-marker (make-marker) (point))))))))
13988 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
13989 "Find node HEADING in BUFFER.
13990 Return a marker to the heading if it was found, or nil if not.
13991 If POS-ONLY is set, return just the position instead of a marker.
13993 The heading text must match exact, but it may have a TODO keyword,
13994 a priority cookie and tags in the standard locations."
13995 (with-current-buffer (or buffer (current-buffer))
13996 (save-excursion
13997 (save-restriction
13998 (widen)
13999 (goto-char (point-min))
14000 (let (case-fold-search)
14001 (if (re-search-forward
14002 (format org-complex-heading-regexp-format
14003 (regexp-quote heading)) nil t)
14004 (if pos-only
14005 (match-beginning 0)
14006 (move-marker (make-marker) (match-beginning 0)))))))))
14008 (defun org-find-exact-heading-in-directory (heading &optional dir)
14009 "Find Org node headline HEADING in all .org files in directory DIR.
14010 When the target headline is found, return a marker to this location."
14011 (let ((files (directory-files (or dir default-directory)
14013 file visiting m buffer)
14014 (catch 'found
14015 (while (setq file (pop files))
14016 (message "trying %s" file)
14017 (setq visiting (org-find-base-buffer-visiting file))
14018 (setq buffer (or visiting (find-file-noselect file)))
14019 (setq m (org-find-exact-headline-in-buffer
14020 heading buffer))
14021 (when (and (not m) (not visiting)) (kill-buffer buffer))
14022 (and m (throw 'found m))))))
14024 (defun org-find-entry-with-id (ident)
14025 "Locate the entry that contains the ID property with exact value IDENT.
14026 IDENT can be a string, a symbol or a number, this function will search for
14027 the string representation of it.
14028 Return the position where this entry starts, or nil if there is no such entry."
14029 (interactive "sID: ")
14030 (let ((id (cond
14031 ((stringp ident) ident)
14032 ((symbol-name ident) (symbol-name ident))
14033 ((numberp ident) (number-to-string ident))
14034 (t (error "IDENT %s must be a string, symbol or number" ident))))
14035 (case-fold-search nil))
14036 (save-excursion
14037 (save-restriction
14038 (widen)
14039 (goto-char (point-min))
14040 (when (re-search-forward
14042 nil t)
14043 (org-back-to-heading t)
14044 (point))))))
14046 ;;;; Timestamps
14048 (defvar org-last-changed-timestamp nil)
14049 (defvar org-last-inserted-timestamp nil
14050 "The last time stamp inserted with `org-insert-time-stamp'.")
14051 (defvar org-time-was-given) ; dynamically scoped parameter
14052 (defvar org-end-time-was-given) ; dynamically scoped parameter
14053 (defvar org-ts-what) ; dynamically scoped parameter
14055 (defun org-time-stamp (arg &optional inactive)
14056 "Prompt for a date/time and insert a time stamp.
14057 If the user specifies a time like HH:MM, or if this command is called
14058 with a prefix argument, the time stamp will contain date and time.
14059 Otherwise, only the date will be included. All parts of a date not
14060 specified by the user will be filled in from the current date/time.
14061 So if you press just return without typing anything, the time stamp
14062 will represent the current date/time. If there is already a timestamp
14063 at the cursor, it will be modified."
14064 (interactive "P")
14065 (let* ((ts nil)
14066 (default-time
14067 ;; Default time is either today, or, when entering a range,
14068 ;; the range start.
14069 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14070 (save-excursion
14071 (re-search-backward
14073 (- (point) 20) t)))
14074 (apply 'encode-time (org-parse-time-string (match-string 1)))
14075 (current-time)))
14076 (default-input (and ts (org-get-compact-tod ts)))
14077 org-time-was-given org-end-time-was-given time)
14078 (cond
14079 ((and (org-at-timestamp-p t)
14080 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14081 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14082 (insert "--")
14083 (setq time (let ((this-command this-command))
14084 (org-read-date arg 'totime nil nil
14085 default-time default-input)))
14086 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14087 ((org-at-timestamp-p t)
14088 (setq time (let ((this-command this-command))
14089 (org-read-date arg 'totime nil nil default-time default-input)))
14090 (when (org-at-timestamp-p t) ; just to get the match data
14091 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14092 (replace-match "")
14093 (setq org-last-changed-timestamp
14094 (org-insert-time-stamp
14095 time (or org-time-was-given arg)
14096 inactive nil nil (list org-end-time-was-given))))
14097 (message "Timestamp updated"))
14098 (t
14099 (setq time (let ((this-command this-command))
14100 (org-read-date arg 'totime nil nil default-time default-input)))
14101 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14102 nil nil (list org-end-time-was-given))))))
14104 ;; FIXME: can we use this for something else, like computing time differences?
14105 (defun org-get-compact-tod (s)
14106 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14107 (let* ((t1 (match-string 1 s))
14108 (h1 (string-to-number (match-string 2 s)))
14109 (m1 (string-to-number (match-string 3 s)))
14110 (t2 (and (match-end 4) (match-string 5 s)))
14111 (h2 (and t2 (string-to-number (match-string 6 s))))
14112 (m2 (and t2 (string-to-number (match-string 7 s))))
14113 dh dm)
14114 (if (not t2)
14115 t1
14116 (setq dh (- h2 h1) dm (- m2 m1))
14117 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14118 (concat t1 "+" (number-to-string dh)
14119 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14121 (defun org-time-stamp-inactive (&optional arg)
14122 "Insert an inactive time stamp.
14123 An inactive time stamp is enclosed in square brackets instead of angle
14124 brackets. It is inactive in the sense that it does not trigger agenda entries,
14125 does not link to the calendar and cannot be changed with the S-cursor keys.
14126 So these are more for recording a certain time/date."
14127 (interactive "P")
14128 (org-time-stamp arg 'inactive))
14130 (defvar org-date-ovl (make-overlay 1 1))
14131 (overlay-put org-date-ovl 'face 'org-warning)
14132 (org-detach-overlay org-date-ovl)
14134 (defvar org-ans1) ; dynamically scoped parameter
14135 (defvar org-ans2) ; dynamically scoped parameter
14137 (defvar org-plain-time-of-day-regexp) ; defined below
14139 (defvar org-overriding-default-time nil) ; dynamically scoped
14140 (defvar org-read-date-overlay nil)
14141 (defvar org-dcst nil) ; dynamically scoped
14142 (defvar org-read-date-history nil)
14143 (defvar org-read-date-final-answer nil)
14145 (defun org-read-date (&optional with-time to-time from-string prompt
14146 default-time default-input)
14147 "Read a date, possibly a time, and make things smooth for the user.
14148 The prompt will suggest to enter an ISO date, but you can also enter anything
14149 which will at least partially be understood by `parse-time-string'.
14150 Unrecognized parts of the date will default to the current day, month, year,
14151 hour and minute. If this command is called to replace a timestamp at point,
14152 of to enter the second timestamp of a range, the default time is taken
14153 from the existing stamp. Furthermore, the command prefers the future,
14154 so if you are giving a date where the year is not given, and the day-month
14155 combination is already past in the current year, it will assume you
14156 mean next year. For details, see the manual. A few examples:
14158 3-2-5 --> 2003-02-05
14159 feb 15 --> currentyear-02-15
14160 2/15 --> currentyear-02-15
14161 sep 12 9 --> 2009-09-12
14162 12:45 --> today 12:45
14163 22 sept 0:34 --> currentyear-09-22 0:34
14164 12 --> currentyear-currentmonth-12
14165 Fri --> nearest Friday (today or later)
14166 etc.
14168 Furthermore you can specify a relative date by giving, as the *first* thing
14169 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14170 change in days weeks, months, years.
14171 With a single plus or minus, the date is relative to today. With a double
14172 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14173 +4d --> four days from today
14174 +4 --> same as above
14175 +2w --> two weeks from today
14176 ++5 --> five days from default date
14178 The function understands only English month and weekday abbreviations,
14179 but this can be configured with the variables `parse-time-months' and
14180 `parse-time-weekdays'.
14182 While prompting, a calendar is popped up - you can also select the
14183 date with the mouse (button 1). The calendar shows a period of three
14184 months. To scroll it to other months, use the keys `>' and `<'.
14185 If you don't like the calendar, turn it off with
14186 \(setq org-read-date-popup-calendar nil)
14188 With optional argument TO-TIME, the date will immediately be converted
14189 to an internal time.
14190 With an optional argument WITH-TIME, the prompt will suggest to also
14191 insert a time. Note that when WITH-TIME is not set, you can still
14192 enter a time, and this function will inform the calling routine about
14193 this change. The calling routine may then choose to change the format
14194 used to insert the time stamp into the buffer to include the time.
14195 With optional argument FROM-STRING, read from this string instead from
14196 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14197 the time/date that is used for everything that is not specified by the
14198 user."
14199 (require 'parse-time)
14200 (let* ((org-time-stamp-rounding-minutes
14201 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14202 (org-dcst org-display-custom-times)
14203 (ct (org-current-time))
14204 (def (or org-overriding-default-time default-time ct))
14205 (defdecode (decode-time def))
14206 (dummy (progn
14207 (when (< (nth 2 defdecode) org-extend-today-until)
14208 (setcar (nthcdr 2 defdecode) -1)
14209 (setcar (nthcdr 1 defdecode) 59)
14210 (setq def (apply 'encode-time defdecode)
14211 defdecode (decode-time def)))))
14212 (calendar-frame-setup nil)
14213 (calendar-setup nil)
14214 (calendar-move-hook nil)
14215 (calendar-view-diary-initially-flag nil)
14216 (calendar-view-holidays-initially-flag nil)
14217 (timestr (format-time-string
14218 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14219 (prompt (concat (if prompt (concat prompt " ") "")
14220 (format "Date+time [%s]: " timestr)))
14221 ans (org-ans0 "") org-ans1 org-ans2 final)
14223 (cond
14224 (from-string (setq ans from-string))
14225 (org-read-date-popup-calendar
14226 (save-excursion
14227 (save-window-excursion
14228 (calendar)
14229 (calendar-forward-day (- (time-to-days def)
14230 (calendar-absolute-from-gregorian
14231 (calendar-current-date))))
14232 (org-eval-in-calendar nil t)
14233 (let* ((old-map (current-local-map))
14234 (map (copy-keymap calendar-mode-map))
14235 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14236 (org-defkey map (kbd "RET") 'org-calendar-select)
14237 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14238 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14239 (org-defkey minibuffer-local-map [(meta shift left)]
14240 (lambda () (interactive)
14241 (org-eval-in-calendar '(calendar-backward-month 1))))
14242 (org-defkey minibuffer-local-map [(meta shift right)]
14243 (lambda () (interactive)
14244 (org-eval-in-calendar '(calendar-forward-month 1))))
14245 (org-defkey minibuffer-local-map [(meta shift up)]
14246 (lambda () (interactive)
14247 (org-eval-in-calendar '(calendar-backward-year 1))))
14248 (org-defkey minibuffer-local-map [(meta shift down)]
14249 (lambda () (interactive)
14250 (org-eval-in-calendar '(calendar-forward-year 1))))
14251 (org-defkey minibuffer-local-map [?\e (shift left)]
14252 (lambda () (interactive)
14253 (org-eval-in-calendar '(calendar-backward-month 1))))
14254 (org-defkey minibuffer-local-map [?\e (shift right)]
14255 (lambda () (interactive)
14256 (org-eval-in-calendar '(calendar-forward-month 1))))
14257 (org-defkey minibuffer-local-map [?\e (shift up)]
14258 (lambda () (interactive)
14259 (org-eval-in-calendar '(calendar-backward-year 1))))
14260 (org-defkey minibuffer-local-map [?\e (shift down)]
14261 (lambda () (interactive)
14262 (org-eval-in-calendar '(calendar-forward-year 1))))
14263 (org-defkey minibuffer-local-map [(shift up)]
14264 (lambda () (interactive)
14265 (org-eval-in-calendar '(calendar-backward-week 1))))
14266 (org-defkey minibuffer-local-map [(shift down)]
14267 (lambda () (interactive)
14268 (org-eval-in-calendar '(calendar-forward-week 1))))
14269 (org-defkey minibuffer-local-map [(shift left)]
14270 (lambda () (interactive)
14271 (org-eval-in-calendar '(calendar-backward-day 1))))
14272 (org-defkey minibuffer-local-map [(shift right)]
14273 (lambda () (interactive)
14274 (org-eval-in-calendar '(calendar-forward-day 1))))
14275 (org-defkey minibuffer-local-map ">"
14276 (lambda () (interactive)
14277 (org-eval-in-calendar '(scroll-calendar-left 1))))
14278 (org-defkey minibuffer-local-map "<"
14279 (lambda () (interactive)
14280 (org-eval-in-calendar '(scroll-calendar-right 1))))
14281 (org-defkey minibuffer-local-map "\C-v"
14282 (lambda () (interactive)
14283 (org-eval-in-calendar
14284 '(calendar-scroll-left-three-months 1))))
14285 (org-defkey minibuffer-local-map "\M-v"
14286 (lambda () (interactive)
14287 (org-eval-in-calendar
14288 '(calendar-scroll-right-three-months 1))))
14289 (run-hooks 'org-read-date-minibuffer-setup-hook)
14290 (unwind-protect
14291 (progn
14292 (use-local-map map)
14293 (add-hook 'post-command-hook 'org-read-date-display)
14294 (setq org-ans0 (read-string prompt default-input
14295 'org-read-date-history nil))
14296 ;; org-ans0: from prompt
14297 ;; org-ans1: from mouse click
14298 ;; org-ans2: from calendar motion
14299 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14300 (remove-hook 'post-command-hook 'org-read-date-display)
14301 (use-local-map old-map)
14302 (when org-read-date-overlay
14303 (delete-overlay org-read-date-overlay)
14304 (setq org-read-date-overlay nil)))))))
14306 (t ; Naked prompt only
14307 (unwind-protect
14308 (setq ans (read-string prompt default-input
14309 'org-read-date-history timestr))
14310 (when org-read-date-overlay
14311 (delete-overlay org-read-date-overlay)
14312 (setq org-read-date-overlay nil)))))
14314 (setq final (org-read-date-analyze ans def defdecode))
14316 ;; One round trip to get rid of 34th of August and stuff like that....
14317 (setq final (decode-time (apply 'encode-time final)))
14319 (setq org-read-date-final-answer ans)
14321 (if to-time
14322 (apply 'encode-time final)
14323 (if (and (boundp 'org-time-was-given) org-time-was-given)
14324 (format "%04d-%02d-%02d %02d:%02d"
14325 (nth 5 final) (nth 4 final) (nth 3 final)
14326 (nth 2 final) (nth 1 final))
14327 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14329 (defvar def)
14330 (defvar defdecode)
14331 (defvar with-time)
14332 (defvar org-read-date-analyze-futurep nil)
14333 (defun org-read-date-display ()
14334 "Display the current date prompt interpretation in the minibuffer."
14335 (when org-read-date-display-live
14336 (when org-read-date-overlay
14337 (delete-overlay org-read-date-overlay))
14338 (let ((p (point)))
14339 (end-of-line 1)
14340 (while (not (equal (buffer-substring
14341 (max (point-min) (- (point) 4)) (point))
14342 " "))
14343 (insert " "))
14344 (goto-char p))
14345 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14346 " " (or org-ans1 org-ans2)))
14347 (org-end-time-was-given nil)
14348 (f (org-read-date-analyze ans def defdecode))
14349 (fmts (if org-dcst
14350 org-time-stamp-custom-formats
14351 org-time-stamp-formats))
14352 (fmt (if (or with-time
14353 (and (boundp 'org-time-was-given) org-time-was-given))
14354 (cdr fmts)
14355 (car fmts)))
14356 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14357 (when (and org-end-time-was-given
14358 (string-match org-plain-time-of-day-regexp txt))
14359 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14360 org-end-time-was-given
14361 (substring txt (match-end 0)))))
14362 (when org-read-date-analyze-futurep
14363 (setq txt (concat txt " (=>F)")))
14364 (setq org-read-date-overlay
14365 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14366 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14368 (defun org-read-date-analyze (ans def defdecode)
14369 "Analyze the combined answer of the date prompt."
14370 ;; FIXME: cleanup and comment
14371 (let ((nowdecode (decode-time (current-time)))
14372 delta deltan deltaw deltadef year month day
14373 hour minute second wday pm h2 m2 tl wday1
14374 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14375 (setq org-read-date-analyze-futurep nil)
14377 (setq ans "+0"))
14379 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14380 (setq ans (replace-match "" t t ans)
14381 deltan (car delta)
14382 deltaw (nth 1 delta)
14383 deltadef (nth 2 delta)))
14385 ;; Check if there is an iso week date in there
14386 ;; If yes, store the info and postpone interpreting it until the rest
14387 ;; of the parsing is done
14388 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14389 (setq iso-year (if (match-end 1)
14390 (org-small-year-to-year
14391 (string-to-number (match-string 1 ans))))
14392 iso-weekday (if (match-end 3)
14393 (string-to-number (match-string 3 ans)))
14394 iso-week (string-to-number (match-string 2 ans)))
14395 (setq ans (replace-match "" t t ans)))
14397 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14398 (when (string-match
14400 (setq year (if (match-end 2)
14401 (string-to-number (match-string 2 ans))
14402 (progn (setq kill-year t)
14403 (string-to-number (format-time-string "%Y"))))
14404 month (string-to-number (match-string 3 ans))
14405 day (string-to-number (match-string 4 ans)))
14406 (if (< year 100) (setq year (+ 2000 year)))
14408 t nil ans)))
14409 ;; Help matching american dates, like 5/30 or 5/30/7
14410 (when (string-match
14411 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14412 (setq year (if (match-end 4)
14413 (string-to-number (match-string 4 ans))
14414 (progn (setq kill-year t)
14415 (string-to-number (format-time-string "%Y"))))
14416 month (string-to-number (match-string 1 ans))
14417 day (string-to-number (match-string 2 ans)))
14418 (if (< year 100) (setq year (+ 2000 year)))
14420 t nil ans)))
14421 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14422 ;; If there is a time with am/pm, and *no* time without it, we convert
14423 ;; so that matching will be successful.
14424 (loop for i from 1 to 2 do ; twice, for end time as well
14427 (setq hour (string-to-number (match-string 1 ans))
14428 minute (if (match-end 3)
14429 (string-to-number (match-string 3 ans))
14430 0)
14431 pm (equal ?p
14432 (string-to-char (downcase (match-string 4 ans)))))
14433 (if (and (= hour 12) (not pm))
14434 (setq hour 0)
14435 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14436 (setq ans (replace-match (format "%02d:%02d" hour minute)
14437 t t ans))))
14439 ;; Check if a time range is given as a duration
14440 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14441 (setq hour (string-to-number (match-string 1 ans))
14442 h2 (+ hour (string-to-number (match-string 3 ans)))
14443 minute (string-to-number (match-string 2 ans))
14444 m2 (+ minute (if (match-end 5) (string-to-number
14445 (match-string 5 ans))0)))
14446 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14447 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14448 t t ans)))
14450 ;; Check if there is a time range
14451 (when (boundp 'org-end-time-was-given)
14452 (setq org-time-was-given nil)
14453 (when (and (string-match org-plain-time-of-day-regexp ans)
14454 (match-end 8))
14455 (setq org-end-time-was-given (match-string 8 ans))
14456 (setq ans (concat (substring ans 0 (match-beginning 7))
14457 (substring ans (match-end 7))))))
14459 (setq tl (parse-time-string ans)
14460 day (or (nth 3 tl) (nth 3 defdecode))
14461 month (or (nth 4 tl)
14462 (if (and org-read-date-prefer-future
14463 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14464 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14465 (nth 4 defdecode)))
14466 year (or (and (not kill-year) (nth 5 tl))
14467 (if (and org-read-date-prefer-future
14468 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14469 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14470 (nth 5 defdecode)))
14471 hour (or (nth 2 tl) (nth 2 defdecode))
14472 minute (or (nth 1 tl) (nth 1 defdecode))
14473 second (or (nth 0 tl) 0)
14474 wday (nth 6 tl))
14476 (when (and (eq org-read-date-prefer-future 'time)
14477 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14478 (equal day (nth 3 nowdecode))
14479 (equal month (nth 4 nowdecode))
14480 (equal year (nth 5 nowdecode))
14481 (nth 2 tl)
14482 (or (< (nth 2 tl) (nth 2 nowdecode))
14483 (and (= (nth 2 tl) (nth 2 nowdecode))
14484 (nth 1 tl)
14485 (< (nth 1 tl) (nth 1 nowdecode)))))
14486 (setq day (1+ day)
14487 futurep t))
14489 ;; Special date definitions below
14490 (cond
14491 (iso-week
14492 ;; There was an iso week
14493 (require 'cal-iso)
14494 (setq futurep nil)
14495 (setq year (or iso-year year)
14496 day (or iso-weekday wday 1)
14497 wday nil ; to make sure that the trigger below does not match
14498 iso-date (calendar-gregorian-from-absolute
14499 (calendar-absolute-from-iso
14500 (list iso-week day year))))
14501 ; FIXME: Should we also push ISO weeks into the future?
14502 ; (when (and org-read-date-prefer-future
14503 ; (not iso-year)
14504 ; (< (calendar-absolute-from-gregorian iso-date)
14505 ; (time-to-days (current-time))))
14506 ; (setq year (1+ year)
14507 ; iso-date (calendar-gregorian-from-absolute
14508 ; (calendar-absolute-from-iso
14509 ; (list iso-week day year)))))
14510 (setq month (car iso-date)
14511 year (nth 2 iso-date)
14512 day (nth 1 iso-date)))
14513 (deltan
14514 (setq futurep nil)
14515 (unless deltadef
14516 (let ((now (decode-time (current-time))))
14517 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14518 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14519 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14520 ((equal deltaw "m") (setq month (+ month deltan)))
14521 ((equal deltaw "y") (setq year (+ year deltan)))))
14522 ((and wday (not (nth 3 tl)))
14523 (setq futurep nil)
14524 ;; Weekday was given, but no day, so pick that day in the week
14525 ;; on or after the derived date.
14526 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14527 (unless (equal wday wday1)
14528 (setq day (+ day (% (- wday wday1 -7) 7))))))
14529 (if (and (boundp 'org-time-was-given)
14530 (nth 2 tl))
14531 (setq org-time-was-given t))
14532 (if (< year 100) (setq year (+ 2000 year)))
14533 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14534 (setq org-read-date-analyze-futurep futurep)
14535 (list second minute hour day month year)))
14537 (defvar parse-time-weekdays)
14539 (defun org-read-date-get-relative (s today default)
14540 "Check string S for special relative date string.
14541 TODAY and DEFAULT are internal times, for today and for a default.
14542 Return shift list (N what def-flag)
14544 N is the number of WHATs to shift.
14545 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14546 the DEFAULT date rather than TODAY."
14547 (when (and
14548 (string-match
14549 (concat
14554 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14555 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14556 (string-to-char (substring (match-string 1 s) -1))
14557 ?+))
14558 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14559 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14560 (what (if (match-end 3) (match-string 3 s) "d"))
14561 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14562 (date (if rel default today))
14563 (wday (nth 6 (decode-time date)))
14564 delta)
14565 (if wday1
14566 (progn
14567 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14568 (if (= dir ?-) (setq delta (- delta 7)))
14569 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14570 (list delta "d" rel))
14571 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14573 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14574 "Turn a user-specified date into the internal representation.
14575 The internal representation needed by the calendar is (month day year).
14576 This is a wrapper to handle the brain-dead convention in calendar that
14577 user function argument order change dependent on argument order."
14578 (if (boundp 'calendar-date-style)
14579 (cond
14580 ((eq calendar-date-style 'american)
14581 (list arg1 arg2 arg3))
14582 ((eq calendar-date-style 'european)
14583 (list arg2 arg1 arg3))
14584 ((eq calendar-date-style 'iso)
14585 (list arg2 arg3 arg1)))
14586 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14587 (if (org-bound-and-true-p european-calendar-style)
14588 (list arg2 arg1 arg3)
14589 (list arg1 arg2 arg3)))))
14591 (defun org-eval-in-calendar (form &optional keepdate)
14592 "Eval FORM in the calendar window and return to current window.
14593 Also, store the cursor date in variable org-ans2."
14594 (let ((sf (selected-frame))
14595 (sw (selected-window)))
14596 (select-window (get-buffer-window "*Calendar*" t))
14597 (eval form)
14598 (when (and (not keepdate) (calendar-cursor-to-date))
14599 (let* ((date (calendar-cursor-to-date))
14600 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14601 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14602 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14603 (select-window sw)
14604 (org-select-frame-set-input-focus sf)))
14606 (defun org-calendar-select ()
14607 "Return to `org-read-date' with the date currently selected.
14608 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14609 (interactive)
14610 (when (calendar-cursor-to-date)
14611 (let* ((date (calendar-cursor-to-date))
14612 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14613 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14614 (if (active-minibuffer-window) (exit-minibuffer))))
14616 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14617 "Insert a date stamp for the date given by the internal TIME.
14618 WITH-HM means use the stamp format that includes the time of the day.
14619 INACTIVE means use square brackets instead of angular ones, so that the
14620 stamp will not contribute to the agenda.
14621 PRE and POST are optional strings to be inserted before and after the
14622 stamp.
14623 The command returns the inserted time stamp."
14624 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14625 stamp)
14626 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14627 (insert-before-markers (or pre ""))
14628 (when (listp extra)
14629 (setq extra (car extra))
14630 (if (and (stringp extra)
14632 (setq extra (format "-%02d:%02d"
14633 (string-to-number (match-string 1 extra))
14634 (string-to-number (match-string 2 extra))))
14635 (setq extra nil)))
14636 (when extra
14637 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14638 (insert-before-markers (setq stamp (format-time-string fmt time)))
14639 (insert-before-markers (or post ""))
14640 (setq org-last-inserted-timestamp stamp)))
14642 (defun org-toggle-time-stamp-overlays ()
14643 "Toggle the use of custom time stamp formats."
14644 (interactive)
14645 (setq org-display-custom-times (not org-display-custom-times))
14646 (unless org-display-custom-times
14647 (let ((p (point-min)) (bmp (buffer-modified-p)))
14648 (while (setq p (next-single-property-change p 'display))
14649 (if (and (get-text-property p 'display)
14650 (eq (get-text-property p 'face) 'org-date))
14651 (remove-text-properties
14652 p (setq p (next-single-property-change p 'display))
14653 '(display t))))
14654 (set-buffer-modified-p bmp)))
14655 (if (featurep 'xemacs)
14656 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14657 (org-restart-font-lock)
14658 (setq org-table-may-need-update t)
14659 (if org-display-custom-times
14660 (message "Time stamps are overlayed with custom format")
14661 (message "Time stamp overlays removed")))
14663 (defun org-display-custom-time (beg end)
14664 "Overlay modified time stamp format over timestamp between BEG and END."
14665 (let* ((ts (buffer-substring beg end))
14666 t1 w1 with-hm tf time str w2 (off 0))
14667 (save-match-data
14668 (setq t1 (org-parse-time-string ts t))
14669 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14670 (setq off (- (match-end 0) (match-beginning 0)))))
14671 (setq end (- end off))
14672 (setq w1 (- end beg)
14673 with-hm (and (nth 1 t1) (nth 2 t1))
14674 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14675 time (org-fix-decoded-time t1)
14676 str (org-add-props
14677 (format-time-string
14678 (substring tf 1 -1) (apply 'encode-time time))
14679 nil 'mouse-face 'highlight)
14680 w2 (length str))
14681 (if (not (= w2 w1))
14682 (add-text-properties (1+ beg) (+ 2 beg)
14683 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14684 (if (featurep 'xemacs)
14685 (progn
14686 (put-text-property beg end 'invisible t)
14687 (put-text-property beg end 'end-glyph (make-glyph str)))
14688 (put-text-property beg end 'display str))))
14690 (defun org-translate-time (string)
14691 "Translate all timestamps in STRING to custom format.
14692 But do this only if the variable `org-display-custom-times' is set."
14693 (when org-display-custom-times
14694 (save-match-data
14695 (let* ((start 0)
14696 (re org-ts-regexp-both)
14697 t1 with-hm inactive tf time str beg end)
14698 (while (setq start (string-match re string start))
14699 (setq beg (match-beginning 0)
14700 end (match-end 0)
14701 t1 (save-match-data
14702 (org-parse-time-string (substring string beg end) t))
14703 with-hm (and (nth 1 t1) (nth 2 t1))
14704 inactive (equal (substring string beg (1+ beg)) "[")
14705 tf (funcall (if with-hm 'cdr 'car)
14706 org-time-stamp-custom-formats)
14707 time (org-fix-decoded-time t1)
14708 str (format-time-string
14709 (concat
14710 (if inactive "[" "<") (substring tf 1 -1)
14711 (if inactive "]" ">"))
14712 (apply 'encode-time time))
14713 string (replace-match str t t string)
14714 start (+ start (length str)))))))
14715 string)
14717 (defun org-fix-decoded-time (time)
14718 "Set 0 instead of nil for the first 6 elements of time.
14719 Don't touch the rest."
14720 (let ((n 0))
14721 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14723 (defun org-days-to-time (timestamp-string)
14724 "Difference between TIMESTAMP-STRING and now in days."
14725 (- (time-to-days (org-time-string-to-time timestamp-string))
14726 (time-to-days (current-time))))
14728 (defun org-deadline-close (timestamp-string &optional ndays)
14729 "Is the time in TIMESTAMP-STRING close to the current date?"
14730 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14731 (and (< (org-days-to-time timestamp-string) ndays)
14732 (not (org-entry-is-done-p))))
14734 (defun org-get-wdays (ts)
14735 "Get the deadline lead time appropriate for timestring TS."
14736 (cond
14737 ((<= org-deadline-warning-days 0)
14738 ;; 0 or negative, enforce this value no matter what
14739 (- org-deadline-warning-days))
14741 ;; lead time is specified.
14742 (floor (* (string-to-number (match-string 1 ts))
14743 (cdr (assoc (match-string 2 ts)
14744 '(("d" . 1) ("w" . 7)
14745 ("m" . 30.4) ("y" . 365.25)))))))
14746 ;; go for the default.
14747 (t org-deadline-warning-days)))
14749 (defun org-calendar-select-mouse (ev)
14750 "Return to `org-read-date' with the date currently selected.
14751 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14752 (interactive "e")
14753 (mouse-set-point ev)
14754 (when (calendar-cursor-to-date)
14755 (let* ((date (calendar-cursor-to-date))
14756 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14757 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14758 (if (active-minibuffer-window) (exit-minibuffer))))
14760 (defun org-check-deadlines (ndays)
14761 "Check if there are any deadlines due or past due.
14762 A deadline is considered due if it happens within `org-deadline-warning-days'
14763 days from today's date. If the deadline appears in an entry marked DONE,
14764 it is not shown. The prefix arg NDAYS can be used to test that many
14766 (interactive "P")
14767 (let* ((org-warn-days
14768 (cond
14769 ((equal ndays '(4)) 100000)
14770 (ndays (prefix-numeric-value ndays))
14771 (t (abs org-deadline-warning-days))))
14772 (case-fold-search nil)
14774 (callback
14775 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14777 (message "%d deadlines past-due or due within %d days"
14778 (org-occur regexp nil callback)
14779 org-warn-days)))
14781 (defun org-check-before-date (date)
14782 "Check if there are deadlines or scheduled entries before DATE."
14783 (interactive (list (org-read-date)))
14784 (let ((case-fold-search nil)
14788 (callback
14789 (lambda () (time-less-p
14790 (org-time-string-to-time (match-string 2))
14791 (org-time-string-to-time date)))))
14792 (message "%d entries before %s"
14793 (org-occur regexp nil callback) date)))
14795 (defun org-check-after-date (date)
14796 "Check if there are deadlines or scheduled entries after DATE."
14797 (interactive (list (org-read-date)))
14798 (let ((case-fold-search nil)
14802 (callback
14803 (lambda () (not
14804 (time-less-p
14805 (org-time-string-to-time (match-string 2))
14806 (org-time-string-to-time date))))))
14807 (message "%d entries after %s"
14808 (org-occur regexp nil callback) date)))
14810 (defun org-evaluate-time-range (&optional to-buffer)
14811 "Evaluate a time range by computing the difference between start and end.
14812 Normally the result is just printed in the echo area, but with prefix arg
14813 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14814 If the time range is actually in a table, the result is inserted into the
14815 next column.
14816 For time difference computation, a year is assumed to be exactly 365
14817 days in order to avoid rounding problems."
14818 (interactive "P")
14819 (or
14820 (org-clock-update-time-maybe)
14821 (save-excursion
14822 (unless (org-at-date-range-p t)
14823 (goto-char (point-at-bol))
14824 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14825 (if (not (org-at-date-range-p t))
14826 (error "Not at a time-stamp range, and none found in current line")))
14827 (let* ((ts1 (match-string 1))
14828 (ts2 (match-string 2))
14829 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14830 (match-end (match-end 0))
14831 (time1 (org-time-string-to-time ts1))
14832 (time2 (org-time-string-to-time ts2))
14833 (t1 (org-float-time time1))
14834 (t2 (org-float-time time2))
14835 (diff (abs (- t2 t1)))
14836 (negative (< (- t2 t1) 0))
14837 ;; (ys (floor (* 365 24 60 60)))
14838 (ds (* 24 60 60))
14839 (hs (* 60 60))
14840 (fy "%dy %dd %02d:%02d")
14841 (fy1 "%dy %dd")
14842 (fd "%dd %02d:%02d")
14843 (fd1 "%dd")
14844 (fh "%02d:%02d")
14845 y d h m align)
14846 (if havetime
14847 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14848 y 0
14849 d (floor (/ diff ds)) diff (mod diff ds)
14850 h (floor (/ diff hs)) diff (mod diff hs)
14851 m (floor (/ diff 60)))
14852 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14853 y 0
14854 d (floor (+ (/ diff ds) 0.5))
14855 h 0 m 0))
14856 (if (not to-buffer)
14857 (message "%s" (org-make-tdiff-string y d h m))
14858 (if (org-at-table-p)
14859 (progn
14860 (goto-char match-end)
14861 (setq align t)
14862 (and (looking-at " *|") (goto-char (match-end 0))))
14863 (goto-char match-end))
14864 (if (looking-at
14866 (replace-match ""))
14867 (if negative (insert " -"))
14868 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14869 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14870 (insert " " (format fh h m))))
14871 (if align (org-table-align))
14872 (message "Time difference inserted")))))
14874 (defun org-make-tdiff-string (y d h m)
14875 (let ((fmt "")
14876 (l nil))
14877 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14878 l (push y l)))
14879 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14880 l (push d l)))
14881 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14882 l (push h l)))
14883 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14884 l (push m l)))
14885 (apply 'format fmt (nreverse l))))
14887 (defun org-time-string-to-time (s)
14888 (apply 'encode-time (org-parse-time-string s)))
14889 (defun org-time-string-to-seconds (s)
14890 (org-float-time (org-time-string-to-time s)))
14892 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14893 "Convert a time stamp to an absolute day number.
14894 If there is a specifier for a cyclic time stamp, get the closest date to
14895 DAYNR.
14896 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14897 the variable date is bound by the calendar when this is called."
14898 (cond
14900 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14901 daynr
14902 (+ daynr 1000)))
14904 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14905 (time-to-days (current-time))) (match-string 0 s)
14906 prefer show-all))
14907 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14909 (defun org-days-to-iso-week (days)
14910 "Return the iso week number."
14911 (require 'cal-iso)
14912 (car (calendar-iso-from-absolute days)))
14914 (defun org-small-year-to-year (year)
14915 "Convert 2-digit years into 4-digit years.
14916 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14917 The year 2000 cannot be abbreviated. Any year larger than 99
14918 is returned unchanged."
14919 (if (< year 38)
14920 (setq year (+ 2000 year))
14921 (if (< year 100)
14922 (setq year (+ 1900 year))))
14923 year)
14925 (defun org-time-from-absolute (d)
14926 "Return the time corresponding to date D.
14927 D may be an absolute day number, or a calendar-type list (month day year)."
14928 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14929 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14931 (defun org-calendar-holiday ()
14932 "List of holidays, for Diary display in Org-mode."
14933 (require 'holidays)
14934 (let ((hl (funcall
14935 (if (fboundp 'calendar-check-holidays)
14936 'calendar-check-holidays 'check-calendar-holidays) date)))
14937 (if hl (mapconcat 'identity hl "; "))))
14939 (defun org-diary-sexp-entry (sexp entry date)
14940 "Process a SEXP diary ENTRY for DATE."
14941 (require 'diary-lib)
14942 (let ((result (if calendar-debug-sexp
14943 (let ((stack-trace-on-error t))
14944 (eval (car (read-from-string sexp))))
14945 (condition-case nil
14946 (eval (car (read-from-string sexp)))
14947 (error
14948 (beep)
14949 (message "Bad sexp at line %d in %s: %s"
14950 (org-current-line)
14951 (buffer-file-name) sexp)
14952 (sleep-for 2))))))
14953 (cond ((stringp result) result)
14954 ((and (consp result)
14955 (stringp (cdr result))) (cdr result))
14956 (result entry)
14957 (t nil))))
14959 (defun org-diary-to-ical-string (frombuf)
14960 "Get iCalendar entries from diary entries in buffer FROMBUF.
14961 This uses the icalendar.el library."
14962 (let* ((tmpdir (if (featurep 'xemacs)
14963 (temp-directory)
14964 temporary-file-directory))
14965 (tmpfile (make-temp-name
14966 (expand-file-name "orgics" tmpdir)))
14967 buf rtn b e)
14968 (with-current-buffer frombuf
14969 (icalendar-export-region (point-min) (point-max) tmpfile)
14970 (setq buf (find-buffer-visiting tmpfile))
14971 (set-buffer buf)
14972 (goto-char (point-min))
14973 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14974 (setq b (match-beginning 0)))
14975 (goto-char (point-max))
14976 (if (re-search-backward "^END:VEVENT" nil t)
14977 (setq e (match-end 0)))
14979 (kill-buffer buf)
14980 (delete-file tmpfile)
14981 rtn))
14983 (defun org-closest-date (start current change prefer show-all)
14984 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14985 When PREFER is `past' return a date that is either CURRENT or past.
14986 When PREFER is `future', return a date that is either CURRENT or future.
14987 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14988 ;; Make the proper lists from the dates
14989 (catch 'exit
14990 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
14991 dn dw sday cday n1 n2 n0
14992 d m y y1 y2 date1 date2 nmonths nm ny m2)
14994 (setq start (org-date-to-gregorian start)
14995 current (org-date-to-gregorian
14996 (if show-all
14997 current
14998 (time-to-days (current-time))))
14999 sday (calendar-absolute-from-gregorian start)
15000 cday (calendar-absolute-from-gregorian current))
15002 (if (<= cday sday) (throw 'exit sday))
15005 (setq dn (string-to-number (match-string 1 change))
15006 dw (cdr (assoc (match-string 2 change) a1)))
15007 (error "Invalid change specifier: %s" change))
15008 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15009 (cond
15010 ((eq dw 'day)
15011 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15012 n2 (+ n1 dn)))
15013 ((eq dw 'year)
15014 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15015 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15016 (setq date1 (list m d y1)
15017 n1 (calendar-absolute-from-gregorian date1)
15018 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15019 n2 (calendar-absolute-from-gregorian date2)))
15020 ((eq dw 'month)
15021 ;; approx number of month between the two dates
15022 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15023 ;; How often does dn fit in there?
15024 (setq d (nth 1 start) m (car start) y (nth 2 start)
15025 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15026 m (+ m nm)
15027 ny (floor (/ m 12))
15028 y (+ y ny)
15029 m (- m (* ny 12)))
15030 (while (> m 12) (setq m (- m 12) y (1+ y)))
15031 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15032 (setq m2 (+ m dn) y2 y)
15033 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15034 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15035 (while (<= n2 cday)
15036 (setq n1 n2 m m2 y y2)
15037 (setq m2 (+ m dn) y2 y)
15038 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15039 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15040 ;; Make sure n1 is the earlier date
15041 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15042 (if show-all
15043 (cond
15044 ((eq prefer 'past) (if (= cday n2) n2 n1))
15045 ((eq prefer 'future) (if (= cday n1) n1 n2))
15046 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15047 (cond
15048 ((eq prefer 'past) (if (= cday n2) n2 n1))
15049 ((eq prefer 'future) (if (= cday n1) n1 n2))
15050 (t (if (= cday n1) n1 n2)))))))
15052 (defun org-date-to-gregorian (date)
15053 "Turn any specification of DATE into a Gregorian date for the calendar."
15054 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15055 ((and (listp date) (= (length date) 3)) date)
15056 ((stringp date)
15057 (setq date (org-parse-time-string date))
15058 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15059 ((listp date)
15060 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15062 (defun org-parse-time-string (s &optional nodefault)
15063 "Parse the standard Org-mode time string.
15064 This should be a lot faster than the normal `parse-time-string'.
15065 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15066 hour and minute fields will be nil if not given."
15067 (if (string-match org-ts-regexp0 s)
15068 (list 0
15069 (if (or (match-beginning 8) (not nodefault))
15070 (string-to-number (or (match-string 8 s) "0")))
15071 (if (or (match-beginning 7) (not nodefault))
15072 (string-to-number (or (match-string 7 s) "0")))
15073 (string-to-number (match-string 4 s))
15074 (string-to-number (match-string 3 s))
15075 (string-to-number (match-string 2 s))
15076 nil nil nil)
15077 (error "Not a standard Org-mode time string: %s" s)))
15079 (defun org-timestamp-up (&optional arg)
15080 "Increase the date item at the cursor by one.
15081 If the cursor is on the year, change the year. If it is on the month or
15082 the day, change that.
15083 With prefix ARG, change by that many units."
15084 (interactive "p")
15085 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15087 (defun org-timestamp-down (&optional arg)
15088 "Decrease 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-up-day (&optional arg)
15096 "Increase the date in the time stamp by one day.
15097 With prefix ARG, change that many days."
15098 (interactive "p")
15099 (if (and (not (org-at-timestamp-p t))
15100 (org-on-heading-p))
15101 (org-todo 'up)
15102 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15104 (defun org-timestamp-down-day (&optional arg)
15105 "Decrease the date in the time stamp by one day.
15106 With prefix ARG, change that many days."
15107 (interactive "p")
15108 (if (and (not (org-at-timestamp-p t))
15109 (org-on-heading-p))
15110 (org-todo 'down)
15111 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15113 (defun org-at-timestamp-p (&optional inactive-ok)
15114 "Determine if the cursor is in or at a timestamp."
15115 (interactive)
15116 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15117 (pos (point))
15118 (ans (or (looking-at tsr)
15119 (save-excursion
15121 (if (> (point) (point-min)) (backward-char 1))
15122 (and (looking-at tsr)
15123 (> (- (match-end 0) pos) -1))))))
15124 (and ans
15125 (boundp 'org-ts-what)
15126 (setq org-ts-what
15127 (cond
15128 ((= pos (match-beginning 0)) 'bracket)
15129 ((= pos (1- (match-end 0))) 'bracket)
15130 ((org-pos-in-match-range pos 2) 'year)
15131 ((org-pos-in-match-range pos 3) 'month)
15132 ((org-pos-in-match-range pos 7) 'hour)
15133 ((org-pos-in-match-range pos 8) 'minute)
15134 ((or (org-pos-in-match-range pos 4)
15135 (org-pos-in-match-range pos 5)) 'day)
15136 ((and (> pos (or (match-end 8) (match-end 5)))
15137 (< pos (match-end 0)))
15138 (- pos (or (match-end 8) (match-end 5))))
15139 (t 'day))))
15140 ans))
15142 (defun org-toggle-timestamp-type ()
15143 "Toggle the type (<active> or [inactive]) of a time stamp."
15144 (interactive)
15145 (when (org-at-timestamp-p t)
15146 (let ((beg (match-beginning 0)) (end (match-end 0))
15147 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15148 (save-excursion
15149 (goto-char beg)
15150 (while (re-search-forward "[][<>]" end t)
15151 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15152 t t)))
15153 (message "Timestamp is now %sactive"
15154 (if (equal (char-after beg) ?<) "" "in")))))
15156 (defun org-timestamp-change (n &optional what updown)
15157 "Change the date in the time stamp at point.
15158 The date will be changed by N times WHAT. WHAT can be `day', `month',
15159 `year', `minute', `second'. If WHAT is not given, the cursor position
15160 in the timestamp determines what will be changed."
15161 (let ((pos (point))
15162 with-hm inactive
15163 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15164 org-ts-what
15165 extra rem
15166 ts time time0)
15167 (if (not (org-at-timestamp-p t))
15168 (error "Not at a timestamp"))
15169 (if (and (not what) (eq org-ts-what 'bracket))
15170 (org-toggle-timestamp-type)
15171 (if (and (not what) (not (eq org-ts-what 'day))
15172 org-display-custom-times
15173 (get-text-property (point) 'display)
15174 (not (get-text-property (1- (point)) 'display)))
15175 (setq org-ts-what 'day))
15176 (setq org-ts-what (or what org-ts-what)
15177 inactive (= (char-after (match-beginning 0)) ?\[)
15178 ts (match-string 0))
15179 (replace-match "")
15180 (if (string-match
15182 ts)
15183 (setq extra (match-string 1 ts)))
15185 (setq with-hm t))
15186 (setq time0 (org-parse-time-string ts))
15187 (when (and updown
15188 (eq org-ts-what 'minute)
15189 (not current-prefix-arg))
15190 ;; This looks like s-up and s-down. Change by one rounding step.
15191 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15192 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15193 (setcar (cdr time0) (+ (nth 1 time0)
15194 (if (> n 0) (- rem) (- dm rem))))))
15195 (setq time
15196 (encode-time (or (car time0) 0)
15197 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15198 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15199 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15200 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15201 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15202 (nthcdr 6 time0)))
15203 (when (and (member org-ts-what '(hour minute))
15204 extra
15206 (setq extra (org-modify-ts-extra
15207 extra
15208 (if (eq org-ts-what 'hour) 2 5)
15209 n dm)))
15210 (when (integerp org-ts-what)
15211 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15212 (if (eq what 'calendar)
15213 (let ((cal-date (org-get-date-from-calendar)))
15214 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15215 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15216 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15217 (setcar time0 (or (car time0) 0))
15218 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15219 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15220 (setq time (apply 'encode-time time0))))
15221 (setq org-last-changed-timestamp
15222 (org-insert-time-stamp time with-hm inactive nil nil extra))
15223 (org-clock-update-time-maybe)
15224 (goto-char pos)
15225 ;; Try to recenter the calendar window, if any
15226 (if (and org-calendar-follow-timestamp-change
15227 (get-buffer-window "*Calendar*" t)
15228 (memq org-ts-what '(day month year)))
15229 (org-recenter-calendar (time-to-days time))))))
15231 (defun org-modify-ts-extra (s pos n dm)
15232 "Change the different parts of the lead-time and repeat fields in timestamp."
15233 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15234 ng h m new rem)
15235 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15236 (cond
15237 ((or (org-pos-in-match-range pos 2)
15238 (org-pos-in-match-range pos 3))
15239 (setq m (string-to-number (match-string 3 s))
15240 h (string-to-number (match-string 2 s)))
15241 (if (org-pos-in-match-range pos 2)
15242 (setq h (+ h n))
15243 (setq n (* dm (org-no-warnings (signum n))))
15244 (when (not (= 0 (setq rem (% m dm))))
15245 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15246 (setq m (+ m n)))
15247 (if (< m 0) (setq m (+ m 60) h (1- h)))
15248 (if (> m 59) (setq m (- m 60) h (1+ h)))
15249 (setq h (min 24 (max 0 h)))
15250 (setq ng 1 new (format "-%02d:%02d" h m)))
15251 ((org-pos-in-match-range pos 6)
15252 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15253 ((org-pos-in-match-range pos 5)
15254 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15256 ((org-pos-in-match-range pos 9)
15257 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15258 ((org-pos-in-match-range pos 8)
15259 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15261 (when ng
15262 (setq s (concat
15263 (substring s 0 (match-beginning ng))
15264 new
15265 (substring s (match-end ng))))))
15266 s))
15268 (defun org-recenter-calendar (date)
15269 "If the calendar is visible, recenter it to DATE."
15270 (let* ((win (selected-window))
15271 (cwin (get-buffer-window "*Calendar*" t))
15272 (calendar-move-hook nil))
15273 (when cwin
15274 (select-window cwin)
15275 (calendar-goto-date (if (listp date) date
15276 (calendar-gregorian-from-absolute date)))
15277 (select-window win))))
15279 (defun org-goto-calendar (&optional arg)
15280 "Go to the Emacs calendar at the current date.
15281 If there is a time stamp in the current line, go to that date.
15282 A prefix ARG can be used to force the current date."
15283 (interactive "P")
15284 (let ((tsr org-ts-regexp) diff
15285 (calendar-move-hook nil)
15286 (calendar-view-holidays-initially-flag nil)
15287 (calendar-view-diary-initially-flag nil))
15288 (if (or (org-at-timestamp-p)
15289 (save-excursion
15290 (beginning-of-line 1)
15291 (looking-at (concat ".*" tsr))))
15292 (let ((d1 (time-to-days (current-time)))
15293 (d2 (time-to-days
15294 (org-time-string-to-time (match-string 1)))))
15295 (setq diff (- d2 d1))))
15296 (calendar)
15297 (calendar-goto-today)
15298 (if (and diff (not arg)) (calendar-forward-day diff))))
15300 (defun org-get-date-from-calendar ()
15301 "Return a list (month day year) of date at point in calendar."
15302 (with-current-buffer "*Calendar*"
15303 (save-match-data
15304 (calendar-cursor-to-date))))
15306 (defun org-date-from-calendar ()
15307 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15308 If there is already a time stamp at the cursor position, update it."
15309 (interactive)
15310 (if (org-at-timestamp-p t)
15311 (org-timestamp-change 0 'calendar)
15312 (let ((cal-date (org-get-date-from-calendar)))
15313 (org-insert-time-stamp
15314 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15316 (defun org-minutes-to-hh:mm-string (m)
15317 "Compute H:MM from a number of minutes."
15318 (let ((h (/ m 60)))
15319 (setq m (- m (* 60 h)))
15320 (format org-time-clocksum-format h m)))
15322 (defun org-hh:mm-string-to-minutes (s)
15323 "Convert a string H:MM to a number of minutes.
15324 If the string is just a number, interpret it as minutes.
15325 In fact, the first hh:mm or number in the string will be taken,
15326 there can be extra stuff in the string.
15327 If no number is found, the return value is 0."
15328 (cond
15330 (+ (* (string-to-number (match-string 1 s)) 60)
15331 (string-to-number (match-string 2 s))))
15333 (string-to-number (match-string 1 s)))
15334 (t 0)))
15336 ;;;; Files
15338 (defun org-save-all-org-buffers ()
15339 "Save all Org-mode buffers without user confirmation."
15340 (interactive)
15341 (message "Saving all Org-mode buffers...")
15342 (save-some-buffers t 'org-mode-p)
15343 (when (featurep 'org-id) (org-id-locations-save))
15344 (message "Saving all Org-mode buffers... done"))
15346 (defun org-revert-all-org-buffers ()
15347 "Revert all Org-mode buffers.
15348 Prompt for confirmation when there are unsaved changes.
15349 Be sure you know what you are doing before letting this function
15350 overwrite your changes.
15352 This function is useful in a setup where one tracks org files
15353 with a version control system, to revert on one machine after pulling
15354 changes from another. I believe the procedure must be like this:
15356 1. M-x org-save-all-org-buffers
15357 2. Pull changes from the other machine, resolve conflicts
15358 3. M-x org-revert-all-org-buffers"
15359 (interactive)
15360 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15361 (error "Abort"))
15362 (save-excursion
15363 (save-window-excursion
15364 (mapc
15365 (lambda (b)
15366 (when (and (with-current-buffer b (org-mode-p))
15367 (with-current-buffer b buffer-file-name))
15368 (switch-to-buffer b)
15369 (revert-buffer t 'no-confirm)))
15370 (buffer-list))
15371 (when (and (featurep 'org-id) org-id-track-globally)
15372 (org-id-locations-load)))))
15374 ;;;; Agenda files
15376 ;;;###autoload
15377 (defun org-switchb (&optional arg)
15378 "Switch between Org buffers.
15379 With a prefix argument, restrict available to files.
15380 With two prefix arguments, restrict available buffers to agenda files.
15382 Defaults to `iswitchb' for buffer name completion.
15383 Set `org-completion-use-ido' to make it use ido instead."
15384 (interactive "P")
15385 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15386 ((equal arg '(16)) (org-buffer-list 'agenda))
15387 (t (org-buffer-list))))
15388 (org-completion-use-iswitchb org-completion-use-iswitchb)
15389 (org-completion-use-ido org-completion-use-ido))
15390 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15391 (setq org-completion-use-iswitchb t))
15392 (switch-to-buffer
15393 (org-icompleting-read "Org buffer: "
15394 (mapcar 'list (mapcar 'buffer-name blist))
15395 nil t))))
15397 ;;; Define some older names previously used for this functionality
15398 ;;;###autoload
15399 (defalias 'org-ido-switchb 'org-switchb)
15400 ;;;###autoload
15401 (defalias 'org-iswitchb 'org-switchb)
15403 (defun org-buffer-list (&optional predicate exclude-tmp)
15404 "Return a list of Org buffers.
15405 PREDICATE can be `export', `files' or `agenda'.
15407 export restrict the list to Export buffers.
15408 files restrict the list to buffers visiting Org files.
15409 agenda restrict the list to buffers visiting agenda files.
15411 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15412 (let* ((bfn nil)
15413 (agenda-files (and (eq predicate 'agenda)
15414 (mapcar 'file-truename (org-agenda-files t))))
15415 (filter
15416 (cond
15417 ((eq predicate 'files)
15418 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15419 ((eq predicate 'export)
15420 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15421 ((eq predicate 'agenda)
15422 (lambda (b)
15423 (with-current-buffer b
15424 (and (eq major-mode 'org-mode)
15425 (setq bfn (buffer-file-name b))
15426 (member (file-truename bfn) agenda-files)))))
15427 (t (lambda (b) (with-current-buffer b
15428 (or (eq major-mode 'org-mode)
15429 (string-match "\*Org .*Export"
15430 (buffer-name b)))))))))
15431 (delq nil
15432 (mapcar
15433 (lambda(b)
15434 (if (and (funcall filter b)
15435 (or (not exclude-tmp)
15436 (not (string-match "tmp" (buffer-name b)))))
15437 b
15438 nil))
15439 (buffer-list)))))
15441 (defun org-agenda-files (&optional unrestricted archives)
15442 "Get the list of agenda files.
15443 Optional UNRESTRICTED means return the full list even if a restriction
15444 is currently in place.
15445 When ARCHIVES is t, include all archive files that are really being
15446 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15447 `org-agenda-archives-mode' is t."
15448 (let ((files
15449 (cond
15450 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15451 ((stringp org-agenda-files) (org-read-agenda-file-list))
15452 ((listp org-agenda-files) org-agenda-files)
15453 (t (error "Invalid value of `org-agenda-files'")))))
15454 (setq files (apply 'append
15455 (mapcar (lambda (f)
15456 (if (file-directory-p f)
15457 (directory-files
15458 f t org-agenda-file-regexp)
15459 (list f)))
15460 files)))
15461 (when org-agenda-skip-unavailable-files
15462 (setq files (delq nil
15463 (mapcar (function
15464 (lambda (file)
15465 (and (file-readable-p file) file)))
15466 files))))
15467 (when (or (eq archives t)
15468 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15469 (setq files (org-add-archive-files files)))
15470 files))
15472 (defun org-agenda-file-p (&optional file)
15473 "Return non-nil, if FILE is an agenda file.
15474 If FILE is omitted, use the file associated with the current
15475 buffer."
15476 (member (or file (buffer-file-name))
15477 (org-agenda-files t)))
15479 (defun org-edit-agenda-file-list ()
15480 "Edit the list of agenda files.
15481 Depending on setup, this either uses customize to edit the variable
15482 `org-agenda-files', or it visits the file that is holding the list. In the
15483 latter case, the buffer is set up in a way that saving it automatically kills
15484 the buffer and restores the previous window configuration."
15485 (interactive)
15486 (if (stringp org-agenda-files)
15487 (let ((cw (current-window-configuration)))
15488 (find-file org-agenda-files)
15489 (org-set-local 'org-window-configuration cw)
15490 (org-add-hook 'after-save-hook
15491 (lambda ()
15492 (set-window-configuration
15493 (prog1 org-window-configuration
15494 (kill-buffer (current-buffer))))
15495 (org-install-agenda-files-menu)
15496 (message "New agenda file list installed"))
15497 nil 'local)
15498 (message "%s" (substitute-command-keys
15500 (customize-variable 'org-agenda-files)))
15502 (defun org-store-new-agenda-file-list (list)
15503 "Set new value for the agenda file list and save it correctly."
15504 (if (stringp org-agenda-files)
15505 (let ((fe (org-read-agenda-file-list t)) b u)
15506 (while (setq b (find-buffer-visiting org-agenda-files))
15507 (kill-buffer b))
15508 (with-temp-file org-agenda-files
15509 (insert
15510 (mapconcat
15511 (lambda (f) ;; Keep un-expanded entries.
15512 (if (setq u (assoc f fe))
15513 (cdr u)
15514 f))
15517 (let ((org-mode-hook nil) (org-inhibit-startup t)
15518 (org-insert-mode-line-in-empty-file nil))
15519 (setq org-agenda-files list)
15520 (customize-save-variable 'org-agenda-files org-agenda-files))))
15522 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15523 "Read the list of agenda files from a file.
15524 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15525 filenames, used by `org-store-new-agenda-file-list' to write back
15526 un-expanded file names."
15527 (when (file-directory-p org-agenda-files)
15528 (error "`org-agenda-files' cannot be a single directory"))
15529 (when (stringp org-agenda-files)
15530 (with-temp-buffer
15531 (insert-file-contents org-agenda-files)
15532 (mapcar
15533 (lambda (f)
15534 (let ((e (expand-file-name (substitute-in-file-name f)
15535 org-directory)))
15536 (if pair-with-expansion
15537 (cons e f)
15538 e)))
15541 ;;;###autoload
15542 (defun org-cycle-agenda-files ()
15543 "Cycle through the files in `org-agenda-files'.
15544 If the current buffer visits an agenda file, find the next one in the list.
15545 If the current buffer does not, find the first agenda file."
15546 (interactive)
15547 (let* ((fs (org-agenda-files t))
15548 (files (append fs (list (car fs))))
15549 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15550 file)
15551 (unless files (error "No agenda files"))
15552 (catch 'exit
15553 (while (setq file (pop files))
15554 (if (equal (file-truename file) tcf)
15555 (when (car files)
15556 (find-file (car files))
15557 (throw 'exit t))))
15558 (find-file (car fs)))
15559 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15561 (defun org-agenda-file-to-front (&optional to-end)
15562 "Move/add the current file to the top of the agenda file list.
15563 If the file is not present in the list, it is added to the front. If it is
15564 present, it is moved there. With optional argument TO-END, add/move to the
15565 end of the list."
15566 (interactive "P")
15567 (let ((org-agenda-skip-unavailable-files nil)
15568 (file-alist (mapcar (lambda (x)
15569 (cons (file-truename x) x))
15570 (org-agenda-files t)))
15571 (ctf (file-truename buffer-file-name))
15572 x had)
15573 (setq x (assoc ctf file-alist) had x)
15575 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15576 (if to-end
15577 (setq file-alist (append (delq x file-alist) (list x)))
15578 (setq file-alist (cons x (delq x file-alist))))
15579 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15580 (org-install-agenda-files-menu)
15581 (message "File %s to %s of agenda file list"
15582 (if had "moved" "added") (if to-end "end" "front"))))
15584 (defun org-remove-file (&optional file)
15585 "Remove current file from the list of files in variable `org-agenda-files'.
15586 These are the files which are being checked for agenda entries.
15587 Optional argument FILE means use this file instead of the current."
15588 (interactive)
15589 (let* ((org-agenda-skip-unavailable-files nil)
15590 (file (or file buffer-file-name))
15591 (true-file (file-truename file))
15592 (afile (abbreviate-file-name file))
15593 (files (delq nil (mapcar
15594 (lambda (x)
15595 (if (equal true-file
15596 (file-truename x))
15597 nil x))
15598 (org-agenda-files t)))))
15599 (if (not (= (length files) (length (org-agenda-files t))))
15600 (progn
15601 (org-store-new-agenda-file-list files)
15602 (org-install-agenda-files-menu)
15603 (message "Removed file: %s" afile))
15604 (message "File was not in list: %s (not removed)" afile))))
15606 (defun org-file-menu-entry (file)
15607 (vector file (list 'find-file file) t))
15609 (defun org-check-agenda-file (file)
15610 "Make sure FILE exists. If not, ask user what to do."
15611 (when (not (file-exists-p file))
15612 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15613 (abbreviate-file-name file))
15614 (let ((r (downcase (read-char-exclusive))))
15615 (cond
15616 ((equal r ?r)
15617 (org-remove-file file)
15618 (throw 'nextfile t))
15619 (t (error "Abort"))))))
15621 (defun org-get-agenda-file-buffer (file)
15622 "Get a buffer visiting FILE. If the buffer needs to be created, add
15623 it to the list of buffers which might be released later."
15624 (let ((buf (org-find-base-buffer-visiting file)))
15625 (if buf
15626 buf ; just return it
15627 ;; Make a new buffer and remember it
15628 (setq buf (find-file-noselect file))
15629 (if buf (push buf org-agenda-new-buffers))
15630 buf)))
15632 (defun org-release-buffers (blist)
15633 "Release all buffers in list, asking the user for confirmation when needed.
15634 When a buffer is unmodified, it is just killed. When modified, it is saved
15635 \(if the user agrees) and then killed."
15636 (let (buf file)
15637 (while (setq buf (pop blist))
15638 (setq file (buffer-file-name buf))
15639 (when (and (buffer-modified-p buf)
15640 file
15641 (y-or-n-p (format "Save file %s? " file)))
15642 (with-current-buffer buf (save-buffer)))
15643 (kill-buffer buf))))
15645 (defun org-prepare-agenda-buffers (files)
15646 "Create buffers for all agenda files, protect archived trees and comments."
15647 (interactive)
15648 (let ((pa '(:org-archived t))
15649 (pc '(:org-comment t))
15650 (pall '(:org-archived t :org-comment t))
15651 (inhibit-read-only t)
15652 (rea (concat ":" org-archive-tag ":"))
15653 bmp file re)
15654 (save-excursion
15655 (save-restriction
15656 (while (setq file (pop files))
15657 (catch 'nextfile
15658 (if (bufferp file)
15659 (set-buffer file)
15660 (org-check-agenda-file file)
15661 (set-buffer (org-get-agenda-file-buffer file)))
15662 (widen)
15663 (setq bmp (buffer-modified-p))
15664 (org-refresh-category-properties)
15665 (setq org-todo-keywords-for-agenda
15666 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15667 (setq org-done-keywords-for-agenda
15668 (append org-done-keywords-for-agenda org-done-keywords))
15669 (setq org-todo-keyword-alist-for-agenda
15670 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15671 (setq org-drawers-for-agenda
15672 (append org-drawers-for-agenda org-drawers))
15673 (setq org-tag-alist-for-agenda
15674 (append org-tag-alist-for-agenda org-tag-alist))
15676 (save-excursion
15677 (remove-text-properties (point-min) (point-max) pall)
15678 (when org-agenda-skip-archived-trees
15679 (goto-char (point-min))
15680 (while (re-search-forward rea nil t)
15681 (if (org-on-heading-p t)
15682 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15683 (goto-char (point-min))
15685 (while (re-search-forward re nil t)
15686 (add-text-properties
15687 (match-beginning 0) (org-end-of-subtree t) pc)))
15688 (set-buffer-modified-p bmp)))))
15689 (setq org-todo-keywords-for-agenda
15690 (org-uniquify org-todo-keywords-for-agenda))
15691 (setq org-todo-keyword-alist-for-agenda
15692 (org-uniquify org-todo-keyword-alist-for-agenda)
15693 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15695 ;;;; Embedded LaTeX
15697 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15698 "Keymap for the minor `org-cdlatex-mode'.")
15700 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15701 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15702 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15703 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15704 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15706 (defvar org-cdlatex-texmathp-advice-is-done nil
15707 "Flag remembering if we have applied the advice to texmathp already.")
15709 (define-minor-mode org-cdlatex-mode
15710 "Toggle the minor `org-cdlatex-mode'.
15711 This mode supports entering LaTeX environment and math in LaTeX fragments
15712 in Org-mode.
15714 nil " OCDL" nil
15715 (when org-cdlatex-mode (require 'cdlatex))
15716 (unless org-cdlatex-texmathp-advice-is-done
15717 (setq org-cdlatex-texmathp-advice-is-done t)
15718 (defadvice texmathp (around org-math-always-on activate)
15719 "Always return t in org-mode buffers.
15720 This is because we want to insert math symbols without dollars even outside
15721 the LaTeX math segments. If Orgmode thinks that point is actually inside
15722 an embedded LaTeX fragment, let texmathp do its job.
15724 (interactive)
15725 (let (p)
15726 (cond
15727 ((not (org-mode-p)) ad-do-it)
15728 ((eq this-command 'cdlatex-math-symbol)
15729 (setq ad-return-value t
15730 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15731 (t
15732 (let ((p (org-inside-LaTeX-fragment-p)))
15733 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15734 (setq ad-return-value t
15735 texmathp-why '("Org-mode embedded math" . 0))
15736 (if p ad-do-it)))))))))
15738 (defun turn-on-org-cdlatex ()
15739 "Unconditionally turn on `org-cdlatex-mode'."
15740 (org-cdlatex-mode 1))
15742 (defun org-inside-LaTeX-fragment-p ()
15743 "Test if point is inside a LaTeX fragment.
15745 sequence appearing also before point.
15746 Even though the matchers for math are configurable, this function assumes
15748 delimiters are skipped when they have been removed by customization.
15749 The return value is nil, or a cons cell with the delimiter and
15750 and the position of this delimiter.
15752 This function does a reasonably good job, but can locally be fooled by
15753 for example currency specifications. For example it will assume being in
15755 fragments that are properly closed, but during editing, we have to live
15756 with the uncertainty caused by missing closing delimiters. This function
15757 looks only before point, not after."
15758 (catch 'exit
15759 (let ((pos (point))
15760 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15761 (lim (progn
15763 (point)))
15764 dd-on str (start 0) m re)
15765 (goto-char pos)
15766 (when dodollar
15768 re (nth 1 (assoc "$" org-latex-regexps)))
15769 (while (string-match re str start)
15770 (cond
15771 ((= (match-end 0) (length str))
15772 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15773 ((= (match-end 0) (- (length str) 5))
15774 (throw 'exit nil))
15775 (t (setq start (match-end 0))))))
15776 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15777 (goto-char pos)
15778 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15779 (and (match-beginning 2) (throw 'exit nil))
15780 ;; count $$
15782 (setq dd-on (not dd-on)))
15783 (goto-char pos)
15784 (if dd-on (cons "$$" m))))))
15786 (defun org-inside-latex-macro-p ()
15787 "Is point inside a LaTeX macro or its arguments?"
15788 (save-match-data
15789 (org-in-regexp
15792 (defun org-try-cdlatex-tab ()
15793 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15794 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15795 - inside a LaTeX fragment, or
15796 - after the first word in a line, where an abbreviation expansion could
15797 insert a LaTeX environment."
15798 (when org-cdlatex-mode
15799 (cond
15800 ((save-excursion
15801 (skip-chars-backward "a-zA-Z0-9*")
15803 (bolp))
15804 (cdlatex-tab) t)
15805 ((org-inside-LaTeX-fragment-p)
15806 (cdlatex-tab) t)
15807 (t nil))))
15809 (defun org-cdlatex-underscore-caret (&optional arg)
15810 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15811 Revert to the normal definition outside of these fragments."
15812 (interactive "P")
15813 (if (org-inside-LaTeX-fragment-p)
15814 (call-interactively 'cdlatex-sub-superscript)
15815 (let (org-cdlatex-mode)
15816 (call-interactively (key-binding (vector last-input-event))))))
15818 (defun org-cdlatex-math-modify (&optional arg)
15819 "Execute `cdlatex-math-modify' in LaTeX fragments.
15820 Revert to the normal definition outside of these fragments."
15821 (interactive "P")
15822 (if (org-inside-LaTeX-fragment-p)
15823 (call-interactively 'cdlatex-math-modify)
15824 (let (org-cdlatex-mode)
15825 (call-interactively (key-binding (vector last-input-event))))))
15827 (defvar org-latex-fragment-image-overlays nil
15828 "List of overlays carrying the images of latex fragments.")
15829 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15831 (defun org-remove-latex-fragment-image-overlays ()
15832 "Remove all overlays with LaTeX fragment images in current buffer."
15833 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15834 (setq org-latex-fragment-image-overlays nil))
15836 (defun org-preview-latex-fragment (&optional subtree)
15837 "Preview the LaTeX fragment at point, or all locally or globally.
15838 If the cursor is in a LaTeX fragment, create the image and overlay
15839 it over the source code. If there is no fragment at point, display
15840 all fragments in the current text, from one headline to the next. With
15841 prefix SUBTREE, display all fragments in the current subtree. With a
15843 the cursor is before the first headline,
15844 display all fragments in the buffer.
15846 (interactive "P")
15847 (org-remove-latex-fragment-image-overlays)
15848 (save-excursion
15849 (save-restriction
15850 (let (beg end at msg)
15851 (cond
15852 ((or (equal subtree '(16))
15853 (not (save-excursion
15854 (re-search-backward (concat "^" outline-regexp) nil t))))
15855 (setq beg (point-min) end (point-max)
15856 msg "Creating images for buffer...%s"))
15857 ((equal subtree '(4))
15858 (org-back-to-heading)
15859 (setq beg (point) end (org-end-of-subtree t)
15860 msg "Creating images for subtree...%s"))
15861 (t
15862 (if (setq at (org-inside-LaTeX-fragment-p))
15863 (goto-char (max (point-min) (- (cdr at) 2)))
15864 (org-back-to-heading))
15865 (setq beg (point) end (progn (outline-next-heading) (point))
15866 msg (if at "Creating image...%s"
15867 "Creating images for entry...%s"))))
15868 (message msg "")
15869 (narrow-to-region beg end)
15870 (goto-char beg)
15871 (org-format-latex
15872 (concat "ltxpng/" (file-name-sans-extension
15873 (file-name-nondirectory
15874 buffer-file-name)))
15875 default-directory 'overlays msg at 'forbuffer 'dvipng)
15876 (message msg "done. Use `C-c C-c' to remove images.")))))
15878 (defvar org-latex-regexps
15880 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15883 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15887 "Regular expressions for matching embedded LaTeX.")
15889 (defvar org-export-have-math nil) ;; dynamic scoping
15890 (defun org-format-latex (prefix &optional dir overlays msg at
15891 forbuffer processing-type)
15892 "Replace LaTeX fragments with links to an image, and produce images.
15893 Some of the options can be changed using the variable
15894 `org-format-latex-options'."
15895 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15896 (let* ((prefixnodir (file-name-nondirectory prefix))
15897 (absprefix (expand-file-name prefix dir))
15898 (todir (file-name-directory absprefix))
15899 (opt org-format-latex-options)
15900 (matchers (plist-get opt :matchers))
15901 (re-list org-latex-regexps)
15902 (org-format-latex-header-extra
15903 (plist-get (org-infile-export-plist) :latex-header-extra))
15904 (cnt 0) txt hash link beg end re e checkdir
15905 executables-checked string
15906 m n block linkfile movefile ov)
15907 ;; Check the different regular expressions
15908 (while (setq e (pop re-list))
15909 (setq m (car e) re (nth 1 e) n (nth 2 e)
15911 (when (member m matchers)
15912 (goto-char (point-min))
15913 (while (re-search-forward re nil t)
15914 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15915 (not (get-text-property (match-beginning n)
15916 'org-protected))
15917 (or (not overlays)
15918 (not (eq (get-char-property (match-beginning n)
15919 'org-overlay-type)
15920 'org-latex-overlay))))
15921 (setq org-export-have-math t)
15922 (cond
15923 ((eq processing-type 'verbatim)
15924 ;; Leave the text verbatim, just protect it
15925 (add-text-properties (match-beginning n) (match-end n)
15926 '(org-protected t)))
15927 ((eq processing-type 'mathjax)
15928 ;; Prepare for MathJax processing
15929 (setq string (match-string n))
15930 (if (equal m "$")
15931 (save-excursion
15932 (delete-region (match-beginning n) (match-end n))
15933 (goto-char (match-beginning n))
15936 '(org-protected t))))
15937 (add-text-properties (match-beginning n) (match-end n)
15938 '(org-protected t))))
15939 ((or (eq processing-type 'dvipng) t)
15940 ;; Process to an image
15941 (setq txt (match-string n)
15942 beg (match-beginning n) end (match-end n)
15943 cnt (1+ cnt))
15944 (let (print-length print-level) ; make sure full list is printed
15945 (setq hash (sha1 (prin1-to-string
15946 (list org-format-latex-header
15947 org-format-latex-header-extra
15948 org-export-latex-default-packages-alist
15949 org-export-latex-packages-alist
15950 org-format-latex-options
15951 forbuffer txt)))
15952 linkfile (format "%s_%s.png" prefix hash)
15953 movefile (format "%s_%s.png" absprefix hash)))
15954 (setq link (concat block "[[file:" linkfile "]]" block))
15955 (if msg (message msg cnt))
15956 (goto-char beg)
15957 (unless checkdir ; make sure the directory exists
15958 (setq checkdir t)
15959 (or (file-directory-p todir) (make-directory todir t)))
15961 (unless executables-checked
15962 (org-check-external-command
15963 "latex" "needed to convert LaTeX fragments to images")
15964 (org-check-external-command
15965 "dvipng" "needed to convert LaTeX fragments to images")
15966 (setq executables-checked t))
15968 (unless (file-exists-p movefile)
15969 (org-create-formula-image
15970 txt movefile opt forbuffer))
15971 (if overlays
15972 (progn
15973 (mapc (lambda (o)
15974 (if (eq (overlay-get o 'org-overlay-type)
15975 'org-latex-overlay)
15976 (delete-overlay o)))
15977 (overlays-in beg end))
15978 (setq ov (make-overlay beg end))
15979 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15980 (if (featurep 'xemacs)
15981 (progn
15982 (overlay-put ov 'invisible t)
15983 (overlay-put
15984 ov 'end-glyph
15985 (make-glyph (vector 'png :file movefile))))
15986 (overlay-put
15987 ov 'display
15988 (list 'image :type 'png :file movefile :ascent 'center)))
15989 (push ov org-latex-fragment-image-overlays)
15990 (goto-char end))
15991 (delete-region beg end)
15992 (insert (org-add-props link
15993 (list 'org-latex-src
15994 (replace-regexp-in-string
15997 ;; This function borrows from Ganesh Swami's latex2png.el
15998 (defun org-create-formula-image (string tofile options buffer)
15999 "This calls dvipng."
16000 (require 'org-latex)
16001 (let* ((tmpdir (if (featurep 'xemacs)
16002 (temp-directory)
16003 temporary-file-directory))
16004 (texfilebase (make-temp-name
16005 (expand-file-name "orgtex" tmpdir)))
16006 (texfile (concat texfilebase ".tex"))
16007 (dvifile (concat texfilebase ".dvi"))
16008 (pngfile (concat texfilebase ".png"))
16009 (fnh (if (featurep 'xemacs)
16010 (font-height (get-face-font 'default))
16011 (face-attribute 'default :height nil)))
16012 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16013 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16014 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16015 "Black"))
16016 (bg (or (plist-get options (if buffer :background :html-background))
16017 "Transparent")))
16018 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16019 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16020 (with-temp-file texfile
16021 (insert (org-splice-latex-header
16022 org-format-latex-header
16023 org-export-latex-default-packages-alist
16024 org-export-latex-packages-alist t
16025 org-format-latex-header-extra))
16027 (require 'org-latex)
16028 (org-export-latex-fix-inputenc))
16029 (let ((dir default-directory))
16030 (condition-case nil
16031 (progn
16032 (cd tmpdir)
16033 (call-process "latex" nil nil nil texfile))
16034 (error nil))
16035 (cd dir))
16036 (if (not (file-exists-p dvifile))
16037 (progn (message "Failed to create dvi file from %s" texfile) nil)
16038 (condition-case nil
16039 (call-process "dvipng" nil nil nil
16040 "-fg" fg "-bg" bg
16041 "-D" dpi
16042 ;;"-x" scale "-y" scale
16043 "-T" "tight"
16044 "-o" pngfile
16045 dvifile)
16046 (error nil))
16047 (if (not (file-exists-p pngfile))
16048 (if org-format-latex-signal-error
16049 (error "Failed to create png file from %s" texfile)
16050 (message "Failed to create png file from %s" texfile)
16051 nil)
16052 ;; Use the requested file name and clean up
16053 (copy-file pngfile tofile 'replace)
16054 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16055 (delete-file (concat texfilebase e)))
16056 pngfile))))
16058 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16059 "Fill a LaTeX header template TPL.
16060 In the template, the following place holders will be recognized:
16063 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16065 [NO-PACKAGES] do not include PKG
16066 [EXTRA] the string EXTRA
16067 [NO-EXTRA] do not include EXTRA
16069 For backward compatibility, if both the positive and the negative place
16071 assumed to be present at the end of the template.
16072 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16073 EXTRA is a string.
16074 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16075 (let (rpl (end ""))
16077 (setq rpl (if (or (match-end 1) (not def-pkg))
16078 "" (org-latex-packages-to-string def-pkg snippets-p t))
16079 tpl (replace-match rpl t t tpl))
16080 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16083 (setq rpl (if (or (match-end 1) (not pkg))
16084 "" (org-latex-packages-to-string pkg snippets-p t))
16085 tpl (replace-match rpl t t tpl))
16086 (if pkg (setq end
16088 (org-latex-packages-to-string pkg snippets-p)))))
16091 (setq rpl (if (or (match-end 1) (not extra))
16093 tpl (replace-match rpl t t tpl))
16099 tpl)))
16101 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16103 (setq pkg (mapconcat (lambda(p)
16104 (cond
16105 ((stringp p) p)
16106 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16107 (format "%% Package %s omitted" (cadr p)))
16108 ((equal "" (car p))
16110 (t
16112 (car p) (cadr p)))))
16113 pkg
16117 (defun org-dvipng-color (attr)
16118 "Return an rgb color specification for dvipng."
16119 (apply 'format "rgb %s %s %s"
16120 (mapcar 'org-normalize-color
16121 (color-values (face-attribute 'default attr nil)))))
16123 (defun org-normalize-color (value)
16124 "Return string to be used as color value for an RGB component."
16125 (format "%g" (/ value 65535.0)))
16127 ;; Image display
16130 (defvar org-inline-image-overlays nil)
16131 (make-variable-buffer-local 'org-inline-image-overlays)
16133 (defun org-toggle-inline-images (&optional include-linked)
16134 "Toggle the display of inline images.
16135 INCLUDE-LINKED is passed to `org-display-inline-images'."
16136 (interactive "P")
16137 (if org-inline-image-overlays
16138 (progn
16139 (org-remove-inline-images)
16140 (message "Inline image display turned off"))
16141 (org-display-inline-images include-linked)
16142 (if org-inline-image-overlays
16143 (message "%d images displayed inline"
16144 (length org-inline-image-overlays))
16145 (message "No images to display inline"))))
16147 (defun org-display-inline-images (&optional include-linked refresh beg end)
16148 "Display inline images.
16149 Normally only links without a description part are inlined, because this
16150 is how it will work for export. When INCLUDE-LINKED is set, also links
16151 with a description part will be inlined. This can be nice for a quick
16152 look at those images, but it does not reflect what exported files will look
16153 like.
16154 When REFRESH is set, refresh existing images between BEG and END.
16155 This will create new image displays only if necessary.
16156 BEG and END default to the buffer boundaries."
16157 (interactive "P")
16158 (unless refresh
16159 (org-remove-inline-images)
16160 (clear-image-cache))
16161 (save-excursion
16162 (save-restriction
16163 (widen)
16164 (setq beg (or beg (point-min)) end (or end (point-max)))
16165 (goto-char (point-min))
16167 (substring (org-image-file-name-regexp) 0 -2)
16169 old file ov img)
16170 (while (re-search-forward re end t)
16171 (setq old (get-char-property-and-overlay (match-beginning 1)
16172 'org-image-overlay))
16173 (setq file (expand-file-name
16174 (concat (or (match-string 3) "") (match-string 4))))
16175 (when (file-exists-p file)
16176 (if (and (car-safe old) refresh)
16177 (image-refresh (overlay-get (cdr old) 'display))
16178 (setq img (create-image file))
16179 (when img
16180 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16181 (overlay-put ov 'display img)
16182 (overlay-put ov 'face 'default)
16183 (overlay-put ov 'org-image-overlay t)
16184 (overlay-put ov 'modification-hooks
16185 (list 'org-display-inline-modification-hook))
16186 (push ov org-inline-image-overlays)))))))))
16188 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16189 "Remove inline-display overlay if a corresponding region is modified."
16190 (let ((inhibit-modification-hooks t))
16191 (when (and ov after)
16192 (delete ov org-inline-image-overlays)
16193 (delete-overlay ov))))
16195 (defun org-remove-inline-images ()
16196 "Remove inline display of images."
16197 (interactive)
16198 (mapc 'delete-overlay org-inline-image-overlays)
16199 (setq org-inline-image-overlays nil))
16201 ;;;; Key bindings
16203 ;; Make `C-c C-x' a prefix key
16204 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16206 ;; TAB key with modifiers
16207 (org-defkey org-mode-map "\C-i" 'org-cycle)
16208 (org-defkey org-mode-map [(tab)] 'org-cycle)
16209 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16210 (org-defkey org-mode-map [(meta tab)] 'org-complete)
16212 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
16213 ;; The following line is necessary under Suse GNU/Linux
16214 (unless (featurep 'xemacs)
16215 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16216 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16217 (define-key org-mode-map [backtab] 'org-shifttab)
16219 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16220 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16221 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16223 ;; Cursor keys with modifiers
16224 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16225 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16226 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16227 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16229 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16230 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16231 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16232 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16234 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16235 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16236 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16237 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16239 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16240 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16242 ;; Babel keys
16243 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16244 (mapc (lambda (pair)
16245 (define-key org-babel-map (car pair) (cdr pair)))
16246 org-babel-key-bindings)
16248 ;;; Extra keys for tty access.
16249 ;; We only set them when really needed because otherwise the
16250 ;; menus don't show the simple keys
16252 (when (or org-use-extra-keys
16253 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16254 (not window-system))
16255 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16256 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16257 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16258 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16259 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16260 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16261 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16262 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16263 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16264 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16265 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16266 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16267 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16268 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16269 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16270 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16271 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16272 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16273 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16274 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16275 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16276 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16277 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
16278 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16279 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16280 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16281 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16282 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16284 ;; All the other keys
16286 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16287 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16288 (if (boundp 'narrow-map)
16289 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16290 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16291 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16292 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16293 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16294 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16295 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16296 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16297 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16298 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16299 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16300 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16301 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16302 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16303 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16304 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16305 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16306 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16308 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16309 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16310 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16311 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16312 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16313 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16314 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16315 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16316 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16317 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16318 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16319 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16320 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16321 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16322 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16323 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16324 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16325 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16326 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16328 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16329 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16330 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16331 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16332 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16333 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16334 (org-defkey org-mode-map "\C-c^" 'org-sort)
16335 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16336 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16337 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16338 (org-defkey org-mode-map "\C-m" 'org-return)
16339 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16340 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16341 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16342 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16343 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16344 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16345 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16346 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16347 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16348 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16349 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16350 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16351 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16352 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16353 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16354 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16355 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16356 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16357 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16358 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16359 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16361 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16362 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16363 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16364 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16366 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16367 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16368 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16369 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16370 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16371 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16372 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16373 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16374 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16375 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16377 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16378 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16379 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16380 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16381 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16382 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16383 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16385 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16386 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16387 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16388 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16389 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16391 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16393 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16395 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16396 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16398 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16401 (when (featurep 'xemacs)
16402 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16405 (defconst org-speed-commands-default
16406 '(
16407 ("Outline Navigation")
16408 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16409 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16410 ("f" . (org-speed-move-safe 'org-forward-same-level))
16411 ("b" . (org-speed-move-safe 'org-backward-same-level))
16412 ("u" . (org-speed-move-safe 'outline-up-heading))
16413 ("j" . org-goto)
16414 ("g" . (org-refile t))
16415 ("Outline Visibility")
16416 ("c" . org-cycle)
16417 ("C" . org-shifttab)
16418 (" " . org-display-outline-path)
16419 ("Outline Structure Editing")
16420 ("U" . org-shiftmetaup)
16421 ("D" . org-shiftmetadown)
16422 ("r" . org-metaright)
16423 ("l" . org-metaleft)
16424 ("R" . org-shiftmetaright)
16425 ("L" . org-shiftmetaleft)
16426 ("i" . (progn (forward-char 1) (call-interactively
16427 'org-insert-heading-respect-content)))
16428 ("^" . org-sort)
16429 ("w" . org-refile)
16430 ("a" . org-archive-subtree-default-with-confirmation)
16431 ("." . outline-mark-subtree)
16432 ("Clock Commands")
16433 ("I" . org-clock-in)
16434 ("O" . org-clock-out)
16435 ("Meta Data Editing")
16436 ("t" . org-todo)
16437 ("0" . (org-priority ?\ ))
16438 ("1" . (org-priority ?A))
16439 ("2" . (org-priority ?B))
16440 ("3" . (org-priority ?C))
16441 (";" . org-set-tags-command)
16442 ("e" . org-set-effort)
16443 ("Agenda Views etc")
16444 ("v" . org-agenda)
16445 ("/" . org-sparse-tree)
16446 ("Misc")
16447 ("o" . org-open-at-point)
16448 ("?" . org-speed-command-help)
16449 ("<" . (org-agenda-set-restriction-lock 'subtree))
16450 (">" . (org-agenda-remove-restriction-lock))
16451 )
16452 "The default speed commands.")
16454 (defun org-print-speed-command (e)
16455 (if (> (length (car e)) 1)
16456 (progn
16458 (princ (car e))
16460 (princ (make-string (length (car e)) ?-))
16462 (princ (car e))
16463 (princ " ")
16464 (if (symbolp (cdr e))
16465 (princ (symbol-name (cdr e)))
16466 (prin1 (cdr e)))
16469 (defun org-speed-command-help ()
16470 "Show the available speed commands."
16471 (interactive)
16472 (if (not org-use-speed-commands)
16473 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16474 (with-output-to-temp-buffer "*Help*"
16476 (mapc 'org-print-speed-command org-speed-commands-user)
16479 (mapc 'org-print-speed-command org-speed-commands-default))
16480 (with-current-buffer "*Help*"
16481 (setq truncate-lines t))))
16483 (defun org-speed-move-safe (cmd)
16484 "Execute CMD, but make sure that the cursor always ends up in a headline.
16485 If not, return to the original position and throw an error."
16486 (interactive)
16487 (let ((pos (point)))
16488 (call-interactively cmd)
16489 (unless (and (bolp) (org-on-heading-p))
16490 (goto-char pos)
16491 (error "Boundary reached while executing %s" cmd))))
16493 (defvar org-self-insert-command-undo-counter 0)
16495 (defvar org-table-auto-blank-field) ; defined in org-table.el
16496 (defvar org-speed-command nil)
16497 (defun org-self-insert-command (N)
16498 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16499 If the cursor is in a table looking at whitespace, the whitespace is
16500 overwritten, and the table is not marked as requiring realignment."
16501 (interactive "p")
16502 (cond
16503 ((and org-use-speed-commands
16504 (or (and (bolp) (looking-at outline-regexp))
16505 (and (functionp org-use-speed-commands)
16506 (funcall org-use-speed-commands)))
16507 (setq
16508 org-speed-command
16509 (or (cdr (assoc (this-command-keys) org-speed-commands-user))
16510 (cdr (assoc (this-command-keys) org-speed-commands-default)))))
16511 (cond
16512 ((commandp org-speed-command)
16513 (setq this-command org-speed-command)
16514 (call-interactively org-speed-command))
16515 ((functionp org-speed-command)
16516 (funcall org-speed-command))
16517 ((and org-speed-command (listp org-speed-command))
16518 (eval org-speed-command))
16519 (t (let (org-use-speed-commands)
16520 (call-interactively 'org-self-insert-command)))))
16521 ((and
16522 (org-table-p)
16523 (progn
16524 ;; check if we blank the field, and if that triggers align
16525 (and (featurep 'org-table) org-table-auto-blank-field
16526 (member last-command
16527 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16529 ;; got extra space, this field does not determine column width
16530 (let (org-table-may-need-update) (org-table-blank-field))
16531 ;; no extra space, this field may determine column width
16532 (org-table-blank-field)))
16533 t)
16534 (eq N 1)
16536 (let (org-table-may-need-update)
16537 (goto-char (1- (match-end 0)))
16538 (delete-backward-char 1)
16539 (goto-char (match-beginning 0))
16540 (self-insert-command N)))
16541 (t
16542 (setq org-table-may-need-update t)
16543 (self-insert-command N)
16544 (org-fix-tags-on-the-fly)
16545 (if org-self-insert-cluster-for-undo
16546 (if (not (eq last-command 'org-self-insert-command))
16547 (setq org-self-insert-command-undo-counter 1)
16548 (if (>= org-self-insert-command-undo-counter 20)
16549 (setq org-self-insert-command-undo-counter 1)
16550 (and (> org-self-insert-command-undo-counter 0)
16551 buffer-undo-list
16552 (not (cadr buffer-undo-list)) ; remove nil entry
16553 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16554 (setq org-self-insert-command-undo-counter
16555 (1+ org-self-insert-command-undo-counter))))))))
16557 (defun org-fix-tags-on-the-fly ()
16558 (when (and (equal (char-after (point-at-bol)) ?*)
16559 (org-on-heading-p))
16560 (org-align-tags-here org-tags-column)))
16562 (defun org-delete-backward-char (N)
16563 "Like `delete-backward-char', insert whitespace at field end in tables.
16564 When deleting backwards, in tables this function will insert whitespace in
16566 still be marked for re-alignment if the field did fill the entire column,
16567 because, in this case the deletion might narrow the column."
16568 (interactive "p")
16569 (if (and (org-table-p)
16570 (eq N 1)
16571 (string-match "|" (buffer-substring (point-at-bol) (point)))
16572 (looking-at ".*?|"))
16573 (let ((pos (point))
16575 (c org-table-may-need-update))
16576 (backward-delete-char N)
16577 (if (not overwrite-mode)
16578 (progn
16579 (skip-chars-forward "^|")
16580 (insert " ")
16581 (goto-char (1- pos))))
16582 ;; noalign: if there were two spaces at the end, this field
16583 ;; does not determine the width of the column.
16584 (if noalign (setq org-table-may-need-update c)))
16585 (backward-delete-char N)
16586 (org-fix-tags-on-the-fly)))
16588 (defun org-delete-char (N)
16589 "Like `delete-char', but insert whitespace at field end in tables.
16590 When deleting characters, in tables this function will insert whitespace in
16592 still be marked for re-alignment if the field did fill the entire column,
16593 because, in this case the deletion might narrow the column."
16594 (interactive "p")
16595 (if (and (org-table-p)
16596 (not (bolp))
16597 (not (= (char-after) ?|))
16598 (eq N 1))
16599 (if (looking-at ".*?|")
16600 (let ((pos (point))
16602 (c org-table-may-need-update))
16603 (replace-match (concat
16604 (substring (match-string 0) 1 -1)
16605 " |"))
16606 (goto-char pos)
16607 ;; noalign: if there were two spaces at the end, this field
16608 ;; does not determine the width of the column.
16609 (if noalign (setq org-table-may-need-update c)))
16610 (delete-char N))
16611 (delete-char N)
16612 (org-fix-tags-on-the-fly)))
16614 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16615 (put 'org-self-insert-command 'delete-selection t)
16616 (put 'orgtbl-self-insert-command 'delete-selection t)
16617 (put 'org-delete-char 'delete-selection 'supersede)
16618 (put 'org-delete-backward-char 'delete-selection 'supersede)
16619 (put 'org-yank 'delete-selection 'yank)
16621 ;; Make `flyspell-mode' delay after some commands
16622 (put 'org-self-insert-command 'flyspell-delayed t)
16623 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16624 (put 'org-delete-char 'flyspell-delayed t)
16625 (put 'org-delete-backward-char 'flyspell-delayed t)
16627 ;; Make pabbrev-mode expand after org-mode commands
16628 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16629 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16631 ;; How to do this: Measure non-white length of current string
16632 ;; If equal to column width, we should realign.
16634 (defun org-remap (map &rest commands)
16635 "In MAP, remap the functions given in COMMANDS.
16636 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16637 (let (new old)
16638 (while commands
16639 (setq old (pop commands) new (pop commands))
16640 (if (fboundp 'command-remapping)
16641 (org-defkey map (vector 'remap old) new)
16642 (substitute-key-definition old new map global-map)))))
16644 (when (eq org-enable-table-editor 'optimized)
16645 ;; If the user wants maximum table support, we need to hijack
16646 ;; some standard editing functions
16647 (org-remap org-mode-map
16648 'self-insert-command 'org-self-insert-command
16649 'delete-char 'org-delete-char
16650 'delete-backward-char 'org-delete-backward-char)
16651 (org-defkey org-mode-map "|" 'org-force-self-insert))
16653 (defvar org-ctrl-c-ctrl-c-hook nil
16654 "Hook for functions attaching themselves to `C-c C-c'.
16655 This can be used to add additional functionality to the C-c C-c key which
16656 executes context-dependent commands.
16657 Each function will be called with no arguments. The function must check
16658 if the context is appropriate for it to act. If yes, it should do its
16659 thing and then return a non-nil value. If the context is wrong,
16660 just do nothing and return nil.")
16662 (defvar org-tab-first-hook nil
16663 "Hook for functions to attach themselves to TAB.
16664 See `org-ctrl-c-ctrl-c-hook' for more information.
16665 This hook runs as the first action when TAB is pressed, even before
16666 `org-cycle' messes around with the `outline-regexp' to cater for
16667 inline tasks and plain list item folding.
16668 If any function in this hook returns t, any other actions that
16669 would have been caused by TAB (such as table field motion or visibility
16670 cycling) will not occur.")
16672 (defvar org-tab-after-check-for-table-hook nil
16673 "Hook for functions to attach themselves to TAB.
16674 See `org-ctrl-c-ctrl-c-hook' for more information.
16675 This hook runs after it has been established that the cursor is not in a
16676 table, but before checking if the cursor is in a headline or if global cycling
16677 should be done.
16678 If any function in this hook returns t, not other actions like visibility
16679 cycling will be done.")
16681 (defvar org-tab-after-check-for-cycling-hook nil
16682 "Hook for functions to attach themselves to TAB.
16683 See `org-ctrl-c-ctrl-c-hook' for more information.
16684 This hook runs after it has been established that not table field motion and
16685 not visibility should be done because of current context. This is probably
16686 the place where a package like yasnippets can hook in.")
16688 (defvar org-tab-before-tab-emulation-hook nil
16689 "Hook for functions to attach themselves to TAB.
16690 See `org-ctrl-c-ctrl-c-hook' for more information.
16691 This hook runs after every other options for TAB have been exhausted, but
16694 (defvar org-metaleft-hook nil
16695 "Hook for functions attaching themselves to `M-left'.
16696 See `org-ctrl-c-ctrl-c-hook' for more information.")
16697 (defvar org-metaright-hook nil
16698 "Hook for functions attaching themselves to `M-right'.
16699 See `org-ctrl-c-ctrl-c-hook' for more information.")
16700 (defvar org-metaup-hook nil
16701 "Hook for functions attaching themselves to `M-up'.
16702 See `org-ctrl-c-ctrl-c-hook' for more information.")
16703 (defvar org-metadown-hook nil
16704 "Hook for functions attaching themselves to `M-down'.
16705 See `org-ctrl-c-ctrl-c-hook' for more information.")
16706 (defvar org-shiftmetaleft-hook nil
16707 "Hook for functions attaching themselves to `M-S-left'.
16708 See `org-ctrl-c-ctrl-c-hook' for more information.")
16709 (defvar org-shiftmetaright-hook nil
16710 "Hook for functions attaching themselves to `M-S-right'.
16711 See `org-ctrl-c-ctrl-c-hook' for more information.")
16712 (defvar org-shiftmetaup-hook nil
16713 "Hook for functions attaching themselves to `M-S-up'.
16714 See `org-ctrl-c-ctrl-c-hook' for more information.")
16715 (defvar org-shiftmetadown-hook nil
16716 "Hook for functions attaching themselves to `M-S-down'.
16717 See `org-ctrl-c-ctrl-c-hook' for more information.")
16718 (defvar org-metareturn-hook nil
16719 "Hook for functions attaching themselves to `M-RET'.
16720 See `org-ctrl-c-ctrl-c-hook' for more information.")
16721 (defvar org-shiftup-hook nil
16722 "Hook for functions attaching themselves to `S-up'.
16723 See `org-ctrl-c-ctrl-c-hook' for more information.")
16724 (defvar org-shiftup-final-hook nil
16725 "Hook for functions attaching themselves to `S-up'.
16726 This one runs after all other options except shift-select have been excluded.
16727 See `org-ctrl-c-ctrl-c-hook' for more information.")
16728 (defvar org-shiftdown-hook nil
16729 "Hook for functions attaching themselves to `S-down'.
16730 See `org-ctrl-c-ctrl-c-hook' for more information.")
16731 (defvar org-shiftdown-final-hook nil
16732 "Hook for functions attaching themselves to `S-down'.
16733 This one runs after all other options except shift-select have been excluded.
16734 See `org-ctrl-c-ctrl-c-hook' for more information.")
16735 (defvar org-shiftleft-hook nil
16736 "Hook for functions attaching themselves to `S-left'.
16737 See `org-ctrl-c-ctrl-c-hook' for more information.")
16738 (defvar org-shiftleft-final-hook nil
16739 "Hook for functions attaching themselves to `S-left'.
16740 This one runs after all other options except shift-select have been excluded.
16741 See `org-ctrl-c-ctrl-c-hook' for more information.")
16742 (defvar org-shiftright-hook nil
16743 "Hook for functions attaching themselves to `S-right'.
16744 See `org-ctrl-c-ctrl-c-hook' for more information.")
16745 (defvar org-shiftright-final-hook nil
16746 "Hook for functions attaching themselves to `S-right'.
16747 This one runs after all other options except shift-select have been excluded.
16748 See `org-ctrl-c-ctrl-c-hook' for more information.")
16750 (defun org-modifier-cursor-error ()
16751 "Throw an error, a modified cursor command was applied in wrong context."
16752 (error "This command is active in special context like tables, headlines or items"))
16754 (defun org-shiftselect-error ()
16755 "Throw an error because Shift-Cursor command was applied in wrong context."
16756 (if (and (boundp 'shift-select-mode) shift-select-mode)
16757 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16758 (error "This command works only in special context like headlines or timestamps")))
16760 (defun org-call-for-shift-select (cmd)
16761 (let ((this-command-keys-shift-translated t))
16762 (call-interactively cmd)))
16764 (defun org-shifttab (&optional arg)
16765 "Global visibility cycling or move to previous table field.
16766 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16767 on context.
16768 See the individual commands for more information."
16769 (interactive "P")
16770 (cond
16771 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16772 ((integerp arg)
16773 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16774 (message "Content view to level: %d" arg)
16775 (org-content (prefix-numeric-value arg2))
16776 (setq org-cycle-global-status 'overview)))
16777 (t (call-interactively 'org-global-cycle))))
16779 (defun org-shiftmetaleft ()
16780 "Promote subtree or delete table column.
16781 Calls `org-promote-subtree', `org-outdent-item',
16782 or `org-table-delete-column', depending on context.
16783 See the individual commands for more information."
16784 (interactive)
16785 (cond
16786 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16787 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16788 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16789 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16790 (t (org-modifier-cursor-error))))
16792 (defun org-shiftmetaright ()
16793 "Demote subtree or insert table column.
16794 Calls `org-demote-subtree', `org-indent-item',
16795 or `org-table-insert-column', depending on context.
16796 See the individual commands for more information."
16797 (interactive)
16798 (cond
16799 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16800 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16801 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16802 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16803 (t (org-modifier-cursor-error))))
16805 (defun org-shiftmetaup (&optional arg)
16806 "Move subtree up or kill table row.
16807 Calls `org-move-subtree-up' or `org-table-kill-row' or
16808 `org-move-item-up' depending on context. See the individual commands
16809 for more information."
16810 (interactive "P")
16811 (cond
16812 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16813 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16814 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16815 ((org-at-item-p) (call-interactively 'org-move-item-up))
16816 (t (org-modifier-cursor-error))))
16818 (defun org-shiftmetadown (&optional arg)
16819 "Move subtree down or insert table row.
16820 Calls `org-move-subtree-down' or `org-table-insert-row' or
16821 `org-move-item-down', depending on context. See the individual
16822 commands for more information."
16823 (interactive "P")
16824 (cond
16825 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16826 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16827 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16828 ((org-at-item-p) (call-interactively 'org-move-item-down))
16829 (t (org-modifier-cursor-error))))
16831 (defsubst org-hidden-tree-error ()
16832 (error
16833 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16835 (defun org-metaleft (&optional arg)
16836 "Promote heading or move table column to left.
16837 Calls `org-do-promote' or `org-table-move-column', depending on context.
16838 With no specific context, calls the Emacs default `backward-word'.
16839 See the individual commands for more information."
16840 (interactive "P")
16841 (cond
16842 ((run-hook-with-args-until-success 'org-metaleft-hook))
16843 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16844 ((or (org-on-heading-p)
16845 (and (org-region-active-p)
16846 (save-excursion
16847 (goto-char (region-beginning))
16848 (org-on-heading-p))))
16849 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16850 (call-interactively 'org-do-promote))
16851 ((or (org-at-item-p)
16852 (and (org-region-active-p)
16853 (save-excursion
16854 (goto-char (region-beginning))
16855 (org-at-item-p))))
16856 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16857 (call-interactively 'org-outdent-item))
16858 (t (call-interactively 'backward-word))))
16860 (defun org-metaright (&optional arg)
16861 "Demote subtree or move table column to right.
16862 Calls `org-do-demote' or `org-table-move-column', depending on context.
16863 With no specific context, calls the Emacs default `forward-word'.
16864 See the individual commands for more information."
16865 (interactive "P")
16866 (cond
16867 ((run-hook-with-args-until-success 'org-metaright-hook))
16868 ((org-at-table-p) (call-interactively 'org-table-move-column))
16869 ((or (org-on-heading-p)
16870 (and (org-region-active-p)
16871 (save-excursion
16872 (goto-char (region-beginning))
16873 (org-on-heading-p))))
16874 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16875 (call-interactively 'org-do-demote))
16876 ((or (org-at-item-p)
16877 (and (org-region-active-p)
16878 (save-excursion
16879 (goto-char (region-beginning))
16880 (org-at-item-p))))
16881 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16882 (call-interactively 'org-indent-item))
16883 (t (call-interactively 'forward-word))))
16885 (defun org-check-for-hidden (what)
16886 "Check if there are hidden headlines/items in the current visual line.
16887 WHAT can be either `headlines' or `items'. If the current line is
16888 an outline or item heading and it has a folded subtree below it,
16889 this function returns t, nil otherwise."
16890 (let ((re (cond
16891 ((eq what 'headlines) (concat "^" org-outline-regexp))
16892 ((eq what 'items) (concat "^" (org-item-re t)))
16893 (t (error "This should not happen"))))
16894 beg end)
16895 (save-excursion
16896 (catch 'exit
16897 (unless (org-region-active-p)
16898 (setq beg (point-at-bol))
16899 (beginning-of-line 2)
16900 (while (and (not (eobp)) ;; this is like `next-line'
16901 (get-char-property (1- (point)) 'invisible))
16902 (beginning-of-line 2))
16903 (setq end (point))
16904 (goto-char beg)
16905 (goto-char (point-at-eol))
16906 (setq end (max end (point)))
16907 (while (re-search-forward re end t)
16908 (if (get-char-property (match-beginning 0) 'invisible)
16909 (throw 'exit t))))
16910 nil))))
16912 (defun org-metaup (&optional arg)
16913 "Move subtree up or move table row up.
16914 Calls `org-move-subtree-up' or `org-table-move-row' or
16915 `org-move-item-up', depending on context. See the individual commands
16916 for more information."
16917 (interactive "P")
16918 (cond
16919 ((run-hook-with-args-until-success 'org-metaup-hook))
16920 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16921 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16922 ((org-at-item-p) (call-interactively 'org-move-item-up))
16923 (t (transpose-lines 1) (beginning-of-line -1))))
16925 (defun org-metadown (&optional arg)
16926 "Move subtree down or move table row down.
16927 Calls `org-move-subtree-down' or `org-table-move-row' or
16928 `org-move-item-down', depending on context. See the individual
16929 commands for more information."
16930 (interactive "P")
16931 (cond
16932 ((run-hook-with-args-until-success 'org-metadown-hook))
16933 ((org-at-table-p) (call-interactively 'org-table-move-row))
16934 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16935 ((org-at-item-p) (call-interactively 'org-move-item-down))
16936 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16938 (defun org-shiftup (&optional arg)
16939 "Increase item in timestamp or increase priority of current headline.
16940 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16941 depending on context. See the individual commands for more information."
16942 (interactive "P")
16943 (cond
16944 ((run-hook-with-args-until-success 'org-shiftup-hook))
16945 ((and org-support-shift-select (org-region-active-p))
16946 (org-call-for-shift-select 'previous-line))
16947 ((org-at-timestamp-p t)
16948 (call-interactively (if org-edit-timestamp-down-means-later
16949 'org-timestamp-down 'org-timestamp-up)))
16950 ((and (not (eq org-support-shift-select 'always))
16951 org-enable-priority-commands
16952 (org-on-heading-p))
16953 (call-interactively 'org-priority-up))
16954 ((and (not org-support-shift-select) (org-at-item-p))
16955 (call-interactively 'org-previous-item))
16956 ((org-clocktable-try-shift 'up arg))
16957 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
16958 (org-support-shift-select
16959 (org-call-for-shift-select 'previous-line))
16960 (t (org-shiftselect-error))))
16962 (defun org-shiftdown (&optional arg)
16963 "Decrease item in timestamp or decrease priority of current headline.
16964 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
16965 depending on context. See the individual commands for more information."
16966 (interactive "P")
16967 (cond
16968 ((run-hook-with-args-until-success 'org-shiftdown-hook))
16969 ((and org-support-shift-select (org-region-active-p))
16970 (org-call-for-shift-select 'next-line))
16971 ((org-at-timestamp-p t)
16972 (call-interactively (if org-edit-timestamp-down-means-later
16973 'org-timestamp-up 'org-timestamp-down)))
16974 ((and (not (eq org-support-shift-select 'always))
16975 org-enable-priority-commands
16976 (org-on-heading-p))
16977 (call-interactively 'org-priority-down))
16978 ((and (not org-support-shift-select) (org-at-item-p))
16979 (call-interactively 'org-next-item))
16980 ((org-clocktable-try-shift 'down arg))
16981 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
16982 (org-support-shift-select
16983 (org-call-for-shift-select 'next-line))
16984 (t (org-shiftselect-error))))
16986 (defun org-shiftright (&optional arg)
16987 "Cycle the thing at point or in the current line, depending on context.
16988 Depending on context, this does one of the following:
16990 - switch a timestamp at point one day into the future
16991 - on a headline, switch to the next TODO keyword.
16992 - on an item, switch entire list to the next bullet type
16993 - on a property line, switch to the next allowed value
16994 - on a clocktable definition line, move time block into the future"
16995 (interactive "P")
16996 (cond
16997 ((run-hook-with-args-until-success 'org-shiftright-hook))
16998 ((and org-support-shift-select (org-region-active-p))
16999 (org-call-for-shift-select 'forward-char))
17000 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17001 ((and (not (eq org-support-shift-select 'always))
17002 (org-on-heading-p))
17003 (let ((org-inhibit-logging
17004 (not org-treat-S-cursor-todo-selection-as-state-change))
17005 (org-inhibit-blocking
17006 (not org-treat-S-cursor-todo-selection-as-state-change)))
17007 (org-call-with-arg 'org-todo 'right)))
17008 ((or (and org-support-shift-select
17009 (not (eq org-support-shift-select 'always))
17010 (org-at-item-bullet-p))
17011 (and (not org-support-shift-select) (org-at-item-p)))
17012 (org-call-with-arg 'org-cycle-list-bullet nil))
17013 ((and (not (eq org-support-shift-select 'always))
17014 (org-at-property-p))
17015 (call-interactively 'org-property-next-allowed-value))
17016 ((org-clocktable-try-shift 'right arg))
17017 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17018 (org-support-shift-select
17019 (org-call-for-shift-select 'forward-char))
17020 (t (org-shiftselect-error))))
17022 (defun org-shiftleft (&optional arg)
17023 "Cycle the thing at point or in the current line, depending on context.
17024 Depending on context, this does one of the following:
17026 - switch a timestamp at point one day into the past
17027 - on a headline, switch to the previous TODO keyword.
17028 - on an item, switch entire list to the previous bullet type
17029 - on a property line, switch to the previous allowed value
17030 - on a clocktable definition line, move time block into the past"
17031 (interactive "P")
17032 (cond
17033 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17034 ((and org-support-shift-select (org-region-active-p))
17035 (org-call-for-shift-select 'backward-char))
17036 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17037 ((and (not (eq org-support-shift-select 'always))
17038 (org-on-heading-p))
17039 (let ((org-inhibit-logging
17040 (not org-treat-S-cursor-todo-selection-as-state-change))
17041 (org-inhibit-blocking
17042 (not org-treat-S-cursor-todo-selection-as-state-change)))
17043 (org-call-with-arg 'org-todo 'left)))
17044 ((or (and org-support-shift-select
17045 (not (eq org-support-shift-select 'always))
17046 (org-at-item-bullet-p))
17047 (and (not org-support-shift-select) (org-at-item-p)))
17048 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17049 ((and (not (eq org-support-shift-select 'always))
17050 (org-at-property-p))
17051 (call-interactively 'org-property-previous-allowed-value))
17052 ((org-clocktable-try-shift 'left arg))
17053 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17054 (org-support-shift-select
17055 (org-call-for-shift-select 'backward-char))
17056 (t (org-shiftselect-error))))
17058 (defun org-shiftcontrolright ()
17059 "Switch to next TODO set."
17060 (interactive)
17061 (cond
17062 ((and org-support-shift-select (org-region-active-p))
17063 (org-call-for-shift-select 'forward-word))
17064 ((and (not (eq org-support-shift-select 'always))
17065 (org-on-heading-p))
17066 (org-call-with-arg 'org-todo 'nextset))
17067 (org-support-shift-select
17068 (org-call-for-shift-select 'forward-word))
17069 (t (org-shiftselect-error))))
17071 (defun org-shiftcontrolleft ()
17072 "Switch to previous TODO set."
17073 (interactive)
17074 (cond
17075 ((and org-support-shift-select (org-region-active-p))
17076 (org-call-for-shift-select 'backward-word))
17077 ((and (not (eq org-support-shift-select 'always))
17078 (org-on-heading-p))
17079 (org-call-with-arg 'org-todo 'previousset))
17080 (org-support-shift-select
17081 (org-call-for-shift-select 'backward-word))
17082 (t (org-shiftselect-error))))
17084 (defun org-ctrl-c-ret ()
17085 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17086 (interactive)
17087 (cond
17088 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17089 (t (call-interactively 'org-insert-heading))))
17091 (defun org-copy-special ()
17092 "Copy region in table or copy current subtree.
17093 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17094 See the individual commands for more information."
17095 (interactive)
17096 (call-interactively
17097 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17099 (defun org-cut-special ()
17100 "Cut region in table or cut current subtree.
17101 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17102 See the individual commands for more information."
17103 (interactive)
17104 (call-interactively
17105 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17107 (defun org-paste-special (arg)
17108 "Paste rectangular region into table, or past subtree relative to level.
17109 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17110 See the individual commands for more information."
17111 (interactive "P")
17112 (if (org-at-table-p)
17113 (org-table-paste-rectangle)
17114 (org-paste-subtree arg)))
17116 (defun org-edit-special (&optional arg)
17117 "Call a special editor for the stuff at point.
17118 When at a table, call the formula editor with `org-table-edit-formulas'.
17119 When at the first line of an src example, call `org-edit-src-code'.
17120 When in an #+include line, visit the include file. Otherwise call
17121 `ffap' to visit the file at point."
17122 (interactive)
17123 ;; possibly prep session before editing source
17124 (when arg
17125 (let* ((info (org-babel-get-src-block-info))
17126 (lang (nth 0 info))
17127 (params (nth 2 info))
17128 (session (cdr (assoc :session params))))
17129 (when (and info session) ;; we are in a source-code block with a session
17130 (funcall
17131 (intern (concat "org-babel-prep-session:" lang)) session params))))
17132 (cond ;; proceed with `org-edit-special'
17133 ((save-excursion
17134 (beginning-of-line 1)
17135 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17136 (find-file (org-trim (match-string 1))))
17137 ((org-edit-src-code))
17138 ((org-edit-fixed-width-region))
17139 ((org-at-table.el-p)
17140 (org-edit-src-code))
17141 ((org-at-table-p)
17142 (call-interactively 'org-table-edit-formulas))
17143 (t (call-interactively 'ffap))))
17146 (defun org-ctrl-c-ctrl-c (&optional arg)
17147 "Set tags in headline, or update according to changed information at point.
17149 This command does many different things, depending on context:
17151 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17152 this is what we do.
17154 - If the cursor is on a statistics cookie, update it.
17156 - If the cursor is in a headline, prompt for tags and insert them
17157 into the current line, aligned to `org-tags-column'. When called
17158 with prefix arg, realign all tags in the current buffer.
17160 - If the cursor is in one of the special #+KEYWORD lines, this
17161 triggers scanning the buffer for these lines and updating the
17162 information.
17164 - If the cursor is inside a table, realign the table. This command
17165 works even if the automatic table editor has been turned off.
17167 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17168 the entire table.
17170 - If the cursor is at a footnote reference or definition, jump to
17171 the corresponding definition or references, respectively.
17173 - If the cursor is a the beginning of a dynamic block, update it.
17175 - If the current buffer is a capture buffer, close note and file it.
17177 - If the cursor is on a <<<target>>>, update radio targets and
17178 corresponding links in this buffer.
17180 - If the cursor is on a numbered item in a plain list, renumber the
17181 ordered list.
17183 - If the cursor is on a checkbox, toggle it.
17185 - If the cursor is on a code block, evaluate it. The variable
17186 `org-confirm-babel-evaluate' can be used to control prompting
17187 before code block evaluation, by default every code block
17188 evaluation requires confirmation. Code block evaluation can be
17189 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17190 (interactive "P")
17191 (let ((org-enable-table-editor t))
17192 (cond
17193 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17194 org-occur-highlights
17195 org-latex-fragment-image-overlays)
17196 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17197 (org-remove-occur-highlights)
17198 (org-remove-latex-fragment-image-overlays)
17199 (message "Temporary highlights/overlays removed from current buffer"))
17200 ((and (local-variable-p 'org-finish-function (current-buffer))
17201 (fboundp org-finish-function))
17202 (funcall org-finish-function))
17203 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17204 ((or (looking-at org-property-start-re)
17205 (org-at-property-p))
17206 (call-interactively 'org-property-action))
17207 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17209 (or (org-on-heading-p) (org-at-item-p)))
17210 (call-interactively 'org-update-statistics-cookies))
17211 ((org-on-heading-p) (call-interactively 'org-set-tags))
17212 ((org-at-table.el-p)
17213 (message "Use C-c ' to edit table.el tables"))
17214 ((org-at-table-p)
17215 (org-table-maybe-eval-formula)
17216 (if arg
17217 (call-interactively 'org-table-recalculate)
17218 (org-table-maybe-recalculate-line))
17219 (call-interactively 'org-table-align))
17220 ((or (org-footnote-at-reference-p)
17221 (org-footnote-at-definition-p))
17222 (call-interactively 'org-footnote-action))
17223 ((org-at-item-checkbox-p)
17224 (call-interactively 'org-list-repair)
17225 (call-interactively 'org-toggle-checkbox)
17226 (org-list-send-list 'maybe))
17227 ((org-at-item-p)
17228 (call-interactively 'org-list-repair)
17229 (when arg (call-interactively 'org-toggle-checkbox))
17230 (org-list-send-list 'maybe))
17231 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17232 ;; Dynamic block
17233 (beginning-of-line 1)
17234 (save-excursion (org-update-dblock)))
17235 ((save-excursion
17236 (beginning-of-line 1)
17238 (cond
17239 ((equal (match-string 1) "TBLFM")
17240 ;; Recalculate the table before this line
17241 (save-excursion
17242 (beginning-of-line 1)
17244 (if (org-at-table-p)
17245 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17246 (t
17247 (let ((org-inhibit-startup-visibility-stuff t)
17248 (org-startup-align-all-tables nil))
17249 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17250 (message "Local setup has been refreshed"))))
17251 ((org-clock-update-time-maybe))
17252 (t (error "C-c C-c can do nothing useful at this location")))))
17254 (defun org-mode-restart ()
17255 "Restart Org-mode, to scan again for special lines.
17256 Also updates the keyword regular expressions."
17257 (interactive)
17258 (org-mode)
17259 (message "Org-mode restarted"))
17261 (defun org-kill-note-or-show-branches ()
17262 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17263 (interactive)
17264 (if (not org-finish-function)
17265 (progn
17266 (hide-subtree)
17267 (call-interactively 'show-branches))
17268 (let ((org-note-abort t))
17269 (funcall org-finish-function))))
17271 (defun org-return (&optional indent)
17272 "Goto next table row or insert a newline.
17273 Calls `org-table-next-row' or `newline', depending on context.
17274 See the individual commands for more information."
17275 (interactive)
17276 (cond
17277 ((bobp) (if indent (newline-and-indent) (newline)))
17278 ((org-at-table-p)
17279 (org-table-justify-field-maybe)
17280 (call-interactively 'org-table-next-row))
17281 ((and org-return-follows-link
17282 (eq (get-text-property (point) 'face) 'org-link))
17283 (call-interactively 'org-open-at-point))
17284 ((and (org-at-heading-p)
17285 (looking-at
17287 (org-show-entry)
17288 (end-of-line 1)
17289 (newline))
17290 (t (if indent (newline-and-indent) (newline)))))
17292 (defun org-return-indent ()
17293 "Goto next table row or insert a newline and indent.
17294 Calls `org-table-next-row' or `newline-and-indent', depending on
17295 context. See the individual commands for more information."
17296 (interactive)
17297 (org-return t))
17299 (defun org-ctrl-c-star ()
17300 "Compute table, or change heading status of lines.
17301 Calls `org-table-recalculate' or `org-toggle-heading',
17302 depending on context."
17303 (interactive)
17304 (cond
17305 ((org-at-table-p)
17306 (call-interactively 'org-table-recalculate))
17307 (t
17308 ;; Convert all lines in region to list items
17309 (call-interactively 'org-toggle-heading))))
17311 (defun org-ctrl-c-minus ()
17312 "Insert separator line in table or modify bullet status of line.
17313 Also turns a plain line or a region of lines into list items.
17314 Calls `org-table-insert-hline', `org-toggle-item', or
17315 `org-cycle-list-bullet', depending on context."
17316 (interactive)
17317 (cond
17318 ((org-at-table-p)
17319 (call-interactively 'org-table-insert-hline))
17320 ((org-region-active-p)
17321 (call-interactively 'org-toggle-item))
17322 ((org-in-item-p)
17323 (call-interactively 'org-cycle-list-bullet))
17324 (t
17325 (call-interactively 'org-toggle-item))))
17327 (defun org-toggle-item ()
17328 "Convert headings or normal lines to items, items to normal lines.
17329 If there is no active region, only the current line is considered.
17331 If the first line in the region is a headline, convert all headlines to items.
17333 If the first line in the region is an item, convert all items to normal lines.
17335 If the first line is normal text, add an item bullet to each line."
17336 (interactive)
17337 (let (l2 l beg end)
17338 (if (org-region-active-p)
17339 (setq beg (region-beginning) end (region-end))
17340 (setq beg (point-at-bol)
17341 end (min (1+ (point-at-eol)) (point-max))))
17342 (save-excursion
17343 (goto-char end)
17344 (setq l2 (org-current-line))
17345 (goto-char beg)
17346 (beginning-of-line 1)
17347 (setq l (1- (org-current-line)))
17348 (if (org-at-item-p)
17349 ;; We already have items, de-itemize
17350 (while (< (setq l (1+ l)) l2)
17351 (when (org-at-item-p)
17353 (delete-region (point) (match-end 0)))
17354 (beginning-of-line 2))
17355 (if (org-on-heading-p)
17356 ;; Headings, convert to items
17357 (while (< (setq l (1+ l)) l2)
17358 (if (looking-at org-outline-regexp)
17359 (replace-match (org-list-bullet-string "-") t t))
17360 (beginning-of-line 2))
17361 ;; normal lines, turn them into items
17362 (while (< (setq l (1+ l)) l2)
17363 (unless (org-at-item-p)
17365 (replace-match
17367 (beginning-of-line 2)))))))
17369 (defun org-toggle-heading (&optional nstars)
17370 "Convert headings to normal text, or items or text to headings.
17371 If there is no active region, only the current line is considered.
17373 If the first line is a heading, remove the stars from all headlines
17374 in the region.
17376 If the first line is a plain list item, turn all plain list items
17377 into headings.
17379 If the first line is a normal line, turn each and every line in the
17380 region into a heading.
17382 When converting a line into a heading, the number of stars is chosen
17383 such that the lines become children of the current entry. However,
17384 when a prefix argument is given, its value determines the number of
17385 stars to add."
17386 (interactive "P")
17387 (let (l2 l itemp beg end)
17388 (if (org-region-active-p)
17389 (setq beg (region-beginning) end (region-end))
17390 (setq beg (point-at-bol)
17391 end (min (1+ (point-at-eol)) (point-max))))
17392 (save-excursion
17393 (goto-char end)
17394 (setq l2 (org-current-line))
17395 (goto-char beg)
17396 (beginning-of-line 1)
17397 (setq l (1- (org-current-line)))
17398 (if (org-on-heading-p)
17399 ;; We already have headlines, de-star them
17400 (while (< (setq l (1+ l)) l2)
17401 (when (org-on-heading-p t)
17402 (and (looking-at outline-regexp) (replace-match "")))
17403 (beginning-of-line 2))
17404 (setq itemp (org-at-item-p))
17405 (let* ((stars
17406 (if nstars
17407 (make-string (prefix-numeric-value current-prefix-arg)
17408 ?*)
17409 (save-excursion
17410 (if (re-search-backward org-complex-heading-regexp nil t)
17411 (match-string 1) ""))))
17412 (add-stars (cond (nstars "")
17413 ((equal stars "") "*")
17414 (org-odd-levels-only "**")
17415 (t "*")))
17416 (rpl (concat stars add-stars " ")))
17417 (while (< (setq l (1+ l)) l2)
17418 (if itemp
17419 (and (org-at-item-p) (replace-match rpl t t))
17420 (unless (org-on-heading-p)
17422 (replace-match (concat rpl (match-string 2))))))
17423 (beginning-of-line 2)))))))
17425 (defun org-meta-return (&optional arg)
17426 "Insert a new heading or wrap a region in a table.
17427 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17428 See the individual commands for more information."
17429 (interactive "P")
17430 (cond
17431 ((run-hook-with-args-until-success 'org-metareturn-hook))
17432 ((org-at-table-p)
17433 (call-interactively 'org-table-wrap-region))
17434 (t (call-interactively 'org-insert-heading))))
17436 ;;; Menu entries
17438 ;; Define the Org-mode menus
17439 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17440 '("Tbl"
17441 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17442 ["Next Field" org-cycle (org-at-table-p)]
17443 ["Previous Field" org-shifttab (org-at-table-p)]
17444 ["Next Row" org-return (org-at-table-p)]
17445 "--"
17446 ["Blank Field" org-table-blank-field (org-at-table-p)]
17447 ["Edit Field" org-table-edit-field (org-at-table-p)]
17448 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17449 "--"
17450 ("Column"
17451 ["Move Column Left" org-metaleft (org-at-table-p)]
17452 ["Move Column Right" org-metaright (org-at-table-p)]
17453 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17454 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17455 ("Row"
17456 ["Move Row Up" org-metaup (org-at-table-p)]
17457 ["Move Row Down" org-metadown (org-at-table-p)]
17458 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17459 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17460 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17461 "--"
17462 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17463 ("Rectangle"
17464 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17465 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17466 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17467 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17468 "--"
17469 ("Calculate"
17470 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17471 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17472 ["Edit Formulas" org-edit-special (org-at-table-p)]
17473 "--"
17474 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17475 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17476 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17477 "--"
17478 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17479 "--"
17480 ["Sum Column/Rectangle" org-table-sum
17481 (or (org-at-table-p) (org-region-active-p))]
17482 ["Which Column?" org-table-current-column (org-at-table-p)])
17483 ["Debug Formulas"
17484 org-table-toggle-formula-debugger
17485 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17486 ["Show Col/Row Numbers"
17487 org-table-toggle-coordinate-overlays
17488 :style toggle
17489 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17490 "--"
17491 ["Create" org-table-create (and (not (org-at-table-p))
17492 org-enable-table-editor)]
17493 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17494 ["Import from File" org-table-import (not (org-at-table-p))]
17495 ["Export to File" org-table-export (org-at-table-p)]
17496 "--"
17497 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17499 (easy-menu-define org-org-menu org-mode-map "Org menu"
17500 '("Org"
17501 ("Show/Hide"
17502 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17503 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17504 ["Sparse Tree..." org-sparse-tree t]
17505 ["Reveal Context" org-reveal t]
17506 ["Show All" show-all t]
17507 "--"
17508 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17509 "--"
17510 ["New Heading" org-insert-heading t]
17511 ("Navigate Headings"
17512 ["Up" outline-up-heading t]
17513 ["Next" outline-next-visible-heading t]
17514 ["Previous" outline-previous-visible-heading t]
17515 ["Next Same Level" outline-forward-same-level t]
17516 ["Previous Same Level" outline-backward-same-level t]
17517 "--"
17518 ["Jump" org-goto t])
17519 ("Edit Structure"
17520 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17521 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17522 "--"
17523 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17524 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17525 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17526 "--"
17527 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17528 "--"
17529 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17530 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17531 ["Demote Heading" org-metaright (not (org-at-table-p))]
17532 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17533 "--"
17534 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17535 "--"
17536 ["Convert to odd levels" org-convert-to-odd-levels t]
17537 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17538 ("Editing"
17539 ["Emphasis..." org-emphasize t]
17540 ["Edit Source Example" org-edit-special t]
17541 "--"
17542 ["Footnote new/jump" org-footnote-action t]
17543 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17544 ("Archive"
17545 ["Archive (default method)" org-archive-subtree-default t]
17546 "--"
17547 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17548 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17549 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17550 )
17551 "--"
17552 ("Hyperlinks"
17553 ["Store Link (Global)" org-store-link t]
17554 ["Find existing link to here" org-occur-link-in-agenda-files t]
17555 ["Insert Link" org-insert-link t]
17556 ["Follow Link" org-open-at-point t]
17557 "--"
17558 ["Next link" org-next-link t]
17559 ["Previous link" org-previous-link t]
17560 "--"
17561 ["Descriptive Links"
17562 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17563 :style radio
17564 :selected (member '(org-link) buffer-invisibility-spec)]
17565 ["Literal Links"
17566 (progn
17567 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17568 :style radio
17569 :selected (not (member '(org-link) buffer-invisibility-spec))])
17570 "--"
17571 ("TODO Lists"
17572 ["TODO/DONE/-" org-todo t]
17573 ("Select keyword"
17574 ["Next keyword" org-shiftright (org-on-heading-p)]
17575 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17576 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
17577 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17578 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17579 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17580 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17581 "--"
17582 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17583 :selected org-enforce-todo-dependencies :style toggle :active t]
17584 "Settings for tree at point"
17585 ["Do Children sequentially" org-toggle-ordered-property :style radio
17586 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17587 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17588 ["Do Children parallel" org-toggle-ordered-property :style radio
17589 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17590 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17591 "--"
17592 ["Set Priority" org-priority t]
17593 ["Priority Up" org-shiftup t]
17594 ["Priority Down" org-shiftdown t]
17595 "--"
17596 ["Get news from all feeds" org-feed-update-all t]
17597 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17598 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17599 ("TAGS and Properties"
17600 ["Set Tags" org-set-tags-command t]
17601 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17602 "--"
17603 ["Set property" org-set-property t]
17604 ["Column view of properties" org-columns t]
17605 ["Insert Column View DBlock" org-insert-columns-dblock t])
17606 ("Dates and Scheduling"
17607 ["Timestamp" org-time-stamp t]
17608 ["Timestamp (inactive)" org-time-stamp-inactive t]
17609 ("Change Date"
17610 ["1 Day Later" org-shiftright t]
17611 ["1 Day Earlier" org-shiftleft t]
17612 ["1 ... Later" org-shiftup t]
17613 ["1 ... Earlier" org-shiftdown t])
17614 ["Compute Time Range" org-evaluate-time-range t]
17615 ["Schedule Item" org-schedule t]
17616 ["Deadline" org-deadline t]
17617 "--"
17618 ["Custom time format" org-toggle-time-stamp-overlays
17619 :style radio :selected org-display-custom-times]
17620 "--"
17621 ["Goto Calendar" org-goto-calendar t]
17622 ["Date from Calendar" org-date-from-calendar t]
17623 "--"
17624 ["Start/Restart Timer" org-timer-start t]
17625 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17626 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17627 ["Insert Timer String" org-timer t]
17628 ["Insert Timer Item" org-timer-item t])
17629 ("Logging work"
17630 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17631 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17632 ["Clock out" org-clock-out t]
17633 ["Clock cancel" org-clock-cancel t]
17634 "--"
17635 ["Mark as default task" org-clock-mark-default-task t]
17636 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17637 ["Goto running clock" org-clock-goto t]
17638 "--"
17639 ["Display times" org-clock-display t]
17640 ["Create clock table" org-clock-report t]
17641 "--"
17642 ["Record DONE time"
17643 (progn (setq org-log-done (not org-log-done))
17644 (message "Switching to %s will %s record a timestamp"
17645 (car org-done-keywords)
17646 (if org-log-done "automatically" "not")))
17647 :style toggle :selected org-log-done])
17648 "--"
17649 ["Agenda Command..." org-agenda t]
17650 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17651 ("File List for Agenda")
17652 ("Special views current file"
17653 ["TODO Tree" org-show-todo-tree t]
17654 ["Check Deadlines" org-check-deadlines t]
17655 ["Timeline" org-timeline t]
17656 ["Tags/Property tree" org-match-sparse-tree t])
17657 "--"
17658 ["Export/Publish..." org-export t]
17659 ("LaTeX"
17660 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17661 :selected org-cdlatex-mode]
17662 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17663 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17664 ["Modify math symbol" org-cdlatex-math-modify
17665 (org-inside-LaTeX-fragment-p)]
17666 ["Insert citation" org-reftex-citation t]
17667 "--"
17668 ["Template for BEAMER" org-insert-beamer-options-template t])
17669 "--"
17670 ("MobileOrg"
17671 ["Push Files and Views" org-mobile-push t]
17672 ["Get Captured and Flagged" org-mobile-pull t]
17673 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17674 "--"
17675 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17676 "--"
17677 ("Documentation"
17678 ["Show Version" org-version t]
17679 ["Info Documentation" org-info t])
17680 ("Customize"
17681 ["Browse Org Group" org-customize t]
17682 "--"
17683 ["Expand This Menu" org-create-customize-menu
17684 (fboundp 'customize-menu-create)])
17685 ["Send bug report" org-submit-bug-report t]
17686 "--"
17687 ("Refresh/Reload"
17688 ["Refresh setup current buffer" org-mode-restart t]
17689 ["Reload Org (after update)" org-reload t]
17690 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17691 ))
17693 (defun org-info (&optional node)
17694 "Read documentation for Org-mode in the info system.
17695 With optional NODE, go directly to that node."
17696 (interactive)
17697 (info (format "(org)%s" (or node ""))))
17699 ;;;###autoload
17700 (defun org-submit-bug-report ()
17701 "Submit a bug report on Org-mode via mail.
17703 Don't hesitate to report any problems or inaccurate documentation.
17705 If you don't have setup sending mail from (X)Emacs, please copy the
17706 output buffer into your mail program, as it gives us important
17707 information about your Org-mode version and configuration."
17708 (interactive)
17709 (require 'reporter)
17710 (org-load-modules-maybe)
17711 (org-require-autoloaded-modules)
17712 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17713 (reporter-submit-bug-report
17714 "emacs-orgmode@gnu.org"
17715 (org-version)
17716 (let (list)
17717 (save-window-excursion
17718 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17719 (delete-other-windows)
17720 (erase-buffer)
17721 (insert "You are about to submit a bug report to the Org-mode mailing list.
17723 We would like to add your full Org-mode and Outline configuration to the
17724 bug report. This greatly simplifies the work of the maintainer and
17725 other experts on the mailing list.
17727 HOWEVER, some variables you have customized may contain private
17728 information. The names of customers, colleagues, or friends, might
17729 appear in the form of file names, tags, todo states, or search strings.
17730 If you answer yes to the prompt, you might want to check and remove
17731 such private information before sending the email.")
17732 (add-text-properties (point-min) (point-max) '(face org-warning))
17733 (when (yes-or-no-p "Include your Org-mode configuration ")
17734 (mapatoms
17735 (lambda (v)
17736 (and (boundp v)
17738 (or (and (symbol-value v)
17740 (and
17741 (get v 'custom-type) (get v 'standard-value)
17742 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17743 (push v list)))))
17744 (kill-buffer (get-buffer "*Warn about privacy*"))
17745 list))
17746 nil nil
17747 "Remember to cover the basics, that is, what you expected to happen and
17748 what in fact did happen. You don't know how to make a good report? See
17750 http://orgmode.org/manual/Feedback.html#Feedback
17752 Your bug report will be posted to the Org-mode mailing list.
17753 ------------------------------------------------------------------------")
17754 (save-excursion
17759 (defun org-install-agenda-files-menu ()
17760 (let ((bl (buffer-list)))
17761 (save-excursion
17762 (while bl
17763 (set-buffer (pop bl))
17764 (if (org-mode-p) (setq bl nil)))
17765 (when (org-mode-p)
17766 (easy-menu-change
17767 '("Org") "File List for Agenda"
17768 (append
17769 (list
17770 ["Edit File List" (org-edit-agenda-file-list) t]
17771 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17772 ["Remove Current File from List" org-remove-file t]
17773 ["Cycle through agenda files" org-cycle-agenda-files t]
17774 ["Occur in all agenda files" org-occur-in-agenda-files t]
17775 "--")
17776 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17778 ;;;; Documentation
17780 ;;;###autoload
17781 (defun org-require-autoloaded-modules ()
17782 (interactive)
17783 (mapc 'require
17784 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17785 org-docbook org-exp org-html org-icalendar
17786 org-id org-latex
17787 org-publish org-remember org-table
17788 org-timer org-xoxo)))
17790 ;;;###autoload
17791 (defun org-reload (&optional uncompiled)
17792 "Reload all org lisp files.
17793 With prefix arg UNCOMPILED, load the uncompiled versions."
17794 (interactive "P")
17795 (require 'find-func)
17797 (dir-org (file-name-directory (org-find-library-name "org")))
17798 (dir-org-contrib (ignore-errors
17799 (file-name-directory
17800 (org-find-library-name "org-contribdir"))))
17801 (babel-files
17802 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17803 (append (list nil "comint" "eval" "exp" "keys"
17804 "lob" "ref" "table" "tangle")
17805 (delq nil
17806 (mapcar
17807 (lambda (lang)
17808 (when (cdr lang) (symbol-name (car lang))))
17809 org-babel-load-languages)))))
17810 (files
17811 (append (directory-files dir-org t file-re)
17812 babel-files
17813 (and dir-org-contrib
17814 (directory-files dir-org-contrib t file-re))))
17815 (remove-re (concat (if (featurep 'xemacs)
17816 "org-colview" "org-colview-xemacs")
17818 (setq files (mapcar 'file-name-sans-extension files))
17819 (setq files (mapcar
17820 (lambda (x) (if (string-match remove-re x) nil x))
17821 files))
17822 (setq files (delq nil files))
17823 (mapc
17824 (lambda (f)
17825 (when (featurep (intern (file-name-nondirectory f)))
17826 (if (and (not uncompiled)
17827 (file-exists-p (concat f ".elc")))
17828 (load (concat f ".elc") nil nil t)
17829 (load (concat f ".el") nil nil t))))
17830 files))
17831 (org-version))
17833 ;;;###autoload
17834 (defun org-customize ()
17835 "Call the customize function with org as argument."
17836 (interactive)
17837 (org-load-modules-maybe)
17838 (org-require-autoloaded-modules)
17839 (customize-browse 'org))
17841 (defun org-create-customize-menu ()
17842 "Create a full customization menu for Org-mode, insert it into the menu."
17843 (interactive)
17844 (org-load-modules-maybe)
17845 (org-require-autoloaded-modules)
17846 (if (fboundp 'customize-menu-create)
17847 (progn
17848 (easy-menu-change
17849 '("Org") "Customize"
17850 `(["Browse Org group" org-customize t]
17851 "--"
17852 ,(customize-menu-create 'org)
17853 ["Set" Custom-set t]
17854 ["Save" Custom-save t]
17855 ["Reset to Current" Custom-reset-current t]
17856 ["Reset to Saved" Custom-reset-saved t]
17857 ["Reset to Standard Settings" Custom-reset-standard t]))
17859 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17861 ;;;; Miscellaneous stuff
17863 ;;; Generally useful functions
17865 (defun org-get-at-bol (property)
17866 "Get text property PROPERTY at beginning of line."
17867 (get-text-property (point-at-bol) property))
17869 (defun org-find-text-property-in-string (prop s)
17870 "Return the first non-nil value of property PROP in string S."
17871 (or (get-text-property 0 prop s)
17872 (get-text-property (or (next-single-property-change 0 prop s) 0)
17873 prop s)))
17875 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17876 "Display the given MESSAGE as a warning."
17877 (if (fboundp 'display-warning)
17878 (display-warning 'org message
17879 (if (featurep 'xemacs) 'warning :warning))
17880 (let ((buf (get-buffer-create "*Org warnings*")))
17881 (with-current-buffer buf
17882 (goto-char (point-max))
17883 (insert "Warning (Org): " message)
17884 (unless (bolp)
17885 (newline)))
17886 (display-buffer buf)
17887 (sit-for 0))))
17889 (defun org-in-commented-line ()
17890 "Is point in a line starting with `#'?"
17891 (equal (char-after (point-at-bol)) ?#))
17893 (defun org-in-indented-comment-line ()
17894 "Is point in a line starting with `#' after some white space?"
17895 (save-excursion
17896 (save-match-data
17897 (goto-char (point-at-bol))
17900 (defun org-in-verbatim-emphasis ()
17901 (save-match-data
17902 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17904 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17905 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17906 (if (and marker (marker-buffer marker)
17907 (buffer-live-p (marker-buffer marker)))
17908 (progn
17909 (switch-to-buffer (marker-buffer marker))
17910 (if (or (> marker (point-max)) (< marker (point-min)))
17911 (widen))
17912 (goto-char marker)
17913 (org-show-context 'org-goto))
17914 (if bookmark
17915 (bookmark-jump bookmark)
17916 (error "Cannot find location"))))
17918 (defun org-quote-csv-field (s)
17919 "Quote field for inclusion in CSV material."
17922 s))
17924 (defun org-plist-delete (plist property)
17925 "Delete PROPERTY from PLIST.
17926 This is in contrast to merely setting it to 0."
17927 (let (p)
17928 (while plist
17929 (if (not (eq property (car plist)))
17930 (setq p (plist-put p (car plist) (nth 1 plist))))
17931 (setq plist (cddr plist)))
17932 p))
17934 (defun org-force-self-insert (N)
17935 "Needed to enforce self-insert under remapping."
17936 (interactive "p")
17937 (self-insert-command N))
17939 (defun org-string-width (s)
17940 "Compute width of string, ignoring invisible characters.
17941 This ignores character with invisibility property `org-link', and also
17942 characters with property `org-cwidth', because these will become invisible
17943 upon the next fontification round."
17944 (let (b l)
17945 (when (or (eq t buffer-invisibility-spec)
17946 (assq 'org-link buffer-invisibility-spec))
17947 (while (setq b (text-property-any 0 (length s)
17948 'invisible 'org-link s))
17949 (setq s (concat (substring s 0 b)
17950 (substring s (or (next-single-property-change
17951 b 'invisible s) (length s)))))))
17952 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17953 (setq s (concat (substring s 0 b)
17954 (substring s (or (next-single-property-change
17955 b 'org-cwidth s) (length s))))))
17956 (setq l (string-width s) b -1)
17957 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
17958 (setq l (- l (get-text-property b 'org-dwidth-n s))))
17959 l))
17961 (defun org-get-indentation (&optional line)
17962 "Get the indentation of the current line, interpreting tabs.
17963 When LINE is given, assume it represents a line and compute its indentation."
17964 (if line
17965 (if (string-match "^ *" (org-remove-tabs line))
17966 (match-end 0))
17967 (save-excursion
17968 (beginning-of-line 1)
17970 (current-column))))
17972 (defun org-remove-tabs (s &optional width)
17973 "Replace tabulators in S with spaces.
17974 Assumes that s is a single line, starting in column 0."
17975 (setq width (or width tab-width))
17977 (setq s (replace-match
17978 (make-string
17979 (- (* width (/ (+ (match-beginning 0) width) width))
17980 (match-beginning 0)) ?\ )
17981 t t s)))
17982 s)
17984 (defun org-fix-indentation (line ind)
17985 "Fix indentation in LINE.
17986 IND is a cons cell with target and minimum indentation.
17987 If the current indentation in LINE is smaller than the minimum,
17988 leave it alone. If it is larger than ind, set it to the target."
17989 (let* ((l (org-remove-tabs line))
17990 (i (org-get-indentation l))
17991 (i1 (car ind)) (i2 (cdr ind)))
17992 (if (>= i i2) (setq l (substring line i2)))
17993 (if (> i1 0)
17994 (concat (make-string i1 ?\ ) l)
17995 l)))
17997 (defun org-remove-indentation (code &optional n)
17998 "Remove the maximum common indentation from the lines in CODE.
17999 N may optionally be the number of spaces to remove."
18000 (with-temp-buffer
18001 (insert code)
18002 (org-do-remove-indentation n)
18003 (buffer-string)))
18005 (defun org-do-remove-indentation (&optional n)
18006 "Remove the maximum common indentation from the buffer."
18007 (untabify (point-min) (point-max))
18008 (let ((min 10000) re)
18009 (if n
18010 (setq min n)
18011 (goto-char (point-min))
18013 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18014 (unless (or (= min 0) (= min 10000))
18016 (goto-char (point-min))
18017 (while (re-search-forward re nil t)
18018 (replace-match "")
18019 (end-of-line 1))
18020 min)))
18022 (defun org-fill-template (template alist)
18023 "Find each %key of ALIST in TEMPLATE and replace it."
18024 (let ((case-fold-search nil)
18025 entry key value)
18026 (setq alist (sort (copy-sequence alist)
18027 (lambda (a b) (< (length (car a)) (length (car b))))))
18028 (while (setq entry (pop alist))
18029 (setq template
18030 (replace-regexp-in-string
18031 (concat "%" (regexp-quote (car entry)))
18032 (cdr entry) template t t)))
18033 template))
18035 (defun org-base-buffer (buffer)
18036 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18037 (if (not buffer)
18038 buffer
18039 (or (buffer-base-buffer buffer)
18040 buffer)))
18042 (defun org-trim (s)
18043 "Remove whitespace at beginning and end of string."
18046 s)
18048 (defun org-wrap (string &optional width lines)
18049 "Wrap string to either a number of lines, or a width in characters.
18050 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18051 that costs. If there is a word longer than WIDTH, the text is actually
18052 wrapped to the length of that word.
18053 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18054 many lines, whatever width that takes.
18055 The return value is a list of lines, without newlines at the end."
18057 (maxword (apply 'max (mapcar 'org-string-width words)))
18058 w ll)
18059 (cond (width
18060 (org-do-wrap words (max maxword width)))
18061 (lines
18062 (setq w maxword)
18063 (setq ll (org-do-wrap words maxword))
18064 (if (<= (length ll) lines)
18065 ll
18066 (setq ll words)
18067 (while (> (length ll) lines)
18068 (setq w (1+ w))
18069 (setq ll (org-do-wrap words w)))
18070 ll))
18071 (t (error "Cannot wrap this")))))
18073 (defun org-do-wrap (words width)
18074 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18075 (let (lines line)
18076 (while words
18077 (setq line (pop words))
18078 (while (and words (< (+ (length line) (length (car words))) width))
18079 (setq line (concat line " " (pop words))))
18080 (setq lines (push line lines)))
18081 (nreverse lines)))
18083 (defun org-split-string (string &optional separators)
18084 "Splits STRING into substrings at SEPARATORS.
18085 No empty strings are returned if there are matches at the beginning
18086 and end of string."
18088 (start 0)
18089 notfirst
18090 (list nil))
18091 (while (and (string-match rexp string
18092 (if (and notfirst
18093 (= start (match-beginning 0))
18094 (< start (length string)))
18095 (1+ start) start))
18096 (< (match-beginning 0) (length string)))
18097 (setq notfirst t)
18098 (or (eq (match-beginning 0) 0)
18099 (and (eq (match-beginning 0) (match-end 0))
18100 (eq (match-beginning 0) start))
18101 (setq list
18102 (cons (substring string start (match-beginning 0))
18103 list)))
18104 (setq start (match-end 0)))
18105 (or (eq start (length string))
18106 (setq list
18107 (cons (substring string start)
18108 list)))
18109 (nreverse list)))
18111 (defun org-quote-vert (s)
18113 (while (string-match "|" s)
18115 s)
18117 (defun org-uuidgen-p (s)
18118 "Is S an ID created by UUIDGEN?"
18119 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18121 (defun org-context ()
18122 "Return a list of contexts of the current cursor position.
18123 If several contexts apply, all are returned.
18124 Each context entry is a list with a symbol naming the context, and
18125 two positions indicating start and end of the context. Possible
18126 contexts are:
18128 :headline anywhere in a headline
18129 :headline-stars on the leading stars in a headline
18130 :todo-keyword on a TODO keyword (including DONE) in a headline
18131 :tags on the TAGS in a headline
18132 :priority on the priority cookie in a headline
18133 :item on the first line of a plain list item
18134 :item-bullet on the bullet/number of a plain list item
18135 :checkbox on the checkbox in a plain list item
18136 :table in an org-mode table
18137 :table-special on a special filed in a table
18138 :table-table in a table.el table
18139 :link on a hyperlink
18140 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18141 :target on a <<target>>
18142 :radio-target on a <<<radio-target>>>
18143 :latex-fragment on a LaTeX fragment
18144 :latex-preview on a LaTeX fragment with overlayed preview image
18146 This function expects the position to be visible because it uses font-lock
18147 faces as a help to recognize the following contexts: :table-special, :link,
18148 and :keyword."
18149 (let* ((f (get-text-property (point) 'face))
18150 (faces (if (listp f) f (list f)))
18151 (p (point)) clist o)
18152 ;; First the large context
18153 (cond
18154 ((org-on-heading-p t)
18155 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18156 (when (progn
18157 (beginning-of-line 1)
18158 (looking-at org-todo-line-tags-regexp))
18159 (push (org-point-in-group p 1 :headline-stars) clist)
18160 (push (org-point-in-group p 2 :todo-keyword) clist)
18161 (push (org-point-in-group p 4 :tags) clist))
18162 (goto-char p)
18165 (push (org-point-in-group p 0 :priority) clist)))
18167 ((org-at-item-p)
18168 (push (org-point-in-group p 2 :item-bullet) clist)
18169 (push (list :item (point-at-bol)
18170 (save-excursion (org-end-of-item) (point)))
18171 clist)
18172 (and (org-at-item-checkbox-p)
18173 (push (org-point-in-group p 0 :checkbox) clist)))
18175 ((org-at-table-p)
18176 (push (list :table (org-table-begin) (org-table-end)) clist)
18177 (if (memq 'org-formula faces)
18178 (push (list :table-special
18179 (previous-single-property-change p 'face)
18180 (next-single-property-change p 'face)) clist)))
18181 ((org-at-table-p 'any)
18182 (push (list :table-table) clist)))
18183 (goto-char p)
18185 ;; Now the small context
18186 (cond
18187 ((org-at-timestamp-p)
18188 (push (org-point-in-group p 0 :timestamp) clist))
18189 ((memq 'org-link faces)
18190 (push (list :link
18191 (previous-single-property-change p 'face)
18192 (next-single-property-change p 'face)) clist))
18193 ((memq 'org-special-keyword faces)
18194 (push (list :keyword
18195 (previous-single-property-change p 'face)
18196 (next-single-property-change p 'face)) clist))
18197 ((org-on-target-p)
18198 (push (org-point-in-group p 0 :target) clist)
18199 (goto-char (1- (match-beginning 0)))
18200 (if (looking-at org-radio-target-regexp)
18201 (push (org-point-in-group p 0 :radio-target) clist))
18202 (goto-char p))
18203 ((setq o (car (delq nil
18204 (mapcar
18205 (lambda (x)
18206 (if (memq x org-latex-fragment-image-overlays) x))
18207 (overlays-at (point))))))
18208 (push (list :latex-fragment
18209 (overlay-start o) (overlay-end o)) clist)
18210 (push (list :latex-preview
18211 (overlay-start o) (overlay-end o)) clist))
18212 ((org-inside-LaTeX-fragment-p)
18213 ;; FIXME: positions wrong.
18214 (push (list :latex-fragment (point) (point)) clist)))
18216 (setq clist (nreverse (delq nil clist)))
18217 clist))
18219 ;; FIXME: Compare with at-regexp-p Do we need both?
18220 (defun org-in-regexp (re &optional nlines visually)
18221 "Check if point is inside a match of regexp.
18222 Normally only the current line is checked, but you can include NLINES extra
18223 lines both before and after point into the search.
18224 If VISUALLY is set, require that the cursor is not after the match but
18225 really on, so that the block visually is on the match."
18226 (catch 'exit
18227 (let ((pos (point))
18228 (eol (point-at-eol (+ 1 (or nlines 0))))
18229 (inc (if visually 1 0)))
18230 (save-excursion
18231 (beginning-of-line (- 1 (or nlines 0)))
18232 (while (re-search-forward re eol t)
18233 (if (and (<= (match-beginning 0) pos)
18234 (>= (+ inc (match-end 0)) pos))
18235 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18237 (defun org-at-regexp-p (regexp)
18238 "Is point inside a match of REGEXP in the current line?"
18239 (catch 'exit
18240 (save-excursion
18241 (let ((pos (point)) (end (point-at-eol)))
18242 (beginning-of-line 1)
18243 (while (re-search-forward regexp end t)
18244 (if (and (<= (match-beginning 0) pos)
18245 (>= (match-end 0) pos))
18246 (throw 'exit t)))
18247 nil))))
18249 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18250 "Return t if the current point is between matches of START-RE and END-RE.
18251 This will also return t if point is on one of the two matches or
18252 in an unfinished block. END-RE can be a string or a form
18253 returning a string.
18255 An optional third argument bounds the search for START-RE. It
18256 defaults to previous heading or `point-min'."
18257 (let ((pos (point))
18258 (limit (or bound (save-excursion (outline-previous-heading)))))
18259 (save-excursion
18260 ;; we're on a block when point is on start-re...
18261 (or (org-at-regexp-p start-re)
18262 ;; ... or start-re can be found above...
18263 (and (re-search-backward start-re limit t)
18264 ;; ... but no end-re between start-re and point.
18265 (not (re-search-forward (eval end-re) pos t)))))))
18267 (defun org-occur-in-agenda-files (regexp &optional nlines)
18268 "Call `multi-occur' with buffers for all agenda files."
18270 (let* ((files (org-agenda-files))
18271 (tnames (mapcar 'file-truename files))
18272 (extra org-agenda-text-search-extra-files)
18273 f)
18274 (when (eq (car extra) 'agenda-archives)
18275 (setq extra (cdr extra))
18276 (setq files (org-add-archive-files files)))
18277 (while (setq f (pop extra))
18278 (unless (member (file-truename f) tnames)
18279 (add-to-list 'files f 'append)
18280 (add-to-list 'tnames (file-truename f) 'append)))
18281 (multi-occur
18282 (mapcar (lambda (x)
18283 (with-current-buffer
18284 (or (get-file-buffer x) (find-file-noselect x))
18285 (widen)
18286 (current-buffer)))
18287 files)
18288 regexp)))
18290 (if (boundp 'occur-mode-find-occurrence-hook)
18291 ;; Emacs 23
18292 (add-hook 'occur-mode-find-occurrence-hook
18293 (lambda ()
18294 (when (org-mode-p)
18295 (org-reveal))))
18296 ;; Emacs 22
18297 (defadvice occur-mode-goto-occurrence
18298 (after org-occur-reveal activate)
18299 (and (org-mode-p) (org-reveal)))
18300 (defadvice occur-mode-goto-occurrence-other-window
18301 (after org-occur-reveal activate)
18302 (and (org-mode-p) (org-reveal)))
18303 (defadvice occur-mode-display-occurrence
18304 (after org-occur-reveal activate)
18305 (when (org-mode-p)
18306 (let ((pos (occur-mode-find-occurrence)))
18307 (with-current-buffer (marker-buffer pos)
18308 (save-excursion
18309 (goto-char pos)
18310 (org-reveal)))))))
18312 (defun org-occur-link-in-agenda-files ()
18313 "Create a link and search for it in the agendas.
18314 The link is not stored in `org-stored-links', it is just created
18315 for the search purpose."
18316 (interactive)
18317 (let ((link (condition-case nil
18318 (org-store-link nil)
18319 (error "Unable to create a link to here"))))
18320 (org-occur-in-agenda-files (regexp-quote link))))
18322 (defun org-uniquify (list)
18323 "Remove duplicate elements from LIST."
18324 (let (res)
18325 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18326 res))
18328 (defun org-delete-all (elts list)
18329 "Remove all elements in ELTS from LIST."
18330 (while elts
18331 (setq list (delete (pop elts) list)))
18332 list)
18334 (defun org-count (cl-item cl-seq)
18335 "Count the number of occurrences of ITEM in SEQ.
18336 Taken from `count' in cl-seq.el with all keyword arguments removed."
18337 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18338 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18339 (while (< cl-start cl-end)
18340 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18341 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18342 (setq cl-start (1+ cl-start)))
18343 cl-count))
18345 (defun org-remove-if (predicate seq)
18346 "Remove everything from SEQ that fulfills PREDICATE."
18347 (let (res e)
18348 (while seq
18349 (setq e (pop seq))
18350 (if (not (funcall predicate e)) (push e res)))
18351 (nreverse res)))
18353 (defun org-remove-if-not (predicate seq)
18354 "Remove everything from SEQ that does not fulfill PREDICATE."
18355 (let (res e)
18356 (while seq
18357 (setq e (pop seq))
18358 (if (funcall predicate e) (push e res)))
18359 (nreverse res)))
18361 (defun org-back-over-empty-lines ()
18362 "Move backwards over whitespace, to the beginning of the first empty line.
18363 Returns the number of empty lines passed."
18364 (let ((pos (point)))
18366 (beginning-of-line 2)
18367 (goto-char (min (point) pos))
18368 (count-lines (point) pos)))
18370 (defun org-skip-whitespace ()
18373 (defun org-point-in-group (point group &optional context)
18374 "Check if POINT is in match-group GROUP.
18375 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18376 match. If the match group does not exist or point is not inside it,
18377 return nil."
18378 (and (match-beginning group)
18379 (>= point (match-beginning group))
18380 (<= point (match-end group))
18381 (if context
18382 (list context (match-beginning group) (match-end group))
18383 t)))
18385 (defun org-switch-to-buffer-other-window (&rest args)
18386 "Switch to buffer in a second window on the current frame.
18387 In particular, do not allow pop-up frames.
18388 Returns the newly created buffer."
18389 (let (pop-up-frames special-display-buffer-names special-display-regexps
18390 special-display-function)
18391 (apply 'switch-to-buffer-other-window args)))
18393 (defun org-combine-plists (&rest plists)
18394 "Create a single property list from all plists in PLISTS.
18395 The process starts by copying the first list, and then setting properties
18396 from the other lists. Settings in the last list are the most significant
18397 ones and overrule settings in the other lists."
18398 (let ((rtn (copy-sequence (pop plists)))
18399 p v ls)
18400 (while plists
18401 (setq ls (pop plists))
18402 (while ls
18403 (setq p (pop ls) v (pop ls))
18404 (setq rtn (plist-put rtn p v))))
18405 rtn))
18407 (defun org-move-line-down (arg)
18408 "Move the current line down. With prefix argument, move it past ARG lines."
18409 (interactive "p")
18410 (let ((col (current-column))
18411 beg end pos)
18412 (beginning-of-line 1) (setq beg (point))
18413 (beginning-of-line 2) (setq end (point))
18414 (beginning-of-line (+ 1 arg))
18415 (setq pos (move-marker (make-marker) (point)))
18416 (insert (delete-and-extract-region beg end))
18417 (goto-char pos)
18418 (org-move-to-column col)))
18420 (defun org-move-line-up (arg)
18421 "Move the current line up. With prefix argument, move it past ARG lines."
18422 (interactive "p")
18423 (let ((col (current-column))
18424 beg end pos)
18425 (beginning-of-line 1) (setq beg (point))
18426 (beginning-of-line 2) (setq end (point))
18427 (beginning-of-line (- arg))
18428 (setq pos (move-marker (make-marker) (point)))
18429 (insert (delete-and-extract-region beg end))
18430 (goto-char pos)
18431 (org-move-to-column col)))
18433 (defun org-replace-escapes (string table)
18434 "Replace %-escapes in STRING with values in TABLE.
18436 The sequences in STRING may contain normal field width and padding information,
18438 so values can contain further %-escapes if they are define later in TABLE."
18439 (let ((tbl (copy-alist table))
18440 (case-fold-search nil)
18441 (pchg 0)
18442 e re rpl)
18443 (while (setq e (pop tbl))
18444 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18445 (when (and (cdr e) (string-match re (cdr e)))
18446 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18447 (safe "SREF"))
18448 (add-text-properties 0 3 (list 'sref sref) safe)
18449 (setcdr e (replace-match safe t t (cdr e)))))
18450 (while (string-match re string)
18451 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18452 (cdr e)))
18453 (setq string (replace-match rpl t t string))))
18454 (while (setq pchg (next-property-change pchg string))
18455 (let ((sref (get-text-property pchg 'sref string)))
18456 (when (and sref (string-match "SREF" string pchg))
18457 (setq string (replace-match sref t t string)))))
18458 string))
18460 (defun org-sublist (list start end)
18461 "Return a section of LIST, from START to END.
18462 Counting starts at 1."
18463 (let (rtn (c start))
18464 (setq list (nthcdr (1- start) list))
18465 (while (and list (<= c end))
18466 (push (pop list) rtn)
18467 (setq c (1+ c)))
18468 (nreverse rtn)))
18470 (defun org-find-base-buffer-visiting (file)
18471 "Like `find-buffer-visiting' but always return the base buffer and
18472 not an indirect buffer."
18473 (let ((buf (or (get-file-buffer file)
18474 (find-buffer-visiting file))))
18475 (if buf
18476 (or (buffer-base-buffer buf) buf)
18477 nil)))
18479 (defun org-image-file-name-regexp (&optional extensions)
18480 "Return regexp matching the file names of images.
18481 If EXTENSIONS is given, only match these."
18482 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18483 (image-file-name-regexp)
18484 (let ((image-file-name-extensions
18485 (or extensions
18486 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18487 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18489 (regexp-opt (nconc (mapcar 'upcase
18490 image-file-name-extensions)
18491 image-file-name-extensions)
18492 t)
18495 (defun org-file-image-p (file &optional extensions)
18496 "Return non-nil if FILE is an image."
18497 (save-match-data
18498 (string-match (org-image-file-name-regexp extensions) file)))
18500 (defun org-get-cursor-date ()
18501 "Return the date at cursor in as a time.
18502 This works in the calendar and in the agenda, anywhere else it just
18503 returns the current time."
18504 (let (date day defd)
18505 (cond
18506 ((eq major-mode 'calendar-mode)
18507 (setq date (calendar-cursor-to-date)
18508 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18509 ((eq major-mode 'org-agenda-mode)
18510 (setq day (get-text-property (point) 'day))
18511 (if day
18512 (setq date (calendar-gregorian-from-absolute day)
18513 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18514 (nth 2 date))))))
18515 (or defd (current-time))))
18517 (defvar org-agenda-action-marker (make-marker)
18518 "Marker pointing to the entry for the next agenda action.")
18520 (defun org-mark-entry-for-agenda-action ()
18521 "Mark the current entry as target of an agenda action.
18522 Agenda actions are actions executed from the agenda with the key `k',
18523 which make use of the date at the cursor."
18524 (interactive)
18525 (move-marker org-agenda-action-marker
18526 (save-excursion (org-back-to-heading t) (point))
18527 (current-buffer))
18528 (message
18529 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18531 ;;; Paragraph filling stuff.
18532 ;; We want this to be just right, so use the full arsenal.
18534 (defun org-indent-line-function ()
18535 "Indent line like previous, but further if previous was headline or item."
18536 (interactive)
18537 (let* ((pos (point))
18538 (itemp (org-at-item-p))
18539 (case-fold-search t)
18541 column bpos bcol tpos tcol bullet btype bullet-type)
18542 ;; Find the previous relevant line
18543 (beginning-of-line 1)
18544 (cond
18545 ;; Comments
18546 ((looking-at "#") (setq column 0))
18547 ;; Headings
18549 ;; Drawers
18551 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18552 (save-excursion
18553 (goto-char (1- (match-beginning 1)))
18554 (setq column (current-column))))
18555 ;; Special blocks
18557 (save-excursion
18558 (re-search-backward
18560 (setq column (org-get-indentation (match-string 0))))
18563 (save-excursion
18565 (setq column
18566 (if (equal (downcase (match-string 1)) "src")
18567 ;; src blocks: let `org-edit-src-exit' handle them
18568 (org-get-indentation)
18569 (org-get-indentation (match-string 0)))))
18570 ;; Lists
18571 ((org-in-item-p)
18572 (org-beginning-of-item)
18573 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18574 (setq bpos (match-beginning 1) tpos (match-end 0)
18575 bcol (progn (goto-char bpos) (current-column))
18576 tcol (progn (goto-char tpos) (current-column))
18577 bullet (match-string 1)
18578 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
18579 (if (> tcol (+ bcol org-description-max-indent))
18580 (setq tcol (+ bcol 5)))
18581 (if (not itemp)
18582 (setq column tcol)
18583 (beginning-of-line 1)
18584 (goto-char pos)
18586 (progn
18588 (setq bullet (match-string 1)
18589 btype (if (string-match "[0-9]" bullet) "n" bullet))
18590 (setq column (if (equal btype bullet-type) bcol tcol)))
18591 (setq column (org-get-indentation)))))
18592 ;; This line has nothing special, look upside to get a clue about
18593 ;; what to do.
18594 (t
18595 (beginning-of-line 0)
18598 (not (looking-at org-drawer-regexp)))
18599 (beginning-of-line 0))
18600 (cond
18601 ;; There was an heading above.
18603 (if (not org-adapt-indentation)
18604 (setq column 0)
18605 (goto-char (match-end 0))
18606 (setq column (current-column))))
18607 ;; A drawer had started and is unfinished: indent consequently.
18608 ((looking-at org-drawer-regexp)
18609 (goto-char (1- (match-beginning 1)))
18610 (setq column (current-column)))
18611 ;; The drawer had ended: indent like its :END: line.
18613 (goto-char (match-end 1))
18614 (setq column (current-column)))
18615 ;; There was a list that since ended: indent relatively to
18616 ;; current heading.
18617 ((org-in-item-p)
18618 (outline-previous-heading)
18619 (if (and org-adapt-indentation
18621 (progn
18622 (goto-char (match-end 0))
18623 (setq column (current-column)))
18624 (setq column 0)))
18625 ;; Else, nothing noticeable found: get indentation and go on.
18626 (t (setq column (org-get-indentation))))))
18627 (goto-char pos)
18628 (if (<= (current-column) (current-indentation))
18629 (org-indent-line-to column)
18630 (save-excursion (org-indent-line-to column)))
18631 (setq column (current-column))
18632 (beginning-of-line 1)
18633 (if (looking-at
18635 (replace-match (concat (match-string 1)
18636 (format org-property-format
18637 (match-string 2) (match-string 3)))
18638 t t))
18639 (org-move-to-column column)))
18641 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18642 "Variable to store copy of `adaptive-fill-regexp'.
18643 Since `adaptive-fill-regexp' is set to never match, we need to
18644 store a backup of its value before entering `org-mode' so that
18645 the functionality can be provided as a fall-back.")
18647 (defun org-set-autofill-regexps ()
18648 (interactive)
18649 ;; In the paragraph separator we include headlines, because filling
18650 ;; text in a line directly attached to a headline would otherwise
18651 ;; fill the headline as well.
18654 ;; The paragraph starter includes hand-formatted lists.
18655 (org-set-local
18656 'paragraph-start
18657 (concat
18666 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18667 ;; But only if the user has not turned off tables or fixed-width regions
18668 (org-set-local
18669 'auto-fill-inhibit-regexp
18672 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18673 (concat
18675 (if org-enable-table-editor "|" "")
18676 (if org-enable-fixed-width-editor ":" "")
18677 "]"))))
18678 ;; We use our own fill-paragraph function, to make sure that tables
18679 ;; and fixed-width regions are not wrapped. That function will pass
18680 ;; through to `fill-paragraph' when appropriate.
18681 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18682 ;; Adaptive filling: To get full control, first make sure that
18683 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18684 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18685 (org-set-local 'org-adaptive-fill-regexp-backup
18686 adaptive-fill-regexp))
18688 (org-set-local 'adaptive-fill-function
18689 'org-adaptive-fill-function)
18690 (org-set-local
18691 'align-mode-rules-list
18692 '((org-in-buffer-settings
18694 (modes . '(org-mode))))))
18696 (defun org-fill-paragraph (&optional justify)
18697 "Re-align a table, pass through to fill-paragraph if no table."
18698 (let ((table-p (org-at-table-p))
18699 (table.el-p (org-at-table.el-p)))
18700 (cond ((and (equal (char-after (point-at-bol)) ?*)
18701 (save-excursion (goto-char (point-at-bol))
18702 (looking-at outline-regexp)))
18703 t) ; skip headlines
18704 (table.el-p t) ; skip table.el tables
18705 (table-p (org-table-align) t) ; align org-mode tables
18706 (t nil)))) ; call paragraph-fill
18708 ;; For reference, this is the default value of adaptive-fill-regexp
18711 (defun org-adaptive-fill-function ()
18712 "Return a fill prefix for org-mode files.
18713 In particular, this makes sure hanging paragraphs for hand-formatted lists
18714 work correctly."
18715 (cond
18716 ;; Comment line
18718 (match-string-no-properties 0))
18719 ;; Description list
18721 (save-excursion
18722 (if (> (match-end 1) (+ (match-beginning 1)
18723 org-description-max-indent))
18724 (goto-char (+ (match-beginning 1) 5))
18725 (goto-char (match-end 0)))
18726 (make-string (current-column) ?\ )))
18727 ;; Ordered or unordered list
18729 (save-excursion
18730 (goto-char (match-end 0))
18731 (make-string (current-column) ?\ )))
18732 ;; Other text
18733 ((looking-at org-adaptive-fill-regexp-backup)
18734 (match-string-no-properties 0))))
18736 ;;; Other stuff.
18738 (defun org-toggle-fixed-width-section (arg)
18739 "Toggle the fixed-width export.
18740 If there is no active region, the QUOTE keyword at the current headline is
18741 inserted or removed. When present, it causes the text between this headline
18742 and the next to be exported as fixed-width text, and unmodified.
18743 If there is an active region, this command adds or removes a colon as the
18744 first character of this line. If the first character of a line is a colon,
18745 this line is also exported in fixed-width font."
18746 (interactive "P")
18747 (let* ((cc 0)
18748 (regionp (org-region-active-p))
18749 (beg (if regionp (region-beginning) (point)))
18750 (end (if regionp (region-end)))
18751 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18752 (case-fold-search nil)
18754 off)
18755 (if regionp
18756 (save-excursion
18757 (goto-char beg)
18758 (setq cc (current-column))
18759 (beginning-of-line 1)
18760 (setq off (looking-at re))
18761 (while (> nlines 0)
18762 (setq nlines (1- nlines))
18763 (beginning-of-line 1)
18764 (cond
18765 (arg
18766 (org-move-to-column cc t)
18768 (forward-line -1))
18769 ((and off (looking-at re))
18770 (replace-match "" t t nil 1))
18771 ((not off) (org-move-to-column cc t) (insert ": ")))
18772 (forward-line 1)))
18773 (save-excursion
18774 (org-back-to-heading)
18775 (if (looking-at (concat outline-regexp
18777 (replace-match "" t t nil 1)
18778 (if (looking-at outline-regexp)
18779 (progn
18780 (goto-char (match-end 0))
18781 (insert org-quote-string " "))))))))
18783 (defun org-reftex-citation ()
18784 "Use reftex-citation to insert a citation into the buffer.
18785 This looks for a line like
18787 #+BIBLIOGRAPHY: foo plain option:-d
18789 and derives from it that foo.bib is the bibliography file relevant
18790 for this document. It then installs the necessary environment for RefTeX
18791 to work in this buffer and calls `reftex-citation' to insert a citation
18792 into the buffer.
18794 Export of such citations to both LaTeX and HTML is handled by the contributed
18795 package org-exp-bibtex by Taru Karttunen."
18796 (interactive)
18797 (let ((reftex-docstruct-symbol 'rds)
18799 rds bib)
18800 (save-excursion
18801 (save-restriction
18802 (widen)
18803 (let ((case-fold-search t)
18805 (if (not (save-excursion
18806 (or (re-search-forward re nil t)
18807 (re-search-backward re nil t))))
18808 (error "No bibliography defined in file")
18809 (setq bib (concat (match-string 1) ".bib")
18810 rds (list (list 'bib bib)))))))
18811 (call-interactively 'reftex-citation)))
18813 ;;;; Functions extending outline functionality
18815 (defun org-beginning-of-line (&optional arg)
18816 "Go to the beginning of the current line. If that is invisible, continue
18817 to a visible line beginning. This makes the function of C-a more intuitive.
18818 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18819 first attempt, and only move to after the tags when the cursor is already
18820 beyond the end of the headline."
18821 (interactive "P")
18822 (let ((pos (point))
18823 (special (if (consp org-special-ctrl-a/e)
18824 (car org-special-ctrl-a/e)
18825 org-special-ctrl-a/e))
18826 refpos)
18827 (if (org-bound-and-true-p line-move-visual)
18828 (beginning-of-visual-line 1)
18829 (beginning-of-line 1))
18830 (if (and arg (fboundp 'move-beginning-of-line))
18831 (call-interactively 'move-beginning-of-line)
18832 (if (bobp)
18833 nil
18834 (backward-char 1)
18835 (if (org-truely-invisible-p)
18836 (while (and (not (bobp)) (org-truely-invisible-p))
18837 (backward-char 1)
18838 (beginning-of-line 1))
18839 (forward-char 1))))
18840 (when special
18841 (cond
18842 ((and (looking-at org-complex-heading-regexp)
18843 (= (char-after (match-end 1)) ?\ ))
18844 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18845 (point-at-eol)))
18846 (goto-char
18847 (if (eq special t)
18848 (cond ((> pos refpos) refpos)
18849 ((= pos (point)) refpos)
18850 (t (point)))
18851 (cond ((> pos (point)) (point))
18852 ((not (eq last-command this-command)) (point))
18853 (t refpos)))))
18854 ((org-at-item-p)
18855 (goto-char
18856 (if (eq special t)
18857 (cond ((> pos (match-end 4)) (match-end 4))
18858 ((= pos (point)) (match-end 4))
18859 (t (point)))
18860 (cond ((> pos (point)) (point))
18861 ((not (eq last-command this-command)) (point))
18862 (t (match-end 4))))))))
18863 (org-no-warnings
18864 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18866 (defun org-end-of-line (&optional arg)
18867 "Go to the end of the line.
18868 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18869 first attempt, and only move to after the tags when the cursor is already
18870 beyond the end of the headline."
18871 (interactive "P")
18872 (let ((special (if (consp org-special-ctrl-a/e)
18873 (cdr org-special-ctrl-a/e)
18874 org-special-ctrl-a/e)))
18875 (if (or (not special)
18876 (not (org-on-heading-p))
18877 arg)
18878 (call-interactively
18879 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18880 ((fboundp 'move-end-of-line) 'move-end-of-line)
18881 (t 'end-of-line)))
18882 (let ((pos (point)))
18883 (beginning-of-line 1)
18885 (if (eq special t)
18886 (if (or (< pos (match-beginning 1))
18887 (= pos (match-end 0)))
18888 (goto-char (match-beginning 1))
18889 (goto-char (match-end 0)))
18890 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18891 (goto-char (match-end 0))
18892 (goto-char (match-beginning 1))))
18893 (call-interactively (if (fboundp 'move-end-of-line)
18894 'move-end-of-line
18895 'end-of-line)))))
18896 (org-no-warnings
18897 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18899 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18900 (define-key org-mode-map "\C-e" 'org-end-of-line)
18901 (define-key org-mode-map [home] 'org-beginning-of-line)
18902 (define-key org-mode-map [end] 'org-end-of-line)
18904 (defun org-backward-sentence (&optional arg)
18905 "Go to beginning of sentence, or beginning of table field.
18906 This will call `backward-sentence' or `org-table-beginning-of-field',
18907 depending on context."
18908 (interactive "P")
18909 (cond
18910 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18911 (t (call-interactively 'backward-sentence))))
18913 (defun org-forward-sentence (&optional arg)
18914 "Go to end of sentence, or end of table field.
18915 This will call `forward-sentence' or `org-table-end-of-field',
18916 depending on context."
18917 (interactive "P")
18918 (cond
18919 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18920 (t (call-interactively 'forward-sentence))))
18922 (define-key org-mode-map "\M-a" 'org-backward-sentence)
18923 (define-key org-mode-map "\M-e" 'org-forward-sentence)
18925 (defun org-kill-line (&optional arg)
18926 "Kill line, to tags or end of line."
18927 (interactive "P")
18928 (cond
18929 ((or (not org-special-ctrl-k)
18930 (bolp)
18931 (not (org-on-heading-p)))
18932 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
18933 org-ctrl-k-protect-subtree)
18934 (if (or (eq org-ctrl-k-protect-subtree 'error)
18935 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
18936 (error "C-k aborted - would kill hidden subtree")))
18937 (call-interactively 'kill-line))
18939 (kill-region (point) (match-beginning 1))
18940 (org-set-tags nil t))
18941 (t (kill-region (point) (point-at-eol)))))
18943 (define-key org-mode-map "\C-k" 'org-kill-line)
18945 (defun org-yank (&optional arg)
18946 "Yank. If the kill is a subtree, treat it specially.
18947 This command will look at the current kill and check if is a single
18948 subtree, or a series of subtrees[1]. If it passes the test, and if the
18949 cursor is at the beginning of a line or after the stars of a currently
18950 empty headline, then the yank is handled specially. How exactly depends
18951 on the value of the following variables, both set by default.
18953 org-yank-folded-subtrees
18954 When set, the subtree(s) will be folded after insertion, but only
18955 if doing so would now swallow text after the yanked text.
18957 org-yank-adjusted-subtrees
18958 When set, the subtree will be promoted or demoted in order to
18959 fit into the local outline tree structure, which means that the level
18960 will be adjusted so that it becomes the smaller one of the two
18961 *visible* surrounding headings.
18963 Any prefix to this command will cause `yank' to be called directly with
18965 will just
18966 plainly yank the text as it is.
18968 \[1] The test checks if the first non-white line is a heading
18969 and if there are no other headings with fewer stars."
18970 (interactive "P")
18971 (org-yank-generic 'yank arg))
18973 (defun org-yank-generic (command arg)
18974 "Perform some yank-like command.
18976 This function implements the behavior described in the `org-yank'
18977 documentation. However, it has been generalized to work for any
18978 interactive command with similar behavior."
18980 ;; pretend to be command COMMAND
18981 (setq this-command command)
18983 (if arg
18984 (call-interactively command)
18986 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
18987 (and (org-kill-is-subtree-p)
18988 (or (bolp)
18990 (string-match
18992 (buffer-substring (point-at-bol) (point)))))))
18993 swallowp)
18994 (cond
18995 ((and subtreep org-yank-folded-subtrees)
18996 (let ((beg (point))
18997 end)
18998 (if (and subtreep org-yank-adjusted-subtrees)
18999 (org-paste-subtree nil nil 'for-yank)
19000 (call-interactively command))
19002 (setq end (point))
19003 (goto-char beg)
19004 (when (and (bolp) subtreep
19005 (not (setq swallowp
19006 (org-yank-folding-would-swallow-text beg end))))
19007 (or (looking-at outline-regexp)
19008 (re-search-forward (concat "^" outline-regexp) end t))
19009 (while (and (< (point) end) (looking-at outline-regexp))
19010 (hide-subtree)
19011 (org-cycle-show-empty-lines 'folded)
19012 (condition-case nil
19013 (outline-forward-same-level 1)
19014 (error (goto-char end)))))
19015 (when swallowp
19016 (message
19017 "Inserted text not folded because that would swallow text"))
19019 (goto-char end)
19021 (beginning-of-line 1)
19022 (push-mark beg 'nomsg)))
19023 ((and subtreep org-yank-adjusted-subtrees)
19024 (let ((beg (point-at-bol)))
19025 (org-paste-subtree nil nil 'for-yank)
19026 (push-mark beg 'nomsg)))
19027 (t
19028 (call-interactively command))))))
19030 (defun org-yank-folding-would-swallow-text (beg end)
19031 "Would hide-subtree at BEG swallow any text after END?"
19032 (let (level)
19033 (save-excursion
19034 (goto-char beg)
19035 (when (or (looking-at outline-regexp)
19036 (re-search-forward (concat "^" outline-regexp) end t))
19037 (setq level (org-outline-level)))
19038 (goto-char end)
19040 (if (or (eobp)
19041 (and (bolp) (looking-at org-outline-regexp)
19042 (<= (org-outline-level) level)))
19043 nil ; Nothing would be swallowed
19044 t)))) ; something would swallow
19046 (define-key org-mode-map "\C-y" 'org-yank)
19048 (defun org-invisible-p ()
19049 "Check if point is at a character currently not visible."
19050 ;; Early versions of noutline don't have `outline-invisible-p'.
19051 (if (fboundp 'outline-invisible-p)
19052 (outline-invisible-p)
19053 (get-char-property (point) 'invisible)))
19055 (defun org-truely-invisible-p ()
19056 "Check if point is at a character currently not visible.
19057 This version does not only check the character property, but also
19058 `visible-mode'."
19059 ;; Early versions of noutline don't have `outline-invisible-p'.
19060 (if (org-bound-and-true-p visible-mode)
19061 nil
19062 (if (fboundp 'outline-invisible-p)
19063 (outline-invisible-p)
19064 (get-char-property (point) 'invisible))))
19066 (defun org-invisible-p2 ()
19067 "Check if point is at a character currently not visible."
19068 (save-excursion
19069 (if (and (eolp) (not (bobp))) (backward-char 1))
19070 ;; Early versions of noutline don't have `outline-invisible-p'.
19071 (if (fboundp 'outline-invisible-p)
19072 (outline-invisible-p)
19073 (get-char-property (point) 'invisible))))
19075 (defun org-back-to-heading (&optional invisible-ok)
19076 "Call `outline-back-to-heading', but provide a better error message."
19077 (condition-case nil
19078 (outline-back-to-heading invisible-ok)
19079 (error (error "Before first headline at position %d in buffer %s"
19080 (point) (current-buffer)))))
19082 (defun org-beginning-of-defun ()
19083 "Go to the beginning of the subtree, i.e. back to the heading."
19084 (org-back-to-heading))
19085 (defun org-end-of-defun ()
19086 "Go to the end of the subtree."
19087 (org-end-of-subtree nil t))
19089 (defun org-before-first-heading-p ()
19090 "Before first heading?"
19091 (save-excursion
19094 (defun org-on-heading-p (&optional ignored)
19095 (outline-on-heading-p t))
19096 (defun org-at-heading-p (&optional ignored)
19097 (outline-on-heading-p t))
19099 (defun org-point-at-end-of-empty-headline ()
19100 "If point is at the end of an empty headline, return t, else nil.
19101 If the heading only contains a TODO keyword, it is still still considered
19102 empty."
19104 (save-excursion
19105 (beginning-of-line 1)
19108 (defun org-at-heading-or-item-p ()
19109 (or (org-on-heading-p) (org-at-item-p)))
19111 (defun org-on-target-p ()
19112 (or (org-in-regexp org-radio-target-regexp)
19113 (org-in-regexp org-target-regexp)))
19115 (defun org-up-heading-all (arg)
19116 "Move to the heading line of which the present line is a subheading.
19117 This function considers both visible and invisible heading lines.
19118 With argument, move up ARG levels."
19119 (if (fboundp 'outline-up-heading-all)
19120 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19121 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19123 (defun org-up-heading-safe ()
19124 "Move to the heading line of which the present line is a subheading.
19125 This version will not throw an error. It will return the level of the
19126 headline found, or nil if no higher level is found.
19128 Also, this function will be a lot faster than `outline-up-heading',
19129 because it relies on stars being the outline starters. This can really
19130 make a significant difference in outlines with very many siblings."
19131 (let (start-level re)
19132 (org-back-to-heading t)
19133 (setq start-level (funcall outline-level))
19134 (if (equal start-level 1)
19135 nil
19137 (if (re-search-backward re nil t)
19138 (funcall outline-level)))))
19140 (defun org-first-sibling-p ()
19141 "Is this heading the first child of its parents?"
19142 (interactive)
19143 (let ((re (concat "^" outline-regexp))
19144 level l)
19145 (unless (org-at-heading-p t)
19146 (error "Not at a heading"))
19147 (setq level (funcall outline-level))
19148 (save-excursion
19149 (if (not (re-search-backward re nil t))
19150 t
19151 (setq l (funcall outline-level))
19152 (< l level)))))
19154 (defun org-goto-sibling (&optional previous)
19155 "Goto the next sibling, even if it is invisible.
19156 When PREVIOUS is set, go to the previous sibling instead. Returns t
19157 when a sibling was found. When none is found, return nil and don't
19158 move point."
19159 (let ((fun (if previous 're-search-backward 're-search-forward))
19160 (pos (point))
19161 (re (concat "^" outline-regexp))
19162 level l)
19163 (when (condition-case nil (org-back-to-heading t) (error nil))
19164 (setq level (funcall outline-level))
19165 (catch 'exit
19166 (or previous (forward-char 1))
19167 (while (funcall fun re nil t)
19168 (setq l (funcall outline-level))
19169 (when (< l level) (goto-char pos) (throw 'exit nil))
19170 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19171 (goto-char pos)
19172 nil))))
19174 (defun org-show-siblings ()
19175 "Show all siblings of the current headline."
19176 (save-excursion
19177 (while (org-goto-sibling) (org-flag-heading nil)))
19178 (save-excursion
19179 (while (org-goto-sibling 'previous)
19180 (org-flag-heading nil))))
19182 (defun org-goto-first-child ()
19183 "Goto the first child, even if it is invisible.
19184 Return t when a child was found. Otherwise don't move point and
19185 return nil."
19186 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19187 (when (condition-case nil (org-back-to-heading t) (error nil))
19188 (setq level (outline-level))
19189 (forward-char 1)
19190 (if (and (re-search-forward re nil t) (> (outline-level) level))
19191 (progn (goto-char (match-beginning 0)) t)
19192 (goto-char pos) nil))))
19194 (defun org-show-hidden-entry ()
19195 "Show an entry where even the heading is hidden."
19196 (save-excursion
19197 (org-show-entry)))
19199 (defun org-flag-heading (flag &optional entry)
19200 "Flag the current heading. FLAG non-nil means make invisible.
19201 When ENTRY is non-nil, show the entire entry."
19202 (save-excursion
19203 (org-back-to-heading t)
19204 ;; Check if we should show the entire entry
19205 (if entry
19206 (progn
19207 (org-show-entry)
19208 (save-excursion
19209 (and (outline-next-heading)
19210 (org-flag-heading nil))))
19211 (outline-flag-region (max (point-min) (1- (point)))
19212 (save-excursion (outline-end-of-heading) (point))
19213 flag))))
19215 (defun org-get-next-sibling ()
19216 "Move to next heading of the same level, and return point.
19217 If there is no such heading, return nil.
19218 This is like outline-next-sibling, but invisible headings are ok."
19219 (let ((level (funcall outline-level)))
19220 (outline-next-heading)
19221 (while (and (not (eobp)) (> (funcall outline-level) level))
19222 (outline-next-heading))
19223 (if (or (eobp) (< (funcall outline-level) level))
19224 nil
19225 (point))))
19227 (defun org-get-last-sibling ()
19228 "Move to previous heading of the same level, and return point.
19229 If there is no such heading, return nil."
19230 (let ((opoint (point))
19231 (level (funcall outline-level)))
19232 (outline-previous-heading)
19233 (when (and (/= (point) opoint) (outline-on-heading-p t))
19234 (while (and (> (funcall outline-level) level)
19235 (not (bobp)))
19236 (outline-previous-heading))
19237 (if (< (funcall outline-level) level)
19238 nil
19239 (point)))))
19241 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19242 ;; This contains an exact copy of the original function, but it uses
19243 ;; `org-back-to-heading', to make it work also in invisible
19244 ;; trees. And is uses an invisible-OK argument.
19245 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19246 ;; Furthermore, when used inside Org, finding the end of a large subtree
19247 ;; with many children and grandchildren etc, this can be much faster
19248 ;; than the outline version.
19249 (org-back-to-heading invisible-OK)
19250 (let ((first t)
19251 (level (funcall outline-level)))
19252 (if (and (org-mode-p) (< level 1000))
19253 ;; A true heading (not a plain list item), in Org-mode
19254 ;; This means we can easily find the end by looking
19255 ;; only for the right number of stars. Using a regexp to do
19256 ;; this is so much faster than using a Lisp loop.
19258 (forward-char 1)
19259 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19260 ;; something else, do it the slow way
19261 (while (and (not (eobp))
19262 (or first (> (funcall outline-level) level)))
19263 (setq first nil)
19264 (outline-next-heading)))
19265 (unless to-heading
19267 (progn
19268 ;; Go to end of line before heading
19269 (forward-char -1)
19271 ;; leave blank line before heading
19272 (forward-char -1))))))
19273 (point))
19275 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19276 "Use Org version in org-mode, for dramatic speed-up."
19277 (if (eq major-mode 'org-mode)
19278 (progn
19279 (org-end-of-subtree nil t)
19280 (unless (eobp) (backward-char 1)))
19281 ad-do-it))
19283 (defun org-forward-same-level (arg &optional invisible-ok)
19284 "Move forward to the arg'th subheading at same level as this one.
19285 Stop at the first and last subheadings of a superior heading.
19286 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19287 it wil also look at invisible ones."
19288 (interactive "p")
19289 (org-back-to-heading invisible-ok)
19290 (org-on-heading-p)
19291 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19293 l)
19294 (forward-char 1)
19295 (while (> arg 0)
19296 (while (and (re-search-forward re nil 'move)
19297 (setq l (- (match-end 0) (match-beginning 0) 1))
19298 (= l level)
19299 (not invisible-ok)
19300 (progn (backward-char 1) (org-invisible-p)))
19301 (if (< l level) (setq arg 1)))
19302 (setq arg (1- arg)))
19303 (beginning-of-line 1)))
19305 (defun org-backward-same-level (arg &optional invisible-ok)
19306 "Move backward to the arg'th subheading at same level as this one.
19307 Stop at the first and last subheadings of a superior heading."
19308 (interactive "p")
19309 (org-back-to-heading)
19310 (org-on-heading-p)
19311 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19313 l)
19314 (while (> arg 0)
19315 (while (and (re-search-backward re nil 'move)
19316 (setq l (- (match-end 0) (match-beginning 0) 1))
19317 (= l level)
19318 (not invisible-ok)
19319 (org-invisible-p))
19320 (if (< l level) (setq arg 1)))
19321 (setq arg (1- arg)))))
19323 (defun org-show-subtree ()
19324 "Show everything after this heading at deeper levels."
19325 (outline-flag-region
19326 (point)
19327 (save-excursion
19328 (org-end-of-subtree t t))
19329 nil))
19331 (defun org-show-entry ()
19332 "Show the body directly following this heading.
19333 Show the heading too, if it is currently invisible."
19334 (interactive)
19335 (save-excursion
19336 (condition-case nil
19337 (progn
19338 (org-back-to-heading t)
19339 (outline-flag-region
19340 (max (point-min) (1- (point)))
19341 (save-excursion
19342 (if (re-search-forward
19344 (match-beginning 1)
19345 (point-max)))
19346 nil)
19347 (org-cycle-hide-drawers 'children))
19348 (error nil))))
19350 (defun org-make-options-regexp (kwds &optional extra)
19351 "Make a regular expression for keyword lines."
19352 (concat
19353 "^"
19360 ;; Make isearch reveal the necessary context
19361 (defun org-isearch-end ()
19362 "Reveal context after isearch exits."
19363 (when isearch-success ; only if search was successful
19364 (if (featurep 'xemacs)
19365 ;; Under XEmacs, the hook is run in the correct place,
19366 ;; we directly show the context.
19367 (org-show-context 'isearch)
19368 ;; In Emacs the hook runs *before* restoring the overlays.
19369 ;; So we have to use a one-time post-command-hook to do this.
19370 ;; (Emacs 22 has a special variable, see function `org-mode')
19371 (unless (and (boundp 'isearch-mode-end-hook-quit)
19372 isearch-mode-end-hook-quit)
19373 ;; Only when the isearch was not quitted.
19374 (org-add-hook 'post-command-hook 'org-isearch-post-command
19375 'append 'local)))))
19377 (defun org-isearch-post-command ()
19378 "Remove self from hook, and show context."
19379 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19380 (org-show-context 'isearch))
19383 ;;;; Integration with and fixes for other packages
19385 ;;; Imenu support
19387 (defvar org-imenu-markers nil
19388 "All markers currently used by Imenu.")
19389 (make-variable-buffer-local 'org-imenu-markers)
19391 (defun org-imenu-new-marker (&optional pos)
19392 "Return a new marker for use by Imenu, and remember the marker."
19393 (let ((m (make-marker)))
19394 (move-marker m (or pos (point)))
19395 (push m org-imenu-markers)
19396 m))
19398 (defun org-imenu-get-tree ()
19399 "Produce the index for Imenu."
19400 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19401 (setq org-imenu-markers nil)
19402 (let* ((n org-imenu-depth)
19403 (re (concat "^" outline-regexp))
19404 (subs (make-vector (1+ n) nil))
19405 (last-level 0)
19406 m level head)
19407 (save-excursion
19408 (save-restriction
19409 (widen)
19410 (goto-char (point-max))
19411 (while (re-search-backward re nil t)
19412 (setq level (org-reduced-level (funcall outline-level)))
19413 (when (<= level n)
19414 (looking-at org-complex-heading-regexp)
19415 (setq head (org-link-display-format
19416 (org-match-string-no-properties 4))
19417 m (org-imenu-new-marker))
19418 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19419 (if (>= level last-level)
19420 (push (cons head m) (aref subs level))
19421 (push (cons head (aref subs (1+ level))) (aref subs level))
19422 (loop for i from (1+ level) to n do (aset subs i nil)))
19423 (setq last-level level)))))
19424 (aref subs 1)))
19426 (eval-after-load "imenu"
19427 '(progn
19428 (add-hook 'imenu-after-jump-hook
19429 (lambda ()
19430 (if (eq major-mode 'org-mode)
19431 (org-show-context 'org-goto))))))
19433 (defun org-link-display-format (link)
19434 "Replace a link with either the description, or the link target
19435 if no description is present"
19436 (save-match-data
19437 (if (string-match org-bracket-link-analytic-regexp link)
19438 (replace-match (if (match-end 5)
19439 (match-string 5 link)
19440 (concat (match-string 1 link)
19441 (match-string 3 link)))
19442 nil t link)
19443 link)))
19445 ;; Speedbar support
19447 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19448 "Overlay marking the agenda restriction line in speedbar.")
19449 (overlay-put org-speedbar-restriction-lock-overlay
19450 'face 'org-agenda-restriction-lock)
19451 (overlay-put org-speedbar-restriction-lock-overlay
19452 'help-echo "Agendas are currently limited to this item.")
19453 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19455 (defun org-speedbar-set-agenda-restriction ()
19456 "Restrict future agenda commands to the location at point in speedbar.
19458 (interactive)
19459 (require 'org-agenda)
19460 (let (p m tp np dir txt)
19461 (cond
19462 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19463 'org-imenu t))
19464 (setq m (get-text-property p 'org-imenu-marker))
19465 (with-current-buffer (marker-buffer m)
19466 (goto-char m)
19467 (org-agenda-set-restriction-lock 'subtree)))
19468 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19469 'speedbar-function 'speedbar-find-file))
19470 (setq tp (previous-single-property-change
19471 (1+ p) 'speedbar-function)
19472 np (next-single-property-change
19473 tp 'speedbar-function)
19474 dir (speedbar-line-directory)
19475 txt (buffer-substring-no-properties (or tp (point-min))
19476 (or np (point-max))))
19477 (with-current-buffer (find-file-noselect
19478 (let ((default-directory dir))
19479 (expand-file-name txt)))
19480 (unless (org-mode-p)
19481 (error "Cannot restrict to non-Org-mode file"))
19482 (org-agenda-set-restriction-lock 'file)))
19483 (t (error "Don't know how to restrict Org-mode's agenda")))
19484 (move-overlay org-speedbar-restriction-lock-overlay
19485 (point-at-bol) (point-at-eol))
19486 (setq current-prefix-arg nil)
19487 (org-agenda-maybe-redo)))
19489 (eval-after-load "speedbar"
19490 '(progn
19491 (speedbar-add-supported-extension ".org")
19492 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19493 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19494 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19495 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19496 (add-hook 'speedbar-visiting-tag-hook
19497 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19499 ;;; Fixes and Hacks for problems with other packages
19501 ;; Make flyspell not check words in links, to not mess up our keymap
19502 (defun org-mode-flyspell-verify ()
19503 "Don't let flyspell put overlays at active buttons."
19504 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19505 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19507 (defun org-remove-flyspell-overlays-in (beg end)
19508 "Remove flyspell overlays in region."
19509 (and (org-bound-and-true-p flyspell-mode)
19510 (fboundp 'flyspell-delete-region-overlays)
19511 (flyspell-delete-region-overlays beg end))
19512 (add-text-properties beg end '(org-no-flyspell t)))
19514 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19515 (eval-after-load "bookmark"
19516 '(if (boundp 'bookmark-after-jump-hook)
19517 ;; We can use the hook
19518 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19519 ;; Hook not available, use advice
19520 (defadvice bookmark-jump (after org-make-visible activate)
19521 "Make the position visible."
19522 (org-bookmark-jump-unhide))))
19524 ;; Make sure saveplace shows the location if it was hidden
19525 (eval-after-load "saveplace"
19526 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19527 "Make the position visible."
19528 (org-bookmark-jump-unhide)))
19530 ;; Make sure ecb shows the location if it was hidden
19531 (eval-after-load "ecb"
19532 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19533 "Make hierarchy visible when jumping into location from ECB tree buffer."
19534 (if (eq major-mode 'org-mode)
19535 (org-show-context))))
19537 (defun org-bookmark-jump-unhide ()
19538 "Unhide the current position, to show the bookmark location."
19539 (and (org-mode-p)
19540 (or (org-invisible-p)
19541 (save-excursion (goto-char (max (point-min) (1- (point))))
19542 (org-invisible-p)))
19543 (org-show-context 'bookmark-jump)))
19545 ;; Make session.el ignore our circular variable
19546 (eval-after-load "session"
19547 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19549 ;;;; Experimental code
19551 (defun org-closed-in-range ()
19552 "Sparse tree of items closed in a certain time range.
19553 Still experimental, may disappear in the future."
19554 (interactive)
19555 ;; Get the time interval from the user.
19556 (let* ((time1 (org-float-time
19557 (org-read-date nil 'to-time nil "Starting date: ")))
19558 (time2 (org-float-time
19559 (org-read-date nil 'to-time nil "End date:")))
19560 ;; callback function
19561 (callback (lambda ()
19562 (let ((time
19563 (org-float-time
19564 (apply 'encode-time
19565 (org-parse-time-string
19566 (match-string 1))))))
19567 ;; check if time in interval
19568 (and (>= time time1) (<= time time2))))))
19569 ;; make tree, check each match with the callback
19572 ;;;; Finish up
19574 (provide 'org)
19576 (run-hooks 'org-load-hook)
19578 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19580 ;;; org.el ends here