| blob | 6b3773819faf5ee551ce1ddac302576f521b10ce |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
114 ;; babel
123 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
155 :key-type
192 ;;;; Customization variables
194 "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
197 identifier."
201 ;;; Version
207 "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
234 ;;; Compatibility constants
236 ;;; The custom variables
239 "Outline-based notes management and organizer."
245 "Mode hook for Org-mode, run after the mode was turned on."
250 "Hook that is run after org.el has been loaded."
255 "Hook that is run after an Org log buffer is created."
264 "Load all extensions listed in `org-modules'."
269 org-modules)
273 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
282 (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)
283 "Modules that should always be loaded together with org.el.
284 If a description starts with <C>, the file is not part of Emacs
285 and loading it will require that you have downloaded and properly installed
286 the org-mode distribution.
288 You can also use this system to load external packages (i.e. neither Org
289 core modules, nor modules from the CONTRIB directory). Just add symbols
290 to the end of the list. If the package is called org-xyz.el, then you need
291 to add the symbol `xyz', and the package must have a call to
293 (provide 'org-xyz)"
296 :type
327 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
336 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
345 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
362 "Non-nil means make shift-cursor commands select text when possible.
364 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
365 start selecting a region, or enlarge regions started in this way.
366 In Org-mode, in special contexts, these same keys are used for
367 other purposes, important enough to compete with shift selection.
368 Org tries to balance these needs by supporting `shift-select-mode'
369 outside these special contexts, under control of this variable.
371 The default of this variable is nil, to avoid confusing behavior. Shifted
372 cursor keys will then execute Org commands in the following contexts:
373 - on a headline, changing TODO state (left/right) and priority (up/down)
374 - on a time stamp, changing the time
375 - in a plain list item, changing the bullet type
376 - in a property definition line, switching between allowed values
377 - in the BEGIN line of a clock table (changing the time block).
378 Outside these contexts, the commands will throw an error.
380 When this variable is t and the cursor is not in a special
381 context, Org-mode will support shift-selection for making and
382 enlarging regions. To make this more effective, the bullet
383 cycling will no longer happen anywhere in an item line, but only
384 if the cursor is exactly on the bullet.
386 If you set this variable to the symbol `always', then the keys
387 will not be special in headlines, property lines, and item lines,
388 to make shift selection work there as well. If this is what you
389 want, you can use the following alternative commands: `C-c C-t'
390 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
391 can be used to switch TODO sets, `C-c -' to cycle item bullet
392 types, and properties can be edited by hand or in column view.
394 However, when the cursor is on a timestamp, shift-cursor commands
395 will still edit the time stamp - this is just too good to give up.
397 XEmacs user should have this variable set to nil, because
398 `shift-select-mode' is in Emacs 23 or later only."
406 "Options concerning startup of Org-mode."
411 "Non-nil means entering Org-mode will switch to OVERVIEW.
412 This can also be configured on a per-file basis by adding one of
413 the following lines anywhere in the buffer:
415 #+STARTUP: fold (or `overview', this is equivalent)
416 #+STARTUP: nofold (or `showall', this is equivalent)
417 #+STARTUP: content
418 #+STARTUP: showeverything"
427 "Non-nil means entering Org-mode will set `truncate-lines'.
428 This is useful since some lines containing links can be very long and
429 uninteresting. Also tables look terrible when wrapped."
434 "Non-nil means turn on `org-indent-mode' on startup.
435 This can also be configured on a per-file basis by adding one of
436 the following lines anywhere in the buffer:
438 #+STARTUP: indent
439 #+STARTUP: noindent"
447 When this option is turned on, you can use TeX-like syntax for sub- and
449 considered as a single item - so grouping with {} is normally not
450 needed. For example, the following things will be parsed as single
451 sub- or superscripts.
453 10^24 or 10^tau several digits will be considered 1 item.
454 10^-12 or 10^-tau a leading sign with digits or a word
455 x^2-y^3 will be read as x^2 - y^3, because items are
456 terminated by almost any nonword/nondigit char.
457 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
459 Still, ambiguity is possible - so when in doubt use {} to enclose the
460 sub/superscript. If you set this variable to the symbol `{}',
461 the braces are *required* in order to trigger interpretations as
463 frequently in plain text.
465 Not all export backends support this, but HTML does.
480 "Non-nil means turn on `org-beamer-mode' on startup.
481 This can also be configured on a per-file basis by adding one of
482 the following lines anywhere in the buffer:
484 #+STARTUP: beamer"
489 "Non-nil means align all tables when visiting a file.
490 This is useful when the column width in tables is forced with <N> cookies
491 in table fields. Such tables will look correct only after the first re-align.
492 This can also be configured on a per-file basis by adding one of
493 the following lines anywhere in the buffer:
494 #+STARTUP: align
495 #+STARTUP: noalign"
500 "Non-nil means show inline images when loading a new Org file.
501 This can also be configured on a per-file basis by adding one of
502 the following lines anywhere in the buffer:
503 #+STARTUP: inlineimages
504 #+STARTUP: noinlineimages"
509 "Non-nil means insert the first line setting Org-mode in empty files.
510 When the function `org-mode' is called interactively in an empty file, this
511 normally means that the file name does not automatically trigger Org-mode.
512 To ensure that the file will always be in Org-mode in the future, a
513 line enforcing Org-mode will be inserted into the buffer, if this option
514 has been set."
519 "Non-nil means use alternative key bindings for some keys.
520 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
521 These keys are also used by other packages like shift-selection-mode'
522 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
523 If you want to use Org-mode together with one of these other modes,
524 or more generally if you would like to move some Org-mode commands to
525 other keys, set this variable and configure the keys with the variable
526 `org-disputed-keys'.
528 This option is only relevant at load-time of Org-mode, and must be set
529 *before* org.el is loaded. Changing it requires a restart of Emacs to
530 become effective."
535 "Non-nil means use extra key sequence definitions for certain commands.
536 This happens automatically if you run XEmacs or if `window-system'
537 is nil. This variable lets you do the same manually. You must
538 set it before loading org.
540 Example: on Carbon Emacs 22 running graphically, with an external
541 keyboard on a Powerbook, the default way of setting M-left might
542 not work for either Alt or ESC. Setting this variable will make
543 it work for ESC."
557 "Keys for which Org-mode and other modes compete.
558 This is an alist, cars are the default keys, second element specifies
559 the alternative to use when `org-replace-disputed-keys' is t.
561 Keys can be specified in any syntax supported by `define-key'.
562 The value of this option takes effect only at Org-mode's startup,
563 therefore you'll have to restart Emacs to apply it after changing."
568 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
569 Or return the original if not disputed.
570 Also apply the translations defined in `org-xemacs-key-equivalents'."
575 org-disputed-keys)))
579 key)
589 "Define a key, possibly translated, as returned by `org-key'."
593 "The ellipsis to use in the Org-mode outline.
594 When nil, just use the standard three dots. When a string, use that instead,
595 When a face, use the standard 3 dots, but with the specified face.
596 The change affects only Org-mode (which will then use its own display table).
597 Changing this requires executing `M-x org-mode' in a buffer to become
598 effective."
608 "Keywords in Org-mode."
613 "String to mark deadline entries.
614 A deadline is this string, followed by a time stamp. Should be a word,
615 terminated by a colon. You can insert a schedule keyword and
617 Changes become only effective after restarting Emacs."
622 "String to mark scheduled TODO entries.
623 A schedule is this string, followed by a time stamp. Should be a word,
624 terminated by a colon. You can insert a schedule keyword and
626 Changes become only effective after restarting Emacs."
631 "String used as the prefix for timestamps logging closing a TODO entry."
636 "String used as prefix for timestamps clocking work hours on an item."
641 "Entries starting with this keyword will never be exported.
642 An entry can be toggled between COMMENT and normal with
644 Changes become only effective after restarting Emacs."
649 "Entries starting with this keyword will be exported in fixed-width font.
650 Quoting applies only to the text in the entry following the headline, and does
651 not extend beyond the next headline, even if that is lower level.
652 An entry can be toggled between QUOTE and normal with
659 "Regular expression for specifying repeated events.
663 "Options concerning the general structure of Org-mode files."
668 "Options about how to make context of a location visible."
692 "Non-nil means show full hierarchy when revealing a location.
693 Org-mode often shows locations in an org-mode file which might have
694 been invisible before. When this is set, the hierarchy of headings
695 above the exposed location is shown.
696 Turning this off for example for sparse trees makes them very compact.
697 Instead of t, this can also be an alist specifying this option for different
698 contexts. Valid contexts are
699 agenda when exposing an entry from the agenda
700 org-goto when using the command `org-goto' on key C-c C-j
701 occur-tree when using the command `org-occur' on key C-c /
702 tags-tree when constructing a sparse tree based on tags matches
703 link-search when exposing search matches associated with a link
704 mark-goto when exposing the jump goal of a mark
705 bookmark-jump when exposing a bookmark location
706 isearch when exiting from an incremental search
707 default default for all contexts not set explicitly"
712 "Non-nil means show following heading when revealing a location.
713 Org-mode often shows locations in an org-mode file which might have
714 been invisible before. When this is set, the heading following the
715 match is shown.
716 Turning this off for example for sparse trees makes them very compact,
717 but makes it harder to edit the location of the match. In such a case,
719 Instead of t, this can also be an alist specifying this option for different
720 contexts. See `org-show-hierarchy-above' for valid contexts."
725 "Non-nil means show all sibling heading when revealing a location.
726 Org-mode often shows locations in an org-mode file which might have
727 been invisible before. When this is set, the sibling of the current entry
728 heading are all made visible. If `org-show-hierarchy-above' is t,
729 the same happens on each level of the hierarchy above the current entry.
731 By default this is on for the isearch context, off for all other contexts.
732 Turning this off for example for sparse trees makes them very compact,
733 but makes it harder to edit the location of the match. In such a case,
735 Instead of t, this can also be an alist specifying this option for different
736 contexts. See `org-show-hierarchy-above' for valid contexts."
741 "Non-nil means show the entry below a headline when revealing a location.
742 Org-mode often shows locations in an org-mode file which might have
743 been invisible before. When this is set, the text below the headline that is
744 exposed is also shown.
746 By default this is off for all contexts.
747 Instead of t, this can also be an alist specifying this option for different
748 contexts. See `org-show-hierarchy-above' for valid contexts."
753 "How should indirect tree buffers be displayed?
754 This applies to indirect buffers created with the commands
756 Valid values are:
757 current-window Display in the current window
758 other-window Just display in another window.
759 dedicated-frame Create one new frame, and re-use it each time.
760 new-frame Make a new frame each time. Note that in this case
761 previously-made indirect buffers are kept, and you need to
762 kill these buffers yourself."
772 "Non-nil means activate single letter commands at beginning of a headline.
773 This may also be a function to test for appropriate locations where speed
774 commands should be active."
782 "Alist of additional speed commands.
783 This list will be checked before `org-speed-commands-default'
784 when the variable `org-use-speed-commands' is non-nil
785 and when the cursor is at the beginning of a headline.
786 The car if each entry is a string with a single letter, which must
787 be assigned to `self-insert-command' in the global map.
788 The cdr is either a command to be called interactively, a function
789 to be called, or a form to be evaluated.
790 An entry that is just a list with a single string will be interpreted
791 as a descriptive headline that will be added when listing the speed
792 commands in the Help buffer using the `?' speed command."
804 "Options concerning visibility cycling in Org-mode."
809 "Non-nil means skip CHILDREN state in entries that don't have any."
814 "Maximum level which should still be subject to visibility cycling.
815 Levels higher than this will, for cycling, be treated as text, not a headline.
816 When `org-odd-levels-only' is set, a value of N in this variable actually
817 means 2N-1 stars as the limiting headline.
818 When nil, cycle all levels.
819 Note that the limiting level of cycling is also influenced by
820 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
821 `org-inlinetask-min-level' is, cycling will be limited to levels one less
822 than its value."
829 "Names of drawers. Drawers are not opened by cycling on the headline above.
830 Drawers only open with a TAB on the drawer line itself. A drawer looks like
831 this:
832 :DRAWERNAME:
833 .....
834 :END:
836 the property API.
838 Drawers can be defined on the per-file basis with a line like:
840 #+DRAWERS: HIDDEN STATE PROPERTIES"
846 "Non-nil means entering Org-mode will fold all blocks.
847 This can also be set in on a per-file basis with
849 #+STARTUP: hideblocks
850 #+STARTUP: showblocks"
856 "Cycle globally if cursor is at beginning of buffer and not at a headline.
857 This makes it possible to do global cycling without having to use S-TAB or
859 of the buffer
860 must not be a headline - it may be empty or some other text. When used in
861 this way, `org-cycle-hook' is disables temporarily, to make sure the
862 cursor stays at the beginning of the buffer.
863 When this option is nil, don't do anything special at the beginning
864 of the buffer."
869 "Non-nil means cycle entry level or item indentation in new empty entries.
871 When the cursor is at the end of an empty headline, i.e with only stars
872 and maybe a TODO keyword, TAB will then switch the entry to become a child,
873 and then all possible ancestor states, before returning to the original state.
874 This makes data entry extremely fast: M-RET to create a new headline,
875 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
877 When the cursor is at the end of an empty plain list item, one TAB will
878 make it a subitem, two or more tabs will back up to make this an item
879 higher up in the item hierarchy."
884 "Where should `org-cycle' emulate TAB.
885 nil Never
886 white Only in completely white lines
887 whitestart Only at the beginning of lines, before the first non-white char
888 t Everywhere except in headlines
889 exc-hl-bol Everywhere except at the start of a headline
890 If TAB is used in a place where it does not emulate TAB, the current subtree
891 visibility is cycled."
898 ))
901 "Number of empty lines needed to keep an empty line between collapsed trees.
902 If you leave an empty line between the end of a subtree and the following
903 headline, this empty line is hidden when the subtree is folded.
904 Org-mode will leave (exactly) one empty line visible if the number of
905 empty lines is equal or larger to the number given in this variable.
906 So the default 2 means at least 2 empty lines after the end of a subtree
907 are needed to produce free space between a collapsed subtree and the
908 following headline.
910 If the number is negative, and the number of empty lines is at least -N,
911 all empty lines are shown.
913 Special case: when 0, never leave empty lines in collapsed view."
919 "Hook that is run before visibility cycling is happening.
920 The function(s) in this hook must accept a single argument which indicates
921 the new state that will be set right after running this hook. The
922 argument is a symbol. Before a global state change, it can have the values
923 `overview', `content', or `all'. Before a local state change, it can have
924 the values `folded', `children', or `subtree'."
929 org-cycle-hide-drawers
930 org-cycle-show-empty-lines
931 org-optimize-window-after-visibility-change)
932 "Hook that is run after `org-cycle' has changed the buffer visibility.
933 The function(s) in this hook must accept a single argument which indicates
934 the new state that was set by the most recent `org-cycle' command. The
935 argument is a symbol. After a global state change, it can have the values
936 `overview', `content', or `all'. After a local state change, it can have
937 the values `folded', `children', or `subtree'."
942 "Options concerning structure editing in Org-mode."
947 "Non-nil means skip even levels and only use odd levels for the outline.
948 This has the effect that two stars are being added/taken away in
949 promotion/demotion commands. It also influences how levels are
950 handled by the exporters.
951 Changing it requires restart of `font-lock-mode' to become effective
952 for fontification also in regions already fontified.
953 You may also set this on a per-file basis by adding one of the following
954 lines to the buffer:
956 #+STARTUP: odd
957 #+STARTUP: oddeven"
963 "Non-nil means adapt indentation to outline node level.
965 When this variable is set, Org assumes that you write outlines by
966 indenting text in each node to align with the headline (after the stars).
967 The following issues are influenced by this variable:
969 - When this is set and the *entire* text in an entry is indented, the
970 indentation is increased by one space in a demotion command, and
971 decreased by one in a promotion command. If any line in the entry
972 body starts with text at column 0, indentation is not changed at all.
974 - Property drawers and planning information is inserted indented when
975 this variable s set. When nil, they will not be indented.
977 - TAB indents a line relative to context. The lines below a headline
978 will be indented when this variable is set.
980 Note that this is all about true indentation, by adding and removing
981 space characters. See also `org-indent.el' which does level-dependent
982 indentation in a virtual way, i.e. at display time in Emacs."
987 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
989 When t, `C-a' will bring back the cursor to the beginning of the
990 headline text, i.e. after the stars and after a possible TODO keyword.
991 In an item, this will be the position after the bullet.
992 When the cursor is already at that position, another `C-a' will bring
993 it to the beginning of the line.
995 `C-e' will jump to the end of the headline, ignoring the presence of tags
996 in the headline. A second `C-e' will then jump to the true end of the
997 line, after any tags. This also means that, when this variable is
998 non-nil, `C-e' also will never jump beyond the end of the heading of a
999 folded section, i.e. not after the ellipses.
1001 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1002 going to the true line boundary first. Only a directly following, identical
1003 keypress will bring the cursor to the special positions.
1005 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1006 set separately."
1025 "Non-nil means `C-k' will behave specially in headlines.
1026 When nil, `C-k' will call the default `kill-line' command.
1027 When t, the following will happen while the cursor is in the headline:
1029 - When the cursor is at the beginning of a headline, kill the entire
1030 line and possible the folded subtree below the line.
1031 - When in the middle of the headline text, kill the headline up to the tags.
1032 - When after the headline text, kill the tags."
1037 "Non-nil means, do not delete a hidden subtree with C-k.
1038 When set to the symbol `error', simply throw an error when C-k is
1039 used to kill (part-of) a headline that has hidden text behind it.
1040 Any other non-nil value will result in a query to the user, if it is
1041 OK to kill that hidden subtree. When nil, kill without remorse."
1049 "Non-nil means when yanking subtrees, fold them.
1050 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1051 it starts with a heading and all other headings in it are either children
1052 or siblings, then fold all the subtrees. However, do this only if no
1053 text after the yank would be swallowed into a folded tree by this action."
1058 "Non-nil means when yanking subtrees, adjust the level.
1059 With this setting, `org-paste-subtree' is used to insert the subtree, see
1060 this function for details."
1065 "Non-nil means M-RET will split the line at the cursor position.
1066 When nil, it will go to the end of the line before making a
1067 new line.
1068 You may also set this option in a different way for different
1069 contexts. Valid contexts are:
1071 headline when creating a new headline
1072 item when creating a new item
1073 table in a table field
1074 default the value to be used for all contexts not explicitly
1075 customized"
1092 "Non-nil means insert new headings after the current subtree.
1093 When nil, the new heading is created directly after the current line.
1096 for the duration of the command."
1102 "Should `org-insert-heading' leave a blank line before new heading/item?
1103 The value is an alist, with `heading' and `plain-list-item' as CAR,
1104 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1105 which case Org will look at the surrounding headings/items and try to
1106 make an intelligent decision whether to insert a blank line or not.
1108 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1109 set, the setting here is ignored and no empty line is inserted, to avoid
1110 breaking the list structure."
1123 "Hook being run after inserting a new heading."
1129 This currently only means they are never auto-wrapped.
1130 When nil, such lines will be treated like ordinary lines.
1131 See also the QUOTE keyword."
1136 "Non-nil means typing characters in `org-goto' starts incremental search."
1141 "Options concerning sparse trees in Org-mode."
1146 "Non-nil means highlight all matches that define a sparse tree.
1147 The highlights will automatically disappear the next time the buffer is
1148 changed by an edit command."
1153 "Non-nil means any change to the buffer will remove temporary highlights.
1154 Such highlights are created by `org-occur' and `org-clock-display'.
1155 When nil, `C-c C-c needs to be used to get rid of the highlights.
1156 The highlights created by `org-preview-latex-fragment' always need
1157 `C-c C-c' to be removed."
1164 "Hook that is run after `org-occur' has constructed a sparse tree.
1165 This can be used to recenter the window to show as much of the structure
1166 as possible."
1171 "Options concerning imenu and speedbar in Org-mode."
1176 "The maximum level for Imenu access to Org-mode headlines.
1177 This also applied for speedbar access."
1182 "Options concerning tables in Org-mode."
1188 When nil, such lines will be treated like ordinary lines.
1190 When equal to the symbol `optimized', the table editor will be optimized to
1191 do the following:
1192 - Automatic overwrite mode in front of whitespace in table fields.
1193 This makes the structure of the table stay in tact as long as the edited
1194 field does not exceed the column width.
1195 - Minimize the number of realigns. Normally, the table is aligned each time
1196 TAB or RET are pressed to move to another field. With optimization this
1197 happens only if changes to a field might have changed the column width.
1198 Optimization requires replacing the functions `self-insert-command',
1199 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1200 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1201 very good at guessing when a re-align will be necessary, but you can always
1204 If you would like to use the optimized version in Org-mode, but the
1205 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1207 This variable can be used to turn on and off the table editor during a session,
1208 but in order to toggle optimization, a restart is required.
1210 See also the variable `org-table-auto-blank-field'."
1218 "Non-nil means cluster self-insert commands for undo when possible.
1219 If this is set, then, like in the Emacs command loop, 20 consecutive
1220 characters will be undone together.
1221 This is configurable, because there is some impact on typing performance."
1226 "Non-nil means TAB will automatically notice a table.el table.
1227 When it sees such a table, it moves point into it and - if necessary -
1228 calls `table-recognize-table'."
1233 "Options concerning links in Org-mode."
1238 "Buffer-local version of `org-link-abbrev-alist', which see.
1243 "Alist of link abbreviations.
1244 The car of each element is a string, to be replaced at the start of a link.
1246 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1248 [[linkkey:tag][description]]
1250 The 'linkkey' must be a word word, starting with a letter, followed
1251 by letters, numbers, '-' or '_'.
1253 If REPLACE is a string, the tag will simply be appended to create the link.
1256 be inserted at that point (see the function `url-hexify-string').
1258 REPLACE may also be a function that will be called with the tag as the
1259 only argument to create the link, which should be returned as a string.
1261 See the manual for examples."
1271 "Non-nil means Org will display descriptive links.
1272 E.g. [[http://orgmode.org][Org website]] will be displayed as
1274 description. When set to `nil', Org will display the full links
1275 literally.
1277 You can interactively set the value of this variable by calling
1278 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1283 "How the path name in file links should be stored.
1284 Valid values are:
1286 relative Relative to the current directory, i.e. the directory of the file
1287 into which the link is being inserted.
1288 absolute Absolute path, if possible with ~ for home directory.
1289 noabbrev Absolute path, no abbreviation of home directory.
1290 adaptive Use relative path for files in the current directory and sub-
1291 directories of it. For other files, use an absolute path."
1300 "Types of links that should be activated in Org-mode files.
1301 This is a list of symbols, each leading to the activation of a certain link
1302 type. In principle, it does not hurt to turn on most link types - there may
1303 be a small gain when turning off unused link types. The types are:
1305 bracket The recommended [[link][description]] or [[link]] links with hiding.
1306 angle Links in angular brackets that may contain whitespace like
1307 <bbdb:Carsten Dominik>.
1308 plain Plain links in normal text, no whitespace, like http://google.com.
1309 radio Text that is matched by a radio target, see manual for details.
1310 tag Tag settings in a headline (link to tag search).
1311 date Time stamps (link to calendar).
1312 footnote Footnote labels.
1314 Changing this variable requires a restart of Emacs to become effective."
1326 "Function to use to generate link descriptions from links.
1327 If nil the link location will be used. This function must take
1328 two parameters; the first is the link and the second the
1329 description `org-insert-link' has generated, and should return the
1330 description to use."
1335 "Options concerning storing links in Org-mode."
1340 "Format of the description part of a link to an email or usenet message.
1341 The following %-escapes will be replaced by corresponding information:
1349 %s subject
1350 %d date
1351 %m message-id.
1353 You may use normal field width specification between the % and the letter.
1354 This is for example useful to limit the length of the subject.
1368 It should match if the message is from the user him/herself."
1373 "Non-nil means storing a link to an Org file will use entry IDs.
1375 Note that before this variable is even considered, org-id must be loaded,
1376 so please customize `org-modules' and turn it on.
1378 The variable can have the following values:
1380 t Create an ID if needed to make a link to the current entry.
1382 create-if-interactive
1383 If `org-store-link' is called directly (interactively, as a user
1384 command), do create an ID to support the link. But when doing the
1385 job for remember, only use the ID if it already exists. The
1386 purpose of this setting is to avoid proliferation of unwanted
1387 IDs, just because you happen to be in an Org file when you
1388 call `org-remember' that automatically and preemptively
1389 creates a link. If you do want to get an ID link in a remember
1390 template to an entry not having an ID, create it first by
1391 explicitly creating a link to it, using `C-c C-l' first.
1393 create-if-interactive-and-no-custom-id
1394 Like create-if-interactive, but do not create an ID if there is
1395 a CUSTOM_ID property defined in the entry. This is the default.
1397 use-existing
1398 Use existing ID, do not create one.
1400 nil Never use an ID to make a link, instead link using a text search for
1401 the headline text."
1406 create-if-interactive)
1408 create-if-interactive-and-no-custom-id)
1413 "Non-nil means file links from `org-store-link' contain context.
1414 A search string will be added to the file name with :: as separator and
1415 used to find the context when the link is activated by the command
1416 `org-open-at-point'. When this option is t, the entire active region
1417 will be placed in the search string of the file link. If set to a
1418 positive integer, only the first n lines of context will be stored.
1421 negates this setting for the duration of the command."
1426 "Non-nil means keep link in list for entire session.
1428 The command `org-store-link' adds a link pointing to the current
1429 location to an internal list. These links accumulate during a session.
1430 The command `org-insert-link' can be used to insert links into any
1431 Org-mode file (offering completion for all stored links). When this
1433 will be removed from the list, to make completing the unused links
1434 more efficient."
1439 "Options concerning following links in Org-mode."
1444 "Function to translate links with different syntax to Org syntax.
1445 This can be used to translate links created for example by the Planner
1446 or emacs-wiki packages to Org syntax.
1447 The function must accept two parameters, a TYPE containing the link
1449 which is everything after the link protocol. It should return a cons
1450 with possibly modified values of type and path.
1451 Org contains a function for this, so if you set this variable to
1452 `org-translate-link-from-planner', you should be able follow many
1453 links created by planner."
1458 "Hook that is run after a link has been followed."
1463 "Non-nil means on links TAB will follow the link.
1464 Needs to be set before org.el is loaded.
1465 This really should not be used, it does not make sense, and the
1466 implementation is bad."
1471 "Non-nil means on links RET will follow the link."
1477 "Non-nil means mouse-1 on a link will follow the link.
1478 A longer mouse click will still set point. Does not work on XEmacs.
1479 Needs to be set before org.el is loaded."
1484 "Number of different positions to be recorded in the ring.
1485 Changing this requires a restart of Emacs to work correctly."
1490 "Non-nil means internal links in Org files must exactly match a headline.
1491 When nil, the link search tries to match a phrase with all words
1492 in the search text."
1498 query-to-create)))
1505 "Setup the frame configuration for following links.
1506 When following a link with Emacs, it may often be useful to display
1507 this link in another window or frame. This variable can be used to
1508 set this up for the different types of links.
1509 For VM, use any of
1510 `vm-visit-folder'
1511 `vm-visit-folder-other-window'
1512 `vm-visit-folder-other-frame'
1513 For Gnus, use any of
1514 `gnus'
1515 `gnus-other-frame'
1516 `org-gnus-no-new-news'
1517 For FILE, use any of
1518 `find-file'
1519 `find-file-other-window'
1520 `find-file-other-frame'
1521 For Wanderlust use any of
1522 `wl'
1523 `wl-other-frame'
1524 For the calendar, use the variable `calendar-setup'.
1525 For BBDB, it is currently only possible to display the matches in
1526 another window."
1550 "Non-nil means use indirect buffer to display infile links.
1551 Activating internal links (from one location in a file to another location
1552 in the same file) normally just jumps to the location. When the link is
1554 is displayed in
1555 another window. When this option is set, the other window actually displays
1556 an indirect buffer clone of the current buffer, to avoid any visibility
1557 changes to the current buffer."
1562 "Non-nil means `org-open-file' will open non-existing files.
1563 When nil, an error will be generated.
1564 This variable applies only to external applications because they
1565 might choke on non-existing files. If the link is to a file that
1566 will be opened in Emacs, the variable is ignored."
1571 "Non-nil means a link to a directory really means to index.org.
1572 When nil, following a directory link will run dired or open a finder/explorer
1573 window on that directory."
1578 "Function and arguments to call for following mailto links.
1579 This is a list with the first element being a Lisp function, and the
1580 remaining elements being arguments to the function. In string arguments,
1581 %a will be replaced by the address, and %s will be replaced by the subject
1582 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1591 "Non-nil means ask for confirmation before executing shell links.
1592 Shell links can be dangerous: just think about a link
1594 [[shell:rm -rf ~/*][Google Search]]
1597 but really it would remove your entire home directory.
1598 Therefore we advise against setting this variable to nil.
1599 Just change it to `y-or-n-p' if you want to confirm with a
1607 'safe-local-variable
1611 "A regexp to skip confirmation for shell links."
1616 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1617 Elisp links can be dangerous: just think about a link
1622 but really it would remove your entire home directory.
1623 Therefore we advise against setting this variable to nil.
1624 Just change it to `y-or-n-p' if you want to confirm with a
1632 'safe-local-variable
1636 "A regexp to skip confirmation for Elisp links."
1644 "Default file applications on a UNIX or GNU/Linux system.
1655 "Default file applications on a MacOS X system.
1657 for some files for which the OS does not have a good default.
1665 'mswindows-shell-execute
1670 'mswindows-shell-execute
1673 "Default file applications on a Windows NT system.
1678 '(
1683 )
1684 "External applications for opening `file:path' items in a document.
1685 Org-mode uses system defaults for different file types, but
1686 you can use this variable to set the application for a given file
1687 extension. The entries in this list are cons cells where the car identifies
1688 files and the cdr the corresponding command. Possible values for the
1689 file identifier are
1691 ways, depending on its contents:
1693 - Alphanumeric characters only:
1694 Match links with this file extension.
1696 to open PDFs with evince.
1698 - Regular expression: Match links where the
1699 filename matches the regexp. If you want to
1700 use groups here, use shy groups.
1704 to open *.html and *.xhtml with firefox.
1706 - Regular expression which contains (non-shy) groups:
1708 anything after that, matches the regexp.
1709 In a custom command string, %1, %2, etc. are replaced with
1710 the parts of the link that were matched by the groups.
1711 For backwards compatibility, if a command string is given
1712 that does not use any of the group matches, this case is
1713 handled identically to the second one (i.e. match against
1714 file name only).
1715 In a custom lisp form, you can access the group matches with
1716 (match-string n link).
1719 to open [[file:document.pdf::5]] with evince at page 5.
1721 `directory' Matches a directory
1722 `remote' Matches a remote file, accessible through tramp or efs.
1723 Remote files most likely should be visited through Emacs
1724 because external applications cannot handle such paths.
1725 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1726 so all files Emacs knows how to handle. Using this with
1727 command `emacs' will open most files in Emacs. Beware that this
1728 will also open html files inside Emacs, unless you add
1730 t Default for files not matched by any of the other options.
1731 `system' The system command to open files, like `open' on Windows
1732 and Mac OS X, and mailcap under GNU/Linux. This is the command
1733 that will be selected if you call `C-c C-o' with a double
1736 Possible values for the command are:
1737 `emacs' The file will be visited by the current Emacs process.
1738 `default' Use the default application for this file type, which is the
1739 association for t in the list, most likely in the system-specific
1740 part.
1741 This can be used to overrule an unwanted setting in the
1742 system-specific variable.
1744 This command is specified by the entry whose car is `system'.
1745 Most likely, the system-specific version of this variable
1746 does define this command, but you can overrule/replace it
1747 here.
1748 string A command to be executed by a shell; %s will be replaced
1749 by the path to the file.
1750 sexp A Lisp form which will be evaluated. The file path will
1751 be available in the Lisp variable `file'.
1752 For more examples, see the system specific constants
1753 `org-file-apps-defaults-macosx'
1754 `org-file-apps-defaults-windowsnt'
1755 `org-file-apps-defaults-gnu'."
1765 auto-mode))
1776 "Options concerning refiling entries in Org-mode."
1781 "Directory with org files.
1782 This is just a default location to look for Org files. There is no need
1783 at all to put your files into this directory. It is only used in the
1784 following situations:
1786 1. When a remember template specifies a target file that is not an
1787 absolute path. The path will then be interpreted relative to
1788 `org-directory'
1789 2. When a remember note is filed away in an interactive way (when exiting the
1790 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1791 with `org-directory' as the default path."
1797 "Default target for storing notes.
1798 Used as a fall back file for org-remember.el and org-capture.el, for
1799 templates that do not specify a target file."
1804 file))
1807 "The default interface to be used for `org-goto'.
1808 Allowed values are:
1809 outline The interface shows an outline of the relevant file
1810 and the correct heading is found by moving through
1811 the outline or by searching with incremental search.
1812 outline-path-completion Headlines in the current buffer are offered via
1813 completion. This is the interface also used by
1814 the refile command."
1821 "Maximum target level when running `org-goto' with refile interface."
1826 "Non-nil means store new notes at the beginning of a file or entry.
1827 When nil, new notes will be filed to the end of a file or entry.
1828 This can also be a list with cons cells of regular expressions that
1829 are matched against file names, and values."
1839 "Information to record when a task is refiled.
1841 Possible values are:
1843 nil Don't add anything
1844 time Add a time stamp to the task
1845 note Prompt for a note and add it with template `org-log-note-headings'
1847 This option can also be set with on a per-file-basis with
1849 #+STARTUP: nologrefile
1850 #+STARTUP: logrefile
1851 #+STARTUP: lognoterefile
1853 You can have local logging settings for a subtree by setting the LOGGING
1854 property to one or more of these keywords.
1856 When bulk-refiling from the agenda, the value `note' is forbidden and
1857 will temporarily be changed to `time'."
1867 This is list of cons cells. Each cell contains:
1868 - a specification of the files to be considered, either a list of files,
1869 or a symbol whose function or variable value will be used to retrieve
1870 a file name or a list of file names. If you use `org-agenda-files' for
1871 that, all agenda files will be scanned for targets. Nil means consider
1872 headings in the current buffer.
1873 - A specification of how to find candidate refile targets. This may be
1874 any of:
1876 This tag has to be present in all target headlines, inheritance will
1877 not be considered.
1879 todo keyword.
1881 headlines that are refiling targets.
1882 - a cons cell (:level . N). Any headline of level N is considered a target.
1883 Note that, when `org-odd-levels-only' is set, level corresponds to
1884 order in hierarchy, not to the number of stars.
1885 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1886 Note that, when `org-odd-levels-only' is set, level corresponds to
1887 order in hierarchy, not to the number of stars.
1889 You can set the variable `org-refile-target-verify-function' to a function
1890 to verify each headline found by the simple criteria above.
1892 When this variable is nil, all top-level headlines in the current buffer
1893 are used, equivalent to the value `((nil . (:level . 1))'."
1909 "Function to verify if the headline at point should be a refile target.
1910 The function will be called without arguments, with point at the
1911 beginning of the headline. It should return t and leave point
1912 where it is if the headline is a valid target for refiling.
1914 If the target should not be selected, the function must return nil.
1915 In addition to this, it may move point to a place from where the search
1916 should be continued. For example, the function may decide that the entire
1917 subtree of the current entry should be excluded and move point to the end
1918 of the subtree."
1923 "Non-nil means cache refile targets to speed up the process.
1924 The cache for a particular file will be updated automatically when
1925 the buffer has been killed, or when any of the marker used for flagging
1926 refile targets no longer points at a live buffer.
1927 If you have added new entries to a buffer that might themselves be targets,
1928 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1929 find that easier, `C-u C-u C-u C-c C-w'."
1934 "Non-nil means provide refile targets as paths.
1935 So a level 3 headline will be available as level1/level2/level3.
1937 When the value is `file', also include the file name (without directory)
1938 into the path. In this case, you can also stop the completion after
1939 the file name, to get entries inserted as top level in the file.
1941 When `full-file-path', include the full file path."
1950 "Non-nil means complete the outline path in hierarchical steps.
1951 When Org-mode uses the refile interface to select an outline path
1952 \(see variable `org-refile-use-outline-path'), the completion of
1953 the path can be done is a single go, or if can be done in steps down
1954 the headline hierarchy. Going in steps is probably the best if you
1955 do not use a special completion package like `ido' or `icicles'.
1956 However, when using these packages, going in one step can be very
1957 fast, while still showing the whole path to the entry."
1962 "Non-nil means allow to create new nodes as refile targets.
1964 of an existing node. When the value of this variable is `confirm',
1965 new node creation must be confirmed by the user (recommended)
1966 When nil, the completion must match an existing entry.
1968 Note that, if the new heading is not seen by the criteria
1969 listed in `org-refile-targets', multiple instances of the same
1970 heading would be created by trying again to file under the new
1971 heading."
1979 "Non-nil means also refile active region within a subtree.
1981 By default `org-refile' doesn't allow refiling regions if they
1982 don't contain a set of subtrees, but it might be convenient to
1983 do so sometimes: in that case, the first line of the region is
1984 converted to a headline before refiling."
1989 "Options concerning TODO items in Org-mode."
1994 "Options concerning Progress logging in Org-mode."
2001 "The available interpretation symbols for customizing `org-todo-keywords'.
2005 "List of TODO entry keyword sequences and their interpretation.
2008 Each sequence starts with a symbol, either `sequence' or `type',
2009 indicating if the keywords should be interpreted as a sequence of
2010 action steps, or as different types of TODO items. The first
2011 keywords are states requiring action - these states will select a headline
2012 for inclusion into the global TODO list Org-mode produces. If one of
2015 the last keyword is treated as the only DONE state of the sequence.
2018 additional state where no keyword is present. For details about this
2019 cycling, see the manual.
2021 TODO keywords and interpretation can also be set on a per-file basis with
2022 the special #+SEQ_TODO and #+TYP_TODO lines.
2024 Each keyword can optionally specify a character for fast state selection
2025 \(in combination with the variable `org-use-fast-todo-selection')
2026 and specifiers for state change logging, using the same syntax
2029 indicates to record a time stamp each time this state is selected.
2031 Each keyword may also specify if a timestamp or a note should be
2032 recorded when entering or leaving the state, by adding additional
2033 characters in the parenthesis after the keyword. This looks like this:
2035 record only the time of the state change. With X and Y being either
2037 Y when leaving the state if and only if the *target* state does not
2038 define X. You may omit any of the fast-selection key or X or /Y,
2039 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2041 For backward compatibility, this variable may also be just a list
2042 of keywords - in this case the interpretation (sequence or type) will be
2043 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2053 ;;Quick and dirty way to see
2054 ;;`org-todo-interpretations'. This takes the
2055 ;;place of item arguments
2056 :convert-widget
2063 org-todo-interpretation-widgets))
2064 widget))
2095 "Controls how TODO keywords are interpreted.
2096 This variable is in principle obsolete and is only used for
2097 backward compatibility, if the interpretation of todo keywords is
2098 not given already in `org-todo-keywords'. See that variable for
2099 more information."
2106 "Non-nil means use the fast todo selection scheme with C-c C-t.
2107 This variable describes if and under what circumstances the cycling
2108 mechanism for TODO keywords will be replaced by a single-key, direct
2109 selection scheme.
2111 When nil, fast selection is never used.
2113 When the symbol `prefix', it will be used when `org-todo' is called with
2114 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2115 in an agenda buffer.
2117 When t, fast selection is used by default. In this case, the prefix
2118 argument forces cycling instead.
2120 In all cases, the special interface is only used if access keys have actually
2121 been assigned by the user, i.e. if keywords in the configuration are followed
2122 by a letter in parenthesis, like TODO(t)."
2130 "Non-nil means update todo statistics after insert and toggle.
2131 ALL-HEADLINES means update todo statistics by including headlines
2132 with no TODO keyword as well, counting them as not done.
2133 A list of TODO keywords means the same, but skip keywords that are
2134 not in this list.
2136 When this is set, todo statistics is updated in the parent of the
2137 current entry each time a todo state is changed."
2147 "Non-nil means TODO statistics covers just direct children.
2148 When nil, all entries in the subtree are considered.
2149 This has only an effect if `org-provide-todo-statistics' is set.
2150 To set this to nil for only a single subtree, use a COOKIE_DATA
2156 "Hook which is run after the state of a TODO item was changed.
2157 The new state (a string with a TODO keyword, or nil) is available in the
2158 Lisp variable `state'."
2163 "Hook for functions that are allowed to block a state change.
2165 Each function gets as its single argument a property list, see
2166 `org-trigger-hook' for more information about this list.
2168 If any of the functions in this hook returns nil, the state change
2172 "Hook for functions that are triggered by a state change.
2174 Each function gets as its single argument a property list with at least
2175 the following elements:
2177 (:type type-of-change :position pos-at-entry-start
2178 :from old-state :to new-state)
2180 Depending on the type, more properties may be present.
2182 This mechanism is currently implemented for:
2184 TODO state changes
2185 ------------------
2186 :type todo-state-change
2187 :from previous state (keyword as a string), or nil, or a symbol
2188 'todo' or 'done', to indicate the general type of state.
2192 "Non-nil means undone TODO entries will block switching the parent to DONE.
2193 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2194 be blocked if any prior sibling is not yet done.
2195 Finally, if the parent is blocked because of ordered siblings of its own,
2196 the child will also be blocked.
2197 This variable needs to be set before org.el is loaded, and you need to
2198 restart Emacs after a change to make the change effective. The only way
2199 to change is while Emacs is running is through the customize interface."
2211 "Non-nil means unchecked boxes will block switching the parent to DONE.
2212 When this is nil, checkboxes have no influence on switching TODO states.
2213 When non-nil, you first need to check off all check boxes before the TODO
2214 entry can be switched to DONE.
2215 This variable needs to be set before org.el is loaded, and you need to
2216 restart Emacs after a change to make the change effective. The only way
2217 to change is while Emacs is running is through the customize interface."
2229 "Non-nil means inserting a TODO heading is treated as state change.
2231 logging will apply if appropriate. When nil, the new TODO item will
2232 be inserted directly, and no logging will take place."
2237 "Non-nil means switching TODO states with S-cursor counts as state change.
2238 This is the default behavior. However, setting this to nil allows a
2239 convenient way to select a TODO state and bypass any logging associated
2240 with that."
2245 "Tag changes that should be triggered by TODO state changes.
2246 This is a list. Each entry is
2248 (state-change (tag . flag) .......)
2250 State-change can be a string with a state, and empty string to indicate the
2251 state that has no TODO keyword, or it can be one of the symbols `todo'
2252 or `done', meaning any not-done or done state, respectively."
2266 "Information to record when a task moves to the DONE state.
2268 Possible values are:
2270 nil Don't add anything, just change the keyword
2271 time Add a time stamp to the task
2272 note Prompt for a note and add it with template `org-log-note-headings'
2274 This option can also be set with on a per-file-basis with
2276 #+STARTUP: nologdone
2277 #+STARTUP: logdone
2278 #+STARTUP: lognotedone
2280 You can have local logging settings for a subtree by setting the LOGGING
2281 property to one or more of these keywords."
2289 ;; Normalize old uses of org-log-done.
2296 "Information to record when the scheduling date of a tasks is modified.
2298 Possible values are:
2300 nil Don't add anything, just change the date
2301 time Add a time stamp to the task
2302 note Prompt for a note and add it with template `org-log-note-headings'
2304 This option can also be set with on a per-file-basis with
2306 #+STARTUP: nologreschedule
2307 #+STARTUP: logreschedule
2308 #+STARTUP: lognotereschedule"
2317 "Information to record when the deadline date of a tasks is modified.
2319 Possible values are:
2321 nil Don't add anything, just change the date
2322 time Add a time stamp to the task
2323 note Prompt for a note and add it with template `org-log-note-headings'
2325 This option can also be set with on a per-file-basis with
2327 #+STARTUP: nologredeadline
2328 #+STARTUP: logredeadline
2329 #+STARTUP: lognoteredeadline
2331 You can have local logging settings for a subtree by setting the LOGGING
2332 property to one or more of these keywords."
2341 "Non-nil means record a note when clocking out of an item.
2342 This can also be configured on a per-file basis by adding one of
2343 the following lines anywhere in the buffer:
2345 #+STARTUP: lognoteclock-out
2346 #+STARTUP: nolognoteclock-out"
2352 "Non-nil means the CLOSED time stamp will contain date and time.
2353 When nil, only the date will be recorded."
2367 "Headings for notes added to entries.
2368 The value is an alist, with the car being a symbol indicating the note
2369 context, and the cdr is the heading to be used. The heading may also be the
2370 empty string.
2371 %t in the heading will be replaced by a time stamp.
2372 %T will be an active time stamp instead the default inactive one
2373 %s will be replaced by the new TODO state, in double quotes.
2374 %S will be replaced by the old TODO state, in double quotes.
2375 %u will be replaced by the user name.
2376 %U will be replaced by the full user name.
2378 In fact, it is not a good idea to change the `state' entry, because
2379 agenda log mode depends on the format of these entries."
2385 "Heading when changing todo state (todo sequence only)"
2399 "Non-nil means insert state change notes and time stamps into a drawer.
2400 When nil, state changes notes will be inserted after the headline and
2401 any scheduling and clock lines, but not inside a drawer.
2403 The value of this variable should be the name of the drawer to use.
2404 LOGBOOK is proposed as the default drawer for this purpose, you can
2405 also set this to a string to define the drawer of your choice.
2409 If this variable is set, `org-log-state-notes-insert-after-drawers'
2410 will be ignored.
2412 You can set the property LOG_INTO_DRAWER to overrule this setting for
2413 a subtree."
2425 "Return the value of `org-log-into-drawer', but let properties overrule.
2426 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2427 used instead of the default value."
2435 "Non-nil means insert state change notes after any drawers in entry.
2436 Only the drawers that *immediately* follow the headline and the
2437 deadline/scheduled line are skipped.
2438 When nil, insert notes right after the heading and perhaps the line
2439 with deadline/scheduling if present.
2441 This variable will have no effect if `org-log-into-drawer' is
2442 set."
2448 "Non-nil means the latest state note will be directly after heading.
2449 When nil, the state change notes will be ordered according to time."
2455 "The TODO state to which a repeater should return the repeating task.
2456 By default this is the first task in a TODO sequence, or the previous state
2457 in a TODO_TYP set. But you can specify another task here.
2458 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2464 "Non-nil means record moving through the DONE state when triggering repeat.
2465 An auto-repeating task is immediately switched back to TODO when
2468 record a closing note, there will be no record of the task moving
2469 through DONE. This variable forces taking a note anyway.
2471 nil Don't force a record
2472 time Record a time stamp
2473 note Record a note
2475 This option can also be set with on a per-file-basis with
2477 #+STARTUP: logrepeat
2478 #+STARTUP: lognoterepeat
2479 #+STARTUP: nologrepeat
2481 You can have local logging settings for a subtree by setting the LOGGING
2482 property to one or more of these keywords."
2492 "Priorities in Org-mode."
2497 "Non-nil means priority commands are active.
2498 When nil, these commands will be disabled, so that you never accidentally
2499 set a priority."
2504 "The highest priority of TODO items. A character like ?A, ?B etc.
2505 Must have a smaller ASCII number than `org-lowest-priority'."
2510 "The lowest priority of TODO items. A character like ?A, ?B etc.
2511 Must have a larger ASCII number than `org-highest-priority'."
2516 "The default priority of TODO items.
2517 This is the priority an item gets if no explicit priority is given.
2518 When starting to cycle on an empty priority the first step in the cycle
2519 depends on `org-priority-start-cycle-with-default'. The resulting first
2520 step priority must not exceed the range from `org-highest-priority' to
2521 `org-lowest-priority' which means that `org-default-priority' has to be
2522 in this range exclusive or inclusive the range boundaries. Else the
2523 first step refuses to set the default and the second will fall back
2524 to (depending on the command used) the highest or lowest priority."
2529 "Non-nil means start with default priority when starting to cycle.
2530 When this is nil, the first step in the cycle will be (depending on the
2531 command used) one higher or lower than the default priority.
2532 See also `org-default-priority'."
2537 "Function to extract the priority from a string.
2538 The string is normally the headline. If this is nil Org computes the
2539 priority from the priority cookie like [#A] in the headline. It returns
2540 an integer, increasing by 1000 for each priority level.
2541 The user can set a different function here, which should take a string
2542 as an argument and return the numeric priority."
2547 "Options concerning time stamps and deadlines in Org-mode."
2552 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2553 When nil, these labeled time stamps are forces into the second line of an
2554 entry, just after the headline. When scheduling from the global TODO list,
2555 the time stamp will always be forced into the second line."
2560 "Formats for `format-time-string' which are used for time stamps.
2564 "Number of minutes to round time stamps to.
2565 These are two values, the first applies when first creating a time stamp.
2566 The second applies when changing it with the commands `S-up' and `S-down'.
2567 When changing the time stamp, this means that it will change in steps
2568 of N minutes, as given by the second value.
2570 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2571 numbers should be factors of 60, so for example 5, 10, 15.
2573 When this is larger than 1, you can still force an exact time stamp by using
2574 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2575 and by using a prefix arg to `S-up/down' to specify the exact number
2576 of minutes to shift."
2586 ;; Normalize old customizations of this variable.
2590 org-time-stamp-rounding-minutes)))
2593 "Non-nil means overlay custom formats over all time stamps.
2594 The formats are defined through the variable `org-time-stamp-custom-formats'.
2595 To turn this on on a per-file basis, insert anywhere in the file:
2596 #+STARTUP: customtime"
2604 "Custom formats for time stamps. See `format-time-string' for the syntax.
2605 These are overlayed over the default ISO format if the variable
2606 `org-display-custom-times' is set. Time like %H:%M should be at the
2607 end of the second format. The custom formats are also honored by export
2608 commands, if custom time display is turned on at the time of export."
2613 "Get the right format for a time string."
2618 f)))
2621 "The format string used when creating CLOCKSUM lines.
2622 This is also used when org-mode generates a time duration."
2628 org-mode generates a time duration."
2633 "The format string used when creating CLOCKSUM lines, or when
2634 org-mode generates a time duration."
2639 "No. of days before expiration during which a deadline becomes active.
2640 This variable governs the display in sparse trees and in the agenda.
2641 When 0 or negative, it means use this number (the absolute value of it)
2642 even if a deadline has a different individual lead time specified.
2644 Custom commands can set this variable in the options section."
2650 "Non-nil means assume future for incomplete date input from user.
2651 This affects the following situations:
2652 1. The user gives a month but not a year.
2655 2. The user gives a day, but no month.
2658 it will be considered as *this* month.
2660 If you set this variable to the symbol `time', then also the following
2661 will work:
2663 3. If the user gives a time, but no day. If the time is before now,
2664 to will be interpreted as tomorrow.
2666 Currently none of this works for ISO week specifications.
2668 When this option is nil, the current day, month and year will always be
2669 used as defaults.
2671 See also `org-agenda-jump-prefer-future'."
2679 "Should the agenda jump command prefer the future for incomplete dates?
2680 The default is to do the same as configured in `org-read-date-prefer-future'.
2681 But you can also set a deviating value here.
2682 This may t or nil, or the symbol `org-read-date-prefer-future'."
2687 org-read-date-prefer-future)
2692 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2694 Depending on the system Emacs is running on, certain dates cannot
2695 be represented with the type used internally to represent time.
2696 Dates between 1970-1-1 and 2038-1-1 can always be represented
2697 correctly. Some systems allow for earlier dates, some for later,
2698 some for both. One way to find out it to insert any date into an
2699 Org buffer, putting the cursor on the year and hitting S-up and
2700 S-down to test the range.
2702 When this variable is set to t, the date/time prompt will not let
2703 you specify dates outside the 1970-2037 range, so it is certain that
2704 these dates will work in whatever version of Emacs you are
2705 running, and also that you can move a file from one Emacs implementation
2706 to another. WHenever Org is forcing the year for you, it will display
2707 a message and beep.
2709 When this variable is nil, Org will check if the date is
2710 representable in the specific Emacs implementation you are using.
2711 If not, it will force a year, usually the current year, and beep
2712 to remind you. Currently this setting is not recommended because
2713 the likelihood that you will open your Org files in an Emacs that
2714 has limited date range is not negligible.
2716 A workaround for this problem is to use diary sexp dates for time
2717 stamps outside of this range."
2722 "Non-nil means display current interpretation of date prompt live.
2723 This display will be in an overlay, in the minibuffer."
2728 "Non-nil means pop up a calendar when prompting for a date.
2729 In the calendar, the date can be selected with mouse-1. However, the
2730 minibuffer will also be active, and you can simply enter the date as well.
2731 When nil, only the minibuffer will be available."
2739 "Hook to be used to set up keys for the date/time interface.
2740 Add key definitions to `minibuffer-local-map', which will be a temporary
2741 copy."
2746 "The hour when your day really ends. Must be an integer.
2747 This has influence for the following applications:
2749 the time given here, the day recognized as TODAY is actually yesterday.
2750 - When a date is read from the user and it is still before the time given
2751 here, the current date and time will be assumed to be yesterday, 23:59.
2752 Also, timestamps inserted in remember templates follow this rule.
2754 IMPORTANT: This is a feature whose implementation is and likely will
2755 remain incomplete. Really, it is only here because past midnight seems to
2756 be the favorite working time of John Wiegley :-)"
2761 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2762 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2764 23:59 of the previous day."
2769 "Non-nil means S-down will increase the time in a time stamp.
2770 When nil, S-up will increase."
2775 "Non-nil means make the calendar window follow timestamp changes.
2776 When a timestamp is modified and the calendar window is visible, it will be
2777 moved to the new date."
2782 "Options concerning tags in Org-mode."
2787 "List of tags allowed in Org-mode files.
2788 When this list is nil, Org-mode will base TAG input on what is already in the
2789 buffer.
2790 The value of this variable is an alist, the car of each entry must be a
2791 keyword as a string, the cdr may be a character that is used to select
2792 that tag through the fast-tag-selection interface.
2793 See the manual for details."
2808 "List of tags that will always appear in all Org-mode files.
2809 This is in addition to any in buffer settings or customizations
2810 of `org-tag-alist'.
2811 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2812 The value of this variable is an alist, the car of each entry must be a
2813 keyword as a string, the cdr may be a character that is used to select
2814 that tag through the fast-tag-selection interface.
2815 See the manual for details.
2816 To disable these tags on a per-file basis, insert anywhere in the file:
2817 #+STARTUP: noptag"
2828 "If non-nil, always offer completion for all tags of all agenda files.
2829 Instead of customizing this variable directly, you might want to
2830 set it locally for capture buffers, because there no list of
2831 tags in that file can be created dynamically (there are none).
2833 (add-hook 'org-capture-mode-hook
2834 (lambda ()
2835 (set (make-local-variable
2836 'org-complete-tags-always-offer-all-agenda-tags)
2837 t)))"
2842 "List of tags that can be inherited by all entries in the file.
2843 The tags will be inherited if the variable `org-use-tag-inheritance'
2844 says they should be.
2848 "Non-nil means use fast tag selection scheme.
2849 This is a special interface to select and deselect tags with single keys.
2850 When nil, fast selection is never used.
2851 When the symbol `auto', fast selection is used if and only if selection
2852 characters for tags have been configured, either through the variable
2853 `org-tag-alist' or through a #+TAGS line in the buffer.
2854 When t, fast selection is always used and selection keys are assigned
2855 automatically if necessary."
2863 "Non-nil means fast tag selection exits after first change.
2864 When nil, you have to press RET to exit it.
2865 During fast tag selection, you can toggle this flag with `C-c'.
2866 This variable can also have the value `expert'. In this case, the window
2867 displaying the tags menu is not even shown, until you press C-c again."
2875 "Non-nil means fast tags selection interface will also offer TODO states.
2879 "The column to which tags should be indented in a headline.
2880 If this number is positive, it specifies the column. If it is negative,
2881 it means that the tags should be flushright to that column. For example,
2882 -80 works well for a normal 80 character screen."
2887 "Non-nil keeps tags aligned when modifying headlines.
2888 Some operations (i.e. demoting) change the length of a headline and
2889 therefore shift the tags around. With this option turned on, after
2890 each such operation the tags are again aligned to `org-tags-column'."
2895 "Non-nil means tags in levels apply also for sublevels.
2896 When nil, only the tags directly given in a specific line apply there.
2897 This may also be a list of tags that should be inherited, or a regexp that
2898 matches tags that should be inherited. Additional control is possible
2899 with the variable `org-tags-exclude-from-inheritance' which gives an
2900 explicit list of tags to be excluded from inheritance., even if the value of
2901 `org-use-tag-inheritance' would select it for inheritance.
2903 If this option is t, a match early-on in a tree can lead to a large
2904 number of matches in the subtree when constructing the agenda or creating
2905 a sparse tree. If you only want to see the first match in a tree during
2906 a search, check out the variable `org-tags-match-list-sublevels'."
2915 "List of tags that should never be inherited.
2916 This is a way to exclude a few tags from inheritance. For way to do
2917 the opposite, to actively allow inheritance for selected tags,
2918 see the variable `org-use-tag-inheritance'."
2923 "Check if TAG is one that should be inherited."
2935 "Non-nil means list also sublevels of headlines matching a search.
2936 This variable applies to tags/property searches, and also to stuck
2937 projects because this search is based on a tags match as well.
2939 When set to the symbol `indented', sublevels are indented with
2940 leading dots.
2942 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2943 the sublevels of a headline matching a tag search often also match
2944 the same search. Listing all of them can create very long lists.
2945 Setting this variable to nil causes subtrees of a match to be skipped.
2947 This variable is semi-obsolete and probably should always be true. It
2948 is better to limit inheritance to certain tags using the variables
2949 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2957 "When set, tags are sorted using this function as a comparator."
2973 "Options concerning properties in Org-mode."
2978 "How property key/value pairs should be formatted by `indent-line'.
2979 When `indent-line' hits a property definition, it will format the line
2980 according to this format, mainly to make sure that the values are
2981 lined-up with respect to each other."
2986 "Alist of properties and functions to adjust inserted values.
2987 Elements of this alist must be of the form
2989 ([string] [function])
2991 where [string] must be a property name and [function] must be a
2992 lambda expression: this lambda expression must take one argument,
2993 the value to adjust, and return the new value as a string.
2997 and the clock summary:
3000 (let ((clocksum (org-clock-sum-current-item))
3001 (effort (org-duration-string-to-minutes
3003 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3008 "Non-nil means properties apply also for sublevels.
3010 This setting is chiefly used during property searches. Turning it on can
3011 cause significant overhead when doing a search, which is why it is not
3012 on by default.
3014 When nil, only the properties directly given in the current entry count.
3015 When t, every property is inherited. The value may also be a list of
3016 properties that should have inheritance, or a regular expression matching
3017 properties that should be inherited.
3019 However, note that some special properties use inheritance under special
3020 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3022 for valid values of a property.
3024 Note for programmers:
3025 When querying an entry with `org-entry-get', you can control if inheritance
3026 should be used. By default, `org-entry-get' looks only at the local
3027 properties. You can request inheritance by setting the inherit argument
3028 to t (to force inheritance) or to `selective' (to respect the setting
3029 in this variable)."
3038 "Check if PROPERTY is one that should be inherited."
3049 "The default column format, if no other format has been defined.
3050 This variable can be set on the per-file basis by inserting a line
3052 #+COLUMNS: %25ITEM ....."
3057 "The ellipses to be used when a field in column view is truncated.
3058 When this is the empty string, as many characters as possible are shown,
3059 but then there will be no visual indication that the field has been truncated.
3060 When this is a string of length N, the last N characters of a truncated
3061 field are replaced by this string. If the column is narrower than the
3062 ellipses string, only part of the ellipses string will be shown."
3067 "Function that modifies values for display in column view.
3068 For example, it can be used to cut out a certain part from a time stamp.
3069 The function must take 2 arguments:
3071 column-title The title of the column (*not* the property name)
3072 value The value that should be modified.
3074 The function should return the value that should be displayed,
3075 or nil if the normal value should be used."
3080 "The property that is being used to keep track of effort estimates.
3081 Effort estimates given in this property need to have the format H:MM."
3089 "List of property/value pairs that can be inherited by any entry.
3091 These are fixed values, for the preset properties. The user variable
3092 that can be used to add to this list is `org-global-properties'.
3094 The entries in this list are cons cells where the car is a property
3095 name and cdr is a string with the value. If the value represents
3100 "List of property/value pairs that can be inherited by any entry.
3102 This list will be combined with the constant `org-global-properties-fixed'.
3104 The entries in this list are cons cells where the car is a property
3105 name and cdr is a string with the value.
3107 You can set buffer-local values for the same purpose in the variable
3108 `org-file-properties' this by adding lines like
3110 #+PROPERTY: NAME VALUE"
3117 "List of property/value pairs that can be inherited by any entry.
3118 Valid for the current buffer.
3123 "Options concerning agenda views in Org-mode."
3128 "Variable used by org files to set a category for agenda display.
3129 Such files should use a file variable to set it, for example
3133 or contain a special line
3135 #+CATEGORY: ELisp
3137 If the file does not specify a category, then file's base name
3143 "The files to be used for agenda display.
3147 If an entry is a directory, all files in that directory that are matched by
3148 `org-agenda-file-regexp' will be part of the file list.
3150 If the value of the variable is not a list but a single file name, then
3151 the list of agenda files is actually stored and maintained in that file, one
3152 agenda file per line. In this file paths can be given relative to
3153 `org-directory'. Tilde expansion and environment variable substitution
3154 are also made."
3161 "Regular expression to match files for `org-agenda-files'.
3162 If any element in the list in that variable contains a directory instead
3163 of a normal file, all files in that directory that are matched by this
3164 regular expression will be included."
3169 "List of extra files to be searched by text search commands.
3170 These files will be search in addition to the agenda files by the
3171 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3172 Note that these files will only be searched for text search commands,
3173 not for the other agenda views like todo lists, tag searches or the weekly
3174 agenda. This variable is intended to list notes and possibly archive files
3175 that should also be searched by these two commands.
3176 In fact, if the first element in the list is the symbol `agenda-archives',
3177 than all archive files of all agenda files will be added to the search
3178 scope."
3189 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3190 A nil value means to remove them, after a query, from the list."
3195 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3196 The command `org-calendar-goto-agenda' will be bound to this key. The
3197 default is the character `c' because then `c' can be used to switch back and
3198 forth between agenda and calendar."
3203 "The key to be installed in `calendar-mode-map' for agenda-action.
3204 The command `org-agenda-action' will be bound to this key. The
3205 default is the character `k' because we use the same key in the agenda."
3210 "The key to be installed in `calendar-mode-map' for adding diary entries.
3211 This option is irrelevant until `org-agenda-diary-file' has been configured
3212 to point to an Org-mode file. When that is the case, the command
3213 `org-agenda-diary-entry' will be bound to the key given here, by default
3214 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3215 if you want to continue doing this, you need to change this to a different
3216 key."
3221 "File to which to add new entries with the `i' key in agenda and calendar.
3222 When this is the symbol `diary-file', the functionality in the Emacs
3223 calendar will be used to add entries to the `diary-file'. But when this
3224 points to a file, `org-agenda-diary-entry' will be used instead."
3240 org-calendar-insert-diary-entry-key
3244 "Options for embedding LaTeX code into Org-mode."
3252 "Options for creating images from LaTeX fragments.
3253 This is a property list with the following properties:
3255 `default' means use the foreground of the default face.
3257 `default' means use the background of the default face.
3258 :scale a scaling factor for the size of the images, to get more pixels
3259 :html-foreground, :html-background, :html-scale
3260 the same numbers for HTML export.
3261 :matchers a list indicating which matchers should be used to
3262 find LaTeX fragments. Valid members of this list are:
3273 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3274 When nil, just push out a message."
3283 \[PACKAGES]
3284 \[DEFAULT-PACKAGES]
3285 % The settings below are copied from fullpage.sty
3298 "The document header used for processing LaTeX fragments.
3299 It is imperative that this header make sure that no page number
3300 appears on the page. The package defined in the variables
3301 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3303 will be appended."
3310 "Set the packages alist and make sure it has 3 elements per entry."
3314 x))
3315 val)))
3319 "Get the packages alist and make sure it has 3 elements per entry."
3323 x))
3326 ;; The following variables are defined here because is it also used
3327 ;; when formatting latex fragments. Originally it was part of the
3328 ;; LaTeX exporter, which is why the name includes "export".
3345 )
3346 "Alist of default packages to be inserted in the header.
3347 Change this only if one of the packages here causes an incompatibility
3348 with another package you are using.
3349 The packages in this list are needed by one part or another of Org-mode
3350 to function properly.
3352 - inputenc, fontenc: for basic font and character selection
3353 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3354 for interpreting the entities in `org-entities'. You can skip some of these
3355 packages if you don't use any of the symbols in it.
3356 - graphicx: for including images
3357 - float, wrapfig: for figure placement
3358 - longtable: for long tables
3359 - hyperref: for cross references
3361 Therefore you should not modify this variable unless you know what you
3362 are doing. The one reason to change it anyway is that you might be loading
3363 some other package that conflicts with one of the default packages.
3365 If SNIPPET-FLAG is t, the package also needs to be included when
3366 compiling LaTeX snippets into images for inclusion into HTML."
3379 "Alist of packages to be inserted in every LaTeX header.
3380 These will be inserted after `org-export-latex-default-packages-alist'.
3382 SNIPPET-FLAG, when t, indicates that this package is also needed when
3383 turning LaTeX snippets into images for inclusion into HTML.
3384 Make sure that you only list packages here which:
3385 - you want in every file
3386 - do not conflict with the default packages in
3387 `org-export-latex-default-packages-alist'
3388 - do not conflict with the setup in `org-format-latex-header'."
3402 "Settings for Org-mode appearance."
3407 "Non-nil means fontify only the stars in each headline.
3408 When nil, the entire headline is fontified.
3409 Changing it requires restart of `font-lock-mode' to become effective
3410 also in regions already fontified."
3415 "Non-nil means hide the first N-1 stars in a headline.
3416 This works by using the face `org-hide' for these stars. This
3417 face is white for a light background, and black for a dark
3418 background. You may have to customize the face `org-hide' to
3419 make this work.
3420 Changing it requires restart of `font-lock-mode' to become effective
3421 also in regions already fontified.
3422 You may also set this on a per-file basis by adding one of the following
3423 lines to the buffer:
3425 #+STARTUP: hidestars
3426 #+STARTUP: showstars"
3431 "List of symbols corresponding to keywords to be hidden the org buffer.
3432 For example, a value '(title) for this list will make the document's title
3433 appear in the buffer without the initial #+TITLE: keyword."
3441 "Non-nil means change the face of a headline if it is marked DONE.
3442 Normally, only the TODO/DONE keyword indicates the state of a headline.
3443 When this is non-nil, the headline after the keyword is set to the
3444 `org-headline-done' as an additional indication."
3449 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3450 Changing this variable requires a restart of Emacs to take effect."
3455 "Non-nil means fontify the whole line for headings.
3456 This is useful when setting a background color for the
3457 org-level-* faces."
3462 "Non-nil means fontify what is treated specially by the exporters."
3467 "Non-nil mean font-lock should hide the emphasis marker characters."
3472 "Non-nil means show entities as UTF8 characters.
3478 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3483 "Regular expression for matching emphasis.
3484 After a match, the match groups contain these elements:
3485 0 The match of the full regular expression, including the characters
3486 before and after the proper match
3487 1 The character before the proper match, or empty at beginning of line
3488 2 The proper match, including the leading and trailing markers
3489 3 The leading marker like * or /, indicating the type of highlighting
3490 4 The text between the emphasis markers, not including the markers
3497 "Set variable and compute the emphasis regular expression."
3501 org-emphasis-alist org-emphasis-regexp-components)
3513 ;; make sure special characters appear at the right position in the class
3525 ;; Make the regexp
3533 body1
3545 body1
3553 "Components used to build the regular expression for emphasis.
3554 This is a list with five entries. Terminology: In an emphasis string
3558 specify what is allowed/forbidden in each part:
3560 pre Chars allowed as prematch. Beginning of line will be allowed too.
3561 post Chars allowed as postmatch. End of line will be allowed too.
3562 border The chars *forbidden* as border characters.
3564 non-shy groups here, and don't allow newline here.
3565 newline The maximum number of newlines allowed in an emphasis exp.
3567 Use customize to modify this, or restart Emacs after changing it."
3586 )
3587 "Special syntax for emphasized text.
3588 Text starting and ending with a special character will be emphasized, for
3589 example *bold*, _underlined_ and /italic/. This variable sets the marker
3590 characters, the face to be used by font-lock for highlighting in Org-mode
3591 Emacs buffers, and the HTML tags to be used for this.
3592 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3593 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3594 Use customize to modify this, or restart Emacs after changing it."
3609 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3612 ;;; Miscellaneous options
3615 "Completion in Org-mode."
3620 "Non-nil means use ido completion wherever possible.
3621 Note that `ido-mode' must be active for this variable to be relevant.
3622 If you decide to turn this variable on, you might well want to turn off
3623 `org-outline-path-complete-in-steps'.
3624 See also `org-completion-use-iswitchb'."
3629 "Non-nil means use iswitchb completion wherever possible.
3630 Note that `iswitchb-mode' must be active for this variable to be relevant.
3631 If you decide to turn this variable on, you might well want to turn off
3632 `org-outline-path-complete-in-steps'.
3633 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3639 Normal means, no org-mode-specific context."
3643 ;;; Functions and variables from their packages
3644 ;; Declared here to avoid compiler warnings
3646 ;; XEmacs only
3652 ;; Emacs only
3655 ;; Various packages
3673 org-format-agenda-item "org-agenda"
3704 ;;; Autoload and prepare some org modules
3706 ;; Some table stuff that needs to be defined here, because it is used
3707 ;; by the functions setting up org-mode or checking for table context.
3720 "Detect the first line outside a table when searching from within it.
3723 ;; Autoload the functions in org-table.el that are needed by functions here.
3728 org-table-convert org-table-convert-region org-table-copy-down
3729 org-table-copy-region org-table-create
3730 org-table-create-or-convert-from-region
3731 org-table-create-with-table.el org-table-current-dline
3732 org-table-cut-region org-table-delete-column org-table-edit-field
3733 org-table-edit-formulas org-table-end org-table-eval-formula
3734 org-table-export org-table-field-info
3735 org-table-get-stored-formulas org-table-goto-column
3736 org-table-hline-and-move org-table-import org-table-insert-column
3737 org-table-insert-hline org-table-insert-row org-table-iterate
3738 org-table-justify-field-maybe org-table-kill-row
3739 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3740 org-table-move-column org-table-move-column-left
3741 org-table-move-column-right org-table-move-row
3742 org-table-move-row-down org-table-move-row-up
3743 org-table-next-field org-table-next-row org-table-paste-rectangle
3744 org-table-previous-field org-table-recalculate
3745 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3746 org-table-toggle-coordinate-overlays
3747 org-table-toggle-formula-debugger org-table-wrap-region
3748 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3749 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3750 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3753 "Return t if the cursor is inside an org-type table.
3754 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3759 org-table-line-regexp)))
3760 nil))
3764 "Return t if and only if we are at a table.el table."
3770 "If there is a table.el table nearby, recognize it and move into it."
3776 nil
3786 t
3791 t)
3792 nil)
3793 nil))
3796 "Return t if the cursor is inside a hline in a table."
3801 nil))
3806 "Apply FUNCTION to the start of all tables in the buffer."
3822 ;; Declare and autoload functions from org-exp.el & Co
3830 org-insert-export-options-template
3831 org-table-clean-before-export))
3834 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3835 org-export-region-as-ascii))
3838 org-replace-region-by-latex org-export-region-as-latex
3839 org-export-as-latex org-export-as-pdf
3840 org-export-as-pdf-and-open))
3843 org-export-as-html-batch org-export-as-html-to-buffer
3844 org-replace-region-by-html org-export-region-as-html
3845 org-export-as-html))
3848 org-replace-region-by-docbook org-export-region-as-docbook
3849 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3850 org-export-as-docbook))
3853 org-export-icalendar-all-agenda-files
3854 org-export-icalendar-combine-agenda-files))
3858 ;; Declare and autoload functions from org-agenda.el
3863 org-todo-list org-tags-view org-agenda-list-stuck-projects
3864 org-diary org-agenda-to-appt
3865 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3867 ;; Autoload org-remember
3872 org-remember-apply-template org-remember org-remember-handler)))
3877 org-capture-import-remember-templates)))
3879 ;; Autoload org-clock.el
3894 "Return non-nil if clock is currently running.
3895 The return value is actually the clock marker."
3900 "org-clock"
3902 org-clock-goto org-clock-sum org-clock-display
3903 org-clock-remove-overlays org-clock-report
3904 org-clocktable-shift org-dblock-write:clocktable
3905 org-get-clocktable org-resolve-clocks)))
3908 "If this is a CLOCK line, update it and return t.
3909 Otherwise, return nil."
3918 ts te h m s neg)
3921 nil)
3926 ;; The clock is running here
3947 t))))))
3950 "Check if the current buffer contains the running clock.
3951 If yes, offer to stop it and to save the buffer with the changes."
3960 "Check if this line starts a clock table, if yes, shift the time block."
3964 ;; Autoload org-timer.el
3968 "org-timer"
3970 org-timer-change-times-in-region
3971 org-timer-set-timer
3972 org-timer-reset-timers
3973 org-timer-show-remaining-time)))
3975 ;; Autoload org-feed.el
3979 "org-feed"
3983 ;; Autoload org-indent.el
3985 ;; Define the variable already here, to make sure we have it.
3987 "Non-nil if Org-Indent mode is enabled.
3992 "org-indent"
3995 ;; Autoload org-mobile.el
3999 "org-mobile"
4002 ;; Autoload archiving code
4003 ;; The stuff that is needed for cycling and tags has to be defined here.
4006 "Options concerning archiving in Org-mode."
4011 "The location where subtrees should be archived.
4013 The value of this variable is a string, consisting of two parts,
4014 separated by a double-colon. The first part is a filename and
4015 the second part is a headline.
4017 When the filename is omitted, archiving happens in the same file.
4018 %s in the filename will be replaced by the current file
4019 name (without the directory part). Archiving to a different file
4020 is useful to keep archived entries from contributing to the
4021 Org-mode Agenda.
4023 The archived entries will be filed as subtrees of the specified
4024 headline. When the headline is omitted, the subtrees are simply
4025 filed away at the end of the file, as top-level entries. Also in
4026 the heading you can use %s to represent the file name, this can be
4027 useful when using the same archive for a number of different files.
4029 Here are a few examples:
4031 If the current file is Projects.org, archive in file
4032 Projects.org_archive, as top-level trees. This is the default.
4035 Archive in the current file, under the top-level headline
4039 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4042 Archive in file ~/org/archive.org (absolute path), under headlines
4046 Archive in file ./basement (relative path), as level 3 trees
4049 You may set this option on a per-file basis by adding to the buffer a
4050 line like
4052 #+ARCHIVE: basement::** Finished Tasks
4054 You may also define it locally for a subtree by setting an ARCHIVE property
4055 in the entry. If such a property is found in an entry, or anywhere up
4056 the hierarchy, it will be used."
4061 "The tag that marks a subtree as archived.
4062 An archived subtree does not open during visibility cycling, and does
4063 not contribute to the agenda listings.
4064 After changing this, font-lock must be restarted in the relevant buffers to
4065 get the proper fontification."
4071 "Non-nil means the agenda will skip any items located in archived trees.
4072 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4073 variable is no longer recommended, you should leave it at the value t.
4074 Instead, use the key `v' to cycle the archives-mode in the agenda."
4080 "Non-nil means ignore archived trees when creating column view."
4086 "Non-nil means `org-cycle' will open archived trees.
4087 An archived tree is a tree marked with the tag ARCHIVE.
4088 When nil, archived trees will stay folded. You can still open them with
4089 normal outline commands like `show-all', but not with the cycling commands."
4095 "Non-nil means sparse tree construction shows matches in archived trees.
4096 When nil, matches in these trees are highlighted, but the trees are kept in
4097 collapsed state."
4103 "Re-hide all archived subtrees after a visibility state change."
4114 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4117 "Cycle subtree even if it is archived."
4124 "Re-hide all archived subtrees after a visibility state change."
4139 flag)))
4146 org-archive-to-archive-sibling org-toggle-archive-tag
4147 org-archive-subtree-default
4148 org-archive-subtree-default-with-confirmation)))
4150 ;; Autoload Column View Code
4158 org-columns-compute org-agenda-columns org-columns-remove-overlays
4161 ;; Autoload ID code
4169 org-id-get-with-outline-path-completion
4170 org-id-get-with-outline-drilling org-id-store-link
4171 org-id-goto org-id-find org-id-store-link))
4173 ;; Autoload Plotting Code
4178 ;;; Variables for pre-computed regular expressions, all buffer local
4196 "Matches a headline and puts everything into groups:
4197 group 1: the stars
4198 group 2: The todo keyword, maybe
4199 group 3: Priority cookie
4200 group 4: True headline
4204 "Printf format to make regexp to match an exact headline.
4205 This regexp will match the headline of any node which hase the exact
4206 headline text that is put into the format, but may have any TODO state,
4210 "Matches a headline and puts TODO state into group 2 if present.
4265 "Regular expression to match a plain time or time range.
4266 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4267 groups carry important information:
4268 0 the full match
4269 1 the first time, range or not
4277 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4278 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4279 groups carry important information:
4280 0 the full match
4281 7 hours of duration
4290 "Regular expression to match a timestamp time or time range.
4291 After a match, the following groups carry important information:
4292 0 the full match
4293 1 date plus weekday, for back referencing to make sure both times are on the same day
4294 2 the first time, range or not
4349 "Variable associated with STARTUP options for org-mode.
4350 Each element is a list of three items: The startup options as written
4351 in the #+STARTUP line, the corresponding variable, and the value to
4352 set this variable to if the option is found. An optional forth element PUSH
4356 "Precompute regular expressions for current buffer."
4376 kwds kws0 kwsa key log value cat arch tags const links hw dws
4377 tail sep kws1 prio props ftags drawers beamer-p
4399 ;; general TODO-like setup
4411 links)))
4417 props)))
4422 ftags
4432 l var val)
4462 ))))
4479 ;; Process the TODO keywords
4481 ;; Use the global values as if they had been given locally.
4493 kws)))
4496 kwsa nil
4499 ;; 1 2
4507 kw)
4509 kws0)
4526 ;; Process the constants
4534 ;; Process the tags.
4545 tgs))
4553 ;; Compute the regular expressions and other local variables
4561 org-drawer-regexp
4565 org-not-done-keywords
4567 org-todo-regexp
4570 org-not-done-regexp
4574 org-not-done-heading-regexp
4578 org-todo-line-regexp
4582 org-complex-heading-regexp
4589 org-complex-heading-regexp-format
4598 org-nl-done-regexp
4602 org-todo-line-tags-regexp
4607 org-looking-at-done-regexp
4612 org-deadline-time-regexp
4614 org-deadline-line-regexp
4616 org-scheduled-regexp
4618 org-scheduled-time-regexp
4620 org-closed-time-regexp
4622 org-keyword-time-regexp
4628 org-keyword-time-not-clock-regexp
4634 org-maybe-keyword-time-regexp
4640 org-planning-or-clock-line-re
4645 org-all-time-keywords
4648 org-clock-string org-closed-string))
4649 )
4654 "Return the contents of FILE, as a string."
4668 "Extract the log state setting from a TODO keyword string.
4682 "Remove a pair of parenthesis at the end of each string in LIST."
4686 x))
4687 list))
4690 "Assign fast keys to a keyword-key alist.
4691 Respect keys that are already there."
4709 ;;; Some variables used in various places
4716 "Function to be called when `C-c C-c' is used.
4720 ;; FIXME: Occasionally check by commenting these, to make sure
4721 ;; no other functions uses these, forgetting to let-bind them.
4726 ;; Defined somewhere in this file, but used before definition.
4732 ;;;; Define the Org-mode
4735 (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"))
4738 ;; We use a before-change function to check if a table might need
4739 ;; an update.
4741 "Indicates that a table might need an update.
4742 This variable is set by `org-before-change-function'.
4745 "Every change indicates that a table might need an update."
4755 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4756 ;; some places -- e.g. see the macro org-with-limited-levels.
4757 ;;
4758 ;; In Org buffers, the value of `outline-regexp' is that of
4759 ;; `org-outline-regexp'. The only function still directly relying on
4760 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4761 ;; job when `orgstruct-mode' is active.
4765 "Regexp to match Org headlines.
4766 This is similar to `org-outline-regexp' but additionally makes
4769 ;;;###autoload
4771 "Outline-based notes management and organizer, alias
4774 Org-mode develops organizational tasks around a NOTES file which
4775 contains information about projects as plain text. Org-mode is
4776 implemented on top of outline-mode, which is ideal to keep the content
4777 of large files well structured. It supports ToDo items, deadlines and
4778 time stamps, which magically appear in the diary listing of the Emacs
4779 calendar. Tables are easily created with a built-in table editor.
4780 Plain text URL-like links connect to websites, emails (VM), Usenet
4781 messages (Gnus), BBDB entries, and any files related to the project.
4782 For printing and sharing of notes, an Org-mode file (or a part of it)
4783 can be exported as a structured ASCII or HTML file.
4785 The following commands are available:
4789 ;; Get rid of Outline menus, they are not needed
4790 ;; Need to do this here because define-derived-mode sets up
4791 ;; the keymap so late. Still, it is a waste to call this each time
4792 ;; we switch another buffer into org-mode.
4795 ;; Assume this is Greg's port, it uses easymenu
4820 org-display-table 4
4823 org-ellipsis)))
4828 ;; tag faces set outside customize.... force initialization.
4830 ;; Calc embedded
4836 ;; Activate before-change-function
4840 ;; Check for running clock before killing a buffer
4842 ;; Paragraphs and auto-filling
4846 ;; Beginning/end of defun
4849 ;; Next error for sparse trees
4851 ;; Make sure dependence stuff works reliably, even for users who set it
4852 ;; too late :-(
4864 ;; Comment characters
4868 ;; Align options lines
4870 'align-mode-rules-list
4875 ;; Imenu
4879 ;; Make isearch reveal context
4882 ;; Emacs 21 and XEmacs make use of the hook
4884 ;; Emacs 22 deals with this through a special variable
4888 ;; Turn on org-beamer-mode?
4891 ;; Setup the pcomplete hooks
4904 ;; If empty file that did not turn on org-mode automatically, make it to.
4929 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4939 "Return today date, considering `org-extend-today-until'."
4944 ;;;; Font-Lock stuff, including the activators
4975 "Regular expression used to analyze links.
4976 Here is what the match groups contain after a match:
4977 1: http:
4978 2: http
4979 3: path
4980 4: [desc]
4988 "Number of stacked braces for sub/superscript matching.
4989 This has to be set before loading org.el to be effective."
4994 "Create a regular expression which will match a balanced sexp.
4995 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4996 as single character strings.
4997 The regexp returned will match the entire expression including the
4998 delimiters. It will also define a single group which contains the
4999 match except for the outermost delimiters. The maximum depth of
5000 stacked delimiters is N. Escaping delimiters is not possible."
5029 "Update the link regular expressions.
5030 This should be called after the variable `org-link-types' has changed."
5034 org-link-re-with-space
5040 org-link-re-with-space2
5046 org-link-re-with-space3
5051 org-angle-link-re
5057 org-plain-link-re
5061 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5062 org-bracket-link-regexp
5064 org-bracket-link-analytic-regexp
5072 org-bracket-link-analytic-regexp++
5080 org-any-link-re
5089 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5091 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5092 "Regular expression matching time strings for analysis.
5093 This one does not require the space after the date, so it can be used
5095 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5111 "Regular expression matching a time stamp or time stamp range.
5117 "Run through the buffer and add overlays to emphasised strings."
5126 'face
5139 rtn))
5142 "Insert or change an emphasis, i.e. a font like bold or italic.
5143 If there is an active region, change that region to a new emphasis.
5144 If there is no region, just insert the marker characters and position
5145 the cursor between them.
5146 CHAR should be either the marker character, or the first character of the
5147 HTML tag associated with that emphasis. If CHAR is a space, the means
5148 to remove the emphasis of the selected region.
5149 If char is not given (for example in an interactive call) it
5150 will be prompted for."
5201 "Run through the buffer and add overlays to links."
5210 nil
5216 t)))))
5224 t)))
5227 "When non-nil, fontify code in code blocks."
5238 "Fontify #+ lines and blocks, in the correct ways."
5241 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5242 limit t)
5250 end end1 quoting block-type ovl)
5253 ;; a single line of backend-specific content
5261 ; for backend-specific code
5262 t)
5264 ;; Truly a block
5276 beg end
5284 ;; remove old background overlays
5289 ;; add a background overlay
5303 t))
5316 ;; just any other in-buffer setting, but not indented
5320 t)
5329 t)
5337 "Run through the buffer and add overlays to links."
5345 t)))
5348 "Run through the buffer and add overlays to footnotes."
5355 'keymap org-mouse-map
5356 'help-echo
5358 "Footnote definition"
5360 'font-lock-fontified t
5361 'font-lock-multiline t
5365 "Run through the buffer and add overlays to bracketed links."
5369 ;; FIXME: above we should remove the escapes.
5370 ;; but that requires another match, protecting match data,
5371 ;; a lot of overhead for font-lock.
5378 ;; We need to remove the invisible property here. Table narrowing
5379 ;; may have made some of this invisible.
5397 t)))
5400 "Run through the buffer and add overlays to dates."
5412 t)))
5421 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5425 "Run through the buffer and add overlays to target matches."
5433 'keymap org-mouse-map
5437 t)))))
5440 "Find all radio targets in this file and update the regular expression."
5455 t)))
5462 ;; This should be with the exporter code, but we also use if for font-locking
5472 "Compute regular expression for stuff treated specially by exporters."
5479 org-latex-regexps)))
5507 org-entities)))
5511 org-latex-entities)
5512 nil))
5514 ))
5515 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5518 org-export-html-special-string-regexps)))
5523 ))))
5525 'org-latex-and-specials-regexp
5530 "Run through the buffer and add overlays to links."
5534 limit t))
5548 rtn)))
5551 "Restart `font-lock-mode', to force refontification."
5557 "Return a list of all targets in this file.
5558 With optional argument RADIO, only find radio targets."
5560 rtn)
5565 rtn)))
5568 "Make regular expression matching all strings in TARGETS.
5569 The regular expression finds the targets also if there is a line break
5570 between words."
5579 x)
5580 targets
5592 t)))
5595 "Compute the outline level of the heading at point.
5596 This function assumes that the cursor is at the beginning of a line matched
5597 by `outline-regexp'. Otherwise it returns garbage.
5598 If this is called at a normal headline, the level is the number of stars.
5599 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5606 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5613 "Functions that can manipulate `org-font-lock-extra-keywords'.
5614 This is calles after `org-font-lock-extra-keywords' is defined, but before
5615 it is installed to be used by font lock. This can be useful if something
5626 ;; Call the hook
5628 ;; Headlines
5635 ;; Table lines
5638 ;; Table internals
5643 ;; Drawers
5646 ;; Properties
5650 ;; Links
5660 ;; TODO lines
5663 ;; DONE
5669 nil)
5670 ;; Priorities
5672 ;; Tags
5674 ;; Special keywords
5679 ;; Emphasis
5684 ;; Checkboxes
5685 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5690 ;; Description list items
5693 ;; ARCHIVEd headings
5695 org-outline-regexp-bol
5698 ;; Specials
5702 ;; Code
5704 ;; COMMENT
5709 ;; Blocks and meta lines
5711 )))
5714 ;; Now set the full font-lock-keywords
5721 "Toggle the composition display of entities as UTF8 characters."
5733 "Find an entity to fontify."
5739 limit t)
5751 nil))))
5754 "Fontify string S like in Org-mode."
5766 "Get the right face for match N in font-lock matching of headlines."
5779 "Get the right face for a TODO keyword KWD.
5780 If KWD is a number, get the corresponding match group."
5788 "Create a face list that inherits INHERIT, but sets the foreground color.
5789 When FACE-OR-COLOR is not a string, just return it."
5793 face-or-color)
5794 face-or-color))
5797 "Add the special tag faces."
5806 "Add the special priority faces."
5813 org-priority-faces)))
5818 "Get the right face for a TODO keyword KWD.
5819 If KWD is a number, get the corresponding match group."
5826 "Remove fontification and activation overlays from links."
5831 deactivate-mark buffer-file-name buffer-file-truename)
5835 invisible t intangible t
5836 org-no-flyspell t org-emphasis t))
5846 "Remove specific display properties that have been added by font lock.
5847 The will remove the raise properties that are used to show superscripts
5848 and subscripts."
5858 "Add raise properties to sub/superscripts."
5862 org-match-substring-regexp
5863 org-match-substring-with-braces-regexp)
5864 limit t)
5874 ;; FIXME: Should we go back one character here, for a_b^c
5875 ;; (goto-char (1- pos)) ;????????????????????
5877 t
5879 'display
5895 t)))))
5897 ;;;; Visibility cycling, including org-goto and indirect buffer
5899 ;;; Cycling
5906 ;;;###autoload
5911 "TAB-action and visibility cycling for Org-mode.
5913 This is the command invoked in Org-mode by the TAB key. Its main purpose
5914 is outline visibility cycling, but it also invokes other actions
5915 in special contexts.
5917 - When this function is called with a prefix argument, rotate the entire
5918 buffer through 3 states (global cycling)
5919 1. OVERVIEW: Show only top-level headlines.
5920 2. CONTENTS: Show all headlines of all levels, but no body text.
5921 3. SHOW ALL: Show everything.
5922 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5923 determined by the variable `org-startup-folded', and by any VISIBILITY
5924 properties in the buffer.
5925 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5926 including any drawers.
5928 - When inside a table, re-align the table and move to the next field.
5930 - When point is at the beginning of a headline, rotate the subtree started
5931 by this line through 3 different states (local cycling)
5932 1. FOLDED: Only the main headline is shown.
5933 2. CHILDREN: The main headline and the direct children are shown.
5934 From this state, you can move to one of the children
5935 and zoom in further.
5936 3. SUBTREE: Show the entire subtree, including body text.
5937 If there is no subtree, switch directly from CHILDREN to FOLDED.
5939 - When point is at the beginning of an empty headline and the variable
5940 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5941 of the headline by demoting and promoting it to likely levels. This
5942 speeds up creation document structure by pressing TAB once or several
5943 times right after creating a new headline.
5945 - When there is a numeric prefix, go up to a heading with level ARG, do
5946 a `show-subtree' and return to the previous cursor position. If ARG
5947 is negative, go up that many levels.
5949 - When point is not at the beginning of a headline, execute the global
5950 binding for TAB, which is re-indenting the line. See the option
5951 `org-cycle-emulate-tab' for details.
5953 - Special case: if point is at the beginning of the buffer and there is
5954 no headline in line 1, this function will act as if called with prefix arg
5955 (C-u TAB, same as S-TAB) also when called without prefix arg.
5956 But only if also the variable `org-cycle-global-at-bob' is t."
5966 org-inlinetask-min-level
5971 limit-level)))
5974 outline-regexp
5982 org-cycle-hook))
5986 ;; special case: use global cycling
6000 ;; Table: enter it or move to the next field.
6011 ;; Global cycling: delegate to `org-cycle-internal-global'.
6014 ;; Drawers: delegate to `org-flag-drawer'.
6022 ;; Show-subtree, ARG levels up from here.
6030 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6036 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6043 ;; From there: TAB emulation and template completion.
6067 t
6076 "Do the global cycling action."
6080 ;; We just created the overview - now do table of contents
6081 ;; This can be slow in very large buffers, so indicate action
6091 ;; We just showed the table of contents - now show everything
6099 ;; Default action: go to overview
6107 "Do the local cycling action."
6109 ;; First, determine end of headline (EOH), end of subtree or item
6110 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6134 ;; Determine end invisible part of buffer (EOL)
6136 ;; XEmacs doesn't have `next-single-char-property-change'
6146 ;; Find out what to do next and set `this-command'
6149 ;; Nothing is hidden behind this heading
6161 org-cycle-skip-children-state-if-no-children))))
6162 ;; Entire subtree is hidden in one line: children view
6168 ;; Fold every list in subtree to top-level items.
6190 ;; We just showed the children, or no children are there,
6191 ;; now show everything.
6198 ;; Default action: hide the subtree.
6205 ;;;###autoload
6207 "Cycle the global visibility. For details see `org-cycle'.
6209 With a numeric prefix, show all headlines up to that level."
6225 "Set the visibility required by startup options and properties."
6240 "Switch subtree visibilities according to :VISIBILITY: property."
6247 nil t)
6271 ;; This function uses outline-regexp instead of the more fundamental
6272 ;; org-outline-regexp so that org-cycle-global works outside of Org
6273 ;; buffers, where outline-regexp is needed.
6275 "Switch to overview mode, showing only top-level headlines.
6276 Really, this shows all headlines with level equal or greater than the level
6277 of the first headline in the buffer. This is important, because if the
6278 first headline is not level one, then (hide-sublevels 1) gives confusing
6279 results."
6290 "Show all headlines in the buffer, like a table of contents.
6291 With numerical argument N, show content up to level N."
6294 ;; Visit all headings and show their offspring
6301 t)
6310 "Adjust the window after a change in outline visibility.
6311 This function is the default value of the hook `org-cycle-hook'."
6321 "Remove outline overlays that do not contain non-white stuff."
6331 "Fix visibility issues after moving a subtree."
6332 ;; First, find a reasonable region to look at:
6333 ;; Start two siblings above, end three below
6351 ;; Properly fold already folded siblings
6362 "Show empty lines above all visible headlines.
6363 The region to be covered depends on STATE when called through
6364 `org-cycle-hook'. Lisp program can use t for STATE to get the
6365 entire buffer covered. Note that an empty line is only shown if there
6366 are at least `org-cycle-separator-lines' empty lines before the headline."
6376 beg end b e)
6400 ;; Never hide empty lines at the end of the file.
6410 "Move to the parent and re-show empty lines before visible headlines."
6416 "Return `org-agenda-files' list, plus all open org-mode files.
6417 This is useful for operations that need to scan all of a user's
6418 open and agenda-wise Org files."
6426 files))
6429 "Return the beginning position of the current entry."
6433 "Return the end position of the current entry."
6437 "Re-hide all drawers after a visibility state change."
6463 "Is the end of the current subtree visible?"
6468 "Move cursor to the first headline and recenter the headline.
6469 Optional argument N means put the headline into the Nth line of the window."
6475 ;;; Saving and restoring visibility
6478 "Return a list of the locations of all outline overlays.
6479 These are overlays with the `invisible' property value `outline'.
6480 The return value is a list of cons cells, with start and stop
6481 positions for each overlay.
6482 If USE-MARKERS is set, return the positions as markers."
6500 "Create visibility overlays for all positions in DATA.
6501 DATA should have been made by `org-outline-overlay-data'."
6510 data)))))
6512 ;;; Folding of blocks
6523 "Call FUNCTION at the head of all source blocks in the current buffer.
6524 Optional arguments START and END can be used to limit the range."
6536 "Toggle the visibility of all blocks in the current buffer."
6540 "Fold all blocks in the current buffer."
6546 "Unfold all blocks in the current buffer."
6552 "Toggle visibility of block at point."
6563 "Toggle the visibility of the current block."
6570 ov)
6586 ;; make the block accessible to isearch
6588 ov 'isearch-open-invisible
6599 ;; org-tab-after-check-for-cycling-hook
6601 ;; Remove overlays when changing major mode
6606 ;;; Org-goto
6612 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6628 nil)
6629 (org-defkey map "q" 'org-goto-quit)
6630 (org-defkey map "n" 'outline-next-visible-heading)
6631 (org-defkey map "p" 'outline-previous-visible-heading)
6632 (org-defkey map "f" 'outline-forward-same-level)
6633 (org-defkey map "b" 'outline-backward-same-level)
6634 (org-defkey map "u" 'outline-up-heading))
6635 (org-defkey map "/" 'org-occur)
6636 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6637 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6638 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6639 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6640 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6641 map))
6643 (defconst org-goto-help
6644 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6645 RET=jump to location [Q]uit and return to previous location
6646 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6648 (defvar org-goto-start-pos) ; dynamically scoped parameter
6650 ;; FIXME: Docstring does not mention both interfaces
6651 (defun org-goto (&optional alternative-interface)
6652 "Look up a different location in the current file, keeping current visibility.
6654 When you want look-up or go to a different location in a document, the
6655 fastest way is often to fold the entire buffer and then dive into the tree.
6656 This method has the disadvantage, that the previous location will be folded,
6657 which may not be what you want.
6659 This command works around this by showing a copy of the current buffer
6660 in an indirect buffer, in overview mode. You can dive into the tree in
6661 that copy, use org-occur and incremental search to find a location.
6662 When pressing RET or `Q', the command returns to the original buffer in
6663 which the visibility is still unchanged. After RET is will also jump to
6664 the location selected in the indirect buffer and expose the headline
6665 hierarchy above."
6666 (interactive "P")
6667 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6668 (org-refile-use-outline-path t)
6669 (org-refile-target-verify-function nil)
6670 (interface
6671 (if (not alternative-interface)
6672 org-goto-interface
6673 (if (eq org-goto-interface 'outline)
6674 'outline-path-completion
6675 'outline)))
6676 (org-goto-start-pos (point))
6677 (selected-point
6678 (if (eq interface 'outline)
6679 (car (org-get-location (current-buffer) org-goto-help))
6680 (let ((pa (org-refile-get-location "Goto")))
6681 (org-refile-check-position pa)
6682 (nth 3 pa)))))
6683 (if selected-point
6684 (progn
6685 (org-mark-ring-push org-goto-start-pos)
6686 (goto-char selected-point)
6687 (if (or (outline-invisible-p) (org-invisible-p2))
6688 (org-show-context 'org-goto)))
6689 (message "Quit"))))
6691 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6692 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6693 (defvar org-goto-local-auto-isearch-map) ; defined below
6695 (defun org-get-location (buf help)
6696 "Let the user select a location in the Org-mode buffer BUF.
6697 This function uses a recursive edit. It returns the selected position
6698 or nil."
6699 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6700 (isearch-hide-immediately nil)
6701 (isearch-search-fun-function
6702 (lambda () 'org-goto-local-search-headings))
6703 (org-goto-selected-point org-goto-exit-command)
6704 (pop-up-frames nil)
6705 (special-display-buffer-names nil)
6706 (special-display-regexps nil)
6707 (special-display-function nil))
6708 (save-excursion
6709 (save-window-excursion
6710 (delete-other-windows)
6711 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6712 (org-pop-to-buffer-same-window
6713 (condition-case nil
6714 (make-indirect-buffer (current-buffer) "*org-goto*")
6715 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6716 (with-output-to-temp-buffer "*Help*"
6717 (princ help))
6718 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6719 (setq buffer-read-only nil)
6720 (let ((org-startup-truncated t)
6721 (org-startup-folded nil)
6722 (org-startup-align-all-tables nil))
6723 (org-mode)
6724 (org-overview))
6725 (setq buffer-read-only t)
6726 (if (and (boundp 'org-goto-start-pos)
6727 (integer-or-marker-p org-goto-start-pos))
6728 (let ((org-show-hierarchy-above t)
6729 (org-show-siblings t)
6730 (org-show-following-heading t))
6731 (goto-char org-goto-start-pos)
6732 (and (outline-invisible-p) (org-show-context)))
6733 (goto-char (point-min)))
6734 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6735 (message "Select location and press RET")
6736 (use-local-map org-goto-map)
6737 (recursive-edit)
6738 ))
6739 (kill-buffer "*org-goto*")
6740 (cons org-goto-selected-point org-goto-exit-command)))
6742 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6743 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6744 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6745 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6747 (defun org-goto-local-search-headings (string bound noerror)
6748 "Search and make sure that any matches are in headlines."
6749 (catch 'return
6750 (while (if isearch-forward
6751 (search-forward string bound noerror)
6752 (search-backward string bound noerror))
6753 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6754 (and (member :headline context)
6755 (not (member :tags context))))
6756 (throw 'return (point))))))
6758 (defun org-goto-local-auto-isearch ()
6759 "Start isearch."
6760 (interactive)
6761 (goto-char (point-min))
6762 (let ((keys (this-command-keys)))
6763 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6764 (isearch-mode t)
6765 (isearch-process-search-char (string-to-char keys)))))
6767 (defun org-goto-ret (&optional arg)
6768 "Finish `org-goto' by going to the new location."
6769 (interactive "P")
6770 (setq org-goto-selected-point (point)
6771 org-goto-exit-command 'return)
6772 (throw 'exit nil))
6774 (defun org-goto-left ()
6775 "Finish `org-goto' by going to the new location."
6776 (interactive)
6777 (if (org-on-heading-p)
6778 (progn
6779 (beginning-of-line 1)
6780 (setq org-goto-selected-point (point)
6781 org-goto-exit-command 'left)
6782 (throw 'exit nil))
6783 (error "Not on a heading")))
6785 (defun org-goto-right ()
6786 "Finish `org-goto' by going to the new location."
6787 (interactive)
6788 (if (org-on-heading-p)
6789 (progn
6790 (setq org-goto-selected-point (point)
6791 org-goto-exit-command 'right)
6792 (throw 'exit nil))
6793 (error "Not on a heading")))
6795 (defun org-goto-quit ()
6796 "Finish `org-goto' without cursor motion."
6797 (interactive)
6798 (setq org-goto-selected-point nil)
6799 (setq org-goto-exit-command 'quit)
6800 (throw 'exit nil))
6802 ;;; Indirect buffer display of subtrees
6804 (defvar org-indirect-dedicated-frame nil
6805 "This is the frame being used for indirect tree display.")
6806 (defvar org-last-indirect-buffer nil)
6808 (defun org-tree-to-indirect-buffer (&optional arg)
6809 "Create indirect buffer and narrow it to current subtree.
6810 With numerical prefix ARG, go up to this level and then take that tree.
6811 If ARG is negative, go up that many levels.
6812 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6813 indirect buffer previously made with this command, to avoid proliferation of
6814 indirect buffers. However, when you call the command with a \
6816 when `org-indirect-buffer-display' is `new-frame', the last buffer
6817 is kept so that you can work with several indirect buffers at the same time.
6818 If `org-indirect-buffer-display' is `dedicated-frame', the \
6820 requests that a new frame be made for the new buffer, so that the dedicated
6821 frame is not changed."
6822 (interactive "P")
6823 (let ((cbuf (current-buffer))
6824 (cwin (selected-window))
6825 (pos (point))
6826 beg end level heading ibuf)
6827 (save-excursion
6828 (org-back-to-heading t)
6829 (when (numberp arg)
6830 (setq level (org-outline-level))
6831 (if (< arg 0) (setq arg (+ level arg)))
6832 (while (> (setq level (org-outline-level)) arg)
6833 (outline-up-heading 1 t)))
6834 (setq beg (point)
6835 heading (org-get-heading))
6836 (org-end-of-subtree t t)
6837 (if (org-on-heading-p) (backward-char 1))
6838 (setq end (point)))
6839 (if (and (buffer-live-p org-last-indirect-buffer)
6840 (not (eq org-indirect-buffer-display 'new-frame))
6841 (not arg))
6842 (kill-buffer org-last-indirect-buffer))
6843 (setq ibuf (org-get-indirect-buffer cbuf)
6844 org-last-indirect-buffer ibuf)
6845 (cond
6846 ((or (eq org-indirect-buffer-display 'new-frame)
6847 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6848 (select-frame (make-frame))
6849 (delete-other-windows)
6850 (org-pop-to-buffer-same-window ibuf)
6851 (org-set-frame-title heading))
6852 ((eq org-indirect-buffer-display 'dedicated-frame)
6853 (raise-frame
6854 (select-frame (or (and org-indirect-dedicated-frame
6855 (frame-live-p org-indirect-dedicated-frame)
6856 org-indirect-dedicated-frame)
6857 (setq org-indirect-dedicated-frame (make-frame)))))
6858 (delete-other-windows)
6859 (org-pop-to-buffer-same-window ibuf)
6860 (org-set-frame-title (concat "Indirect: " heading)))
6861 ((eq org-indirect-buffer-display 'current-window)
6862 (org-pop-to-buffer-same-window ibuf))
6863 ((eq org-indirect-buffer-display 'other-window)
6864 (pop-to-buffer ibuf))
6865 (t (error "Invalid value")))
6866 (if (featurep 'xemacs)
6867 (save-excursion (org-mode) (turn-on-font-lock)))
6868 (narrow-to-region beg end)
6869 (show-all)
6870 (goto-char pos)
6871 (and (window-live-p cwin) (select-window cwin))))
6873 (defun org-get-indirect-buffer (&optional buffer)
6874 (setq buffer (or buffer (current-buffer)))
6875 (let ((n 1) (base (buffer-name buffer)) bname)
6876 (while (buffer-live-p
6877 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6878 (setq n (1+ n)))
6879 (condition-case nil
6880 (make-indirect-buffer buffer bname 'clone)
6881 (error (make-indirect-buffer buffer bname)))))
6883 (defun org-set-frame-title (title)
6884 "Set the title of the current frame to the string TITLE."
6885 ;; FIXME: how to name a single frame in XEmacs???
6886 (unless (featurep 'xemacs)
6887 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6889 ;;;; Structure editing
6891 ;;; Inserting headlines
6893 (defun org-previous-line-empty-p ()
6894 (save-excursion
6895 (and (not (bobp))
6896 (or (beginning-of-line 0) t)
6897 (save-match-data
6900 (defun org-insert-heading (&optional force-heading invisible-ok)
6901 "Insert a new heading or item with same depth at point.
6902 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6903 If point is at the beginning of a headline, insert a sibling before the
6904 current headline. If point is not at the beginning, split the line,
6905 create the new headline with the text in the current line after point
6906 \(but see also the variable `org-M-RET-may-split-line').
6908 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6909 This is important for non-interactive uses of the command."
6910 (interactive "P")
6911 (if (or (= (buffer-size) 0)
6912 (and (not (save-excursion
6913 (and (ignore-errors (org-back-to-heading invisible-ok))
6914 (org-on-heading-p))))
6915 (or force-heading (not (org-in-item-p)))))
6916 (progn
6918 (run-hooks 'org-insert-heading-hook))
6919 (when (or force-heading (not (org-insert-item)))
6920 (let* ((empty-line-p nil)
6921 (level nil)
6922 (on-heading (org-on-heading-p))
6923 (head (save-excursion
6924 (condition-case nil
6925 (progn
6926 (org-back-to-heading invisible-ok)
6927 (when (and (not on-heading)
6928 (featurep 'org-inlinetask)
6929 (integerp org-inlinetask-min-level)
6930 (>= (length (match-string 0))
6931 org-inlinetask-min-level))
6932 ;; Find a heading level before the inline task
6933 (while (and (setq level (org-up-heading-safe))
6934 (>= level org-inlinetask-min-level)))
6935 (if (org-on-heading-p)
6936 (org-back-to-heading invisible-ok)
6937 (error "This should not happen")))
6938 (setq empty-line-p (org-previous-line-empty-p))
6939 (match-string 0))
6940 (error "*"))))
6941 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6942 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6943 pos hide-previous previous-pos)
6944 (cond
6945 ((and (org-on-heading-p) (bolp)
6946 (or (bobp)
6947 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6948 ;; insert before the current line
6949 (open-line (if blank 2 1)))
6950 ((and (bolp)
6951 (not org-insert-heading-respect-content)
6952 (or (bobp)
6953 (save-excursion
6954 (backward-char 1) (not (outline-invisible-p)))))
6955 ;; insert right here
6956 nil)
6957 (t
6958 ;; somewhere in the line
6959 (save-excursion
6960 (setq previous-pos (point-at-bol))
6961 (end-of-line)
6962 (setq hide-previous (outline-invisible-p)))
6963 (and org-insert-heading-respect-content (org-show-subtree))
6964 (let ((split
6965 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6966 (save-excursion
6967 (let ((p (point)))
6968 (goto-char (point-at-bol))
6969 (and (looking-at org-complex-heading-regexp)
6970 (> p (match-beginning 4)))))))
6971 tags pos)
6972 (cond
6973 (org-insert-heading-respect-content
6974 (org-end-of-subtree nil t)
6975 (when (featurep 'org-inlinetask)
6976 (while (and (not (eobp))
6978 (>= (length (match-string 1))
6979 org-inlinetask-min-level))
6980 (org-end-of-subtree nil t)))
6981 (or (bolp) (newline))
6982 (or (org-previous-line-empty-p)
6983 (and blank (newline)))
6984 (open-line 1))
6985 ((org-on-heading-p)
6986 (when hide-previous
6987 (show-children)
6988 (org-show-entry))
6990 (setq tags (and (match-end 2) (match-string 2)))
6991 (and (match-end 1)
6992 (delete-region (match-beginning 1) (match-end 1)))
6993 (setq pos (point-at-bol))
6994 (or split (end-of-line 1))
6995 (delete-horizontal-space)
6997 (buffer-substring (point-at-bol) (point)))
6998 (insert " "))
6999 (newline (if blank 2 1))
7000 (when tags
7001 (save-excursion
7002 (goto-char pos)
7003 (end-of-line 1)
7004 (insert " " tags)
7005 (org-set-tags nil 'align))))
7006 (t
7007 (or split (end-of-line 1))
7008 (newline (if blank 2 1)))))))
7009 (insert head) (just-one-space)
7010 (setq pos (point))
7011 (end-of-line 1)
7012 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7013 (when (and org-insert-heading-respect-content hide-previous)
7014 (save-excursion
7015 (goto-char previous-pos)
7016 (hide-subtree)))
7017 (run-hooks 'org-insert-heading-hook)))))
7019 (defun org-get-heading (&optional no-tags no-todo)
7020 "Return the heading of the current entry, without the stars.
7021 When NO-TAGS is non-nil, don't include tags.
7022 When NO-TODO is non-nil, don't include TODO keywords."
7023 (save-excursion
7024 (org-back-to-heading t)
7025 (cond
7026 ((and no-tags no-todo)
7027 (looking-at org-complex-heading-regexp)
7028 (match-string 4))
7029 (no-tags
7031 (match-string 1))
7032 (no-todo
7035 (match-string 2))
7037 (match-string 1)))))
7039 (defun org-heading-components ()
7040 "Return the components of the current heading.
7041 This is a list with the following elements:
7042 - the level as an integer
7043 - the reduced level, different if `org-odd-levels-only' is set.
7044 - the TODO keyword, or nil
7045 - the priority character, like ?A, or nil if no priority is given
7046 - the headline text itself, or the tags string if no headline text
7047 - the tags string, or nil."
7048 (save-excursion
7049 (org-back-to-heading t)
7050 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7051 (list (length (match-string 1))
7052 (org-reduced-level (length (match-string 1)))
7053 (org-match-string-no-properties 2)
7054 (and (match-end 3) (aref (match-string 3) 2))
7055 (org-match-string-no-properties 4)
7056 (org-match-string-no-properties 5)))))
7058 (defun org-get-entry ()
7059 "Get the entry text, after heading, entire subtree."
7060 (save-excursion
7061 (org-back-to-heading t)
7062 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7064 (defun org-insert-heading-after-current ()
7065 "Insert a new heading with same level as current, after current subtree."
7066 (interactive)
7067 (org-back-to-heading)
7068 (org-insert-heading)
7069 (org-move-subtree-down)
7070 (end-of-line 1))
7072 (defun org-insert-heading-respect-content ()
7073 (interactive)
7074 (let ((org-insert-heading-respect-content t))
7075 (org-insert-heading t)))
7077 (defun org-insert-todo-heading-respect-content (&optional force-state)
7078 (interactive "P")
7079 (let ((org-insert-heading-respect-content t))
7080 (org-insert-todo-heading force-state t)))
7082 (defun org-insert-todo-heading (arg &optional force-heading)
7083 "Insert a new heading with the same level and TODO state as current heading.
7084 If the heading has no TODO state, or if the state is DONE, use the first
7085 state (TODO by default). Also with prefix arg, force first state."
7086 (interactive "P")
7087 (when (or force-heading (not (org-insert-item 'checkbox)))
7088 (org-insert-heading force-heading)
7089 (save-excursion
7090 (org-back-to-heading)
7091 (outline-previous-heading)
7092 (looking-at org-todo-line-regexp))
7093 (let*
7094 ((new-mark-x
7095 (if (or arg
7096 (not (match-beginning 2))
7097 (member (match-string 2) org-done-keywords))
7098 (car org-todo-keywords-1)
7099 (match-string 2)))
7100 (new-mark
7101 (or
7102 (run-hook-with-args-until-success
7103 'org-todo-get-default-hook new-mark-x nil)
7104 new-mark-x)))
7105 (beginning-of-line 1)
7106 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7107 (if org-treat-insert-todo-heading-as-state-change
7108 (org-todo new-mark)
7109 (insert new-mark " "))))
7110 (when org-provide-todo-statistics
7111 (org-update-parent-todo-statistics))))
7113 (defun org-insert-subheading (arg)
7114 "Insert a new subheading and demote it.
7115 Works for outline headings and for plain lists alike."
7116 (interactive "P")
7117 (org-insert-heading arg)
7118 (cond
7119 ((org-on-heading-p) (org-do-demote))
7120 ((org-at-item-p) (org-indent-item))))
7122 (defun org-insert-todo-subheading (arg)
7123 "Insert a new subheading with TODO keyword or checkbox and demote it.
7124 Works for outline headings and for plain lists alike."
7125 (interactive "P")
7126 (org-insert-todo-heading arg)
7127 (cond
7128 ((org-on-heading-p) (org-do-demote))
7129 ((org-at-item-p) (org-indent-item))))
7131 ;;; Promotion and Demotion
7133 (defvar org-after-demote-entry-hook nil
7134 "Hook run after an entry has been demoted.
7135 The cursor will be at the beginning of the entry.
7136 When a subtree is being demoted, the hook will be called for each node.")
7138 (defvar org-after-promote-entry-hook nil
7139 "Hook run after an entry has been promoted.
7140 The cursor will be at the beginning of the entry.
7141 When a subtree is being promoted, the hook will be called for each node.")
7143 (defun org-promote-subtree ()
7144 "Promote the entire subtree.
7145 See also `org-promote'."
7146 (interactive)
7147 (save-excursion
7148 (org-with-limited-levels (org-map-tree 'org-promote)))
7149 (org-fix-position-after-promote))
7151 (defun org-demote-subtree ()
7152 "Demote the entire subtree. See `org-demote'.
7153 See also `org-promote'."
7154 (interactive)
7155 (save-excursion
7156 (org-with-limited-levels (org-map-tree 'org-demote)))
7157 (org-fix-position-after-promote))
7160 (defun org-do-promote ()
7161 "Promote the current heading higher up the tree.
7162 If the region is active in `transient-mark-mode', promote all headings
7163 in the region."
7164 (interactive)
7165 (save-excursion
7166 (if (org-region-active-p)
7167 (org-map-region 'org-promote (region-beginning) (region-end))
7168 (org-promote)))
7169 (org-fix-position-after-promote))
7171 (defun org-do-demote ()
7172 "Demote the current heading lower down the tree.
7173 If the region is active in `transient-mark-mode', demote all headings
7174 in the region."
7175 (interactive)
7176 (save-excursion
7177 (if (org-region-active-p)
7178 (org-map-region 'org-demote (region-beginning) (region-end))
7179 (org-demote)))
7180 (org-fix-position-after-promote))
7182 (defun org-fix-position-after-promote ()
7183 "Make sure that after pro/demotion cursor position is right."
7184 (let ((pos (point)))
7185 (when (save-excursion
7186 (beginning-of-line 1)
7187 (looking-at org-todo-line-regexp)
7188 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7189 (cond ((eobp) (insert " "))
7190 ((eolp) (insert " "))
7191 ((equal (char-after) ?\ ) (forward-char 1))))))
7193 (defun org-current-level ()
7194 "Return the level of the current entry, or nil if before the first headline.
7195 The level is the number of stars at the beginning of the headline."
7196 (save-excursion
7197 (org-with-limited-levels
7198 (ignore-errors
7199 (org-back-to-heading t)
7200 (funcall outline-level)))))
7202 (defun org-get-previous-line-level ()
7203 "Return the outline depth of the last headline before the current line.
7204 Returns 0 for the first headline in the buffer, and nil if before the
7205 first headline."
7206 (let ((current-level (org-current-level))
7207 (prev-level (when (> (line-number-at-pos) 1)
7208 (save-excursion
7209 (beginning-of-line 0)
7210 (org-current-level)))))
7211 (cond ((null current-level) nil) ; Before first headline
7212 ((null prev-level) 0) ; At first headline
7213 (prev-level))))
7215 (defun org-reduced-level (l)
7216 "Compute the effective level of a heading.
7217 This takes into account the setting of `org-odd-levels-only'."
7218 (cond
7219 ((zerop l) 0)
7220 (org-odd-levels-only (1+ (floor (/ l 2))))
7221 (t l)))
7223 (defun org-level-increment ()
7224 "Return the number of stars that will be added or removed at a
7225 time to headlines when structure editing, based on the value of
7226 `org-odd-levels-only'."
7227 (if org-odd-levels-only 2 1))
7229 (defun org-get-valid-level (level &optional change)
7230 "Rectify a level change under the influence of `org-odd-levels-only'
7231 LEVEL is a current level, CHANGE is by how much the level should be
7232 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7233 even level numbers will become the next higher odd number."
7234 (if org-odd-levels-only
7235 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7236 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7237 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7238 (max 1 (+ level (or change 0)))))
7240 (if (boundp 'define-obsolete-function-alias)
7241 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7242 (define-obsolete-function-alias 'org-get-legal-level
7243 'org-get-valid-level)
7244 (define-obsolete-function-alias 'org-get-legal-level
7245 'org-get-valid-level "23.1")))
7247 (defun org-promote ()
7248 "Promote the current heading higher up the tree.
7249 If the region is active in `transient-mark-mode', promote all headings
7250 in the region."
7251 (org-back-to-heading t)
7252 (let* ((level (save-match-data (funcall outline-level)))
7253 (after-change-functions (remove 'flyspell-after-change-function
7254 after-change-functions))
7255 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7256 (diff (abs (- level (length up-head) -1))))
7257 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7258 (replace-match up-head nil t)
7259 ;; Fixup tag positioning
7260 (and org-auto-align-tags (org-set-tags nil t))
7261 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7262 (run-hooks 'org-after-promote-entry-hook)))
7264 (defun org-demote ()
7265 "Demote the current heading lower down the tree.
7266 If the region is active in `transient-mark-mode', demote all headings
7267 in the region."
7268 (org-back-to-heading t)
7269 (let* ((level (save-match-data (funcall outline-level)))
7270 (after-change-functions (remove 'flyspell-after-change-function
7271 after-change-functions))
7272 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7273 (diff (abs (- level (length down-head) -1))))
7274 (replace-match down-head nil t)
7275 ;; Fixup tag positioning
7276 (and org-auto-align-tags (org-set-tags nil t))
7277 (if org-adapt-indentation (org-fixup-indentation diff))
7278 (run-hooks 'org-after-demote-entry-hook)))
7280 (defun org-cycle-level ()
7281 "Cycle the level of an empty headline through possible states.
7282 This goes first to child, then to parent, level, then up the hierarchy.
7283 After top level, it switches back to sibling level."
7284 (interactive)
7285 (let ((org-adapt-indentation nil))
7286 (when (org-point-at-end-of-empty-headline)
7287 (setq this-command 'org-cycle-level) ; Only needed for caching
7288 (let ((cur-level (org-current-level))
7289 (prev-level (org-get-previous-line-level)))
7290 (cond
7291 ;; If first headline in file, promote to top-level.
7292 ((= prev-level 0)
7293 (loop repeat (/ (- cur-level 1) (org-level-increment))
7294 do (org-do-promote)))
7295 ;; If same level as prev, demote one.
7296 ((= prev-level cur-level)
7297 (org-do-demote))
7298 ;; If parent is top-level, promote to top level if not already.
7299 ((= prev-level 1)
7300 (loop repeat (/ (- cur-level 1) (org-level-increment))
7301 do (org-do-promote)))
7302 ;; If top-level, return to prev-level.
7303 ((= cur-level 1)
7304 (loop repeat (/ (- prev-level 1) (org-level-increment))
7305 do (org-do-demote)))
7306 ;; If less than prev-level, promote one.
7307 ((< cur-level prev-level)
7308 (org-do-promote))
7309 ;; If deeper than prev-level, promote until higher than
7310 ;; prev-level.
7311 ((> cur-level prev-level)
7312 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7313 do (org-do-promote))))
7314 t))))
7316 (defun org-map-tree (fun)
7317 "Call FUN for every heading underneath the current one."
7318 (org-back-to-heading)
7319 (let ((level (funcall outline-level)))
7320 (save-excursion
7321 (funcall fun)
7322 (while (and (progn
7323 (outline-next-heading)
7324 (> (funcall outline-level) level))
7325 (not (eobp)))
7326 (funcall fun)))))
7328 (defun org-map-region (fun beg end)
7329 "Call FUN for every heading between BEG and END."
7330 (let ((org-ignore-region t))
7331 (save-excursion
7332 (setq end (copy-marker end))
7333 (goto-char beg)
7334 (if (and (re-search-forward org-outline-regexp-bol nil t)
7335 (< (point) end))
7336 (funcall fun))
7337 (while (and (progn
7338 (outline-next-heading)
7339 (< (point) end))
7340 (not (eobp)))
7341 (funcall fun)))))
7343 (defvar org-property-end-re) ; silence byte-compiler
7344 (defun org-fixup-indentation (diff)
7345 "Change the indentation in the current entry by DIFF.
7346 However, if any line in the current entry has no indentation, or if it
7347 would end up with no indentation after the change, nothing at all is done."
7348 (save-excursion
7349 (let* ((end (save-excursion (outline-next-heading)
7350 (point-marker)))
7351 ;; FIXME we should use `org-end-of-meta-data-and-drawers'
7352 ;; here but it matches misplaced :END:...
7353 (drawer-end (save-excursion
7354 (and (re-search-forward
7355 org-property-end-re end t)
7356 (match-end 0))))
7357 (prohibit (if (> diff 0)
7360 col)
7361 (while (re-search-forward
7366 (beginning-of-line)
7368 (goto-char (match-end 0))
7369 (setq col (current-column))
7370 (if (< diff 0) (replace-match ""))
7371 (org-indent-to-column (+ diff col))
7372 (if drawer-end (setq drawer-end (+ diff drawer-end))))
7373 (end-of-line))
7374 (unless (save-excursion (end-of-line 1)
7375 (re-search-forward prohibit end t))
7376 (while (and (< (point) end)
7378 (goto-char (match-end 0))
7379 (setq col (current-column))
7380 (if (< diff 0) (replace-match ""))
7381 (org-indent-to-column (+ diff col))))
7382 (move-marker end nil))))
7384 (defun org-convert-to-odd-levels ()
7385 "Convert an org-mode file with all levels allowed to one with odd levels.
7386 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7387 level 5 etc."
7388 (interactive)
7389 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7390 (let ((outline-level 'org-outline-level)
7391 (org-odd-levels-only nil) n)
7392 (save-excursion
7393 (goto-char (point-min))
7395 (setq n (- (length (match-string 0)) 2))
7396 (while (>= (setq n (1- n)) 0)
7397 (org-demote))
7398 (end-of-line 1))))))
7400 (defun org-convert-to-oddeven-levels ()
7401 "Convert an org-mode file with only odd levels to one with odd/even levels.
7402 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7403 file contains a section with an even level, conversion would
7404 destroy the structure of the file. An error is signaled in this
7405 case."
7406 (interactive)
7407 (goto-char (point-min))
7408 ;; First check if there are no even levels
7410 (org-show-context t)
7411 (error "Not all levels are odd in this file. Conversion not possible"))
7412 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7413 (let ((outline-regexp org-outline-regexp)
7414 (outline-level 'org-outline-level)
7415 (org-odd-levels-only nil) n)
7416 (save-excursion
7417 (goto-char (point-min))
7419 (setq n (/ (1- (length (match-string 0))) 2))
7420 (while (>= (setq n (1- n)) 0)
7421 (org-promote))
7422 (end-of-line 1))))))
7424 (defun org-tr-level (n)
7425 "Make N odd if required."
7426 (if org-odd-levels-only (1+ (/ n 2)) n))
7428 ;;; Vertical tree motion, cutting and pasting of subtrees
7430 (defun org-move-subtree-up (&optional arg)
7431 "Move the current subtree up past ARG headlines of the same level."
7432 (interactive "p")
7433 (org-move-subtree-down (- (prefix-numeric-value arg))))
7435 (defun org-move-subtree-down (&optional arg)
7436 "Move the current subtree down past ARG headlines of the same level."
7437 (interactive "p")
7438 (setq arg (prefix-numeric-value arg))
7439 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7440 'org-get-last-sibling))
7441 (ins-point (make-marker))
7442 (cnt (abs arg))
7443 (col (current-column))
7444 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7445 ;; Select the tree
7446 (org-back-to-heading)
7447 (setq beg0 (point))
7448 (save-excursion
7449 (setq ne-beg (org-back-over-empty-lines))
7450 (setq beg (point)))
7451 (save-match-data
7452 (save-excursion (outline-end-of-heading)
7453 (setq folded (outline-invisible-p)))
7454 (outline-end-of-subtree))
7455 (outline-next-heading)
7456 (setq ne-end (org-back-over-empty-lines))
7457 (setq end (point))
7458 (goto-char beg0)
7459 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7460 ;; include less whitespace
7461 (save-excursion
7462 (goto-char beg)
7463 (forward-line (- ne-beg ne-end))
7464 (setq beg (point))))
7465 ;; Find insertion point, with error handling
7466 (while (> cnt 0)
7467 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7468 (progn (goto-char beg0)
7469 (error "Cannot move past superior level or buffer limit")))
7470 (setq cnt (1- cnt)))
7471 (if (> arg 0)
7472 ;; Moving forward - still need to move over subtree
7473 (progn (org-end-of-subtree t t)
7474 (save-excursion
7475 (org-back-over-empty-lines)
7476 (or (bolp) (newline)))))
7477 (setq ne-ins (org-back-over-empty-lines))
7478 (move-marker ins-point (point))
7479 (setq txt (buffer-substring beg end))
7480 (org-save-markers-in-region beg end)
7481 (delete-region beg end)
7482 (org-remove-empty-overlays-at beg)
7483 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7484 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7486 (let ((bbb (point)))
7487 (insert-before-markers txt)
7488 (org-reinstall-markers-in-region bbb)
7489 (move-marker ins-point bbb))
7491 (setq ins-end (point))
7492 (goto-char ins-point)
7493 (org-skip-whitespace)
7494 (when (and (< arg 0)
7495 (org-first-sibling-p)
7496 (> ne-ins ne-beg))
7497 ;; Move whitespace back to beginning
7498 (save-excursion
7499 (goto-char ins-end)
7500 (let ((kill-whole-line t))
7501 (kill-line (- ne-ins ne-beg)) (point)))
7503 (move-marker ins-point nil)
7504 (if folded
7505 (hide-subtree)
7506 (org-show-entry)
7507 (show-children)
7508 (org-cycle-hide-drawers 'children))
7509 (org-clean-visibility-after-subtree-move)
7510 ;; move back to the initial column we were at
7511 (move-to-column col)))
7513 (defvar org-subtree-clip ""
7514 "Clipboard for cut and paste of subtrees.
7515 This is actually only a copy of the kill, because we use the normal kill
7516 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7518 (defvar org-subtree-clip-folded nil
7519 "Was the last copied subtree folded?
7520 This is used to fold the tree back after pasting.")
7522 (defun org-cut-subtree (&optional n)
7523 "Cut the current subtree into the clipboard.
7524 With prefix arg N, cut this many sequential subtrees.
7525 This is a short-hand for marking the subtree and then cutting it."
7526 (interactive "p")
7527 (org-copy-subtree n 'cut))
7529 (defun org-copy-subtree (&optional n cut force-store-markers)
7530 "Cut the current subtree into the clipboard.
7531 With prefix arg N, cut this many sequential subtrees.
7532 This is a short-hand for marking the subtree and then copying it.
7533 If CUT is non-nil, actually cut the subtree.
7534 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7535 of some markers in the region, even if CUT is non-nil. This is
7536 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7537 (interactive "p")
7538 (let (beg end folded (beg0 (point)))
7539 (if (org-called-interactively-p 'any)
7540 (org-back-to-heading nil) ; take what looks like a subtree
7541 (org-back-to-heading t)) ; take what is really there
7542 (org-back-over-empty-lines)
7543 (setq beg (point))
7545 (save-match-data
7546 (save-excursion (outline-end-of-heading)
7547 (setq folded (outline-invisible-p)))
7548 (condition-case nil
7549 (org-forward-same-level (1- n) t)
7550 (error nil))
7551 (org-end-of-subtree t t))
7552 (org-back-over-empty-lines)
7553 (setq end (point))
7554 (goto-char beg0)
7555 (when (> end beg)
7556 (setq org-subtree-clip-folded folded)
7557 (when (or cut force-store-markers)
7558 (org-save-markers-in-region beg end))
7559 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7560 (setq org-subtree-clip (current-kill 0))
7561 (message "%s: Subtree(s) with %d characters"
7562 (if cut "Cut" "Copied")
7563 (length org-subtree-clip)))))
7565 (defun org-paste-subtree (&optional level tree for-yank)
7566 "Paste the clipboard as a subtree, with modification of headline level.
7567 The entire subtree is promoted or demoted in order to match a new headline
7568 level.
7570 If the cursor is at the beginning of a headline, the same level as
7571 that headline is used to paste the tree
7573 If not, the new level is derived from the *visible* headings
7574 before and after the insertion point, and taken to be the inferior headline
7575 level of the two. So if the previous visible heading is level 3 and the
7576 next is level 4 (or vice versa), level 4 will be used for insertion.
7577 This makes sure that the subtree remains an independent subtree and does
7578 not swallow low level entries.
7580 You can also force a different level, either by using a numeric prefix
7581 argument, or by inserting the heading marker by hand. For example, if the
7584 If optional TREE is given, use this text instead of the kill ring.
7586 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7587 move back over whitespace before inserting, and move point to the end of
7588 the inserted text when done."
7589 (interactive "P")
7590 (setq tree (or tree (and kill-ring (current-kill 0))))
7591 (unless (org-kill-is-subtree-p tree)
7592 (error "%s"
7593 (substitute-command-keys
7595 (org-with-limited-levels
7596 (let* ((visp (not (outline-invisible-p)))
7597 (txt tree)
7599 (old-level (if (string-match org-outline-regexp-bol txt)
7600 (- (match-end 0) (match-beginning 0) 1)
7601 -1))
7602 (force-level (cond (level (prefix-numeric-value level))
7604 (string-match
7606 (point-at-bol) (point))))
7607 (- (match-end 1) (match-beginning 1)))
7608 ((and (bolp)
7609 (looking-at org-outline-regexp))
7610 (- (match-end 0) (point) 1))
7611 (t nil)))
7612 (previous-level (save-excursion
7613 (condition-case nil
7614 (progn
7615 (outline-previous-visible-heading 1)
7616 (if (looking-at ^re_)
7617 (- (match-end 0) (match-beginning 0) 1)
7618 1))
7619 (error 1))))
7620 (next-level (save-excursion
7621 (condition-case nil
7622 (progn
7623 (or (looking-at org-outline-regexp)
7624 (outline-next-visible-heading 1))
7625 (if (looking-at ^re_)
7626 (- (match-end 0) (match-beginning 0) 1)
7627 1))
7628 (error 1))))
7629 (new-level (or force-level (max previous-level next-level)))
7630 (shift (if (or (= old-level -1)
7631 (= new-level -1)
7632 (= old-level new-level))
7633 0
7634 (- new-level old-level)))
7635 (delta (if (> shift 0) -1 1))
7636 (func (if (> shift 0) 'org-demote 'org-promote))
7637 (org-odd-levels-only nil)
7638 beg end newend)
7639 ;; Remove the forced level indicator
7640 (if force-level
7641 (delete-region (point-at-bol) (point)))
7642 ;; Paste
7643 (beginning-of-line (if (bolp) 1 2))
7644 (unless for-yank (org-back-over-empty-lines))
7645 (setq beg (point))
7646 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7647 (insert-before-markers txt)
7649 (setq newend (point))
7650 (org-reinstall-markers-in-region beg)
7651 (setq end (point))
7652 (goto-char beg)
7654 (setq beg (point))
7655 (if (and (outline-invisible-p) visp)
7656 (save-excursion (outline-show-heading)))
7657 ;; Shift if necessary
7658 (unless (= shift 0)
7659 (save-restriction
7660 (narrow-to-region beg end)
7661 (while (not (= shift 0))
7662 (org-map-region func (point-min) (point-max))
7663 (setq shift (+ delta shift)))
7664 (goto-char (point-min))
7665 (setq newend (point-max))))
7666 (when (or (org-called-interactively-p 'interactive) for-yank)
7667 (message "Clipboard pasted as level %d subtree" new-level))
7668 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7669 kill-ring
7670 (eq org-subtree-clip (current-kill 0))
7671 org-subtree-clip-folded)
7672 ;; The tree was folded before it was killed/copied
7673 (hide-subtree))
7674 (and for-yank (goto-char newend)))))
7676 (defun org-kill-is-subtree-p (&optional txt)
7677 "Check if the current kill is an outline subtree, or a set of trees.
7678 Returns nil if kill does not start with a headline, or if the first
7679 headline level is not the largest headline level in the tree.
7680 So this will actually accept several entries of equal levels as well,
7681 which is OK for `org-paste-subtree'.
7682 If optional TXT is given, check this string instead of the current kill."
7683 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7684 (re (org-get-limited-outline-regexp))
7685 (^re (concat "^" re))
7686 (start-level (and kill
7687 (string-match
7689 kill)
7690 (- (match-end 2) (match-beginning 2) 1)))
7691 (start (1+ (or (match-beginning 2) -1))))
7692 (if (not start-level)
7693 (progn
7694 nil) ;; does not even start with a heading
7695 (catch 'exit
7696 (while (setq start (string-match ^re kill (1+ start)))
7697 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7698 (throw 'exit nil)))
7699 t))))
7701 (defvar org-markers-to-move nil
7702 "Markers that should be moved with a cut-and-paste operation.
7703 Those markers are stored together with their positions relative to
7704 the start of the region.")
7706 (defun org-save-markers-in-region (beg end)
7707 "Check markers in region.
7708 If these markers are between BEG and END, record their position relative
7709 to BEG, so that after moving the block of text, we can put the markers back
7710 into place.
7711 This function gets called just before an entry or tree gets cut from the
7712 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7713 called immediately, to move the markers with the entries."
7714 (setq org-markers-to-move nil)
7715 (when (featurep 'org-clock)
7716 (org-clock-save-markers-for-cut-and-paste beg end))
7717 (when (featurep 'org-agenda)
7718 (org-agenda-save-markers-for-cut-and-paste beg end)))
7720 (defun org-check-and-save-marker (marker beg end)
7721 "Check if MARKER is between BEG and END.
7722 If yes, remember the marker and the distance to BEG."
7723 (when (and (marker-buffer marker)
7724 (equal (marker-buffer marker) (current-buffer)))
7725 (if (and (>= marker beg) (< marker end))
7726 (push (cons marker (- marker beg)) org-markers-to-move))))
7728 (defun org-reinstall-markers-in-region (beg)
7729 "Move all remembered markers to their position relative to BEG."
7730 (mapc (lambda (x)
7731 (move-marker (car x) (+ beg (cdr x))))
7732 org-markers-to-move)
7733 (setq org-markers-to-move nil))
7735 (defun org-narrow-to-subtree ()
7736 "Narrow buffer to the current subtree."
7737 (interactive)
7738 (save-excursion
7739 (save-match-data
7740 (org-with-limited-levels
7741 (narrow-to-region
7742 (progn (org-back-to-heading t) (point))
7743 (progn (org-end-of-subtree t t)
7744 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7745 (point)))))))
7747 (defun org-narrow-to-block ()
7748 "Narrow buffer to the current block."
7749 (interactive)
7750 (let* ((case-fold-search t)
7753 (if blockp
7754 (narrow-to-region (car blockp) (cdr blockp))
7755 (error "Not in a block"))))
7757 (eval-when-compile
7758 (defvar org-property-drawer-re))
7760 (defvar org-property-start-re) ;; defined below
7761 (defun org-clone-subtree-with-time-shift (n &optional shift)
7762 "Clone the task (subtree) at point N times.
7763 The clones will be inserted as siblings.
7765 In interactive use, the user will be prompted for the number of
7766 clones to be produced, and for a time SHIFT, which may be a
7767 repeater as used in time stamps, for example `+3d'.
7769 When a valid repeater is given and the entry contains any time
7770 stamps, the clones will become a sequence in time, with time
7771 stamps in the subtree shifted for each clone produced. If SHIFT
7772 is nil or the empty string, time stamps will be left alone. The
7773 ID property of the original subtree is removed.
7775 If the original subtree did contain time stamps with a repeater,
7776 the following will happen:
7777 - the repeater will be removed in each clone
7778 - an additional clone will be produced, with the current, unshifted
7779 date(s) in the entry.
7780 - the original entry will be placed *after* all the clones, with
7781 repeater intact.
7782 - the start days in the repeater in the original entry will be shifted
7783 to past the last clone.
7784 I this way you can spell out a number of instances of a repeating task,
7785 and still retain the repeater to cover future instances of the task."
7786 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7787 (let (beg end template task idprop
7788 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7789 (if (not (and (integerp n) (> n 0)))
7790 (error "Invalid number of replications %s" n))
7793 shift)))
7794 (error "Invalid shift specification %s" shift))
7795 (when doshift
7796 (setq shift-n (string-to-number (match-string 1 shift))
7797 shift-what (cdr (assoc (match-string 2 shift)
7798 '(("d" . day) ("w" . week)
7799 ("m" . month) ("y" . year))))))
7800 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7801 (setq nmin 1 nmax n)
7802 (org-back-to-heading t)
7803 (setq beg (point))
7804 (setq idprop (org-entry-get nil "ID"))
7805 (org-end-of-subtree t t)
7807 (setq end (point))
7808 (setq template (buffer-substring beg end))
7809 ;; Remove clocks and empty drawers
7810 (with-temp-buffer
7811 (insert template)
7812 (goto-char (point-min))
7813 (while (re-search-forward
7815 (replace-match "")
7816 (kill-whole-line))
7817 (goto-char (point-min))
7818 (while (re-search-forward
7820 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7821 (setq template (buffer-substring (point-min) (point-max))))
7822 (when (and doshift
7824 (delete-region beg end)
7825 (setq end beg)
7826 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7827 (goto-char end)
7828 (loop for n from nmin to nmax do
7829 ;; prepare clone
7830 (with-temp-buffer
7831 (insert template)
7832 (org-mode)
7833 (goto-char (point-min))
7834 (and idprop (if org-clone-delete-id
7835 (org-entry-delete nil "ID")
7836 (org-id-get-create t)))
7837 (while (re-search-forward org-property-start-re nil t)
7838 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7839 (goto-char (point-min))
7840 (when doshift
7841 (while (re-search-forward org-ts-regexp-both nil t)
7842 (org-timestamp-change (* n shift-n) shift-what))
7843 (unless (= n n-no-remove)
7844 (goto-char (point-min))
7845 (while (re-search-forward org-ts-regexp nil t)
7846 (save-excursion
7847 (goto-char (match-beginning 0))
7849 (delete-region (match-beginning 1) (match-end 1)))))))
7850 (setq task (buffer-string)))
7851 (insert task))
7852 (goto-char beg)))
7854 ;;; Outline Sorting
7856 (defun org-sort (with-case)
7857 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7858 Optional argument WITH-CASE means sort case-sensitively.
7859 With a double prefix argument, also remove duplicate entries."
7860 (interactive "P")
7861 (cond
7862 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7863 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7864 (t
7865 (org-call-with-arg 'org-sort-entries with-case))))
7867 (defun org-sort-remove-invisible (s)
7868 (remove-text-properties 0 (length s) org-rm-props s)
7869 (while (string-match org-bracket-link-regexp s)
7870 (setq s (replace-match (if (match-end 2)
7871 (match-string 3 s)
7872 (match-string 1 s)) t t s)))
7873 s)
7875 (defvar org-priority-regexp) ; defined later in the file
7877 (defvar org-after-sorting-entries-or-items-hook nil
7878 "Hook that is run after a bunch of entries or items have been sorted.
7879 When children are sorted, the cursor is in the parent line when this
7880 hook gets called. When a region or a plain list is sorted, the cursor
7881 will be in the first entry of the sorted region/list.")
7883 (defun org-sort-entries
7884 (&optional with-case sorting-type getkey-func compare-func property)
7885 "Sort entries on a certain level of an outline tree.
7886 If there is an active region, the entries in the region are sorted.
7887 Else, if the cursor is before the first entry, sort the top-level items.
7888 Else, the children of the entry at point are sorted.
7890 Sorting can be alphabetically, numerically, by date/time as given by
7891 a time stamp, by a property or by priority.
7893 The command prompts for the sorting type unless it has been given to the
7894 function through the SORTING-TYPE argument, which needs to be a character,
7895 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7896 precise meaning of each character:
7898 n Numerically, by converting the beginning of the entry/item to a number.
7899 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7900 t By date/time, either the first active time stamp in the entry, or, if
7901 none exist, by the first inactive one.
7902 s By the scheduled date/time.
7903 d By deadline date/time.
7904 c By creation time, which is assumed to be the first inactive time stamp
7905 at the beginning of a line.
7906 p By priority according to the cookie.
7907 r By the value of a property.
7909 Capital letters will reverse the sort order.
7911 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7912 called with point at the beginning of the record. It must return either
7913 a string or a number that should serve as the sorting key for that record.
7915 Comparing entries ignores case by default. However, with an optional argument
7916 WITH-CASE, the sorting considers case as well."
7917 (interactive "P")
7918 (let ((case-func (if with-case 'identity 'downcase))
7919 start beg end stars re re2
7920 txt what tmp)
7921 ;; Find beginning and end of region to sort
7922 (cond
7923 ((org-region-active-p)
7924 ;; we will sort the region
7925 (setq end (region-end)
7926 what "region")
7927 (goto-char (region-beginning))
7928 (if (not (org-on-heading-p)) (outline-next-heading))
7929 (setq start (point)))
7930 ((or (org-on-heading-p)
7931 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7932 ;; we will sort the children of the current headline
7933 (org-back-to-heading)
7934 (setq start (point)
7935 end (progn (org-end-of-subtree t t)
7937 (org-back-over-empty-lines)
7938 (point))
7939 what "children")
7940 (goto-char start)
7941 (show-subtree)
7942 (outline-next-heading))
7943 (t
7944 ;; we will sort the top-level entries in this file
7945 (goto-char (point-min))
7946 (or (org-on-heading-p) (outline-next-heading))
7947 (setq start (point))
7948 (goto-char (point-max))
7949 (beginning-of-line 1)
7951 ;; File ends in a non-white line
7952 (end-of-line 1)
7954 (setq end (point-max))
7955 (setq what "top-level")
7956 (goto-char start)
7957 (show-all)))
7959 (setq beg (point))
7960 (if (>= beg end) (error "Nothing to sort"))
7963 (setq stars (match-string 1)
7964 re (concat "^" (regexp-quote stars) " +")
7966 txt (buffer-substring beg end))
7968 (if (and (not (equal stars "*")) (string-match re2 txt))
7969 (error "Region to sort contains a level above the first entry"))
7971 (unless sorting-type
7972 (message
7973 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7975 A/N/T/S/D/C/P/O/F means reversed:"
7976 what)
7977 (setq sorting-type (read-char-exclusive))
7979 (and (= (downcase sorting-type) ?f)
7980 (setq getkey-func
7981 (org-icompleting-read "Sort using function: "
7982 obarray 'fboundp t nil nil))
7983 (setq getkey-func (intern getkey-func)))
7985 (and (= (downcase sorting-type) ?r)
7986 (setq property
7987 (org-icompleting-read "Property: "
7988 (mapcar 'list (org-buffer-property-keys t))
7989 nil t))))
7991 (message "Sorting entries...")
7993 (save-restriction
7994 (narrow-to-region start end)
7995 (let ((dcst (downcase sorting-type))
7996 (case-fold-search nil)
7997 (now (current-time)))
7998 (sort-subr
7999 (/= dcst sorting-type)
8000 ;; This function moves to the beginning character of the "record" to
8001 ;; be sorted.
8002 (lambda nil
8003 (if (re-search-forward re nil t)
8004 (goto-char (match-beginning 0))
8005 (goto-char (point-max))))
8006 ;; This function moves to the last character of the "record" being
8007 ;; sorted.
8008 (lambda nil
8009 (save-match-data
8010 (condition-case nil
8011 (outline-forward-same-level 1)
8012 (error
8013 (goto-char (point-max))))))
8014 ;; This function returns the value that gets sorted against.
8015 (lambda nil
8016 (cond
8017 ((= dcst ?n)
8018 (if (looking-at org-complex-heading-regexp)
8019 (string-to-number (match-string 4))
8020 nil))
8021 ((= dcst ?a)
8022 (if (looking-at org-complex-heading-regexp)
8023 (funcall case-func (match-string 4))
8024 nil))
8025 ((= dcst ?t)
8026 (let ((end (save-excursion (outline-next-heading) (point))))
8027 (if (or (re-search-forward org-ts-regexp end t)
8028 (re-search-forward org-ts-regexp-both end t))
8029 (org-time-string-to-seconds (match-string 0))
8030 (org-float-time now))))
8031 ((= dcst ?c)
8032 (let ((end (save-excursion (outline-next-heading) (point))))
8033 (if (re-search-forward
8035 end t)
8036 (org-time-string-to-seconds (match-string 0))
8037 (org-float-time now))))
8038 ((= dcst ?s)
8039 (let ((end (save-excursion (outline-next-heading) (point))))
8040 (if (re-search-forward org-scheduled-time-regexp end t)
8041 (org-time-string-to-seconds (match-string 1))
8042 (org-float-time now))))
8043 ((= dcst ?d)
8044 (let ((end (save-excursion (outline-next-heading) (point))))
8045 (if (re-search-forward org-deadline-time-regexp end t)
8046 (org-time-string-to-seconds (match-string 1))
8047 (org-float-time now))))
8048 ((= dcst ?p)
8049 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8050 (string-to-char (match-string 2))
8051 org-default-priority))
8052 ((= dcst ?r)
8053 (or (org-entry-get nil property) ""))
8054 ((= dcst ?o)
8055 (if (looking-at org-complex-heading-regexp)
8056 (- 9999 (length (member (match-string 2)
8057 org-todo-keywords-1)))))
8058 ((= dcst ?f)
8059 (if getkey-func
8060 (progn
8061 (setq tmp (funcall getkey-func))
8062 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8063 tmp)
8064 (error "Invalid key function `%s'" getkey-func)))
8065 (t (error "Invalid sorting type `%c'" sorting-type))))
8066 nil
8067 (cond
8068 ((= dcst ?a) 'string<)
8069 ((= dcst ?f) compare-func)
8070 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8071 (t nil)))))
8072 (run-hooks 'org-after-sorting-entries-or-items-hook)
8073 (message "Sorting entries...done")))
8075 (defun org-do-sort (table what &optional with-case sorting-type)
8076 "Sort TABLE of WHAT according to SORTING-TYPE.
8077 The user will be prompted for the SORTING-TYPE if the call to this
8078 function does not specify it. WHAT is only for the prompt, to indicate
8079 what is being sorted. The sorting key will be extracted from
8080 the car of the elements of the table.
8081 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8082 (unless sorting-type
8083 (message
8084 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8085 what)
8086 (setq sorting-type (read-char-exclusive)))
8087 (let ((dcst (downcase sorting-type))
8088 extractfun comparefun)
8089 ;; Define the appropriate functions
8090 (cond
8091 ((= dcst ?n)
8092 (setq extractfun 'string-to-number
8093 comparefun (if (= dcst sorting-type) '< '>)))
8094 ((= dcst ?a)
8095 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8096 (lambda(x) (downcase (org-sort-remove-invisible x))))
8097 comparefun (if (= dcst sorting-type)
8098 'string<
8099 (lambda (a b) (and (not (string< a b))
8100 (not (string= a b)))))))
8101 ((= dcst ?t)
8102 (setq extractfun
8103 (lambda (x)
8104 (if (or (string-match org-ts-regexp x)
8105 (string-match org-ts-regexp-both x))
8106 (org-float-time
8107 (org-time-string-to-time (match-string 0 x)))
8108 0))
8109 comparefun (if (= dcst sorting-type) '< '>)))
8110 (t (error "Invalid sorting type `%c'" sorting-type)))
8112 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8113 table)
8114 (lambda (a b) (funcall comparefun (car a) (car b))))))
8117 ;;; The orgstruct minor mode
8119 ;; Define a minor mode which can be used in other modes in order to
8120 ;; integrate the org-mode structure editing commands.
8122 ;; This is really a hack, because the org-mode structure commands use
8123 ;; keys which normally belong to the major mode. Here is how it
8124 ;; works: The minor mode defines all the keys necessary to operate the
8125 ;; structure commands, but wraps the commands into a function which
8126 ;; tests if the cursor is currently at a headline or a plain list
8127 ;; item. If that is the case, the structure command is used,
8128 ;; temporarily setting many Org-mode variables like regular
8129 ;; expressions for filling etc. However, when any of those keys is
8130 ;; used at a different location, function uses `key-binding' to look
8131 ;; up if the key has an associated command in another currently active
8132 ;; keymap (minor modes, major mode, global), and executes that
8133 ;; command. There might be problems if any of the keys is otherwise
8134 ;; used as a prefix key.
8136 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8137 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8138 ;; addresses this by checking explicitly for both bindings.
8140 (defvar orgstruct-mode-map (make-sparse-keymap)
8141 "Keymap for the minor `orgstruct-mode'.")
8143 (defvar org-local-vars nil
8144 "List of local variables, for use by `orgstruct-mode'.")
8146 ;;;###autoload
8147 (define-minor-mode orgstruct-mode
8148 "Toggle the minor mode `orgstruct-mode'.
8149 This mode is for using Org-mode structure commands in other
8150 modes. The following keys behave as if Org-mode were active, if
8151 the cursor is on a headline, or on a plain list item (both as
8152 defined by Org-mode).
8154 M-up Move entry/item up
8155 M-down Move entry/item down
8156 M-left Promote
8157 M-right Demote
8158 M-S-up Move entry/item up
8159 M-S-down Move entry/item down
8160 M-S-left Promote subtree
8161 M-S-right Demote subtree
8162 M-q Fill paragraph and items like in Org-mode
8163 C-c ^ Sort entries
8164 C-c - Cycle list bullet
8165 TAB Cycle item visibility
8166 M-RET Insert new heading/item
8167 S-M-RET Insert new TODO heading / Checkbox item
8168 C-c C-c Set tags / toggle checkbox"
8169 nil " OrgStruct" nil
8170 (org-load-modules-maybe)
8171 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8173 ;;;###autoload
8174 (defun turn-on-orgstruct ()
8175 "Unconditionally turn on `orgstruct-mode'."
8176 (orgstruct-mode 1))
8178 (defun orgstruct++-mode (&optional arg)
8179 "Toggle `orgstruct-mode', the enhanced version of it.
8180 In addition to setting orgstruct-mode, this also exports all indentation
8181 and autofilling variables from org-mode into the buffer. It will also
8182 recognize item context in multiline items.
8183 Note that turning off orgstruct-mode will *not* remove the
8184 indentation/paragraph settings. This can only be done by refreshing the
8186 (interactive "P")
8187 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8188 (if (< arg 1)
8189 (orgstruct-mode -1)
8190 (orgstruct-mode 1)
8191 (let (var val)
8192 (mapc
8193 (lambda (x)
8194 (when (string-match
8196 (symbol-name (car x)))
8197 (setq var (car x) val (nth 1 x))
8198 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8199 org-local-vars)
8200 (org-set-local 'orgstruct-is-++ t))))
8202 (defvar orgstruct-is-++ nil
8203 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8204 (make-variable-buffer-local 'orgstruct-is-++)
8206 ;;;###autoload
8207 (defun turn-on-orgstruct++ ()
8208 "Unconditionally turn on `orgstruct++-mode'."
8209 (orgstruct++-mode 1))
8211 (defun orgstruct-error ()
8212 "Error when there is no default binding for a structure key."
8213 (interactive)
8214 (error "This key has no function outside structure elements"))
8216 (defun orgstruct-setup ()
8217 "Setup orgstruct keymaps."
8218 (let ((nfunc 0)
8219 (bindings
8220 (list
8221 '([(meta up)] org-metaup)
8222 '([(meta down)] org-metadown)
8223 '([(meta left)] org-metaleft)
8224 '([(meta right)] org-metaright)
8225 '([(meta shift up)] org-shiftmetaup)
8226 '([(meta shift down)] org-shiftmetadown)
8227 '([(meta shift left)] org-shiftmetaleft)
8228 '([(meta shift right)] org-shiftmetaright)
8229 '([?\e (up)] org-metaup)
8230 '([?\e (down)] org-metadown)
8231 '([?\e (left)] org-metaleft)
8232 '([?\e (right)] org-metaright)
8233 '([?\e (shift up)] org-shiftmetaup)
8234 '([?\e (shift down)] org-shiftmetadown)
8235 '([?\e (shift left)] org-shiftmetaleft)
8236 '([?\e (shift right)] org-shiftmetaright)
8237 '([(shift up)] org-shiftup)
8238 '([(shift down)] org-shiftdown)
8239 '([(shift left)] org-shiftleft)
8240 '([(shift right)] org-shiftright)
8241 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8242 '("\M-q" fill-paragraph)
8243 '("\C-c^" org-sort)
8244 '("\C-c-" org-cycle-list-bullet)))
8245 elt key fun cmd)
8246 (while (setq elt (pop bindings))
8247 (setq nfunc (1+ nfunc))
8248 (setq key (org-key (car elt))
8249 fun (nth 1 elt)
8250 cmd (orgstruct-make-binding fun nfunc key))
8251 (org-defkey orgstruct-mode-map key cmd))
8253 ;; Special treatment needed for TAB and RET
8254 (org-defkey orgstruct-mode-map [(tab)]
8255 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8256 (org-defkey orgstruct-mode-map "\C-i"
8257 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8259 (org-defkey orgstruct-mode-map "\M-\C-m"
8260 (orgstruct-make-binding 'org-insert-heading 105
8261 "\M-\C-m" [(meta return)]))
8262 (org-defkey orgstruct-mode-map [(meta return)]
8263 (orgstruct-make-binding 'org-insert-heading 106
8264 [(meta return)] "\M-\C-m"))
8266 (org-defkey orgstruct-mode-map [(shift meta return)]
8267 (orgstruct-make-binding 'org-insert-todo-heading 107
8268 [(meta return)] "\M-\C-m"))
8270 (org-defkey orgstruct-mode-map "\e\C-m"
8271 (orgstruct-make-binding 'org-insert-heading 108
8272 "\e\C-m" [?\e (return)]))
8273 (org-defkey orgstruct-mode-map [?\e (return)]
8274 (orgstruct-make-binding 'org-insert-heading 109
8275 [?\e (return)] "\e\C-m"))
8276 (org-defkey orgstruct-mode-map [?\e (shift return)]
8277 (orgstruct-make-binding 'org-insert-todo-heading 110
8278 [?\e (return)] "\e\C-m"))
8280 (unless org-local-vars
8281 (setq org-local-vars (org-get-local-variables)))
8283 t))
8285 (defun orgstruct-make-binding (fun n &rest keys)
8286 "Create a function for binding in the structure minor mode.
8287 FUN is the command to call inside a table. N is used to create a unique
8288 command name. KEYS are keys that should be checked in for a command
8289 to execute outside of tables."
8290 (eval
8291 (list 'defun
8292 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8293 '(arg)
8295 "Outside of structure, run the binding of `"
8296 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8297 "'.")
8298 '(interactive "p")
8299 (list 'if
8300 `(org-context-p 'headline 'item
8301 (and orgstruct-is-++
8302 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8303 'item-body))
8304 (list 'org-run-like-in-org-mode (list 'quote fun))
8305 (list 'let '(orgstruct-mode)
8306 (list 'call-interactively
8307 (append '(or)
8308 (mapcar (lambda (k)
8309 (list 'key-binding k))
8310 keys)
8311 '('orgstruct-error))))))))
8313 (defun org-context-p (&rest contexts)
8314 "Check if local context is any of CONTEXTS.
8315 Possible values in the list of contexts are `table', `headline', and `item'."
8316 (let ((pos (point)))
8317 (goto-char (point-at-bol))
8318 (prog1 (or (and (memq 'table contexts)
8320 (and (memq 'headline contexts)
8321 (looking-at org-outline-regexp))
8322 (and (memq 'item contexts)
8324 (and (memq 'item-body contexts)
8325 (org-in-item-p)))
8326 (goto-char pos))))
8328 (defun org-get-local-variables ()
8329 "Return a list of all local variables in an org-mode buffer."
8330 (let (varlist)
8331 (with-current-buffer (get-buffer-create "*Org tmp*")
8332 (erase-buffer)
8333 (org-mode)
8334 (setq varlist (buffer-local-variables)))
8335 (kill-buffer "*Org tmp*")
8336 (delq nil
8337 (mapcar
8338 (lambda (x)
8339 (setq x
8340 (if (symbolp x)
8341 (list x)
8342 (list (car x) (list 'quote (cdr x)))))
8343 (if (string-match
8344 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8345 (symbol-name (car x)))
8346 x nil))
8347 varlist))))
8349 (defun org-clone-local-variables (from-buffer &optional regexp)
8350 "Clone local variables from FROM-BUFFER.
8351 Optional argument REGEXP selects variables to clone."
8352 (mapc
8353 (lambda (pair)
8354 (and (symbolp (car pair))
8355 (or (null regexp)
8356 (string-match regexp (symbol-name (car pair))))
8357 (set (make-local-variable (car pair))
8358 (cdr pair))))
8359 (buffer-local-variables from-buffer)))
8361 ;;;###autoload
8362 (defun org-run-like-in-org-mode (cmd)
8363 "Run a command, pretending that the current buffer is in Org-mode.
8364 This will temporarily bind local variables that are typically bound in
8365 Org-mode to the values they have in Org-mode, and then interactively
8366 call CMD."
8367 (org-load-modules-maybe)
8368 (unless org-local-vars
8369 (setq org-local-vars (org-get-local-variables)))
8370 (eval (list 'let org-local-vars
8371 (list 'call-interactively (list 'quote cmd)))))
8373 ;;;; Archiving
8375 (defun org-get-category (&optional pos force-refresh)
8376 "Get the category applying to position POS."
8377 (if force-refresh (org-refresh-category-properties))
8378 (let ((pos (or pos (point))))
8379 (or (get-text-property pos 'org-category)
8380 (progn (org-refresh-category-properties)
8381 (get-text-property pos 'org-category)))))
8383 (defun org-refresh-category-properties ()
8384 "Refresh category text properties in the buffer."
8385 (let ((def-cat (cond
8386 ((null org-category)
8387 (if buffer-file-name
8388 (file-name-sans-extension
8389 (file-name-nondirectory buffer-file-name))
8390 "???"))
8391 ((symbolp org-category) (symbol-name org-category))
8392 (t org-category)))
8393 beg end cat pos optionp)
8394 (org-unmodified
8395 (save-excursion
8396 (save-restriction
8397 (widen)
8398 (goto-char (point-min))
8399 (put-text-property (point) (point-max) 'org-category def-cat)
8400 (while (re-search-forward
8402 (setq pos (match-end 0)
8403 optionp (equal (char-after (match-beginning 0)) ?#)
8404 cat (org-trim (match-string 2)))
8405 (if optionp
8406 (setq beg (point-at-bol) end (point-max))
8407 (org-back-to-heading t)
8408 (setq beg (point) end (org-end-of-subtree t t)))
8409 (put-text-property beg end 'org-category cat)
8410 (put-text-property beg end 'org-category-position beg)
8411 (goto-char pos)))))))
8414 ;;;; Link Stuff
8416 ;;; Link abbreviations
8418 (defun org-link-expand-abbrev (link)
8419 "Apply replacements as defined in `org-link-abbrev-alist."
8421 (let* ((key (match-string 1 link))
8422 (as (or (assoc key org-link-abbrev-alist-local)
8423 (assoc key org-link-abbrev-alist)))
8424 (tag (and (match-end 2) (match-string 3 link)))
8425 rpl)
8426 (if (not as)
8427 link
8428 (setq rpl (cdr as))
8429 (cond
8430 ((symbolp rpl) (funcall rpl tag))
8431 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8432 ((string-match "%h" rpl)
8433 (replace-match (url-hexify-string (or tag "")) t t rpl))
8434 (t (concat rpl tag)))))
8435 link))
8437 ;;; Storing and inserting links
8439 (defvar org-insert-link-history nil
8440 "Minibuffer history for links inserted with `org-insert-link'.")
8442 (defvar org-stored-links nil
8443 "Contains the links stored with `org-store-link'.")
8445 (defvar org-store-link-plist nil
8446 "Plist with info about the most recently link created with `org-store-link'.")
8448 (defvar org-link-protocols nil
8449 "Link protocols added to Org-mode using `org-add-link-type'.")
8451 (defvar org-store-link-functions nil
8452 "List of functions that are called to create and store a link.
8453 Each function will be called in turn until one returns a non-nil
8454 value. Each function should check if it is responsible for creating
8455 this link (for example by looking at the major mode).
8456 If not, it must exit and return nil.
8457 If yes, it should return a non-nil value after a calling
8458 `org-store-link-props' with a list of properties and values.
8459 Special properties are:
8463 This is obligatory as well.
8464 :description Optional default description for the second pair
8465 of brackets in an Org-mode link. The user can still change
8466 this when inserting this link into an Org-mode buffer.
8468 In addition to these, any additional properties can be specified
8469 and then used in remember templates.")
8471 (defun org-add-link-type (type &optional follow export)
8472 "Add TYPE to the list of `org-link-types'.
8473 Re-compute all regular expressions depending on `org-link-types'
8475 FOLLOW and EXPORT are two functions.
8477 FOLLOW should take the link path as the single argument and do whatever
8478 is necessary to follow the link, for example find a file or display
8479 a mail message.
8481 EXPORT should format the link path for export to one of the export formats.
8482 It should be a function accepting three arguments:
8485 desc the description of the link, if any, or a description added by
8486 org-export-normalize-links if there is none
8487 format the export format, a symbol like `html' or `latex' or `ascii'..
8489 The function may use the FORMAT information to return different values
8490 depending on the format. The return value will be put literally into
8491 the exported file. If the return value is nil, this means Org should
8492 do what it normally does with links which do not have EXPORT defined.
8494 Org-mode has a built-in default for exporting links. If you are happy with
8495 this default, there is no need to define an export function for the link
8496 type. For a simple example of an export function, see `org-bbdb.el'."
8497 (add-to-list 'org-link-types type t)
8498 (org-make-link-regexps)
8499 (if (assoc type org-link-protocols)
8500 (setcdr (assoc type org-link-protocols) (list follow export))
8501 (push (list type follow export) org-link-protocols)))
8503 (defvar org-agenda-buffer-name)
8505 ;;;###autoload
8506 (defun org-store-link (arg)
8508 This link is added to `org-stored-links' and can later be inserted
8511 For some link types, a prefix arg is interpreted:
8512 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8513 For file links, arg negates `org-context-in-file-links'."
8514 (interactive "P")
8515 (org-load-modules-maybe)
8516 (setq org-store-link-plist nil) ; reset
8517 (org-with-limited-levels
8518 (let (link cpltxt desc description search txt custom-id agenda-link)
8519 (cond
8521 ((run-hook-with-args-until-success 'org-store-link-functions)
8522 (setq link (plist-get org-store-link-plist :link)
8523 desc (or (plist-get org-store-link-plist :description) link)))
8525 ((equal (buffer-name) "*Org Edit Src Example*")
8526 (let (label gc)
8527 (while (or (not label)
8528 (save-excursion
8529 (save-restriction
8530 (widen)
8531 (goto-char (point-min))
8532 (re-search-forward
8533 (regexp-quote (format org-coderef-label-format label))
8534 nil t))))
8535 (when label (message "Label exists already") (sit-for 2))
8536 (setq label (read-string "Code line label: " label)))
8537 (end-of-line 1)
8538 (setq link (format org-coderef-label-format label))
8539 (setq gc (- 79 (length link)))
8540 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8541 (insert link)
8542 (setq link (concat "(" label ")") desc nil)))
8544 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8545 ;; We are in the agenda, link to referenced location
8546 (let ((m (or (get-text-property (point) 'org-hd-marker)
8547 (get-text-property (point) 'org-marker))))
8548 (when m
8549 (org-with-point-at m
8550 (setq agenda-link
8551 (if (org-called-interactively-p 'any)
8552 (call-interactively 'org-store-link)
8553 (org-store-link nil)))))))
8555 ((eq major-mode 'calendar-mode)
8556 (let ((cd (calendar-cursor-to-date)))
8557 (setq link
8558 (format-time-string
8559 (car org-time-stamp-formats)
8560 (apply 'encode-time
8561 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8562 nil nil nil))))
8563 (org-store-link-props :type "calendar" :date cd)))
8565 ((eq major-mode 'w3-mode)
8566 (setq cpltxt (if (and (buffer-name)
8567 (not (string-match "Untitled" (buffer-name))))
8568 (buffer-name)
8569 (url-view-url t))
8570 link (org-make-link (url-view-url t)))
8571 (org-store-link-props :type "w3" :url (url-view-url t)))
8573 ((eq major-mode 'w3m-mode)
8574 (setq cpltxt (or w3m-current-title w3m-current-url)
8575 link (org-make-link w3m-current-url))
8576 (org-store-link-props :type "w3m" :url (url-view-url t)))
8578 ((setq search (run-hook-with-args-until-success
8579 'org-create-file-search-functions))
8580 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8581 "::" search))
8582 (setq cpltxt (or description link)))
8584 ((eq major-mode 'image-mode)
8585 (setq cpltxt (concat "file:"
8586 (abbreviate-file-name buffer-file-name))
8587 link (org-make-link cpltxt))
8588 (org-store-link-props :type "image" :file buffer-file-name))
8590 ((eq major-mode 'dired-mode)
8591 ;; link to the file in the current line
8592 (let ((file (dired-get-filename nil t)))
8593 (setq file (if file
8594 (abbreviate-file-name
8595 (expand-file-name (dired-get-filename nil t)))
8596 ;; otherwise, no file so use current directory.
8597 default-directory))
8598 (setq cpltxt (concat "file:" file)
8599 link (org-make-link cpltxt))))
8601 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8602 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8603 (cond
8605 (setq cpltxt
8606 (concat "file:"
8607 (abbreviate-file-name
8608 (buffer-file-name (buffer-base-buffer)))
8609 "::" (match-string 1))
8610 link (org-make-link cpltxt)))
8611 ((and (featurep 'org-id)
8612 (or (eq org-link-to-org-use-id t)
8613 (and (eq org-link-to-org-use-id 'create-if-interactive)
8614 (org-called-interactively-p 'any))
8615 (and (eq org-link-to-org-use-id
8616 'create-if-interactive-and-no-custom-id)
8617 (org-called-interactively-p 'any)
8618 (not custom-id))
8619 (and org-link-to-org-use-id
8620 (org-entry-get nil "ID"))))
8621 ;; We can make a link using the ID.
8622 (setq link (condition-case nil
8623 (prog1 (org-id-store-link)
8624 (setq desc (plist-get org-store-link-plist
8625 :description)))
8626 (error
8627 ;; probably before first headline, link to file only
8628 (concat "file:"
8629 (abbreviate-file-name
8630 (buffer-file-name (buffer-base-buffer))))))))
8631 (t
8632 ;; Just link to current headline
8633 (setq cpltxt (concat "file:"
8634 (abbreviate-file-name
8635 (buffer-file-name (buffer-base-buffer)))))
8636 ;; Add a context search string
8637 (when (org-xor org-context-in-file-links arg)
8638 (setq txt (cond
8639 ((org-on-heading-p) nil)
8640 ((org-region-active-p)
8641 (buffer-substring (region-beginning) (region-end)))
8642 (t nil)))
8644 (setq cpltxt
8645 (concat cpltxt "::"
8646 (condition-case nil
8647 (org-make-org-heading-search-string txt)
8648 (error "")))
8649 desc (or (nth 4 (ignore-errors
8650 (org-heading-components))) "NONE"))))
8652 (setq cpltxt (substring cpltxt 0 -2)))
8653 (setq link (org-make-link cpltxt)))))
8655 ((buffer-file-name (buffer-base-buffer))
8656 ;; Just link to this file here.
8657 (setq cpltxt (concat "file:"
8658 (abbreviate-file-name
8659 (buffer-file-name (buffer-base-buffer)))))
8660 ;; Add a context string
8661 (when (org-xor org-context-in-file-links arg)
8662 (setq txt (if (org-region-active-p)
8663 (buffer-substring (region-beginning) (region-end))
8664 (buffer-substring (point-at-bol) (point-at-eol))))
8665 ;; Only use search option if there is some text.
8667 (setq cpltxt
8668 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8669 desc "NONE")))
8670 (setq link (org-make-link cpltxt)))
8672 ((org-called-interactively-p 'interactive)
8673 (error "Cannot link to a buffer which is not visiting a file"))
8675 (t (setq link nil)))
8677 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8678 (setq link (or link cpltxt)
8679 desc (or desc cpltxt))
8680 (if (equal desc "NONE") (setq desc nil))
8682 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8683 (progn
8684 (setq org-stored-links
8685 (cons (list link desc) org-stored-links))
8686 (message "Stored: %s" (or desc link))
8687 (when custom-id
8688 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8689 "::#" custom-id))
8690 (setq org-stored-links
8691 (cons (list link desc) org-stored-links))))
8692 (or agenda-link (and link (org-make-link-string link desc)))))))
8694 (defun org-store-link-props (&rest plist)
8695 "Store link properties, extract names and addresses."
8696 (let (x adr)
8697 (when (setq x (plist-get plist :from))
8698 (setq adr (mail-extract-address-components x))
8699 (setq plist (plist-put plist :fromname (car adr)))
8700 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8701 (when (setq x (plist-get plist :to))
8702 (setq adr (mail-extract-address-components x))
8703 (setq plist (plist-put plist :toname (car adr)))
8704 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8705 (let ((from (plist-get plist :from))
8706 (to (plist-get plist :to)))
8707 (when (and from to org-from-is-user-regexp)
8708 (setq plist
8709 (plist-put plist :fromto
8710 (if (string-match org-from-is-user-regexp from)
8711 (concat "to %t")
8712 (concat "from %f"))))))
8713 (setq org-store-link-plist plist))
8715 (defun org-add-link-props (&rest plist)
8716 "Add these properties to the link property list."
8717 (let (key value)
8718 (while plist
8719 (setq key (pop plist) value (pop plist))
8720 (setq org-store-link-plist
8721 (plist-put org-store-link-plist key value)))))
8723 (defun org-email-link-description (&optional fmt)
8724 "Return the description part of an email link.
8725 This takes information from `org-store-link-plist' and formats it
8726 according to FMT (default from `org-email-link-description-format')."
8727 (setq fmt (or fmt org-email-link-description-format))
8728 (let* ((p org-store-link-plist)
8729 (to (plist-get p :toaddress))
8730 (from (plist-get p :fromaddress))
8731 (table
8732 (list
8733 (cons "%c" (plist-get p :fromto))
8734 (cons "%F" (plist-get p :from))
8735 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8736 (cons "%T" (plist-get p :to))
8737 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8738 (cons "%s" (plist-get p :subject))
8739 (cons "%d" (plist-get p :date))
8740 (cons "%m" (plist-get p :message-id)))))
8741 (when (string-match "%c" fmt)
8742 ;; Check if the user wrote this message
8743 (if (and org-from-is-user-regexp from to
8744 (save-match-data (string-match org-from-is-user-regexp from)))
8745 (setq fmt (replace-match "to %t" t t fmt))
8746 (setq fmt (replace-match "from %f" t t fmt))))
8747 (org-replace-escapes fmt table)))
8749 (defun org-make-org-heading-search-string (&optional string heading)
8750 "Make search string for STRING or current headline."
8751 (interactive)
8752 (let ((s (or string (org-get-heading)))
8753 (lines org-context-in-file-links))
8754 (unless (and string (not heading))
8755 ;; We are using a headline, clean up garbage in there.
8756 (if (string-match org-todo-regexp s)
8757 (setq s (replace-match "" t t s)))
8759 (setq s (replace-match "" t t s)))
8760 (setq s (org-trim s))
8763 (setq s (replace-match "" t t s)))
8764 (while (string-match org-ts-regexp s)
8765 (setq s (replace-match "" t t s))))
8766 (or string (setq s (concat "*" s))) ; Add * for headlines
8767 (when (and string (integerp lines) (> lines 0))
8769 (when (< lines (length slines))
8770 (setq s (mapconcat
8771 'identity
8772 (reverse (nthcdr (- (length slines) lines)
8776 (defun org-make-link (&rest strings)
8777 "Concatenate STRINGS."
8778 (apply 'concat strings))
8780 (defun org-make-link-string (link &optional description)
8781 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8783 (error "Empty link"))
8784 (when (and description
8785 (stringp description)
8787 (setq description nil))
8788 (when (stringp description)
8789 ;; Remove brackets from the description, they are fatal.
8791 (setq description (replace-match "{" t t description)))
8793 (setq description (replace-match "}" t t description))))
8794 (when (equal link description)
8795 ;; No description needed, it is identical
8796 (setq description nil))
8797 (when (and (not description)
8798 (not (string-match (org-image-file-name-regexp) link))
8799 (not (equal link (org-link-escape link))))
8800 (setq description (org-extract-attributes link)))
8801 (setq link
8802 (cond ((string-match (org-image-file-name-regexp) link) link)
8803 ((string-match org-link-types-re link)
8804 (concat (match-string 1 link)
8805 (org-link-escape (substring link (match-end 1)))))
8806 (t (org-link-escape link))))
8807 (concat "[[" link "]"
8808 (if description (concat "[" description "]") "")
8809 "]"))
8811 (defconst org-link-escape-chars
8812 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8813 "List of characters that should be escaped in link.
8814 This is the list that is used for internal purposes.")
8816 (defvar org-url-encoding-use-url-hexify nil)
8818 (defconst org-link-escape-chars-browser
8819 '(?\ )
8820 "List of escapes for characters that are problematic in links.
8821 This is the list that is used before handing over to the browser.")
8823 (defun org-link-escape (text &optional table merge)
8824 "Return percent escaped representation of TEXT.
8825 TEXT is a string with the text to escape.
8826 Optional argument TABLE is a list with characters that should be
8827 escaped. When nil, `org-link-escape-chars' is used.
8828 If optional argument MERGE is set, merge TABLE into
8829 `org-link-escape-chars'."
8830 (if (and org-url-encoding-use-url-hexify (not table))
8831 (url-hexify-string text)
8832 (cond
8833 ((and table merge)
8834 (mapc (lambda (defchr)
8835 (unless (member defchr table)
8836 (setq table (cons defchr table)))) org-link-escape-chars))
8837 ((null table)
8838 (setq table org-link-escape-chars)))
8839 (mapconcat
8840 (lambda (char)
8841 (if (or (member char table)
8842 (< char 32) (= char 37) (> char 126))
8843 (mapconcat (lambda (sequence-element)
8844 (format "%%%.2X" sequence-element))
8845 (or (encode-coding-char char 'utf-8)
8846 (error "Unable to percent escape character: %s"
8847 (char-to-string char))) "")
8848 (char-to-string char))) text "")))
8850 (defun org-link-unescape (str)
8851 "Unhex hexified unicode strings as returned from the JavaScript function
8852 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8853 (unless (and (null str) (string= "" str))
8854 (let ((pos 0) (case-fold-search t) unhexed)
8856 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8857 (setq str (replace-match unhexed t t str))
8858 (setq pos (+ pos (length unhexed))))))
8859 str)
8861 (defun org-link-unescape-compound (hex)
8862 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8863 Note: this function also decodes single byte encodings like
8865 (save-match-data
8866 (let* ((bytes (cdr (split-string hex "%")))
8867 (ret "")
8868 (eat 0)
8869 (sum 0))
8870 (while bytes
8871 (let* ((val (string-to-number (pop bytes) 16))
8872 (shift-xor
8873 (if (= 0 eat)
8874 (cond
8875 ((>= val 252) (cons 6 252))
8876 ((>= val 248) (cons 5 248))
8877 ((>= val 240) (cons 4 240))
8878 ((>= val 224) (cons 3 224))
8879 ((>= val 192) (cons 2 192))
8880 (t (cons 0 0)))
8881 (cons 6 128))))
8882 (if (>= val 192) (setq eat (car shift-xor)))
8883 (setq val (logxor val (cdr shift-xor)))
8884 (setq sum (+ (lsh sum (car shift-xor)) val))
8885 (if (> eat 0) (setq eat (- eat 1)))
8886 (cond
8887 ((= 0 eat) ;multi byte
8888 (setq ret (concat ret (org-char-to-string sum)))
8889 (setq sum 0))
8890 ((not bytes) ; single byte(s)
8891 (setq ret (org-link-unescape-single-byte-sequence hex))))
8892 )) ;; end (while bytes
8893 ret )))
8895 (defun org-link-unescape-single-byte-sequence (hex)
8896 "Unhexify hex-encoded single byte character sequences."
8897 (mapconcat (lambda (byte)
8898 (char-to-string (string-to-number byte 16)))
8899 (cdr (split-string hex "%")) ""))
8901 (defun org-xor (a b)
8902 "Exclusive or."
8903 (if a (not b) b))
8905 (defun org-fixup-message-id-for-http (s)
8906 "Replace special characters in a message id, so it can be used in an http query."
8907 (when (string-match "%" s)
8908 (setq s (mapconcat (lambda (c)
8909 (if (eq c ?%)
8910 "%25"
8911 (char-to-string c)))
8912 s "")))
8913 (while (string-match "<" s)
8914 (setq s (replace-match "%3C" t t s)))
8915 (while (string-match ">" s)
8916 (setq s (replace-match "%3E" t t s)))
8917 (while (string-match "@" s)
8918 (setq s (replace-match "%40" t t s)))
8919 s)
8921 ;;;###autoload
8922 (defun org-insert-link-global ()
8923 "Insert a link like Org-mode does.
8924 This command can be called in any mode to insert a link in Org-mode syntax."
8925 (interactive)
8926 (org-load-modules-maybe)
8927 (org-run-like-in-org-mode 'org-insert-link))
8929 (defun org-insert-link (&optional complete-file link-location)
8930 "Insert a link. At the prompt, enter the link.
8932 Completion can be used to insert any of the link protocol prefixes like
8933 http or ftp in use.
8935 The history can be used to select a link previously stored with
8936 `org-store-link'. When the empty string is entered (i.e. if you just
8937 press RET at the prompt), the link defaults to the most recently
8938 stored link. As SPC triggers completion in the minibuffer, you need to
8939 use M-SPC or C-q SPC to force the insertion of a space character.
8941 You will also be prompted for a description, and if one is given, it will
8942 be displayed in the buffer instead of the link.
8944 If there is already a link at point, this command will allow you to edit link
8945 and description parts.
8948 be selected using completion. The path to the file will be relative to the
8949 current directory if the file is in the current directory or a subdirectory.
8950 Otherwise, the link will be the absolute path as completed in the minibuffer
8951 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8952 option `org-link-file-path-type'.
8955 the current directory or below.
8958 `org-keep-stored-link-after-insertion'.
8960 If `org-make-link-description-function' is non-nil, this function will be
8961 called with the link target, and the result will be the default
8962 link description.
8964 If the LINK-LOCATION parameter is non-nil, this value will be
8965 used as the link location instead of reading one interactively."
8966 (interactive "P")
8967 (let* ((wcf (current-window-configuration))
8968 (region (if (org-region-active-p)
8969 (buffer-substring (region-beginning) (region-end))))
8970 (remove (and region (list (region-beginning) (region-end))))
8971 (desc region)
8972 tmphist ; byte-compile incorrectly complains about this
8973 (link link-location)
8974 entry file all-prefixes)
8975 (cond
8976 (link-location) ; specified by arg, just use it.
8977 ((org-in-regexp org-bracket-link-regexp 1)
8978 ;; We do have a link at point, and we are going to edit it.
8979 (setq remove (list (match-beginning 0) (match-end 0)))
8980 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8981 (setq link (read-string "Link: "
8982 (org-link-unescape
8983 (org-match-string-no-properties 1)))))
8984 ((or (org-in-regexp org-angle-link-re)
8985 (org-in-regexp org-plain-link-re))
8986 ;; Convert to bracket link
8987 (setq remove (list (match-beginning 0) (match-end 0))
8988 link (read-string "Link: "
8989 (org-remove-angle-brackets (match-string 0)))))
8990 ((member complete-file '((4) (16)))
8991 ;; Completing read for file names.
8992 (setq link (org-file-complete-link complete-file)))
8993 (t
8994 ;; Read link, with completion for stored links.
8995 (with-output-to-temp-buffer "*Org Links*"
8996 (princ "Insert a link.
8998 (when org-stored-links
9000 (princ (mapconcat
9001 (lambda (x)
9002 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9004 (let ((cw (selected-window)))
9005 (select-window (get-buffer-window "*Org Links*" 'visible))
9006 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
9007 (unless (pos-visible-in-window-p (point-max))
9008 (org-fit-window-to-buffer))
9009 (and (window-live-p cw) (select-window cw)))
9010 ;; Fake a link history, containing the stored links.
9011 (setq tmphist (append (mapcar 'car org-stored-links)
9012 org-insert-link-history))
9013 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9014 (mapcar 'car org-link-abbrev-alist)
9015 org-link-types))
9016 (unwind-protect
9017 (progn
9018 (setq link
9019 (let ((org-completion-use-ido nil)
9020 (org-completion-use-iswitchb nil))
9021 (org-completing-read
9022 "Link: "
9023 (append
9024 (mapcar (lambda (x) (list (concat x ":")))
9025 all-prefixes)
9026 (mapcar 'car org-stored-links))
9027 nil nil nil
9028 'tmphist
9029 (car (car org-stored-links)))))
9031 (error "No link selected"))
9032 (if (or (member link all-prefixes)
9033 (and (equal ":" (substring link -1))
9034 (member (substring link 0 -1) all-prefixes)
9035 (setq link (substring link 0 -1))))
9036 (setq link (org-link-try-special-completion link))))
9037 (set-window-configuration wcf)
9038 (kill-buffer "*Org Links*"))
9039 (setq entry (assoc link org-stored-links))
9040 (or entry (push link org-insert-link-history))
9041 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9042 (not org-keep-stored-link-after-insertion))
9043 (setq org-stored-links (delq (assoc link org-stored-links)
9044 org-stored-links)))
9045 (setq desc (or desc (nth 1 entry)))))
9047 (if (string-match org-plain-link-re link)
9048 ;; URL-like link, normalize the use of angular brackets.
9049 (setq link (org-make-link (org-remove-angle-brackets link))))
9051 ;; Check if we are linking to the current file with a search option
9052 ;; If yes, simplify the link by using only the search option.
9053 (when (and buffer-file-name
9055 (let* ((path (match-string 1 link))
9056 (case-fold-search nil)
9057 (search (match-string 2 link)))
9058 (save-match-data
9059 (if (equal (file-truename buffer-file-name) (file-truename path))
9060 ;; We are linking to this same file, with a search option
9061 (setq link search)))))
9063 ;; Check if we can/should use a relative path. If yes, simplify the link
9065 (let* ((type (match-string 1 link))
9066 (path (match-string 2 link))
9067 (origpath path)
9068 (case-fold-search nil))
9069 (cond
9070 ((or (eq org-link-file-path-type 'absolute)
9071 (equal complete-file '(16)))
9072 (setq path (abbreviate-file-name (expand-file-name path))))
9073 ((eq org-link-file-path-type 'noabbrev)
9074 (setq path (expand-file-name path)))
9075 ((eq org-link-file-path-type 'relative)
9076 (setq path (file-relative-name path)))
9077 (t
9078 (save-match-data
9079 (if (string-match (concat "^" (regexp-quote
9080 (expand-file-name
9081 (file-name-as-directory
9082 default-directory))))
9083 (expand-file-name path))
9084 ;; We are linking a file with relative path name.
9085 (setq path (substring (expand-file-name path)
9086 (match-end 0)))
9087 (setq path (abbreviate-file-name (expand-file-name path)))))))
9088 (setq link (concat type path))
9089 (if (equal desc origpath)
9090 (setq desc path))))
9092 (if org-make-link-description-function
9093 (setq desc (funcall org-make-link-description-function link desc)))
9095 (setq desc (read-string "Description: " desc))
9097 (if remove (apply 'delete-region remove))
9098 (insert (org-make-link-string link desc))))
9100 (defun org-link-try-special-completion (type)
9101 "If there is completion support for link type TYPE, offer it."
9102 (let ((fun (intern (concat "org-" type "-complete-link"))))
9103 (if (functionp fun)
9104 (funcall fun)
9105 (read-string "Link (no completion support): " (concat type ":")))))
9107 (defun org-file-complete-link (&optional arg)
9108 "Create a file link using completion."
9109 (let (file link)
9110 (setq file (read-file-name "File: "))
9111 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9112 (pwd1 (file-name-as-directory (abbreviate-file-name
9113 (expand-file-name ".")))))
9114 (cond
9115 ((equal arg '(16))
9116 (setq link (org-make-link
9117 "file:"
9118 (abbreviate-file-name (expand-file-name file)))))
9120 (setq link (org-make-link "file:" (match-string 1 file))))
9122 (expand-file-name file))
9123 (setq link (org-make-link
9124 "file:" (match-string 1 (expand-file-name file)))))
9125 (t (setq link (org-make-link "file:" file)))))
9126 link))
9128 (defun org-completing-read (&rest args)
9129 "Completing-read with SPACE being a normal character."
9130 (let ((minibuffer-local-completion-map
9131 (copy-keymap minibuffer-local-completion-map)))
9132 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9133 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9134 (apply 'org-icompleting-read args)))
9136 (defun org-completing-read-no-i (&rest args)
9137 (let (org-completion-use-ido org-completion-use-iswitchb)
9138 (apply 'org-completing-read args)))
9140 (defun org-iswitchb-completing-read (prompt choices &rest args)
9141 "Use iswitch as a completing-read replacement to choose from choices.
9142 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9143 from."
9144 (let* ((iswitchb-use-virtual-buffers nil)
9145 (iswitchb-make-buflist-hook
9146 (lambda ()
9147 (setq iswitchb-temp-buflist choices))))
9148 (iswitchb-read-buffer prompt)))
9150 (defun org-icompleting-read (&rest args)
9151 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9152 (org-without-partial-completion
9153 (if (and org-completion-use-ido
9154 (fboundp 'ido-completing-read)
9155 (boundp 'ido-mode) ido-mode
9156 (listp (second args)))
9157 (let ((ido-enter-matching-directory nil))
9158 (apply 'ido-completing-read (concat (car args))
9159 (if (consp (car (nth 1 args)))
9160 (mapcar 'car (nth 1 args))
9161 (nth 1 args))
9162 (cddr args)))
9163 (if (and org-completion-use-iswitchb
9164 (boundp 'iswitchb-mode) iswitchb-mode
9165 (listp (second args)))
9166 (apply 'org-iswitchb-completing-read (concat (car args))
9167 (if (consp (car (nth 1 args)))
9168 (mapcar 'car (nth 1 args))
9169 (nth 1 args))
9170 (cddr args))
9171 (apply 'completing-read args)))))
9173 (defun org-extract-attributes (s)
9174 "Extract the attributes cookie from a string and set as text property."
9175 (let (a attr (start 0) key value)
9176 (save-match-data
9178 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9180 (setq key (match-string 1 a) value (match-string 2 a)
9181 start (match-end 0)
9182 attr (plist-put attr (intern key) value))))
9183 (org-add-props s nil 'org-attr attr))
9184 s))
9186 (defun org-extract-attributes-from-string (tag)
9187 (let (key value attr)
9189 (setq key (match-string 1 tag) value (match-string 2 tag)
9190 tag (replace-match "" t t tag)
9191 attr (plist-put attr (intern key) value)))
9192 (cons tag attr)))
9194 (defun org-attributes-to-string (plist)
9195 "Format a property list into an HTML attribute list."
9196 (let ((s "") key value)
9197 (while plist
9198 (setq key (pop plist) value (pop plist))
9199 (and value
9201 s))
9203 ;;; Opening/following a link
9205 (defvar org-link-search-failed nil)
9207 (defvar org-open-link-functions nil
9208 "Hook for functions finding a plain text link.
9209 These functions must take a single argument, the link content.
9210 They will be called for links that look like [[link text][description]]
9214 These functions will be called *before* Org attempts to resolve the
9215 link by doing text searches in the current buffer - so if you want a
9217 handle this as a special case.
9219 When the function does handle the link, it must return a non-nil value.
9220 If it decides that it is not responsible for this link, it must return
9221 nil to indicate that that Org-mode can continue with other options
9222 like exact and fuzzy text search.")
9224 (defun org-next-link ()
9225 "Move forward to the next link.
9226 If the link is in hidden text, expose it."
9227 (interactive)
9228 (when (and org-link-search-failed (eq this-command last-command))
9229 (goto-char (point-min))
9230 (message "Link search wrapped back to beginning of buffer"))
9231 (setq org-link-search-failed nil)
9232 (let* ((pos (point))
9233 (ct (org-context))
9234 (a (assoc :link ct)))
9235 (if a (goto-char (nth 2 a)))
9236 (if (re-search-forward org-any-link-re nil t)
9237 (progn
9238 (goto-char (match-beginning 0))
9239 (if (outline-invisible-p) (org-show-context)))
9240 (goto-char pos)
9241 (setq org-link-search-failed t)
9242 (error "No further link found"))))
9244 (defun org-previous-link ()
9245 "Move backward to the previous link.
9246 If the link is in hidden text, expose it."
9247 (interactive)
9248 (when (and org-link-search-failed (eq this-command last-command))
9249 (goto-char (point-max))
9250 (message "Link search wrapped back to end of buffer"))
9251 (setq org-link-search-failed nil)
9252 (let* ((pos (point))
9253 (ct (org-context))
9254 (a (assoc :link ct)))
9255 (if a (goto-char (nth 1 a)))
9256 (if (re-search-backward org-any-link-re nil t)
9257 (progn
9258 (goto-char (match-beginning 0))
9259 (if (outline-invisible-p) (org-show-context)))
9260 (goto-char pos)
9261 (setq org-link-search-failed t)
9262 (error "No further link found"))))
9264 (defun org-translate-link (s)
9265 "Translate a link string if a translation function has been defined."
9266 (if (and org-link-translation-function
9267 (fboundp org-link-translation-function)
9269 (progn
9270 (setq s (funcall org-link-translation-function
9271 (match-string 1) (match-string 2)))
9272 (concat (car s) ":" (cdr s)))
9273 s))
9275 (defun org-translate-link-from-planner (type path)
9276 "Translate a link from Emacs Planner syntax so that Org can follow it.
9277 This is still an experimental function, your mileage may vary."
9278 (cond
9279 ((member type '("http" "https" "news" "ftp"))
9280 ;; standard Internet links are the same.
9281 nil)
9282 ((and (equal type "irc") (string-match "^//" path))
9283 ;; Planner has two / at the beginning of an irc link, we have 1.
9284 ;; We should have zero, actually....
9285 (setq path (substring path 1)))
9286 ((and (equal type "lisp") (string-match "^/" path))
9287 ;; Planner has a slash, we do not.
9288 (setq type "elisp" path (substring path 1)))
9290 ;; A typical message link. Planner has the id after the final slash,
9291 ;; we separate it with a hash mark
9292 (setq path (concat (match-string 1 path) "#"
9293 (org-remove-angle-brackets (match-string 2 path)))))
9294 )
9295 (cons type path))
9297 (defun org-find-file-at-mouse (ev)
9298 "Open file link or URL at mouse."
9299 (interactive "e")
9300 (mouse-set-point ev)
9301 (org-open-at-point 'in-emacs))
9303 (defun org-open-at-mouse (ev)
9304 "Open file link or URL at mouse.
9305 See the docstring of `org-open-file' for details."
9306 (interactive "e")
9307 (mouse-set-point ev)
9308 (if (eq major-mode 'org-agenda-mode)
9309 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9310 (org-open-at-point))
9312 (defvar org-window-config-before-follow-link nil
9313 "The window configuration before following a link.
9314 This is saved in case the need arises to restore it.")
9316 (defvar org-open-link-marker (make-marker)
9317 "Marker pointing to the location where `org-open-at-point; was called.")
9319 ;;;###autoload
9320 (defun org-open-at-point-global ()
9321 "Follow a link like Org-mode does.
9322 This command can be called in any mode to follow a link that has
9323 Org-mode syntax."
9324 (interactive)
9325 (org-run-like-in-org-mode 'org-open-at-point))
9327 ;;;###autoload
9328 (defun org-open-link-from-string (s &optional arg reference-buffer)
9329 "Open a link in the string S, as if it was in Org-mode."
9331 (let ((reference-buffer (or reference-buffer (current-buffer))))
9332 (with-temp-buffer
9333 (let ((org-inhibit-startup t))
9334 (org-mode)
9335 (insert s)
9336 (goto-char (point-min))
9337 (when reference-buffer
9338 (setq org-link-abbrev-alist-local
9339 (with-current-buffer reference-buffer
9340 org-link-abbrev-alist-local)))
9341 (org-open-at-point arg reference-buffer)))))
9343 (defvar org-open-at-point-functions nil
9344 "Hook that is run when following a link at point.
9346 Functions in this hook must return t if they identify and follow
9347 a link at point. If they don't find anything interesting at point,
9348 they must return nil.")
9350 (defun org-open-at-point (&optional arg reference-buffer)
9351 "Open link at or after point.
9352 If there is no link at point, this function will search forward up to
9353 the end of the current line.
9354 Normally, files will be opened by an appropriate application. If the
9355 optional prefix argument ARG is non-nil, Emacs will visit the file.
9356 With a double prefix argument, try to open outside of Emacs, in the
9357 application the system uses for this file type."
9358 (interactive "P")
9359 ;; if in a code block, then open the block's results
9360 (unless (call-interactively #'org-babel-open-src-block-result)
9361 (org-load-modules-maybe)
9362 (move-marker org-open-link-marker (point))
9363 (setq org-window-config-before-follow-link (current-window-configuration))
9364 (org-remove-occur-highlights nil nil t)
9365 (cond
9366 ((and (org-on-heading-p)
9367 (not (org-in-regexp
9372 (not (get-text-property (point) 'org-linked-text)))
9373 (or (org-offer-links-in-entry arg)
9374 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9375 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9376 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9377 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9378 (not (org-in-regexp org-bracket-link-regexp)))
9379 (org-footnote-action))
9380 (t
9381 (let (type path link line search (pos (point)))
9382 (catch 'match
9383 (save-excursion
9385 (when (org-in-regexp org-bracket-link-regexp 1)
9386 (setq link (org-extract-attributes
9387 (org-link-unescape (org-match-string-no-properties 1))))
9389 (setq link (replace-match " " t t link)))
9390 (setq link (org-link-expand-abbrev link))
9391 (cond
9392 ((or (file-name-absolute-p link)
9394 (setq type "file" path link))
9395 ((string-match org-link-re-with-space3 link)
9396 (setq type (match-string 1 link) path (match-string 2 link)))
9397 (t (setq type "thisfile" path link)))
9398 (throw 'match t)))
9400 (when (get-text-property (point) 'org-linked-text)
9401 (setq type "thisfile"
9402 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9403 (1+ (point)) (point))
9404 path (buffer-substring
9405 (or (previous-single-property-change pos 'org-linked-text)
9406 (point-min))
9407 (or (next-single-property-change pos 'org-linked-text)
9408 (point-max))))
9409 (throw 'match t))
9411 (save-excursion
9412 (when (or (org-in-regexp org-angle-link-re)
9413 (org-in-regexp org-plain-link-re))
9414 (setq type (match-string 1) path (match-string 2))
9415 (throw 'match t)))
9416 (save-excursion
9418 (setq type "tags"
9419 path (match-string 1))
9420 (while (string-match ":" path)
9421 (setq path (replace-match "+" t t path)))
9422 (throw 'match t)))
9424 (setq type "tree-match"
9425 path (match-string 1))
9426 (throw 'match t)))
9427 (unless path
9428 (error "No link found"))
9430 ;; switch back to reference buffer
9431 ;; needed when if called in a temporary buffer through
9432 ;; org-open-link-from-string
9433 (with-current-buffer (or reference-buffer (current-buffer))
9435 ;; Remove any trailing spaces in path
9437 (setq path (replace-match "" t t path)))
9438 (if (and org-link-translation-function
9439 (fboundp org-link-translation-function))
9440 ;; Check if we need to translate the link
9441 (let ((tmp (funcall org-link-translation-function type path)))
9442 (setq type (car tmp) path (cdr tmp))))
9444 (cond
9446 ((assoc type org-link-protocols)
9447 (funcall (nth 1 (assoc type org-link-protocols)) path))
9449 ((equal type "mailto")
9450 (let ((cmd (car org-link-mailto-program))
9451 (args (cdr org-link-mailto-program)) args1
9452 (address path) (subject "") a)
9454 (setq address (match-string 1 path)
9455 subject (org-link-escape (match-string 2 path))))
9456 (while args
9457 (cond
9458 ((not (stringp (car args))) (push (pop args) args1))
9459 (t (setq a (pop args))
9460 (if (string-match "%a" a)
9461 (setq a (replace-match address t t a)))
9462 (if (string-match "%s" a)
9463 (setq a (replace-match subject t t a)))
9464 (push a args1))))
9465 (apply cmd (nreverse args1))))
9467 ((member type '("http" "https" "ftp" "news"))
9468 (browse-url (concat type ":" (org-link-escape
9469 path org-link-escape-chars-browser))))
9471 ((string= type "doi")
9472 (browse-url (concat "http://dx.doi.org/"
9473 (org-link-escape
9474 path org-link-escape-chars-browser))))
9476 ((member type '("message"))
9477 (browse-url (concat type ":" path)))
9479 ((string= type "tags")
9480 (org-tags-view arg path))
9482 ((string= type "tree-match")
9485 ((string= type "file")
9487 (setq line (string-to-number (match-string 1 path))
9488 path (substring path 0 (match-beginning 0)))
9490 (setq search (match-string 1 path)
9491 path (substring path 0 (match-beginning 0)))))
9492 (if (string-match "[*?{]" (file-name-nondirectory path))
9493 (dired path)
9494 (org-open-file path arg line search)))
9496 ((string= type "shell")
9497 (let ((cmd path))
9498 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9499 (string-match org-confirm-shell-link-not-regexp cmd))
9500 (not org-confirm-shell-link-function)
9501 (funcall org-confirm-shell-link-function
9503 (org-add-props cmd nil
9504 'face 'org-warning))))
9505 (progn
9506 (message "Executing %s" cmd)
9507 (shell-command cmd))
9508 (error "Abort"))))
9510 ((string= type "elisp")
9511 (let ((cmd path))
9512 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9513 (string-match org-confirm-elisp-link-not-regexp cmd))
9514 (not org-confirm-elisp-link-function)
9515 (funcall org-confirm-elisp-link-function
9517 (org-add-props cmd nil
9518 'face 'org-warning))))
9519 (message "%s => %s" cmd
9520 (if (equal (string-to-char cmd) ?\()
9521 (eval (read cmd))
9522 (call-interactively (read cmd))))
9523 (error "Abort"))))
9525 ((and (string= type "thisfile")
9526 (run-hook-with-args-until-success
9527 'org-open-link-functions path)))
9529 ((string= type "thisfile")
9530 (if arg
9531 (switch-to-buffer-other-window
9532 (org-get-buffer-for-internal-link (current-buffer)))
9533 (org-mark-ring-push))
9534 (let ((cmd `(org-link-search
9535 ,path
9536 ,(cond ((equal arg '(4)) ''occur)
9537 ((equal arg '(16)) ''org-occur)
9538 (t nil))
9539 ,pos)))
9540 (condition-case nil (eval cmd)
9541 (error (progn (widen) (eval cmd))))))
9543 (t
9544 (browse-url-at-point)))))))
9545 (move-marker org-open-link-marker nil)
9546 (run-hook-with-args 'org-follow-link-hook)))
9548 (defun org-offer-links-in-entry (&optional nth zero)
9549 "Offer links in the current entry and follow the selected link.
9550 If there is only one link, follow it immediately as well.
9551 If NTH is an integer, immediately pick the NTH link found.
9552 If ZERO is a string, check also this string for a link, and if
9553 there is one, offer it as link number zero."
9557 (cnt ?0)
9558 (in-emacs (if (integerp nth) nil nth))
9559 have-zero end links link c)
9560 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9561 (push (match-string 0 zero) links)
9562 (setq cnt (1- cnt) have-zero t))
9563 (save-excursion
9564 (org-back-to-heading t)
9565 (setq end (save-excursion (outline-next-heading) (point)))
9566 (while (re-search-forward re end t)
9567 (push (match-string 0) links))
9568 (setq links (org-uniquify (reverse links))))
9570 (cond
9571 ((null links)
9572 (message "No links"))
9573 ((equal (length links) 1)
9574 (setq link (list (car links))))
9575 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9576 (setq link (nth (if have-zero nth (1- nth)) links)))
9577 (t ; we have to select a link
9578 (save-excursion
9579 (save-window-excursion
9580 (delete-other-windows)
9581 (with-output-to-temp-buffer "*Select Link*"
9582 (mapc (lambda (l)
9583 (if (not (string-match org-bracket-link-regexp l))
9585 (org-remove-angle-brackets l)))
9586 (if (match-end 3)
9588 (match-string 3 l) (match-string 1 l)))
9590 (match-string 1 l))))))
9591 links))
9592 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9593 (message "Select link to open, RET to open all:")
9594 (setq c (read-char-exclusive))
9595 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9596 (when (equal c ?q) (error "Abort"))
9597 (if (equal c ?\C-m)
9598 (setq link links)
9599 (setq nth (- c ?0))
9600 (if have-zero (setq nth (1+ nth)))
9601 (unless (and (integerp nth) (>= (length links) nth))
9602 (error "Invalid link selection"))
9603 (setq link (list (nth (1- nth) links))))))
9604 (if link
9605 (let ((buf (current-buffer)))
9606 (dolist (l link)
9607 (org-open-link-from-string l in-emacs buf))
9608 t)
9609 nil)))
9611 ;; Add special file links that specify the way of opening
9613 (org-add-link-type "file+sys" 'org-open-file-with-system)
9614 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9615 (defun org-open-file-with-system (path)
9616 "Open file at PATH using the system way of opening it."
9617 (org-open-file path 'system))
9618 (defun org-open-file-with-emacs (path)
9619 "Open file at PATH in Emacs."
9620 (org-open-file path 'emacs))
9621 (defun org-remove-file-link-modifiers ()
9622 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9623 (goto-char (point-min))
9625 (org-if-unprotected
9626 (replace-match "file:" t t))))
9627 (eval-after-load "org-exp"
9628 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9629 'org-remove-file-link-modifiers))
9631 ;;;; Time estimates
9633 (defun org-get-effort (&optional pom)
9634 "Get the effort estimate for the current entry."
9635 (org-entry-get pom org-effort-property))
9637 ;;; File search
9639 (defvar org-create-file-search-functions nil
9640 "List of functions to construct the right search string for a file link.
9641 These functions are called in turn with point at the location to
9642 which the link should point.
9644 A function in the hook should first test if it would like to
9645 handle this file type, for example by checking the `major-mode'
9646 or the file extension. If it decides not to handle this file, it
9647 should just return nil to give other functions a chance. If it
9648 does handle the file, it must return the search string to be used
9649 when following the link. The search string will be part of the
9650 file link, given after a double colon, and `org-open-at-point'
9651 will automatically search for it. If special measures must be
9652 taken to make the search successful, another function should be
9653 added to the companion hook `org-execute-file-search-functions',
9654 which see.
9656 A function in this hook may also use `setq' to set the variable
9657 `description' to provide a suggestion for the descriptive text to
9658 be used for this link when it gets inserted into an Org-mode
9661 (defvar org-execute-file-search-functions nil
9662 "List of functions to execute a file search triggered by a link.
9664 Functions added to this hook must accept a single argument, the
9665 search string that was part of the file link, the part after the
9666 double colon. The function must first check if it would like to
9667 handle this search, for example by checking the `major-mode' or
9668 the file extension. If it decides not to handle this search, it
9669 should just return nil to give other functions a chance. If it
9670 does handle the search, it must return a non-nil value to keep
9671 other functions from trying.
9673 Each function can access the current prefix argument through the
9674 variable `current-prefix-argument'. Note that a single prefix is
9675 used to force opening a link in Emacs, so it may be good to only
9676 use a numeric or double prefix to guide the search function.
9678 In case this is needed, a function in this hook can also restore
9679 the window configuration before `org-open-at-point' was called using:
9681 (set-window-configuration org-window-config-before-follow-link)")
9683 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9684 (defun org-link-search (s &optional type avoid-pos)
9685 "Search for a link search option.
9686 If S is surrounded by forward slashes, it is interpreted as a
9687 regular expression. In org-mode files, this will create an `org-occur'
9688 sparse tree. In ordinary files, `occur' will be used to list matches.
9689 If the current buffer is in `dired-mode', grep will be used to search
9690 in all files. If AVOID-POS is given, ignore matches near that position."
9691 (let ((case-fold-search t)
9695 org-emphasis-alist)
9697 (pos (point))
9698 (pre nil) (post nil)
9699 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9700 (cond
9701 ;; First check if there are any special search functions
9702 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9703 ;; Now try the builtin stuff
9704 ((and (equal (string-to-char s0) ?#)
9705 (> (length s0) 1)
9706 (save-excursion
9707 (goto-char (point-min))
9708 (and
9709 (re-search-forward
9711 (setq type 'dedicated
9712 pos (match-beginning 0))))
9713 ;; There is an exact target for this
9714 (goto-char pos)
9715 (org-back-to-heading t)))
9716 ((save-excursion
9717 (goto-char (point-min))
9718 (and
9719 (re-search-forward
9720 (concat "<<" (regexp-quote s0) ">>") nil t)
9721 (setq type 'dedicated
9722 pos (match-beginning 0))))
9723 ;; There is an exact target for this
9724 (goto-char pos))
9726 (save-excursion
9727 (goto-char (point-min))
9728 (and
9729 (re-search-forward
9730 (concat "[^[]" (regexp-quote
9731 (format org-coderef-label-format
9732 (match-string 1 s0))))
9733 nil t)
9734 (setq type 'dedicated
9735 pos (1+ (match-beginning 0))))))
9736 ;; There is a coderef target for this
9737 (goto-char pos))
9739 ;; A regular expression
9740 (cond
9741 ((org-mode-p)
9742 (org-occur (match-string 1 s)))
9743 ;;((eq major-mode 'dired-mode)
9744 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9745 (t (org-do-occur (match-string 1 s)))))
9746 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9747 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9748 (goto-char (point-min))
9749 (cond
9750 ((let (case-fold-search)
9751 (re-search-forward (format org-complex-heading-regexp-format
9752 (regexp-quote s))
9753 nil t))
9754 ;; OK, found a match
9755 (setq type 'dedicated)
9756 (goto-char (match-beginning 0)))
9757 ((and (not org-link-search-inhibit-query)
9758 (eq org-link-search-must-match-exact-headline 'query-to-create)
9759 (y-or-n-p "No match - create this as a new heading? "))
9760 (goto-char (point-max))
9761 (or (bolp) (newline))
9763 (beginning-of-line 0))
9764 (t
9765 (goto-char pos)
9766 (error "No match"))))
9767 (t
9768 ;; A normal search string
9769 (when (equal (string-to-char s) ?*)
9770 ;; Anchor on headlines, post may include tags.
9773 s (substring s 1)))
9774 (remove-text-properties
9775 0 (length s)
9776 '(face nil mouse-face nil keymap nil fontified nil) s)
9777 ;; Make a series of regular expressions to find a match
9786 re4 (concat "[^a-zA-Z_]" re4_)
9788 re1 (concat pre re2 post)
9789 re3 (concat pre (if pre re4_ re4) post)
9790 re5 (concat pre ".*" re4)
9791 re2 (concat pre re2)
9792 re2a (concat pre (if pre re2a_ re2a))
9793 re4 (concat pre (if pre re4_ re4))
9797 ))
9798 (cond
9799 ((eq type 'org-occur) (org-occur reall))
9800 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9801 (t (goto-char (point-min))
9802 (setq type 'fuzzy)
9803 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9804 (org-search-not-self 1 re1 nil t)
9805 (org-search-not-self 1 re2 nil t)
9806 (org-search-not-self 1 re2a nil t)
9807 (org-search-not-self 1 re3 nil t)
9808 (org-search-not-self 1 re4 nil t)
9809 (org-search-not-self 1 re5 nil t)
9810 )
9811 (goto-char (match-beginning 1))
9812 (goto-char pos)
9813 (error "No match"))))))
9814 (and (org-mode-p) (org-show-context 'link-search))
9815 type))
9817 (defun org-search-not-self (group &rest args)
9818 "Execute `re-search-forward', but only accept matches that do not
9819 enclose the position of `org-open-link-marker'."
9820 (let ((m org-open-link-marker))
9821 (catch 'exit
9822 (while (apply 're-search-forward args)
9823 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9824 (goto-char (match-end group))
9825 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9826 (> (match-beginning 0) (marker-position m))
9827 (< (match-end 0) (marker-position m)))
9828 (save-match-data
9829 (or (not (org-in-regexp
9830 org-bracket-link-analytic-regexp 1))
9831 (not (match-end 4)) ; no description
9832 (and (<= (match-beginning 4) (point))
9833 (>= (match-end 4) (point))))))
9834 (throw 'exit (point))))))))
9836 (defun org-get-buffer-for-internal-link (buffer)
9837 "Return a buffer to be used for displaying the link target of internal links."
9838 (cond
9839 ((not org-display-internal-link-with-indirect-buffer)
9840 buffer)
9841 ((string-match "(Clone)$" (buffer-name buffer))
9842 (message "Buffer is already a clone, not making another one")
9843 ;; we also do not modify visibility in this case
9844 buffer)
9845 (t ; make a new indirect buffer for displaying the link
9846 (let* ((bn (buffer-name buffer))
9847 (ibn (concat bn "(Clone)"))
9848 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9849 (with-current-buffer ib (org-overview))
9850 ib))))
9852 (defun org-do-occur (regexp &optional cleanup)
9853 "Call the Emacs command `occur'.
9854 If CLEANUP is non-nil, remove the printout of the regular expression
9855 in the *Occur* buffer. This is useful if the regex is long and not useful
9856 to read."
9857 (occur regexp)
9858 (when cleanup
9859 (let ((cwin (selected-window)) win beg end)
9860 (when (setq win (get-buffer-window "*Occur*"))
9861 (select-window win))
9862 (goto-char (point-min))
9863 (when (re-search-forward "match[a-z]+" nil t)
9864 (setq beg (match-end 0))
9866 (setq end (1- (match-beginning 0)))))
9867 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9868 (goto-char (point-min))
9869 (select-window cwin))))
9871 ;;; The mark ring for links jumps
9873 (defvar org-mark-ring nil
9874 "Mark ring for positions before jumps in Org-mode.")
9875 (defvar org-mark-ring-last-goto nil
9876 "Last position in the mark ring used to go back.")
9877 ;; Fill and close the ring
9878 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9879 (loop for i from 1 to org-mark-ring-length do
9880 (push (make-marker) org-mark-ring))
9881 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9882 org-mark-ring)
9884 (defun org-mark-ring-push (&optional pos buffer)
9885 "Put the current position or POS into the mark ring and rotate it."
9886 (interactive)
9887 (setq pos (or pos (point)))
9888 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9889 (move-marker (car org-mark-ring)
9890 (or pos (point))
9891 (or buffer (current-buffer)))
9892 (message "%s"
9893 (substitute-command-keys
9896 (defun org-mark-ring-goto (&optional n)
9897 "Jump to the previous position in the mark ring.
9898 With prefix arg N, jump back that many stored positions. When
9899 called several times in succession, walk through the entire ring.
9900 Org-mode commands jumping to a different position in the current file,
9901 or to another Org-mode file, automatically push the old position
9902 onto the ring."
9903 (interactive "p")
9904 (let (p m)
9905 (if (eq last-command this-command)
9906 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9907 (setq p org-mark-ring))
9908 (setq org-mark-ring-last-goto p)
9909 (setq m (car p))
9910 (org-pop-to-buffer-same-window (marker-buffer m))
9911 (goto-char m)
9912 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9914 (defun org-remove-angle-brackets (s)
9915 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9916 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9917 s)
9918 (defun org-add-angle-brackets (s)
9919 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9920 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9921 s)
9922 (defun org-remove-double-quotes (s)
9925 s)
9927 ;;; Following specific links
9929 (defun org-follow-timestamp-link ()
9930 (cond
9931 ((org-at-date-range-p t)
9932 (let ((org-agenda-start-on-weekday)
9933 (t1 (match-string 1))
9934 (t2 (match-string 2)))
9935 (setq t1 (time-to-days (org-time-string-to-time t1))
9936 t2 (time-to-days (org-time-string-to-time t2)))
9937 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9938 ((org-at-timestamp-p t)
9939 (org-agenda-list nil (time-to-days (org-time-string-to-time
9940 (substring (match-string 1) 0 10)))
9941 1))
9942 (t (error "This should not happen"))))
9945 ;;; Following file links
9946 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9947 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9948 (declare-function mailcap-mime-info
9949 "mailcap" (string &optional request no-decode))
9950 (defvar org-wait nil)
9951 (defun org-open-file (path &optional in-emacs line search)
9952 "Open the file at PATH.
9953 First, this expands any special file name abbreviations. Then the
9954 configuration variable `org-file-apps' is checked if it contains an
9955 entry for this file type, and if yes, the corresponding command is launched.
9957 If no application is found, Emacs simply visits the file.
9959 With optional prefix argument IN-EMACS, Emacs will visit the file.
9961 prefix arg, Org tries to avoid opening in Emacs
9962 and to use an external application to visit the file.
9964 Optional LINE specifies a line to go to, optional SEARCH a string
9965 to search for. If LINE or SEARCH is given, the file will be
9966 opened in Emacs, unless an entry from org-file-apps that makes
9967 use of groups in a regexp matches.
9969 If you want to change the way frames are used when following a
9970 link, please customize `org-link-frame-setup'.
9972 If the file does not exist, an error is thrown."
9973 (let* ((file (if (equal path "")
9974 buffer-file-name
9975 (substitute-in-file-name (expand-file-name path))))
9976 (file-apps (append org-file-apps (org-default-apps)))
9977 (apps (org-remove-if
9978 'org-file-apps-entry-match-against-dlink-p file-apps))
9979 (apps-dlink (org-remove-if-not
9980 'org-file-apps-entry-match-against-dlink-p file-apps))
9981 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9982 (dirp (if remp nil (file-directory-p file)))
9983 (file (if (and dirp org-open-directory-means-index-dot-org)
9984 (concat (file-name-as-directory file) "index.org")
9985 file))
9986 (a-m-a-p (assq 'auto-mode apps))
9987 (dfile (downcase file))
9988 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9989 (link (cond ((and (eq line nil)
9990 (eq search nil))
9991 file)
9992 (line
9993 (concat file "::" (number-to-string line)))
9994 (search
9995 (concat file "::" search))))
9996 (dlink (downcase link))
9997 (old-buffer (current-buffer))
9998 (old-pos (point))
9999 (old-mode major-mode)
10000 ext cmd link-match-data)
10002 (setq ext (match-string 1 dfile))
10004 (setq ext (match-string 1 dfile))))
10005 (cond
10006 ((member in-emacs '((16) system))
10007 (setq cmd (cdr (assoc 'system apps))))
10008 (in-emacs (setq cmd 'emacs))
10009 (t
10010 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10011 (and dirp (cdr (assoc 'directory apps)))
10012 ; first, try matching against apps-dlink
10013 ; if we get a match here, store the match data for later
10014 (let ((match (assoc-default dlink apps-dlink
10015 'string-match)))
10016 (if match
10017 (progn (setq link-match-data (match-data))
10018 match)
10019 (progn (setq in-emacs (or in-emacs line search))
10020 nil))) ; if we have no match in apps-dlink,
10021 ; always open the file in emacs if line or search
10022 ; is given (for backwards compatibility)
10023 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10024 'string-match)
10025 (cdr (assoc ext apps))
10026 (cdr (assoc t apps))))))
10027 (when (eq cmd 'system)
10028 (setq cmd (cdr (assoc 'system apps))))
10029 (when (eq cmd 'default)
10030 (setq cmd (cdr (assoc t apps))))
10031 (when (eq cmd 'mailcap)
10032 (require 'mailcap)
10033 (mailcap-parse-mailcaps)
10034 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10035 (command (mailcap-mime-info mime-type)))
10036 (if (stringp command)
10037 (setq cmd command)
10038 (setq cmd 'emacs))))
10039 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10040 (not (file-exists-p file))
10041 (not org-open-non-existing-files))
10042 (error "No such file: %s" file))
10043 (cond
10045 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10047 (setq cmd (replace-match "%s" t t cmd)))
10048 (while (string-match "%s" cmd)
10049 (setq cmd (replace-match
10050 (save-match-data
10051 (shell-quote-argument
10052 (convert-standard-filename file)))
10053 t t cmd)))
10055 ;; Replace "%1", "%2" etc. in command with group matches from regex
10056 (save-match-data
10057 (let ((match-index 1)
10058 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10059 (set-match-data link-match-data)
10060 (while (<= match-index number-of-groups)
10061 (let ((regex (concat "%" (number-to-string match-index)))
10062 (replace-with (match-string match-index dlink)))
10063 (while (string-match regex cmd)
10064 (setq cmd (replace-match replace-with t t cmd))))
10065 (setq match-index (+ match-index 1)))))
10067 (save-window-excursion
10068 (start-process-shell-command cmd nil cmd)
10069 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10070 ))
10071 ((or (stringp cmd)
10072 (eq cmd 'emacs))
10073 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10074 (widen)
10075 (if line (org-goto-line line)
10076 (if search (org-link-search search))))
10077 ((consp cmd)
10078 (let ((file (convert-standard-filename file)))
10079 (save-match-data
10080 (set-match-data link-match-data)
10081 (eval cmd))))
10082 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10083 (and (org-mode-p) (eq old-mode 'org-mode)
10084 (or (not (equal old-buffer (current-buffer)))
10085 (not (equal old-pos (point))))
10086 (org-mark-ring-push old-pos old-buffer))))
10088 (defun org-file-apps-entry-match-against-dlink-p (entry)
10089 "This function returns non-nil if `entry' uses a regular
10090 expression which should be matched against the whole link by
10091 org-open-file.
10093 It assumes that is the case when the entry uses a regular
10094 expression which has at least one grouping construct and the
10095 action is either a lisp form or a command string containing
10096 '%1', i.e. using at least one subexpression match as a
10097 parameter."
10098 (let ((selector (car entry))
10099 (action (cdr entry)))
10100 (if (stringp selector)
10101 (and (> (regexp-opt-depth selector) 0)
10102 (or (and (stringp action)
10103 (string-match "%[0-9]" action))
10104 (consp action)))
10105 nil)))
10107 (defun org-default-apps ()
10108 "Return the default applications for this operating system."
10109 (cond
10110 ((eq system-type 'darwin)
10111 org-file-apps-defaults-macosx)
10112 ((eq system-type 'windows-nt)
10113 org-file-apps-defaults-windowsnt)
10114 (t org-file-apps-defaults-gnu)))
10116 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10117 "Convert extensions to regular expressions in the cars of LIST.
10118 Also, weed out any non-string entries, because the return value is used
10119 only for regexp matching.
10120 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10121 point to the symbol `emacs', indicating that the file should
10122 be opened in Emacs."
10123 (append
10124 (delq nil
10125 (mapcar (lambda (x)
10126 (if (not (stringp (car x)))
10127 nil
10129 x
10131 list))
10132 (if add-auto-mode
10133 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10135 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10136 (defun org-file-remote-p (file)
10137 "Test whether FILE specifies a location on a remote system.
10138 Return non-nil if the location is indeed remote.
10142 (cond ((fboundp 'file-remote-p)
10143 (file-remote-p file))
10144 ((fboundp 'tramp-handle-file-remote-p)
10145 (tramp-handle-file-remote-p file))
10146 ((and (boundp 'ange-ftp-name-format)
10147 (string-match (car ange-ftp-name-format) file))
10148 t)
10149 (t nil)))
10152 ;;;; Refiling
10154 (defun org-get-org-file ()
10155 "Read a filename, with default directory `org-directory'."
10156 (let ((default (or org-default-notes-file remember-data-file)))
10157 (read-file-name (format "File name [%s]: " default)
10158 (file-name-as-directory org-directory)
10159 default)))
10161 (defun org-notes-order-reversed-p ()
10162 "Check if the current file should receive notes in reversed order."
10163 (cond
10164 ((not org-reverse-note-order) nil)
10165 ((eq t org-reverse-note-order) t)
10166 ((not (listp org-reverse-note-order)) nil)
10167 (t (catch 'exit
10168 (let ((all org-reverse-note-order)
10169 entry)
10170 (while (setq entry (pop all))
10171 (if (string-match (car entry) buffer-file-name)
10172 (throw 'exit (cdr entry))))
10173 nil)))))
10175 (defvar org-refile-target-table nil
10176 "The list of refile targets, created by `org-refile'.")
10178 (defvar org-agenda-new-buffers nil
10179 "Buffers created to visit agenda files.")
10181 (defvar org-refile-cache nil
10182 "Cache for refile targets.")
10184 (defvar org-refile-markers nil
10185 "All the markers used for caching refile locations.")
10187 (defun org-refile-marker (pos)
10188 "Get a new refile marker, but only if caching is in use."
10189 (if (not org-refile-use-cache)
10190 pos
10191 (let ((m (make-marker)))
10192 (move-marker m pos)
10193 (push m org-refile-markers)
10194 m)))
10196 (defun org-refile-cache-clear ()
10197 "Clear the refile cache and disable all the markers."
10198 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10199 (setq org-refile-markers nil)
10200 (setq org-refile-cache nil)
10201 (message "Refile cache has been cleared"))
10203 (defun org-refile-cache-check-set (set)
10204 "Check if all the markers in the cache still have live buffers."
10205 (let (marker)
10206 (catch 'exit
10207 (while (and set (setq marker (nth 3 (pop set))))
10208 ;; if org-refile-use-outline-path is 'file, marker may be nil
10209 (when (and marker (null (marker-buffer marker)))
10210 (message "not found") (sit-for 3)
10211 (throw 'exit nil)))
10212 t)))
10214 (defun org-refile-cache-put (set &rest identifiers)
10215 "Push the refile targets SET into the cache, under IDENTIFIERS."
10216 (let* ((key (sha1 (prin1-to-string identifiers)))
10217 (entry (assoc key org-refile-cache)))
10218 (if entry
10219 (setcdr entry set)
10220 (push (cons key set) org-refile-cache))))
10222 (defun org-refile-cache-get (&rest identifiers)
10223 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10224 (cond
10225 ((not org-refile-cache) nil)
10226 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10227 (t
10228 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10229 org-refile-cache))))
10230 (and set (org-refile-cache-check-set set) set)))))
10232 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10233 "Produce a table with refile targets."
10234 (let ((case-fold-search nil)
10235 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10236 (entries (or org-refile-targets '((nil . (:level . 1)))))
10237 targets tgs txt re files f desc descre fast-path-p level pos0)
10238 (message "Getting targets...")
10239 (with-current-buffer (or default-buffer (current-buffer))
10240 (while (setq entry (pop entries))
10241 (setq files (car entry) desc (cdr entry))
10242 (setq fast-path-p nil)
10243 (cond
10244 ((null files) (setq files (list (current-buffer))))
10245 ((eq files 'org-agenda-files)
10246 (setq files (org-agenda-files 'unrestricted)))
10247 ((and (symbolp files) (fboundp files))
10248 (setq files (funcall files)))
10249 ((and (symbolp files) (boundp files))
10250 (setq files (symbol-value files))))
10251 (if (stringp files) (setq files (list files)))
10252 (cond
10253 ((eq (car desc) :tag)
10255 ((eq (car desc) :todo)
10257 ((eq (car desc) :regexp)
10258 (setq descre (cdr desc)))
10259 ((eq (car desc) :level)
10261 (if org-odd-levels-only
10262 (1- (* 2 (cdr desc)))
10263 (cdr desc)))
10265 ((eq (car desc) :maxlevel)
10266 (setq fast-path-p t)
10268 (if org-odd-levels-only
10269 (1- (* 2 (cdr desc)))
10270 (cdr desc)))
10272 (t (error "Bad refiling target description %s" desc)))
10273 (while (setq f (pop files))
10274 (with-current-buffer
10275 (if (bufferp f) f (org-get-agenda-file-buffer f))
10276 (or
10277 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10278 (progn
10279 (if (bufferp f) (setq f (buffer-file-name
10280 (buffer-base-buffer f))))
10281 (setq f (and f (expand-file-name f)))
10282 (if (eq org-refile-use-outline-path 'file)
10283 (push (list (file-name-nondirectory f) f nil nil) tgs))
10284 (save-excursion
10285 (save-restriction
10286 (widen)
10287 (goto-char (point-min))
10288 (while (re-search-forward descre nil t)
10289 (goto-char (setq pos0 (point-at-bol)))
10290 (catch 'next
10291 (when org-refile-target-verify-function
10292 (save-match-data
10293 (or (funcall org-refile-target-verify-function)
10294 (throw 'next t))))
10295 (when (and (looking-at org-complex-heading-regexp)
10296 (not (member (match-string 4) excluded-entries)))
10297 (setq level (org-reduced-level
10298 (- (match-end 1) (match-beginning 1)))
10299 txt (org-link-display-format (match-string 4))
10301 re (format org-complex-heading-regexp-format
10302 (regexp-quote (match-string 4))))
10303 (when org-refile-use-outline-path
10304 (setq txt (mapconcat
10305 'org-protect-slash
10306 (append
10307 (if (eq org-refile-use-outline-path
10308 'file)
10309 (list (file-name-nondirectory
10310 (buffer-file-name
10311 (buffer-base-buffer))))
10312 (if (eq org-refile-use-outline-path
10313 'full-file-path)
10314 (list (buffer-file-name
10315 (buffer-base-buffer)))))
10316 (org-get-outline-path fast-path-p
10317 level txt)
10318 (list txt))
10319 "/")))
10320 (push (list txt f re (org-refile-marker (point)))
10321 tgs)))
10322 (when (= (point) pos0)
10323 ;; verification function has not moved point
10324 (goto-char (point-at-eol))))))))
10325 (when org-refile-use-cache
10326 (org-refile-cache-put tgs (buffer-file-name) descre))
10327 (setq targets (append tgs targets))
10328 ))))
10329 (message "Getting targets...done")
10330 (nreverse targets)))
10332 (defun org-protect-slash (s)
10333 (while (string-match "/" s)
10335 s)
10337 (defvar org-olpa (make-vector 20 nil))
10339 (defun org-get-outline-path (&optional fastp level heading)
10340 "Return the outline path to the current entry, as a list.
10342 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10343 routine which makes outline path derivations for an entire file,
10344 avoiding backtracing. Refile target collection makes use of that."
10345 (if fastp
10346 (progn
10347 (if (> level 19)
10348 (error "Outline path failure, more than 19 levels"))
10349 (loop for i from level upto 19 do
10350 (aset org-olpa i nil))
10351 (prog1
10352 (delq nil (append org-olpa nil))
10353 (aset org-olpa level heading)))
10354 (let (rtn case-fold-search)
10355 (save-excursion
10356 (save-restriction
10357 (widen)
10358 (while (org-up-heading-safe)
10359 (when (looking-at org-complex-heading-regexp)
10360 (push (org-match-string-no-properties 4) rtn)))
10361 rtn)))))
10363 (defun org-format-outline-path (path &optional width prefix)
10364 "Format the outline path PATH for display.
10365 Width is the maximum number of characters that is available.
10366 Prefix is a prefix to be included in the returned string,
10367 such as the file name."
10368 (setq width (or width 79))
10369 (if prefix (setq width (- width (length prefix))))
10370 (if (not path)
10371 (or prefix "")
10372 (let* ((nsteps (length path))
10373 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10374 (maxwidth (if (<= total-width width)
10375 10000 ;; everything fits
10376 ;; we need to shorten the level headings
10377 (/ (- width nsteps) nsteps)))
10378 (org-odd-levels-only nil)
10379 (n 0)
10380 (total (1+ (length prefix))))
10381 (setq maxwidth (max maxwidth 10))
10382 (concat prefix
10383 (mapconcat
10384 (lambda (h)
10385 (setq n (1+ n))
10386 (if (and (= n nsteps) (< maxwidth 10000))
10387 (setq maxwidth (- total-width total)))
10388 (if (< (length h) maxwidth)
10389 (progn (setq total (+ total (length h) 1)) h)
10390 (setq h (substring h 0 (- maxwidth 2))
10391 total (+ total maxwidth 1))
10393 (setq h (substring h 0 (match-beginning 0))))
10394 (setq h (concat h "..")))
10395 (org-add-props h nil 'face
10396 (nth (% (1- n) org-n-level-faces)
10397 org-level-faces))
10398 h)
10399 path "/")))))
10401 (defun org-display-outline-path (&optional file current)
10402 "Display the current outline path in the echo area."
10403 (interactive "P")
10404 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10405 (case-fold-search nil)
10406 (path (and (org-mode-p) (org-get-outline-path))))
10407 (if current (setq path (append path
10408 (save-excursion
10409 (org-back-to-heading t)
10410 (if (looking-at org-complex-heading-regexp)
10411 (list (match-string 4)))))))
10412 (message "%s"
10413 (org-format-outline-path
10414 path
10415 (1- (frame-width))
10416 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10418 (defvar org-refile-history nil
10419 "History for refiling operations.")
10421 (defvar org-after-refile-insert-hook nil
10422 "Hook run after `org-refile' has inserted its stuff at the new location.
10423 Note that this is still *before* the stuff will be removed from
10424 the *old* location.")
10426 (defvar org-capture-last-stored-marker)
10427 (defun org-refile (&optional goto default-buffer rfloc)
10428 "Move the entry or entries at point to another heading.
10429 The list of target headings is compiled using the information in
10430 `org-refile-targets', which see.
10432 At the target location, the entry is filed as a subitem of the target
10433 heading. Depending on `org-reverse-note-order', the new subitem will
10434 either be the first or the last subitem.
10436 If there is an active region, all entries in that region will be moved.
10437 However, the region must fulfill the requirement that the first heading
10438 is the first one sets the top-level of the moved text - at most siblings
10439 below it are allowed.
10441 With prefix arg GOTO, the command will only visit the target location
10442 and not actually move anything.
10445 go to the location where the last refiling operation has put the subtree.
10446 With a prefix argument of `2', refile to the running clock.
10448 RFLOC can be a refile location obtained in a different way.
10450 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10452 If you are using target caching (see `org-refile-use-cache'),
10453 You have to clear the target cache in order to find new targets.
10454 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10455 prefix argument (`C-u C-u C-u C-c C-w')."
10457 (interactive "P")
10458 (if (member goto '(0 (64)))
10459 (org-refile-cache-clear)
10460 (let* ((cbuf (current-buffer))
10461 (regionp (org-region-active-p))
10462 (region-start (and regionp (region-beginning)))
10463 (region-end (and regionp (region-end)))
10464 (region-length (and regionp (- region-end region-start)))
10465 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10466 pos it nbuf file re level reversed)
10467 (setq last-command nil)
10468 (when regionp
10469 (goto-char region-start)
10470 (or (bolp) (goto-char (point-at-bol)))
10471 (setq region-start (point))
10472 (unless (or (org-kill-is-subtree-p
10473 (buffer-substring region-start region-end))
10474 (prog1 org-refile-active-region-within-subtree
10475 (org-toggle-heading)))
10476 (error "The region is not a (sequence of) subtree(s)")))
10477 (if (equal goto '(16))
10478 (org-refile-goto-last-stored)
10479 (when (or
10480 (and (equal goto 2)
10481 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10482 (prog1
10483 (setq it (list (or org-clock-heading "running clock")
10484 (buffer-file-name
10485 (marker-buffer org-clock-hd-marker))
10486 ""
10487 (marker-position org-clock-hd-marker)))
10488 (setq goto nil)))
10489 (setq it (or rfloc
10490 (save-excursion
10491 (unless goto (org-back-to-heading t))
10492 (org-refile-get-location
10493 (cond (goto "Goto")
10494 (regionp "Refile region to")
10495 (t "Refile subtree to")) default-buffer
10496 org-refile-allow-creating-parent-nodes)))))
10497 (setq file (nth 1 it)
10498 re (nth 2 it)
10499 pos (nth 3 it))
10500 (if (and (not goto)
10501 pos
10502 (equal (buffer-file-name) file)
10503 (if regionp
10504 (and (>= pos region-start)
10505 (<= pos region-end))
10506 (and (>= pos (point))
10507 (< pos (save-excursion
10508 (org-end-of-subtree t t))))))
10509 (error "Cannot refile to position inside the tree or region"))
10511 (setq nbuf (or (find-buffer-visiting file)
10512 (find-file-noselect file)))
10513 (if goto
10514 (progn
10515 (org-pop-to-buffer-same-window nbuf)
10516 (goto-char pos)
10517 (org-show-context 'org-goto))
10518 (if regionp
10519 (progn
10520 (org-kill-new (buffer-substring region-start region-end))
10521 (org-save-markers-in-region region-start region-end))
10522 (org-copy-subtree 1 nil t))
10523 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10524 (find-file-noselect file)))
10525 (setq reversed (org-notes-order-reversed-p))
10526 (save-excursion
10527 (save-restriction
10528 (widen)
10529 (if pos
10530 (progn
10531 (goto-char pos)
10532 (looking-at org-outline-regexp)
10533 (setq level (org-get-valid-level (funcall outline-level) 1))
10534 (goto-char
10535 (if reversed
10536 (or (outline-next-heading) (point-max))
10537 (or (save-excursion (org-get-next-sibling))
10538 (org-end-of-subtree t t)
10539 (point-max)))))
10540 (setq level 1)
10541 (if (not reversed)
10542 (goto-char (point-max))
10543 (goto-char (point-min))
10544 (or (outline-next-heading) (goto-char (point-max)))))
10545 (if (not (bolp)) (newline))
10546 (org-paste-subtree level)
10547 (when org-log-refile
10548 (org-add-log-setup 'refile nil nil 'findpos
10549 org-log-refile)
10550 (unless (eq org-log-refile 'note)
10551 (save-excursion (org-add-log-note))))
10552 (and org-auto-align-tags (org-set-tags nil t))
10553 (bookmark-set "org-refile-last-stored")
10554 ;; If we are refiling for capture, make sure that the
10555 ;; last-capture pointers point here
10556 (when (org-bound-and-true-p org-refile-for-capture)
10557 (bookmark-set "org-capture-last-stored-marker")
10558 (move-marker org-capture-last-stored-marker (point)))
10559 (if (fboundp 'deactivate-mark) (deactivate-mark))
10560 (run-hooks 'org-after-refile-insert-hook))))
10561 (if regionp
10562 (delete-region (point) (+ (point) region-length))
10563 (org-cut-subtree))
10564 (when (featurep 'org-inlinetask)
10565 (org-inlinetask-remove-END-maybe))
10566 (setq org-markers-to-move nil)
10569 (defun org-refile-goto-last-stored ()
10570 "Go to the location where the last refile was stored."
10571 (interactive)
10572 (bookmark-jump "org-refile-last-stored")
10573 (message "This is the location of the last refile"))
10575 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10576 "Prompt the user for a refile location, using PROMPT.
10577 PROMPT should not be suffixed with a colon and a space, because
10578 this function appends the default value from
10579 `org-refile-history' automatically, if that is not empty."
10580 (let ((org-refile-targets org-refile-targets)
10581 (org-refile-use-outline-path org-refile-use-outline-path)
10582 excluded-entries)
10583 (when (and (eq major-mode 'org-mode)
10584 (not org-refile-use-cache))
10585 (org-map-tree
10586 (lambda()
10587 (setq excluded-entries
10588 (append excluded-entries (list (org-get-heading t t)))))))
10589 (setq org-refile-target-table
10590 (org-refile-get-targets default-buffer excluded-entries)))
10591 (unless org-refile-target-table
10592 (error "No refile targets"))
10593 (let* ((prompt (concat prompt
10594 (and (car org-refile-history)
10595 (concat " (default " (car org-refile-history) ")"))
10596 ": "))
10597 (cbuf (current-buffer))
10598 (partial-completion-mode nil)
10599 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10600 (cfunc (if (and org-refile-use-outline-path
10601 org-outline-path-complete-in-steps)
10602 'org-olpath-completing-read
10603 'org-icompleting-read))
10604 (extra (if org-refile-use-outline-path "/" ""))
10605 (filename (and cfn (expand-file-name cfn)))
10606 (tbl (mapcar
10607 (lambda (x)
10608 (if (and (not (member org-refile-use-outline-path
10609 '(file full-file-path)))
10610 (not (equal filename (nth 1 x))))
10611 (cons (concat (car x) extra " ("
10612 (file-name-nondirectory (nth 1 x)) ")")
10613 (cdr x))
10614 (cons (concat (car x) extra) (cdr x))))
10615 org-refile-target-table))
10616 (completion-ignore-case t)
10617 pa answ parent-target child parent old-hist)
10618 (setq old-hist org-refile-history)
10619 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10620 nil 'org-refile-history (car org-refile-history)))
10621 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10622 (org-refile-check-position pa)
10623 (if pa
10624 (progn
10625 (when (or (not org-refile-history)
10626 (not (eq old-hist org-refile-history))
10627 (not (equal (car pa) (car org-refile-history))))
10628 (setq org-refile-history
10629 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10630 org-refile-history
10631 (cdr org-refile-history))))
10632 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10633 (pop org-refile-history)))
10634 pa)
10636 (progn
10637 (setq parent (match-string 1 answ)
10638 child (match-string 2 answ))
10639 (setq parent-target (or (assoc parent tbl)
10640 (assoc (concat parent "/") tbl)))
10641 (when (and parent-target
10642 (or (eq new-nodes t)
10643 (and (eq new-nodes 'confirm)
10645 child)))))
10646 (org-refile-new-child parent-target child)))
10647 (error "Invalid target location")))))
10649 (defun org-refile-check-position (refile-pointer)
10650 "Check if the refile pointer matches the readline to which it points."
10651 (let* ((file (nth 1 refile-pointer))
10652 (re (nth 2 refile-pointer))
10653 (pos (nth 3 refile-pointer))
10654 buffer)
10655 (when (org-string-nw-p re)
10656 (setq buffer (if (markerp pos)
10657 (marker-buffer pos)
10658 (or (find-buffer-visiting file)
10659 (find-file-noselect file))))
10660 (with-current-buffer buffer
10661 (save-excursion
10662 (save-restriction
10663 (widen)
10664 (goto-char pos)
10665 (beginning-of-line 1)
10666 (unless (org-looking-at-p re)
10667 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10669 (defun org-refile-new-child (parent-target child)
10670 "Use refile target PARENT-TARGET to add new CHILD below it."
10671 (unless parent-target
10672 (error "Cannot find parent for new node"))
10673 (let ((file (nth 1 parent-target))
10674 (pos (nth 3 parent-target))
10675 level)
10676 (with-current-buffer (or (find-buffer-visiting file)
10677 (find-file-noselect file))
10678 (save-excursion
10679 (save-restriction
10680 (widen)
10681 (if pos
10682 (goto-char pos)
10683 (goto-char (point-max))
10684 (if (not (bolp)) (newline)))
10685 (when (looking-at org-outline-regexp)
10686 (setq level (funcall outline-level))
10687 (org-end-of-subtree t t))
10688 (org-back-over-empty-lines)
10690 (if pos (org-get-valid-level level 1) 1) ?*)
10692 (beginning-of-line 0)
10693 (list (concat (car parent-target) "/" child) file "" (point)))))))
10695 (defun org-olpath-completing-read (prompt collection &rest args)
10696 "Read an outline path like a file name."
10697 (let ((thetable collection)
10698 (org-completion-use-ido nil) ; does not work with ido.
10699 (org-completion-use-iswitchb nil)) ; or iswitchb
10700 (apply
10701 'org-icompleting-read prompt
10702 (lambda (string predicate &optional flag)
10703 (let (rtn r f (l (length string)))
10704 (cond
10705 ((eq flag nil)
10706 ;; try completion
10707 (try-completion string thetable))
10708 ((eq flag t)
10709 ;; all-completions
10710 (setq rtn (all-completions string thetable predicate))
10711 (mapcar
10712 (lambda (x)
10713 (setq r (substring x l))
10714 (if (string-match " ([^)]*)$" x)
10715 (setq f (match-string 0 x))
10716 (setq f ""))
10717 (if (string-match "/" r)
10718 (concat string (substring r 0 (match-end 0)) f)
10719 x))
10720 rtn))
10721 ((eq flag 'lambda)
10722 ;; exact match?
10723 (assoc string thetable)))
10724 ))
10725 args)))
10727 ;;;; Dynamic blocks
10729 (defun org-find-dblock (name)
10730 "Find the first dynamic block with name NAME in the buffer.
10731 If not found, stay at current position and return nil."
10732 (let (pos)
10733 (save-excursion
10734 (goto-char (point-min))
10736 nil t)
10737 (match-beginning 0))))
10738 (if pos (goto-char pos))
10739 pos))
10741 (defconst org-dblock-start-re
10743 "Matches the start line of a dynamic block, with parameters.")
10746 "Matches the end of a dynamic block.")
10748 (defun org-create-dblock (plist)
10749 "Create a dynamic block section, with parameters taken from PLIST.
10750 PLIST must contain a :name entry which is used as name of the block."
10752 (end-of-line 1)
10753 (newline))
10754 (let ((col (current-column))
10755 (name (plist-get plist :name)))
10756 (insert "#+BEGIN: " name)
10757 (while plist
10758 (if (eq (car plist) :name)
10759 (setq plist (cddr plist))
10760 (insert " " (prin1-to-string (pop plist)))))
10762 (beginning-of-line -2)))
10764 (defun org-prepare-dblock ()
10765 "Prepare dynamic block for refresh.
10766 This empties the block, puts the cursor at the insert position and returns
10767 the property list including an extra property :name with the block name."
10768 (unless (looking-at org-dblock-start-re)
10769 (error "Not at a dynamic block"))
10770 (let* ((begdel (1+ (match-end 0)))
10771 (name (org-no-properties (match-string 1)))
10772 (params (append (list :name name)
10773 (read (concat "(" (match-string 3) ")")))))
10774 (save-excursion
10775 (beginning-of-line 1)
10777 (setq params (plist-put params :indentation-column (current-column))))
10778 (unless (re-search-forward org-dblock-end-re nil t)
10779 (error "Dynamic block not terminated"))
10780 (setq params
10781 (append params
10782 (list :content (buffer-substring
10783 begdel (match-beginning 0)))))
10784 (delete-region begdel (match-beginning 0))
10785 (goto-char begdel)
10786 (open-line 1)
10787 params))
10789 (defun org-map-dblocks (&optional command)
10790 "Apply COMMAND to all dynamic blocks in the current buffer.
10791 If COMMAND is not given, use `org-update-dblock'."
10792 (let ((cmd (or command 'org-update-dblock)))
10793 (save-excursion
10794 (goto-char (point-min))
10795 (while (re-search-forward org-dblock-start-re nil t)
10796 (goto-char (match-beginning 0))
10797 (save-excursion
10798 (condition-case nil
10799 (funcall cmd)
10800 (error (message "Error during update of dynamic block"))))
10801 (unless (re-search-forward org-dblock-end-re nil t)
10802 (error "Dynamic block not terminated"))))))
10804 (defun org-dblock-update (&optional arg)
10805 "User command for updating dynamic blocks.
10806 Update the dynamic block at point. With prefix ARG, update all dynamic
10807 blocks in the buffer."
10808 (interactive "P")
10809 (if arg
10810 (org-update-all-dblocks)
10811 (or (looking-at org-dblock-start-re)
10812 (org-beginning-of-dblock))
10813 (org-update-dblock)))
10815 (defun org-update-dblock ()
10816 "Update the dynamic block at point.
10817 This means to empty the block, parse for parameters and then call
10818 the correct writing function."
10819 (interactive)
10820 (save-window-excursion
10821 (let* ((pos (point))
10822 (line (org-current-line))
10823 (params (org-prepare-dblock))
10824 (name (plist-get params :name))
10825 (indent (plist-get params :indentation-column))
10826 (cmd (intern (concat "org-dblock-write:" name))))
10827 (message "Updating dynamic block `%s' at line %d..." name line)
10828 (funcall cmd params)
10829 (message "Updating dynamic block `%s' at line %d...done" name line)
10830 (goto-char pos)
10831 (when (and indent (> indent 0))
10832 (setq indent (make-string indent ?\ ))
10833 (save-excursion
10834 (org-beginning-of-dblock)
10835 (forward-line 1)
10836 (while (not (looking-at org-dblock-end-re))
10837 (insert indent)
10838 (beginning-of-line 2))
10839 (when (looking-at org-dblock-end-re)
10841 (replace-match ""))
10842 (insert indent)))))))
10844 (defun org-beginning-of-dblock ()
10845 "Find the beginning of the dynamic block at point.
10846 Error if there is no such block at point."
10847 (let ((pos (point))
10848 beg)
10849 (end-of-line 1)
10850 (if (and (re-search-backward org-dblock-start-re nil t)
10851 (setq beg (match-beginning 0))
10852 (re-search-forward org-dblock-end-re nil t)
10853 (> (match-end 0) pos))
10854 (goto-char beg)
10855 (goto-char pos)
10856 (error "Not in a dynamic block"))))
10858 (defun org-update-all-dblocks ()
10859 "Update all dynamic blocks in the buffer.
10860 This function can be used in a hook."
10861 (interactive)
10862 (when (org-mode-p)
10863 (org-map-dblocks 'org-update-dblock)))
10866 ;;;; Completion
10868 (defconst org-additional-option-like-keywords
10869 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10870 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10871 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10872 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10873 "BEGIN:" "END:"
10874 "ORGTBL" "TBLFM:" "TBLNAME:"
10875 "BEGIN_EXAMPLE" "END_EXAMPLE"
10876 "BEGIN_QUOTE" "END_QUOTE"
10877 "BEGIN_VERSE" "END_VERSE"
10878 "BEGIN_CENTER" "END_CENTER"
10879 "BEGIN_SRC" "END_SRC"
10880 "BEGIN_RESULT" "END_RESULT"
10881 "SOURCE:" "SRCNAME:" "FUNCTION:"
10882 "RESULTS:" "DATA:"
10883 "HEADER:" "HEADERS:"
10884 "BABEL:"
10885 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10886 "CAPTION:" "LABEL:"
10887 "SETUPFILE:"
10888 "INCLUDE:"
10889 "BIND:"
10890 "MACRO:"))
10892 (defcustom org-structure-template-alist
10893 '(
10906 ("L" "#+latex: "
10910 ("H" "#+html: "
10913 ("A" "#+ascii: ")
10914 ("i" "#+index: ?"
10915 "#+index: ?")
10916 ("I" "#+include %file ?"
10918 )
10919 "Structure completion elements.
10920 This is a list of abbreviation keys and values. The value gets inserted
10921 if you type `<' followed by the key and then press the completion key,
10922 usually `M-TAB'. %file will be replaced by a file name after prompting
10923 for the file using completion. The cursor will be placed at the position
10924 of the `?` in the template.
10925 There are two templates for each key, the first uses the original Org syntax,
10926 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10927 the default when the /org-mtags.el/ module has been loaded. See also the
10928 variable `org-mtags-prefer-muse-templates'.
10929 This is an experimental feature, it is undecided if it is going to stay in."
10930 :group 'org-completion
10931 :type '(repeat
10932 (string :tag "Key")
10933 (string :tag "Template")
10934 (string :tag "Muse Template")))
10936 (defun org-try-structure-completion ()
10937 "Try to complete a structure template before point.
10939 expands them."
10940 (let ((l (buffer-substring (point-at-bol) (point)))
10941 a)
10944 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10945 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10946 (match-beginning 1)) a)
10947 t)))
10949 (defun org-complete-expand-structure-template (start cell)
10950 "Expand a structure template."
10951 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10952 (rpl (nth (if musep 2 1) cell))
10953 (ind ""))
10954 (delete-region start (point))
10956 (cond
10957 ((bolp))
10959 (setq ind (buffer-substring (point-at-bol) (point))))
10960 (t (newline))))
10961 (setq start (point))
10962 (if (string-match "%file" rpl)
10963 (setq rpl (replace-match
10964 (concat
10966 (save-match-data
10967 (abbreviate-file-name (read-file-name "Include file: ")))
10969 t t rpl)))
10972 (insert rpl)
10975 ;;;; TODO, DEADLINE, Comments
10977 (defun org-toggle-comment ()
10978 "Change the COMMENT state of an entry."
10979 (interactive)
10980 (save-excursion
10981 (org-back-to-heading)
10982 (let (case-fold-search)
10983 (if (looking-at (concat org-outline-regexp
10985 (replace-match "" t t nil 1)
10986 (if (looking-at org-outline-regexp)
10987 (progn
10988 (goto-char (match-end 0))
10989 (insert org-comment-string " ")))))))
10991 (defvar org-last-todo-state-is-todo nil
10992 "This is non-nil when the last TODO state change led to a TODO state.
10993 If the last change removed the TODO tag or switched to DONE, then
10994 this is nil.")
10996 (defvar org-setting-tags nil) ; dynamically skipped
10998 (defvar org-todo-setup-filter-hook nil
10999 "Hook for functions that pre-filter todo specs.
11000 Each function takes a todo spec and returns either nil or the spec
11001 transformed into canonical form." )
11003 (defvar org-todo-get-default-hook nil
11004 "Hook for functions that get a default item for todo.
11005 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11006 nil or a string to be used for the todo mark." )
11008 (defvar org-agenda-headline-snapshot-before-repeat)
11010 (defun org-current-effective-time ()
11011 "Return current time adjusted for `org-extend-today-until' variable"
11012 (let* ((ct (org-current-time))
11013 (dct (decode-time ct))
11014 (ct1
11015 (if (and org-use-effective-time
11016 (< (nth 2 dct) org-extend-today-until))
11017 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11018 ct)))
11019 ct1))
11021 (defun org-todo-yesterday (&optional arg)
11022 "Like `org-todo' but the time of change will be 23:59 of yesterday"
11023 (interactive "P")
11024 (let* ((hour (third (decode-time
11025 (org-current-time))))
11026 (org-extend-today-until (1+ hour)))
11027 (org-todo arg)))
11029 (defun org-todo (&optional arg)
11030 "Change the TODO state of an item.
11031 The state of an item is given by a keyword at the start of the heading,
11032 like
11033 *** TODO Write paper
11034 *** DONE Call mom
11036 The different keywords are specified in the variable `org-todo-keywords'.
11038 So for this example: when the item starts with TODO, it is changed to DONE.
11039 When it starts with DONE, the DONE is removed. And when neither TODO nor
11040 DONE are present, add TODO at the beginning of the heading.
11043 state.
11044 With numeric prefix arg, switch to that state.
11046 keywords (nextset).
11049 For calling through lisp, arg is also interpreted in the following way:
11050 'none -> empty state
11052 'done -> switch to DONE
11053 'nextset -> switch to the next set of keywords
11054 'previousset -> switch to the previous set of keywords
11056 really is a member of `org-todo-keywords'."
11057 (interactive "P")
11058 (if (equal arg '(16)) (setq arg 'nextset))
11059 (let ((org-blocker-hook org-blocker-hook)
11060 (case-fold-search nil))
11061 (when (equal arg '(64))
11062 (setq arg nil org-blocker-hook nil))
11063 (when (and org-blocker-hook
11064 (or org-inhibit-blocking
11065 (org-entry-get nil "NOBLOCKING")))
11066 (setq org-blocker-hook nil))
11067 (save-excursion
11068 (catch 'exit
11069 (org-back-to-heading t)
11070 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11072 (looking-at " *"))
11073 (let* ((match-data (match-data))
11074 (startpos (point-at-bol))
11075 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11076 (org-log-done org-log-done)
11077 (org-log-repeat org-log-repeat)
11078 (org-todo-log-states org-todo-log-states)
11079 (this (match-string 1))
11080 (hl-pos (match-beginning 0))
11081 (head (org-get-todo-sequence-head this))
11082 (ass (assoc head org-todo-kwd-alist))
11083 (interpret (nth 1 ass))
11084 (done-word (nth 3 ass))
11085 (final-done-word (nth 4 ass))
11086 (last-state (or this ""))
11087 (completion-ignore-case t)
11088 (member (member this org-todo-keywords-1))
11089 (tail (cdr member))
11090 (state (cond
11091 ((and org-todo-key-trigger
11092 (or (and (equal arg '(4))
11093 (eq org-use-fast-todo-selection 'prefix))
11094 (and (not arg) org-use-fast-todo-selection
11095 (not (eq org-use-fast-todo-selection
11096 'prefix)))))
11097 ;; Use fast selection
11098 (org-fast-todo-selection))
11099 ((and (equal arg '(4))
11100 (or (not org-use-fast-todo-selection)
11101 (not org-todo-key-trigger)))
11102 ;; Read a state with completion
11103 (org-icompleting-read
11104 "State: " (mapcar (lambda(x) (list x))
11105 org-todo-keywords-1)
11106 nil t))
11107 ((eq arg 'right)
11108 (if this
11109 (if tail (car tail) nil)
11110 (car org-todo-keywords-1)))
11111 ((eq arg 'left)
11112 (if (equal member org-todo-keywords-1)
11113 nil
11114 (if this
11115 (nth (- (length org-todo-keywords-1)
11116 (length tail) 2)
11117 org-todo-keywords-1)
11118 (org-last org-todo-keywords-1))))
11119 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11120 (setq arg nil))) ; hack to fall back to cycling
11121 (arg
11122 ;; user or caller requests a specific state
11123 (cond
11124 ((equal arg "") nil)
11125 ((eq arg 'none) nil)
11126 ((eq arg 'done) (or done-word (car org-done-keywords)))
11127 ((eq arg 'nextset)
11128 (or (car (cdr (member head org-todo-heads)))
11129 (car org-todo-heads)))
11130 ((eq arg 'previousset)
11131 (let ((org-todo-heads (reverse org-todo-heads)))
11132 (or (car (cdr (member head org-todo-heads)))
11133 (car org-todo-heads))))
11134 ((car (member arg org-todo-keywords-1)))
11135 ((stringp arg)
11136 (error "State `%s' not valid in this file" arg))
11137 ((nth (1- (prefix-numeric-value arg))
11138 org-todo-keywords-1))))
11139 ((null member) (or head (car org-todo-keywords-1)))
11140 ((equal this final-done-word) nil) ;; -> make empty
11141 ((null tail) nil) ;; -> first entry
11142 ((memq interpret '(type priority))
11143 (if (eq this-command last-command)
11144 (car tail)
11145 (if (> (length tail) 0)
11146 (or done-word (car org-done-keywords))
11147 nil)))
11148 (t
11149 (car tail))))
11150 (state (or
11151 (run-hook-with-args-until-success
11152 'org-todo-get-default-hook state last-state)
11153 state))
11154 (next (if state (concat " " state " ") " "))
11155 (change-plist (list :type 'todo-state-change :from this :to state
11156 :position startpos))
11157 dolog now-done-p)
11158 (when org-blocker-hook
11159 (setq org-last-todo-state-is-todo
11160 (not (member this org-done-keywords)))
11161 (unless (save-excursion
11162 (save-match-data
11163 (org-with-wide-buffer
11164 (run-hook-with-args-until-failure
11165 'org-blocker-hook change-plist))))
11166 (if (org-called-interactively-p 'interactive)
11167 (error "TODO state change from %s to %s blocked" this state)
11168 ;; fail silently
11169 (message "TODO state change from %s to %s blocked" this state)
11170 (throw 'exit nil))))
11171 (store-match-data match-data)
11172 (replace-match next t t)
11173 (unless (pos-visible-in-window-p hl-pos)
11174 (message "TODO state changed to %s" (org-trim next)))
11175 (unless head
11176 (setq head (org-get-todo-sequence-head state)
11177 ass (assoc head org-todo-kwd-alist)
11178 interpret (nth 1 ass)
11179 done-word (nth 3 ass)
11180 final-done-word (nth 4 ass)))
11181 (when (memq arg '(nextset previousset))
11182 (message "Keyword-Set %d/%d: %s"
11183 (- (length org-todo-sets) -1
11184 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11185 (length org-todo-sets)
11186 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11187 (setq org-last-todo-state-is-todo
11188 (not (member state org-done-keywords)))
11189 (setq now-done-p (and (member state org-done-keywords)
11190 (not (member this org-done-keywords))))
11191 (and logging (org-local-logging logging))
11192 (when (and (or org-todo-log-states org-log-done)
11193 (not (eq org-inhibit-logging t))
11194 (not (memq arg '(nextset previousset))))
11195 ;; we need to look at recording a time and note
11196 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11197 (nth 2 (assoc this org-todo-log-states))))
11198 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11199 (setq dolog 'time))
11200 (when (and state
11201 (member state org-not-done-keywords)
11202 (not (member this org-not-done-keywords)))
11203 ;; This is now a todo state and was not one before
11204 ;; If there was a CLOSED time stamp, get rid of it.
11205 (org-add-planning-info nil nil 'closed))
11206 (when (and now-done-p org-log-done)
11207 ;; It is now done, and it was not done before
11208 (org-add-planning-info 'closed (org-current-effective-time))
11209 (if (and (not dolog) (eq 'note org-log-done))
11210 (org-add-log-setup 'done state this 'findpos 'note)))
11211 (when (and state dolog)
11212 ;; This is a non-nil state, and we need to log it
11213 (org-add-log-setup 'state state this 'findpos dolog)))
11214 ;; Fixup tag positioning
11215 (org-todo-trigger-tag-changes state)
11216 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11217 (when org-provide-todo-statistics
11218 (org-update-parent-todo-statistics))
11219 (run-hooks 'org-after-todo-state-change-hook)
11220 (if (and arg (not (member state org-done-keywords)))
11221 (setq head (org-get-todo-sequence-head state)))
11222 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11223 ;; Do we need to trigger a repeat?
11224 (when now-done-p
11225 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11226 ;; This is for the agenda, take a snapshot of the headline.
11227 (save-match-data
11228 (setq org-agenda-headline-snapshot-before-repeat
11229 (org-get-heading))))
11230 (org-auto-repeat-maybe state))
11231 ;; Fixup cursor location if close to the keyword
11232 (if (and (outline-on-heading-p)
11233 (not (bolp))
11234 (save-excursion (beginning-of-line 1)
11235 (looking-at org-todo-line-regexp))
11236 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11237 (progn
11238 (goto-char (or (match-end 2) (match-end 1)))
11239 (and (looking-at " ") (just-one-space))))
11240 (when org-trigger-hook
11241 (save-excursion
11242 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11244 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11245 "Block turning an entry into a TODO, using the hierarchy.
11246 This checks whether the current task should be blocked from state
11247 changes. Such blocking occurs when:
11249 1. The task has children which are not all in a completed state.
11251 2. A task has a parent with the property :ORDERED:, and there
11252 are siblings prior to the current task with incomplete
11253 status.
11255 3. The parent of the task is blocked because it has siblings that should
11256 be done first, or is child of a block grandparent TODO entry."
11258 (if (not org-enforce-todo-dependencies)
11259 t ; if locally turned off don't block
11260 (catch 'dont-block
11261 ;; If this is not a todo state change, or if this entry is already DONE,
11262 ;; do not block
11263 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11264 (member (plist-get change-plist :from)
11265 (cons 'done org-done-keywords))
11266 (member (plist-get change-plist :to)
11267 (cons 'todo org-not-done-keywords))
11268 (not (plist-get change-plist :to)))
11269 (throw 'dont-block t))
11270 ;; If this task has children, and any are undone, it's blocked
11271 (save-excursion
11272 (org-back-to-heading t)
11273 (let ((this-level (funcall outline-level)))
11274 (outline-next-heading)
11275 (let ((child-level (funcall outline-level)))
11276 (while (and (not (eobp))
11277 (> child-level this-level))
11278 ;; this todo has children, check whether they are all
11279 ;; completed
11280 (if (and (not (org-entry-is-done-p))
11281 (org-entry-is-todo-p))
11282 (throw 'dont-block nil))
11283 (outline-next-heading)
11284 (setq child-level (funcall outline-level))))))
11285 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11286 ;; any previous siblings are undone, it's blocked
11287 (save-excursion
11288 (org-back-to-heading t)
11289 (let* ((pos (point))
11290 (parent-pos (and (org-up-heading-safe) (point))))
11291 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11292 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11293 (forward-line 1)
11294 (re-search-forward org-not-done-heading-regexp pos t))
11295 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11296 ;; Search further up the hierarchy, to see if an anchestor is blocked
11297 (while t
11298 (goto-char parent-pos)
11299 (if (not (looking-at org-not-done-heading-regexp))
11300 (throw 'dont-block t)) ; do not block, parent is not a TODO
11301 (setq pos (point))
11302 (setq parent-pos (and (org-up-heading-safe) (point)))
11303 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11304 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11305 (forward-line 1)
11306 (re-search-forward org-not-done-heading-regexp pos t))
11307 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11309 (defcustom org-track-ordered-property-with-tag nil
11310 "Should the ORDERED property also be shown as a tag?
11311 The ORDERED property decides if an entry should require subtasks to be
11312 completed in sequence. Since a property is not very visible, setting
11313 this option means that toggling the ORDERED property with the command
11314 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11315 not relevant for the behavior, but it makes things more visible.
11317 Note that toggling the tag with tags commands will not change the property
11318 and therefore not influence behavior!
11320 This can be t, meaning the tag ORDERED should be used, It can also be a
11321 string to select a different tag for this task."
11322 :group 'org-todo
11323 :type '(choice
11324 (const :tag "No tracking" nil)
11325 (const :tag "Track with ORDERED tag" t)
11326 (string :tag "Use other tag")))
11328 (defun org-toggle-ordered-property ()
11329 "Toggle the ORDERED property of the current entry.
11330 For better visibility, you can track the value of this property with a tag.
11331 See variable `org-track-ordered-property-with-tag'."
11332 (interactive)
11333 (let* ((t1 org-track-ordered-property-with-tag)
11334 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11335 (save-excursion
11336 (org-back-to-heading)
11337 (if (org-entry-get nil "ORDERED")
11338 (progn
11339 (org-delete-property "ORDERED")
11340 (and tag (org-toggle-tag tag 'off))
11341 (message "Subtasks can be completed in arbitrary order"))
11342 (org-entry-put nil "ORDERED" "t")
11343 (and tag (org-toggle-tag tag 'on))
11344 (message "Subtasks must be completed in sequence")))))
11346 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11347 (defun org-block-todo-from-checkboxes (change-plist)
11348 "Block turning an entry into a TODO, using checkboxes.
11349 This checks whether the current task should be blocked from state
11350 changes because there are unchecked boxes in this entry."
11351 (if (not org-enforce-todo-checkbox-dependencies)
11352 t ; if locally turned off don't block
11353 (catch 'dont-block
11354 ;; If this is not a todo state change, or if this entry is already DONE,
11355 ;; do not block
11356 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11357 (member (plist-get change-plist :from)
11358 (cons 'done org-done-keywords))
11359 (member (plist-get change-plist :to)
11360 (cons 'todo org-not-done-keywords))
11361 (not (plist-get change-plist :to)))
11362 (throw 'dont-block t))
11363 ;; If this task has checkboxes that are not checked, it's blocked
11364 (save-excursion
11365 (org-back-to-heading t)
11366 (let ((beg (point)) end)
11367 (outline-next-heading)
11368 (setq end (point))
11369 (goto-char beg)
11370 (if (org-list-search-forward
11371 (concat (org-item-beginning-re)
11374 end t)
11375 (progn
11376 (if (boundp 'org-blocked-by-checkboxes)
11377 (setq org-blocked-by-checkboxes t))
11378 (throw 'dont-block nil)))))
11379 t))) ; do not block
11381 (defun org-entry-blocked-p ()
11382 "Is the current entry blocked?"
11383 (if (org-entry-get nil "NOBLOCKING")
11384 nil ;; Never block this entry
11385 (not
11386 (run-hook-with-args-until-failure
11387 'org-blocker-hook
11388 (list :type 'todo-state-change
11389 :position (point)
11390 :from 'todo
11391 :to 'done)))))
11393 (defun org-update-statistics-cookies (all)
11394 "Update the statistics cookie, either from TODO or from checkboxes.
11395 This should be called with the cursor in a line with a statistics cookie."
11396 (interactive "P")
11397 (if all
11398 (progn
11399 (org-update-checkbox-count 'all)
11400 (org-map-entries 'org-update-parent-todo-statistics))
11401 (if (not (org-on-heading-p))
11402 (org-update-checkbox-count)
11403 (let ((pos (move-marker (make-marker) (point)))
11404 end l1 l2)
11405 (ignore-errors (org-back-to-heading t))
11406 (if (not (org-on-heading-p))
11407 (org-update-checkbox-count)
11408 (setq l1 (org-outline-level))
11409 (setq end (save-excursion
11410 (outline-next-heading)
11411 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11412 (point)))
11413 (if (and (save-excursion
11414 (re-search-forward
11416 (not (save-excursion (re-search-forward
11418 (org-update-checkbox-count)
11419 (if (and l2 (> l2 l1))
11420 (progn
11421 (goto-char end)
11422 (org-update-parent-todo-statistics))
11423 (goto-char pos)
11424 (beginning-of-line 1)
11425 (while (re-search-forward
11427 (point-at-eol) t)
11428 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11429 (goto-char pos)
11430 (move-marker pos nil)))))
11432 (defvar org-entry-property-inherited-from) ;; defined below
11433 (defun org-update-parent-todo-statistics ()
11434 "Update any statistics cookie in the parent of the current headline.
11435 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11436 the entire subtree and this will travel up the hierarchy and update
11437 statistics everywhere."
11438 (let* ((prop (save-excursion (org-up-heading-safe)
11439 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11440 (recursive (or (not org-hierarchical-todo-statistics)
11442 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11443 0))
11444 (first t)
11446 level ltoggle l1 new ndel
11447 (cnt-all 0) (cnt-done 0) is-percent kwd
11448 checkbox-beg ov ovs ove cookie-present)
11449 (catch 'exit
11450 (save-excursion
11451 (beginning-of-line 1)
11452 (setq ltoggle (funcall outline-level))
11453 ;; Three situations are to consider:
11455 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11456 ;; to the top-level ancestor on the headline;
11458 ;; 2. If parent has "recursive" property, repeat up to the
11459 ;; headline setting that property, taking inheritance into
11460 ;; account;
11462 ;; 3. Else, move up to direct parent and proceed only once.
11463 (while (and (setq level (org-up-heading-safe))
11464 (or recursive first)
11465 (>= (point) lim))
11466 (setq first nil cookie-present nil)
11467 (unless (and level
11468 (not (string-match
11470 (downcase (or (org-entry-get nil "COOKIE_DATA")
11471 "")))))
11472 (throw 'exit nil))
11473 (while (re-search-forward box-re (point-at-eol) t)
11474 (setq cnt-all 0 cnt-done 0 cookie-present t)
11475 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11476 (save-match-data
11477 (unless (outline-next-heading) (throw 'exit nil))
11478 (while (and (looking-at org-complex-heading-regexp)
11479 (> (setq l1 (length (match-string 1))) level))
11480 (setq kwd (and (or recursive (= l1 ltoggle))
11481 (match-string 2)))
11482 (if (or (eq org-provide-todo-statistics 'all-headlines)
11483 (and (listp org-provide-todo-statistics)
11484 (or (member kwd org-provide-todo-statistics)
11485 (member kwd org-done-keywords))))
11486 (setq cnt-all (1+ cnt-all))
11487 (if (eq org-provide-todo-statistics t)
11488 (and kwd (setq cnt-all (1+ cnt-all)))))
11489 (and (member kwd org-done-keywords)
11490 (setq cnt-done (1+ cnt-done)))
11491 (outline-next-heading)))
11492 (setq new
11493 (if is-percent
11494 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11495 (format "[%d/%d]" cnt-done cnt-all))
11496 ndel (- (match-end 0) checkbox-beg))
11497 ;; handle overlays when updating cookie from column view
11498 (when (setq ov (car (overlays-at checkbox-beg)))
11499 (setq ovs (overlay-start ov) ove (overlay-end ov))
11500 (delete-overlay ov))
11501 (goto-char checkbox-beg)
11502 (insert new)
11503 (delete-region (point) (+ (point) ndel))
11504 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11505 (when ov (move-overlay ov ovs ove)))
11506 (when cookie-present
11507 (run-hook-with-args 'org-after-todo-statistics-hook
11508 cnt-done (- cnt-all cnt-done))))))
11509 (run-hooks 'org-todo-statistics-hook)))
11511 (defvar org-after-todo-statistics-hook nil
11512 "Hook that is called after a TODO statistics cookie has been updated.
11513 Each function is called with two arguments: the number of not-done entries
11514 and the number of done entries.
11516 For example, the following function, when added to this hook, will switch
11517 an entry to DONE when all children are done, and back to TODO when new
11518 entries are set to a TODO status. Note that this hook is only called
11519 when there is a statistics cookie in the headline!
11521 (defun org-summary-todo (n-done n-not-done)
11523 (let (org-log-done org-log-states) ; turn off logging
11525 ")
11527 (defvar org-todo-statistics-hook nil
11528 "Hook that is run whenever Org thinks TODO statistics should be updated.
11529 This hook runs even if there is no statistics cookie present, in which case
11530 `org-after-todo-statistics-hook' would not run.")
11532 (defun org-todo-trigger-tag-changes (state)
11533 "Apply the changes defined in `org-todo-state-tags-triggers'."
11534 (let ((l org-todo-state-tags-triggers)
11535 changes)
11536 (when (or (not state) (equal state ""))
11537 (setq changes (append changes (cdr (assoc "" l)))))
11538 (when (and (stringp state) (> (length state) 0))
11539 (setq changes (append changes (cdr (assoc state l)))))
11540 (when (member state org-not-done-keywords)
11541 (setq changes (append changes (cdr (assoc 'todo l)))))
11542 (when (member state org-done-keywords)
11543 (setq changes (append changes (cdr (assoc 'done l)))))
11544 (dolist (c changes)
11545 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11547 (defun org-local-logging (value)
11548 "Get logging settings from a property VALUE."
11549 (let* (words w a)
11550 ;; directly set the variables, they are already local.
11551 (setq org-log-done nil
11552 org-log-repeat nil
11553 org-todo-log-states nil)
11554 (setq words (org-split-string value))
11555 (while (setq w (pop words))
11556 (cond
11557 ((setq a (assoc w org-startup-options))
11558 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11559 (set (nth 1 a) (nth 2 a))))
11560 ((setq a (org-extract-log-state-settings w))
11561 (and (member (car a) org-todo-keywords-1)
11562 (push a org-todo-log-states)))))))
11564 (defun org-get-todo-sequence-head (kwd)
11565 "Return the head of the TODO sequence to which KWD belongs.
11566 If KWD is not set, check if there is a text property remembering the
11567 right sequence."
11568 (let (p)
11569 (cond
11570 ((not kwd)
11571 (or (get-text-property (point-at-bol) 'org-todo-head)
11572 (progn
11573 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11574 nil (point-at-eol)))
11575 (get-text-property p 'org-todo-head))))
11576 ((not (member kwd org-todo-keywords-1))
11577 (car org-todo-keywords-1))
11578 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11580 (defun org-fast-todo-selection ()
11581 "Fast TODO keyword selection with single keys.
11582 Returns the new TODO keyword, or nil if no state change should occur."
11583 (let* ((fulltable org-todo-key-alist)
11584 (done-keywords org-done-keywords) ;; needed for the faces.
11585 (maxlen (apply 'max (mapcar
11586 (lambda (x)
11587 (if (stringp (car x)) (string-width (car x)) 0))
11588 fulltable)))
11589 (expert nil)
11590 (fwidth (+ maxlen 3 1 3))
11591 (ncol (/ (- (window-width) 4) fwidth))
11592 tg cnt e c tbl
11593 groups ingroup)
11594 (save-excursion
11595 (save-window-excursion
11596 (if expert
11597 (set-buffer (get-buffer-create " *Org todo*"))
11598 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11599 (erase-buffer)
11600 (org-set-local 'org-done-keywords done-keywords)
11601 (setq tbl fulltable cnt 0)
11602 (while (setq e (pop tbl))
11603 (cond
11604 ((equal e '(:startgroup))
11605 (push '() groups) (setq ingroup t)
11606 (when (not (= cnt 0))
11607 (setq cnt 0)
11609 (insert "{ "))
11610 ((equal e '(:endgroup))
11611 (setq ingroup nil cnt 0)
11613 ((equal e '(:newline))
11614 (when (not (= cnt 0))
11615 (setq cnt 0)
11617 (setq e (car tbl))
11618 (while (equal (car tbl) '(:newline))
11620 (setq tbl (cdr tbl)))))
11621 (t
11622 (setq tg (car e) c (cdr e))
11623 (if ingroup (push tg (car groups)))
11624 (setq tg (org-add-props tg nil 'face
11625 (org-get-todo-face tg)))
11626 (if (and (= cnt 0) (not ingroup)) (insert " "))
11627 (insert "[" c "] " tg (make-string
11628 (- fwidth 4 (length tg)) ?\ ))
11629 (when (= (setq cnt (1+ cnt)) ncol)
11631 (if ingroup (insert " "))
11632 (setq cnt 0)))))
11634 (goto-char (point-min))
11635 (if (not expert) (org-fit-window-to-buffer))
11636 (message "[a-z..]:Set [SPC]:clear")
11637 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11638 (cond
11639 ((or (= c ?\C-g)
11640 (and (= c ?q) (not (rassoc c fulltable))))
11641 (setq quit-flag t))
11642 ((= c ?\ ) nil)
11643 ((setq e (rassoc c fulltable) tg (car e))
11644 tg)
11645 (t (setq quit-flag t)))))))
11647 (defun org-entry-is-todo-p ()
11648 (member (org-get-todo-state) org-not-done-keywords))
11650 (defun org-entry-is-done-p ()
11651 (member (org-get-todo-state) org-done-keywords))
11653 (defun org-get-todo-state ()
11654 (save-excursion
11655 (org-back-to-heading t)
11656 (and (looking-at org-todo-line-regexp)
11657 (match-end 2)
11658 (match-string 2))))
11660 (defun org-at-date-range-p (&optional inactive-ok)
11661 "Is the cursor inside a date range?"
11662 (interactive)
11663 (save-excursion
11664 (catch 'exit
11665 (let ((pos (point)))
11667 (skip-chars-backward "<[")
11668 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11669 (>= (match-end 0) pos)
11670 (throw 'exit t))
11672 (skip-chars-backward "<[")
11673 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11674 (>= (match-end 0) pos)
11675 (throw 'exit t)))
11676 nil)))
11678 (defun org-get-repeat (&optional tagline)
11679 "Check if there is a deadline/schedule with repeater in this entry."
11680 (save-match-data
11681 (save-excursion
11682 (org-back-to-heading t)
11683 (and (re-search-forward (if tagline
11685 org-repeat-re)
11686 (org-entry-end-position) t)
11687 (match-string-no-properties 1)))))
11689 (defvar org-last-changed-timestamp)
11690 (defvar org-last-inserted-timestamp)
11691 (defvar org-log-post-message)
11692 (defvar org-log-note-purpose)
11693 (defvar org-log-note-how)
11694 (defvar org-log-note-extra)
11695 (defun org-auto-repeat-maybe (done-word)
11696 "Check if the current headline contains a repeated deadline/schedule.
11697 If yes, set TODO state back to what it was and change the base date
11698 of repeating deadline/scheduled time stamps to new date.
11699 This function is run automatically after each state change to a DONE state."
11700 ;; last-state is dynamically scoped into this function
11701 (let* ((repeat (org-get-repeat))
11702 (aa (assoc last-state org-todo-kwd-alist))
11703 (interpret (nth 1 aa))
11704 (head (nth 2 aa))
11705 (whata '(("d" . day) ("m" . month) ("y" . year)))
11706 (msg "Entry repeats: ")
11707 (org-log-done nil)
11708 (org-todo-log-states nil)
11709 re type n what ts time to-state)
11710 (when repeat
11711 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11712 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11713 org-todo-repeat-to-state))
11714 (unless (and to-state (member to-state org-todo-keywords-1))
11715 (setq to-state (if (eq interpret 'type) last-state head)))
11716 (org-todo to-state)
11717 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11718 (org-entry-put nil "LAST_REPEAT" (format-time-string
11719 (org-time-stamp-format t t))))
11720 (when org-log-repeat
11721 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11722 (memq 'org-add-log-note post-command-hook))
11723 ;; OK, we are already setup for some record
11724 (if (eq org-log-repeat 'note)
11725 ;; make sure we take a note, not only a time stamp
11726 (setq org-log-note-how 'note))
11727 ;; Set up for taking a record
11728 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11729 last-state
11730 'findpos org-log-repeat)))
11731 (org-back-to-heading t)
11732 (org-add-planning-info nil nil 'closed)
11736 (while (re-search-forward
11737 re (save-excursion (outline-next-heading) (point)) t)
11738 (setq type (if (match-end 1) org-scheduled-string
11739 (if (match-end 3) org-deadline-string "Plain:"))
11740 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11742 (setq n (string-to-number (match-string 2 ts))
11743 what (match-string 3 ts))
11744 (if (equal what "w") (setq n (* n 7) what "d"))
11745 ;; Preparation, see if we need to modify the start date for the change
11746 (when (match-end 1)
11747 (setq time (save-match-data (org-time-string-to-time ts)))
11748 (cond
11749 ((equal (match-string 1 ts) ".")
11750 ;; Shift starting date to today
11751 (org-timestamp-change
11752 (- (org-today) (time-to-days time))
11753 'day))
11754 ((equal (match-string 1 ts) "+")
11755 (let ((nshiftmax 10) (nshift 0))
11756 (while (or (= nshift 0)
11757 (<= (time-to-days time)
11758 (time-to-days (current-time))))
11759 (when (= (incf nshift) nshiftmax)
11760 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11761 (error "Abort")))
11762 (org-timestamp-change n (cdr (assoc what whata)))
11763 (org-at-timestamp-p t)
11764 (setq ts (match-string 1))
11765 (setq time (save-match-data (org-time-string-to-time ts)))))
11766 (org-timestamp-change (- n) (cdr (assoc what whata)))
11767 ;; rematch, so that we have everything in place for the real shift
11768 (org-at-timestamp-p t)
11769 (setq ts (match-string 1))
11771 (org-timestamp-change n (cdr (assoc what whata)))
11772 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11773 (setq org-log-post-message msg)
11774 (message "%s" msg))))
11776 (defun org-show-todo-tree (arg)
11777 "Make a compact tree which shows all headlines marked with TODO.
11778 The tree will show the lines where the regexp matches, and all higher
11779 headlines above the match.
11781 With a numeric prefix N, construct a sparse tree for the Nth element
11782 of `org-todo-keywords-1'."
11783 (interactive "P")
11784 (let ((case-fold-search nil)
11785 (kwd-re
11786 (cond ((null arg) org-not-done-regexp)
11787 ((equal arg '(4))
11788 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11789 (mapcar 'list org-todo-keywords-1))))
11793 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11794 (regexp-quote (nth (1- (prefix-numeric-value arg))
11795 org-todo-keywords-1)))
11796 (t (error "Invalid prefix argument: %s" arg)))))
11797 (message "%d TODO entries found"
11798 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11800 (defun org-deadline (&optional remove time)
11802 With argument REMOVE, remove any deadline from the item.
11803 With argument TIME, set the deadline at the corresponding date. TIME
11805 (interactive "P")
11806 (let* ((old-date (org-entry-get nil "DEADLINE"))
11807 (repeater (and old-date
11808 (string-match
11810 old-date)
11811 (match-string 1 old-date))))
11812 (if remove
11813 (progn
11814 (when (and old-date org-log-redeadline)
11815 (org-add-log-setup 'deldeadline nil old-date 'findpos
11816 org-log-redeadline))
11817 (org-remove-timestamp-with-keyword org-deadline-string)
11818 (message "Item no longer has a deadline."))
11819 (org-add-planning-info 'deadline time 'closed)
11820 (when (and old-date org-log-redeadline
11821 (not (equal old-date
11822 (substring org-last-inserted-timestamp 1 -1))))
11823 (org-add-log-setup 'redeadline nil old-date 'findpos
11824 org-log-redeadline))
11825 (when repeater
11826 (save-excursion
11827 (org-back-to-heading t)
11828 (when (re-search-forward (concat org-deadline-string " "
11829 org-last-inserted-timestamp)
11830 (save-excursion
11831 (outline-next-heading) (point)) t)
11832 (goto-char (1- (match-end 0)))
11833 (insert " " repeater)
11834 (setq org-last-inserted-timestamp
11835 (concat (substring org-last-inserted-timestamp 0 -1)
11836 " " repeater
11837 (substring org-last-inserted-timestamp -1))))))
11838 (message "Deadline on %s" org-last-inserted-timestamp))))
11840 (defun org-schedule (&optional remove time)
11841 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11842 With argument REMOVE, remove any scheduling date from the item.
11843 With argument TIME, scheduled at the corresponding date. TIME can
11845 (interactive "P")
11846 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11847 (repeater (and old-date
11848 (string-match
11850 old-date)
11851 (match-string 1 old-date))))
11852 (if remove
11853 (progn
11854 (when (and old-date org-log-reschedule)
11855 (org-add-log-setup 'delschedule nil old-date 'findpos
11856 org-log-reschedule))
11857 (org-remove-timestamp-with-keyword org-scheduled-string)
11858 (message "Item is no longer scheduled."))
11859 (org-add-planning-info 'scheduled time 'closed)
11860 (when (and old-date org-log-reschedule
11861 (not (equal old-date
11862 (substring org-last-inserted-timestamp 1 -1))))
11863 (org-add-log-setup 'reschedule nil old-date 'findpos
11864 org-log-reschedule))
11865 (when repeater
11866 (save-excursion
11867 (org-back-to-heading t)
11868 (when (re-search-forward (concat org-scheduled-string " "
11869 org-last-inserted-timestamp)
11870 (save-excursion
11871 (outline-next-heading) (point)) t)
11872 (goto-char (1- (match-end 0)))
11873 (insert " " repeater)
11874 (setq org-last-inserted-timestamp
11875 (concat (substring org-last-inserted-timestamp 0 -1)
11876 " " repeater
11877 (substring org-last-inserted-timestamp -1))))))
11878 (message "Scheduled to %s" org-last-inserted-timestamp))))
11880 (defun org-get-scheduled-time (pom &optional inherit)
11881 "Get the scheduled time as a time tuple, of a format suitable
11882 for calling org-schedule with, or if there is no scheduling,
11883 returns nil."
11884 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11885 (when time
11886 (apply 'encode-time (org-parse-time-string time)))))
11888 (defun org-get-deadline-time (pom &optional inherit)
11889 "Get the deadline as a time tuple, of a format suitable for
11890 calling org-deadline with, or if there is no scheduling, returns
11891 nil."
11892 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11893 (when time
11894 (apply 'encode-time (org-parse-time-string time)))))
11896 (defun org-remove-timestamp-with-keyword (keyword)
11897 "Remove all time stamps with KEYWORD in the current entry."
11899 beg)
11900 (save-excursion
11901 (org-back-to-heading t)
11902 (setq beg (point))
11903 (outline-next-heading)
11904 (while (re-search-backward re beg t)
11905 (replace-match "")
11907 (equal (char-before) ?\ ))
11908 (backward-delete-char 1)
11910 (point-at-bol) (point-at-eol)))
11911 (delete-region (point-at-bol)
11912 (min (point-max) (1+ (point-at-eol))))))))))
11914 (defun org-add-planning-info (what &optional time &rest remove)
11915 "Insert new timestamp with keyword in the line directly after the headline.
11916 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11917 If non is given, the user is prompted for a date.
11918 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11919 be removed."
11920 (interactive)
11921 (let (org-time-was-given org-end-time-was-given ts
11922 end default-time default-input)
11924 (catch 'exit
11925 (when (and (memq what '(scheduled deadline))
11926 (or (not time)
11927 (and (stringp time)
11928 (string-match "^[-+]+[0-9]" time))))
11929 ;; Try to get a default date/time from existing timestamp
11930 (save-excursion
11931 (org-back-to-heading t)
11932 (setq end (save-excursion (outline-next-heading) (point)))
11933 (when (re-search-forward (if (eq what 'scheduled)
11934 org-scheduled-time-regexp
11935 org-deadline-time-regexp)
11936 end t)
11937 (setq ts (match-string 1)
11938 default-time
11939 (apply 'encode-time (org-parse-time-string ts))
11940 default-input (and ts (org-get-compact-tod ts))))))
11941 (when what
11942 (setq time
11943 (if (and (stringp time)
11944 (string-match "^[-+]+[0-9]" time))
11945 ;; This is a relative time, set the proper date
11946 (apply 'encode-time
11947 (org-read-date-analyze
11948 time default-time (decode-time default-time)))
11949 ;; If necessary, get the time from the user
11950 (or time (org-read-date nil 'to-time nil nil
11951 default-time default-input)))))
11953 (when (and org-insert-labeled-timestamps-at-point
11954 (member what '(scheduled deadline)))
11955 (insert
11956 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11957 (org-insert-time-stamp time org-time-was-given
11958 nil nil nil (list org-end-time-was-given))
11959 (setq what nil))
11960 (save-excursion
11961 (save-restriction
11962 (let (col list elt ts buffer-invisibility-spec)
11963 (org-back-to-heading t)
11965 (goto-char (match-end 1))
11966 (setq col (current-column))
11967 (goto-char (match-end 0))
11969 (when (and (not what)
11970 (not (looking-at
11972 org-keyword-time-not-clock-regexp))))
11973 ;; Nothing to add, nothing to remove...... :-)
11974 (throw 'exit nil))
11975 (if (and (not (looking-at org-outline-regexp))
11978 (not (equal (match-string 1) org-clock-string)))
11979 (narrow-to-region (match-beginning 0) (match-end 0))
11981 (backward-char 1)
11982 (narrow-to-region (point) (point))
11983 (and org-adapt-indentation (org-indent-to-column col)))
11984 ;; Check if we have to remove something.
11985 (setq list (cons what remove))
11986 (while list
11987 (setq elt (pop list))
11988 (when (or (and (eq elt 'scheduled)
11989 (re-search-forward org-scheduled-time-regexp nil t))
11990 (and (eq elt 'deadline)
11991 (re-search-forward org-deadline-time-regexp nil t))
11992 (and (eq elt 'closed)
11993 (re-search-forward org-closed-time-regexp nil t)))
11994 (replace-match "")
11995 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11997 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11998 (when what
11999 (insert
12000 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12001 (cond ((eq what 'scheduled) org-scheduled-string)
12002 ((eq what 'deadline) org-deadline-string)
12003 ((eq what 'closed) org-closed-string))
12004 " ")
12005 (setq ts (org-insert-time-stamp
12006 time
12007 (or org-time-was-given
12008 (and (eq what 'closed) org-log-done-with-time))
12009 (eq what 'closed)
12010 nil nil (list org-end-time-was-given)))
12011 (insert
12012 (if (not (or (bolp) (eq (char-before) ?\ )
12013 (memq (char-after) '(32 10))
12014 (eobp))) " " ""))
12015 (end-of-line 1))
12016 (goto-char (point-min))
12017 (widen)
12020 (delete-region (1- (point)) (point-at-eol)))
12021 ts))))))
12023 (defvar org-log-note-marker (make-marker))
12024 (defvar org-log-note-purpose nil)
12025 (defvar org-log-note-state nil)
12026 (defvar org-log-note-previous-state nil)
12027 (defvar org-log-note-how nil)
12028 (defvar org-log-note-extra nil)
12029 (defvar org-log-note-window-configuration nil)
12030 (defvar org-log-note-return-to (make-marker))
12031 (defvar org-log-note-effective-time nil
12032 "Remembered current time so that dynamically scoped
12033 `org-extend-today-until' affects tha timestamps in state change
12034 log")
12036 (defvar org-log-post-message nil
12037 "Message to be displayed after a log note has been stored.
12038 The auto-repeater uses this.")
12040 (defun org-add-note ()
12041 "Add a note to the current entry.
12042 This is done in the same way as adding a state change note."
12043 (interactive)
12044 (org-add-log-setup 'note nil nil 'findpos nil))
12046 (defvar org-property-end-re)
12047 (defun org-add-log-setup (&optional purpose state prev-state
12048 findpos how extra)
12049 "Set up the post command hook to take a note.
12050 If this is about to TODO state change, the new state is expected in STATE.
12051 When FINDPOS is non-nil, find the correct position for the note in
12052 the current entry. If not, assume that it can be inserted at point.
12053 HOW is an indicator what kind of note should be created.
12054 EXTRA is additional text that will be inserted into the notes buffer."
12055 (let* ((org-log-into-drawer (org-log-into-drawer))
12056 (drawer (cond ((stringp org-log-into-drawer)
12057 org-log-into-drawer)
12058 (org-log-into-drawer "LOGBOOK")
12059 (t nil))))
12060 (save-restriction
12061 (save-excursion
12062 (when findpos
12063 (org-back-to-heading t)
12064 (narrow-to-region (point) (save-excursion
12065 (outline-next-heading) (point)))
12069 (goto-char (match-end 0))
12070 (cond
12071 (drawer
12073 nil t)
12074 (progn
12075 (goto-char (match-end 0))
12076 (or org-log-states-order-reversed
12077 (and (re-search-forward org-property-end-re nil t)
12078 (goto-char (1- (match-beginning 0))))))
12080 (beginning-of-line 0)
12081 (org-indent-line-function)
12082 (beginning-of-line 2)
12083 (org-indent-line-function)
12084 (end-of-line 0)))
12085 ((and org-log-state-notes-insert-after-drawers
12086 (save-excursion
12087 (forward-line) (looking-at org-drawer-regexp)))
12088 (forward-line)
12089 (while (looking-at org-drawer-regexp)
12090 (goto-char (match-end 0))
12091 (re-search-forward org-property-end-re (point-max) t)
12092 (forward-line))
12093 (forward-line -1)))
12094 (unless org-log-states-order-reversed
12096 (org-skip-over-state-notes)
12098 (move-marker org-log-note-marker (point))
12099 (setq org-log-note-purpose purpose
12100 org-log-note-state state
12101 org-log-note-previous-state prev-state
12102 org-log-note-how how
12103 org-log-note-extra extra
12104 org-log-note-effective-time (org-current-effective-time))
12105 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12107 (defun org-skip-over-state-notes ()
12108 "Skip past the list of State notes in an entry."
12110 (when (ignore-errors (goto-char (org-in-item-p)))
12111 (let* ((struct (org-list-struct))
12112 (prevs (org-list-prevs-alist struct)))
12114 (goto-char (or (org-list-get-next-item (point) struct prevs)
12115 (org-list-get-item-end (point) struct)))))))
12117 (defun org-add-log-note (&optional purpose)
12118 "Pop up a window for taking a note, and add this note later at point."
12119 (remove-hook 'post-command-hook 'org-add-log-note)
12120 (setq org-log-note-window-configuration (current-window-configuration))
12121 (delete-other-windows)
12122 (move-marker org-log-note-return-to (point))
12123 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12124 (goto-char org-log-note-marker)
12125 (org-switch-to-buffer-other-window "*Org Note*")
12126 (erase-buffer)
12127 (if (memq org-log-note-how '(time state))
12128 (let (current-prefix-arg) (org-store-log-note))
12129 (let ((org-inhibit-startup t)) (org-mode))
12130 (insert (format "# Insert note for %s.
12132 (cond
12133 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12134 ((eq org-log-note-purpose 'done) "closed todo item")
12135 ((eq org-log-note-purpose 'state)
12137 (or org-log-note-previous-state "")
12138 (or org-log-note-state "")))
12139 ((eq org-log-note-purpose 'reschedule)
12140 "rescheduling")
12141 ((eq org-log-note-purpose 'delschedule)
12142 "no longer scheduled")
12143 ((eq org-log-note-purpose 'redeadline)
12144 "changing deadline")
12145 ((eq org-log-note-purpose 'deldeadline)
12146 "removing deadline")
12147 ((eq org-log-note-purpose 'refile)
12148 "refiling")
12149 ((eq org-log-note-purpose 'note)
12150 "this entry")
12151 (t (error "This should not happen")))))
12152 (if org-log-note-extra (insert org-log-note-extra))
12153 (org-set-local 'org-finish-function 'org-store-log-note)
12154 (run-hooks 'org-log-buffer-setup-hook)))
12156 (defvar org-note-abort nil) ; dynamically scoped
12157 (defun org-store-log-note ()
12158 "Finish taking a log note, and insert it to where it belongs."
12159 (let ((txt (buffer-string))
12160 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12161 lines ind bul)
12162 (kill-buffer (current-buffer))
12164 (setq txt (replace-match "" t t txt)))
12166 (setq txt (replace-match "" t t txt)))
12169 (setq note
12170 (org-replace-escapes
12171 note
12172 (list (cons "%u" (user-login-name))
12173 (cons "%U" user-full-name)
12174 (cons "%t" (format-time-string
12175 (org-time-stamp-format 'long 'inactive)
12176 org-log-note-effective-time))
12177 (cons "%T" (format-time-string
12178 (org-time-stamp-format 'long nil)
12179 org-log-note-effective-time))
12180 (cons "%s" (if org-log-note-state
12182 ""))
12183 (cons "%S" (if org-log-note-previous-state
12187 (push note lines))
12188 (when (or current-prefix-arg org-note-abort)
12189 (when org-log-into-drawer
12190 (org-remove-empty-drawer-at
12191 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12192 org-log-note-marker))
12193 (setq lines nil))
12194 (when lines
12195 (with-current-buffer (marker-buffer org-log-note-marker)
12196 (save-excursion
12197 (goto-char org-log-note-marker)
12198 (move-marker org-log-note-marker nil)
12199 (end-of-line 1)
12201 (setq ind (save-excursion
12202 (if (ignore-errors (goto-char (org-in-item-p)))
12203 (let ((struct (org-list-struct)))
12204 (org-list-get-ind
12205 (org-list-get-top-point struct) struct))
12207 (cond
12208 ((and (org-at-heading-p)
12209 org-adapt-indentation)
12210 (1+ (org-current-level)))
12211 ((org-at-heading-p) 0)
12212 (t (org-get-indentation))))))
12213 (setq bul (org-list-bullet-string "-"))
12214 (org-indent-line-to ind)
12215 (insert bul (pop lines))
12216 (let ((ind-body (+ (length bul) ind)))
12217 (while lines
12219 (org-indent-line-to ind-body)
12220 (insert (pop lines))))
12221 (message "Note stored")
12222 (org-back-to-heading t)
12223 (org-cycle-hide-drawers 'children)))))
12224 (set-window-configuration org-log-note-window-configuration)
12225 (with-current-buffer (marker-buffer org-log-note-return-to)
12226 (goto-char org-log-note-return-to))
12227 (move-marker org-log-note-return-to nil)
12228 (and org-log-post-message (message "%s" org-log-post-message)))
12230 (defun org-remove-empty-drawer-at (drawer pos)
12231 "Remove an empty drawer DRAWER at position POS.
12232 POS may also be a marker."
12233 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12234 (save-excursion
12235 (save-restriction
12236 (widen)
12237 (goto-char pos)
12238 (if (org-in-regexp
12240 (replace-match ""))))))
12242 (defun org-sparse-tree (&optional arg)
12243 "Create a sparse tree, prompt for the details.
12244 This command can create sparse trees. You first need to select the type
12245 of match used to create the tree:
12247 t Show all TODO entries.
12248 T Show entries with a specific TODO keyword.
12249 m Show entries selected by a tags/property match.
12250 p Enter a property name and its value (both with completion on existing
12251 names/values) and show entries with that property.
12252 r Show entries matching a regular expression (`/' can be used as well)
12253 d Show deadlines due within `org-deadline-warning-days'.
12254 b Show deadlines and scheduled items before a date.
12255 a Show deadlines and scheduled items after a date."
12256 (interactive "P")
12257 (let (ans kwd value)
12258 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12259 (setq ans (read-char-exclusive))
12260 (cond
12261 ((equal ans ?d)
12262 (call-interactively 'org-check-deadlines))
12263 ((equal ans ?b)
12264 (call-interactively 'org-check-before-date))
12265 ((equal ans ?a)
12266 (call-interactively 'org-check-after-date))
12267 ((equal ans ?t)
12268 (org-show-todo-tree nil))
12269 ((equal ans ?T)
12270 (org-show-todo-tree '(4)))
12271 ((member ans '(?T ?m))
12272 (call-interactively 'org-match-sparse-tree))
12273 ((member ans '(?p ?P))
12274 (setq kwd (org-icompleting-read "Property: "
12275 (mapcar 'list (org-buffer-property-keys))))
12276 (setq value (org-icompleting-read "Value: "
12277 (mapcar 'list (org-property-values kwd))))
12280 (org-match-sparse-tree arg (concat kwd "=" value)))
12281 ((member ans '(?r ?R ?/))
12282 (call-interactively 'org-occur))
12285 (defvar org-occur-highlights nil
12286 "List of overlays used for occur matches.")
12287 (make-variable-buffer-local 'org-occur-highlights)
12288 (defvar org-occur-parameters nil
12289 "Parameters of the active org-occur calls.
12290 This is a list, each call to org-occur pushes as cons cell,
12291 containing the regular expression and the callback, onto the list.
12292 The list can contain several entries if `org-occur' has been called
12293 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12294 will only contain one set of parameters. When the highlights are
12295 removed (for example with `C-c C-c', or with the next edit (depending
12296 on `org-remove-highlights-with-change'), this variable is emptied
12297 as well.")
12298 (make-variable-buffer-local 'org-occur-parameters)
12300 (defun org-occur (regexp &optional keep-previous callback)
12301 "Make a compact tree which shows all matches of REGEXP.
12302 The tree will show the lines where the regexp matches, and all higher
12303 headlines above the match. It will also show the heading after the match,
12304 to make sure editing the matching entry is easy.
12305 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12306 call to `org-occur' will be kept, to allow stacking of calls to this
12307 command.
12308 If CALLBACK is non-nil, it is a function which is called to confirm
12309 that the match should indeed be shown."
12311 (when (equal regexp "")
12312 (error "Regexp cannot be empty"))
12313 (unless keep-previous
12314 (org-remove-occur-highlights nil nil t))
12315 (push (cons regexp callback) org-occur-parameters)
12316 (let ((cnt 0))
12317 (save-excursion
12318 (goto-char (point-min))
12319 (if (or (not keep-previous) ; do not want to keep
12320 (not org-occur-highlights)) ; no previous matches
12321 ;; hide everything
12322 (org-overview))
12323 (while (re-search-forward regexp nil t)
12324 (when (or (not callback)
12325 (save-match-data (funcall callback)))
12326 (setq cnt (1+ cnt))
12327 (when org-highlight-sparse-tree-matches
12328 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12329 (org-show-context 'occur-tree))))
12330 (when org-remove-highlights-with-change
12331 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12332 nil 'local))
12333 (unless org-sparse-tree-open-archived-trees
12334 (org-hide-archived-subtrees (point-min) (point-max)))
12335 (run-hooks 'org-occur-hook)
12336 (if (org-called-interactively-p 'interactive)
12337 (message "%d match(es) for regexp %s" cnt regexp))
12338 cnt))
12340 (defun org-occur-next-match (&optional n reset)
12341 "Function for `next-error-function' to find sparse tree matches.
12342 N is the number of matches to move, when negative move backwards.
12343 RESET is entirely ignored - this function always goes back to the
12344 starting point when no match is found."
12345 (let* ((limit (if (< n 0) (point-min) (point-max)))
12346 (search-func (if (< n 0)
12347 'previous-single-char-property-change
12348 'next-single-char-property-change))
12349 (n (abs n))
12350 (pos (point))
12351 p1)
12352 (catch 'exit
12353 (while (setq p1 (funcall search-func (point) 'org-type))
12354 (when (equal p1 limit)
12355 (goto-char pos)
12356 (error "No more matches"))
12357 (when (equal (get-char-property p1 'org-type) 'org-occur)
12358 (setq n (1- n))
12359 (when (= n 0)
12360 (goto-char p1)
12361 (throw 'exit (point))))
12362 (goto-char p1))
12363 (goto-char p1)
12364 (error "No more matches"))))
12366 (defun org-show-context (&optional key)
12367 "Make sure point and context are visible.
12368 How much context is shown depends upon the variables
12369 `org-show-hierarchy-above', `org-show-following-heading'. and
12370 `org-show-siblings'."
12371 (let ((heading-p (org-on-heading-p t))
12372 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12373 (following-p (org-get-alist-option org-show-following-heading key))
12374 (entry-p (org-get-alist-option org-show-entry-below key))
12375 (siblings-p (org-get-alist-option org-show-siblings key)))
12376 (catch 'exit
12377 ;; Show heading or entry text
12378 (if (and heading-p (not entry-p))
12379 (org-flag-heading nil) ; only show the heading
12380 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12381 (org-show-hidden-entry))) ; show entire entry
12382 (when following-p
12383 ;; Show next sibling, or heading below text
12384 (save-excursion
12385 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12386 (org-flag-heading nil))))
12387 (when siblings-p (org-show-siblings))
12388 (when hierarchy-p
12389 ;; show all higher headings, possibly with siblings
12390 (save-excursion
12391 (while (and (condition-case nil
12392 (progn (org-up-heading-all 1) t)
12393 (error nil))
12394 (not (bobp)))
12395 (org-flag-heading nil)
12396 (when siblings-p (org-show-siblings))))))))
12398 (defvar org-reveal-start-hook nil
12399 "Hook run before revealing a location.")
12401 (defun org-reveal (&optional siblings)
12402 "Show current entry, hierarchy above it, and the following headline.
12403 This can be used to show a consistent set of context around locations
12404 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12405 not t for the search context.
12407 With optional argument SIBLINGS, on each level of the hierarchy all
12408 siblings are shown. This repairs the tree structure to what it would
12409 look like when opened with hierarchical calls to `org-cycle'.
12411 go to the parent and show the
12412 entire tree."
12413 (interactive "P")
12414 (run-hooks 'org-reveal-start-hook)
12415 (let ((org-show-hierarchy-above t)
12416 (org-show-following-heading t)
12417 (org-show-siblings (if siblings t org-show-siblings)))
12418 (org-show-context nil))
12419 (when (equal siblings '(16))
12420 (save-excursion
12421 (when (org-up-heading-safe)
12422 (org-show-subtree)
12423 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12425 (defun org-highlight-new-match (beg end)
12426 "Highlight from BEG to END and mark the highlight is an occur headline."
12427 (let ((ov (make-overlay beg end)))
12428 (overlay-put ov 'face 'secondary-selection)
12429 (overlay-put ov 'org-type 'org-occur)
12430 (push ov org-occur-highlights)))
12432 (defun org-remove-occur-highlights (&optional beg end noremove)
12433 "Remove the occur highlights from the buffer.
12434 BEG and END are ignored. If NOREMOVE is nil, remove this function
12435 from the `before-change-functions' in the current buffer."
12436 (interactive)
12437 (unless org-inhibit-highlight-removal
12438 (mapc 'delete-overlay org-occur-highlights)
12439 (setq org-occur-highlights nil)
12440 (setq org-occur-parameters nil)
12441 (unless noremove
12442 (remove-hook 'before-change-functions
12443 'org-remove-occur-highlights 'local))))
12445 ;;;; Priorities
12448 "Regular expression matching the priority indicator.")
12450 (defvar org-remove-priority-next-time nil)
12452 (defun org-priority-up ()
12453 "Increase the priority of the current item."
12454 (interactive)
12455 (org-priority 'up))
12457 (defun org-priority-down ()
12458 "Decrease the priority of the current item."
12459 (interactive)
12460 (org-priority 'down))
12462 (defun org-priority (&optional action)
12463 "Change the priority of an item by ARG.
12464 ACTION can be `set', `up', `down', or a character."
12465 (interactive)
12466 (unless org-enable-priority-commands
12467 (error "Priority commands are disabled"))
12468 (setq action (or action 'set))
12469 (let (current new news have remove)
12470 (save-excursion
12471 (org-back-to-heading t)
12472 (if (looking-at org-priority-regexp)
12473 (setq current (string-to-char (match-string 2))
12474 have t))
12475 (cond
12476 ((eq action 'remove)
12477 (setq remove t new ?\ ))
12478 ((or (eq action 'set)
12479 (if (featurep 'xemacs) (characterp action) (integerp action)))
12480 (if (not (eq action 'set))
12481 (setq new action)
12482 (message "Priority %c-%c, SPC to remove: "
12483 org-highest-priority org-lowest-priority)
12484 (save-match-data
12485 (setq new (read-char-exclusive))))
12486 (if (and (= (upcase org-highest-priority) org-highest-priority)
12487 (= (upcase org-lowest-priority) org-lowest-priority))
12488 (setq new (upcase new)))
12489 (cond ((equal new ?\ ) (setq remove t))
12490 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12491 (error "Priority must be between `%c' and `%c'"
12492 org-highest-priority org-lowest-priority))))
12493 ((eq action 'up)
12494 (setq new (if have
12495 (1- current) ; normal cycling
12496 ;; last priority was empty
12497 (if (eq last-command this-command)
12498 org-lowest-priority ; wrap around empty to lowest
12499 ;; default
12500 (if org-priority-start-cycle-with-default
12501 org-default-priority
12502 (1- org-default-priority))))))
12503 ((eq action 'down)
12504 (setq new (if have
12505 (1+ current) ; normal cycling
12506 ;; last priority was empty
12507 (if (eq last-command this-command)
12508 org-highest-priority ; wrap around empty to highest
12509 ;; default
12510 (if org-priority-start-cycle-with-default
12511 org-default-priority
12512 (1+ org-default-priority))))))
12513 (t (error "Invalid action")))
12514 (if (or (< (upcase new) org-highest-priority)
12515 (> (upcase new) org-lowest-priority))
12516 (if (and (memq action '(up down))
12517 (not have) (not (eq last-command this-command)))
12518 ;; `new' is from default priority
12519 (error
12520 "The default can not be set, see `org-default-priority' why")
12521 ;; normal cycling: `new' is beyond highest/lowest priority
12522 ;; and is wrapped around to the empty priority
12523 (setq remove t)))
12524 (setq news (format "%c" new))
12525 (if have
12526 (if remove
12527 (replace-match "" t t nil 1)
12528 (replace-match news t t nil 2))
12529 (if remove
12530 (error "No priority cookie found in line")
12531 (let ((case-fold-search nil))
12532 (looking-at org-todo-line-regexp))
12533 (if (match-end 2)
12534 (progn
12535 (goto-char (match-end 2))
12536 (insert " [#" news "]"))
12537 (goto-char (match-beginning 3))
12538 (insert "[#" news "] "))))
12539 (org-preserve-lc (org-set-tags nil 'align)))
12540 (if remove
12541 (message "Priority removed")
12542 (message "Priority of current item set to %s" news))))
12544 (defun org-get-priority (s)
12545 "Find priority cookie and return priority."
12546 (if (functionp org-get-priority-function)
12547 (funcall org-get-priority-function)
12548 (save-match-data
12549 (if (not (string-match org-priority-regexp s))
12550 (* 1000 (- org-lowest-priority org-default-priority))
12551 (* 1000 (- org-lowest-priority
12552 (string-to-char (match-string 2 s))))))))
12554 ;;;; Tags
12556 (defvar org-agenda-archives-mode)
12557 (defvar org-map-continue-from nil
12558 "Position from where mapping should continue.
12559 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12561 (defvar org-scanner-tags nil
12562 "The current tag list while the tags scanner is running.")
12563 (defvar org-trust-scanner-tags nil
12564 "Should `org-get-tags-at' use the tags for the scanner.
12565 This is for internal dynamical scoping only.
12566 When this is non-nil, the function `org-get-tags-at' will return the value
12567 of `org-scanner-tags' instead of building the list by itself. This
12568 can lead to large speed-ups when the tags scanner is used in a file with
12569 many entries, and when the list of tags is retrieved, for example to
12570 obtain a list of properties. Building the tags list for each entry in such
12571 a file becomes an N^2 operation - but with this variable set, it scales
12572 as N.")
12574 (defun org-scan-tags (action matcher &optional todo-only)
12575 "Scan headline tags with inheritance and produce output ACTION.
12577 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12578 or `agenda' to produce an entry list for an agenda view. It can also be
12579 a Lisp form or a function that should be called at each matched headline, in
12580 this case the return value is a list of all return values from these calls.
12582 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12583 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12584 only lines with a TODO keyword are included in the output."
12585 (require 'org-agenda)
12588 (org-re
12590 (props (list 'face 'default
12591 'done-face 'org-agenda-done
12592 'undone-face 'default
12593 'mouse-face 'highlight
12594 'org-not-done-regexp org-not-done-regexp
12595 'org-todo-regexp org-todo-regexp
12596 'help-echo
12597 (format "mouse-2 or RET jump to org file %s"
12598 (abbreviate-file-name
12599 (or (buffer-file-name (buffer-base-buffer))
12600 (buffer-name (buffer-base-buffer)))))))
12601 (case-fold-search nil)
12602 (org-map-continue-from nil)
12603 lspos tags tags-list
12604 (tags-alist (list (cons 0 org-file-tags)))
12605 (llast 0) rtn rtn1 level category i txt
12606 todo marker entry priority)
12607 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12608 (setq action (list 'lambda nil action)))
12609 (save-excursion
12610 (goto-char (point-min))
12611 (when (eq action 'sparse-tree)
12612 (org-overview)
12613 (org-remove-occur-highlights))
12614 (while (re-search-forward re nil t)
12615 (catch :skip
12616 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12617 tags (if (match-end 4) (org-match-string-no-properties 4)))
12618 (goto-char (setq lspos (match-beginning 0)))
12619 (setq level (org-reduced-level (funcall outline-level))
12620 category (org-get-category))
12621 (setq i llast llast level)
12622 ;; remove tag lists from same and sublevels
12623 (while (>= i level)
12624 (when (setq entry (assoc i tags-alist))
12625 (setq tags-alist (delete entry tags-alist)))
12626 (setq i (1- i)))
12627 ;; add the next tags
12628 (when tags
12629 (setq tags (org-split-string tags ":")
12630 tags-alist
12631 (cons (cons level tags) tags-alist)))
12632 ;; compile tags for current headline
12633 (setq tags-list
12634 (if org-use-tag-inheritance
12635 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12636 tags)
12637 org-scanner-tags tags-list)
12638 (when org-use-tag-inheritance
12639 (setcdr (car tags-alist)
12640 (mapcar (lambda (x)
12641 (setq x (copy-sequence x))
12642 (org-add-prop-inherited x))
12643 (cdar tags-alist))))
12644 (when (and tags org-use-tag-inheritance
12645 (or (not (eq t org-use-tag-inheritance))
12646 org-tags-exclude-from-inheritance))
12647 ;; selective inheritance, remove uninherited ones
12648 (setcdr (car tags-alist)
12649 (org-remove-uninherited-tags (cdar tags-alist))))
12650 (when (and
12652 ;; eval matcher only when the todo condition is OK
12653 (and (or (not todo-only) (member todo org-not-done-keywords))
12654 (let ((case-fold-search t)) (eval matcher)))
12656 ;; Call the skipper, but return t if it does not skip,
12657 ;; so that the `and' form continues evaluating
12658 (progn
12659 (unless (eq action 'sparse-tree) (org-agenda-skip))
12660 t)
12662 ;; Check if timestamps are deselecting this entry
12663 (or (not todo-only)
12664 (and (member todo org-not-done-keywords)
12665 (or (not org-agenda-tags-todo-honor-ignore-options)
12666 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12668 ;; Extra check for the archive tag
12669 ;; FIXME: Does the skipper already do this????
12670 (or
12671 (not (member org-archive-tag tags-list))
12672 ;; we have an archive tag, should we use this anyway?
12673 (or (not org-agenda-skip-archived-trees)
12674 (and (eq action 'agenda) org-agenda-archives-mode))))
12676 ;; select this headline
12678 (cond
12679 ((eq action 'sparse-tree)
12680 (and org-highlight-sparse-tree-matches
12681 (org-get-heading) (match-end 0)
12682 (org-highlight-new-match
12683 (match-beginning 0) (match-beginning 1)))
12684 (org-show-context 'tags-tree))
12685 ((eq action 'agenda)
12686 (setq txt (org-format-agenda-item
12687 ""
12688 (concat
12689 (if (eq org-tags-match-list-sublevels 'indented)
12690 (make-string (1- level) ?.) "")
12691 (org-get-heading))
12692 category
12693 tags-list
12694 )
12695 priority (org-get-priority txt))
12696 (goto-char lspos)
12697 (setq marker (org-agenda-new-marker))
12698 (org-add-props txt props
12699 'org-marker marker 'org-hd-marker marker 'org-category category
12700 'todo-state todo
12701 'priority priority 'type "tagsmatch")
12702 (push txt rtn))
12703 ((functionp action)
12704 (setq org-map-continue-from nil)
12705 (save-excursion
12706 (setq rtn1 (funcall action))
12707 (push rtn1 rtn)))
12708 (t (error "Invalid action")))
12710 ;; if we are to skip sublevels, jump to end of subtree
12711 (unless org-tags-match-list-sublevels
12712 (org-end-of-subtree t)
12713 (backward-char 1))))
12714 ;; Get the correct position from where to continue
12715 (if org-map-continue-from
12716 (goto-char org-map-continue-from)
12717 (and (= (point) lspos) (end-of-line 1)))))
12718 (when (and (eq action 'sparse-tree)
12719 (not org-sparse-tree-open-archived-trees))
12720 (org-hide-archived-subtrees (point-min) (point-max)))
12721 (nreverse rtn)))
12723 (defun org-remove-uninherited-tags (tags)
12724 "Remove all tags that are not inherited from the list TAGS."
12725 (cond
12726 ((eq org-use-tag-inheritance t)
12727 (if org-tags-exclude-from-inheritance
12728 (org-delete-all org-tags-exclude-from-inheritance tags)
12729 tags))
12730 ((not org-use-tag-inheritance) nil)
12731 ((stringp org-use-tag-inheritance)
12732 (delq nil (mapcar
12733 (lambda (x)
12734 (if (and (string-match org-use-tag-inheritance x)
12735 (not (member x org-tags-exclude-from-inheritance)))
12736 x nil))
12737 tags)))
12738 ((listp org-use-tag-inheritance)
12739 (delq nil (mapcar
12740 (lambda (x)
12741 (if (member x org-use-tag-inheritance) x nil))
12742 tags)))))
12744 (defvar todo-only) ;; dynamically scoped
12746 (defun org-match-sparse-tree (&optional todo-only match)
12747 "Create a sparse tree according to tags string MATCH.
12748 MATCH can contain positive and negative selection of tags, like
12750 If optional argument TODO-ONLY is non-nil, only select lines that are
12751 also TODO lines."
12752 (interactive "P")
12753 (org-prepare-agenda-buffers (list (current-buffer)))
12754 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12756 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12758 (defvar org-cached-props nil)
12759 (defun org-cached-entry-get (pom property)
12760 (if (or (eq t org-use-property-inheritance)
12761 (and (stringp org-use-property-inheritance)
12762 (string-match org-use-property-inheritance property))
12763 (and (listp org-use-property-inheritance)
12764 (member property org-use-property-inheritance)))
12765 ;; Caching is not possible, check it directly
12766 (org-entry-get pom property 'inherit)
12767 ;; Get all properties, so that we can do complicated checks easily
12768 (cdr (assoc property (or org-cached-props
12769 (setq org-cached-props
12770 (org-entry-properties pom)))))))
12772 (defun org-global-tags-completion-table (&optional files)
12773 "Return the list of all tags in all agenda buffer/files.
12774 Optional FILES argument is a list of files to which can be used
12775 instead of the agenda files."
12776 (save-excursion
12777 (org-uniquify
12778 (delq nil
12779 (apply 'append
12780 (mapcar
12781 (lambda (file)
12782 (set-buffer (find-file-noselect file))
12783 (append (org-get-buffer-tags)
12784 (mapcar (lambda (x) (if (stringp (car-safe x))
12785 (list (car-safe x)) nil))
12786 org-tag-alist)))
12787 (if (and files (car files))
12788 files
12789 (org-agenda-files))))))))
12791 (defun org-make-tags-matcher (match)
12792 "Create the TAGS/TODO matcher form for the selection string MATCH."
12793 ;; todo-only is scoped dynamically into this function, and the function
12794 ;; may change it if the matcher asks for it.
12795 (unless match
12796 ;; Get a new match request, with completion
12797 (let ((org-last-tags-completion-table
12798 (org-global-tags-completion-table)))
12799 (setq match (org-completing-read-no-i
12800 "Match: " 'org-tags-completion-function nil nil nil
12801 'org-tags-history))))
12803 ;; Parse the string and create a lisp form
12804 (let ((match0 match)
12805 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12806 minus tag mm
12807 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12808 orterms term orlist re-p str-p level-p level-op time-p
12809 prop-p pn pv po gv rest)
12810 (if (string-match "/+" match)
12811 ;; match contains also a todo-matching request
12812 (progn
12813 (setq tagsmatch (substring match 0 (match-beginning 0))
12814 todomatch (substring match (match-end 0)))
12815 (if (string-match "^!" todomatch)
12816 (setq todo-only t todomatch (substring todomatch 1)))
12818 (setq todomatch nil)))
12819 ;; only matching tags
12820 (setq tagsmatch match todomatch nil))
12822 ;; Make the tags matcher
12824 (setq tagsmatcher t)
12825 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12826 (while (setq term (pop orterms))
12828 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12829 (while (string-match re term)
12830 (setq rest (substring term (match-end 0))
12831 minus (and (match-end 1)
12832 (equal (match-string 1 term) "-"))
12833 tag (save-match-data (replace-regexp-in-string
12835 (match-string 2 term)))
12836 re-p (equal (string-to-char tag) ?{)
12837 level-p (match-end 4)
12838 prop-p (match-end 5)
12839 mm (cond
12840 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12841 (level-p
12842 (setq level-op (org-op-to-function (match-string 3 term)))
12843 `(,level-op level ,(string-to-number
12844 (match-string 4 term))))
12845 (prop-p
12846 (setq pn (match-string 5 term)
12847 po (match-string 6 term)
12848 pv (match-string 7 term)
12849 re-p (equal (string-to-char pv) ?{)
12851 time-p (save-match-data
12853 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12854 (if time-p (setq pv (org-matcher-time pv)))
12855 (setq po (org-op-to-function po (if time-p 'time str-p)))
12856 (cond
12857 ((equal pn "CATEGORY")
12858 (setq gv '(get-text-property (point) 'org-category)))
12859 ((equal pn "TODO")
12860 (setq gv 'todo))
12861 (t
12862 (setq gv `(org-cached-entry-get nil ,pn))))
12863 (if re-p
12864 (if (eq po 'org<>)
12865 `(not (string-match ,pv (or ,gv "")))
12866 `(string-match ,pv (or ,gv "")))
12867 (if str-p
12868 `(,po (or ,gv "") ,pv)
12869 `(,po (string-to-number (or ,gv ""))
12870 ,(string-to-number pv) ))))
12871 (t `(member ,tag tags-list)))
12872 mm (if minus (list 'not mm) mm)
12873 term rest)
12874 (push mm tagsmatcher))
12875 (push (if (> (length tagsmatcher) 1)
12876 (cons 'and tagsmatcher)
12877 (car tagsmatcher))
12878 orlist)
12879 (setq tagsmatcher nil))
12880 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12881 (setq tagsmatcher
12882 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12883 ;; Make the todo matcher
12885 (setq todomatcher t)
12886 (setq orterms (org-split-string todomatch "|") orlist nil)
12887 (while (setq term (pop orterms))
12888 (while (string-match re term)
12889 (setq minus (and (match-end 1)
12890 (equal (match-string 1 term) "-"))
12891 kwd (match-string 2 term)
12892 re-p (equal (string-to-char kwd) ?{)
12893 term (substring term (match-end 0))
12894 mm (if re-p
12895 `(string-match ,(substring kwd 1 -1) todo)
12896 (list 'equal 'todo kwd))
12897 mm (if minus (list 'not mm) mm))
12898 (push mm todomatcher))
12899 (push (if (> (length todomatcher) 1)
12900 (cons 'and todomatcher)
12901 (car todomatcher))
12902 orlist)
12903 (setq todomatcher nil))
12904 (setq todomatcher (if (> (length orlist) 1)
12905 (cons 'or orlist) (car orlist))))
12907 ;; Return the string and lisp forms of the matcher
12908 (setq matcher (if todomatcher
12909 (list 'and tagsmatcher todomatcher)
12910 tagsmatcher))
12911 (cons match0 matcher)))
12913 (defun org-op-to-function (op &optional stringp)
12914 "Turn an operator into the appropriate function."
12915 (setq op
12916 (cond
12917 ((equal op "<" ) '(< string< org-time<))
12918 ((equal op ">" ) '(> org-string> org-time>))
12919 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12920 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12921 ((member op '("=" "==")) '(= string= org-time=))
12922 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12923 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12925 (defun org<> (a b) (not (= a b)))
12926 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12927 (defun org-string>= (a b) (not (string< a b)))
12928 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12929 (defun org-string<> (a b) (not (string= a b)))
12930 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12931 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12932 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12933 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12934 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12935 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12936 (defun org-2ft (s)
12937 "Convert S to a floating point time.
12938 If S is already a number, just return it. If it is a string, parse
12939 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12940 (cond
12941 ((numberp s) s)
12942 ((stringp s)
12943 (condition-case nil
12944 (float-time (apply 'encode-time (org-parse-time-string s)))
12945 (error 0.)))
12946 (t 0.)))
12948 (defun org-time-today ()
12949 "Time in seconds today at 0:00.
12950 Returns the float number of seconds since the beginning of the
12951 epoch to the beginning of today (00:00)."
12952 (float-time (apply 'encode-time
12953 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12955 (defun org-matcher-time (s)
12956 "Interpret a time comparison value."
12957 (save-match-data
12958 (cond
12959 ((string= s "<now>") (float-time))
12960 ((string= s "<today>") (org-time-today))
12961 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12962 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12964 (+ (org-time-today)
12965 (* (string-to-number (match-string 1 s))
12966 (cdr (assoc (match-string 2 s)
12967 '(("d" . 86400.0) ("w" . 604800.0)
12968 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12969 (t (org-2ft s)))))
12971 (defun org-match-any-p (re list)
12972 "Does re match any element of list?"
12973 (setq list (mapcar (lambda (x) (string-match re x)) list))
12974 (delq nil list))
12976 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12977 (defvar org-tags-overlay (make-overlay 1 1))
12978 (org-detach-overlay org-tags-overlay)
12980 (defun org-get-local-tags-at (&optional pos)
12981 "Get a list of tags defined in the current headline."
12982 (org-get-tags-at pos 'local))
12984 (defun org-get-local-tags ()
12985 "Get a list of tags defined in the current headline."
12986 (org-get-tags-at nil 'local))
12988 (defun org-get-tags-at (&optional pos local)
12989 "Get a list of all headline tags applicable at POS.
12990 POS defaults to point. If tags are inherited, the list contains
12991 the targets in the same sequence as the headlines appear, i.e.
12992 the tags of the current headline come last.
12993 When LOCAL is non-nil, only return tags from the current headline,
12994 ignore inherited ones."
12995 (interactive)
12996 (if (and org-trust-scanner-tags
12997 (or (not pos) (equal pos (point)))
12998 (not local))
12999 org-scanner-tags
13000 (let (tags ltags lastpos parent)
13001 (save-excursion
13002 (save-restriction
13003 (widen)
13004 (goto-char (or pos (point)))
13005 (save-match-data
13006 (catch 'done
13007 (condition-case nil
13008 (progn
13009 (org-back-to-heading t)
13010 (while (not (equal lastpos (point)))
13011 (setq lastpos (point))
13012 (when (looking-at
13014 (setq ltags (org-split-string
13015 (org-match-string-no-properties 1) ":"))
13016 (when parent
13017 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13018 (setq tags (append
13019 (if parent
13020 (org-remove-uninherited-tags ltags)
13021 ltags)
13022 tags)))
13023 (or org-use-tag-inheritance (throw 'done t))
13024 (if local (throw 'done t))
13025 (or (org-up-heading-safe) (error nil))
13026 (setq parent t)))
13027 (error nil)))))
13028 (if local
13029 tags
13030 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13032 (defun org-add-prop-inherited (s)
13033 (add-text-properties 0 (length s) '(inherited t) s)
13034 s)
13036 (defun org-toggle-tag (tag &optional onoff)
13037 "Toggle the tag TAG for the current line.
13038 If ONOFF is `on' or `off', don't toggle but set to this state."
13039 (let (res current)
13040 (save-excursion
13041 (org-back-to-heading t)
13043 (point-at-eol) t)
13044 (progn
13045 (setq current (match-string 1))
13046 (replace-match ""))
13047 (setq current ""))
13048 (setq current (nreverse (org-split-string current ":")))
13049 (cond
13050 ((eq onoff 'on)
13051 (setq res t)
13052 (or (member tag current) (push tag current)))
13053 ((eq onoff 'off)
13054 (or (not (member tag current)) (setq current (delete tag current))))
13055 (t (if (member tag current)
13056 (setq current (delete tag current))
13057 (setq res t)
13058 (push tag current))))
13059 (end-of-line 1)
13060 (if current
13061 (progn
13062 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13063 (org-set-tags nil t))
13064 (delete-horizontal-space))
13065 (run-hooks 'org-after-tags-change-hook))
13066 res))
13068 (defun org-align-tags-here (to-col)
13069 ;; Assumes that this is a headline
13070 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13071 (beginning-of-line 1)
13073 (< pos (match-beginning 2)))
13074 (progn
13075 (setq tags-l (- (match-end 2) (match-beginning 2)))
13076 (goto-char (match-beginning 1))
13077 (insert " ")
13078 (delete-region (point) (1+ (match-beginning 2)))
13079 (setq ncol (max (1+ (current-column))
13080 (1+ col)
13081 (if (> to-col 0)
13082 to-col
13083 (- (abs to-col) tags-l))))
13084 (setq p (point))
13085 (insert (make-string (- ncol (current-column)) ?\ ))
13086 (setq ncol (current-column))
13087 (when indent-tabs-mode (tabify p (point-at-eol)))
13088 (org-move-to-column (min ncol col) t))
13089 (goto-char pos))))
13091 (defun org-set-tags-command (&optional arg just-align)
13092 "Call the set-tags command for the current entry."
13093 (interactive "P")
13094 (if (org-on-heading-p)
13095 (org-set-tags arg just-align)
13096 (save-excursion
13097 (org-back-to-heading t)
13098 (org-set-tags arg just-align))))
13100 (defun org-set-tags-to (data)
13101 "Set the tags of the current entry to DATA, replacing the current tags.
13102 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13103 If DATA is nil or the empty string, any tags will be removed."
13104 (interactive "sTags: ")
13105 (setq data
13106 (cond
13107 ((eq data nil) "")
13108 ((equal data "") "")
13109 ((stringp data)
13110 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13111 ":"))
13112 ((listp data)
13113 (concat ":" (mapconcat 'identity data ":") ":"))
13114 (t nil)))
13115 (when data
13116 (save-excursion
13117 (org-back-to-heading t)
13118 (when (looking-at org-complex-heading-regexp)
13119 (if (match-end 5)
13120 (progn
13121 (goto-char (match-beginning 5))
13122 (insert data)
13123 (delete-region (point) (point-at-eol))
13124 (org-set-tags nil 'align))
13125 (goto-char (point-at-eol))
13126 (insert " " data)
13127 (org-set-tags nil 'align)))
13128 (beginning-of-line 1)
13130 (delete-region (match-beginning 1) (match-end 1))))))
13132 (defun org-align-all-tags ()
13133 "Align the tags i all headings."
13134 (interactive)
13135 (save-excursion
13136 (or (ignore-errors (org-back-to-heading t))
13137 (outline-next-heading))
13138 (if (org-on-heading-p)
13139 (org-set-tags t)
13140 (message "No headings"))))
13142 (defvar org-indent-indentation-per-level)
13143 (defun org-set-tags (&optional arg just-align)
13144 "Set the tags for the current headline.
13145 With prefix ARG, realign all tags in headings in the current buffer."
13146 (interactive "P")
13147 (let* ((re org-outline-regexp-bol)
13148 (current (org-get-tags-string))
13149 (col (current-column))
13150 (org-setting-tags t)
13151 table current-tags inherited-tags ; computed below when needed
13152 tags p0 c0 c1 rpl di tc level)
13153 (if arg
13154 (save-excursion
13155 (goto-char (point-min))
13156 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13157 (while (re-search-forward re nil t)
13158 (org-set-tags nil t)
13159 (end-of-line 1)))
13160 (message "All tags realigned to column %d" org-tags-column))
13161 (if just-align
13162 (setq tags current)
13163 ;; Get a new set of tags from the user
13164 (save-excursion
13165 (setq table (append org-tag-persistent-alist
13166 (or org-tag-alist (org-get-buffer-tags))
13167 (and
13168 org-complete-tags-always-offer-all-agenda-tags
13169 (org-global-tags-completion-table
13170 (org-agenda-files))))
13171 org-last-tags-completion-table table
13172 current-tags (org-split-string current ":")
13173 inherited-tags (nreverse
13174 (nthcdr (length current-tags)
13175 (nreverse (org-get-tags-at))))
13176 tags
13177 (if (or (eq t org-use-fast-tag-selection)
13178 (and org-use-fast-tag-selection
13179 (delq nil (mapcar 'cdr table))))
13180 (org-fast-tag-selection
13181 current-tags inherited-tags table
13182 (if org-fast-tag-selection-include-todo
13183 org-todo-key-alist))
13184 (let ((org-add-colon-after-tag-completion t))
13185 (org-trim
13186 (org-icompleting-read "Tags: "
13187 'org-tags-completion-function
13188 nil nil current 'org-tags-history))))))
13189 (while (string-match "[-+&]+" tags)
13190 ;; No boolean logic, just a list
13191 (setq tags (replace-match ":" t t tags))))
13193 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13195 (if org-tags-sort-function
13196 (setq tags (mapconcat 'identity
13197 (sort (org-split-string
13198 tags (org-re "[^[:alnum:]_@#%]+"))
13199 org-tags-sort-function) ":")))
13202 (setq tags "")
13203 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13204 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13206 ;; Insert new tags at the correct column
13207 (beginning-of-line 1)
13208 (setq level (or (and (looking-at org-outline-regexp)
13209 (- (match-end 0) (point) 1))
13210 1))
13211 (cond
13212 ((and (equal current "") (equal tags "")))
13213 ((re-search-forward
13215 (point-at-eol) t)
13216 (if (equal tags "")
13217 (setq rpl "")
13218 (goto-char (match-beginning 0))
13219 (setq c0 (current-column)
13220 ;; compute offset for the case of org-indent-mode active
13221 di (if org-indent-mode
13222 (* (1- org-indent-indentation-per-level) (1- level))
13223 0)
13224 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13225 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13226 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13227 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13228 (replace-match rpl t t)
13229 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13230 tags)
13231 (t (error "Tags alignment failed")))
13232 (org-move-to-column col)
13233 (unless just-align
13234 (run-hooks 'org-after-tags-change-hook)))))
13236 (defun org-change-tag-in-region (beg end tag off)
13237 "Add or remove TAG for each entry in the region.
13238 This works in the agenda, and also in an org-mode buffer."
13239 (interactive
13240 (list (region-beginning) (region-end)
13241 (let ((org-last-tags-completion-table
13242 (if (org-mode-p)
13243 (org-get-buffer-tags)
13244 (org-global-tags-completion-table))))
13245 (org-icompleting-read
13246 "Tag: " 'org-tags-completion-function nil nil nil
13247 'org-tags-history))
13248 (progn
13250 (equal (read-char-exclusive) ?r))))
13251 (if (fboundp 'deactivate-mark) (deactivate-mark))
13252 (let ((agendap (equal major-mode 'org-agenda-mode))
13253 l1 l2 m buf pos newhead (cnt 0))
13254 (goto-char end)
13255 (setq l2 (1- (org-current-line)))
13256 (goto-char beg)
13257 (setq l1 (org-current-line))
13258 (loop for l from l1 to l2 do
13259 (org-goto-line l)
13260 (setq m (get-text-property (point) 'org-hd-marker))
13261 (when (or (and (org-mode-p) (org-on-heading-p))
13262 (and agendap m))
13263 (setq buf (if agendap (marker-buffer m) (current-buffer))
13264 pos (if agendap m (point)))
13265 (with-current-buffer buf
13266 (save-excursion
13267 (save-restriction
13268 (goto-char pos)
13269 (setq cnt (1+ cnt))
13270 (org-toggle-tag tag (if off 'off 'on))
13271 (setq newhead (org-get-heading)))))
13272 (and agendap (org-agenda-change-all-lines newhead m))))
13273 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13275 (defun org-tags-completion-function (string predicate &optional flag)
13276 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13277 (confirm (lambda (x) (stringp (car x)))))
13279 (setq s1 (match-string 1 string)
13280 s2 (match-string 2 string))
13281 (setq s1 "" s2 string))
13282 (cond
13283 ((eq flag nil)
13284 ;; try completion
13285 (setq rtn (try-completion s2 ctable confirm))
13286 (if (stringp rtn)
13287 (setq rtn
13288 (concat s1 s2 (substring rtn (length s2))
13289 (if (and org-add-colon-after-tag-completion
13290 (assoc rtn ctable))
13291 ":" ""))))
13292 rtn)
13293 ((eq flag t)
13294 ;; all-completions
13295 (all-completions s2 ctable confirm)
13296 )
13297 ((eq flag 'lambda)
13298 ;; exact match?
13299 (assoc s2 ctable)))
13300 ))
13302 (defun org-fast-tag-insert (kwd tags face &optional end)
13303 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13304 (insert (format "%-12s" (concat kwd ":"))
13305 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13306 (or end "")))
13308 (defun org-fast-tag-show-exit (flag)
13309 (save-excursion
13310 (org-goto-line 3)
13312 (replace-match ""))
13313 (when flag
13314 (end-of-line 1)
13315 (org-move-to-column (- (window-width) 19) t)
13316 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13318 (defun org-set-current-tags-overlay (current prefix)
13319 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13320 (if (featurep 'xemacs)
13321 (org-overlay-display org-tags-overlay (concat prefix s)
13322 'secondary-selection)
13323 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13324 (org-overlay-display org-tags-overlay (concat prefix s)))))
13326 (defvar org-last-tag-selection-key nil)
13327 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13328 "Fast tag selection with single keys.
13329 CURRENT is the current list of tags in the headline, INHERITED is the
13330 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13331 possibly with grouping information. TODO-TABLE is a similar table with
13332 TODO keywords, should these have keys assigned to them.
13333 If the keys are nil, a-z are automatically assigned.
13334 Returns the new tags string, or nil to not change the current settings."
13335 (let* ((fulltable (append table todo-table))
13336 (maxlen (apply 'max (mapcar
13337 (lambda (x)
13338 (if (stringp (car x)) (string-width (car x)) 0))
13339 fulltable)))
13340 (buf (current-buffer))
13341 (expert (eq org-fast-tag-selection-single-key 'expert))
13342 (buffer-tags nil)
13343 (fwidth (+ maxlen 3 1 3))
13344 (ncol (/ (- (window-width) 4) fwidth))
13345 (i-face 'org-done)
13346 (c-face 'org-todo)
13347 tg cnt e c char c1 c2 ntable tbl rtn
13348 ov-start ov-end ov-prefix
13349 (exit-after-next org-fast-tag-selection-single-key)
13350 (done-keywords org-done-keywords)
13351 groups ingroup)
13352 (save-excursion
13353 (beginning-of-line 1)
13354 (if (looking-at
13356 (setq ov-start (match-beginning 1)
13357 ov-end (match-end 1)
13358 ov-prefix "")
13359 (setq ov-start (1- (point-at-eol))
13360 ov-end (1+ ov-start))
13362 (setq ov-prefix
13363 (concat
13364 (buffer-substring (1- (point)) (point))
13365 (if (> (current-column) org-tags-column)
13366 " "
13367 (make-string (- org-tags-column (current-column)) ?\ ))))))
13368 (move-overlay org-tags-overlay ov-start ov-end)
13369 (save-window-excursion
13370 (if expert
13371 (set-buffer (get-buffer-create " *Org tags*"))
13372 (delete-other-windows)
13373 (split-window-vertically)
13374 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13375 (erase-buffer)
13376 (org-set-local 'org-done-keywords done-keywords)
13379 (org-fast-tag-show-exit exit-after-next)
13380 (org-set-current-tags-overlay current ov-prefix)
13381 (setq tbl fulltable char ?a cnt 0)
13382 (while (setq e (pop tbl))
13383 (cond
13384 ((equal (car e) :startgroup)
13385 (push '() groups) (setq ingroup t)
13386 (when (not (= cnt 0))
13387 (setq cnt 0)
13389 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13390 ((equal (car e) :endgroup)
13391 (setq ingroup nil cnt 0)
13393 ((equal e '(:newline))
13394 (when (not (= cnt 0))
13395 (setq cnt 0)
13397 (setq e (car tbl))
13398 (while (equal (car tbl) '(:newline))
13400 (setq tbl (cdr tbl)))))
13401 (t
13402 (setq tg (copy-sequence (car e)) c2 nil)
13403 (if (cdr e)
13404 (setq c (cdr e))
13405 ;; automatically assign a character.
13406 (setq c1 (string-to-char
13407 (downcase (substring
13408 tg (if (= (string-to-char tg) ?@) 1 0)))))
13409 (if (or (rassoc c1 ntable) (rassoc c1 table))
13410 (while (or (rassoc char ntable) (rassoc char table))
13411 (setq char (1+ char)))
13412 (setq c2 c1))
13413 (setq c (or c2 char)))
13414 (if ingroup (push tg (car groups)))
13415 (setq tg (org-add-props tg nil 'face
13416 (cond
13417 ((not (assoc tg table))
13418 (org-get-todo-face tg))
13419 ((member tg current) c-face)
13420 ((member tg inherited) i-face)
13421 (t nil))))
13422 (if (and (= cnt 0) (not ingroup)) (insert " "))
13423 (insert "[" c "] " tg (make-string
13424 (- fwidth 4 (length tg)) ?\ ))
13425 (push (cons tg c) ntable)
13426 (when (= (setq cnt (1+ cnt)) ncol)
13428 (if ingroup (insert " "))
13429 (setq cnt 0)))))
13430 (setq ntable (nreverse ntable))
13432 (goto-char (point-min))
13433 (if (not expert) (org-fit-window-to-buffer))
13434 (setq rtn
13435 (catch 'exit
13436 (while t
13437 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13438 (if (not groups) "no " "")
13439 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13440 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13441 (setq org-last-tag-selection-key c)
13442 (cond
13444 ((= c ?!)
13445 (setq groups (not groups))
13446 (goto-char (point-min))
13447 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13448 ((= c ?\C-c)
13449 (if (not expert)
13450 (org-fast-tag-show-exit
13451 (setq exit-after-next (not exit-after-next)))
13452 (setq expert nil)
13453 (delete-other-windows)
13454 (set-window-buffer (split-window-vertically) " *Org tags*")
13455 (org-switch-to-buffer-other-window " *Org tags*")
13456 (org-fit-window-to-buffer)))
13457 ((or (= c ?\C-g)
13458 (and (= c ?q) (not (rassoc c ntable))))
13459 (org-detach-overlay org-tags-overlay)
13460 (setq quit-flag t))
13461 ((= c ?\ )
13462 (setq current nil)
13463 (if exit-after-next (setq exit-after-next 'now)))
13465 (condition-case nil
13466 (setq tg (org-icompleting-read
13467 "Tag: "
13468 (or buffer-tags
13469 (with-current-buffer buf
13470 (org-get-buffer-tags)))))
13471 (quit (setq tg "")))
13473 (add-to-list 'buffer-tags (list tg))
13474 (if (member tg current)
13475 (setq current (delete tg current))
13476 (push tg current)))
13477 (if exit-after-next (setq exit-after-next 'now)))
13478 ((setq e (rassoc c todo-table) tg (car e))
13479 (with-current-buffer buf
13480 (save-excursion (org-todo tg)))
13481 (if exit-after-next (setq exit-after-next 'now)))
13482 ((setq e (rassoc c ntable) tg (car e))
13483 (if (member tg current)
13484 (setq current (delete tg current))
13485 (loop for g in groups do
13486 (if (member tg g)
13487 (mapc (lambda (x)
13488 (setq current (delete x current)))
13489 g)))
13490 (push tg current))
13491 (if exit-after-next (setq exit-after-next 'now))))
13493 ;; Create a sorted list
13494 (setq current
13495 (sort current
13496 (lambda (a b)
13497 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13498 (if (eq exit-after-next 'now) (throw 'exit t))
13499 (goto-char (point-min))
13500 (beginning-of-line 2)
13501 (delete-region (point) (point-at-eol))
13502 (org-fast-tag-insert "Current" current c-face)
13503 (org-set-current-tags-overlay current ov-prefix)
13504 (while (re-search-forward
13506 (setq tg (match-string 1))
13507 (add-text-properties
13508 (match-beginning 1) (match-end 1)
13509 (list 'face
13510 (cond
13511 ((member tg current) c-face)
13512 ((member tg inherited) i-face)
13513 (t (get-text-property (match-beginning 1) 'face))))))
13514 (goto-char (point-min)))))
13515 (org-detach-overlay org-tags-overlay)
13516 (if rtn
13517 (mapconcat 'identity current ":")
13518 nil))))
13520 (defun org-get-tags-string ()
13521 "Get the TAGS string in the current headline."
13522 (unless (org-on-heading-p t)
13523 (error "Not on a heading"))
13524 (save-excursion
13525 (beginning-of-line 1)
13527 (org-match-string-no-properties 1)
13528 "")))
13530 (defun org-get-tags ()
13531 "Get the list of tags specified in the current headline."
13532 (org-split-string (org-get-tags-string) ":"))
13534 (defun org-get-buffer-tags ()
13535 "Get a table of all tags used in the buffer, for completion."
13536 (let (tags)
13537 (save-excursion
13538 (goto-char (point-min))
13539 (while (re-search-forward
13541 (when (equal (char-after (point-at-bol 0)) ?*)
13542 (mapc (lambda (x) (add-to-list 'tags x))
13543 (org-split-string (org-match-string-no-properties 1) ":")))))
13544 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13545 (mapcar 'list tags)))
13547 ;;;; The mapping API
13549 ;;;###autoload
13550 (defun org-map-entries (func &optional match scope &rest skip)
13551 "Call FUNC at each headline selected by MATCH in SCOPE.
13553 FUNC is a function or a lisp form. The function will be called without
13554 arguments, with the cursor positioned at the beginning of the headline.
13555 The return values of all calls to the function will be collected and
13556 returned as a list.
13558 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13559 does not need to preserve point. After evaluation, the cursor will be
13560 moved to the end of the line (presumably of the headline of the
13561 processed entry) and search continues from there. Under some
13562 circumstances, this may not produce the wanted results. For example,
13563 if you have removed (e.g. archived) the current (sub)tree it could
13564 mean that the next entry will be skipped entirely. In such cases, you
13565 can specify the position from where search should continue by making
13566 FUNC set the variable `org-map-continue-from' to the desired buffer
13567 position.
13569 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13570 Only headlines that are matched by this query will be considered during
13571 the iteration. When MATCH is nil or t, all headlines will be
13572 visited by the iteration.
13574 SCOPE determines the scope of this command. It can be any of:
13576 nil The current buffer, respecting the restriction if any
13577 tree The subtree started with the entry at point
13578 region The entries within the active region, if any
13579 file The current buffer, without restriction
13580 file-with-archives
13581 The current buffer, and any archives associated with it
13582 agenda All agenda files
13583 agenda-with-archives
13584 All agenda files with any archive files associated with them
13585 \(file1 file2 ...)
13586 If this is a list, all files in the list will be scanned
13588 The remaining args are treated as settings for the skipping facilities of
13589 the scanner. The following items can be given here:
13591 archive skip trees with the archive tag.
13592 comment skip trees with the COMMENT keyword
13593 function or Emacs Lisp form:
13594 will be used as value for `org-agenda-skip-function', so whenever
13595 the function returns t, FUNC will not be called for that
13596 entry and search will continue from the point where the
13597 function leaves it.
13599 If your function needs to retrieve the tags including inherited tags
13600 at the *current* entry, you can use the value of the variable
13601 `org-scanner-tags' which will be much faster than getting the value
13602 with `org-get-tags-at'. If your function gets properties with
13603 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13604 to t around the call to `org-entry-properties' to get the same speedup.
13605 Note that if your function moves around to retrieve tags and properties at
13606 a *different* entry, you cannot use these techniques."
13607 (let* ((org-agenda-archives-mode nil) ; just to make sure
13608 (org-agenda-skip-archived-trees (memq 'archive skip))
13609 (org-agenda-skip-comment-trees (memq 'comment skip))
13610 (org-agenda-skip-function
13611 (car (org-delete-all '(comment archive) skip)))
13612 (org-tags-match-list-sublevels t)
13613 matcher file res
13614 org-todo-keywords-for-agenda
13615 org-done-keywords-for-agenda
13616 org-todo-keyword-alist-for-agenda
13617 org-drawers-for-agenda
13618 org-tag-alist-for-agenda)
13620 (cond
13621 ((eq match t) (setq matcher t))
13622 ((eq match nil) (setq matcher t))
13623 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13625 (save-excursion
13626 (save-restriction
13627 (cond ((eq scope 'tree)
13628 (org-back-to-heading t)
13629 (org-narrow-to-subtree)
13630 (setq scope nil))
13631 ((and (eq scope 'region) (org-region-active-p))
13632 (narrow-to-region (region-beginning) (region-end))
13633 (setq scope nil)))
13635 (if (not scope)
13636 (progn
13637 (org-prepare-agenda-buffers
13638 (list (buffer-file-name (current-buffer))))
13639 (setq res (org-scan-tags func matcher)))
13640 ;; Get the right scope
13641 (cond
13642 ((and scope (listp scope) (symbolp (car scope)))
13643 (setq scope (eval scope)))
13644 ((eq scope 'agenda)
13645 (setq scope (org-agenda-files t)))
13646 ((eq scope 'agenda-with-archives)
13647 (setq scope (org-agenda-files t))
13648 (setq scope (org-add-archive-files scope)))
13649 ((eq scope 'file)
13650 (setq scope (list (buffer-file-name))))
13651 ((eq scope 'file-with-archives)
13652 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13653 (org-prepare-agenda-buffers scope)
13654 (while (setq file (pop scope))
13655 (with-current-buffer (org-find-base-buffer-visiting file)
13656 (save-excursion
13657 (save-restriction
13658 (widen)
13659 (goto-char (point-min))
13660 (setq res (append res (org-scan-tags func matcher))))))))))
13661 res))
13663 ;;;; Properties
13665 ;;; Setting and retrieving properties
13667 (defconst org-special-properties
13668 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13669 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13670 "The special properties valid in Org-mode.
13672 These are properties that are not defined in the property drawer,
13673 but in some other way.")
13675 (defconst org-default-properties
13676 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13677 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13678 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13679 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13680 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13681 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13682 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13683 "Some properties that are used by Org-mode for various purposes.
13684 Being in this list makes sure that they are offered for completion.")
13687 "Regular expression matching the first line of a property drawer.")
13690 "Regular expression matching the last line of a property drawer.")
13693 "Regular expression matching the first line of a property drawer.")
13696 "Regular expression matching the first line of a property drawer.")
13698 (defconst org-property-drawer-re
13701 "Matches an entire property drawer.")
13703 (defconst org-clock-drawer-re
13706 "Matches an entire clock drawer.")
13708 (defsubst org-re-property (property)
13709 "Return a regexp matching PROPERTY.
13710 Match group 1 will be set to the value of the property."
13713 (defun org-property-action ()
13714 "Do an action on properties."
13715 (interactive)
13716 (let (c)
13717 (org-at-property-p)
13718 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13719 (setq c (read-char-exclusive))
13720 (cond
13721 ((equal c ?s)
13722 (call-interactively 'org-set-property))
13723 ((equal c ?d)
13724 (call-interactively 'org-delete-property))
13725 ((equal c ?D)
13726 (call-interactively 'org-delete-property-globally))
13727 ((equal c ?c)
13728 (call-interactively 'org-compute-property-at-point))
13729 (t (error "No such property action %c" c)))))
13731 (defun org-set-effort (&optional value)
13732 "Set the effort property of the current entry.
13733 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13734 allowed value."
13735 (interactive "P")
13736 (if (equal value 0) (setq value 10))
13737 (let* ((completion-ignore-case t)
13738 (prop org-effort-property)
13739 (cur (org-entry-get nil prop))
13740 (allowed (org-property-get-allowed-values nil prop 'table))
13741 (existing (mapcar 'list (org-property-values prop)))
13742 rpl
13743 (val (cond
13744 ((stringp value) value)
13745 ((and allowed (integerp value))
13746 (or (car (nth (1- value) allowed))
13747 (car (org-last allowed))))
13748 (allowed
13749 (message "Select 1-9,0, [RET%s]: %s"
13750 (if cur (concat "=" cur) "")
13751 (mapconcat 'car allowed " "))
13752 (setq rpl (read-char-exclusive))
13754 cur
13755 (setq rpl (- rpl ?0))
13756 (if (equal rpl 0) (setq rpl 10))
13757 (if (and (> rpl 0) (<= rpl (length allowed)))
13758 (car (nth (1- rpl) allowed))
13759 (org-completing-read "Effort: " allowed nil))))
13760 (t
13761 (let (org-completion-use-ido org-completion-use-iswitchb)
13762 (org-completing-read
13764 (concat "[" cur "]") "")
13765 ": ")
13766 existing nil nil "" nil cur))))))
13767 (unless (equal (org-entry-get nil prop) val)
13768 (org-entry-put nil prop val))
13769 (message "%s is now %s" prop val)))
13771 (defun org-at-property-p ()
13772 "Is cursor inside a property drawer?"
13773 (save-excursion
13774 (beginning-of-line 1)
13776 (save-match-data ;; Used by calling procedures
13777 (let ((p (point))
13778 (range (unless (org-before-first-heading-p)
13779 (org-get-property-block))))
13780 (and range (<= (car range) p) (< p (cdr range))))))))
13782 (defun org-get-property-block (&optional beg end force)
13783 "Return the (beg . end) range of the body of the property drawer.
13784 BEG and END can be beginning and end of subtree, if not given
13785 they will be found.
13786 If the drawer does not exist and FORCE is non-nil, create the drawer."
13787 (catch 'exit
13788 (save-excursion
13789 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13790 (end (or end (progn (outline-next-heading) (point)))))
13791 (goto-char beg)
13792 (if (re-search-forward org-property-start-re end t)
13793 (setq beg (1+ (match-end 0)))
13794 (if force
13795 (save-excursion
13796 (org-insert-property-drawer)
13797 (setq end (progn (outline-next-heading) (point))))
13798 (throw 'exit nil))
13799 (goto-char beg)
13800 (if (re-search-forward org-property-start-re end t)
13801 (setq beg (1+ (match-end 0)))))
13802 (if (re-search-forward org-property-end-re end t)
13803 (setq end (match-beginning 0))
13804 (or force (throw 'exit nil))
13805 (goto-char beg)
13806 (setq end beg)
13807 (org-indent-line-function)
13809 (cons beg end)))))
13811 (defun org-entry-properties (&optional pom which specific)
13812 "Get all properties of the entry at point-or-marker POM.
13813 This includes the TODO keyword, the tags, time strings for deadline,
13814 scheduled, and clocking, and any additional properties defined in the
13815 entry. The return value is an alist, keys may occur multiple times
13816 if the property key was used several times.
13817 POM may also be nil, in which case the current entry is used.
13818 If WHICH is nil or `all', get all properties. If WHICH is
13819 `special' or `standard', only get that subclass. If WHICH
13820 is a string only get exactly this property. SPECIFIC can be a string, the
13821 specific property we are interested in. Specifying it can speed
13822 things up because then unnecessary parsing is avoided."
13823 (setq which (or which 'all))
13824 (org-with-point-at pom
13825 (let ((clockstr (substring org-clock-string 0 -1))
13826 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13827 (case-fold-search nil)
13828 beg end range props sum-props key key1 value string clocksum)
13829 (save-excursion
13830 (when (condition-case nil
13831 (and (org-mode-p) (org-back-to-heading t))
13832 (error nil))
13833 (setq beg (point))
13834 (setq sum-props (get-text-property (point) 'org-summaries))
13835 (setq clocksum (get-text-property (point) :org-clock-minutes))
13836 (outline-next-heading)
13837 (setq end (point))
13838 (when (memq which '(all special))
13839 ;; Get the special properties, like TODO and tags
13840 (goto-char beg)
13841 (when (and (or (not specific) (string= specific "TODO"))
13842 (looking-at org-todo-line-regexp) (match-end 2))
13843 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13844 (when (and (or (not specific) (string= specific "PRIORITY"))
13845 (looking-at org-priority-regexp))
13846 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13847 (when (or (not specific) (string= specific "FILE"))
13848 (push (cons "FILE" buffer-file-name) props))
13849 (when (and (or (not specific) (string= specific "TAGS"))
13850 (setq value (org-get-tags-string))
13852 (push (cons "TAGS" value) props))
13853 (when (and (or (not specific) (string= specific "ALLTAGS"))
13854 (setq value (org-get-tags-at)))
13855 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13856 ":"))
13857 props))
13858 (when (or (not specific) (string= specific "BLOCKED"))
13859 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13860 (when (or (not specific)
13861 (member specific
13862 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13863 "TIMESTAMP" "TIMESTAMP_IA")))
13864 (catch 'match
13865 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13866 (setq key (if (match-end 1)
13867 (substring (org-match-string-no-properties 1)
13868 0 -1))
13869 string (if (equal key clockstr)
13870 (org-no-properties
13871 (org-trim
13872 (buffer-substring
13873 (match-beginning 3) (goto-char
13874 (point-at-eol)))))
13875 (substring (org-match-string-no-properties 3)
13876 1 -1)))
13877 ;; Get the correct property name from the key. This is
13878 ;; necessary if the user has configured time keywords.
13879 (setq key1 (concat key ":"))
13880 (cond
13881 ((not key)
13882 (setq key
13883 (if (= (char-after (match-beginning 3)) ?\[)
13884 "TIMESTAMP_IA" "TIMESTAMP")))
13885 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13886 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13887 ((equal key1 org-closed-string) (setq key "CLOSED"))
13888 ((equal key1 org-clock-string) (setq key "CLOCK")))
13889 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13890 (progn
13891 (push (cons key string) props)
13892 ;; no need to search further if match is found
13893 (throw 'match t))
13894 (when (or (equal key "CLOCK") (not (assoc key props)))
13895 (push (cons key string) props))))))
13896 )
13898 (when (memq which '(all standard))
13899 ;; Get the standard properties, like :PROP: ...
13900 (setq range (org-get-property-block beg end))
13901 (when range
13902 (goto-char (car range))
13903 (while (re-search-forward
13905 (cdr range) t)
13906 (setq key (org-match-string-no-properties 1)
13907 value (org-trim (or (org-match-string-no-properties 2) "")))
13908 (unless (member key excluded)
13909 (push (cons key (or value "")) props)))))
13910 (if clocksum
13911 (push (cons "CLOCKSUM"
13912 (org-columns-number-to-string (/ (float clocksum) 60.)
13913 'add_times))
13914 props))
13915 (unless (assoc "CATEGORY" props)
13916 (push (cons "CATEGORY" (org-get-category)) props))
13917 (append sum-props (nreverse props)))))))
13919 (defun org-entry-get (pom property &optional inherit literal-nil)
13920 "Get value of PROPERTY for entry at point-or-marker POM.
13921 If INHERIT is non-nil and the entry does not have the property,
13922 then also check higher levels of the hierarchy.
13923 If INHERIT is the symbol `selective', use inheritance only if the setting
13924 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13925 If the property is present but empty, the return value is the empty string.
13926 If the property is not present at all, nil is returned.
13929 do not interpret it as the list atom nil. This is used for inheritance
13931 (org-with-point-at pom
13932 (if (and inherit (if (eq inherit 'selective)
13933 (org-property-inherit-p property)
13934 t))
13935 (org-entry-get-with-inheritance property literal-nil)
13936 (if (member property org-special-properties)
13937 ;; We need a special property. Use `org-entry-properties' to
13938 ;; retrieve it, but specify the wanted property
13939 (cdr (assoc property (org-entry-properties nil 'special property)))
13940 (let ((range (unless (org-before-first-heading-p)
13941 (org-get-property-block))))
13942 (if (and range
13943 (goto-char (car range))
13944 (re-search-forward
13945 (org-re-property property)
13946 (cdr range) t))
13947 ;; Found the property, return it.
13948 (if (match-end 1)
13949 (if literal-nil
13950 (org-match-string-no-properties 1)
13951 (org-not-nil (org-match-string-no-properties 1)))
13952 "")))))))
13954 (defun org-property-or-variable-value (var &optional inherit)
13955 "Check if there is a property fixing the value of VAR.
13956 If yes, return this value. If not, return the current value of the variable."
13957 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13959 (read prop)
13960 (symbol-value var))))
13962 (defun org-entry-delete (pom property)
13963 "Delete the property PROPERTY from entry at point-or-marker POM."
13964 (org-with-point-at pom
13965 (if (member property org-special-properties)
13966 nil ; cannot delete these properties.
13967 (let ((range (org-get-property-block)))
13968 (if (and range
13969 (goto-char (car range))
13970 (re-search-forward
13971 (org-re-property property)
13972 (cdr range) t))
13973 (progn
13974 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13975 t)
13976 nil)))))
13978 ;; Multi-values properties are properties that contain multiple values
13979 ;; These values are assumed to be single words, separated by whitespace.
13980 (defun org-entry-add-to-multivalued-property (pom property value)
13981 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13982 (let* ((old (org-entry-get pom property))
13984 (setq value (org-entry-protect-space value))
13985 (unless (member value values)
13986 (setq values (cons value values))
13987 (org-entry-put pom property
13988 (mapconcat 'identity values " ")))))
13990 (defun org-entry-remove-from-multivalued-property (pom property value)
13991 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13992 (let* ((old (org-entry-get pom property))
13994 (setq value (org-entry-protect-space value))
13995 (when (member value values)
13996 (setq values (delete value values))
13997 (org-entry-put pom property
13998 (mapconcat 'identity values " ")))))
14000 (defun org-entry-member-in-multivalued-property (pom property value)
14001 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14002 (let* ((old (org-entry-get pom property))
14004 (setq value (org-entry-protect-space value))
14005 (member value values)))
14007 (defun org-entry-get-multivalued-property (pom property)
14008 "Return a list of values in a multivalued property."
14009 (let* ((value (org-entry-get pom property))
14011 (mapcar 'org-entry-restore-space values)))
14013 (defun org-entry-put-multivalued-property (pom property &rest values)
14014 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14015 VALUES should be a list of strings. Spaces will be protected."
14016 (org-entry-put pom property
14017 (mapconcat 'org-entry-protect-space values " "))
14018 (let* ((value (org-entry-get pom property))
14020 (mapcar 'org-entry-restore-space values)))
14022 (defun org-entry-protect-space (s)
14023 "Protect spaces and newline in string S."
14024 (while (string-match " " s)
14025 (setq s (replace-match "%20" t t s)))
14027 (setq s (replace-match "%0A" t t s)))
14028 s)
14030 (defun org-entry-restore-space (s)
14031 "Restore spaces and newline in string S."
14032 (while (string-match "%20" s)
14033 (setq s (replace-match " " t t s)))
14034 (while (string-match "%0A" s)
14036 s)
14038 (defvar org-entry-property-inherited-from (make-marker)
14039 "Marker pointing to the entry from where a property was inherited.
14040 Each call to `org-entry-get-with-inheritance' will set this marker to the
14041 location of the entry where the inheritance search matched. If there was
14042 no match, the marker will point nowhere.
14043 Note that also `org-entry-get' calls this function, if the INHERIT flag
14044 is set.")
14046 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14047 "Get entry property, and search higher levels if not present.
14048 The search will stop at the first ancestor which has the property defined.
14050 should be considered as undefined (this is the meaning of nil here).
14052 (move-marker org-entry-property-inherited-from nil)
14053 (let (tmp)
14054 (unless (org-before-first-heading-p)
14055 (save-excursion
14056 (save-restriction
14057 (widen)
14058 (catch 'ex
14059 (while t
14060 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14061 (org-back-to-heading t)
14062 (move-marker org-entry-property-inherited-from (point))
14063 (throw 'ex tmp))
14064 (or (org-up-heading-safe) (throw 'ex nil)))))))
14065 (setq tmp (or tmp
14066 (cdr (assoc property org-file-properties))
14067 (cdr (assoc property org-global-properties))
14068 (cdr (assoc property org-global-properties-fixed))))
14069 (if literal-nil tmp (org-not-nil tmp))))
14071 (defvar org-property-changed-functions nil
14072 "Hook called when the value of a property has changed.
14073 Each hook function should accept two arguments, the name of the property
14074 and the new value.")
14076 (defun org-entry-put (pom property value)
14077 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14078 (org-with-point-at pom
14079 (org-back-to-heading t)
14080 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14081 range)
14082 (cond
14083 ((equal property "TODO")
14085 (not (member value org-todo-keywords-1)))
14087 (if (or (not value)
14089 (setq value 'none))
14090 (org-todo value)
14091 (org-set-tags nil 'align))
14092 ((equal property "PRIORITY")
14094 (string-to-char value) ?\ ))
14095 (org-set-tags nil 'align))
14096 ((equal property "SCHEDULED")
14097 (if (re-search-forward org-scheduled-time-regexp end t)
14098 (cond
14099 ((eq value 'earlier) (org-timestamp-change -1 'day))
14100 ((eq value 'later) (org-timestamp-change 1 'day))
14101 (t (call-interactively 'org-schedule)))
14102 (call-interactively 'org-schedule)))
14103 ((equal property "DEADLINE")
14104 (if (re-search-forward org-deadline-time-regexp end t)
14105 (cond
14106 ((eq value 'earlier) (org-timestamp-change -1 'day))
14107 ((eq value 'later) (org-timestamp-change 1 'day))
14108 (t (call-interactively 'org-deadline)))
14109 (call-interactively 'org-deadline)))
14110 ((member property org-special-properties)
14111 (error "The %s property can not yet be set with `org-entry-put'"
14112 property))
14113 (t ; a non-special property
14114 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14115 (setq range (org-get-property-block beg end 'force))
14116 (goto-char (car range))
14117 (if (re-search-forward
14118 (org-re-property property) (cdr range) t)
14119 (progn
14120 (delete-region (match-beginning 0) (match-end 0))
14121 (goto-char (match-beginning 0)))
14122 (goto-char (cdr range))
14124 (backward-char 1)
14125 (org-indent-line-function))
14126 (insert ":" property ":")
14127 (and value (insert " " value))
14128 (org-indent-line-function)))))
14129 (run-hook-with-args 'org-property-changed-functions property value)))
14131 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14132 "Get all property keys in the current buffer.
14133 With INCLUDE-SPECIALS, also list the special properties that reflect things
14134 like tags and TODO state.
14135 With INCLUDE-DEFAULTS, also include properties that has special meaning
14136 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14137 and others.
14138 With INCLUDE-COLUMNS, also include property names given in COLUMN
14139 formats in the current buffer."
14140 (let (rtn range cfmt s p)
14141 (save-excursion
14142 (save-restriction
14143 (widen)
14144 (goto-char (point-min))
14145 (while (re-search-forward org-property-start-re nil t)
14146 (setq range (org-get-property-block))
14147 (goto-char (car range))
14148 (while (re-search-forward
14150 (cdr range) t)
14151 (add-to-list 'rtn (org-match-string-no-properties 1)))
14152 (outline-next-heading))))
14154 (when include-specials
14155 (setq rtn (append org-special-properties rtn)))
14157 (when include-defaults
14158 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14159 (add-to-list 'rtn org-effort-property))
14161 (when include-columns
14162 (save-excursion
14163 (save-restriction
14164 (widen)
14165 (goto-char (point-min))
14166 (while (re-search-forward
14168 nil t)
14169 (setq cfmt (match-string 2) s 0)
14171 cfmt s)
14172 (setq s (match-end 0)
14173 p (match-string 1 cfmt))
14174 (unless (or (equal p "ITEM")
14175 (member p org-special-properties))
14176 (add-to-list 'rtn (match-string 1 cfmt))))))))
14178 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14180 (defun org-property-values (key)
14181 "Return a list of all values of property KEY in the current buffer."
14182 (save-excursion
14183 (save-restriction
14184 (widen)
14185 (goto-char (point-min))
14186 (let ((re (org-re-property key))
14187 values)
14188 (while (re-search-forward re nil t)
14189 (add-to-list 'values (org-trim (match-string 1))))
14190 (delete "" values)))))
14192 (defun org-insert-property-drawer ()
14193 "Insert a property drawer into the current entry."
14194 (interactive)
14195 (org-back-to-heading t)
14196 (looking-at org-outline-regexp)
14197 (let ((indent (if org-adapt-indentation
14198 (- (match-end 0)(match-beginning 0))
14199 0))
14200 (beg (point))
14202 end hiddenp)
14203 (outline-next-heading)
14204 (setq end (point))
14205 (goto-char beg)
14206 (while (re-search-forward re end t))
14207 (setq hiddenp (outline-invisible-p))
14208 (end-of-line 1)
14211 (if (member (match-string 1) '("CLOCK:" ":END:"))
14212 ;; just skip this line
14213 (beginning-of-line 2)
14214 ;; Drawer start, find the end
14216 (beginning-of-line 1)))
14217 (org-skip-over-state-notes)
14219 (if (eq (char-before) ?*) (forward-char 1))
14221 (beginning-of-line 0)
14222 (org-indent-to-column indent)
14223 (beginning-of-line 2)
14224 (org-indent-to-column indent)
14225 (beginning-of-line 0)
14226 (if hiddenp
14227 (save-excursion
14228 (org-back-to-heading t)
14229 (hide-entry))
14230 (org-flag-drawer t))))
14232 (defvar org-property-set-functions-alist nil
14233 "Property set function alist.
14234 Each entry should have the following format:
14236 (PROPERTY . READ-FUNCTION)
14238 The read function will be called with the same argument as
14239 `org-completing-read'.")
14241 (defun org-set-property-function (property)
14242 "Get the function that should be used to set PROPERTY.
14243 This is computed according to `org-property-set-functions-alist'."
14244 (or (cdr (assoc property org-property-set-functions-alist))
14245 'org-completing-read))
14247 (defun org-read-property-value (property)
14248 "Read PROPERTY value from user."
14249 (let* ((completion-ignore-case t)
14250 (allowed (org-property-get-allowed-values nil property 'table))
14251 (cur (org-entry-get nil property))
14252 (prompt (concat property " value"
14254 (concat " [" cur "]") "") ": "))
14255 (set-function (org-set-property-function property))
14256 (val (if allowed
14257 (funcall set-function prompt allowed nil
14258 (not (get-text-property 0 'org-unrestricted
14259 (caar allowed))))
14260 (let (org-completion-use-ido org-completion-use-iswitchb)
14261 (funcall set-function prompt
14262 (mapcar 'list (org-property-values property))
14263 nil nil "" nil cur)))))
14264 (if (equal val "")
14265 cur
14266 val)))
14268 (defvar org-last-set-property nil)
14269 (defun org-read-property-name ()
14270 "Read a property name."
14271 (let* ((completion-ignore-case t)
14272 (keys (org-buffer-property-keys nil t t))
14273 (default-prop (or (save-excursion
14274 (save-match-data
14275 (beginning-of-line)
14277 (null (string= (match-string 1) "END"))
14278 (match-string 1))))
14279 org-last-set-property))
14280 (property (org-icompleting-read
14281 (concat "Property"
14282 (if default-prop (concat " [" default-prop "]") "")
14283 ": ")
14284 (mapcar 'list keys)
14285 nil nil nil nil
14286 default-prop
14287 )))
14288 (if (member property keys)
14289 property
14290 (or (cdr (assoc (downcase property)
14291 (mapcar (lambda (x) (cons (downcase x) x))
14292 keys)))
14293 property))))
14295 (defun org-set-property (property value)
14296 "In the current entry, set PROPERTY to VALUE.
14297 When called interactively, this will prompt for a property name, offering
14298 completion on existing and default properties. And then it will prompt
14299 for a value, offering completion either on allowed values (via an inherited
14300 xxx_ALL property) or on existing values in other instances of this property
14301 in the current file."
14302 (interactive (list nil nil))
14303 (let* ((property (or property (org-read-property-name)))
14304 (value (or value (org-read-property-value property)))
14305 (fn (assoc property org-properties-postprocess-alist)))
14306 (setq org-last-set-property property)
14307 ;; Possibly postprocess the inserted value:
14308 (when fn (setq value (funcall (cadr fn) value)))
14309 (unless (equal (org-entry-get nil property) value)
14310 (org-entry-put nil property value))))
14312 (defun org-delete-property (property)
14313 "In the current entry, delete PROPERTY."
14314 (interactive
14315 (let* ((completion-ignore-case t)
14316 (prop (org-icompleting-read "Property: "
14317 (org-entry-properties nil 'standard))))
14318 (list prop)))
14319 (message "Property %s %s" property
14320 (if (org-entry-delete nil property)
14321 "deleted"
14322 "was not present in the entry")))
14324 (defun org-delete-property-globally (property)
14325 "Remove PROPERTY globally, from all entries."
14326 (interactive
14327 (let* ((completion-ignore-case t)
14328 (prop (org-icompleting-read
14329 "Globally remove property: "
14330 (mapcar 'list (org-buffer-property-keys)))))
14331 (list prop)))
14332 (save-excursion
14333 (save-restriction
14334 (widen)
14335 (goto-char (point-min))
14336 (let ((cnt 0))
14337 (while (re-search-forward
14338 (org-re-property property)
14339 nil t)
14340 (setq cnt (1+ cnt))
14341 (replace-match ""))
14344 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14346 (defun org-compute-property-at-point ()
14347 "Compute the property at point.
14348 This looks for an enclosing column format, extracts the operator and
14349 then applies it to the property in the column format's scope."
14350 (interactive)
14351 (unless (org-at-property-p)
14352 (error "Not at a property"))
14353 (let ((prop (org-match-string-no-properties 2)))
14354 (org-columns-get-format-and-top-level)
14355 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14356 (error "No operator defined for property %s" prop))
14357 (org-columns-compute prop)))
14359 (defvar org-property-allowed-value-functions nil
14360 "Hook for functions supplying allowed values for a specific property.
14361 The functions must take a single argument, the name of the property, and
14363 the values, this means that these values are intended as defaults for
14364 completion, but that other values should be allowed too.
14365 The functions must return nil if they are not responsible for this
14366 property.")
14368 (defun org-property-get-allowed-values (pom property &optional table)
14369 "Get allowed values for the property PROPERTY.
14370 When TABLE is non-nil, return an alist that can directly be used for
14371 completion."
14372 (let (vals)
14373 (cond
14374 ((equal property "TODO")
14375 (setq vals (org-with-point-at pom
14376 (append org-todo-keywords-1 '("")))))
14377 ((equal property "PRIORITY")
14378 (let ((n org-lowest-priority))
14379 (while (>= n org-highest-priority)
14380 (push (char-to-string n) vals)
14381 (setq n (1- n)))))
14382 ((member property org-special-properties))
14383 ((setq vals (run-hook-with-args-until-success
14384 'org-property-allowed-value-functions property)))
14385 (t
14386 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14388 (setq vals (car (read-from-string (concat "(" vals ")"))))
14389 (setq vals (mapcar (lambda (x)
14390 (cond ((stringp x) x)
14391 ((numberp x) (number-to-string x))
14392 ((symbolp x) (symbol-name x))
14393 (t "???")))
14394 vals)))))
14395 (when (member ":ETC" vals)
14396 (setq vals (remove ":ETC" vals))
14397 (org-add-props (car vals) '(org-unrestricted t)))
14398 (if table (mapcar 'list vals) vals)))
14400 (defun org-property-previous-allowed-value (&optional previous)
14401 "Switch to the next allowed value for this property."
14402 (interactive)
14403 (org-property-next-allowed-value t))
14405 (defun org-property-next-allowed-value (&optional previous)
14406 "Switch to the next allowed value for this property."
14407 (interactive)
14408 (unless (org-at-property-p)
14409 (error "Not at a property"))
14410 (let* ((key (match-string 2))
14411 (value (match-string 3))
14412 (allowed (or (org-property-get-allowed-values (point) key)
14413 (and (member value '("[ ]" "[-]" "[X]"))
14414 '("[ ]" "[X]"))))
14415 nval)
14416 (unless allowed
14417 (error "Allowed values for this property have not been defined"))
14418 (if previous (setq allowed (reverse allowed)))
14419 (if (member value allowed)
14420 (setq nval (car (cdr (member value allowed)))))
14421 (setq nval (or nval (car allowed)))
14422 (if (equal nval value)
14423 (error "Only one allowed value for this property"))
14424 (org-at-property-p)
14425 (replace-match (concat " :" key ": " nval) t t)
14426 (org-indent-line-function)
14427 (beginning-of-line 1)
14429 (run-hook-with-args 'org-property-changed-functions key nval)))
14431 (defun org-find-olp (path &optional this-buffer)
14432 "Return a marker pointing to the entry at outline path OLP.
14433 If anything goes wrong, throw an error.
14434 You can wrap this call to catch the error like this:
14436 (condition-case msg
14437 (org-mobile-locate-entry (match-string 4))
14438 (error (nth 1 msg)))
14440 The return value will then be either a string with the error message,
14441 or a marker if everything is OK.
14443 If THIS-BUFFER is set, the outline path does not contain a file,
14444 only headings."
14445 (let* ((file (if this-buffer buffer-file-name (pop path)))
14446 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14447 (level 1)
14448 (lmin 1)
14449 (lmax 1)
14450 limit re end found pos heading cnt flevel)
14451 (unless buffer (error "File not found :%s" file))
14452 (with-current-buffer buffer
14453 (save-excursion
14454 (save-restriction
14455 (widen)
14456 (setq limit (point-max))
14457 (goto-char (point-min))
14458 (while (setq heading (pop path))
14459 (setq re (format org-complex-heading-regexp-format
14460 (regexp-quote heading)))
14461 (setq cnt 0 pos (point))
14462 (while (re-search-forward re end t)
14463 (setq level (- (match-end 1) (match-beginning 1)))
14464 (if (and (>= level lmin) (<= level lmax))
14465 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14466 (when (= cnt 0) (error "Heading not found on level %d: %s"
14467 lmax heading))
14468 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14469 lmax heading))
14470 (goto-char found)
14471 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14472 (setq end (save-excursion (org-end-of-subtree t t))))
14473 (when (org-on-heading-p)
14474 (move-marker (make-marker) (point))))))))
14476 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14477 "Find node HEADING in BUFFER.
14478 Return a marker to the heading if it was found, or nil if not.
14479 If POS-ONLY is set, return just the position instead of a marker.
14481 The heading text must match exact, but it may have a TODO keyword,
14482 a priority cookie and tags in the standard locations."
14483 (with-current-buffer (or buffer (current-buffer))
14484 (save-excursion
14485 (save-restriction
14486 (widen)
14487 (goto-char (point-min))
14488 (let (case-fold-search)
14489 (if (re-search-forward
14490 (format org-complex-heading-regexp-format
14491 (regexp-quote heading)) nil t)
14492 (if pos-only
14493 (match-beginning 0)
14494 (move-marker (make-marker) (match-beginning 0)))))))))
14496 (defun org-find-exact-heading-in-directory (heading &optional dir)
14497 "Find Org node headline HEADING in all .org files in directory DIR.
14498 When the target headline is found, return a marker to this location."
14499 (let ((files (directory-files (or dir default-directory)
14501 file visiting m buffer)
14502 (catch 'found
14503 (while (setq file (pop files))
14504 (message "trying %s" file)
14505 (setq visiting (org-find-base-buffer-visiting file))
14506 (setq buffer (or visiting (find-file-noselect file)))
14507 (setq m (org-find-exact-headline-in-buffer
14508 heading buffer))
14509 (when (and (not m) (not visiting)) (kill-buffer buffer))
14510 (and m (throw 'found m))))))
14512 (defun org-find-entry-with-id (ident)
14513 "Locate the entry that contains the ID property with exact value IDENT.
14514 IDENT can be a string, a symbol or a number, this function will search for
14515 the string representation of it.
14516 Return the position where this entry starts, or nil if there is no such entry."
14517 (interactive "sID: ")
14518 (let ((id (cond
14519 ((stringp ident) ident)
14520 ((symbol-name ident) (symbol-name ident))
14521 ((numberp ident) (number-to-string ident))
14522 (t (error "IDENT %s must be a string, symbol or number" ident))))
14523 (case-fold-search nil))
14524 (save-excursion
14525 (save-restriction
14526 (widen)
14527 (goto-char (point-min))
14528 (when (re-search-forward
14530 nil t)
14531 (org-back-to-heading t)
14532 (point))))))
14534 ;;;; Timestamps
14536 (defvar org-last-changed-timestamp nil)
14537 (defvar org-last-inserted-timestamp nil
14538 "The last time stamp inserted with `org-insert-time-stamp'.")
14539 (defvar org-time-was-given) ; dynamically scoped parameter
14540 (defvar org-end-time-was-given) ; dynamically scoped parameter
14541 (defvar org-ts-what) ; dynamically scoped parameter
14543 (defun org-time-stamp (arg &optional inactive)
14544 "Prompt for a date/time and insert a time stamp.
14545 If the user specifies a time like HH:MM, or if this command is called
14546 with a prefix argument, the time stamp will contain date and time.
14547 Otherwise, only the date will be included. All parts of a date not
14548 specified by the user will be filled in from the current date/time.
14549 So if you press just return without typing anything, the time stamp
14550 will represent the current date/time. If there is already a timestamp
14551 at the cursor, it will be modified."
14552 (interactive "P")
14553 (let* ((ts nil)
14554 (default-time
14555 ;; Default time is either today, or, when entering a range,
14556 ;; the range start.
14557 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14558 (save-excursion
14559 (re-search-backward
14561 (- (point) 20) t)))
14562 (apply 'encode-time (org-parse-time-string (match-string 1)))
14563 (current-time)))
14564 (default-input (and ts (org-get-compact-tod ts)))
14565 (repeater (save-excursion
14566 (save-match-data
14567 (beginning-of-line)
14568 (when (re-search-forward
14570 (save-excursion (progn (end-of-line) (point))) t)
14571 (match-string 0)))))
14572 org-time-was-given org-end-time-was-given time)
14573 (cond
14574 ((and (org-at-timestamp-p t)
14575 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14576 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14577 (insert "--")
14578 (setq time (let ((this-command this-command))
14579 (org-read-date arg 'totime nil nil
14580 default-time default-input)))
14581 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14582 ((org-at-timestamp-p t)
14583 (setq time (let ((this-command this-command))
14584 (org-read-date arg 'totime nil nil default-time default-input)))
14585 (when (org-at-timestamp-p t) ; just to get the match data
14586 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14587 (replace-match "")
14588 (setq org-last-changed-timestamp
14589 (org-insert-time-stamp
14590 time (or org-time-was-given arg)
14591 inactive nil nil (list org-end-time-was-given)))
14592 (when repeater (goto-char (1- (point))) (insert " " repeater)
14593 (setq org-last-changed-timestamp
14594 (concat (substring org-last-inserted-timestamp 0 -1)
14595 " " repeater ">"))))
14596 (message "Timestamp updated"))
14597 (t
14598 (setq time (let ((this-command this-command))
14599 (org-read-date arg 'totime nil nil default-time default-input)))
14600 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14601 nil nil (list org-end-time-was-given))))))
14603 ;; FIXME: can we use this for something else, like computing time differences?
14604 (defun org-get-compact-tod (s)
14605 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14606 (let* ((t1 (match-string 1 s))
14607 (h1 (string-to-number (match-string 2 s)))
14608 (m1 (string-to-number (match-string 3 s)))
14609 (t2 (and (match-end 4) (match-string 5 s)))
14610 (h2 (and t2 (string-to-number (match-string 6 s))))
14611 (m2 (and t2 (string-to-number (match-string 7 s))))
14612 dh dm)
14613 (if (not t2)
14614 t1
14615 (setq dh (- h2 h1) dm (- m2 m1))
14616 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14617 (concat t1 "+" (number-to-string dh)
14618 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14620 (defun org-time-stamp-inactive (&optional arg)
14621 "Insert an inactive time stamp.
14622 An inactive time stamp is enclosed in square brackets instead of angle
14623 brackets. It is inactive in the sense that it does not trigger agenda entries,
14624 does not link to the calendar and cannot be changed with the S-cursor keys.
14625 So these are more for recording a certain time/date."
14626 (interactive "P")
14627 (org-time-stamp arg 'inactive))
14629 (defvar org-date-ovl (make-overlay 1 1))
14630 (overlay-put org-date-ovl 'face 'org-warning)
14631 (org-detach-overlay org-date-ovl)
14633 (defvar org-ans1) ; dynamically scoped parameter
14634 (defvar org-ans2) ; dynamically scoped parameter
14636 (defvar org-plain-time-of-day-regexp) ; defined below
14638 (defvar org-overriding-default-time nil) ; dynamically scoped
14639 (defvar org-read-date-overlay nil)
14640 (defvar org-dcst nil) ; dynamically scoped
14641 (defvar org-read-date-history nil)
14642 (defvar org-read-date-final-answer nil)
14643 (defvar org-read-date-analyze-futurep nil)
14644 (defvar org-read-date-analyze-forced-year nil)
14646 (defun org-read-date (&optional with-time to-time from-string prompt
14647 default-time default-input)
14648 "Read a date, possibly a time, and make things smooth for the user.
14649 The prompt will suggest to enter an ISO date, but you can also enter anything
14650 which will at least partially be understood by `parse-time-string'.
14651 Unrecognized parts of the date will default to the current day, month, year,
14652 hour and minute. If this command is called to replace a timestamp at point,
14653 of to enter the second timestamp of a range, the default time is taken
14654 from the existing stamp. Furthermore, the command prefers the future,
14655 so if you are giving a date where the year is not given, and the day-month
14656 combination is already past in the current year, it will assume you
14657 mean next year. For details, see the manual. A few examples:
14659 3-2-5 --> 2003-02-05
14660 feb 15 --> currentyear-02-15
14661 2/15 --> currentyear-02-15
14662 sep 12 9 --> 2009-09-12
14663 12:45 --> today 12:45
14664 22 sept 0:34 --> currentyear-09-22 0:34
14665 12 --> currentyear-currentmonth-12
14666 Fri --> nearest Friday (today or later)
14667 etc.
14669 Furthermore you can specify a relative date by giving, as the *first* thing
14670 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14671 change in days weeks, months, years.
14672 With a single plus or minus, the date is relative to today. With a double
14673 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14674 +4d --> four days from today
14675 +4 --> same as above
14676 +2w --> two weeks from today
14677 ++5 --> five days from default date
14679 The function understands only English month and weekday abbreviations,
14680 but this can be configured with the variables `parse-time-months' and
14681 `parse-time-weekdays'.
14683 While prompting, a calendar is popped up - you can also select the
14684 date with the mouse (button 1). The calendar shows a period of three
14685 months. To scroll it to other months, use the keys `>' and `<'.
14686 If you don't like the calendar, turn it off with
14687 \(setq org-read-date-popup-calendar nil)
14689 With optional argument TO-TIME, the date will immediately be converted
14690 to an internal time.
14691 With an optional argument WITH-TIME, the prompt will suggest to also
14692 insert a time. Note that when WITH-TIME is not set, you can still
14693 enter a time, and this function will inform the calling routine about
14694 this change. The calling routine may then choose to change the format
14695 used to insert the time stamp into the buffer to include the time.
14696 With optional argument FROM-STRING, read from this string instead from
14697 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14698 the time/date that is used for everything that is not specified by the
14699 user."
14700 (require 'parse-time)
14701 (let* ((org-time-stamp-rounding-minutes
14702 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14703 (org-dcst org-display-custom-times)
14704 (ct (org-current-time))
14705 (def (or org-overriding-default-time default-time ct))
14706 (defdecode (decode-time def))
14707 (dummy (progn
14708 (when (< (nth 2 defdecode) org-extend-today-until)
14709 (setcar (nthcdr 2 defdecode) -1)
14710 (setcar (nthcdr 1 defdecode) 59)
14711 (setq def (apply 'encode-time defdecode)
14712 defdecode (decode-time def)))))
14713 (calendar-frame-setup nil)
14714 (calendar-setup nil)
14715 (calendar-move-hook nil)
14716 (calendar-view-diary-initially-flag nil)
14717 (calendar-view-holidays-initially-flag nil)
14718 (timestr (format-time-string
14719 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14720 (prompt (concat (if prompt (concat prompt " ") "")
14721 (format "Date+time [%s]: " timestr)))
14722 ans (org-ans0 "") org-ans1 org-ans2 final)
14724 (cond
14725 (from-string (setq ans from-string))
14726 (org-read-date-popup-calendar
14727 (save-excursion
14728 (save-window-excursion
14729 (calendar)
14730 (unwind-protect
14731 (progn
14732 (calendar-forward-day (- (time-to-days def)
14733 (calendar-absolute-from-gregorian
14734 (calendar-current-date))))
14735 (org-eval-in-calendar nil t)
14736 (let* ((old-map (current-local-map))
14737 (map (copy-keymap calendar-mode-map))
14738 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14739 (org-defkey map (kbd "RET") 'org-calendar-select)
14740 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14741 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14742 (org-defkey minibuffer-local-map [(meta shift left)]
14743 (lambda () (interactive)
14744 (org-eval-in-calendar '(calendar-backward-month 1))))
14745 (org-defkey minibuffer-local-map [(meta shift right)]
14746 (lambda () (interactive)
14747 (org-eval-in-calendar '(calendar-forward-month 1))))
14748 (org-defkey minibuffer-local-map [(meta shift up)]
14749 (lambda () (interactive)
14750 (org-eval-in-calendar '(calendar-backward-year 1))))
14751 (org-defkey minibuffer-local-map [(meta shift down)]
14752 (lambda () (interactive)
14753 (org-eval-in-calendar '(calendar-forward-year 1))))
14754 (org-defkey minibuffer-local-map [?\e (shift left)]
14755 (lambda () (interactive)
14756 (org-eval-in-calendar '(calendar-backward-month 1))))
14757 (org-defkey minibuffer-local-map [?\e (shift right)]
14758 (lambda () (interactive)
14759 (org-eval-in-calendar '(calendar-forward-month 1))))
14760 (org-defkey minibuffer-local-map [?\e (shift up)]
14761 (lambda () (interactive)
14762 (org-eval-in-calendar '(calendar-backward-year 1))))
14763 (org-defkey minibuffer-local-map [?\e (shift down)]
14764 (lambda () (interactive)
14765 (org-eval-in-calendar '(calendar-forward-year 1))))
14766 (org-defkey minibuffer-local-map [(shift up)]
14767 (lambda () (interactive)
14768 (org-eval-in-calendar '(calendar-backward-week 1))))
14769 (org-defkey minibuffer-local-map [(shift down)]
14770 (lambda () (interactive)
14771 (org-eval-in-calendar '(calendar-forward-week 1))))
14772 (org-defkey minibuffer-local-map [(shift left)]
14773 (lambda () (interactive)
14774 (org-eval-in-calendar '(calendar-backward-day 1))))
14775 (org-defkey minibuffer-local-map [(shift right)]
14776 (lambda () (interactive)
14777 (org-eval-in-calendar '(calendar-forward-day 1))))
14778 (org-defkey minibuffer-local-map ">"
14779 (lambda () (interactive)
14780 (org-eval-in-calendar '(scroll-calendar-left 1))))
14781 (org-defkey minibuffer-local-map "<"
14782 (lambda () (interactive)
14783 (org-eval-in-calendar '(scroll-calendar-right 1))))
14784 (org-defkey minibuffer-local-map "\C-v"
14785 (lambda () (interactive)
14786 (org-eval-in-calendar
14787 '(calendar-scroll-left-three-months 1))))
14788 (org-defkey minibuffer-local-map "\M-v"
14789 (lambda () (interactive)
14790 (org-eval-in-calendar
14791 '(calendar-scroll-right-three-months 1))))
14792 (run-hooks 'org-read-date-minibuffer-setup-hook)
14793 (unwind-protect
14794 (progn
14795 (use-local-map map)
14796 (add-hook 'post-command-hook 'org-read-date-display)
14797 (setq org-ans0 (read-string prompt default-input
14798 'org-read-date-history nil))
14799 ;; org-ans0: from prompt
14800 ;; org-ans1: from mouse click
14801 ;; org-ans2: from calendar motion
14802 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14803 (remove-hook 'post-command-hook 'org-read-date-display)
14804 (use-local-map old-map)
14805 (when org-read-date-overlay
14806 (delete-overlay org-read-date-overlay)
14807 (setq org-read-date-overlay nil)))))
14808 (bury-buffer "*Calendar*")))))
14810 (t ; Naked prompt only
14811 (unwind-protect
14812 (setq ans (read-string prompt default-input
14813 'org-read-date-history timestr))
14814 (when org-read-date-overlay
14815 (delete-overlay org-read-date-overlay)
14816 (setq org-read-date-overlay nil)))))
14818 (setq final (org-read-date-analyze ans def defdecode))
14820 (when org-read-date-analyze-forced-year
14821 (message "Year was forced into %s"
14822 (if org-read-date-force-compatible-dates
14823 "compatible range (1970-2037)"
14824 "range representable on this machine"))
14825 (ding))
14827 ;; One round trip to get rid of 34th of August and stuff like that....
14828 (setq final (decode-time (apply 'encode-time final)))
14830 (setq org-read-date-final-answer ans)
14832 (if to-time
14833 (apply 'encode-time final)
14834 (if (and (boundp 'org-time-was-given) org-time-was-given)
14835 (format "%04d-%02d-%02d %02d:%02d"
14836 (nth 5 final) (nth 4 final) (nth 3 final)
14837 (nth 2 final) (nth 1 final))
14838 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14840 (defvar def)
14841 (defvar defdecode)
14842 (defvar with-time)
14843 (defun org-read-date-display ()
14844 "Display the current date prompt interpretation in the minibuffer."
14845 (when org-read-date-display-live
14846 (when org-read-date-overlay
14847 (delete-overlay org-read-date-overlay))
14848 (let ((p (point)))
14849 (end-of-line 1)
14850 (while (not (equal (buffer-substring
14851 (max (point-min) (- (point) 4)) (point))
14852 " "))
14853 (insert " "))
14854 (goto-char p))
14855 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14856 " " (or org-ans1 org-ans2)))
14857 (org-end-time-was-given nil)
14858 (f (org-read-date-analyze ans def defdecode))
14859 (fmts (if org-dcst
14860 org-time-stamp-custom-formats
14861 org-time-stamp-formats))
14862 (fmt (if (or with-time
14863 (and (boundp 'org-time-was-given) org-time-was-given))
14864 (cdr fmts)
14865 (car fmts)))
14866 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14867 (when (and org-end-time-was-given
14868 (string-match org-plain-time-of-day-regexp txt))
14869 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14870 org-end-time-was-given
14871 (substring txt (match-end 0)))))
14872 (when org-read-date-analyze-futurep
14873 (setq txt (concat txt " (=>F)")))
14874 (setq org-read-date-overlay
14875 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14876 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14878 (defun org-read-date-analyze (ans def defdecode)
14879 "Analyze the combined answer of the date prompt."
14880 ;; FIXME: cleanup and comment
14881 (let ((nowdecode (decode-time (current-time)))
14882 delta deltan deltaw deltadef year month day
14883 hour minute second wday pm h2 m2 tl wday1
14884 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14885 (setq org-read-date-analyze-futurep nil
14886 org-read-date-analyze-forced-year nil)
14888 (setq ans "+0"))
14890 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14891 (setq ans (replace-match "" t t ans)
14892 deltan (car delta)
14893 deltaw (nth 1 delta)
14894 deltadef (nth 2 delta)))
14896 ;; Check if there is an iso week date in there
14897 ;; If yes, store the info and postpone interpreting it until the rest
14898 ;; of the parsing is done
14899 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14900 (setq iso-year (if (match-end 1)
14901 (org-small-year-to-year
14902 (string-to-number (match-string 1 ans))))
14903 iso-weekday (if (match-end 3)
14904 (string-to-number (match-string 3 ans)))
14905 iso-week (string-to-number (match-string 2 ans)))
14906 (setq ans (replace-match "" t t ans)))
14908 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14909 (when (string-match
14911 (setq year (if (match-end 2)
14912 (string-to-number (match-string 2 ans))
14913 (progn (setq kill-year t)
14914 (string-to-number (format-time-string "%Y"))))
14915 month (string-to-number (match-string 3 ans))
14916 day (string-to-number (match-string 4 ans)))
14917 (if (< year 100) (setq year (+ 2000 year)))
14919 t nil ans)))
14921 ;; Help matching dottet european dates
14922 (when (string-match
14923 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14924 (setq year (if (match-end 3)
14925 (string-to-number (match-string 3 ans))
14926 (progn (setq kill-year t)
14927 (string-to-number (format-time-string "%Y"))))
14928 day (string-to-number (match-string 1 ans))
14929 month (string-to-number (match-string 2 ans))
14931 t nil ans)))
14933 ;; Help matching american dates, like 5/30 or 5/30/7
14934 (when (string-match
14935 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14936 (setq year (if (match-end 4)
14937 (string-to-number (match-string 4 ans))
14938 (progn (setq kill-year t)
14939 (string-to-number (format-time-string "%Y"))))
14940 month (string-to-number (match-string 1 ans))
14941 day (string-to-number (match-string 2 ans)))
14942 (if (< year 100) (setq year (+ 2000 year)))
14944 t nil ans)))
14945 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14946 ;; If there is a time with am/pm, and *no* time without it, we convert
14947 ;; so that matching will be successful.
14948 (loop for i from 1 to 2 do ; twice, for end time as well
14951 (setq hour (string-to-number (match-string 1 ans))
14952 minute (if (match-end 3)
14953 (string-to-number (match-string 3 ans))
14954 0)
14955 pm (equal ?p
14956 (string-to-char (downcase (match-string 4 ans)))))
14957 (if (and (= hour 12) (not pm))
14958 (setq hour 0)
14959 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14960 (setq ans (replace-match (format "%02d:%02d" hour minute)
14961 t t ans))))
14963 ;; Check if a time range is given as a duration
14964 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14965 (setq hour (string-to-number (match-string 1 ans))
14966 h2 (+ hour (string-to-number (match-string 3 ans)))
14967 minute (string-to-number (match-string 2 ans))
14968 m2 (+ minute (if (match-end 5) (string-to-number
14969 (match-string 5 ans))0)))
14970 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14971 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14972 t t ans)))
14974 ;; Check if there is a time range
14975 (when (boundp 'org-end-time-was-given)
14976 (setq org-time-was-given nil)
14977 (when (and (string-match org-plain-time-of-day-regexp ans)
14978 (match-end 8))
14979 (setq org-end-time-was-given (match-string 8 ans))
14980 (setq ans (concat (substring ans 0 (match-beginning 7))
14981 (substring ans (match-end 7))))))
14983 (setq tl (parse-time-string ans)
14984 day (or (nth 3 tl) (nth 3 defdecode))
14985 month (or (nth 4 tl)
14986 (if (and org-read-date-prefer-future
14987 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14988 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14989 (nth 4 defdecode)))
14990 year (or (and (not kill-year) (nth 5 tl))
14991 (if (and org-read-date-prefer-future
14992 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14993 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14994 (nth 5 defdecode)))
14995 hour (or (nth 2 tl) (nth 2 defdecode))
14996 minute (or (nth 1 tl) (nth 1 defdecode))
14997 second (or (nth 0 tl) 0)
14998 wday (nth 6 tl))
15000 (when (and (eq org-read-date-prefer-future 'time)
15001 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15002 (equal day (nth 3 nowdecode))
15003 (equal month (nth 4 nowdecode))
15004 (equal year (nth 5 nowdecode))
15005 (nth 2 tl)
15006 (or (< (nth 2 tl) (nth 2 nowdecode))
15007 (and (= (nth 2 tl) (nth 2 nowdecode))
15008 (nth 1 tl)
15009 (< (nth 1 tl) (nth 1 nowdecode)))))
15010 (setq day (1+ day)
15011 futurep t))
15013 ;; Special date definitions below
15014 (cond
15015 (iso-week
15016 ;; There was an iso week
15017 (require 'cal-iso)
15018 (setq futurep nil)
15019 (setq year (or iso-year year)
15020 day (or iso-weekday wday 1)
15021 wday nil ; to make sure that the trigger below does not match
15022 iso-date (calendar-gregorian-from-absolute
15023 (calendar-absolute-from-iso
15024 (list iso-week day year))))
15025 ; FIXME: Should we also push ISO weeks into the future?
15026 ; (when (and org-read-date-prefer-future
15027 ; (not iso-year)
15028 ; (< (calendar-absolute-from-gregorian iso-date)
15029 ; (time-to-days (current-time))))
15030 ; (setq year (1+ year)
15031 ; iso-date (calendar-gregorian-from-absolute
15032 ; (calendar-absolute-from-iso
15033 ; (list iso-week day year)))))
15034 (setq month (car iso-date)
15035 year (nth 2 iso-date)
15036 day (nth 1 iso-date)))
15037 (deltan
15038 (setq futurep nil)
15039 (unless deltadef
15040 (let ((now (decode-time (current-time))))
15041 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15042 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15043 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15044 ((equal deltaw "m") (setq month (+ month deltan)))
15045 ((equal deltaw "y") (setq year (+ year deltan)))))
15046 ((and wday (not (nth 3 tl)))
15047 (setq futurep nil)
15048 ;; Weekday was given, but no day, so pick that day in the week
15049 ;; on or after the derived date.
15050 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15051 (unless (equal wday wday1)
15052 (setq day (+ day (% (- wday wday1 -7) 7))))))
15053 (if (and (boundp 'org-time-was-given)
15054 (nth 2 tl))
15055 (setq org-time-was-given t))
15056 (if (< year 100) (setq year (+ 2000 year)))
15057 ;; Check of the date is representable
15058 (if org-read-date-force-compatible-dates
15059 (progn
15060 (if (< year 1970)
15061 (setq year 1970 org-read-date-analyze-forced-year t))
15062 (if (> year 2037)
15063 (setq year 2037 org-read-date-analyze-forced-year t)))
15064 (condition-case nil
15065 (ignore (encode-time second minute hour day month year))
15066 (error
15067 (setq year (nth 5 defdecode))
15068 (setq org-read-date-analyze-forced-year t))))
15069 (setq org-read-date-analyze-futurep futurep)
15070 (list second minute hour day month year)))
15072 (defvar parse-time-weekdays)
15074 (defun org-read-date-get-relative (s today default)
15075 "Check string S for special relative date string.
15076 TODAY and DEFAULT are internal times, for today and for a default.
15077 Return shift list (N what def-flag)
15079 N is the number of WHATs to shift.
15080 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15081 the DEFAULT date rather than TODAY."
15082 (when (and
15083 (string-match
15084 (concat
15089 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15090 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15091 (string-to-char (substring (match-string 1 s) -1))
15092 ?+))
15093 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15094 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15095 (what (if (match-end 3) (match-string 3 s) "d"))
15096 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15097 (date (if rel default today))
15098 (wday (nth 6 (decode-time date)))
15099 delta)
15100 (if wday1
15101 (progn
15102 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15103 (if (= dir ?-) (setq delta (- delta 7)))
15104 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15105 (list delta "d" rel))
15106 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15108 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15109 "Turn a user-specified date into the internal representation.
15110 The internal representation needed by the calendar is (month day year).
15111 This is a wrapper to handle the brain-dead convention in calendar that
15112 user function argument order change dependent on argument order."
15113 (if (boundp 'calendar-date-style)
15114 (cond
15115 ((eq calendar-date-style 'american)
15116 (list arg1 arg2 arg3))
15117 ((eq calendar-date-style 'european)
15118 (list arg2 arg1 arg3))
15119 ((eq calendar-date-style 'iso)
15120 (list arg2 arg3 arg1)))
15121 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15122 (if (org-bound-and-true-p european-calendar-style)
15123 (list arg2 arg1 arg3)
15124 (list arg1 arg2 arg3)))))
15126 (defun org-eval-in-calendar (form &optional keepdate)
15127 "Eval FORM in the calendar window and return to current window.
15128 Also, store the cursor date in variable org-ans2."
15129 (let ((sf (selected-frame))
15130 (sw (selected-window)))
15131 (select-window (get-buffer-window "*Calendar*" t))
15132 (eval form)
15133 (when (and (not keepdate) (calendar-cursor-to-date))
15134 (let* ((date (calendar-cursor-to-date))
15135 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15136 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15137 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15138 (select-window sw)
15139 (org-select-frame-set-input-focus sf)))
15141 (defun org-calendar-select ()
15142 "Return to `org-read-date' with the date currently selected.
15143 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15144 (interactive)
15145 (when (calendar-cursor-to-date)
15146 (let* ((date (calendar-cursor-to-date))
15147 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15148 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15149 (if (active-minibuffer-window) (exit-minibuffer))))
15151 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15152 "Insert a date stamp for the date given by the internal TIME.
15153 WITH-HM means use the stamp format that includes the time of the day.
15154 INACTIVE means use square brackets instead of angular ones, so that the
15155 stamp will not contribute to the agenda.
15156 PRE and POST are optional strings to be inserted before and after the
15157 stamp.
15158 The command returns the inserted time stamp."
15159 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15160 stamp)
15161 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15162 (insert-before-markers (or pre ""))
15163 (when (listp extra)
15164 (setq extra (car extra))
15165 (if (and (stringp extra)
15167 (setq extra (format "-%02d:%02d"
15168 (string-to-number (match-string 1 extra))
15169 (string-to-number (match-string 2 extra))))
15170 (setq extra nil)))
15171 (when extra
15172 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15173 (insert-before-markers (setq stamp (format-time-string fmt time)))
15174 (insert-before-markers (or post ""))
15175 (setq org-last-inserted-timestamp stamp)))
15177 (defun org-toggle-time-stamp-overlays ()
15178 "Toggle the use of custom time stamp formats."
15179 (interactive)
15180 (setq org-display-custom-times (not org-display-custom-times))
15181 (unless org-display-custom-times
15182 (let ((p (point-min)) (bmp (buffer-modified-p)))
15183 (while (setq p (next-single-property-change p 'display))
15184 (if (and (get-text-property p 'display)
15185 (eq (get-text-property p 'face) 'org-date))
15186 (remove-text-properties
15187 p (setq p (next-single-property-change p 'display))
15188 '(display t))))
15189 (set-buffer-modified-p bmp)))
15190 (if (featurep 'xemacs)
15191 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15192 (org-restart-font-lock)
15193 (setq org-table-may-need-update t)
15194 (if org-display-custom-times
15195 (message "Time stamps are overlayed with custom format")
15196 (message "Time stamp overlays removed")))
15198 (defun org-display-custom-time (beg end)
15199 "Overlay modified time stamp format over timestamp between BEG and END."
15200 (let* ((ts (buffer-substring beg end))
15201 t1 w1 with-hm tf time str w2 (off 0))
15202 (save-match-data
15203 (setq t1 (org-parse-time-string ts t))
15204 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15205 (setq off (- (match-end 0) (match-beginning 0)))))
15206 (setq end (- end off))
15207 (setq w1 (- end beg)
15208 with-hm (and (nth 1 t1) (nth 2 t1))
15209 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15210 time (org-fix-decoded-time t1)
15211 str (org-add-props
15212 (format-time-string
15213 (substring tf 1 -1) (apply 'encode-time time))
15214 nil 'mouse-face 'highlight)
15215 w2 (length str))
15216 (if (not (= w2 w1))
15217 (add-text-properties (1+ beg) (+ 2 beg)
15218 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15219 (if (featurep 'xemacs)
15220 (progn
15221 (put-text-property beg end 'invisible t)
15222 (put-text-property beg end 'end-glyph (make-glyph str)))
15223 (put-text-property beg end 'display str))))
15225 (defun org-translate-time (string)
15226 "Translate all timestamps in STRING to custom format.
15227 But do this only if the variable `org-display-custom-times' is set."
15228 (when org-display-custom-times
15229 (save-match-data
15230 (let* ((start 0)
15231 (re org-ts-regexp-both)
15232 t1 with-hm inactive tf time str beg end)
15233 (while (setq start (string-match re string start))
15234 (setq beg (match-beginning 0)
15235 end (match-end 0)
15236 t1 (save-match-data
15237 (org-parse-time-string (substring string beg end) t))
15238 with-hm (and (nth 1 t1) (nth 2 t1))
15239 inactive (equal (substring string beg (1+ beg)) "[")
15240 tf (funcall (if with-hm 'cdr 'car)
15241 org-time-stamp-custom-formats)
15242 time (org-fix-decoded-time t1)
15243 str (format-time-string
15244 (concat
15245 (if inactive "[" "<") (substring tf 1 -1)
15246 (if inactive "]" ">"))
15247 (apply 'encode-time time))
15248 string (replace-match str t t string)
15249 start (+ start (length str)))))))
15250 string)
15252 (defun org-fix-decoded-time (time)
15253 "Set 0 instead of nil for the first 6 elements of time.
15254 Don't touch the rest."
15255 (let ((n 0))
15256 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15258 (defun org-days-to-time (timestamp-string)
15259 "Difference between TIMESTAMP-STRING and now in days."
15260 (- (time-to-days (org-time-string-to-time timestamp-string))
15261 (time-to-days (current-time))))
15263 (defun org-deadline-close (timestamp-string &optional ndays)
15264 "Is the time in TIMESTAMP-STRING close to the current date?"
15265 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15266 (and (< (org-days-to-time timestamp-string) ndays)
15267 (not (org-entry-is-done-p))))
15269 (defun org-get-wdays (ts)
15270 "Get the deadline lead time appropriate for timestring TS."
15271 (cond
15272 ((<= org-deadline-warning-days 0)
15273 ;; 0 or negative, enforce this value no matter what
15274 (- org-deadline-warning-days))
15276 ;; lead time is specified.
15277 (floor (* (string-to-number (match-string 1 ts))
15278 (cdr (assoc (match-string 2 ts)
15279 '(("d" . 1) ("w" . 7)
15280 ("m" . 30.4) ("y" . 365.25)))))))
15281 ;; go for the default.
15282 (t org-deadline-warning-days)))
15284 (defun org-calendar-select-mouse (ev)
15285 "Return to `org-read-date' with the date currently selected.
15286 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15287 (interactive "e")
15288 (mouse-set-point ev)
15289 (when (calendar-cursor-to-date)
15290 (let* ((date (calendar-cursor-to-date))
15291 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15292 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15293 (if (active-minibuffer-window) (exit-minibuffer))))
15295 (defun org-check-deadlines (ndays)
15296 "Check if there are any deadlines due or past due.
15297 A deadline is considered due if it happens within `org-deadline-warning-days'
15298 days from today's date. If the deadline appears in an entry marked DONE,
15299 it is not shown. The prefix arg NDAYS can be used to test that many
15301 (interactive "P")
15302 (let* ((org-warn-days
15303 (cond
15304 ((equal ndays '(4)) 100000)
15305 (ndays (prefix-numeric-value ndays))
15306 (t (abs org-deadline-warning-days))))
15307 (case-fold-search nil)
15309 (callback
15310 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15312 (message "%d deadlines past-due or due within %d days"
15313 (org-occur regexp nil callback)
15314 org-warn-days)))
15316 (defun org-check-before-date (date)
15317 "Check if there are deadlines or scheduled entries before DATE."
15318 (interactive (list (org-read-date)))
15319 (let ((case-fold-search nil)
15323 (callback
15324 (lambda () (time-less-p
15325 (org-time-string-to-time (match-string 2))
15326 (org-time-string-to-time date)))))
15327 (message "%d entries before %s"
15328 (org-occur regexp nil callback) date)))
15330 (defun org-check-after-date (date)
15331 "Check if there are deadlines or scheduled entries after DATE."
15332 (interactive (list (org-read-date)))
15333 (let ((case-fold-search nil)
15337 (callback
15338 (lambda () (not
15339 (time-less-p
15340 (org-time-string-to-time (match-string 2))
15341 (org-time-string-to-time date))))))
15342 (message "%d entries after %s"
15343 (org-occur regexp nil callback) date)))
15345 (defun org-evaluate-time-range (&optional to-buffer)
15346 "Evaluate a time range by computing the difference between start and end.
15347 Normally the result is just printed in the echo area, but with prefix arg
15348 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15349 If the time range is actually in a table, the result is inserted into the
15350 next column.
15351 For time difference computation, a year is assumed to be exactly 365
15352 days in order to avoid rounding problems."
15353 (interactive "P")
15354 (or
15355 (org-clock-update-time-maybe)
15356 (save-excursion
15357 (unless (org-at-date-range-p t)
15358 (goto-char (point-at-bol))
15359 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15360 (if (not (org-at-date-range-p t))
15361 (error "Not at a time-stamp range, and none found in current line")))
15362 (let* ((ts1 (match-string 1))
15363 (ts2 (match-string 2))
15364 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15365 (match-end (match-end 0))
15366 (time1 (org-time-string-to-time ts1))
15367 (time2 (org-time-string-to-time ts2))
15368 (t1 (org-float-time time1))
15369 (t2 (org-float-time time2))
15370 (diff (abs (- t2 t1)))
15371 (negative (< (- t2 t1) 0))
15372 ;; (ys (floor (* 365 24 60 60)))
15373 (ds (* 24 60 60))
15374 (hs (* 60 60))
15375 (fy "%dy %dd %02d:%02d")
15376 (fy1 "%dy %dd")
15377 (fd "%dd %02d:%02d")
15378 (fd1 "%dd")
15379 (fh "%02d:%02d")
15380 y d h m align)
15381 (if havetime
15382 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15383 y 0
15384 d (floor (/ diff ds)) diff (mod diff ds)
15385 h (floor (/ diff hs)) diff (mod diff hs)
15386 m (floor (/ diff 60)))
15387 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15388 y 0
15389 d (floor (+ (/ diff ds) 0.5))
15390 h 0 m 0))
15391 (if (not to-buffer)
15392 (message "%s" (org-make-tdiff-string y d h m))
15393 (if (org-at-table-p)
15394 (progn
15395 (goto-char match-end)
15396 (setq align t)
15397 (and (looking-at " *|") (goto-char (match-end 0))))
15398 (goto-char match-end))
15399 (if (looking-at
15401 (replace-match ""))
15402 (if negative (insert " -"))
15403 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15404 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15405 (insert " " (format fh h m))))
15406 (if align (org-table-align))
15407 (message "Time difference inserted")))))
15409 (defun org-make-tdiff-string (y d h m)
15410 (let ((fmt "")
15411 (l nil))
15412 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15413 l (push y l)))
15414 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15415 l (push d l)))
15416 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15417 l (push h l)))
15418 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15419 l (push m l)))
15420 (apply 'format fmt (nreverse l))))
15422 (defun org-time-string-to-time (s)
15423 (apply 'encode-time (org-parse-time-string s)))
15424 (defun org-time-string-to-seconds (s)
15425 (org-float-time (org-time-string-to-time s)))
15427 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15428 "Convert a time stamp to an absolute day number.
15429 If there is a specifier for a cyclic time stamp, get the closest date to
15430 DAYNR.
15431 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15432 The variable date is bound by the calendar when this is called."
15433 (cond
15435 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15436 daynr
15437 (+ daynr 1000)))
15439 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15440 (time-to-days (current-time))) (match-string 0 s)
15441 prefer show-all))
15442 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15444 (defun org-days-to-iso-week (days)
15445 "Return the iso week number."
15446 (require 'cal-iso)
15447 (car (calendar-iso-from-absolute days)))
15449 (defun org-small-year-to-year (year)
15450 "Convert 2-digit years into 4-digit years.
15451 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15452 The year 2000 cannot be abbreviated. Any year larger than 99
15453 is returned unchanged."
15454 (if (< year 38)
15455 (setq year (+ 2000 year))
15456 (if (< year 100)
15457 (setq year (+ 1900 year))))
15458 year)
15460 (defun org-time-from-absolute (d)
15461 "Return the time corresponding to date D.
15462 D may be an absolute day number, or a calendar-type list (month day year)."
15463 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15464 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15466 (defun org-calendar-holiday ()
15467 "List of holidays, for Diary display in Org-mode."
15468 (require 'holidays)
15469 (let ((hl (funcall
15470 (if (fboundp 'calendar-check-holidays)
15471 'calendar-check-holidays 'check-calendar-holidays) date)))
15472 (if hl (mapconcat 'identity hl "; "))))
15474 (defun org-diary-sexp-entry (sexp entry date)
15475 "Process a SEXP diary ENTRY for DATE."
15476 (require 'diary-lib)
15477 (let ((result (if calendar-debug-sexp
15478 (let ((stack-trace-on-error t))
15479 (eval (car (read-from-string sexp))))
15480 (condition-case nil
15481 (eval (car (read-from-string sexp)))
15482 (error
15483 (beep)
15484 (message "Bad sexp at line %d in %s: %s"
15485 (org-current-line)
15486 (buffer-file-name) sexp)
15487 (sleep-for 2))))))
15488 (cond ((stringp result) (split-string result "; "))
15489 ((and (consp result)
15490 (not (consp (cdr result)))
15491 (stringp (cdr result))) (cdr result))
15492 ((and (consp result)
15493 (stringp (car result))) result)
15494 (result entry)
15495 (t nil))))
15497 (defun org-diary-to-ical-string (frombuf)
15498 "Get iCalendar entries from diary entries in buffer FROMBUF.
15499 This uses the icalendar.el library."
15500 (let* ((tmpdir (if (featurep 'xemacs)
15501 (temp-directory)
15502 temporary-file-directory))
15503 (tmpfile (make-temp-name
15504 (expand-file-name "orgics" tmpdir)))
15505 buf rtn b e)
15506 (with-current-buffer frombuf
15507 (icalendar-export-region (point-min) (point-max) tmpfile)
15508 (setq buf (find-buffer-visiting tmpfile))
15509 (set-buffer buf)
15510 (goto-char (point-min))
15511 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15512 (setq b (match-beginning 0)))
15513 (goto-char (point-max))
15514 (if (re-search-backward "^END:VEVENT" nil t)
15515 (setq e (match-end 0)))
15517 (kill-buffer buf)
15518 (delete-file tmpfile)
15519 rtn))
15521 (defun org-closest-date (start current change prefer show-all)
15522 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15523 When PREFER is `past', return a date that is either CURRENT or past.
15524 When PREFER is `future', return a date that is either CURRENT or future.
15525 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15526 ;; Make the proper lists from the dates
15527 (catch 'exit
15528 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15529 dn dw sday cday n1 n2 n0
15530 d m y y1 y2 date1 date2 nmonths nm ny m2)
15532 (setq start (org-date-to-gregorian start)
15533 current (org-date-to-gregorian
15534 (if show-all
15535 current
15536 (time-to-days (current-time))))
15537 sday (calendar-absolute-from-gregorian start)
15538 cday (calendar-absolute-from-gregorian current))
15540 (if (<= cday sday) (throw 'exit sday))
15543 (setq dn (string-to-number (match-string 1 change))
15544 dw (cdr (assoc (match-string 2 change) a1)))
15545 (error "Invalid change specifier: %s" change))
15546 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15547 (cond
15548 ((eq dw 'day)
15549 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15550 n2 (+ n1 dn)))
15551 ((eq dw 'year)
15552 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15553 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15554 (setq date1 (list m d y1)
15555 n1 (calendar-absolute-from-gregorian date1)
15556 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15557 n2 (calendar-absolute-from-gregorian date2)))
15558 ((eq dw 'month)
15559 ;; approx number of month between the two dates
15560 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15561 ;; How often does dn fit in there?
15562 (setq d (nth 1 start) m (car start) y (nth 2 start)
15563 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15564 m (+ m nm)
15565 ny (floor (/ m 12))
15566 y (+ y ny)
15567 m (- m (* ny 12)))
15568 (while (> m 12) (setq m (- m 12) y (1+ y)))
15569 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15570 (setq m2 (+ m dn) y2 y)
15571 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15572 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15573 (while (<= n2 cday)
15574 (setq n1 n2 m m2 y y2)
15575 (setq m2 (+ m dn) y2 y)
15576 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15577 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15578 ;; Make sure n1 is the earlier date
15579 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15580 (if show-all
15581 (cond
15582 ((eq prefer 'past) (if (= cday n2) n2 n1))
15583 ((eq prefer 'future) (if (= cday n1) n1 n2))
15584 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15585 (cond
15586 ((eq prefer 'past) (if (= cday n2) n2 n1))
15587 ((eq prefer 'future) (if (= cday n1) n1 n2))
15588 (t (if (= cday n1) n1 n2)))))))
15590 (defun org-date-to-gregorian (date)
15591 "Turn any specification of DATE into a Gregorian date for the calendar."
15592 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15593 ((and (listp date) (= (length date) 3)) date)
15594 ((stringp date)
15595 (setq date (org-parse-time-string date))
15596 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15597 ((listp date)
15598 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15600 (defun org-parse-time-string (s &optional nodefault)
15601 "Parse the standard Org-mode time string.
15602 This should be a lot faster than the normal `parse-time-string'.
15603 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15604 hour and minute fields will be nil if not given."
15605 (if (string-match org-ts-regexp0 s)
15606 (list 0
15607 (if (or (match-beginning 8) (not nodefault))
15608 (string-to-number (or (match-string 8 s) "0")))
15609 (if (or (match-beginning 7) (not nodefault))
15610 (string-to-number (or (match-string 7 s) "0")))
15611 (string-to-number (match-string 4 s))
15612 (string-to-number (match-string 3 s))
15613 (string-to-number (match-string 2 s))
15614 nil nil nil)
15615 (error "Not a standard Org-mode time string: %s" s)))
15617 (defun org-timestamp-up (&optional arg)
15618 "Increase the date item at the cursor by one.
15619 If the cursor is on the year, change the year. If it is on the month,
15620 the day or the time, change that.
15621 With prefix ARG, change by that many units."
15622 (interactive "p")
15623 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15625 (defun org-timestamp-down (&optional arg)
15626 "Decrease the date item at the cursor by one.
15627 If the cursor is on the year, change the year. If it is on the month,
15628 the day or the time, change that.
15629 With prefix ARG, change by that many units."
15630 (interactive "p")
15631 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15633 (defun org-timestamp-up-day (&optional arg)
15634 "Increase the date in the time stamp by one day.
15635 With prefix ARG, change that many days."
15636 (interactive "p")
15637 (if (and (not (org-at-timestamp-p t))
15638 (org-on-heading-p))
15639 (org-todo 'up)
15640 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15642 (defun org-timestamp-down-day (&optional arg)
15643 "Decrease the date in the time stamp by one day.
15644 With prefix ARG, change that many days."
15645 (interactive "p")
15646 (if (and (not (org-at-timestamp-p t))
15647 (org-on-heading-p))
15648 (org-todo 'down)
15649 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15651 (defun org-at-timestamp-p (&optional inactive-ok)
15652 "Determine if the cursor is in or at a timestamp."
15653 (interactive)
15654 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15655 (pos (point))
15656 (ans (or (looking-at tsr)
15657 (save-excursion
15659 (if (> (point) (point-min)) (backward-char 1))
15660 (and (looking-at tsr)
15661 (> (- (match-end 0) pos) -1))))))
15662 (and ans
15663 (boundp 'org-ts-what)
15664 (setq org-ts-what
15665 (cond
15666 ((= pos (match-beginning 0)) 'bracket)
15667 ;; Point is considered to be "on the bracket" whether
15668 ;; it's really on it or right after it.
15669 ((or (= pos (1- (match-end 0)))
15670 (= pos (match-end 0))) 'bracket)
15671 ((org-pos-in-match-range pos 2) 'year)
15672 ((org-pos-in-match-range pos 3) 'month)
15673 ((org-pos-in-match-range pos 7) 'hour)
15674 ((org-pos-in-match-range pos 8) 'minute)
15675 ((or (org-pos-in-match-range pos 4)
15676 (org-pos-in-match-range pos 5)) 'day)
15677 ((and (> pos (or (match-end 8) (match-end 5)))
15678 (< pos (match-end 0)))
15679 (- pos (or (match-end 8) (match-end 5))))
15680 (t 'day))))
15681 ans))
15683 (defun org-toggle-timestamp-type ()
15684 "Toggle the type (<active> or [inactive]) of a time stamp."
15685 (interactive)
15686 (when (org-at-timestamp-p t)
15687 (let ((beg (match-beginning 0)) (end (match-end 0))
15688 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15689 (save-excursion
15690 (goto-char beg)
15691 (while (re-search-forward "[][<>]" end t)
15692 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15693 t t)))
15694 (message "Timestamp is now %sactive"
15695 (if (equal (char-after beg) ?<) "" "in")))))
15697 (defun org-timestamp-change (n &optional what updown)
15698 "Change the date in the time stamp at point.
15699 The date will be changed by N times WHAT. WHAT can be `day', `month',
15700 `year', `minute', `second'. If WHAT is not given, the cursor position
15701 in the timestamp determines what will be changed."
15702 (let ((origin (point)) origin-cat
15703 with-hm inactive
15704 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15705 org-ts-what
15706 extra rem
15707 ts time time0)
15708 (if (not (org-at-timestamp-p t))
15709 (error "Not at a timestamp"))
15710 (if (and (not what) (eq org-ts-what 'bracket))
15711 (org-toggle-timestamp-type)
15712 ;; Point isn't on brackets. Remember the part of the time-stamp
15713 ;; the point was in. Indeed, size of time-stamps may change,
15714 ;; but point must be kept in the same category nonetheless.
15715 (setq origin-cat org-ts-what)
15716 (if (and (not what) (not (eq org-ts-what 'day))
15717 org-display-custom-times
15718 (get-text-property (point) 'display)
15719 (not (get-text-property (1- (point)) 'display)))
15720 (setq org-ts-what 'day))
15721 (setq org-ts-what (or what org-ts-what)
15722 inactive (= (char-after (match-beginning 0)) ?\[)
15723 ts (match-string 0))
15724 (replace-match "")
15725 (if (string-match
15727 ts)
15728 (setq extra (match-string 1 ts)))
15730 (setq with-hm t))
15731 (setq time0 (org-parse-time-string ts))
15732 (when (and updown
15733 (eq org-ts-what 'minute)
15734 (not current-prefix-arg))
15735 ;; This looks like s-up and s-down. Change by one rounding step.
15736 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15737 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15738 (setcar (cdr time0) (+ (nth 1 time0)
15739 (if (> n 0) (- rem) (- dm rem))))))
15740 (setq time
15741 (encode-time (or (car time0) 0)
15742 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15743 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15744 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15745 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15746 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15747 (nthcdr 6 time0)))
15748 (when (and (member org-ts-what '(hour minute))
15749 extra
15751 (setq extra (org-modify-ts-extra
15752 extra
15753 (if (eq org-ts-what 'hour) 2 5)
15754 n dm)))
15755 (when (integerp org-ts-what)
15756 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15757 (if (eq what 'calendar)
15758 (let ((cal-date (org-get-date-from-calendar)))
15759 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15760 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15761 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15762 (setcar time0 (or (car time0) 0))
15763 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15764 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15765 (setq time (apply 'encode-time time0))))
15766 ;; Insert the new time-stamp, and ensure point stays in the same
15767 ;; category as before (i.e. not after the last position in that
15768 ;; category).
15769 (let ((pos (point)))
15770 ;; Stay before inserted string. `save-excursion' is of no use.
15771 (setq org-last-changed-timestamp
15772 (org-insert-time-stamp time with-hm inactive nil nil extra))
15773 (goto-char pos))
15774 (save-match-data
15775 (looking-at org-ts-regexp3)
15776 (goto-char (cond
15777 ;; `day' category ends before `hour' if any, or at
15778 ;; the end of the day name.
15779 ((eq origin-cat 'day)
15780 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15781 ((eq origin-cat 'hour) (min (match-end 7) origin))
15782 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15783 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15784 ;; `year' and `month' have both fixed size: point
15785 ;; couldn't have moved into another part.
15786 (t origin))))
15787 ;; Update clock if on a CLOCK line.
15788 (org-clock-update-time-maybe)
15789 ;; Try to recenter the calendar window, if any.
15790 (if (and org-calendar-follow-timestamp-change
15791 (get-buffer-window "*Calendar*" t)
15792 (memq org-ts-what '(day month year)))
15793 (org-recenter-calendar (time-to-days time))))))
15795 (defun org-modify-ts-extra (s pos n dm)
15796 "Change the different parts of the lead-time and repeat fields in timestamp."
15797 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15798 ng h m new rem)
15799 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15800 (cond
15801 ((or (org-pos-in-match-range pos 2)
15802 (org-pos-in-match-range pos 3))
15803 (setq m (string-to-number (match-string 3 s))
15804 h (string-to-number (match-string 2 s)))
15805 (if (org-pos-in-match-range pos 2)
15806 (setq h (+ h n))
15807 (setq n (* dm (org-no-warnings (signum n))))
15808 (when (not (= 0 (setq rem (% m dm))))
15809 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15810 (setq m (+ m n)))
15811 (if (< m 0) (setq m (+ m 60) h (1- h)))
15812 (if (> m 59) (setq m (- m 60) h (1+ h)))
15813 (setq h (min 24 (max 0 h)))
15814 (setq ng 1 new (format "-%02d:%02d" h m)))
15815 ((org-pos-in-match-range pos 6)
15816 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15817 ((org-pos-in-match-range pos 5)
15818 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15820 ((org-pos-in-match-range pos 9)
15821 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15822 ((org-pos-in-match-range pos 8)
15823 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15825 (when ng
15826 (setq s (concat
15827 (substring s 0 (match-beginning ng))
15828 new
15829 (substring s (match-end ng))))))
15830 s))
15832 (defun org-recenter-calendar (date)
15833 "If the calendar is visible, recenter it to DATE."
15834 (let* ((win (selected-window))
15835 (cwin (get-buffer-window "*Calendar*" t))
15836 (calendar-move-hook nil))
15837 (when cwin
15838 (select-window cwin)
15839 (calendar-goto-date (if (listp date) date
15840 (calendar-gregorian-from-absolute date)))
15841 (select-window win))))
15843 (defun org-goto-calendar (&optional arg)
15844 "Go to the Emacs calendar at the current date.
15845 If there is a time stamp in the current line, go to that date.
15846 A prefix ARG can be used to force the current date."
15847 (interactive "P")
15848 (let ((tsr org-ts-regexp) diff
15849 (calendar-move-hook nil)
15850 (calendar-view-holidays-initially-flag nil)
15851 (calendar-view-diary-initially-flag nil))
15852 (if (or (org-at-timestamp-p)
15853 (save-excursion
15854 (beginning-of-line 1)
15855 (looking-at (concat ".*" tsr))))
15856 (let ((d1 (time-to-days (current-time)))
15857 (d2 (time-to-days
15858 (org-time-string-to-time (match-string 1)))))
15859 (setq diff (- d2 d1))))
15860 (calendar)
15861 (calendar-goto-today)
15862 (if (and diff (not arg)) (calendar-forward-day diff))))
15864 (defun org-get-date-from-calendar ()
15865 "Return a list (month day year) of date at point in calendar."
15866 (with-current-buffer "*Calendar*"
15867 (save-match-data
15868 (calendar-cursor-to-date))))
15870 (defun org-date-from-calendar ()
15871 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15872 If there is already a time stamp at the cursor position, update it."
15873 (interactive)
15874 (if (org-at-timestamp-p t)
15875 (org-timestamp-change 0 'calendar)
15876 (let ((cal-date (org-get-date-from-calendar)))
15877 (org-insert-time-stamp
15878 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15880 (defun org-minutes-to-hh:mm-string (m)
15881 "Compute H:MM from a number of minutes."
15882 (let ((h (/ m 60)))
15883 (setq m (- m (* 60 h)))
15884 (format org-time-clocksum-format h m)))
15886 (defun org-hh:mm-string-to-minutes (s)
15887 "Convert a string H:MM to a number of minutes.
15888 If the string is just a number, interpret it as minutes.
15889 In fact, the first hh:mm or number in the string will be taken,
15890 there can be extra stuff in the string.
15891 If no number is found, the return value is 0."
15892 (cond
15893 ((integerp s) s)
15895 (+ (* (string-to-number (match-string 1 s)) 60)
15896 (string-to-number (match-string 2 s))))
15898 (string-to-number (match-string 1 s)))
15899 (t 0)))
15901 (defcustom org-effort-durations
15902 `(("h" . 60)
15903 ("d" . ,(* 60 8))
15904 ("w" . ,(* 60 8 5))
15905 ("m" . ,(* 60 8 5 4))
15906 ("y" . ,(* 60 8 5 40)))
15907 "Conversion factor to minutes for an effort modifier.
15909 Each entry has the form (MODIFIER . MINUTES).
15911 In an effort string, a number followed by MODIFIER is multiplied
15912 by the specified number of MINUTES to obtain an effort in
15913 minutes.
15917 :group 'org-agenda
15918 :type '(alist :key-type (string :tag "Modifier")
15919 :value-type (number :tag "Minutes")))
15921 (defun org-duration-string-to-minutes (s)
15922 "Convert a duration string S to minutes.
15924 A bare number is interpreted as minutes, modifiers can be set by
15925 customizing `org-effort-durations' (which see).
15927 Entries containing a colon are interpreted as H:MM by
15928 `org-hh:mm-string-to-minutes'."
15929 (let ((result 0)
15931 (regexp-opt (mapcar 'car org-effort-durations))
15933 (while (string-match re s)
15934 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15935 (string-to-number (match-string 1 s))))
15936 (setq s (replace-match "" nil t s)))
15937 (incf result (org-hh:mm-string-to-minutes s))
15938 result))
15940 ;;;; Files
15942 (defun org-save-all-org-buffers ()
15943 "Save all Org-mode buffers without user confirmation."
15944 (interactive)
15945 (message "Saving all Org-mode buffers...")
15946 (save-some-buffers t 'org-mode-p)
15947 (when (featurep 'org-id) (org-id-locations-save))
15948 (message "Saving all Org-mode buffers... done"))
15950 (defun org-revert-all-org-buffers ()
15951 "Revert all Org-mode buffers.
15952 Prompt for confirmation when there are unsaved changes.
15953 Be sure you know what you are doing before letting this function
15954 overwrite your changes.
15956 This function is useful in a setup where one tracks org files
15957 with a version control system, to revert on one machine after pulling
15958 changes from another. I believe the procedure must be like this:
15960 1. M-x org-save-all-org-buffers
15961 2. Pull changes from the other machine, resolve conflicts
15962 3. M-x org-revert-all-org-buffers"
15963 (interactive)
15964 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15965 (error "Abort"))
15966 (save-excursion
15967 (save-window-excursion
15968 (mapc
15969 (lambda (b)
15970 (when (and (with-current-buffer b (org-mode-p))
15971 (with-current-buffer b buffer-file-name))
15972 (org-pop-to-buffer-same-window b)
15973 (revert-buffer t 'no-confirm)))
15974 (buffer-list))
15975 (when (and (featurep 'org-id) org-id-track-globally)
15976 (org-id-locations-load)))))
15978 ;;;; Agenda files
15980 ;;;###autoload
15981 (defun org-switchb (&optional arg)
15982 "Switch between Org buffers.
15983 With a prefix argument, restrict available to files.
15984 With two prefix arguments, restrict available buffers to agenda files.
15986 Defaults to `iswitchb' for buffer name completion.
15987 Set `org-completion-use-ido' to make it use ido instead."
15988 (interactive "P")
15989 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15990 ((equal arg '(16)) (org-buffer-list 'agenda))
15991 (t (org-buffer-list))))
15992 (org-completion-use-iswitchb org-completion-use-iswitchb)
15993 (org-completion-use-ido org-completion-use-ido))
15994 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15995 (setq org-completion-use-iswitchb t))
15996 (org-pop-to-buffer-same-window
15997 (org-icompleting-read "Org buffer: "
15998 (mapcar 'list (mapcar 'buffer-name blist))
15999 nil t))))
16001 ;;; Define some older names previously used for this functionality
16002 ;;;###autoload
16003 (defalias 'org-ido-switchb 'org-switchb)
16004 ;;;###autoload
16005 (defalias 'org-iswitchb 'org-switchb)
16007 (defun org-buffer-list (&optional predicate exclude-tmp)
16008 "Return a list of Org buffers.
16009 PREDICATE can be `export', `files' or `agenda'.
16011 export restrict the list to Export buffers.
16012 files restrict the list to buffers visiting Org files.
16013 agenda restrict the list to buffers visiting agenda files.
16015 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16016 (let* ((bfn nil)
16017 (agenda-files (and (eq predicate 'agenda)
16018 (mapcar 'file-truename (org-agenda-files t))))
16019 (filter
16020 (cond
16021 ((eq predicate 'files)
16022 (lambda (b) (with-current-buffer b (org-mode-p))))
16023 ((eq predicate 'export)
16024 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16025 ((eq predicate 'agenda)
16026 (lambda (b)
16027 (with-current-buffer b
16028 (and (org-mode-p)
16029 (setq bfn (buffer-file-name b))
16030 (member (file-truename bfn) agenda-files)))))
16031 (t (lambda (b) (with-current-buffer b
16032 (or (org-mode-p)
16033 (string-match "\*Org .*Export"
16034 (buffer-name b)))))))))
16035 (delq nil
16036 (mapcar
16037 (lambda(b)
16038 (if (and (funcall filter b)
16039 (or (not exclude-tmp)
16040 (not (string-match "tmp" (buffer-name b)))))
16041 b
16042 nil))
16043 (buffer-list)))))
16045 (defun org-agenda-files (&optional unrestricted archives)
16046 "Get the list of agenda files.
16047 Optional UNRESTRICTED means return the full list even if a restriction
16048 is currently in place.
16049 When ARCHIVES is t, include all archive files that are really being
16050 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16051 `org-agenda-archives-mode' is t."
16052 (let ((files
16053 (cond
16054 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16055 ((stringp org-agenda-files) (org-read-agenda-file-list))
16056 ((listp org-agenda-files) org-agenda-files)
16057 (t (error "Invalid value of `org-agenda-files'")))))
16058 (setq files (apply 'append
16059 (mapcar (lambda (f)
16060 (if (file-directory-p f)
16061 (directory-files
16062 f t org-agenda-file-regexp)
16063 (list f)))
16064 files)))
16065 (when org-agenda-skip-unavailable-files
16066 (setq files (delq nil
16067 (mapcar (function
16068 (lambda (file)
16069 (and (file-readable-p file) file)))
16070 files))))
16071 (when (or (eq archives t)
16072 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16073 (setq files (org-add-archive-files files)))
16074 files))
16076 (defun org-agenda-file-p (&optional file)
16077 "Return non-nil, if FILE is an agenda file.
16078 If FILE is omitted, use the file associated with the current
16079 buffer."
16080 (member (or file (buffer-file-name))
16081 (org-agenda-files t)))
16083 (defun org-edit-agenda-file-list ()
16084 "Edit the list of agenda files.
16085 Depending on setup, this either uses customize to edit the variable
16086 `org-agenda-files', or it visits the file that is holding the list. In the
16087 latter case, the buffer is set up in a way that saving it automatically kills
16088 the buffer and restores the previous window configuration."
16089 (interactive)
16090 (if (stringp org-agenda-files)
16091 (let ((cw (current-window-configuration)))
16092 (find-file org-agenda-files)
16093 (org-set-local 'org-window-configuration cw)
16094 (org-add-hook 'after-save-hook
16095 (lambda ()
16096 (set-window-configuration
16097 (prog1 org-window-configuration
16098 (kill-buffer (current-buffer))))
16099 (org-install-agenda-files-menu)
16100 (message "New agenda file list installed"))
16101 nil 'local)
16102 (message "%s" (substitute-command-keys
16104 (customize-variable 'org-agenda-files)))
16106 (defun org-store-new-agenda-file-list (list)
16107 "Set new value for the agenda file list and save it correctly."
16108 (if (stringp org-agenda-files)
16109 (let ((fe (org-read-agenda-file-list t)) b u)
16110 (while (setq b (find-buffer-visiting org-agenda-files))
16111 (kill-buffer b))
16112 (with-temp-file org-agenda-files
16113 (insert
16114 (mapconcat
16115 (lambda (f) ;; Keep un-expanded entries.
16116 (if (setq u (assoc f fe))
16117 (cdr u)
16118 f))
16121 (let ((org-mode-hook nil) (org-inhibit-startup t)
16122 (org-insert-mode-line-in-empty-file nil))
16123 (setq org-agenda-files list)
16124 (customize-save-variable 'org-agenda-files org-agenda-files))))
16126 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16127 "Read the list of agenda files from a file.
16128 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16129 filenames, used by `org-store-new-agenda-file-list' to write back
16130 un-expanded file names."
16131 (when (file-directory-p org-agenda-files)
16132 (error "`org-agenda-files' cannot be a single directory"))
16133 (when (stringp org-agenda-files)
16134 (with-temp-buffer
16135 (insert-file-contents org-agenda-files)
16136 (mapcar
16137 (lambda (f)
16138 (let ((e (expand-file-name (substitute-in-file-name f)
16139 org-directory)))
16140 (if pair-with-expansion
16141 (cons e f)
16142 e)))
16145 ;;;###autoload
16146 (defun org-cycle-agenda-files ()
16147 "Cycle through the files in `org-agenda-files'.
16148 If the current buffer visits an agenda file, find the next one in the list.
16149 If the current buffer does not, find the first agenda file."
16150 (interactive)
16151 (let* ((fs (org-agenda-files t))
16152 (files (append fs (list (car fs))))
16153 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16154 file)
16155 (unless files (error "No agenda files"))
16156 (catch 'exit
16157 (while (setq file (pop files))
16158 (if (equal (file-truename file) tcf)
16159 (when (car files)
16160 (find-file (car files))
16161 (throw 'exit t))))
16162 (find-file (car fs)))
16163 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16165 (defun org-agenda-file-to-front (&optional to-end)
16166 "Move/add the current file to the top of the agenda file list.
16167 If the file is not present in the list, it is added to the front. If it is
16168 present, it is moved there. With optional argument TO-END, add/move to the
16169 end of the list."
16170 (interactive "P")
16171 (let ((org-agenda-skip-unavailable-files nil)
16172 (file-alist (mapcar (lambda (x)
16173 (cons (file-truename x) x))
16174 (org-agenda-files t)))
16175 (ctf (file-truename buffer-file-name))
16176 x had)
16177 (setq x (assoc ctf file-alist) had x)
16179 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16180 (if to-end
16181 (setq file-alist (append (delq x file-alist) (list x)))
16182 (setq file-alist (cons x (delq x file-alist))))
16183 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16184 (org-install-agenda-files-menu)
16185 (message "File %s to %s of agenda file list"
16186 (if had "moved" "added") (if to-end "end" "front"))))
16188 (defun org-remove-file (&optional file)
16189 "Remove current file from the list of files in variable `org-agenda-files'.
16190 These are the files which are being checked for agenda entries.
16191 Optional argument FILE means use this file instead of the current."
16192 (interactive)
16193 (let* ((org-agenda-skip-unavailable-files nil)
16194 (file (or file buffer-file-name))
16195 (true-file (file-truename file))
16196 (afile (abbreviate-file-name file))
16197 (files (delq nil (mapcar
16198 (lambda (x)
16199 (if (equal true-file
16200 (file-truename x))
16201 nil x))
16202 (org-agenda-files t)))))
16203 (if (not (= (length files) (length (org-agenda-files t))))
16204 (progn
16205 (org-store-new-agenda-file-list files)
16206 (org-install-agenda-files-menu)
16207 (message "Removed file: %s" afile))
16208 (message "File was not in list: %s (not removed)" afile))))
16210 (defun org-file-menu-entry (file)
16211 (vector file (list 'find-file file) t))
16213 (defun org-check-agenda-file (file)
16214 "Make sure FILE exists. If not, ask user what to do."
16215 (when (not (file-exists-p file))
16216 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16217 (abbreviate-file-name file))
16218 (let ((r (downcase (read-char-exclusive))))
16219 (cond
16220 ((equal r ?r)
16221 (org-remove-file file)
16222 (throw 'nextfile t))
16223 (t (error "Abort"))))))
16225 (defun org-get-agenda-file-buffer (file)
16226 "Get a buffer visiting FILE. If the buffer needs to be created, add
16227 it to the list of buffers which might be released later."
16228 (let ((buf (org-find-base-buffer-visiting file)))
16229 (if buf
16230 buf ; just return it
16231 ;; Make a new buffer and remember it
16232 (setq buf (find-file-noselect file))
16233 (if buf (push buf org-agenda-new-buffers))
16234 buf)))
16236 (defun org-release-buffers (blist)
16237 "Release all buffers in list, asking the user for confirmation when needed.
16238 When a buffer is unmodified, it is just killed. When modified, it is saved
16239 \(if the user agrees) and then killed."
16240 (let (buf file)
16241 (while (setq buf (pop blist))
16242 (setq file (buffer-file-name buf))
16243 (when (and (buffer-modified-p buf)
16244 file
16245 (y-or-n-p (format "Save file %s? " file)))
16246 (with-current-buffer buf (save-buffer)))
16247 (kill-buffer buf))))
16249 (defun org-prepare-agenda-buffers (files)
16250 "Create buffers for all agenda files, protect archived trees and comments."
16251 (interactive)
16252 (let ((pa '(:org-archived t))
16253 (pc '(:org-comment t))
16254 (pall '(:org-archived t :org-comment t))
16255 (inhibit-read-only t)
16256 (rea (concat ":" org-archive-tag ":"))
16257 bmp file re)
16258 (save-excursion
16259 (save-restriction
16260 (while (setq file (pop files))
16261 (catch 'nextfile
16262 (if (bufferp file)
16263 (set-buffer file)
16264 (org-check-agenda-file file)
16265 (set-buffer (org-get-agenda-file-buffer file)))
16266 (widen)
16267 (setq bmp (buffer-modified-p))
16268 (org-refresh-category-properties)
16269 (setq org-todo-keywords-for-agenda
16270 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16271 (setq org-done-keywords-for-agenda
16272 (append org-done-keywords-for-agenda org-done-keywords))
16273 (setq org-todo-keyword-alist-for-agenda
16274 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16275 (setq org-drawers-for-agenda
16276 (append org-drawers-for-agenda org-drawers))
16277 (setq org-tag-alist-for-agenda
16278 (append org-tag-alist-for-agenda org-tag-alist))
16280 (save-excursion
16281 (remove-text-properties (point-min) (point-max) pall)
16282 (when org-agenda-skip-archived-trees
16283 (goto-char (point-min))
16284 (while (re-search-forward rea nil t)
16285 (if (org-on-heading-p t)
16286 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16287 (goto-char (point-min))
16289 (while (re-search-forward re nil t)
16290 (add-text-properties
16291 (match-beginning 0) (org-end-of-subtree t) pc)))
16292 (set-buffer-modified-p bmp)))))
16293 (setq org-todo-keywords-for-agenda
16294 (org-uniquify org-todo-keywords-for-agenda))
16295 (setq org-todo-keyword-alist-for-agenda
16296 (org-uniquify org-todo-keyword-alist-for-agenda)
16297 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16299 ;;;; Embedded LaTeX
16301 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16302 "Keymap for the minor `org-cdlatex-mode'.")
16304 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16305 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16306 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16307 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16308 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16310 (defvar org-cdlatex-texmathp-advice-is-done nil
16311 "Flag remembering if we have applied the advice to texmathp already.")
16313 (define-minor-mode org-cdlatex-mode
16314 "Toggle the minor `org-cdlatex-mode'.
16315 This mode supports entering LaTeX environment and math in LaTeX fragments
16316 in Org-mode.
16318 nil " OCDL" nil
16319 (when org-cdlatex-mode (require 'cdlatex))
16320 (unless org-cdlatex-texmathp-advice-is-done
16321 (setq org-cdlatex-texmathp-advice-is-done t)
16322 (defadvice texmathp (around org-math-always-on activate)
16323 "Always return t in org-mode buffers.
16324 This is because we want to insert math symbols without dollars even outside
16325 the LaTeX math segments. If Orgmode thinks that point is actually inside
16326 an embedded LaTeX fragment, let texmathp do its job.
16328 (interactive)
16329 (let (p)
16330 (cond
16331 ((not (org-mode-p)) ad-do-it)
16332 ((eq this-command 'cdlatex-math-symbol)
16333 (setq ad-return-value t
16334 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16335 (t
16336 (let ((p (org-inside-LaTeX-fragment-p)))
16337 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16338 (setq ad-return-value t
16339 texmathp-why '("Org-mode embedded math" . 0))
16340 (if p ad-do-it)))))))))
16342 (defun turn-on-org-cdlatex ()
16343 "Unconditionally turn on `org-cdlatex-mode'."
16344 (org-cdlatex-mode 1))
16346 (defun org-inside-LaTeX-fragment-p ()
16347 "Test if point is inside a LaTeX fragment.
16349 sequence appearing also before point.
16350 Even though the matchers for math are configurable, this function assumes
16352 delimiters are skipped when they have been removed by customization.
16353 The return value is nil, or a cons cell with the delimiter and the
16354 position of this delimiter.
16356 This function does a reasonably good job, but can locally be fooled by
16357 for example currency specifications. For example it will assume being in
16359 fragments that are properly closed, but during editing, we have to live
16360 with the uncertainty caused by missing closing delimiters. This function
16361 looks only before point, not after."
16362 (catch 'exit
16363 (let ((pos (point))
16364 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16365 (lim (progn
16367 (point)))
16368 dd-on str (start 0) m re)
16369 (goto-char pos)
16370 (when dodollar
16372 re (nth 1 (assoc "$" org-latex-regexps)))
16373 (while (string-match re str start)
16374 (cond
16375 ((= (match-end 0) (length str))
16376 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16377 ((= (match-end 0) (- (length str) 5))
16378 (throw 'exit nil))
16379 (t (setq start (match-end 0))))))
16380 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16381 (goto-char pos)
16382 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16383 (and (match-beginning 2) (throw 'exit nil))
16384 ;; count $$
16386 (setq dd-on (not dd-on)))
16387 (goto-char pos)
16388 (if dd-on (cons "$$" m))))))
16390 (defun org-inside-latex-macro-p ()
16391 "Is point inside a LaTeX macro or its arguments?"
16392 (save-match-data
16393 (org-in-regexp
16396 (defun org-try-cdlatex-tab ()
16397 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16398 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16399 - inside a LaTeX fragment, or
16400 - after the first word in a line, where an abbreviation expansion could
16401 insert a LaTeX environment."
16402 (when org-cdlatex-mode
16403 (cond
16404 ((save-excursion
16405 (skip-chars-backward "a-zA-Z0-9*")
16407 (bolp))
16408 (cdlatex-tab) t)
16409 ((org-inside-LaTeX-fragment-p)
16410 (cdlatex-tab) t)
16411 (t nil))))
16413 (defun org-cdlatex-underscore-caret (&optional arg)
16414 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16415 Revert to the normal definition outside of these fragments."
16416 (interactive "P")
16417 (if (org-inside-LaTeX-fragment-p)
16418 (call-interactively 'cdlatex-sub-superscript)
16419 (let (org-cdlatex-mode)
16420 (call-interactively (key-binding (vector last-input-event))))))
16422 (defun org-cdlatex-math-modify (&optional arg)
16423 "Execute `cdlatex-math-modify' in LaTeX fragments.
16424 Revert to the normal definition outside of these fragments."
16425 (interactive "P")
16426 (if (org-inside-LaTeX-fragment-p)
16427 (call-interactively 'cdlatex-math-modify)
16428 (let (org-cdlatex-mode)
16429 (call-interactively (key-binding (vector last-input-event))))))
16431 (defvar org-latex-fragment-image-overlays nil
16432 "List of overlays carrying the images of latex fragments.")
16433 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16435 (defun org-remove-latex-fragment-image-overlays ()
16436 "Remove all overlays with LaTeX fragment images in current buffer."
16437 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16438 (setq org-latex-fragment-image-overlays nil))
16440 (defun org-preview-latex-fragment (&optional subtree)
16441 "Preview the LaTeX fragment at point, or all locally or globally.
16442 If the cursor is in a LaTeX fragment, create the image and overlay
16443 it over the source code. If there is no fragment at point, display
16444 all fragments in the current text, from one headline to the next. With
16445 prefix SUBTREE, display all fragments in the current subtree. With a
16447 the cursor is before the first headline,
16448 display all fragments in the buffer.
16450 (interactive "P")
16451 (org-remove-latex-fragment-image-overlays)
16452 (save-excursion
16453 (save-restriction
16454 (let (beg end at msg)
16455 (cond
16456 ((or (equal subtree '(16))
16457 (not (save-excursion
16458 (re-search-backward org-outline-regexp-bol nil t))))
16459 (setq beg (point-min) end (point-max)
16460 msg "Creating images for buffer...%s"))
16461 ((equal subtree '(4))
16462 (org-back-to-heading)
16463 (setq beg (point) end (org-end-of-subtree t)
16464 msg "Creating images for subtree...%s"))
16465 (t
16466 (if (setq at (org-inside-LaTeX-fragment-p))
16467 (goto-char (max (point-min) (- (cdr at) 2)))
16468 (org-back-to-heading))
16469 (setq beg (point) end (progn (outline-next-heading) (point))
16470 msg (if at "Creating image...%s"
16471 "Creating images for entry...%s"))))
16472 (message msg "")
16473 (narrow-to-region beg end)
16474 (goto-char beg)
16475 (org-format-latex
16476 (concat "ltxpng/" (file-name-sans-extension
16477 (file-name-nondirectory
16478 buffer-file-name)))
16479 default-directory 'overlays msg at 'forbuffer 'dvipng)
16480 (message msg "done. Use `C-c C-c' to remove images.")))))
16482 (defvar org-latex-regexps
16484 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16487 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16491 "Regular expressions for matching embedded LaTeX.")
16493 (defvar org-export-have-math nil) ;; dynamic scoping
16494 (defun org-format-latex (prefix &optional dir overlays msg at
16495 forbuffer processing-type)
16496 "Replace LaTeX fragments with links to an image, and produce images.
16497 Some of the options can be changed using the variable
16498 `org-format-latex-options'."
16499 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16500 (let* ((prefixnodir (file-name-nondirectory prefix))
16501 (absprefix (expand-file-name prefix dir))
16502 (todir (file-name-directory absprefix))
16503 (opt org-format-latex-options)
16504 (matchers (plist-get opt :matchers))
16505 (re-list org-latex-regexps)
16506 (org-format-latex-header-extra
16507 (plist-get (org-infile-export-plist) :latex-header-extra))
16508 (cnt 0) txt hash link beg end re e checkdir
16509 executables-checked string
16510 m n block linkfile movefile ov)
16511 ;; Check the different regular expressions
16512 (while (setq e (pop re-list))
16513 (setq m (car e) re (nth 1 e) n (nth 2 e)
16515 (when (member m matchers)
16516 (goto-char (point-min))
16517 (while (re-search-forward re nil t)
16518 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16519 (not (get-text-property (match-beginning n)
16520 'org-protected))
16521 (or (not overlays)
16522 (not (eq (get-char-property (match-beginning n)
16523 'org-overlay-type)
16524 'org-latex-overlay))))
16525 (setq org-export-have-math t)
16526 (cond
16527 ((eq processing-type 'verbatim)
16528 ;; Leave the text verbatim, just protect it
16529 (add-text-properties (match-beginning n) (match-end n)
16530 '(org-protected t)))
16531 ((eq processing-type 'mathjax)
16532 ;; Prepare for MathJax processing
16533 (setq string (match-string n))
16534 (if (member m '("$" "$1"))
16535 (save-excursion
16536 (delete-region (match-beginning n) (match-end n))
16537 (goto-char (match-beginning n))
16540 '(org-protected t))))
16541 (add-text-properties (match-beginning n) (match-end n)
16542 '(org-protected t))))
16543 ((or (eq processing-type 'dvipng) t)
16544 ;; Process to an image
16545 (setq txt (match-string n)
16546 beg (match-beginning n) end (match-end n)
16547 cnt (1+ cnt))
16548 (let (print-length print-level) ; make sure full list is printed
16549 (setq hash (sha1 (prin1-to-string
16550 (list org-format-latex-header
16551 org-format-latex-header-extra
16552 org-export-latex-default-packages-alist
16553 org-export-latex-packages-alist
16554 org-format-latex-options
16555 forbuffer txt)))
16556 linkfile (format "%s_%s.png" prefix hash)
16557 movefile (format "%s_%s.png" absprefix hash)))
16558 (setq link (concat block "[[file:" linkfile "]]" block))
16559 (if msg (message msg cnt))
16560 (goto-char beg)
16561 (unless checkdir ; make sure the directory exists
16562 (setq checkdir t)
16563 (or (file-directory-p todir) (make-directory todir t)))
16565 (unless executables-checked
16566 (org-check-external-command
16567 "latex" "needed to convert LaTeX fragments to images")
16568 (org-check-external-command
16569 "dvipng" "needed to convert LaTeX fragments to images")
16570 (setq executables-checked t))
16572 (unless (file-exists-p movefile)
16573 (org-create-formula-image
16574 txt movefile opt forbuffer))
16575 (if overlays
16576 (progn
16577 (mapc (lambda (o)
16578 (if (eq (overlay-get o 'org-overlay-type)
16579 'org-latex-overlay)
16580 (delete-overlay o)))
16581 (overlays-in beg end))
16582 (setq ov (make-overlay beg end))
16583 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16584 (if (featurep 'xemacs)
16585 (progn
16586 (overlay-put ov 'invisible t)
16587 (overlay-put
16588 ov 'end-glyph
16589 (make-glyph (vector 'png :file movefile))))
16590 (overlay-put
16591 ov 'display
16592 (list 'image :type 'png :file movefile :ascent 'center)))
16593 (push ov org-latex-fragment-image-overlays)
16594 (goto-char end))
16595 (delete-region beg end)
16596 (insert (org-add-props link
16597 (list 'org-latex-src
16598 (replace-regexp-in-string
16601 ;; This function borrows from Ganesh Swami's latex2png.el
16602 (defun org-create-formula-image (string tofile options buffer)
16603 "This calls dvipng."
16604 (require 'org-latex)
16605 (let* ((tmpdir (if (featurep 'xemacs)
16606 (temp-directory)
16607 temporary-file-directory))
16608 (texfilebase (make-temp-name
16609 (expand-file-name "orgtex" tmpdir)))
16610 (texfile (concat texfilebase ".tex"))
16611 (dvifile (concat texfilebase ".dvi"))
16612 (pngfile (concat texfilebase ".png"))
16613 (fnh (if (featurep 'xemacs)
16614 (font-height (get-face-font 'default))
16615 (face-attribute 'default :height nil)))
16616 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16617 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16618 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16619 "Black"))
16620 (bg (or (plist-get options (if buffer :background :html-background))
16621 "Transparent")))
16622 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16623 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16624 (with-temp-file texfile
16625 (insert (org-splice-latex-header
16626 org-format-latex-header
16627 org-export-latex-default-packages-alist
16628 org-export-latex-packages-alist t
16629 org-format-latex-header-extra))
16631 (require 'org-latex)
16632 (org-export-latex-fix-inputenc))
16633 (let ((dir default-directory))
16634 (condition-case nil
16635 (progn
16636 (cd tmpdir)
16637 (call-process "latex" nil nil nil texfile))
16638 (error nil))
16639 (cd dir))
16640 (if (not (file-exists-p dvifile))
16641 (progn (message "Failed to create dvi file from %s" texfile) nil)
16642 (condition-case nil
16643 (call-process "dvipng" nil nil nil
16644 "-fg" fg "-bg" bg
16645 "-D" dpi
16646 ;;"-x" scale "-y" scale
16647 "-T" "tight"
16648 "-o" pngfile
16649 dvifile)
16650 (error nil))
16651 (if (not (file-exists-p pngfile))
16652 (if org-format-latex-signal-error
16653 (error "Failed to create png file from %s" texfile)
16654 (message "Failed to create png file from %s" texfile)
16655 nil)
16656 ;; Use the requested file name and clean up
16657 (copy-file pngfile tofile 'replace)
16658 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16659 (delete-file (concat texfilebase e)))
16660 pngfile))))
16662 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16663 "Fill a LaTeX header template TPL.
16664 In the template, the following place holders will be recognized:
16667 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16669 [NO-PACKAGES] do not include PKG
16670 [EXTRA] the string EXTRA
16671 [NO-EXTRA] do not include EXTRA
16673 For backward compatibility, if both the positive and the negative place
16675 assumed to be present at the end of the template.
16676 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16677 EXTRA is a string.
16678 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16679 (let (rpl (end ""))
16681 (setq rpl (if (or (match-end 1) (not def-pkg))
16682 "" (org-latex-packages-to-string def-pkg snippets-p t))
16683 tpl (replace-match rpl t t tpl))
16684 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16687 (setq rpl (if (or (match-end 1) (not pkg))
16688 "" (org-latex-packages-to-string pkg snippets-p t))
16689 tpl (replace-match rpl t t tpl))
16690 (if pkg (setq end
16692 (org-latex-packages-to-string pkg snippets-p)))))
16695 (setq rpl (if (or (match-end 1) (not extra))
16697 tpl (replace-match rpl t t tpl))
16703 tpl)))
16705 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16707 (setq pkg (mapconcat (lambda(p)
16708 (cond
16709 ((stringp p) p)
16710 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16711 (format "%% Package %s omitted" (cadr p)))
16712 ((equal "" (car p))
16714 (t
16716 (car p) (cadr p)))))
16717 pkg
16721 (defun org-dvipng-color (attr)
16722 "Return an rgb color specification for dvipng."
16723 (apply 'format "rgb %s %s %s"
16724 (mapcar 'org-normalize-color
16725 (color-values (face-attribute 'default attr nil)))))
16727 (defun org-normalize-color (value)
16728 "Return string to be used as color value for an RGB component."
16729 (format "%g" (/ value 65535.0)))
16731 ;; Image display
16734 (defvar org-inline-image-overlays nil)
16735 (make-variable-buffer-local 'org-inline-image-overlays)
16737 (defun org-toggle-inline-images (&optional include-linked)
16738 "Toggle the display of inline images.
16739 INCLUDE-LINKED is passed to `org-display-inline-images'."
16740 (interactive "P")
16741 (if org-inline-image-overlays
16742 (progn
16743 (org-remove-inline-images)
16744 (message "Inline image display turned off"))
16745 (org-display-inline-images include-linked)
16746 (if org-inline-image-overlays
16747 (message "%d images displayed inline"
16748 (length org-inline-image-overlays))
16749 (message "No images to display inline"))))
16751 (defun org-display-inline-images (&optional include-linked refresh beg end)
16752 "Display inline images.
16753 Normally only links without a description part are inlined, because this
16754 is how it will work for export. When INCLUDE-LINKED is set, also links
16755 with a description part will be inlined. This can be nice for a quick
16756 look at those images, but it does not reflect what exported files will look
16757 like.
16758 When REFRESH is set, refresh existing images between BEG and END.
16759 This will create new image displays only if necessary.
16760 BEG and END default to the buffer boundaries."
16761 (interactive "P")
16762 (unless refresh
16763 (org-remove-inline-images)
16764 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16765 (save-excursion
16766 (save-restriction
16767 (widen)
16768 (setq beg (or beg (point-min)) end (or end (point-max)))
16769 (goto-char (point-min))
16771 (substring (org-image-file-name-regexp) 0 -2)
16773 old file ov img)
16774 (while (re-search-forward re end t)
16775 (setq old (get-char-property-and-overlay (match-beginning 1)
16776 'org-image-overlay))
16777 (setq file (expand-file-name
16778 (concat (or (match-string 3) "") (match-string 4))))
16779 (when (file-exists-p file)
16780 (if (and (car-safe old) refresh)
16781 (image-refresh (overlay-get (cdr old) 'display))
16782 (setq img (save-match-data (create-image file)))
16783 (when img
16784 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16785 (overlay-put ov 'display img)
16786 (overlay-put ov 'face 'default)
16787 (overlay-put ov 'org-image-overlay t)
16788 (overlay-put ov 'modification-hooks
16789 (list 'org-display-inline-modification-hook))
16790 (push ov org-inline-image-overlays)))))))))
16792 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16793 "Remove inline-display overlay if a corresponding region is modified."
16794 (let ((inhibit-modification-hooks t))
16795 (when (and ov after)
16796 (delete ov org-inline-image-overlays)
16797 (delete-overlay ov))))
16799 (defun org-remove-inline-images ()
16800 "Remove inline display of images."
16801 (interactive)
16802 (mapc 'delete-overlay org-inline-image-overlays)
16803 (setq org-inline-image-overlays nil))
16805 ;;;; Key bindings
16807 ;; Make `C-c C-x' a prefix key
16808 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16810 ;; TAB key with modifiers
16811 (org-defkey org-mode-map "\C-i" 'org-cycle)
16812 (org-defkey org-mode-map [(tab)] 'org-cycle)
16813 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16814 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16816 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16817 ;; The following line is necessary under Suse GNU/Linux
16818 (unless (featurep 'xemacs)
16819 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16820 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16821 (define-key org-mode-map [backtab] 'org-shifttab)
16823 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16824 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16825 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16827 ;; Cursor keys with modifiers
16828 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16829 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16830 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16831 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16833 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16834 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16835 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16836 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16838 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16839 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16840 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16841 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16843 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16844 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16845 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16846 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16848 ;; Babel keys
16849 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16850 (mapc (lambda (pair)
16851 (define-key org-babel-map (car pair) (cdr pair)))
16852 org-babel-key-bindings)
16854 ;;; Extra keys for tty access.
16855 ;; We only set them when really needed because otherwise the
16856 ;; menus don't show the simple keys
16858 (when (or org-use-extra-keys
16859 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16860 (not window-system))
16861 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16862 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16863 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16864 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16865 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16866 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16867 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16868 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16869 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16870 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16871 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16872 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16873 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16874 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16875 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16876 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16877 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16878 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16879 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16880 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16881 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16882 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16883 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16884 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16885 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16886 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16887 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16888 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16890 ;; All the other keys
16892 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16893 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16894 (if (boundp 'narrow-map)
16895 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16896 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16897 (if (boundp 'narrow-map)
16898 (org-defkey narrow-map "b" 'org-narrow-to-block)
16899 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16900 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16901 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16902 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16903 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16904 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16905 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16906 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16907 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16908 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16909 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16910 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16911 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16912 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16913 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16914 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16915 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16917 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16918 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16919 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16920 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16921 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16922 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16923 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16924 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16925 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16926 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16927 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16928 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16929 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16930 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16931 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16932 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16933 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16934 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16935 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16936 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16938 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16939 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16940 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16941 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16942 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16943 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16944 (org-defkey org-mode-map "\C-c^" 'org-sort)
16945 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16946 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16947 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16948 (org-defkey org-mode-map "\C-m" 'org-return)
16949 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16950 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16951 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16952 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16953 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16954 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16955 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16956 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16957 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16958 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16959 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16960 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16961 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16962 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16963 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16964 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16965 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16966 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16967 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16968 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16969 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16970 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16972 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16973 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16974 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16975 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16977 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16978 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16979 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16980 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16981 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16982 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16983 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16984 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16985 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16986 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16988 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16989 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16990 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16991 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16992 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16993 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16994 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16996 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16997 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16998 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16999 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17000 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17002 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17004 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17006 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17007 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17009 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17012 (when (featurep 'xemacs)
17013 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17016 (defconst org-speed-commands-default
17017 '(
17018 ("Outline Navigation")
17019 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17020 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17021 ("f" . (org-speed-move-safe 'org-forward-same-level))
17022 ("b" . (org-speed-move-safe 'org-backward-same-level))
17023 ("u" . (org-speed-move-safe 'outline-up-heading))
17024 ("j" . org-goto)
17025 ("g" . (org-refile t))
17026 ("Outline Visibility")
17027 ("c" . org-cycle)
17028 ("C" . org-shifttab)
17029 (" " . org-display-outline-path)
17030 ("Outline Structure Editing")
17031 ("U" . org-shiftmetaup)
17032 ("D" . org-shiftmetadown)
17033 ("r" . org-metaright)
17034 ("l" . org-metaleft)
17035 ("R" . org-shiftmetaright)
17036 ("L" . org-shiftmetaleft)
17037 ("i" . (progn (forward-char 1) (call-interactively
17038 'org-insert-heading-respect-content)))
17039 ("^" . org-sort)
17040 ("w" . org-refile)
17041 ("a" . org-archive-subtree-default-with-confirmation)
17042 ("." . org-mark-subtree)
17043 ("Clock Commands")
17044 ("I" . org-clock-in)
17045 ("O" . org-clock-out)
17046 ("Meta Data Editing")
17047 ("t" . org-todo)
17048 ("0" . (org-priority ?\ ))
17049 ("1" . (org-priority ?A))
17050 ("2" . (org-priority ?B))
17051 ("3" . (org-priority ?C))
17052 (";" . org-set-tags-command)
17053 ("e" . org-set-effort)
17054 ("Agenda Views etc")
17055 ("v" . org-agenda)
17056 ("/" . org-sparse-tree)
17057 ("Misc")
17058 ("o" . org-open-at-point)
17059 ("?" . org-speed-command-help)
17060 ("<" . (org-agenda-set-restriction-lock 'subtree))
17061 (">" . (org-agenda-remove-restriction-lock))
17062 )
17063 "The default speed commands.")
17065 (defun org-print-speed-command (e)
17066 (if (> (length (car e)) 1)
17067 (progn
17069 (princ (car e))
17071 (princ (make-string (length (car e)) ?-))
17073 (princ (car e))
17074 (princ " ")
17075 (if (symbolp (cdr e))
17076 (princ (symbol-name (cdr e)))
17077 (prin1 (cdr e)))
17080 (defun org-speed-command-help ()
17081 "Show the available speed commands."
17082 (interactive)
17083 (if (not org-use-speed-commands)
17084 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17085 (with-output-to-temp-buffer "*Help*"
17087 (mapc 'org-print-speed-command org-speed-commands-user)
17090 (mapc 'org-print-speed-command org-speed-commands-default))
17091 (with-current-buffer "*Help*"
17092 (setq truncate-lines t))))
17094 (defun org-speed-move-safe (cmd)
17095 "Execute CMD, but make sure that the cursor always ends up in a headline.
17096 If not, return to the original position and throw an error."
17097 (interactive)
17098 (let ((pos (point)))
17099 (call-interactively cmd)
17100 (unless (and (bolp) (org-on-heading-p))
17101 (goto-char pos)
17102 (error "Boundary reached while executing %s" cmd))))
17104 (defvar org-self-insert-command-undo-counter 0)
17106 (defvar org-table-auto-blank-field) ; defined in org-table.el
17107 (defvar org-speed-command nil)
17109 (defun org-speed-command-default-hook (keys)
17110 "Hook for activating single-letter speed commands.
17111 `org-speed-commands-default' specifies a minimal command set.
17112 Use `org-speed-commands-user' for further customization."
17113 (when (or (and (bolp) (looking-at org-outline-regexp))
17114 (and (functionp org-use-speed-commands)
17115 (funcall org-use-speed-commands)))
17116 (cdr (assoc keys (append org-speed-commands-user
17117 org-speed-commands-default)))))
17119 (defun org-babel-speed-command-hook (keys)
17120 "Hook for activating single-letter code block commands."
17121 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17122 (cdr (assoc keys org-babel-key-bindings))))
17124 (defcustom org-speed-command-hook
17125 '(org-speed-command-default-hook org-babel-speed-command-hook)
17126 "Hook for activating speed commands at strategic locations.
17127 Hook functions are called in sequence until a valid handler is
17128 found.
17130 Each hook takes a single argument, a user-pressed command key
17131 which is also a `self-insert-command' from the global map.
17133 Within the hook, examine the cursor position and the command key
17134 and return nil or a valid handler as appropriate. Handler could
17135 be one of an interactive command, a function, or a form.
17137 Set `org-use-speed-commands' to non-nil value to enable this
17138 hook. The default setting is `org-speed-command-default-hook'."
17139 :group 'org-structure
17140 :type 'hook)
17142 (defun org-self-insert-command (N)
17143 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17144 If the cursor is in a table looking at whitespace, the whitespace is
17145 overwritten, and the table is not marked as requiring realignment."
17146 (interactive "p")
17147 (cond
17148 ((and org-use-speed-commands
17149 (setq org-speed-command
17150 (run-hook-with-args-until-success
17151 'org-speed-command-hook (this-command-keys))))
17152 (cond
17153 ((commandp org-speed-command)
17154 (setq this-command org-speed-command)
17155 (call-interactively org-speed-command))
17156 ((functionp org-speed-command)
17157 (funcall org-speed-command))
17158 ((and org-speed-command (listp org-speed-command))
17159 (eval org-speed-command))
17160 (t (let (org-use-speed-commands)
17161 (call-interactively 'org-self-insert-command)))))
17162 ((and
17163 (org-table-p)
17164 (progn
17165 ;; check if we blank the field, and if that triggers align
17166 (and (featurep 'org-table) org-table-auto-blank-field
17167 (member last-command
17168 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17170 ;; got extra space, this field does not determine column width
17171 (let (org-table-may-need-update) (org-table-blank-field))
17172 ;; no extra space, this field may determine column width
17173 (org-table-blank-field)))
17174 t)
17175 (eq N 1)
17177 (let (org-table-may-need-update)
17178 (goto-char (1- (match-end 0)))
17179 (delete-char -1)
17180 (goto-char (match-beginning 0))
17181 (self-insert-command N)))
17182 (t
17183 (setq org-table-may-need-update t)
17184 (self-insert-command N)
17185 (org-fix-tags-on-the-fly)
17186 (if org-self-insert-cluster-for-undo
17187 (if (not (eq last-command 'org-self-insert-command))
17188 (setq org-self-insert-command-undo-counter 1)
17189 (if (>= org-self-insert-command-undo-counter 20)
17190 (setq org-self-insert-command-undo-counter 1)
17191 (and (> org-self-insert-command-undo-counter 0)
17192 buffer-undo-list (listp buffer-undo-list)
17193 (not (cadr buffer-undo-list)) ; remove nil entry
17194 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17195 (setq org-self-insert-command-undo-counter
17196 (1+ org-self-insert-command-undo-counter))))))))
17198 (defun org-fix-tags-on-the-fly ()
17199 (when (and (equal (char-after (point-at-bol)) ?*)
17200 (org-on-heading-p))
17201 (org-align-tags-here org-tags-column)))
17203 (defun org-delete-backward-char (N)
17204 "Like `delete-backward-char', insert whitespace at field end in tables.
17205 When deleting backwards, in tables this function will insert whitespace in
17207 still be marked for re-alignment if the field did fill the entire column,
17208 because, in this case the deletion might narrow the column."
17209 (interactive "p")
17210 (if (and (org-table-p)
17211 (eq N 1)
17212 (string-match "|" (buffer-substring (point-at-bol) (point)))
17213 (looking-at ".*?|"))
17214 (let ((pos (point))
17216 (c org-table-may-need-update))
17217 (backward-delete-char N)
17218 (if (not overwrite-mode)
17219 (progn
17220 (skip-chars-forward "^|")
17221 (insert " ")
17222 (goto-char (1- pos))))
17223 ;; noalign: if there were two spaces at the end, this field
17224 ;; does not determine the width of the column.
17225 (if noalign (setq org-table-may-need-update c)))
17226 (backward-delete-char N)
17227 (org-fix-tags-on-the-fly)))
17229 (defun org-delete-char (N)
17230 "Like `delete-char', but insert whitespace at field end in tables.
17231 When deleting characters, in tables this function will insert whitespace in
17233 still be marked for re-alignment if the field did fill the entire column,
17234 because, in this case the deletion might narrow the column."
17235 (interactive "p")
17236 (if (and (org-table-p)
17237 (not (bolp))
17238 (not (= (char-after) ?|))
17239 (eq N 1))
17240 (if (looking-at ".*?|")
17241 (let ((pos (point))
17243 (c org-table-may-need-update))
17244 (replace-match (concat
17245 (substring (match-string 0) 1 -1)
17246 " |"))
17247 (goto-char pos)
17248 ;; noalign: if there were two spaces at the end, this field
17249 ;; does not determine the width of the column.
17250 (if noalign (setq org-table-may-need-update c)))
17251 (delete-char N))
17252 (delete-char N)
17253 (org-fix-tags-on-the-fly)))
17255 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17256 (put 'org-self-insert-command 'delete-selection t)
17257 (put 'orgtbl-self-insert-command 'delete-selection t)
17258 (put 'org-delete-char 'delete-selection 'supersede)
17259 (put 'org-delete-backward-char 'delete-selection 'supersede)
17260 (put 'org-yank 'delete-selection 'yank)
17262 ;; Make `flyspell-mode' delay after some commands
17263 (put 'org-self-insert-command 'flyspell-delayed t)
17264 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17265 (put 'org-delete-char 'flyspell-delayed t)
17266 (put 'org-delete-backward-char 'flyspell-delayed t)
17268 ;; Make pabbrev-mode expand after org-mode commands
17269 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17270 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17272 ;; How to do this: Measure non-white length of current string
17273 ;; If equal to column width, we should realign.
17275 (defun org-remap (map &rest commands)
17276 "In MAP, remap the functions given in COMMANDS.
17277 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17278 (let (new old)
17279 (while commands
17280 (setq old (pop commands) new (pop commands))
17281 (if (fboundp 'command-remapping)
17282 (org-defkey map (vector 'remap old) new)
17283 (substitute-key-definition old new map global-map)))))
17285 (when (eq org-enable-table-editor 'optimized)
17286 ;; If the user wants maximum table support, we need to hijack
17287 ;; some standard editing functions
17288 (org-remap org-mode-map
17289 'self-insert-command 'org-self-insert-command
17290 'delete-char 'org-delete-char
17291 'delete-backward-char 'org-delete-backward-char)
17292 (org-defkey org-mode-map "|" 'org-force-self-insert))
17294 (defvar org-ctrl-c-ctrl-c-hook nil
17295 "Hook for functions attaching themselves to `C-c C-c'.
17297 This can be used to add additional functionality to the C-c C-c
17298 key which executes context-dependent commands. This hook is run
17299 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17300 run after the last test.
17302 Each function will be called with no arguments. The function
17303 must check if the context is appropriate for it to act. If yes,
17304 it should do its thing and then return a non-nil value. If the
17305 context is wrong, just do nothing and return nil.")
17307 (defvar org-ctrl-c-ctrl-c-final-hook nil
17308 "Hook for functions attaching themselves to `C-c C-c'.
17310 This can be used to add additional functionality to the C-c C-c
17311 key which executes context-dependent commands. This hook is run
17312 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17313 before the first test.
17315 Each function will be called with no arguments. The function
17316 must check if the context is appropriate for it to act. If yes,
17317 it should do its thing and then return a non-nil value. If the
17318 context is wrong, just do nothing and return nil.")
17320 (defvar org-tab-first-hook nil
17321 "Hook for functions to attach themselves to TAB.
17322 See `org-ctrl-c-ctrl-c-hook' for more information.
17323 This hook runs as the first action when TAB is pressed, even before
17324 `org-cycle' messes around with the `outline-regexp' to cater for
17325 inline tasks and plain list item folding.
17326 If any function in this hook returns t, any other actions that
17327 would have been caused by TAB (such as table field motion or visibility
17328 cycling) will not occur.")
17330 (defvar org-tab-after-check-for-table-hook nil
17331 "Hook for functions to attach themselves to TAB.
17332 See `org-ctrl-c-ctrl-c-hook' for more information.
17333 This hook runs after it has been established that the cursor is not in a
17334 table, but before checking if the cursor is in a headline or if global cycling
17335 should be done.
17336 If any function in this hook returns t, not other actions like visibility
17337 cycling will be done.")
17339 (defvar org-tab-after-check-for-cycling-hook nil
17340 "Hook for functions to attach themselves to TAB.
17341 See `org-ctrl-c-ctrl-c-hook' for more information.
17342 This hook runs after it has been established that not table field motion and
17343 not visibility should be done because of current context. This is probably
17344 the place where a package like yasnippets can hook in.")
17346 (defvar org-tab-before-tab-emulation-hook nil
17347 "Hook for functions to attach themselves to TAB.
17348 See `org-ctrl-c-ctrl-c-hook' for more information.
17349 This hook runs after every other options for TAB have been exhausted, but
17352 (defvar org-metaleft-hook nil
17353 "Hook for functions attaching themselves to `M-left'.
17354 See `org-ctrl-c-ctrl-c-hook' for more information.")
17355 (defvar org-metaright-hook nil
17356 "Hook for functions attaching themselves to `M-right'.
17357 See `org-ctrl-c-ctrl-c-hook' for more information.")
17358 (defvar org-metaup-hook nil
17359 "Hook for functions attaching themselves to `M-up'.
17360 See `org-ctrl-c-ctrl-c-hook' for more information.")
17361 (defvar org-metadown-hook nil
17362 "Hook for functions attaching themselves to `M-down'.
17363 See `org-ctrl-c-ctrl-c-hook' for more information.")
17364 (defvar org-shiftmetaleft-hook nil
17365 "Hook for functions attaching themselves to `M-S-left'.
17366 See `org-ctrl-c-ctrl-c-hook' for more information.")
17367 (defvar org-shiftmetaright-hook nil
17368 "Hook for functions attaching themselves to `M-S-right'.
17369 See `org-ctrl-c-ctrl-c-hook' for more information.")
17370 (defvar org-shiftmetaup-hook nil
17371 "Hook for functions attaching themselves to `M-S-up'.
17372 See `org-ctrl-c-ctrl-c-hook' for more information.")
17373 (defvar org-shiftmetadown-hook nil
17374 "Hook for functions attaching themselves to `M-S-down'.
17375 See `org-ctrl-c-ctrl-c-hook' for more information.")
17376 (defvar org-metareturn-hook nil
17377 "Hook for functions attaching themselves to `M-RET'.
17378 See `org-ctrl-c-ctrl-c-hook' for more information.")
17379 (defvar org-shiftup-hook nil
17380 "Hook for functions attaching themselves to `S-up'.
17381 See `org-ctrl-c-ctrl-c-hook' for more information.")
17382 (defvar org-shiftup-final-hook nil
17383 "Hook for functions attaching themselves to `S-up'.
17384 This one runs after all other options except shift-select have been excluded.
17385 See `org-ctrl-c-ctrl-c-hook' for more information.")
17386 (defvar org-shiftdown-hook nil
17387 "Hook for functions attaching themselves to `S-down'.
17388 See `org-ctrl-c-ctrl-c-hook' for more information.")
17389 (defvar org-shiftdown-final-hook nil
17390 "Hook for functions attaching themselves to `S-down'.
17391 This one runs after all other options except shift-select have been excluded.
17392 See `org-ctrl-c-ctrl-c-hook' for more information.")
17393 (defvar org-shiftleft-hook nil
17394 "Hook for functions attaching themselves to `S-left'.
17395 See `org-ctrl-c-ctrl-c-hook' for more information.")
17396 (defvar org-shiftleft-final-hook nil
17397 "Hook for functions attaching themselves to `S-left'.
17398 This one runs after all other options except shift-select have been excluded.
17399 See `org-ctrl-c-ctrl-c-hook' for more information.")
17400 (defvar org-shiftright-hook nil
17401 "Hook for functions attaching themselves to `S-right'.
17402 See `org-ctrl-c-ctrl-c-hook' for more information.")
17403 (defvar org-shiftright-final-hook nil
17404 "Hook for functions attaching themselves to `S-right'.
17405 This one runs after all other options except shift-select have been excluded.
17406 See `org-ctrl-c-ctrl-c-hook' for more information.")
17408 (defun org-modifier-cursor-error ()
17409 "Throw an error, a modified cursor command was applied in wrong context."
17410 (error "This command is active in special context like tables, headlines or items"))
17412 (defun org-shiftselect-error ()
17413 "Throw an error because Shift-Cursor command was applied in wrong context."
17414 (if (and (boundp 'shift-select-mode) shift-select-mode)
17415 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17416 (error "This command works only in special context like headlines or timestamps")))
17418 (defun org-call-for-shift-select (cmd)
17419 (let ((this-command-keys-shift-translated t))
17420 (call-interactively cmd)))
17422 (defun org-shifttab (&optional arg)
17423 "Global visibility cycling or move to previous table field.
17424 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17425 on context.
17426 See the individual commands for more information."
17427 (interactive "P")
17428 (cond
17429 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17430 ((integerp arg)
17431 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17432 (message "Content view to level: %d" arg)
17433 (org-content (prefix-numeric-value arg2))
17434 (setq org-cycle-global-status 'overview)))
17435 (t (call-interactively 'org-global-cycle))))
17437 (defun org-shiftmetaleft ()
17438 "Promote subtree or delete table column.
17439 Calls `org-promote-subtree', `org-outdent-item',
17440 or `org-table-delete-column', depending on context.
17441 See the individual commands for more information."
17442 (interactive)
17443 (cond
17444 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17445 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17446 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17447 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17448 (t (org-modifier-cursor-error))))
17450 (defun org-shiftmetaright ()
17451 "Demote subtree or insert table column.
17452 Calls `org-demote-subtree', `org-indent-item',
17453 or `org-table-insert-column', depending on context.
17454 See the individual commands for more information."
17455 (interactive)
17456 (cond
17457 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17458 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17459 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17460 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17461 (t (org-modifier-cursor-error))))
17463 (defun org-shiftmetaup (&optional arg)
17464 "Move subtree up or kill table row.
17465 Calls `org-move-subtree-up' or `org-table-kill-row' or
17466 `org-move-item-up' depending on context. See the individual commands
17467 for more information."
17468 (interactive "P")
17469 (cond
17470 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17471 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17472 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17473 ((org-at-item-p) (call-interactively 'org-move-item-up))
17474 (t (org-modifier-cursor-error))))
17476 (defun org-shiftmetadown (&optional arg)
17477 "Move subtree down or insert table row.
17478 Calls `org-move-subtree-down' or `org-table-insert-row' or
17479 `org-move-item-down', depending on context. See the individual
17480 commands for more information."
17481 (interactive "P")
17482 (cond
17483 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17484 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17485 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17486 ((org-at-item-p) (call-interactively 'org-move-item-down))
17487 (t (org-modifier-cursor-error))))
17489 (defsubst org-hidden-tree-error ()
17490 (error
17491 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17493 (defun org-metaleft (&optional arg)
17494 "Promote heading or move table column to left.
17495 Calls `org-do-promote' or `org-table-move-column', depending on context.
17496 With no specific context, calls the Emacs default `backward-word'.
17497 See the individual commands for more information."
17498 (interactive "P")
17499 (cond
17500 ((run-hook-with-args-until-success 'org-metaleft-hook))
17501 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17502 ((org-with-limited-levels
17503 (or (org-on-heading-p)
17504 (and (org-region-active-p)
17505 (save-excursion
17506 (goto-char (region-beginning))
17507 (org-on-heading-p)))))
17508 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17509 (call-interactively 'org-do-promote))
17510 ;; At an inline task.
17511 ((org-on-heading-p)
17512 (call-interactively 'org-inlinetask-promote))
17513 ((or (org-at-item-p)
17514 (and (org-region-active-p)
17515 (save-excursion
17516 (goto-char (region-beginning))
17517 (org-at-item-p))))
17518 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17519 (call-interactively 'org-outdent-item))
17520 (t (call-interactively 'backward-word))))
17522 (defun org-metaright (&optional arg)
17523 "Demote subtree or move table column to right.
17524 Calls `org-do-demote' or `org-table-move-column', depending on context.
17525 With no specific context, calls the Emacs default `forward-word'.
17526 See the individual commands for more information."
17527 (interactive "P")
17528 (cond
17529 ((run-hook-with-args-until-success 'org-metaright-hook))
17530 ((org-at-table-p) (call-interactively 'org-table-move-column))
17531 ((org-with-limited-levels
17532 (or (org-on-heading-p)
17533 (and (org-region-active-p)
17534 (save-excursion
17535 (goto-char (region-beginning))
17536 (org-on-heading-p)))))
17537 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17538 (call-interactively 'org-do-demote))
17539 ;; At an inline task.
17540 ((org-on-heading-p)
17541 (call-interactively 'org-inlinetask-demote))
17542 ((or (org-at-item-p)
17543 (and (org-region-active-p)
17544 (save-excursion
17545 (goto-char (region-beginning))
17546 (org-at-item-p))))
17547 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17548 (call-interactively 'org-indent-item))
17549 (t (call-interactively 'forward-word))))
17551 (defun org-check-for-hidden (what)
17552 "Check if there are hidden headlines/items in the current visual line.
17553 WHAT can be either `headlines' or `items'. If the current line is
17554 an outline or item heading and it has a folded subtree below it,
17555 this function returns t, nil otherwise."
17556 (let ((re (cond
17557 ((eq what 'headlines) org-outline-regexp-bol)
17558 ((eq what 'items) (org-item-beginning-re))
17559 (t (error "This should not happen"))))
17560 beg end)
17561 (save-excursion
17562 (catch 'exit
17563 (unless (org-region-active-p)
17564 (setq beg (point-at-bol))
17565 (beginning-of-line 2)
17566 (while (and (not (eobp)) ;; this is like `next-line'
17567 (get-char-property (1- (point)) 'invisible))
17568 (beginning-of-line 2))
17569 (setq end (point))
17570 (goto-char beg)
17571 (goto-char (point-at-eol))
17572 (setq end (max end (point)))
17573 (while (re-search-forward re end t)
17574 (if (get-char-property (match-beginning 0) 'invisible)
17575 (throw 'exit t))))
17576 nil))))
17578 (defun org-metaup (&optional arg)
17579 "Move subtree up or move table row up.
17580 Calls `org-move-subtree-up' or `org-table-move-row' or
17581 `org-move-item-up', depending on context. See the individual commands
17582 for more information."
17583 (interactive "P")
17584 (cond
17585 ((run-hook-with-args-until-success 'org-metaup-hook))
17586 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17587 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17588 ((org-at-item-p) (call-interactively 'org-move-item-up))
17589 (t (transpose-lines 1) (beginning-of-line -1))))
17591 (defun org-metadown (&optional arg)
17592 "Move subtree down or move table row down.
17593 Calls `org-move-subtree-down' or `org-table-move-row' or
17594 `org-move-item-down', depending on context. See the individual
17595 commands for more information."
17596 (interactive "P")
17597 (cond
17598 ((run-hook-with-args-until-success 'org-metadown-hook))
17599 ((org-at-table-p) (call-interactively 'org-table-move-row))
17600 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17601 ((org-at-item-p) (call-interactively 'org-move-item-down))
17602 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17604 (defun org-shiftup (&optional arg)
17605 "Increase item in timestamp or increase priority of current headline.
17606 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17607 depending on context. See the individual commands for more information."
17608 (interactive "P")
17609 (cond
17610 ((run-hook-with-args-until-success 'org-shiftup-hook))
17611 ((and org-support-shift-select (org-region-active-p))
17612 (org-call-for-shift-select 'previous-line))
17613 ((org-at-timestamp-p t)
17614 (call-interactively (if org-edit-timestamp-down-means-later
17615 'org-timestamp-down 'org-timestamp-up)))
17616 ((and (not (eq org-support-shift-select 'always))
17617 org-enable-priority-commands
17618 (org-on-heading-p))
17619 (call-interactively 'org-priority-up))
17620 ((and (not org-support-shift-select) (org-at-item-p))
17621 (call-interactively 'org-previous-item))
17622 ((org-clocktable-try-shift 'up arg))
17623 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17624 (org-support-shift-select
17625 (org-call-for-shift-select 'previous-line))
17626 (t (org-shiftselect-error))))
17628 (defun org-shiftdown (&optional arg)
17629 "Decrease item in timestamp or decrease priority of current headline.
17630 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17631 depending on context. See the individual commands for more information."
17632 (interactive "P")
17633 (cond
17634 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17635 ((and org-support-shift-select (org-region-active-p))
17636 (org-call-for-shift-select 'next-line))
17637 ((org-at-timestamp-p t)
17638 (call-interactively (if org-edit-timestamp-down-means-later
17639 'org-timestamp-up 'org-timestamp-down)))
17640 ((and (not (eq org-support-shift-select 'always))
17641 org-enable-priority-commands
17642 (org-on-heading-p))
17643 (call-interactively 'org-priority-down))
17644 ((and (not org-support-shift-select) (org-at-item-p))
17645 (call-interactively 'org-next-item))
17646 ((org-clocktable-try-shift 'down arg))
17647 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17648 (org-support-shift-select
17649 (org-call-for-shift-select 'next-line))
17650 (t (org-shiftselect-error))))
17652 (defun org-shiftright (&optional arg)
17653 "Cycle the thing at point or in the current line, depending on context.
17654 Depending on context, this does one of the following:
17656 - switch a timestamp at point one day into the future
17657 - on a headline, switch to the next TODO keyword.
17658 - on an item, switch entire list to the next bullet type
17659 - on a property line, switch to the next allowed value
17660 - on a clocktable definition line, move time block into the future"
17661 (interactive "P")
17662 (cond
17663 ((run-hook-with-args-until-success 'org-shiftright-hook))
17664 ((and org-support-shift-select (org-region-active-p))
17665 (org-call-for-shift-select 'forward-char))
17666 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17667 ((and (not (eq org-support-shift-select 'always))
17668 (org-on-heading-p))
17669 (let ((org-inhibit-logging
17670 (not org-treat-S-cursor-todo-selection-as-state-change))
17671 (org-inhibit-blocking
17672 (not org-treat-S-cursor-todo-selection-as-state-change)))
17673 (org-call-with-arg 'org-todo 'right)))
17674 ((or (and org-support-shift-select
17675 (not (eq org-support-shift-select 'always))
17676 (org-at-item-bullet-p))
17677 (and (not org-support-shift-select) (org-at-item-p)))
17678 (org-call-with-arg 'org-cycle-list-bullet nil))
17679 ((and (not (eq org-support-shift-select 'always))
17680 (org-at-property-p))
17681 (call-interactively 'org-property-next-allowed-value))
17682 ((org-clocktable-try-shift 'right arg))
17683 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17684 (org-support-shift-select
17685 (org-call-for-shift-select 'forward-char))
17686 (t (org-shiftselect-error))))
17688 (defun org-shiftleft (&optional arg)
17689 "Cycle the thing at point or in the current line, depending on context.
17690 Depending on context, this does one of the following:
17692 - switch a timestamp at point one day into the past
17693 - on a headline, switch to the previous TODO keyword.
17694 - on an item, switch entire list to the previous bullet type
17695 - on a property line, switch to the previous allowed value
17696 - on a clocktable definition line, move time block into the past"
17697 (interactive "P")
17698 (cond
17699 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17700 ((and org-support-shift-select (org-region-active-p))
17701 (org-call-for-shift-select 'backward-char))
17702 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17703 ((and (not (eq org-support-shift-select 'always))
17704 (org-on-heading-p))
17705 (let ((org-inhibit-logging
17706 (not org-treat-S-cursor-todo-selection-as-state-change))
17707 (org-inhibit-blocking
17708 (not org-treat-S-cursor-todo-selection-as-state-change)))
17709 (org-call-with-arg 'org-todo 'left)))
17710 ((or (and org-support-shift-select
17711 (not (eq org-support-shift-select 'always))
17712 (org-at-item-bullet-p))
17713 (and (not org-support-shift-select) (org-at-item-p)))
17714 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17715 ((and (not (eq org-support-shift-select 'always))
17716 (org-at-property-p))
17717 (call-interactively 'org-property-previous-allowed-value))
17718 ((org-clocktable-try-shift 'left arg))
17719 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17720 (org-support-shift-select
17721 (org-call-for-shift-select 'backward-char))
17722 (t (org-shiftselect-error))))
17724 (defun org-shiftcontrolright ()
17725 "Switch to next TODO set."
17726 (interactive)
17727 (cond
17728 ((and org-support-shift-select (org-region-active-p))
17729 (org-call-for-shift-select 'forward-word))
17730 ((and (not (eq org-support-shift-select 'always))
17731 (org-on-heading-p))
17732 (org-call-with-arg 'org-todo 'nextset))
17733 (org-support-shift-select
17734 (org-call-for-shift-select 'forward-word))
17735 (t (org-shiftselect-error))))
17737 (defun org-shiftcontrolleft ()
17738 "Switch to previous TODO set."
17739 (interactive)
17740 (cond
17741 ((and org-support-shift-select (org-region-active-p))
17742 (org-call-for-shift-select 'backward-word))
17743 ((and (not (eq org-support-shift-select 'always))
17744 (org-on-heading-p))
17745 (org-call-with-arg 'org-todo 'previousset))
17746 (org-support-shift-select
17747 (org-call-for-shift-select 'backward-word))
17748 (t (org-shiftselect-error))))
17750 (defun org-shiftcontrolup ()
17751 "Change timestamps synchronously up in CLOCK log lines."
17752 (interactive)
17753 (cond ((and (not org-support-shift-select)
17754 (org-at-clock-log-p)
17755 (org-at-timestamp-p t))
17756 (org-clock-timestamps-up))
17757 (t (org-shiftselect-error))))
17759 (defun org-shiftcontroldown ()
17760 "Change timestamps synchronously down in CLOCK log lines."
17761 (interactive)
17762 (cond ((and (not org-support-shift-select)
17763 (org-at-clock-log-p)
17764 (org-at-timestamp-p t))
17765 (org-clock-timestamps-down))
17766 (t (org-shiftselect-error))))
17768 (defun org-ctrl-c-ret ()
17769 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17770 (interactive)
17771 (cond
17772 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17773 (t (call-interactively 'org-insert-heading))))
17775 (defun org-find-visible ()
17776 (let ((s (point)))
17777 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17778 (get-char-property s 'invisible)))
17779 s))
17780 (defun org-find-invisible ()
17781 (let ((s (point)))
17782 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17783 (not (get-char-property s 'invisible))))
17784 s))
17786 (defun org-copy-visible (beg end)
17787 "Copy the visible parts of the region."
17788 (interactive "r")
17789 (let (snippets s)
17790 (save-excursion
17791 (save-restriction
17792 (narrow-to-region beg end)
17793 (setq s (goto-char (point-min)))
17794 (while (not (= (point) (point-max)))
17795 (goto-char (org-find-invisible))
17796 (push (buffer-substring s (point)) snippets)
17797 (setq s (goto-char (org-find-visible))))))
17798 (kill-new (apply 'concat (nreverse snippets)))))
17800 (defun org-copy-special ()
17801 "Copy region in table or copy current subtree.
17802 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17803 See the individual commands for more information."
17804 (interactive)
17805 (call-interactively
17806 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17808 (defun org-cut-special ()
17809 "Cut region in table or cut current subtree.
17810 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17811 See the individual commands for more information."
17812 (interactive)
17813 (call-interactively
17814 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17816 (defun org-paste-special (arg)
17817 "Paste rectangular region into table, or past subtree relative to level.
17818 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17819 See the individual commands for more information."
17820 (interactive "P")
17821 (if (org-at-table-p)
17822 (org-table-paste-rectangle)
17823 (org-paste-subtree arg)))
17825 (defun org-edit-special (&optional arg)
17826 "Call a special editor for the stuff at point.
17827 When at a table, call the formula editor with `org-table-edit-formulas'.
17828 When at the first line of an src example, call `org-edit-src-code'.
17829 When in an #+include line, visit the include file. Otherwise call
17830 `ffap' to visit the file at point."
17831 (interactive)
17832 ;; possibly prep session before editing source
17833 (when arg
17834 (let* ((info (org-babel-get-src-block-info))
17835 (lang (nth 0 info))
17836 (params (nth 2 info))
17837 (session (cdr (assoc :session params))))
17838 (when (and info session) ;; we are in a source-code block with a session
17839 (funcall
17840 (intern (concat "org-babel-prep-session:" lang)) session params))))
17841 (cond ;; proceed with `org-edit-special'
17842 ((save-excursion
17843 (beginning-of-line 1)
17844 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17845 (find-file (org-trim (match-string 1))))
17846 ((org-edit-src-code))
17847 ((org-edit-fixed-width-region))
17848 ((org-at-table.el-p)
17849 (org-edit-src-code))
17850 ((or (org-at-table-p)
17851 (save-excursion
17852 (beginning-of-line 1)
17854 (call-interactively 'org-table-edit-formulas))
17855 (t (call-interactively 'ffap))))
17857 (defun org-ctrl-c-ctrl-c (&optional arg)
17858 "Set tags in headline, or update according to changed information at point.
17860 This command does many different things, depending on context:
17862 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17863 this is what we do.
17865 - If the cursor is on a statistics cookie, update it.
17867 - If the cursor is in a headline, prompt for tags and insert them
17868 into the current line, aligned to `org-tags-column'. When called
17869 with prefix arg, realign all tags in the current buffer.
17871 - If the cursor is in one of the special #+KEYWORD lines, this
17872 triggers scanning the buffer for these lines and updating the
17873 information.
17875 - If the cursor is inside a table, realign the table. This command
17876 works even if the automatic table editor has been turned off.
17878 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17879 the entire table.
17881 - If the cursor is at a footnote reference or definition, jump to
17882 the corresponding definition or references, respectively.
17884 - If the cursor is a the beginning of a dynamic block, update it.
17886 - If the current buffer is a capture buffer, close note and file it.
17888 - If the cursor is on a <<<target>>>, update radio targets and
17889 corresponding links in this buffer.
17891 - If the cursor is on a numbered item in a plain list, renumber the
17892 ordered list.
17894 - If the cursor is on a checkbox, toggle it.
17896 - If the cursor is on a code block, evaluate it. The variable
17897 `org-confirm-babel-evaluate' can be used to control prompting
17898 before code block evaluation, by default every code block
17899 evaluation requires confirmation. Code block evaluation can be
17900 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17901 (interactive "P")
17902 (let ((org-enable-table-editor t))
17903 (cond
17904 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17905 org-occur-highlights
17906 org-latex-fragment-image-overlays)
17907 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17908 (org-remove-occur-highlights)
17909 (org-remove-latex-fragment-image-overlays)
17910 (message "Temporary highlights/overlays removed from current buffer"))
17911 ((and (local-variable-p 'org-finish-function (current-buffer))
17912 (fboundp org-finish-function))
17913 (funcall org-finish-function))
17914 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17915 ((or (looking-at org-property-start-re)
17916 (org-at-property-p))
17917 (call-interactively 'org-property-action))
17918 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17920 (or (org-on-heading-p) (org-at-item-p)))
17921 (call-interactively 'org-update-statistics-cookies))
17922 ((org-on-heading-p) (call-interactively 'org-set-tags))
17923 ((org-at-table.el-p)
17924 (message "Use C-c ' to edit table.el tables"))
17925 ((org-at-table-p)
17926 (org-table-maybe-eval-formula)
17927 (if arg
17928 (call-interactively 'org-table-recalculate)
17929 (org-table-maybe-recalculate-line))
17930 (call-interactively 'org-table-align)
17931 (orgtbl-send-table 'maybe))
17932 ((or (org-footnote-at-reference-p)
17933 (org-footnote-at-definition-p))
17934 (call-interactively 'org-footnote-action))
17935 ((org-at-item-checkbox-p)
17936 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17937 ;; list only if at top item.
17938 (let* ((cbox (match-string 1))
17939 (struct (org-list-struct))
17940 (old-struct (copy-tree struct))
17941 (parents (org-list-parents-alist struct))
17942 (prevs (org-list-prevs-alist struct))
17943 (orderedp (org-entry-get nil "ORDERED"))
17944 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17945 block-item)
17946 ;; Use a light version of `org-toggle-checkbox' to avoid
17947 ;; computing list structure twice.
17948 (org-list-set-checkbox (point-at-bol) struct
17949 (cond
17950 ((equal arg '(16)) "[-]")
17951 ((equal arg '(4)) nil)
17952 ((equal "[X]" cbox) "[ ]")
17953 (t "[X]")))
17954 (org-list-struct-fix-ind struct parents)
17955 (org-list-struct-fix-bul struct prevs)
17956 (setq block-item
17957 (org-list-struct-fix-box struct parents prevs orderedp))
17958 (when block-item
17959 (message
17960 "Checkboxes were removed due to unchecked box at line %d"
17961 (org-current-line block-item)))
17962 (org-list-struct-apply-struct struct old-struct)
17963 (org-update-checkbox-count-maybe)
17964 (when firstp (org-list-send-list 'maybe))))
17965 ((org-at-item-p)
17966 ;; Cursor at an item: repair list. Do checkbox related actions
17967 ;; only if function was called with an argument. Send list only
17968 ;; if at top item.
17969 (let* ((struct (org-list-struct))
17970 (old-struct (copy-tree struct))
17971 (parents (org-list-parents-alist struct))
17972 (prevs (org-list-prevs-alist struct))
17973 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17974 (org-list-struct-fix-ind struct parents)
17975 (org-list-struct-fix-bul struct prevs)
17976 (when arg
17977 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17978 (org-list-struct-fix-box struct parents prevs))
17979 (org-list-struct-apply-struct struct old-struct)
17980 (when arg (org-update-checkbox-count-maybe))
17981 (when firstp (org-list-send-list 'maybe))))
17982 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17983 ;; Dynamic block
17984 (beginning-of-line 1)
17985 (save-excursion (org-update-dblock)))
17986 ((save-excursion
17987 (beginning-of-line 1)
17989 (cond
17990 ((equal (match-string 1) "TBLFM")
17991 ;; Recalculate the table before this line
17992 (save-excursion
17993 (beginning-of-line 1)
17995 (if (org-at-table-p)
17996 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17997 (t
17998 (let ((org-inhibit-startup-visibility-stuff t)
17999 (org-startup-align-all-tables nil))
18000 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18001 (message "Local setup has been refreshed"))))
18002 ((org-clock-update-time-maybe))
18003 (t
18004 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18005 (error "C-c C-c can do nothing useful at this location"))))))
18007 (defun org-mode-restart ()
18008 "Restart Org-mode, to scan again for special lines.
18009 Also updates the keyword regular expressions."
18010 (interactive)
18011 (org-mode)
18012 (message "Org-mode restarted"))
18014 (defun org-kill-note-or-show-branches ()
18015 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18016 (interactive)
18017 (if (not org-finish-function)
18018 (progn
18019 (hide-subtree)
18020 (call-interactively 'show-branches))
18021 (let ((org-note-abort t))
18022 (funcall org-finish-function))))
18024 (defun org-return (&optional indent)
18025 "Goto next table row or insert a newline.
18026 Calls `org-table-next-row' or `newline', depending on context.
18027 See the individual commands for more information."
18028 (interactive)
18029 (cond
18030 ((bobp) (if indent (newline-and-indent) (newline)))
18031 ((org-at-table-p)
18032 (org-table-justify-field-maybe)
18033 (call-interactively 'org-table-next-row))
18034 ;; when `newline-and-indent' is called within a list, make sure
18035 ;; text moved stays inside the item.
18036 ((and (org-in-item-p) indent)
18037 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18038 (progn
18039 (save-match-data (newline))
18040 (org-indent-line-to (length (match-string 0))))
18041 (let ((ind (org-get-indentation)))
18042 (newline)
18043 (if (org-looking-back org-list-end-re)
18044 (org-indent-line-function)
18045 (org-indent-line-to ind)))))
18046 ((and org-return-follows-link
18047 (eq (get-text-property (point) 'face) 'org-link))
18048 (call-interactively 'org-open-at-point))
18049 ((and (org-at-heading-p)
18050 (looking-at
18052 (org-show-entry)
18053 (end-of-line 1)
18054 (newline))
18055 (t (if indent (newline-and-indent) (newline)))))
18057 (defun org-return-indent ()
18058 "Goto next table row or insert a newline and indent.
18059 Calls `org-table-next-row' or `newline-and-indent', depending on
18060 context. See the individual commands for more information."
18061 (interactive)
18062 (org-return t))
18064 (defun org-ctrl-c-star ()
18065 "Compute table, or change heading status of lines.
18066 Calls `org-table-recalculate' or `org-toggle-heading',
18067 depending on context."
18068 (interactive)
18069 (cond
18070 ((org-at-table-p)
18071 (call-interactively 'org-table-recalculate))
18072 (t
18073 ;; Convert all lines in region to list items
18074 (call-interactively 'org-toggle-heading))))
18076 (defun org-ctrl-c-minus ()
18077 "Insert separator line in table or modify bullet status of line.
18078 Also turns a plain line or a region of lines into list items.
18079 Calls `org-table-insert-hline', `org-toggle-item', or
18080 `org-cycle-list-bullet', depending on context."
18081 (interactive)
18082 (cond
18083 ((org-at-table-p)
18084 (call-interactively 'org-table-insert-hline))
18085 ((org-region-active-p)
18086 (call-interactively 'org-toggle-item))
18087 ((org-in-item-p)
18088 (call-interactively 'org-cycle-list-bullet))
18089 (t
18090 (call-interactively 'org-toggle-item))))
18092 (defun org-toggle-item (arg)
18093 "Convert headings or normal lines to items, items to normal lines.
18094 If there is no active region, only the current line is considered.
18096 If the first non blank line in the region is an headline, convert
18097 all headlines to items, shifting text accordingly.
18099 If it is an item, convert all items to normal lines.
18101 If it is normal text, change region into an item. With a prefix
18102 argument ARG, change each line in region into an item."
18103 (interactive "P")
18104 (let ((shift-text
18105 (function
18106 ;; Shift text in current section to IND, from point to END.
18107 ;; The function leaves point to END line.
18108 (lambda (ind end)
18109 (let ((min-i 1000) (end (copy-marker end)))
18110 ;; First determine the minimum indentation (MIN-I) of
18111 ;; the text.
18112 (save-excursion
18113 (catch 'exit
18114 (while (< (point) end)
18115 (let ((i (org-get-indentation)))
18116 (cond
18117 ;; Skip blank lines and inline tasks.
18119 ((looking-at org-outline-regexp-bol))
18120 ;; We can't find less than 0 indentation.
18121 ((zerop i) (throw 'exit (setq min-i 0)))
18122 ((< i min-i) (setq min-i i))))
18123 (forward-line))))
18124 ;; Then indent each line so that a line indented to
18125 ;; MIN-I becomes indented to IND. Ignore blank lines
18126 ;; and inline tasks in the process.
18127 (let ((delta (- ind min-i)))
18128 (while (< (point) end)
18130 (looking-at org-outline-regexp-bol))
18131 (org-indent-line-to (+ (org-get-indentation) delta)))
18132 (forward-line)))))))
18133 (skip-blanks
18134 (function
18135 ;; Return beginning of first non-blank line, starting from
18136 ;; line at POS.
18137 (lambda (pos)
18138 (save-excursion
18139 (goto-char pos)
18141 (point-at-bol)))))
18142 beg end)
18143 ;; Determine boundaries of changes.
18144 (if (org-region-active-p)
18145 (setq beg (funcall skip-blanks (region-beginning))
18146 end (copy-marker (region-end)))
18147 (setq beg (funcall skip-blanks (point-at-bol))
18148 end (copy-marker (point-at-eol))))
18149 ;; Depending on the starting line, choose an action on the text
18150 ;; between BEG and END.
18151 (org-with-limited-levels
18152 (save-excursion
18153 (goto-char beg)
18154 (cond
18155 ;; Case 1. Start at an item: de-itemize. Note that it only
18156 ;; happens when a region is active: `org-ctrl-c-minus'
18157 ;; would call `org-cycle-list-bullet' otherwise.
18158 ((org-at-item-p)
18159 (while (< (point) end)
18160 (when (org-at-item-p)
18162 (delete-region (point) (match-end 0)))
18163 (forward-line)))
18164 ;; Case 2. Start at an heading: convert to items.
18165 ((org-on-heading-p)
18166 (let* ((bul (org-list-bullet-string "-"))
18167 (bul-len (length bul))
18168 ;; Indentation of the first heading. It should be
18169 ;; relative to the indentation of its parent, if any.
18170 (start-ind (save-excursion
18171 (cond
18172 ((not org-adapt-indentation) 0)
18173 ((not (outline-previous-heading)) 0)
18174 (t (length (match-string 0))))))
18175 ;; Level of first heading. Further headings will be
18176 ;; compared to it to determine hierarchy in the list.
18177 (ref-level (org-reduced-level (org-outline-level))))
18178 (while (< (point) end)
18179 (let* ((level (org-reduced-level (org-outline-level)))
18180 (delta (max 0 (- level ref-level))))
18181 ;; If current headline is less indented than the first
18182 ;; one, set it as reference, in order to preserve
18183 ;; subtrees.
18184 (when (< level ref-level) (setq ref-level level))
18185 (replace-match bul t t)
18186 (org-indent-line-to (+ start-ind (* delta bul-len)))
18187 ;; Ensure all text down to END (or SECTION-END) belongs
18188 ;; to the newly created item.
18189 (let ((section-end (save-excursion
18190 (or (outline-next-heading) (point)))))
18191 (forward-line)
18192 (funcall shift-text
18193 (+ start-ind (* (1+ delta) bul-len))
18194 (min end section-end)))))))
18195 ;; Case 3. Normal line with ARG: turn each non-item line into
18196 ;; an item.
18197 (arg
18198 (while (< (point) end)
18199 (unless (or (org-on-heading-p) (org-at-item-p))
18201 (replace-match
18203 (forward-line)))
18204 ;; Case 4. Normal line without ARG: make the first line of
18205 ;; region an item, and shift indentation of others
18206 ;; lines to set them as item's body.
18207 (t (let* ((bul (org-list-bullet-string "-"))
18208 (bul-len (length bul))
18209 (ref-ind (org-get-indentation)))
18211 (insert bul)
18212 (forward-line)
18213 (while (< (point) end)
18214 ;; Ensure that lines less indented than first one
18215 ;; still get included in item body.
18216 (funcall shift-text
18217 (+ ref-ind bul-len)
18218 (min end (save-excursion (or (outline-next-heading)
18219 (point)))))
18220 (forward-line)))))))))
18222 (defun org-toggle-heading (&optional nstars)
18223 "Convert headings to normal text, or items or text to headings.
18224 If there is no active region, only the current line is considered.
18226 If the first non blank line is an headline, remove the stars from
18227 all headlines in the region.
18229 If it is a plain list item, turn all plain list items into headings.
18231 If it is a normal line, turn each and every normal line (i.e. not
18232 an heading or an item) in the region into a heading.
18234 When converting a line into a heading, the number of stars is chosen
18235 such that the lines become children of the current entry. However,
18236 when a prefix argument is given, its value determines the number of
18237 stars to add."
18238 (interactive "P")
18239 (let ((skip-blanks
18240 (function
18241 ;; Return beginning of first non-blank line, starting from
18242 ;; line at POS.
18243 (lambda (pos)
18244 (save-excursion
18245 (goto-char pos)
18247 (point-at-bol)))))
18248 beg end)
18249 ;; Determine boundaries of changes. If region ends at a bol, do
18250 ;; not consider the last line to be in the region.
18251 (if (org-region-active-p)
18252 (setq beg (funcall skip-blanks (region-beginning))
18253 end (copy-marker (save-excursion
18254 (goto-char (region-end))
18255 (if (bolp) (point) (point-at-eol)))))
18256 (setq beg (funcall skip-blanks (point-at-bol))
18257 end (copy-marker (point-at-eol))))
18258 ;; Ensure inline tasks don't count as headings.
18259 (org-with-limited-levels
18260 (save-excursion
18261 (goto-char beg)
18262 (cond
18263 ;; Case 1. Started at an heading: de-star headings.
18264 ((org-on-heading-p)
18265 (while (< (point) end)
18266 (when (org-on-heading-p t)
18267 (looking-at org-outline-regexp) (replace-match ""))
18268 (forward-line)))
18269 ;; Case 2. Started at an item: change items into headlines.
18270 ;; One star will be added by `org-list-to-subtree'.
18271 ((org-at-item-p)
18272 (let* ((stars (make-string
18273 (if nstars
18274 ;; subtract the star that will be added again by
18275 ;; `org-list-to-subtree'
18276 (1- (prefix-numeric-value current-prefix-arg))
18277 (or (org-current-level) 0))
18278 ?*))
18279 (add-stars
18280 (cond (nstars "") ; stars from prefix only
18281 ((equal stars "") "") ; before first heading
18282 (org-odd-levels-only "*") ; inside heading, odd
18283 (t "")))) ; inside heading, oddeven
18284 (while (< (point) end)
18285 (when (org-at-item-p)
18286 ;; Pay attention to cases when region ends before list.
18287 (let* ((struct (org-list-struct))
18288 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18289 (save-restriction
18290 (narrow-to-region (point) list-end)
18291 (insert
18292 (org-list-to-subtree
18293 (org-list-parse-list t)
18294 '(:istart (concat stars add-stars (funcall get-stars depth))
18295 :icount (concat stars add-stars (funcall get-stars depth))))))))
18296 (forward-line))))
18297 ;; Case 3. Started at normal text: make every line an heading,
18298 ;; skipping headlines and items.
18299 (t (let* ((stars (make-string
18300 (if nstars
18301 (prefix-numeric-value current-prefix-arg)
18302 (or (org-current-level) 0))
18303 ?*))
18304 (add-stars
18305 (cond (nstars "") ; stars from prefix only
18306 ((equal stars "") "*") ; before first heading
18307 (org-odd-levels-only "**") ; inside heading, odd
18308 (t "*"))) ; inside heading, oddeven
18309 (rpl (concat stars add-stars " ")))
18310 (while (< (point) end)
18311 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18313 (replace-match (concat rpl (match-string 2))))
18314 (forward-line)))))))))
18316 (defun org-meta-return (&optional arg)
18317 "Insert a new heading or wrap a region in a table.
18318 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18319 See the individual commands for more information."
18320 (interactive "P")
18321 (cond
18322 ((run-hook-with-args-until-success 'org-metareturn-hook))
18323 ((org-at-table-p)
18324 (call-interactively 'org-table-wrap-region))
18325 (t (call-interactively 'org-insert-heading))))
18327 ;;; Menu entries
18329 ;; Define the Org-mode menus
18330 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18331 '("Tbl"
18332 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18333 ["Next Field" org-cycle (org-at-table-p)]
18334 ["Previous Field" org-shifttab (org-at-table-p)]
18335 ["Next Row" org-return (org-at-table-p)]
18336 "--"
18337 ["Blank Field" org-table-blank-field (org-at-table-p)]
18338 ["Edit Field" org-table-edit-field (org-at-table-p)]
18339 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18340 "--"
18341 ("Column"
18342 ["Move Column Left" org-metaleft (org-at-table-p)]
18343 ["Move Column Right" org-metaright (org-at-table-p)]
18344 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18345 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18346 ("Row"
18347 ["Move Row Up" org-metaup (org-at-table-p)]
18348 ["Move Row Down" org-metadown (org-at-table-p)]
18349 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18350 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18351 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18352 "--"
18353 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18354 ("Rectangle"
18355 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18356 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18357 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18358 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18359 "--"
18360 ("Calculate"
18361 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18362 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18363 ["Edit Formulas" org-edit-special (org-at-table-p)]
18364 "--"
18365 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18366 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18367 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18368 "--"
18369 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18370 "--"
18371 ["Sum Column/Rectangle" org-table-sum
18372 (or (org-at-table-p) (org-region-active-p))]
18373 ["Which Column?" org-table-current-column (org-at-table-p)])
18374 ["Debug Formulas"
18375 org-table-toggle-formula-debugger
18376 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18377 ["Show Col/Row Numbers"
18378 org-table-toggle-coordinate-overlays
18379 :style toggle
18380 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18381 "--"
18382 ["Create" org-table-create (and (not (org-at-table-p))
18383 org-enable-table-editor)]
18384 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18385 ["Import from File" org-table-import (not (org-at-table-p))]
18386 ["Export to File" org-table-export (org-at-table-p)]
18387 "--"
18388 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18390 (easy-menu-define org-org-menu org-mode-map "Org menu"
18391 '("Org"
18392 ("Show/Hide"
18393 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18394 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18395 ["Sparse Tree..." org-sparse-tree t]
18396 ["Reveal Context" org-reveal t]
18397 ["Show All" show-all t]
18398 "--"
18399 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18400 "--"
18401 ["New Heading" org-insert-heading t]
18402 ("Navigate Headings"
18403 ["Up" outline-up-heading t]
18404 ["Next" outline-next-visible-heading t]
18405 ["Previous" outline-previous-visible-heading t]
18406 ["Next Same Level" outline-forward-same-level t]
18407 ["Previous Same Level" outline-backward-same-level t]
18408 "--"
18409 ["Jump" org-goto t])
18410 ("Edit Structure"
18411 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18412 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18413 "--"
18414 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18415 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18416 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18417 "--"
18418 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18419 "--"
18420 ["Copy visible text" org-copy-visible t]
18421 "--"
18422 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18423 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18424 ["Demote Heading" org-metaright (not (org-at-table-p))]
18425 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18426 "--"
18427 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18428 "--"
18429 ["Convert to odd levels" org-convert-to-odd-levels t]
18430 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18431 ("Editing"
18432 ["Emphasis..." org-emphasize t]
18433 ["Edit Source Example" org-edit-special t]
18434 "--"
18435 ["Footnote new/jump" org-footnote-action t]
18436 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18437 ("Archive"
18438 ["Archive (default method)" org-archive-subtree-default t]
18439 "--"
18440 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18441 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18442 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18443 )
18444 "--"
18445 ("Hyperlinks"
18446 ["Store Link (Global)" org-store-link t]
18447 ["Find existing link to here" org-occur-link-in-agenda-files t]
18448 ["Insert Link" org-insert-link t]
18449 ["Follow Link" org-open-at-point t]
18450 "--"
18451 ["Next link" org-next-link t]
18452 ["Previous link" org-previous-link t]
18453 "--"
18454 ["Descriptive Links"
18455 org-toggle-link-display
18456 :style radio
18457 :selected org-descriptive-links
18458 ]
18459 ["Literal Links"
18460 org-toggle-link-display
18461 :style radio
18462 :selected (not org-descriptive-links)])
18463 "--"
18464 ("TODO Lists"
18465 ["TODO/DONE/-" org-todo t]
18466 ("Select keyword"
18467 ["Next keyword" org-shiftright (org-on-heading-p)]
18468 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18469 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18470 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18471 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18472 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18473 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18474 "--"
18475 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18476 :selected org-enforce-todo-dependencies :style toggle :active t]
18477 "Settings for tree at point"
18478 ["Do Children sequentially" org-toggle-ordered-property :style radio
18479 :selected (org-entry-get nil "ORDERED")
18480 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18481 ["Do Children parallel" org-toggle-ordered-property :style radio
18482 :selected (not (org-entry-get nil "ORDERED"))
18483 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18484 "--"
18485 ["Set Priority" org-priority t]
18486 ["Priority Up" org-shiftup t]
18487 ["Priority Down" org-shiftdown t]
18488 "--"
18489 ["Get news from all feeds" org-feed-update-all t]
18490 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18491 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18492 ("TAGS and Properties"
18493 ["Set Tags" org-set-tags-command t]
18494 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18495 "--"
18496 ["Set property" org-set-property t]
18497 ["Column view of properties" org-columns t]
18498 ["Insert Column View DBlock" org-insert-columns-dblock t])
18499 ("Dates and Scheduling"
18500 ["Timestamp" org-time-stamp t]
18501 ["Timestamp (inactive)" org-time-stamp-inactive t]
18502 ("Change Date"
18503 ["1 Day Later" org-shiftright t]
18504 ["1 Day Earlier" org-shiftleft t]
18505 ["1 ... Later" org-shiftup t]
18506 ["1 ... Earlier" org-shiftdown t])
18507 ["Compute Time Range" org-evaluate-time-range t]
18508 ["Schedule Item" org-schedule t]
18509 ["Deadline" org-deadline t]
18510 "--"
18511 ["Custom time format" org-toggle-time-stamp-overlays
18512 :style radio :selected org-display-custom-times]
18513 "--"
18514 ["Goto Calendar" org-goto-calendar t]
18515 ["Date from Calendar" org-date-from-calendar t]
18516 "--"
18517 ["Start/Restart Timer" org-timer-start t]
18518 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18519 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18520 ["Insert Timer String" org-timer t]
18521 ["Insert Timer Item" org-timer-item t])
18522 ("Logging work"
18523 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18524 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18525 ["Clock out" org-clock-out t]
18526 ["Clock cancel" org-clock-cancel t]
18527 "--"
18528 ["Mark as default task" org-clock-mark-default-task t]
18529 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18530 ["Goto running clock" org-clock-goto t]
18531 "--"
18532 ["Display times" org-clock-display t]
18533 ["Create clock table" org-clock-report t]
18534 "--"
18535 ["Record DONE time"
18536 (progn (setq org-log-done (not org-log-done))
18537 (message "Switching to %s will %s record a timestamp"
18538 (car org-done-keywords)
18539 (if org-log-done "automatically" "not")))
18540 :style toggle :selected org-log-done])
18541 "--"
18542 ["Agenda Command..." org-agenda t]
18543 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18544 ("File List for Agenda")
18545 ("Special views current file"
18546 ["TODO Tree" org-show-todo-tree t]
18547 ["Check Deadlines" org-check-deadlines t]
18548 ["Timeline" org-timeline t]
18549 ["Tags/Property tree" org-match-sparse-tree t])
18550 "--"
18551 ["Export/Publish..." org-export t]
18552 ("LaTeX"
18553 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18554 :selected org-cdlatex-mode]
18555 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18556 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18557 ["Modify math symbol" org-cdlatex-math-modify
18558 (org-inside-LaTeX-fragment-p)]
18559 ["Insert citation" org-reftex-citation t]
18560 "--"
18561 ["Template for BEAMER" org-insert-beamer-options-template t])
18562 "--"
18563 ("MobileOrg"
18564 ["Push Files and Views" org-mobile-push t]
18565 ["Get Captured and Flagged" org-mobile-pull t]
18566 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18567 "--"
18568 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18569 "--"
18570 ("Documentation"
18571 ["Show Version" org-version t]
18572 ["Info Documentation" org-info t])
18573 ("Customize"
18574 ["Browse Org Group" org-customize t]
18575 "--"
18576 ["Expand This Menu" org-create-customize-menu
18577 (fboundp 'customize-menu-create)])
18578 ["Send bug report" org-submit-bug-report t]
18579 "--"
18580 ("Refresh/Reload"
18581 ["Refresh setup current buffer" org-mode-restart t]
18582 ["Reload Org (after update)" org-reload t]
18583 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18584 ))
18586 (defun org-info (&optional node)
18587 "Read documentation for Org-mode in the info system.
18588 With optional NODE, go directly to that node."
18589 (interactive)
18590 (info (format "(org)%s" (or node ""))))
18592 ;;;###autoload
18593 (defun org-submit-bug-report ()
18594 "Submit a bug report on Org-mode via mail.
18596 Don't hesitate to report any problems or inaccurate documentation.
18598 If you don't have setup sending mail from (X)Emacs, please copy the
18599 output buffer into your mail program, as it gives us important
18600 information about your Org-mode version and configuration."
18601 (interactive)
18602 (require 'reporter)
18603 (org-load-modules-maybe)
18604 (org-require-autoloaded-modules)
18605 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18606 (reporter-submit-bug-report
18607 "emacs-orgmode@gnu.org"
18608 (org-version)
18609 (let (list)
18610 (save-window-excursion
18611 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18612 (delete-other-windows)
18613 (erase-buffer)
18614 (insert "You are about to submit a bug report to the Org-mode mailing list.
18616 We would like to add your full Org-mode and Outline configuration to the
18617 bug report. This greatly simplifies the work of the maintainer and
18618 other experts on the mailing list.
18620 HOWEVER, some variables you have customized may contain private
18621 information. The names of customers, colleagues, or friends, might
18622 appear in the form of file names, tags, todo states, or search strings.
18623 If you answer yes to the prompt, you might want to check and remove
18624 such private information before sending the email.")
18625 (add-text-properties (point-min) (point-max) '(face org-warning))
18626 (when (yes-or-no-p "Include your Org-mode configuration ")
18627 (mapatoms
18628 (lambda (v)
18629 (and (boundp v)
18631 (or (and (symbol-value v)
18633 (and
18634 (get v 'custom-type) (get v 'standard-value)
18635 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18636 (push v list)))))
18637 (kill-buffer (get-buffer "*Warn about privacy*"))
18638 list))
18639 nil nil
18640 "Remember to cover the basics, that is, what you expected to happen and
18641 what in fact did happen. You don't know how to make a good report? See
18643 http://orgmode.org/manual/Feedback.html#Feedback
18645 Your bug report will be posted to the Org-mode mailing list.
18646 ------------------------------------------------------------------------")
18647 (save-excursion
18652 (defun org-install-agenda-files-menu ()
18653 (let ((bl (buffer-list)))
18654 (save-excursion
18655 (while bl
18656 (set-buffer (pop bl))
18657 (if (org-mode-p) (setq bl nil)))
18658 (when (org-mode-p)
18659 (easy-menu-change
18660 '("Org") "File List for Agenda"
18661 (append
18662 (list
18663 ["Edit File List" (org-edit-agenda-file-list) t]
18664 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18665 ["Remove Current File from List" org-remove-file t]
18666 ["Cycle through agenda files" org-cycle-agenda-files t]
18667 ["Occur in all agenda files" org-occur-in-agenda-files t]
18668 "--")
18669 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18671 ;;;; Documentation
18673 ;;;###autoload
18674 (defun org-require-autoloaded-modules ()
18675 (interactive)
18676 (mapc 'require
18677 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18678 org-docbook org-exp org-html org-icalendar
18679 org-id org-latex
18680 org-publish org-remember org-table
18681 org-timer org-xoxo)))
18683 ;;;###autoload
18684 (defun org-reload (&optional uncompiled)
18685 "Reload all org lisp files.
18686 With prefix arg UNCOMPILED, load the uncompiled versions."
18687 (interactive "P")
18688 (require 'find-func)
18690 (dir-org (file-name-directory (org-find-library-name "org")))
18691 (dir-org-contrib (ignore-errors
18692 (file-name-directory
18693 (org-find-library-name "org-contribdir"))))
18694 (babel-files
18695 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18696 (append (list nil "comint" "eval" "exp" "keys"
18697 "lob" "ref" "table" "tangle")
18698 (delq nil
18699 (mapcar
18700 (lambda (lang)
18701 (when (cdr lang) (symbol-name (car lang))))
18702 org-babel-load-languages)))))
18703 (files
18704 (append (directory-files dir-org t file-re)
18705 babel-files
18706 (and dir-org-contrib
18707 (directory-files dir-org-contrib t file-re))))
18708 (remove-re (concat (if (featurep 'xemacs)
18709 "org-colview" "org-colview-xemacs")
18711 (setq files (mapcar 'file-name-sans-extension files))
18712 (setq files (mapcar
18713 (lambda (x) (if (string-match remove-re x) nil x))
18714 files))
18715 (setq files (delq nil files))
18716 (mapc
18717 (lambda (f)
18718 (when (featurep (intern (file-name-nondirectory f)))
18719 (if (and (not uncompiled)
18720 (file-exists-p (concat f ".elc")))
18721 (load (concat f ".elc") nil nil t)
18722 (load (concat f ".el") nil nil t))))
18723 files))
18724 (org-version))
18726 ;;;###autoload
18727 (defun org-customize ()
18728 "Call the customize function with org as argument."
18729 (interactive)
18730 (org-load-modules-maybe)
18731 (org-require-autoloaded-modules)
18732 (customize-browse 'org))
18734 (defun org-create-customize-menu ()
18735 "Create a full customization menu for Org-mode, insert it into the menu."
18736 (interactive)
18737 (org-load-modules-maybe)
18738 (org-require-autoloaded-modules)
18739 (if (fboundp 'customize-menu-create)
18740 (progn
18741 (easy-menu-change
18742 '("Org") "Customize"
18743 `(["Browse Org group" org-customize t]
18744 "--"
18745 ,(customize-menu-create 'org)
18746 ["Set" Custom-set t]
18747 ["Save" Custom-save t]
18748 ["Reset to Current" Custom-reset-current t]
18749 ["Reset to Saved" Custom-reset-saved t]
18750 ["Reset to Standard Settings" Custom-reset-standard t]))
18752 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18754 ;;;; Miscellaneous stuff
18756 ;;; Generally useful functions
18758 (defun org-get-at-bol (property)
18759 "Get text property PROPERTY at beginning of line."
18760 (get-text-property (point-at-bol) property))
18762 (defun org-find-text-property-in-string (prop s)
18763 "Return the first non-nil value of property PROP in string S."
18764 (or (get-text-property 0 prop s)
18765 (get-text-property (or (next-single-property-change 0 prop s) 0)
18766 prop s)))
18768 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18769 "Display the given MESSAGE as a warning."
18770 (if (fboundp 'display-warning)
18771 (display-warning 'org message
18772 (if (featurep 'xemacs) 'warning :warning))
18773 (let ((buf (get-buffer-create "*Org warnings*")))
18774 (with-current-buffer buf
18775 (goto-char (point-max))
18776 (insert "Warning (Org): " message)
18777 (unless (bolp)
18778 (newline)))
18779 (display-buffer buf)
18780 (sit-for 0))))
18782 (defun org-eval (form)
18783 "Eval FORM and return result."
18784 (condition-case error
18785 (eval form)
18786 (error (format "%%![Error: %s]" error))))
18788 (defun org-in-commented-line ()
18789 "Is point in a line starting with `#'?"
18790 (equal (char-after (point-at-bol)) ?#))
18792 (defun org-in-indented-comment-line ()
18793 "Is point in a line starting with `#' after some white space?"
18794 (save-excursion
18795 (save-match-data
18796 (goto-char (point-at-bol))
18799 (defun org-in-verbatim-emphasis ()
18800 (save-match-data
18801 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18803 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18804 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18805 (if (and marker (marker-buffer marker)
18806 (buffer-live-p (marker-buffer marker)))
18807 (progn
18808 (org-pop-to-buffer-same-window (marker-buffer marker))
18809 (if (or (> marker (point-max)) (< marker (point-min)))
18810 (widen))
18811 (goto-char marker)
18812 (org-show-context 'org-goto))
18813 (if bookmark
18814 (bookmark-jump bookmark)
18815 (error "Cannot find location"))))
18817 (defun org-quote-csv-field (s)
18818 "Quote field for inclusion in CSV material."
18821 s))
18823 (defun org-force-self-insert (N)
18824 "Needed to enforce self-insert under remapping."
18825 (interactive "p")
18826 (self-insert-command N))
18828 (defun org-string-width (s)
18829 "Compute width of string, ignoring invisible characters.
18830 This ignores character with invisibility property `org-link', and also
18831 characters with property `org-cwidth', because these will become invisible
18832 upon the next fontification round."
18833 (let (b l)
18834 (when (or (eq t buffer-invisibility-spec)
18835 (assq 'org-link buffer-invisibility-spec))
18836 (while (setq b (text-property-any 0 (length s)
18837 'invisible 'org-link s))
18838 (setq s (concat (substring s 0 b)
18839 (substring s (or (next-single-property-change
18840 b 'invisible s) (length s)))))))
18841 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18842 (setq s (concat (substring s 0 b)
18843 (substring s (or (next-single-property-change
18844 b 'org-cwidth s) (length s))))))
18845 (setq l (string-width s) b -1)
18846 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18847 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18848 l))
18850 (defun org-shorten-string (s maxlength)
18851 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18852 If the string is shorter or has length MAXLENGTH, just return the
18853 original string. If it is longer, the functions finds a space in the
18854 string, breaks this string off at that locations and adds three dots
18855 as ellipsis. Including the ellipsis, the string will not be longer
18856 than MAXLENGTH. If finding a good breaking point in the string does
18857 not work, the string is just chopped off in the middle of a word
18858 if necessary."
18859 (if (<= (length s) maxlength)
18860 s
18861 (let* ((n (max (- maxlength 4) 1))
18863 (if (string-match re s)
18864 (concat (match-string 1 s) "...")
18865 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18867 (defun org-get-indentation (&optional line)
18868 "Get the indentation of the current line, interpreting tabs.
18869 When LINE is given, assume it represents a line and compute its indentation."
18870 (if line
18871 (if (string-match "^ *" (org-remove-tabs line))
18872 (match-end 0))
18873 (save-excursion
18874 (beginning-of-line 1)
18876 (current-column))))
18878 (defun org-get-string-indentation (s)
18879 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18880 (let ((n -1) (i 0) (w tab-width) c)
18881 (catch 'exit
18882 (while (< (setq n (1+ n)) (length s))
18883 (setq c (aref s n))
18884 (cond ((= c ?\ ) (setq i (1+ i)))
18886 (t (throw 'exit t)))))
18887 i))
18889 (defun org-remove-tabs (s &optional width)
18890 "Replace tabulators in S with spaces.
18891 Assumes that s is a single line, starting in column 0."
18892 (setq width (or width tab-width))
18894 (setq s (replace-match
18895 (make-string
18896 (- (* width (/ (+ (match-beginning 0) width) width))
18897 (match-beginning 0)) ?\ )
18898 t t s)))
18899 s)
18901 (defun org-fix-indentation (line ind)
18902 "Fix indentation in LINE.
18903 IND is a cons cell with target and minimum indentation.
18904 If the current indentation in LINE is smaller than the minimum,
18905 leave it alone. If it is larger than ind, set it to the target."
18906 (let* ((l (org-remove-tabs line))
18907 (i (org-get-indentation l))
18908 (i1 (car ind)) (i2 (cdr ind)))
18909 (if (>= i i2) (setq l (substring line i2)))
18910 (if (> i1 0)
18911 (concat (make-string i1 ?\ ) l)
18912 l)))
18914 (defun org-remove-indentation (code &optional n)
18915 "Remove the maximum common indentation from the lines in CODE.
18916 N may optionally be the number of spaces to remove."
18917 (with-temp-buffer
18918 (insert code)
18919 (org-do-remove-indentation n)
18920 (buffer-string)))
18922 (defun org-do-remove-indentation (&optional n)
18923 "Remove the maximum common indentation from the buffer."
18924 (untabify (point-min) (point-max))
18925 (let ((min 10000) re)
18926 (if n
18927 (setq min n)
18928 (goto-char (point-min))
18930 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18931 (unless (or (= min 0) (= min 10000))
18933 (goto-char (point-min))
18934 (while (re-search-forward re nil t)
18935 (replace-match "")
18936 (end-of-line 1))
18937 min)))
18939 (defun org-fill-template (template alist)
18940 "Find each %key of ALIST in TEMPLATE and replace it."
18941 (let ((case-fold-search nil)
18942 entry key value)
18943 (setq alist (sort (copy-sequence alist)
18944 (lambda (a b) (< (length (car a)) (length (car b))))))
18945 (while (setq entry (pop alist))
18946 (setq template
18947 (replace-regexp-in-string
18948 (concat "%" (regexp-quote (car entry)))
18949 (cdr entry) template t t)))
18950 template))
18952 (defun org-base-buffer (buffer)
18953 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18954 (if (not buffer)
18955 buffer
18956 (or (buffer-base-buffer buffer)
18957 buffer)))
18959 (defun org-trim (s)
18960 "Remove whitespace at beginning and end of string."
18963 s)
18965 (defun org-wrap (string &optional width lines)
18966 "Wrap string to either a number of lines, or a width in characters.
18967 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18968 that costs. If there is a word longer than WIDTH, the text is actually
18969 wrapped to the length of that word.
18970 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18971 many lines, whatever width that takes.
18972 The return value is a list of lines, without newlines at the end."
18974 (maxword (apply 'max (mapcar 'org-string-width words)))
18975 w ll)
18976 (cond (width
18977 (org-do-wrap words (max maxword width)))
18978 (lines
18979 (setq w maxword)
18980 (setq ll (org-do-wrap words maxword))
18981 (if (<= (length ll) lines)
18982 ll
18983 (setq ll words)
18984 (while (> (length ll) lines)
18985 (setq w (1+ w))
18986 (setq ll (org-do-wrap words w)))
18987 ll))
18988 (t (error "Cannot wrap this")))))
18990 (defun org-do-wrap (words width)
18991 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18992 (let (lines line)
18993 (while words
18994 (setq line (pop words))
18995 (while (and words (< (+ (length line) (length (car words))) width))
18996 (setq line (concat line " " (pop words))))
18997 (setq lines (push line lines)))
18998 (nreverse lines)))
19000 (defun org-split-string (string &optional separators)
19001 "Splits STRING into substrings at SEPARATORS.
19002 No empty strings are returned if there are matches at the beginning
19003 and end of string."
19005 (start 0)
19006 notfirst
19007 (list nil))
19008 (while (and (string-match rexp string
19009 (if (and notfirst
19010 (= start (match-beginning 0))
19011 (< start (length string)))
19012 (1+ start) start))
19013 (< (match-beginning 0) (length string)))
19014 (setq notfirst t)
19015 (or (eq (match-beginning 0) 0)
19016 (and (eq (match-beginning 0) (match-end 0))
19017 (eq (match-beginning 0) start))
19018 (setq list
19019 (cons (substring string start (match-beginning 0))
19020 list)))
19021 (setq start (match-end 0)))
19022 (or (eq start (length string))
19023 (setq list
19024 (cons (substring string start)
19025 list)))
19026 (nreverse list)))
19028 (defun org-quote-vert (s)
19030 (while (string-match "|" s)
19032 s)
19034 (defun org-uuidgen-p (s)
19035 "Is S an ID created by UUIDGEN?"
19036 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19038 (defun org-context ()
19039 "Return a list of contexts of the current cursor position.
19040 If several contexts apply, all are returned.
19041 Each context entry is a list with a symbol naming the context, and
19042 two positions indicating start and end of the context. Possible
19043 contexts are:
19045 :headline anywhere in a headline
19046 :headline-stars on the leading stars in a headline
19047 :todo-keyword on a TODO keyword (including DONE) in a headline
19048 :tags on the TAGS in a headline
19049 :priority on the priority cookie in a headline
19050 :item on the first line of a plain list item
19051 :item-bullet on the bullet/number of a plain list item
19052 :checkbox on the checkbox in a plain list item
19053 :table in an org-mode table
19054 :table-special on a special filed in a table
19055 :table-table in a table.el table
19056 :link on a hyperlink
19057 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19058 :target on a <<target>>
19059 :radio-target on a <<<radio-target>>>
19060 :latex-fragment on a LaTeX fragment
19061 :latex-preview on a LaTeX fragment with overlayed preview image
19063 This function expects the position to be visible because it uses font-lock
19064 faces as a help to recognize the following contexts: :table-special, :link,
19065 and :keyword."
19066 (let* ((f (get-text-property (point) 'face))
19067 (faces (if (listp f) f (list f)))
19068 (p (point)) clist o)
19069 ;; First the large context
19070 (cond
19071 ((org-on-heading-p t)
19072 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19073 (when (progn
19074 (beginning-of-line 1)
19075 (looking-at org-todo-line-tags-regexp))
19076 (push (org-point-in-group p 1 :headline-stars) clist)
19077 (push (org-point-in-group p 2 :todo-keyword) clist)
19078 (push (org-point-in-group p 4 :tags) clist))
19079 (goto-char p)
19082 (push (org-point-in-group p 0 :priority) clist)))
19084 ((org-at-item-p)
19085 (push (org-point-in-group p 2 :item-bullet) clist)
19086 (push (list :item (point-at-bol)
19087 (save-excursion (org-end-of-item) (point)))
19088 clist)
19089 (and (org-at-item-checkbox-p)
19090 (push (org-point-in-group p 0 :checkbox) clist)))
19092 ((org-at-table-p)
19093 (push (list :table (org-table-begin) (org-table-end)) clist)
19094 (if (memq 'org-formula faces)
19095 (push (list :table-special
19096 (previous-single-property-change p 'face)
19097 (next-single-property-change p 'face)) clist)))
19098 ((org-at-table-p 'any)
19099 (push (list :table-table) clist)))
19100 (goto-char p)
19102 ;; Now the small context
19103 (cond
19104 ((org-at-timestamp-p)
19105 (push (org-point-in-group p 0 :timestamp) clist))
19106 ((memq 'org-link faces)
19107 (push (list :link
19108 (previous-single-property-change p 'face)
19109 (next-single-property-change p 'face)) clist))
19110 ((memq 'org-special-keyword faces)
19111 (push (list :keyword
19112 (previous-single-property-change p 'face)
19113 (next-single-property-change p 'face)) clist))
19114 ((org-on-target-p)
19115 (push (org-point-in-group p 0 :target) clist)
19116 (goto-char (1- (match-beginning 0)))
19117 (if (looking-at org-radio-target-regexp)
19118 (push (org-point-in-group p 0 :radio-target) clist))
19119 (goto-char p))
19120 ((setq o (car (delq nil
19121 (mapcar
19122 (lambda (x)
19123 (if (memq x org-latex-fragment-image-overlays) x))
19124 (overlays-at (point))))))
19125 (push (list :latex-fragment
19126 (overlay-start o) (overlay-end o)) clist)
19127 (push (list :latex-preview
19128 (overlay-start o) (overlay-end o)) clist))
19129 ((org-inside-LaTeX-fragment-p)
19130 ;; FIXME: positions wrong.
19131 (push (list :latex-fragment (point) (point)) clist)))
19133 (setq clist (nreverse (delq nil clist)))
19134 clist))
19136 ;; FIXME: Compare with at-regexp-p Do we need both?
19137 (defun org-in-regexp (re &optional nlines visually)
19138 "Check if point is inside a match of regexp.
19139 Normally only the current line is checked, but you can include NLINES extra
19140 lines both before and after point into the search.
19141 If VISUALLY is set, require that the cursor is not after the match but
19142 really on, so that the block visually is on the match."
19143 (catch 'exit
19144 (let ((pos (point))
19145 (eol (point-at-eol (+ 1 (or nlines 0))))
19146 (inc (if visually 1 0)))
19147 (save-excursion
19148 (beginning-of-line (- 1 (or nlines 0)))
19149 (while (re-search-forward re eol t)
19150 (if (and (<= (match-beginning 0) pos)
19151 (>= (+ inc (match-end 0)) pos))
19152 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19154 (defun org-at-regexp-p (regexp)
19155 "Is point inside a match of REGEXP in the current line?"
19156 (catch 'exit
19157 (save-excursion
19158 (let ((pos (point)) (end (point-at-eol)))
19159 (beginning-of-line 1)
19160 (while (re-search-forward regexp end t)
19161 (if (and (<= (match-beginning 0) pos)
19162 (>= (match-end 0) pos))
19163 (throw 'exit t)))
19164 nil))))
19166 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19167 "Non-nil when point is between matches of START-RE and END-RE.
19169 Also return a non-nil value when point is on one of the matches.
19171 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19172 buffer positions. Default values are the positions of headlines
19173 surrounding the point.
19175 The functions returns a cons cell whose car (resp. cdr) is the
19176 position before START-RE (resp. after END-RE)."
19177 (save-match-data
19178 (let ((pos (point))
19179 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19180 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19181 beg end)
19182 (save-excursion
19183 ;; Point is on a block when on START-RE or if START-RE can be
19184 ;; found before it...
19185 (and (or (org-at-regexp-p start-re)
19186 (re-search-backward start-re limit-up t))
19187 (setq beg (match-beginning 0))
19188 ;; ... and END-RE after it...
19189 (goto-char (match-end 0))
19190 (re-search-forward end-re limit-down t)
19191 (> (setq end (match-end 0)) pos)
19192 ;; ... without another START-RE in-between.
19193 (goto-char (match-beginning 0))
19194 (not (re-search-backward start-re (1+ beg) t))
19195 ;; Return value.
19196 (cons beg end))))))
19198 (defun org-in-block-p (names)
19199 "Is point inside any block whose name belongs to NAMES?
19201 NAMES is a list of strings containing names of blocks."
19202 (save-match-data
19203 (catch 'exit
19204 (let ((case-fold-search t)
19205 (lim-up (save-excursion (outline-previous-heading)))
19206 (lim-down (save-excursion (outline-next-heading))))
19207 (mapc (lambda (name)
19208 (let ((n (regexp-quote name)))
19209 (when (org-between-regexps-p
19212 lim-up lim-down)
19213 (throw 'exit t))))
19214 names))
19215 nil)))
19217 (defun org-occur-in-agenda-files (regexp &optional nlines)
19218 "Call `multi-occur' with buffers for all agenda files."
19220 (let* ((files (org-agenda-files))
19221 (tnames (mapcar 'file-truename files))
19222 (extra org-agenda-text-search-extra-files)
19223 f)
19224 (when (eq (car extra) 'agenda-archives)
19225 (setq extra (cdr extra))
19226 (setq files (org-add-archive-files files)))
19227 (while (setq f (pop extra))
19228 (unless (member (file-truename f) tnames)
19229 (add-to-list 'files f 'append)
19230 (add-to-list 'tnames (file-truename f) 'append)))
19231 (multi-occur
19232 (mapcar (lambda (x)
19233 (with-current-buffer
19234 (or (get-file-buffer x) (find-file-noselect x))
19235 (widen)
19236 (current-buffer)))
19237 files)
19238 regexp)))
19240 (if (boundp 'occur-mode-find-occurrence-hook)
19241 ;; Emacs 23
19242 (add-hook 'occur-mode-find-occurrence-hook
19243 (lambda ()
19244 (when (org-mode-p)
19245 (org-reveal))))
19246 ;; Emacs 22
19247 (defadvice occur-mode-goto-occurrence
19248 (after org-occur-reveal activate)
19249 (and (org-mode-p) (org-reveal)))
19250 (defadvice occur-mode-goto-occurrence-other-window
19251 (after org-occur-reveal activate)
19252 (and (org-mode-p) (org-reveal)))
19253 (defadvice occur-mode-display-occurrence
19254 (after org-occur-reveal activate)
19255 (when (org-mode-p)
19256 (let ((pos (occur-mode-find-occurrence)))
19257 (with-current-buffer (marker-buffer pos)
19258 (save-excursion
19259 (goto-char pos)
19260 (org-reveal)))))))
19262 (defun org-occur-link-in-agenda-files ()
19263 "Create a link and search for it in the agendas.
19264 The link is not stored in `org-stored-links', it is just created
19265 for the search purpose."
19266 (interactive)
19267 (let ((link (condition-case nil
19268 (org-store-link nil)
19269 (error "Unable to create a link to here"))))
19270 (org-occur-in-agenda-files (regexp-quote link))))
19272 (defun org-uniquify (list)
19273 "Remove duplicate elements from LIST."
19274 (let (res)
19275 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19276 res))
19278 (defun org-delete-all (elts list)
19279 "Remove all elements in ELTS from LIST."
19280 (while elts
19281 (setq list (delete (pop elts) list)))
19282 list)
19284 (defun org-count (cl-item cl-seq)
19285 "Count the number of occurrences of ITEM in SEQ.
19286 Taken from `count' in cl-seq.el with all keyword arguments removed."
19287 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19288 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19289 (while (< cl-start cl-end)
19290 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19291 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19292 (setq cl-start (1+ cl-start)))
19293 cl-count))
19295 (defun org-remove-if (predicate seq)
19296 "Remove everything from SEQ that fulfills PREDICATE."
19297 (let (res e)
19298 (while seq
19299 (setq e (pop seq))
19300 (if (not (funcall predicate e)) (push e res)))
19301 (nreverse res)))
19303 (defun org-remove-if-not (predicate seq)
19304 "Remove everything from SEQ that does not fulfill PREDICATE."
19305 (let (res e)
19306 (while seq
19307 (setq e (pop seq))
19308 (if (funcall predicate e) (push e res)))
19309 (nreverse res)))
19311 (defun org-back-over-empty-lines ()
19312 "Move backwards over whitespace, to the beginning of the first empty line.
19313 Returns the number of empty lines passed."
19314 (let ((pos (point)))
19315 (if (cdr (assoc 'heading org-blank-before-new-entry))
19317 (unless (eobp)
19318 (forward-line -1)))
19319 (beginning-of-line 2)
19320 (goto-char (min (point) pos))
19321 (count-lines (point) pos)))
19323 (defun org-skip-whitespace ()
19326 (defun org-point-in-group (point group &optional context)
19327 "Check if POINT is in match-group GROUP.
19328 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19329 match. If the match group does not exist or point is not inside it,
19330 return nil."
19331 (and (match-beginning group)
19332 (>= point (match-beginning group))
19333 (<= point (match-end group))
19334 (if context
19335 (list context (match-beginning group) (match-end group))
19336 t)))
19338 (defun org-switch-to-buffer-other-window (&rest args)
19339 "Switch to buffer in a second window on the current frame.
19340 In particular, do not allow pop-up frames.
19341 Returns the newly created buffer."
19342 (let (pop-up-frames special-display-buffer-names special-display-regexps
19343 special-display-function)
19344 (apply 'switch-to-buffer-other-window args)))
19346 (defun org-combine-plists (&rest plists)
19347 "Create a single property list from all plists in PLISTS.
19348 The process starts by copying the first list, and then setting properties
19349 from the other lists. Settings in the last list are the most significant
19350 ones and overrule settings in the other lists."
19351 (let ((rtn (copy-sequence (pop plists)))
19352 p v ls)
19353 (while plists
19354 (setq ls (pop plists))
19355 (while ls
19356 (setq p (pop ls) v (pop ls))
19357 (setq rtn (plist-put rtn p v))))
19358 rtn))
19360 (defun org-move-line-down (arg)
19361 "Move the current line down. With prefix argument, move it past ARG lines."
19362 (interactive "p")
19363 (let ((col (current-column))
19364 beg end pos)
19365 (beginning-of-line 1) (setq beg (point))
19366 (beginning-of-line 2) (setq end (point))
19367 (beginning-of-line (+ 1 arg))
19368 (setq pos (move-marker (make-marker) (point)))
19369 (insert (delete-and-extract-region beg end))
19370 (goto-char pos)
19371 (org-move-to-column col)))
19373 (defun org-move-line-up (arg)
19374 "Move the current line up. With prefix argument, move it past ARG lines."
19375 (interactive "p")
19376 (let ((col (current-column))
19377 beg end pos)
19378 (beginning-of-line 1) (setq beg (point))
19379 (beginning-of-line 2) (setq end (point))
19380 (beginning-of-line (- arg))
19381 (setq pos (move-marker (make-marker) (point)))
19382 (insert (delete-and-extract-region beg end))
19383 (goto-char pos)
19384 (org-move-to-column col)))
19386 (defun org-replace-escapes (string table)
19387 "Replace %-escapes in STRING with values in TABLE.
19389 The sequences in STRING may contain normal field width and padding information,
19391 so values can contain further %-escapes if they are define later in TABLE."
19392 (let ((tbl (copy-alist table))
19393 (case-fold-search nil)
19394 (pchg 0)
19395 e re rpl)
19396 (while (setq e (pop tbl))
19397 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19398 (when (and (cdr e) (string-match re (cdr e)))
19399 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19400 (safe "SREF"))
19401 (add-text-properties 0 3 (list 'sref sref) safe)
19402 (setcdr e (replace-match safe t t (cdr e)))))
19403 (while (string-match re string)
19404 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19405 (cdr e)))
19406 (setq string (replace-match rpl t t string))))
19407 (while (setq pchg (next-property-change pchg string))
19408 (let ((sref (get-text-property pchg 'sref string)))
19409 (when (and sref (string-match "SREF" string pchg))
19410 (setq string (replace-match sref t t string)))))
19411 string))
19413 (defun org-sublist (list start end)
19414 "Return a section of LIST, from START to END.
19415 Counting starts at 1."
19416 (let (rtn (c start))
19417 (setq list (nthcdr (1- start) list))
19418 (while (and list (<= c end))
19419 (push (pop list) rtn)
19420 (setq c (1+ c)))
19421 (nreverse rtn)))
19423 (defun org-find-base-buffer-visiting (file)
19424 "Like `find-buffer-visiting' but always return the base buffer and
19425 not an indirect buffer."
19426 (let ((buf (or (get-file-buffer file)
19427 (find-buffer-visiting file))))
19428 (if buf
19429 (or (buffer-base-buffer buf) buf)
19430 nil)))
19432 (defun org-image-file-name-regexp (&optional extensions)
19433 "Return regexp matching the file names of images.
19434 If EXTENSIONS is given, only match these."
19435 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19436 (image-file-name-regexp)
19437 (let ((image-file-name-extensions
19438 (or extensions
19439 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19440 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19442 (regexp-opt (nconc (mapcar 'upcase
19443 image-file-name-extensions)
19444 image-file-name-extensions)
19445 t)
19448 (defun org-file-image-p (file &optional extensions)
19449 "Return non-nil if FILE is an image."
19450 (save-match-data
19451 (string-match (org-image-file-name-regexp extensions) file)))
19453 (defun org-get-cursor-date ()
19454 "Return the date at cursor in as a time.
19455 This works in the calendar and in the agenda, anywhere else it just
19456 returns the current time."
19457 (let (date day defd)
19458 (cond
19459 ((eq major-mode 'calendar-mode)
19460 (setq date (calendar-cursor-to-date)
19461 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19462 ((eq major-mode 'org-agenda-mode)
19463 (setq day (get-text-property (point) 'day))
19464 (if day
19465 (setq date (calendar-gregorian-from-absolute day)
19466 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19467 (nth 2 date))))))
19468 (or defd (current-time))))
19470 (defvar org-agenda-action-marker (make-marker)
19471 "Marker pointing to the entry for the next agenda action.")
19473 (defun org-mark-entry-for-agenda-action ()
19474 "Mark the current entry as target of an agenda action.
19475 Agenda actions are actions executed from the agenda with the key `k',
19476 which make use of the date at the cursor."
19477 (interactive)
19478 (move-marker org-agenda-action-marker
19479 (save-excursion (org-back-to-heading t) (point))
19480 (current-buffer))
19481 (message
19482 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19484 (defun org-mark-subtree ()
19485 "Mark the current subtree.
19486 This puts point at the start of the current subtree, and mark at the end.
19488 If point is in an inline task, mark that task instead."
19489 (interactive)
19490 (let ((inline-task-p
19491 (and (featurep 'org-inlinetask)
19492 (org-inlinetask-in-task-p)))
19493 (beg))
19494 ;; Get beginning of subtree
19495 (cond
19496 (inline-task-p (org-inlinetask-goto-beginning))
19497 ((org-at-heading-p) (beginning-of-line))
19498 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19499 (setq beg (point))
19500 ;; Get end of it
19501 (if inline-task-p
19502 (org-inlinetask-goto-end)
19503 (org-end-of-subtree))
19504 ;; Mark zone
19505 (push-mark (point) nil t)
19506 (goto-char beg)))
19508 ;;; Paragraph filling stuff.
19509 ;; We want this to be just right, so use the full arsenal.
19511 (defun org-indent-line-function ()
19512 "Indent line depending on context."
19513 (interactive)
19514 (let* ((pos (point))
19515 (itemp (org-at-item-p))
19516 (case-fold-search t)
19518 (inline-task-p (and (featurep 'org-inlinetask)
19519 (org-inlinetask-in-task-p)))
19520 (inline-re (and inline-task-p
19521 (org-inlinetask-outline-regexp)))
19522 column)
19523 (beginning-of-line 1)
19524 (cond
19525 ;; Comments
19526 ((looking-at "# ") (setq column 0))
19527 ;; Headings
19528 ((looking-at org-outline-regexp) (setq column 0))
19529 ;; Included files
19531 ;; Footnote definition
19532 ((looking-at org-footnote-definition-re) (setq column 0))
19533 ;; Literal examples
19535 (setq column (org-get-indentation))) ; do nothing
19536 ;; Lists
19537 ((ignore-errors (goto-char (org-in-item-p)))
19538 (setq column (if itemp
19539 (org-get-indentation)
19540 (org-list-item-body-column (point))))
19541 (goto-char pos))
19542 ;; Drawers
19544 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19545 (save-excursion
19546 (goto-char (1- (match-beginning 1)))
19547 (setq column (current-column))))
19548 ;; Special blocks
19550 (save-excursion
19551 (re-search-backward
19553 (setq column (org-get-indentation (match-string 0))))
19556 (save-excursion
19558 (setq column
19559 (cond ((equal (downcase (match-string 1)) "src")
19560 ;; src blocks: let `org-edit-src-exit' handle them
19561 (org-get-indentation))
19562 ((equal (downcase (match-string 1)) "example")
19563 (max (org-get-indentation)
19564 (org-get-indentation (match-string 0))))
19565 (t
19566 (org-get-indentation (match-string 0))))))
19567 ;; This line has nothing special, look at the previous relevant
19568 ;; line to compute indentation
19569 (t
19570 (beginning-of-line 0)
19571 (while (and (not (bobp))
19572 (not (looking-at org-drawer-regexp))
19573 ;; When point started in an inline task, do not move
19574 ;; above task starting line.
19575 (not (and inline-task-p (looking-at inline-re)))
19576 ;; Skip drawers, blocks, empty lines, verbatim,
19577 ;; comments, tables, footnotes definitions, lists,
19578 ;; inline tasks.
19580 (re-search-backward org-drawer-regexp nil t))
19584 (looking-at org-footnote-definition-re)
19585 (and (ignore-errors (goto-char (org-in-item-p)))
19586 (goto-char
19587 (org-list-get-top-point (org-list-struct))))
19588 (and (not inline-task-p)
19589 (featurep 'org-inlinetask)
19590 (org-inlinetask-in-task-p)
19591 (or (org-inlinetask-goto-beginning) t))))
19592 (beginning-of-line 0))
19593 (cond
19594 ;; There was an heading above.
19596 (if (not org-adapt-indentation)
19597 (setq column 0)
19598 (goto-char (match-end 0))
19599 (setq column (current-column))))
19600 ;; A drawer had started and is unfinished
19601 ((looking-at org-drawer-regexp)
19602 (goto-char (1- (match-beginning 1)))
19603 (setq column (current-column)))
19604 ;; Else, nothing noticeable found: get indentation and go on.
19605 (t (setq column (org-get-indentation))))))
19606 ;; Now apply indentation and move cursor accordingly
19607 (goto-char pos)
19608 (if (<= (current-column) (current-indentation))
19609 (org-indent-line-to column)
19610 (save-excursion (org-indent-line-to column)))
19611 ;; Special polishing for properties, see `org-property-format'
19612 (setq column (current-column))
19613 (beginning-of-line 1)
19614 (if (looking-at
19616 (replace-match (concat (match-string 1)
19617 (format org-property-format
19618 (match-string 2) (match-string 3)))
19619 t t))
19620 (org-move-to-column column)))
19622 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19623 "Variable to store copy of `adaptive-fill-regexp'.
19624 Since `adaptive-fill-regexp' is set to never match, we need to
19625 store a backup of its value before entering `org-mode' so that
19626 the functionality can be provided as a fall-back.")
19628 (defun org-set-autofill-regexps ()
19629 (interactive)
19630 ;; In the paragraph separator we include headlines, because filling
19631 ;; text in a line directly attached to a headline would otherwise
19632 ;; fill the headline as well.
19635 ;; The paragraph starter includes hand-formatted lists.
19636 (org-set-local
19637 'paragraph-start
19638 (concat
19647 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19648 ;; But only if the user has not turned off tables or fixed-width regions
19649 (org-set-local
19650 'auto-fill-inhibit-regexp
19651 (concat org-outline-regexp
19654 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19655 (concat
19657 (if org-enable-table-editor "|" "")
19658 (if org-enable-fixed-width-editor ":" "")
19659 "]"))))
19660 ;; We use our own fill-paragraph function, to make sure that tables
19661 ;; and fixed-width regions are not wrapped. That function will pass
19662 ;; through to `fill-paragraph' when appropriate.
19663 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19664 ;; Prevent auto-fill from inserting unwanted new items.
19665 (org-set-local 'fill-nobreak-predicate
19666 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19667 fill-nobreak-predicate
19668 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19669 ;; Adaptive filling: To get full control, first make sure that
19670 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19671 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19672 (org-set-local 'org-adaptive-fill-regexp-backup
19673 adaptive-fill-regexp))
19675 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19676 (org-set-local 'adaptive-fill-function
19677 'org-adaptive-fill-function)
19678 (org-set-local
19679 'align-mode-rules-list
19680 '((org-in-buffer-settings
19682 (modes . '(org-mode))))))
19684 (defun org-fill-item-nobreak-p ()
19685 "Non-nil when a line break at point would insert a new item."
19686 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19688 (defun org-fill-paragraph (&optional justify)
19689 "Re-align a table, pass through to fill-paragraph if no table."
19690 (let ((table-p (org-at-table-p))
19691 (table.el-p (org-at-table.el-p))
19692 (itemp (org-in-item-p)))
19693 (cond ((and (equal (char-after (point-at-bol)) ?*)
19694 (save-excursion (goto-char (point-at-bol))
19695 (looking-at org-outline-regexp)))
19696 t) ; skip headlines
19697 (table.el-p t) ; skip table.el tables
19698 (table-p (org-table-align) t) ; align Org tables
19699 (itemp ; align text in items
19700 (let* ((struct (save-excursion (goto-char itemp)
19701 (org-list-struct)))
19702 (parents (org-list-parents-alist struct))
19703 (children (org-list-get-children itemp struct parents))
19704 beg end prev next prefix)
19705 ;; Determine in which part of item point is: before
19706 ;; first child, after last child, between two
19707 ;; sub-lists, or simply in item if there's no child.
19708 (cond
19709 ((not children)
19710 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19711 beg itemp
19712 end (org-list-get-item-end itemp struct)))
19713 ((< (point) (setq next (car children)))
19714 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19715 beg itemp
19716 end next))
19717 ((> (point) (setq prev (car (last children))))
19718 (setq beg (org-list-get-item-end prev struct)
19719 end (org-list-get-item-end itemp struct)
19720 prefix (save-excursion
19721 (goto-char beg)
19723 (make-string (current-column) ?\ ))))
19724 (t (catch 'exit
19725 (while (setq next (pop children))
19726 (if (> (point) next)
19727 (setq prev next)
19728 (setq beg (org-list-get-item-end prev struct)
19729 end next
19730 prefix (save-excursion
19731 (goto-char beg)
19733 (make-string (current-column) ?\ )))
19734 (throw 'exit nil))))))
19735 ;; Use `fill-paragraph' with buffer narrowed to item
19736 ;; without any child, and with our computed PREFIX.
19737 (flet ((fill-context-prefix (from to &optional flr) prefix))
19738 (save-restriction
19739 (narrow-to-region beg end)
19740 (save-excursion (fill-paragraph justify)))) t))
19741 ;; Special case where point is not in a list but is on
19742 ;; a paragraph adjacent to a list: make sure this paragraph
19743 ;; doesn't get merged with the end of the list by narrowing
19744 ;; buffer first.
19745 ((save-excursion (forward-paragraph -1)
19746 (setq itemp (org-in-item-p)))
19747 (let ((struct (save-excursion (goto-char itemp)
19748 (org-list-struct))))
19749 (save-restriction
19750 (narrow-to-region (org-list-get-bottom-point struct)
19751 (save-excursion (forward-paragraph 1)
19752 (point)))
19753 (fill-paragraph justify) t)))
19754 ;; Else simply call `fill-paragraph'.
19755 (t nil))))
19757 ;; For reference, this is the default value of adaptive-fill-regexp
19760 (defun org-adaptive-fill-function ()
19761 "Return a fill prefix for org-mode files."
19762 (let (itemp)
19763 (save-excursion
19764 (cond
19765 ;; Comment line
19767 (match-string-no-properties 0))
19768 ;; Plain list item
19769 ((org-at-item-p)
19770 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19771 ;; Point is in a list after `backward-paragraph': original
19772 ;; point wasn't in the list, or filling would have been taken
19773 ;; care of by `org-auto-fill-function', but the list and the
19774 ;; real paragraph are not separated by a blank line. Thus, move
19775 ;; point after the list to go back to real paragraph and
19776 ;; determine fill-prefix.
19777 ((setq itemp (org-in-item-p))
19778 (goto-char itemp)
19779 (let* ((struct (org-list-struct))
19780 (bottom (org-list-get-bottom-point struct)))
19781 (goto-char bottom)
19782 (make-string (org-get-indentation) ?\ )))
19783 ;; Other text
19784 ((looking-at org-adaptive-fill-regexp-backup)
19785 (match-string-no-properties 0))))))
19787 (defun org-auto-fill-function ()
19788 "Auto-fill function."
19789 (let (itemp prefix)
19790 ;; When in a list, compute an appropriate fill-prefix and make
19791 ;; sure it will be used by `do-auto-fill'.
19792 (if (setq itemp (org-in-item-p))
19793 (progn
19794 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19795 (flet ((fill-context-prefix (from to &optional flr) prefix))
19796 (do-auto-fill)))
19797 ;; Else just use `do-auto-fill'.
19798 (do-auto-fill))))
19800 ;;; Other stuff.
19802 (defun org-toggle-fixed-width-section (arg)
19803 "Toggle the fixed-width export.
19804 If there is no active region, the QUOTE keyword at the current headline is
19805 inserted or removed. When present, it causes the text between this headline
19806 and the next to be exported as fixed-width text, and unmodified.
19807 If there is an active region, this command adds or removes a colon as the
19808 first character of this line. If the first character of a line is a colon,
19809 this line is also exported in fixed-width font."
19810 (interactive "P")
19811 (let* ((cc 0)
19812 (regionp (org-region-active-p))
19813 (beg (if regionp (region-beginning) (point)))
19814 (end (if regionp (region-end)))
19815 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19816 (case-fold-search nil)
19818 off)
19819 (if regionp
19820 (save-excursion
19821 (goto-char beg)
19822 (setq cc (current-column))
19823 (beginning-of-line 1)
19824 (setq off (looking-at re))
19825 (while (> nlines 0)
19826 (setq nlines (1- nlines))
19827 (beginning-of-line 1)
19828 (cond
19829 (arg
19830 (org-move-to-column cc t)
19832 (forward-line -1))
19833 ((and off (looking-at re))
19834 (replace-match "" t t nil 1))
19835 ((not off) (org-move-to-column cc t) (insert ": ")))
19836 (forward-line 1)))
19837 (save-excursion
19838 (org-back-to-heading)
19839 (if (looking-at (concat org-outline-regexp
19841 (replace-match "" t t nil 1)
19842 (if (looking-at org-outline-regexp)
19843 (progn
19844 (goto-char (match-end 0))
19845 (insert org-quote-string " "))))))))
19847 (defun org-reftex-citation ()
19848 "Use reftex-citation to insert a citation into the buffer.
19849 This looks for a line like
19851 #+BIBLIOGRAPHY: foo plain option:-d
19853 and derives from it that foo.bib is the bibliography file relevant
19854 for this document. It then installs the necessary environment for RefTeX
19855 to work in this buffer and calls `reftex-citation' to insert a citation
19856 into the buffer.
19858 Export of such citations to both LaTeX and HTML is handled by the contributed
19859 package org-exp-bibtex by Taru Karttunen."
19860 (interactive)
19861 (let ((reftex-docstruct-symbol 'rds)
19863 rds bib)
19864 (save-excursion
19865 (save-restriction
19866 (widen)
19867 (let ((case-fold-search t)
19869 (if (not (save-excursion
19870 (or (re-search-forward re nil t)
19871 (re-search-backward re nil t))))
19872 (error "No bibliography defined in file")
19873 (setq bib (concat (match-string 1) ".bib")
19874 rds (list (list 'bib bib)))))))
19875 (call-interactively 'reftex-citation)))
19877 ;;;; Functions extending outline functionality
19879 (defun org-beginning-of-line (&optional arg)
19880 "Go to the beginning of the current line. If that is invisible, continue
19881 to a visible line beginning. This makes the function of C-a more intuitive.
19882 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19883 first attempt, and only move to after the tags when the cursor is already
19884 beyond the end of the headline."
19885 (interactive "P")
19886 (let ((pos (point))
19887 (special (if (consp org-special-ctrl-a/e)
19888 (car org-special-ctrl-a/e)
19889 org-special-ctrl-a/e))
19890 refpos)
19891 (if (org-bound-and-true-p line-move-visual)
19892 (beginning-of-visual-line 1)
19893 (beginning-of-line 1))
19894 (if (and arg (fboundp 'move-beginning-of-line))
19895 (call-interactively 'move-beginning-of-line)
19896 (if (bobp)
19897 nil
19898 (backward-char 1)
19899 (if (org-truely-invisible-p)
19900 (while (and (not (bobp)) (org-truely-invisible-p))
19901 (backward-char 1)
19902 (beginning-of-line 1))
19903 (forward-char 1))))
19904 (when special
19905 (cond
19906 ((and (looking-at org-complex-heading-regexp)
19907 (= (char-after (match-end 1)) ?\ ))
19908 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19909 (point-at-eol)))
19910 (goto-char
19911 (if (eq special t)
19912 (cond ((> pos refpos) refpos)
19913 ((= pos (point)) refpos)
19914 (t (point)))
19915 (cond ((> pos (point)) (point))
19916 ((not (eq last-command this-command)) (point))
19917 (t refpos)))))
19918 ((org-at-item-p)
19919 (goto-char
19920 (if (eq special t)
19921 (cond ((> pos (match-end 0)) (match-end 0))
19922 ((= pos (point)) (match-end 0))
19923 (t (point)))
19924 (cond ((> pos (point)) (point))
19925 ((not (eq last-command this-command)) (point))
19926 (t (match-end 0))))))))
19927 (org-no-warnings
19928 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19930 (defun org-end-of-line (&optional arg)
19931 "Go to the end of the line.
19932 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19933 first attempt, and only move to after the tags when the cursor is already
19934 beyond the end of the headline."
19935 (interactive "P")
19936 (let ((special (if (consp org-special-ctrl-a/e)
19937 (cdr org-special-ctrl-a/e)
19938 org-special-ctrl-a/e)))
19939 (if (or (not special)
19940 (not (org-on-heading-p))
19941 arg)
19942 (call-interactively
19943 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19944 ((fboundp 'move-end-of-line) 'move-end-of-line)
19945 (t 'end-of-line)))
19946 (let ((pos (point)))
19947 (beginning-of-line 1)
19949 (if (eq special t)
19950 (if (or (< pos (match-beginning 1))
19951 (= pos (match-end 0)))
19952 (goto-char (match-beginning 1))
19953 (goto-char (match-end 0)))
19954 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19955 (goto-char (match-end 0))
19956 (goto-char (match-beginning 1))))
19957 (call-interactively (if (fboundp 'move-end-of-line)
19958 'move-end-of-line
19959 'end-of-line)))))
19960 (org-no-warnings
19961 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19963 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19964 (define-key org-mode-map "\C-e" 'org-end-of-line)
19966 (defun org-backward-sentence (&optional arg)
19967 "Go to beginning of sentence, or beginning of table field.
19968 This will call `backward-sentence' or `org-table-beginning-of-field',
19969 depending on context."
19970 (interactive "P")
19971 (cond
19972 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19973 (t (call-interactively 'backward-sentence))))
19975 (defun org-forward-sentence (&optional arg)
19976 "Go to end of sentence, or end of table field.
19977 This will call `forward-sentence' or `org-table-end-of-field',
19978 depending on context."
19979 (interactive "P")
19980 (cond
19981 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19982 (t (call-interactively 'forward-sentence))))
19984 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19985 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19987 (defun org-kill-line (&optional arg)
19988 "Kill line, to tags or end of line."
19989 (interactive "P")
19990 (cond
19991 ((or (not org-special-ctrl-k)
19992 (bolp)
19993 (not (org-on-heading-p)))
19994 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19995 org-ctrl-k-protect-subtree)
19996 (if (or (eq org-ctrl-k-protect-subtree 'error)
19997 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19998 (error "C-k aborted - would kill hidden subtree")))
19999 (call-interactively 'kill-line))
20001 (kill-region (point) (match-beginning 1))
20002 (org-set-tags nil t))
20003 (t (kill-region (point) (point-at-eol)))))
20005 (define-key org-mode-map "\C-k" 'org-kill-line)
20007 (defun org-yank (&optional arg)
20008 "Yank. If the kill is a subtree, treat it specially.
20009 This command will look at the current kill and check if is a single
20010 subtree, or a series of subtrees[1]. If it passes the test, and if the
20011 cursor is at the beginning of a line or after the stars of a currently
20012 empty headline, then the yank is handled specially. How exactly depends
20013 on the value of the following variables, both set by default.
20015 org-yank-folded-subtrees
20016 When set, the subtree(s) will be folded after insertion, but only
20017 if doing so would now swallow text after the yanked text.
20019 org-yank-adjusted-subtrees
20020 When set, the subtree will be promoted or demoted in order to
20021 fit into the local outline tree structure, which means that the level
20022 will be adjusted so that it becomes the smaller one of the two
20023 *visible* surrounding headings.
20025 Any prefix to this command will cause `yank' to be called directly with
20027 will just
20028 plainly yank the text as it is.
20030 \[1] The test checks if the first non-white line is a heading
20031 and if there are no other headings with fewer stars."
20032 (interactive "P")
20033 (org-yank-generic 'yank arg))
20035 (defun org-yank-generic (command arg)
20036 "Perform some yank-like command.
20038 This function implements the behavior described in the `org-yank'
20039 documentation. However, it has been generalized to work for any
20040 interactive command with similar behavior."
20042 ;; pretend to be command COMMAND
20043 (setq this-command command)
20045 (if arg
20046 (call-interactively command)
20048 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20049 (and (org-kill-is-subtree-p)
20050 (or (bolp)
20052 (string-match
20054 (buffer-substring (point-at-bol) (point)))))))
20055 swallowp)
20056 (cond
20057 ((and subtreep org-yank-folded-subtrees)
20058 (let ((beg (point))
20059 end)
20060 (if (and subtreep org-yank-adjusted-subtrees)
20061 (org-paste-subtree nil nil 'for-yank)
20062 (call-interactively command))
20064 (setq end (point))
20065 (goto-char beg)
20066 (when (and (bolp) subtreep
20067 (not (setq swallowp
20068 (org-yank-folding-would-swallow-text beg end))))
20069 (org-with-limited-levels
20070 (or (looking-at org-outline-regexp)
20071 (re-search-forward org-outline-regexp-bol end t))
20072 (while (and (< (point) end) (looking-at org-outline-regexp))
20073 (hide-subtree)
20074 (org-cycle-show-empty-lines 'folded)
20075 (condition-case nil
20076 (outline-forward-same-level 1)
20077 (error (goto-char end))))))
20078 (when swallowp
20079 (message
20080 "Inserted text not folded because that would swallow text"))
20082 (goto-char end)
20084 (beginning-of-line 1)
20085 (push-mark beg 'nomsg)))
20086 ((and subtreep org-yank-adjusted-subtrees)
20087 (let ((beg (point-at-bol)))
20088 (org-paste-subtree nil nil 'for-yank)
20089 (push-mark beg 'nomsg)))
20090 (t
20091 (call-interactively command))))))
20093 (defun org-yank-folding-would-swallow-text (beg end)
20094 "Would hide-subtree at BEG swallow any text after END?"
20095 (let (level)
20096 (org-with-limited-levels
20097 (save-excursion
20098 (goto-char beg)
20099 (when (or (looking-at org-outline-regexp)
20100 (re-search-forward org-outline-regexp-bol end t))
20101 (setq level (org-outline-level)))
20102 (goto-char end)
20104 (if (or (eobp)
20105 (and (bolp) (looking-at org-outline-regexp)
20106 (<= (org-outline-level) level)))
20107 nil ; Nothing would be swallowed
20108 t))))) ; something would swallow
20110 (define-key org-mode-map "\C-y" 'org-yank)
20112 (defun org-truely-invisible-p ()
20113 "Check if point is at a character currently not visible.
20114 This version does not only check the character property, but also
20115 `visible-mode'."
20116 ;; Early versions of noutline don't have `outline-invisible-p'.
20117 (if (org-bound-and-true-p visible-mode)
20118 nil
20119 (outline-invisible-p)))
20121 (defun org-invisible-p2 ()
20122 "Check if point is at a character currently not visible."
20123 (save-excursion
20124 (if (and (eolp) (not (bobp))) (backward-char 1))
20125 ;; Early versions of noutline don't have `outline-invisible-p'.
20126 (outline-invisible-p)))
20128 (defun org-back-to-heading (&optional invisible-ok)
20129 "Call `outline-back-to-heading', but provide a better error message."
20130 (condition-case nil
20131 (outline-back-to-heading invisible-ok)
20132 (error (error "Before first headline at position %d in buffer %s"
20133 (point) (current-buffer)))))
20135 (defun org-beginning-of-defun ()
20136 "Go to the beginning of the subtree, i.e. back to the heading."
20137 (org-back-to-heading))
20138 (defun org-end-of-defun ()
20139 "Go to the end of the subtree."
20140 (org-end-of-subtree nil t))
20142 (defun org-before-first-heading-p ()
20143 "Before first heading?"
20144 (save-excursion
20145 (end-of-line)
20146 (null (re-search-backward org-outline-regexp-bol nil t))))
20148 (defun org-on-heading-p (&optional ignored)
20149 (outline-on-heading-p t))
20150 (defun org-at-heading-p (&optional ignored)
20151 (outline-on-heading-p t))
20153 (defun org-point-at-end-of-empty-headline ()
20154 "If point is at the end of an empty headline, return t, else nil.
20155 If the heading only contains a TODO keyword, it is still still considered
20156 empty."
20158 (save-excursion
20159 (beginning-of-line 1)
20160 (let ((case-fold-search nil))
20163 (defun org-at-heading-or-item-p ()
20164 (or (org-on-heading-p) (org-at-item-p)))
20166 (defun org-on-target-p ()
20167 (or (org-in-regexp org-radio-target-regexp)
20168 (org-in-regexp org-target-regexp)))
20170 (defun org-up-heading-all (arg)
20171 "Move to the heading line of which the present line is a subheading.
20172 This function considers both visible and invisible heading lines.
20173 With argument, move up ARG levels."
20174 (if (fboundp 'outline-up-heading-all)
20175 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20176 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20178 (defun org-up-heading-safe ()
20179 "Move to the heading line of which the present line is a subheading.
20180 This version will not throw an error. It will return the level of the
20181 headline found, or nil if no higher level is found.
20183 Also, this function will be a lot faster than `outline-up-heading',
20184 because it relies on stars being the outline starters. This can really
20185 make a significant difference in outlines with very many siblings."
20186 (let (start-level re)
20187 (org-back-to-heading t)
20188 (setq start-level (funcall outline-level))
20189 (if (equal start-level 1)
20190 nil
20192 (if (re-search-backward re nil t)
20193 (funcall outline-level)))))
20195 (defun org-first-sibling-p ()
20196 "Is this heading the first child of its parents?"
20197 (interactive)
20198 (let ((re org-outline-regexp-bol)
20199 level l)
20200 (unless (org-at-heading-p t)
20201 (error "Not at a heading"))
20202 (setq level (funcall outline-level))
20203 (save-excursion
20204 (if (not (re-search-backward re nil t))
20205 t
20206 (setq l (funcall outline-level))
20207 (< l level)))))
20209 (defun org-goto-sibling (&optional previous)
20210 "Goto the next sibling, even if it is invisible.
20211 When PREVIOUS is set, go to the previous sibling instead. Returns t
20212 when a sibling was found. When none is found, return nil and don't
20213 move point."
20214 (let ((fun (if previous 're-search-backward 're-search-forward))
20215 (pos (point))
20216 (re org-outline-regexp-bol)
20217 level l)
20218 (when (condition-case nil (org-back-to-heading t) (error nil))
20219 (setq level (funcall outline-level))
20220 (catch 'exit
20221 (or previous (forward-char 1))
20222 (while (funcall fun re nil t)
20223 (setq l (funcall outline-level))
20224 (when (< l level) (goto-char pos) (throw 'exit nil))
20225 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20226 (goto-char pos)
20227 nil))))
20229 (defun org-show-siblings ()
20230 "Show all siblings of the current headline."
20231 (save-excursion
20232 (while (org-goto-sibling) (org-flag-heading nil)))
20233 (save-excursion
20234 (while (org-goto-sibling 'previous)
20235 (org-flag-heading nil))))
20237 (defun org-goto-first-child ()
20238 "Goto the first child, even if it is invisible.
20239 Return t when a child was found. Otherwise don't move point and
20240 return nil."
20241 (let (level (pos (point)) (re org-outline-regexp-bol))
20242 (when (condition-case nil (org-back-to-heading t) (error nil))
20243 (setq level (outline-level))
20244 (forward-char 1)
20245 (if (and (re-search-forward re nil t) (> (outline-level) level))
20246 (progn (goto-char (match-beginning 0)) t)
20247 (goto-char pos) nil))))
20249 (defun org-show-hidden-entry ()
20250 "Show an entry where even the heading is hidden."
20251 (save-excursion
20252 (org-show-entry)))
20254 (defun org-flag-heading (flag &optional entry)
20255 "Flag the current heading. FLAG non-nil means make invisible.
20256 When ENTRY is non-nil, show the entire entry."
20257 (save-excursion
20258 (org-back-to-heading t)
20259 ;; Check if we should show the entire entry
20260 (if entry
20261 (progn
20262 (org-show-entry)
20263 (save-excursion
20264 (and (outline-next-heading)
20265 (org-flag-heading nil))))
20266 (outline-flag-region (max (point-min) (1- (point)))
20267 (save-excursion (outline-end-of-heading) (point))
20268 flag))))
20270 (defun org-get-next-sibling ()
20271 "Move to next heading of the same level, and return point.
20272 If there is no such heading, return nil.
20273 This is like outline-next-sibling, but invisible headings are ok."
20274 (let ((level (funcall outline-level)))
20275 (outline-next-heading)
20276 (while (and (not (eobp)) (> (funcall outline-level) level))
20277 (outline-next-heading))
20278 (if (or (eobp) (< (funcall outline-level) level))
20279 nil
20280 (point))))
20282 (defun org-get-last-sibling ()
20283 "Move to previous heading of the same level, and return point.
20284 If there is no such heading, return nil."
20285 (let ((opoint (point))
20286 (level (funcall outline-level)))
20287 (outline-previous-heading)
20288 (when (and (/= (point) opoint) (outline-on-heading-p t))
20289 (while (and (> (funcall outline-level) level)
20290 (not (bobp)))
20291 (outline-previous-heading))
20292 (if (< (funcall outline-level) level)
20293 nil
20294 (point)))))
20296 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20297 ;; This contains an exact copy of the original function, but it uses
20298 ;; `org-back-to-heading', to make it work also in invisible
20299 ;; trees. And is uses an invisible-OK argument.
20300 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20301 ;; Furthermore, when used inside Org, finding the end of a large subtree
20302 ;; with many children and grandchildren etc, this can be much faster
20303 ;; than the outline version.
20304 (org-back-to-heading invisible-OK)
20305 (let ((first t)
20306 (level (funcall outline-level)))
20307 (if (and (org-mode-p) (< level 1000))
20308 ;; A true heading (not a plain list item), in Org-mode
20309 ;; This means we can easily find the end by looking
20310 ;; only for the right number of stars. Using a regexp to do
20311 ;; this is so much faster than using a Lisp loop.
20313 (forward-char 1)
20314 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20315 ;; something else, do it the slow way
20316 (while (and (not (eobp))
20317 (or first (> (funcall outline-level) level)))
20318 (setq first nil)
20319 (outline-next-heading)))
20320 (unless to-heading
20322 (progn
20323 ;; Go to end of line before heading
20324 (forward-char -1)
20326 ;; leave blank line before heading
20327 (forward-char -1))))))
20328 (point))
20330 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20331 "Use Org version in org-mode, for dramatic speed-up."
20332 (if (org-mode-p)
20333 (progn
20334 (org-end-of-subtree nil t)
20335 (unless (eobp) (backward-char 1)))
20336 ad-do-it))
20338 ;; FIXME This should not match :END: for custom drawers?
20339 (defun org-end-of-meta-data-and-drawers ()
20340 "Jump to the first text after meta data and drawers in the current entry.
20341 This will move over empty lines, lines with planning time stamps,
20342 clocking lines, and drawers."
20343 (org-back-to-heading t)
20344 (let ((end (save-excursion (outline-next-heading) (point)))
20347 (forward-line 1)
20348 (while (re-search-forward re end t)
20349 (if (not (match-end 1))
20350 ;; empty or planning line
20351 (forward-line 1)
20352 ;; a drawer, find the end
20354 (forward-line 1)))
20356 (point)))
20358 (defun org-forward-same-level (arg &optional invisible-ok)
20359 "Move forward to the arg'th subheading at same level as this one.
20360 Stop at the first and last subheadings of a superior heading.
20361 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20362 it wil also look at invisible ones."
20363 (interactive "p")
20364 (org-back-to-heading invisible-ok)
20365 (org-on-heading-p)
20366 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20368 l)
20369 (forward-char 1)
20370 (while (> arg 0)
20371 (while (and (re-search-forward re nil 'move)
20372 (setq l (- (match-end 0) (match-beginning 0) 1))
20373 (= l level)
20374 (not invisible-ok)
20375 (progn (backward-char 1) (outline-invisible-p)))
20376 (if (< l level) (setq arg 1)))
20377 (setq arg (1- arg)))
20378 (beginning-of-line 1)))
20380 (defun org-backward-same-level (arg &optional invisible-ok)
20381 "Move backward to the arg'th subheading at same level as this one.
20382 Stop at the first and last subheadings of a superior heading."
20383 (interactive "p")
20384 (org-back-to-heading)
20385 (org-on-heading-p)
20386 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20388 l)
20389 (while (> arg 0)
20390 (while (and (re-search-backward re nil 'move)
20391 (setq l (- (match-end 0) (match-beginning 0) 1))
20392 (= l level)
20393 (not invisible-ok)
20394 (outline-invisible-p))
20395 (if (< l level) (setq arg 1)))
20396 (setq arg (1- arg)))))
20398 (defun org-show-subtree ()
20399 "Show everything after this heading at deeper levels."
20400 (outline-flag-region
20401 (point)
20402 (save-excursion
20403 (org-end-of-subtree t t))
20404 nil))
20406 (defun org-show-entry ()
20407 "Show the body directly following this heading.
20408 Show the heading too, if it is currently invisible."
20409 (interactive)
20410 (save-excursion
20411 (condition-case nil
20412 (progn
20413 (org-back-to-heading t)
20414 (outline-flag-region
20415 (max (point-min) (1- (point)))
20416 (save-excursion
20417 (if (re-search-forward
20419 (match-beginning 1)
20420 (point-max)))
20421 nil)
20422 (org-cycle-hide-drawers 'children))
20423 (error nil))))
20425 (defun org-make-options-regexp (kwds &optional extra)
20426 "Make a regular expression for keyword lines."
20427 (concat
20428 "^"
20435 ;; Make isearch reveal the necessary context
20436 (defun org-isearch-end ()
20437 "Reveal context after isearch exits."
20438 (when isearch-success ; only if search was successful
20439 (if (featurep 'xemacs)
20440 ;; Under XEmacs, the hook is run in the correct place,
20441 ;; we directly show the context.
20442 (org-show-context 'isearch)
20443 ;; In Emacs the hook runs *before* restoring the overlays.
20444 ;; So we have to use a one-time post-command-hook to do this.
20445 ;; (Emacs 22 has a special variable, see function `org-mode')
20446 (unless (and (boundp 'isearch-mode-end-hook-quit)
20447 isearch-mode-end-hook-quit)
20448 ;; Only when the isearch was not quitted.
20449 (org-add-hook 'post-command-hook 'org-isearch-post-command
20450 'append 'local)))))
20452 (defun org-isearch-post-command ()
20453 "Remove self from hook, and show context."
20454 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20455 (org-show-context 'isearch))
20458 ;;;; Integration with and fixes for other packages
20460 ;;; Imenu support
20462 (defvar org-imenu-markers nil
20463 "All markers currently used by Imenu.")
20464 (make-variable-buffer-local 'org-imenu-markers)
20466 (defun org-imenu-new-marker (&optional pos)
20467 "Return a new marker for use by Imenu, and remember the marker."
20468 (let ((m (make-marker)))
20469 (move-marker m (or pos (point)))
20470 (push m org-imenu-markers)
20471 m))
20473 (defun org-imenu-get-tree ()
20474 "Produce the index for Imenu."
20475 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20476 (setq org-imenu-markers nil)
20477 (let* ((n org-imenu-depth)
20478 (re (concat "^" (org-get-limited-outline-regexp)))
20479 (subs (make-vector (1+ n) nil))
20480 (last-level 0)
20481 m level head)
20482 (save-excursion
20483 (save-restriction
20484 (widen)
20485 (goto-char (point-max))
20486 (while (re-search-backward re nil t)
20487 (setq level (org-reduced-level (funcall outline-level)))
20488 (when (<= level n)
20489 (looking-at org-complex-heading-regexp)
20490 (setq head (org-link-display-format
20491 (org-match-string-no-properties 4))
20492 m (org-imenu-new-marker))
20493 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20494 (if (>= level last-level)
20495 (push (cons head m) (aref subs level))
20496 (push (cons head (aref subs (1+ level))) (aref subs level))
20497 (loop for i from (1+ level) to n do (aset subs i nil)))
20498 (setq last-level level)))))
20499 (aref subs 1)))
20501 (eval-after-load "imenu"
20502 '(progn
20503 (add-hook 'imenu-after-jump-hook
20504 (lambda ()
20505 (if (org-mode-p)
20506 (org-show-context 'org-goto))))))
20508 (defun org-link-display-format (link)
20509 "Replace a link with either the description, or the link target
20510 if no description is present"
20511 (save-match-data
20512 (if (string-match org-bracket-link-analytic-regexp link)
20513 (replace-match (if (match-end 5)
20514 (match-string 5 link)
20515 (concat (match-string 1 link)
20516 (match-string 3 link)))
20517 nil t link)
20518 link)))
20520 (defun org-toggle-link-display ()
20521 "Toggle the literal or descriptive display of links."
20522 (interactive)
20523 (if org-descriptive-links
20524 (progn (org-remove-from-invisibility-spec '(org-link))
20525 (org-restart-font-lock)
20526 (setq org-descriptive-links nil))
20527 (progn (add-to-invisibility-spec '(org-link))
20528 (org-restart-font-lock)
20529 (setq org-descriptive-links t))))
20531 ;; Speedbar support
20533 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20534 "Overlay marking the agenda restriction line in speedbar.")
20535 (overlay-put org-speedbar-restriction-lock-overlay
20536 'face 'org-agenda-restriction-lock)
20537 (overlay-put org-speedbar-restriction-lock-overlay
20538 'help-echo "Agendas are currently limited to this item.")
20539 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20541 (defun org-speedbar-set-agenda-restriction ()
20542 "Restrict future agenda commands to the location at point in speedbar.
20544 (interactive)
20545 (require 'org-agenda)
20546 (let (p m tp np dir txt)
20547 (cond
20548 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20549 'org-imenu t))
20550 (setq m (get-text-property p 'org-imenu-marker))
20551 (with-current-buffer (marker-buffer m)
20552 (goto-char m)
20553 (org-agenda-set-restriction-lock 'subtree)))
20554 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20555 'speedbar-function 'speedbar-find-file))
20556 (setq tp (previous-single-property-change
20557 (1+ p) 'speedbar-function)
20558 np (next-single-property-change
20559 tp 'speedbar-function)
20560 dir (speedbar-line-directory)
20561 txt (buffer-substring-no-properties (or tp (point-min))
20562 (or np (point-max))))
20563 (with-current-buffer (find-file-noselect
20564 (let ((default-directory dir))
20565 (expand-file-name txt)))
20566 (unless (org-mode-p)
20567 (error "Cannot restrict to non-Org-mode file"))
20568 (org-agenda-set-restriction-lock 'file)))
20569 (t (error "Don't know how to restrict Org-mode's agenda")))
20570 (move-overlay org-speedbar-restriction-lock-overlay
20571 (point-at-bol) (point-at-eol))
20572 (setq current-prefix-arg nil)
20573 (org-agenda-maybe-redo)))
20575 (eval-after-load "speedbar"
20576 '(progn
20577 (speedbar-add-supported-extension ".org")
20578 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20579 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20580 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20581 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20582 (add-hook 'speedbar-visiting-tag-hook
20583 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20585 ;;; Fixes and Hacks for problems with other packages
20587 ;; Make flyspell not check words in links, to not mess up our keymap
20588 (defun org-mode-flyspell-verify ()
20589 "Don't let flyspell put overlays at active buttons, or on
20590 {todo,all-time,additional-option-like}-keywords."
20591 (let ((pos (max (1- (point)) (point-min)))
20592 (word (thing-at-point 'word)))
20593 (and (not (get-text-property pos 'keymap))
20594 (not (get-text-property pos 'org-no-flyspell))
20595 (not (member word org-todo-keywords-1))
20596 (not (member word org-all-time-keywords))
20597 (not (member word org-additional-option-like-keywords)))))
20599 (defun org-remove-flyspell-overlays-in (beg end)
20600 "Remove flyspell overlays in region."
20601 (and (org-bound-and-true-p flyspell-mode)
20602 (fboundp 'flyspell-delete-region-overlays)
20603 (flyspell-delete-region-overlays beg end))
20604 (add-text-properties beg end '(org-no-flyspell t)))
20606 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20607 (eval-after-load "bookmark"
20608 '(if (boundp 'bookmark-after-jump-hook)
20609 ;; We can use the hook
20610 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20611 ;; Hook not available, use advice
20612 (defadvice bookmark-jump (after org-make-visible activate)
20613 "Make the position visible."
20614 (org-bookmark-jump-unhide))))
20616 ;; Make sure saveplace shows the location if it was hidden
20617 (eval-after-load "saveplace"
20618 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20619 "Make the position visible."
20620 (org-bookmark-jump-unhide)))
20622 ;; Make sure ecb shows the location if it was hidden
20623 (eval-after-load "ecb"
20624 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20625 "Make hierarchy visible when jumping into location from ECB tree buffer."
20626 (if (org-mode-p)
20627 (org-show-context))))
20629 (defun org-bookmark-jump-unhide ()
20630 "Unhide the current position, to show the bookmark location."
20631 (and (org-mode-p)
20632 (or (outline-invisible-p)
20633 (save-excursion (goto-char (max (point-min) (1- (point))))
20634 (outline-invisible-p)))
20635 (org-show-context 'bookmark-jump)))
20637 ;; Make session.el ignore our circular variable
20638 (eval-after-load "session"
20639 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20641 ;;;; Experimental code
20643 (defun org-closed-in-range ()
20644 "Sparse tree of items closed in a certain time range.
20645 Still experimental, may disappear in the future."
20646 (interactive)
20647 ;; Get the time interval from the user.
20648 (let* ((time1 (org-float-time
20649 (org-read-date nil 'to-time nil "Starting date: ")))
20650 (time2 (org-float-time
20651 (org-read-date nil 'to-time nil "End date:")))
20652 ;; callback function
20653 (callback (lambda ()
20654 (let ((time
20655 (org-float-time
20656 (apply 'encode-time
20657 (org-parse-time-string
20658 (match-string 1))))))
20659 ;; check if time in interval
20660 (and (>= time time1) (<= time time2))))))
20661 ;; make tree, check each match with the callback
20664 ;;;; Finish up
20666 (provide 'org)
20668 (run-hooks 'org-load-hook)
20670 ;;; org.el ends here