| blob | ca89ab58c422bafc96fd1049235329f4fc72394e |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.6
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."
259 "Load all extensions listed in `org-modules'."
264 org-modules)
268 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
277 (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)
278 "Modules that should always be loaded together with org.el.
279 If a description starts with <C>, the file is not part of Emacs
280 and loading it will require that you have downloaded and properly installed
281 the org-mode distribution.
283 You can also use this system to load external packages (i.e. neither Org
284 core modules, nor modules from the CONTRIB directory). Just add symbols
285 to the end of the list. If the package is called org-xyz.el, then you need
286 to add the symbol `xyz', and the package must have a call to
288 (provide 'org-xyz)"
291 :type
322 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
331 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
340 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
357 "Non-nil means make shift-cursor commands select text when possible.
359 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
360 selecting a region, or enlarge regions started in this way.
361 In Org-mode, in special contexts, these same keys are used for other
362 purposes, important enough to compete with shift selection. Org tries
363 to balance these needs by supporting `shift-select-mode' outside these
364 special contexts, under control of this variable.
366 The default of this variable is nil, to avoid confusing behavior. Shifted
367 cursor keys will then execute Org commands in the following contexts:
368 - on a headline, changing TODO state (left/right) and priority (up/down)
369 - on a time stamp, changing the time
370 - in a plain list item, changing the bullet type
371 - in a property definition line, switching between allowed values
372 - in the BEGIN line of a clock table (changing the time block).
373 Outside these contexts, the commands will throw an error.
375 When this variable is t and the cursor is not in a special context,
376 Org-mode will support shift-selection for making and enlarging regions.
377 To make this more effective, the bullet cycling will no longer happen
378 anywhere in an item line, but only if the cursor is exactly on the bullet.
380 If you set this variable to the symbol `always', then the keys
381 will not be special in headlines, property lines, and item lines, to make
382 shift selection work there as well. If this is what you want, you can
383 use the following alternative commands: `C-c C-t' and `C-c ,' to
384 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
385 TODO sets, `C-c -' to cycle item bullet types, and properties can be
386 edited by hand or in column view.
388 However, when the cursor is on a timestamp, shift-cursor commands
389 will still edit the time stamp - this is just too good to give up.
391 XEmacs user should have this variable set to nil, because shift-select-mode
392 is Emacs 23 only."
400 "Options concerning startup of Org-mode."
405 "Non-nil means entering Org-mode will switch to OVERVIEW.
406 This can also be configured on a per-file basis by adding one of
407 the following lines anywhere in the buffer:
409 #+STARTUP: fold (or `overview', this is equivalent)
410 #+STARTUP: nofold (or `showall', this is equivalent)
411 #+STARTUP: content
412 #+STARTUP: showeverything"
421 "Non-nil means entering Org-mode will set `truncate-lines'.
422 This is useful since some lines containing links can be very long and
423 uninteresting. Also tables look terrible when wrapped."
428 "Non-nil means turn on `org-indent-mode' on startup.
429 This can also be configured on a per-file basis by adding one of
430 the following lines anywhere in the buffer:
432 #+STARTUP: indent
433 #+STARTUP: noindent"
441 When this option is turned on, you can use TeX-like syntax for sub- and
443 considered as a single item - so grouping with {} is normally not
444 needed. For example, the following things will be parsed as single
445 sub- or superscripts.
447 10^24 or 10^tau several digits will be considered 1 item.
448 10^-12 or 10^-tau a leading sign with digits or a word
449 x^2-y^3 will be read as x^2 - y^3, because items are
450 terminated by almost any nonword/nondigit char.
451 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
453 Still, ambiguity is possible - so when in doubt use {} to enclose the
454 sub/superscript. If you set this variable to the symbol `{}',
455 the braces are *required* in order to trigger interpretations as
457 frequently in plain text.
459 Not all export backends support this, but HTML does.
474 "Non-nil means turn on `org-beamer-mode' on startup.
475 This can also be configured on a per-file basis by adding one of
476 the following lines anywhere in the buffer:
478 #+STARTUP: beamer"
483 "Non-nil means align all tables when visiting a file.
484 This is useful when the column width in tables is forced with <N> cookies
485 in table fields. Such tables will look correct only after the first re-align.
486 This can also be configured on a per-file basis by adding one of
487 the following lines anywhere in the buffer:
488 #+STARTUP: align
489 #+STARTUP: noalign"
494 "Non-nil means show inline images when loading a new Org file.
495 This can also be configured on a per-file basis by adding one of
496 the following lines anywhere in the buffer:
497 #+STARTUP: inlineimages
498 #+STARTUP: noinlineimages"
503 "Non-nil means insert the first line setting Org-mode in empty files.
504 When the function `org-mode' is called interactively in an empty file, this
505 normally means that the file name does not automatically trigger Org-mode.
506 To ensure that the file will always be in Org-mode in the future, a
507 line enforcing Org-mode will be inserted into the buffer, if this option
508 has been set."
513 "Non-nil means use alternative key bindings for some keys.
514 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
515 These keys are also used by other packages like shift-selection-mode'
516 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
517 If you want to use Org-mode together with one of these other modes,
518 or more generally if you would like to move some Org-mode commands to
519 other keys, set this variable and configure the keys with the variable
520 `org-disputed-keys'.
522 This option is only relevant at load-time of Org-mode, and must be set
523 *before* org.el is loaded. Changing it requires a restart of Emacs to
524 become effective."
529 "Non-nil means use extra key sequence definitions for certain commands.
530 This happens automatically if you run XEmacs or if `window-system'
531 is nil. This variable lets you do the same manually. You must
532 set it before loading org.
534 Example: on Carbon Emacs 22 running graphically, with an external
535 keyboard on a Powerbook, the default way of setting M-left might
536 not work for either Alt or ESC. Setting this variable will make
537 it work for ESC."
551 "Keys for which Org-mode and other modes compete.
552 This is an alist, cars are the default keys, second element specifies
553 the alternative to use when `org-replace-disputed-keys' is t.
555 Keys can be specified in any syntax supported by `define-key'.
556 The value of this option takes effect only at Org-mode's startup,
557 therefore you'll have to restart Emacs to apply it after changing."
562 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
563 Or return the original if not disputed.
564 Also apply the translations defined in `org-xemacs-key-equivalents'."
569 org-disputed-keys)))
573 key)
583 "Define a key, possibly translated, as returned by `org-key'."
587 "The ellipsis to use in the Org-mode outline.
588 When nil, just use the standard three dots. When a string, use that instead,
589 When a face, use the standard 3 dots, but with the specified face.
590 The change affects only Org-mode (which will then use its own display table).
591 Changing this requires executing `M-x org-mode' in a buffer to become
592 effective."
602 "Keywords in Org-mode."
607 "String to mark deadline entries.
608 A deadline is this string, followed by a time stamp. Should be a word,
609 terminated by a colon. You can insert a schedule keyword and
611 Changes become only effective after restarting Emacs."
616 "String to mark scheduled TODO entries.
617 A schedule is this string, followed by a time stamp. Should be a word,
618 terminated by a colon. You can insert a schedule keyword and
620 Changes become only effective after restarting Emacs."
625 "String used as the prefix for timestamps logging closing a TODO entry."
630 "String used as prefix for timestamps clocking work hours on an item."
635 "Entries starting with this keyword will never be exported.
636 An entry can be toggled between COMMENT and normal with
638 Changes become only effective after restarting Emacs."
643 "Entries starting with this keyword will be exported in fixed-width font.
644 Quoting applies only to the text in the entry following the headline, and does
645 not extend beyond the next headline, even if that is lower level.
646 An entry can be toggled between QUOTE and normal with
653 "Regular expression for specifying repeated events.
657 "Options concerning the general structure of Org-mode files."
662 "Options about how to make context of a location visible."
686 "Non-nil means show full hierarchy when revealing a location.
687 Org-mode often shows locations in an org-mode file which might have
688 been invisible before. When this is set, the hierarchy of headings
689 above the exposed location is shown.
690 Turning this off for example for sparse trees makes them very compact.
691 Instead of t, this can also be an alist specifying this option for different
692 contexts. Valid contexts are
693 agenda when exposing an entry from the agenda
694 org-goto when using the command `org-goto' on key C-c C-j
695 occur-tree when using the command `org-occur' on key C-c /
696 tags-tree when constructing a sparse tree based on tags matches
697 link-search when exposing search matches associated with a link
698 mark-goto when exposing the jump goal of a mark
699 bookmark-jump when exposing a bookmark location
700 isearch when exiting from an incremental search
701 default default for all contexts not set explicitly"
706 "Non-nil means show following heading when revealing a location.
707 Org-mode often shows locations in an org-mode file which might have
708 been invisible before. When this is set, the heading following the
709 match is shown.
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "Non-nil means show all sibling heading when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the sibling of the current entry
722 heading are all made visible. If `org-show-hierarchy-above' is t,
723 the same happens on each level of the hierarchy above the current entry.
725 By default this is on for the isearch context, off for all other contexts.
726 Turning this off for example for sparse trees makes them very compact,
727 but makes it harder to edit the location of the match. In such a case,
729 Instead of t, this can also be an alist specifying this option for different
730 contexts. See `org-show-hierarchy-above' for valid contexts."
735 "Non-nil means show the entry below a headline when revealing a location.
736 Org-mode often shows locations in an org-mode file which might have
737 been invisible before. When this is set, the text below the headline that is
738 exposed is also shown.
740 By default this is off for all contexts.
741 Instead of t, this can also be an alist specifying this option for different
742 contexts. See `org-show-hierarchy-above' for valid contexts."
747 "How should indirect tree buffers be displayed?
748 This applies to indirect buffers created with the commands
750 Valid values are:
751 current-window Display in the current window
752 other-window Just display in another window.
753 dedicated-frame Create one new frame, and re-use it each time.
754 new-frame Make a new frame each time. Note that in this case
755 previously-made indirect buffers are kept, and you need to
756 kill these buffers yourself."
766 "Non-nil means activate single letter commands at beginning of a headline.
767 This may also be a function to test for appropriate locations where speed
768 commands should be active."
776 "Alist of additional speed commands.
777 This list will be checked before `org-speed-commands-default'
778 when the variable `org-use-speed-commands' is non-nil
779 and when the cursor is at the beginning of a headline.
780 The car if each entry is a string with a single letter, which must
781 be assigned to `self-insert-command' in the global map.
782 The cdr is either a command to be called interactively, a function
783 to be called, or a form to be evaluated.
784 An entry that is just a list with a single string will be interpreted
785 as a descriptive headline that will be added when listing the speed
786 commands in the Help buffer using the `?' speed command."
798 "Options concerning visibility cycling in Org-mode."
803 "Non-nil means skip CHILDREN state in entries that don't have any."
808 "Maximum level which should still be subject to visibility cycling.
809 Levels higher than this will, for cycling, be treated as text, not a headline.
810 When `org-odd-levels-only' is set, a value of N in this variable actually
811 means 2N-1 stars as the limiting headline.
812 When nil, cycle all levels.
813 Note that the limiting level of cycling is also influenced by
814 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
815 `org-inlinetask-min-level' is, cycling will be limited to levels one less
816 than its value."
823 "Names of drawers. Drawers are not opened by cycling on the headline above.
824 Drawers only open with a TAB on the drawer line itself. A drawer looks like
825 this:
826 :DRAWERNAME:
827 .....
828 :END:
830 the property API.
832 Drawers can be defined on the per-file basis with a line like:
834 #+DRAWERS: HIDDEN STATE PROPERTIES"
840 "Non-nil means entering Org-mode will fold all blocks.
841 This can also be set in on a per-file basis with
843 #+STARTUP: hideblocks
844 #+STARTUP: showblocks"
850 "Cycle globally if cursor is at beginning of buffer and not at a headline.
851 This makes it possible to do global cycling without having to use S-TAB or
853 of the buffer
854 must not be a headline - it may be empty or some other text. When used in
855 this way, `org-cycle-hook' is disables temporarily, to make sure the
856 cursor stays at the beginning of the buffer.
857 When this option is nil, don't do anything special at the beginning
858 of the buffer."
863 "Non-nil means cycle entry level or item indentation in new empty entries.
865 When the cursor is at the end of an empty headline, i.e with only stars
866 and maybe a TODO keyword, TAB will then switch the entry to become a child,
867 and then all possible ancestor states, before returning to the original state.
868 This makes data entry extremely fast: M-RET to create a new headline,
869 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
871 When the cursor is at the end of an empty plain list item, one TAB will
872 make it a subitem, two or more tabs will back up to make this an item
873 higher up in the item hierarchy."
878 "Where should `org-cycle' emulate TAB.
879 nil Never
880 white Only in completely white lines
881 whitestart Only at the beginning of lines, before the first non-white char
882 t Everywhere except in headlines
883 exc-hl-bol Everywhere except at the start of a headline
884 If TAB is used in a place where it does not emulate TAB, the current subtree
885 visibility is cycled."
892 ))
895 "Number of empty lines needed to keep an empty line between collapsed trees.
896 If you leave an empty line between the end of a subtree and the following
897 headline, this empty line is hidden when the subtree is folded.
898 Org-mode will leave (exactly) one empty line visible if the number of
899 empty lines is equal or larger to the number given in this variable.
900 So the default 2 means at least 2 empty lines after the end of a subtree
901 are needed to produce free space between a collapsed subtree and the
902 following headline.
904 If the number is negative, and the number of empty lines is at least -N,
905 all empty lines are shown.
907 Special case: when 0, never leave empty lines in collapsed view."
913 "Hook that is run before visibility cycling is happening.
914 The function(s) in this hook must accept a single argument which indicates
915 the new state that will be set right after running this hook. The
916 argument is a symbol. Before a global state change, it can have the values
917 `overview', `content', or `all'. Before a local state change, it can have
918 the values `folded', `children', or `subtree'."
923 org-cycle-hide-drawers
924 org-cycle-show-empty-lines
925 org-optimize-window-after-visibility-change)
926 "Hook that is run after `org-cycle' has changed the buffer visibility.
927 The function(s) in this hook must accept a single argument which indicates
928 the new state that was set by the most recent `org-cycle' command. The
929 argument is a symbol. After a global state change, it can have the values
930 `overview', `content', or `all'. After a local state change, it can have
931 the values `folded', `children', or `subtree'."
936 "Options concerning structure editing in Org-mode."
941 "Non-nil means skip even levels and only use odd levels for the outline.
942 This has the effect that two stars are being added/taken away in
943 promotion/demotion commands. It also influences how levels are
944 handled by the exporters.
945 Changing it requires restart of `font-lock-mode' to become effective
946 for fontification also in regions already fontified.
947 You may also set this on a per-file basis by adding one of the following
948 lines to the buffer:
950 #+STARTUP: odd
951 #+STARTUP: oddeven"
957 "Non-nil means adapt indentation to outline node level.
959 When this variable is set, Org assumes that you write outlines by
960 indenting text in each node to align with the headline (after the stars).
961 The following issues are influenced by this variable:
963 - When this is set and the *entire* text in an entry is indented, the
964 indentation is increased by one space in a demotion command, and
965 decreased by one in a promotion command. If any line in the entry
966 body starts with text at column 0, indentation is not changed at all.
968 - Property drawers and planning information is inserted indented when
969 this variable s set. When nil, they will not be indented.
971 - TAB indents a line relative to context. The lines below a headline
972 will be indented when this variable is set.
974 Note that this is all about true indentation, by adding and removing
975 space characters. See also `org-indent.el' which does level-dependent
976 indentation in a virtual way, i.e. at display time in Emacs."
981 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
983 When t, `C-a' will bring back the cursor to the beginning of the
984 headline text, i.e. after the stars and after a possible TODO keyword.
985 In an item, this will be the position after the bullet.
986 When the cursor is already at that position, another `C-a' will bring
987 it to the beginning of the line.
989 `C-e' will jump to the end of the headline, ignoring the presence of tags
990 in the headline. A second `C-e' will then jump to the true end of the
991 line, after any tags. This also means that, when this variable is
992 non-nil, `C-e' also will never jump beyond the end of the heading of a
993 folded section, i.e. not after the ellipses.
995 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
996 going to the true line boundary first. Only a directly following, identical
997 keypress will bring the cursor to the special positions.
999 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1000 set separately."
1019 "Non-nil means `C-k' will behave specially in headlines.
1020 When nil, `C-k' will call the default `kill-line' command.
1021 When t, the following will happen while the cursor is in the headline:
1023 - When the cursor is at the beginning of a headline, kill the entire
1024 line and possible the folded subtree below the line.
1025 - When in the middle of the headline text, kill the headline up to the tags.
1026 - When after the headline text, kill the tags."
1031 "Non-nil means, do not delete a hidden subtree with C-k.
1032 When set to the symbol `error', simply throw an error when C-k is
1033 used to kill (part-of) a headline that has hidden text behind it.
1034 Any other non-nil value will result in a query to the user, if it is
1035 OK to kill that hidden subtree. When nil, kill without remorse."
1043 "Non-nil means when yanking subtrees, fold them.
1044 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1045 it starts with a heading and all other headings in it are either children
1046 or siblings, then fold all the subtrees. However, do this only if no
1047 text after the yank would be swallowed into a folded tree by this action."
1052 "Non-nil means when yanking subtrees, adjust the level.
1053 With this setting, `org-paste-subtree' is used to insert the subtree, see
1054 this function for details."
1059 "Non-nil means M-RET will split the line at the cursor position.
1060 When nil, it will go to the end of the line before making a
1061 new line.
1062 You may also set this option in a different way for different
1063 contexts. Valid contexts are:
1065 headline when creating a new headline
1066 item when creating a new item
1067 table in a table field
1068 default the value to be used for all contexts not explicitly
1069 customized"
1086 "Non-nil means insert new headings after the current subtree.
1087 When nil, the new heading is created directly after the current line.
1090 for the duration of the command."
1096 "Should `org-insert-heading' leave a blank line before new heading/item?
1097 The value is an alist, with `heading' and `plain-list-item' as CAR,
1098 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1099 which case Org will look at the surrounding headings/items and try to
1100 make an intelligent decision whether to insert a blank line or not.
1102 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1103 set, the setting here is ignored and no empty line is inserted, to avoid
1104 breaking the list structure."
1117 "Hook being run after inserting a new heading."
1123 This currently only means they are never auto-wrapped.
1124 When nil, such lines will be treated like ordinary lines.
1125 See also the QUOTE keyword."
1130 "Non-nil means typing characters in `org-goto' starts incremental search."
1135 "Options concerning sparse trees in Org-mode."
1140 "Non-nil means highlight all matches that define a sparse tree.
1141 The highlights will automatically disappear the next time the buffer is
1142 changed by an edit command."
1147 "Non-nil means any change to the buffer will remove temporary highlights.
1148 Such highlights are created by `org-occur' and `org-clock-display'.
1149 When nil, `C-c C-c needs to be used to get rid of the highlights.
1150 The highlights created by `org-preview-latex-fragment' always need
1151 `C-c C-c' to be removed."
1158 "Hook that is run after `org-occur' has constructed a sparse tree.
1159 This can be used to recenter the window to show as much of the structure
1160 as possible."
1165 "Options concerning imenu and speedbar in Org-mode."
1170 "The maximum level for Imenu access to Org-mode headlines.
1171 This also applied for speedbar access."
1176 "Options concerning tables in Org-mode."
1182 When nil, such lines will be treated like ordinary lines.
1184 When equal to the symbol `optimized', the table editor will be optimized to
1185 do the following:
1186 - Automatic overwrite mode in front of whitespace in table fields.
1187 This makes the structure of the table stay in tact as long as the edited
1188 field does not exceed the column width.
1189 - Minimize the number of realigns. Normally, the table is aligned each time
1190 TAB or RET are pressed to move to another field. With optimization this
1191 happens only if changes to a field might have changed the column width.
1192 Optimization requires replacing the functions `self-insert-command',
1193 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1194 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1195 very good at guessing when a re-align will be necessary, but you can always
1198 If you would like to use the optimized version in Org-mode, but the
1199 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1201 This variable can be used to turn on and off the table editor during a session,
1202 but in order to toggle optimization, a restart is required.
1204 See also the variable `org-table-auto-blank-field'."
1212 "Non-nil means cluster self-insert commands for undo when possible.
1213 If this is set, then, like in the Emacs command loop, 20 consecutive
1214 characters will be undone together.
1215 This is configurable, because there is some impact on typing performance."
1220 "Non-nil means TAB will automatically notice a table.el table.
1221 When it sees such a table, it moves point into it and - if necessary -
1222 calls `table-recognize-table'."
1227 "Options concerning links in Org-mode."
1232 "Buffer-local version of `org-link-abbrev-alist', which see.
1237 "Alist of link abbreviations.
1238 The car of each element is a string, to be replaced at the start of a link.
1240 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1242 [[linkkey:tag][description]]
1244 The 'linkkey' must be a word word, starting with a letter, followed
1245 by letters, numbers, '-' or '_'.
1247 If REPLACE is a string, the tag will simply be appended to create the link.
1250 be inserted at that point (see the function `url-hexify-string').
1252 REPLACE may also be a function that will be called with the tag as the
1253 only argument to create the link, which should be returned as a string.
1255 See the manual for examples."
1265 "Non-nil means hide link part and only show description of bracket links.
1266 Bracket links are like [[link][description]]. This variable sets the initial
1267 state in new org-mode buffers. The setting can then be toggled on a
1268 per-buffer basis from the Org->Hyperlinks menu."
1273 "How the path name in file links should be stored.
1274 Valid values are:
1276 relative Relative to the current directory, i.e. the directory of the file
1277 into which the link is being inserted.
1278 absolute Absolute path, if possible with ~ for home directory.
1279 noabbrev Absolute path, no abbreviation of home directory.
1280 adaptive Use relative path for files in the current directory and sub-
1281 directories of it. For other files, use an absolute path."
1290 "Types of links that should be activated in Org-mode files.
1291 This is a list of symbols, each leading to the activation of a certain link
1292 type. In principle, it does not hurt to turn on most link types - there may
1293 be a small gain when turning off unused link types. The types are:
1295 bracket The recommended [[link][description]] or [[link]] links with hiding.
1296 angle Links in angular brackets that may contain whitespace like
1297 <bbdb:Carsten Dominik>.
1298 plain Plain links in normal text, no whitespace, like http://google.com.
1299 radio Text that is matched by a radio target, see manual for details.
1300 tag Tag settings in a headline (link to tag search).
1301 date Time stamps (link to calendar).
1302 footnote Footnote labels.
1304 Changing this variable requires a restart of Emacs to become effective."
1316 "Function to use to generate link descriptions from links.
1317 If nil the link location will be used. This function must take
1318 two parameters; the first is the link and the second the
1319 description `org-insert-link' has generated, and should return the
1320 description to use."
1325 "Options concerning storing links in Org-mode."
1330 "Format of the description part of a link to an email or usenet message.
1331 The following %-escapes will be replaced by corresponding information:
1339 %s subject
1340 %d date
1341 %m message-id.
1343 You may use normal field width specification between the % and the letter.
1344 This is for example useful to limit the length of the subject.
1358 It should match if the message is from the user him/herself."
1363 "Non-nil means storing a link to an Org file will use entry IDs.
1365 Note that before this variable is even considered, org-id must be loaded,
1366 so please customize `org-modules' and turn it on.
1368 The variable can have the following values:
1370 t Create an ID if needed to make a link to the current entry.
1372 create-if-interactive
1373 If `org-store-link' is called directly (interactively, as a user
1374 command), do create an ID to support the link. But when doing the
1375 job for remember, only use the ID if it already exists. The
1376 purpose of this setting is to avoid proliferation of unwanted
1377 IDs, just because you happen to be in an Org file when you
1378 call `org-remember' that automatically and preemptively
1379 creates a link. If you do want to get an ID link in a remember
1380 template to an entry not having an ID, create it first by
1381 explicitly creating a link to it, using `C-c C-l' first.
1383 create-if-interactive-and-no-custom-id
1384 Like create-if-interactive, but do not create an ID if there is
1385 a CUSTOM_ID property defined in the entry. This is the default.
1387 use-existing
1388 Use existing ID, do not create one.
1390 nil Never use an ID to make a link, instead link using a text search for
1391 the headline text."
1396 create-if-interactive)
1398 create-if-interactive-and-no-custom-id)
1403 "Non-nil means file links from `org-store-link' contain context.
1404 A search string will be added to the file name with :: as separator and
1405 used to find the context when the link is activated by the command
1406 `org-open-at-point'. When this option is t, the entire active region
1407 will be placed in the search string of the file link. If set to a
1408 positive integer, only the first n lines of context will be stored.
1411 negates this setting for the duration of the command."
1416 "Non-nil means keep link in list for entire session.
1418 The command `org-store-link' adds a link pointing to the current
1419 location to an internal list. These links accumulate during a session.
1420 The command `org-insert-link' can be used to insert links into any
1421 Org-mode file (offering completion for all stored links). When this
1423 will be removed from the list, to make completing the unused links
1424 more efficient."
1429 "Options concerning following links in Org-mode."
1434 "Function to translate links with different syntax to Org syntax.
1435 This can be used to translate links created for example by the Planner
1436 or emacs-wiki packages to Org syntax.
1437 The function must accept two parameters, a TYPE containing the link
1439 which is everything after the link protocol. It should return a cons
1440 with possibly modified values of type and path.
1441 Org contains a function for this, so if you set this variable to
1442 `org-translate-link-from-planner', you should be able follow many
1443 links created by planner."
1448 "Hook that is run after a link has been followed."
1453 "Non-nil means on links TAB will follow the link.
1454 Needs to be set before org.el is loaded.
1455 This really should not be used, it does not make sense, and the
1456 implementation is bad."
1461 "Non-nil means on links RET will follow the link."
1467 "Non-nil means mouse-1 on a link will follow the link.
1468 A longer mouse click will still set point. Does not work on XEmacs.
1469 Needs to be set before org.el is loaded."
1474 "Number of different positions to be recorded in the ring.
1475 Changing this requires a restart of Emacs to work correctly."
1480 "Non-nil means internal links in Org files must exactly match a headline.
1481 When nil, the link search tries to match a phrase with all words
1482 in the search text."
1488 query-to-create)))
1495 "Setup the frame configuration for following links.
1496 When following a link with Emacs, it may often be useful to display
1497 this link in another window or frame. This variable can be used to
1498 set this up for the different types of links.
1499 For VM, use any of
1500 `vm-visit-folder'
1501 `vm-visit-folder-other-window'
1502 `vm-visit-folder-other-frame'
1503 For Gnus, use any of
1504 `gnus'
1505 `gnus-other-frame'
1506 `org-gnus-no-new-news'
1507 For FILE, use any of
1508 `find-file'
1509 `find-file-other-window'
1510 `find-file-other-frame'
1511 For Wanderlust use any of
1512 `wl'
1513 `wl-other-frame'
1514 For the calendar, use the variable `calendar-setup'.
1515 For BBDB, it is currently only possible to display the matches in
1516 another window."
1540 "Non-nil means use indirect buffer to display infile links.
1541 Activating internal links (from one location in a file to another location
1542 in the same file) normally just jumps to the location. When the link is
1544 is displayed in
1545 another window. When this option is set, the other window actually displays
1546 an indirect buffer clone of the current buffer, to avoid any visibility
1547 changes to the current buffer."
1552 "Non-nil means `org-open-file' will open non-existing files.
1553 When nil, an error will be generated.
1554 This variable applies only to external applications because they
1555 might choke on non-existing files. If the link is to a file that
1556 will be opened in Emacs, the variable is ignored."
1561 "Non-nil means a link to a directory really means to index.org.
1562 When nil, following a directory link will run dired or open a finder/explorer
1563 window on that directory."
1568 "Function and arguments to call for following mailto links.
1569 This is a list with the first element being a Lisp function, and the
1570 remaining elements being arguments to the function. In string arguments,
1571 %a will be replaced by the address, and %s will be replaced by the subject
1572 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1581 "Non-nil means ask for confirmation before executing shell links.
1582 Shell links can be dangerous: just think about a link
1584 [[shell:rm -rf ~/*][Google Search]]
1587 but really it would remove your entire home directory.
1588 Therefore we advise against setting this variable to nil.
1589 Just change it to `y-or-n-p' if you want to confirm with a
1597 'safe-local-variable
1601 "A regexp to skip confirmation for shell links."
1606 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1607 Elisp links can be dangerous: just think about a link
1612 but really it would remove your entire home directory.
1613 Therefore we advise against setting this variable to nil.
1614 Just change it to `y-or-n-p' if you want to confirm with a
1622 'safe-local-variable
1626 "A regexp to skip confirmation for Elisp links."
1634 "Default file applications on a UNIX or GNU/Linux system.
1645 "Default file applications on a MacOS X system.
1647 for some files for which the OS does not have a good default.
1655 'mswindows-shell-execute
1660 'mswindows-shell-execute
1663 "Default file applications on a Windows NT system.
1668 '(
1673 )
1674 "External applications for opening `file:path' items in a document.
1675 Org-mode uses system defaults for different file types, but
1676 you can use this variable to set the application for a given file
1677 extension. The entries in this list are cons cells where the car identifies
1678 files and the cdr the corresponding command. Possible values for the
1679 file identifier are
1681 ways, depending on its contents:
1683 - Alphanumeric characters only:
1684 Match links with this file extension.
1686 to open PDFs with evince.
1688 - Regular expression: Match links where the
1689 filename matches the regexp. If you want to
1690 use groups here, use shy groups.
1694 to open *.html and *.xhtml with firefox.
1696 - Regular expression which contains (non-shy) groups:
1698 anything after that, matches the regexp.
1699 In a custom command string, %1, %2, etc. are replaced with
1700 the parts of the link that were matched by the groups.
1701 For backwards compatibility, if a command string is given
1702 that does not use any of the group matches, this case is
1703 handled identically to the second one (i.e. match against
1704 file name only).
1705 In a custom lisp form, you can access the group matches with
1706 (match-string n link).
1709 to open [[file:document.pdf::5]] with evince at page 5.
1711 `directory' Matches a directory
1712 `remote' Matches a remote file, accessible through tramp or efs.
1713 Remote files most likely should be visited through Emacs
1714 because external applications cannot handle such paths.
1715 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1716 so all files Emacs knows how to handle. Using this with
1717 command `emacs' will open most files in Emacs. Beware that this
1718 will also open html files inside Emacs, unless you add
1720 t Default for files not matched by any of the other options.
1721 `system' The system command to open files, like `open' on Windows
1722 and Mac OS X, and mailcap under GNU/Linux. This is the command
1723 that will be selected if you call `C-c C-o' with a double
1726 Possible values for the command are:
1727 `emacs' The file will be visited by the current Emacs process.
1728 `default' Use the default application for this file type, which is the
1729 association for t in the list, most likely in the system-specific
1730 part.
1731 This can be used to overrule an unwanted setting in the
1732 system-specific variable.
1734 This command is specified by the entry whose car is `system'.
1735 Most likely, the system-specific version of this variable
1736 does define this command, but you can overrule/replace it
1737 here.
1738 string A command to be executed by a shell; %s will be replaced
1739 by the path to the file.
1740 sexp A Lisp form which will be evaluated. The file path will
1741 be available in the Lisp variable `file'.
1742 For more examples, see the system specific constants
1743 `org-file-apps-defaults-macosx'
1744 `org-file-apps-defaults-windowsnt'
1745 `org-file-apps-defaults-gnu'."
1755 auto-mode))
1766 "Options concerning refiling entries in Org-mode."
1771 "Directory with org files.
1772 This is just a default location to look for Org files. There is no need
1773 at all to put your files into this directory. It is only used in the
1774 following situations:
1776 1. When a remember template specifies a target file that is not an
1777 absolute path. The path will then be interpreted relative to
1778 `org-directory'
1779 2. When a remember note is filed away in an interactive way (when exiting the
1780 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1781 with `org-directory' as the default path."
1787 "Default target for storing notes.
1788 Used as a fall back file for org-remember.el and org-capture.el, for
1789 templates that do not specify a target file."
1794 file))
1797 "The default interface to be used for `org-goto'.
1798 Allowed values are:
1799 outline The interface shows an outline of the relevant file
1800 and the correct heading is found by moving through
1801 the outline or by searching with incremental search.
1802 outline-path-completion Headlines in the current buffer are offered via
1803 completion. This is the interface also used by
1804 the refile command."
1811 "Maximum target level when running `org-goto' with refile interface."
1816 "Non-nil means store new notes at the beginning of a file or entry.
1817 When nil, new notes will be filed to the end of a file or entry.
1818 This can also be a list with cons cells of regular expressions that
1819 are matched against file names, and values."
1829 "Information to record when a task is refiled.
1831 Possible values are:
1833 nil Don't add anything
1834 time Add a time stamp to the task
1835 note Prompt for a note and add it with template `org-log-note-headings'
1837 This option can also be set with on a per-file-basis with
1839 #+STARTUP: nologrefile
1840 #+STARTUP: logrefile
1841 #+STARTUP: lognoterefile
1843 You can have local logging settings for a subtree by setting the LOGGING
1844 property to one or more of these keywords.
1846 When bulk-refiling from the agenda, the value `note' is forbidden and
1847 will temporarily be changed to `time'."
1857 This is list of cons cells. Each cell contains:
1858 - a specification of the files to be considered, either a list of files,
1859 or a symbol whose function or variable value will be used to retrieve
1860 a file name or a list of file names. If you use `org-agenda-files' for
1861 that, all agenda files will be scanned for targets. Nil means consider
1862 headings in the current buffer.
1863 - A specification of how to find candidate refile targets. This may be
1864 any of:
1866 This tag has to be present in all target headlines, inheritance will
1867 not be considered.
1869 todo keyword.
1871 headlines that are refiling targets.
1872 - a cons cell (:level . N). Any headline of level N is considered a target.
1873 Note that, when `org-odd-levels-only' is set, level corresponds to
1874 order in hierarchy, not to the number of stars.
1875 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1876 Note that, when `org-odd-levels-only' is set, level corresponds to
1877 order in hierarchy, not to the number of stars.
1879 You can set the variable `org-refile-target-verify-function' to a function
1880 to verify each headline found by the simple criteria above.
1882 When this variable is nil, all top-level headlines in the current buffer
1883 are used, equivalent to the value `((nil . (:level . 1))'."
1899 "Function to verify if the headline at point should be a refile target.
1900 The function will be called without arguments, with point at the
1901 beginning of the headline. It should return t and leave point
1902 where it is if the headline is a valid target for refiling.
1904 If the target should not be selected, the function must return nil.
1905 In addition to this, it may move point to a place from where the search
1906 should be continued. For example, the function may decide that the entire
1907 subtree of the current entry should be excluded and move point to the end
1908 of the subtree."
1913 "Non-nil means cache refile targets to speed up the process.
1914 The cache for a particular file will be updated automatically when
1915 the buffer has been killed, or when any of the marker used for flagging
1916 refile targets no longer points at a live buffer.
1917 If you have added new entries to a buffer that might themselves be targets,
1918 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1919 find that easier, `C-u C-u C-u C-c C-w'."
1924 "Non-nil means provide refile targets as paths.
1925 So a level 3 headline will be available as level1/level2/level3.
1927 When the value is `file', also include the file name (without directory)
1928 into the path. In this case, you can also stop the completion after
1929 the file name, to get entries inserted as top level in the file.
1931 When `full-file-path', include the full file path."
1940 "Non-nil means complete the outline path in hierarchical steps.
1941 When Org-mode uses the refile interface to select an outline path
1942 \(see variable `org-refile-use-outline-path'), the completion of
1943 the path can be done is a single go, or if can be done in steps down
1944 the headline hierarchy. Going in steps is probably the best if you
1945 do not use a special completion package like `ido' or `icicles'.
1946 However, when using these packages, going in one step can be very
1947 fast, while still showing the whole path to the entry."
1952 "Non-nil means allow to create new nodes as refile targets.
1954 of an existing node. When the value of this variable is `confirm',
1955 new node creation must be confirmed by the user (recommended)
1956 When nil, the completion must match an existing entry.
1958 Note that, if the new heading is not seen by the criteria
1959 listed in `org-refile-targets', multiple instances of the same
1960 heading would be created by trying again to file under the new
1961 heading."
1969 "Options concerning TODO items in Org-mode."
1974 "Options concerning Progress logging in Org-mode."
1981 "The available interpretation symbols for customizing `org-todo-keywords'.
1985 "Shall some commands act upon siblings in the active region?
1986 The list of commands is:
1987 - `org-schedule'
1988 - `org-deadline'
1989 - `org-archive-subtree'
1990 - `org-archive-to-archive-sibling'
1991 - `org-archive-set-tag'
1992 - `org-toggle-archive-tag'"
1997 "List of TODO entry keyword sequences and their interpretation.
2000 Each sequence starts with a symbol, either `sequence' or `type',
2001 indicating if the keywords should be interpreted as a sequence of
2002 action steps, or as different types of TODO items. The first
2003 keywords are states requiring action - these states will select a headline
2004 for inclusion into the global TODO list Org-mode produces. If one of
2007 the last keyword is treated as the only DONE state of the sequence.
2010 additional state where no keyword is present. For details about this
2011 cycling, see the manual.
2013 TODO keywords and interpretation can also be set on a per-file basis with
2014 the special #+SEQ_TODO and #+TYP_TODO lines.
2016 Each keyword can optionally specify a character for fast state selection
2017 \(in combination with the variable `org-use-fast-todo-selection')
2018 and specifiers for state change logging, using the same syntax
2021 indicates to record a time stamp each time this state is selected.
2023 Each keyword may also specify if a timestamp or a note should be
2024 recorded when entering or leaving the state, by adding additional
2025 characters in the parenthesis after the keyword. This looks like this:
2027 record only the time of the state change. With X and Y being either
2029 Y when leaving the state if and only if the *target* state does not
2030 define X. You may omit any of the fast-selection key or X or /Y,
2031 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2033 For backward compatibility, this variable may also be just a list
2034 of keywords - in this case the interpretation (sequence or type) will be
2035 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2045 ;;Quick and dirty way to see
2046 ;;`org-todo-interpretations'. This takes the
2047 ;;place of item arguments
2048 :convert-widget
2055 org-todo-interpretation-widgets))
2056 widget))
2087 "Controls how TODO keywords are interpreted.
2088 This variable is in principle obsolete and is only used for
2089 backward compatibility, if the interpretation of todo keywords is
2090 not given already in `org-todo-keywords'. See that variable for
2091 more information."
2098 "Non-nil means use the fast todo selection scheme with C-c C-t.
2099 This variable describes if and under what circumstances the cycling
2100 mechanism for TODO keywords will be replaced by a single-key, direct
2101 selection scheme.
2103 When nil, fast selection is never used.
2105 When the symbol `prefix', it will be used when `org-todo' is called with
2106 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2107 in an agenda buffer.
2109 When t, fast selection is used by default. In this case, the prefix
2110 argument forces cycling instead.
2112 In all cases, the special interface is only used if access keys have actually
2113 been assigned by the user, i.e. if keywords in the configuration are followed
2114 by a letter in parenthesis, like TODO(t)."
2122 "Non-nil means update todo statistics after insert and toggle.
2123 ALL-HEADLINES means update todo statistics by including headlines
2124 with no TODO keyword as well, counting them as not done.
2125 A list of TODO keywords means the same, but skip keywords that are
2126 not in this list.
2128 When this is set, todo statistics is updated in the parent of the
2129 current entry each time a todo state is changed."
2139 "Non-nil means TODO statistics covers just direct children.
2140 When nil, all entries in the subtree are considered.
2141 This has only an effect if `org-provide-todo-statistics' is set.
2142 To set this to nil for only a single subtree, use a COOKIE_DATA
2148 "Hook which is run after the state of a TODO item was changed.
2149 The new state (a string with a TODO keyword, or nil) is available in the
2150 Lisp variable `state'."
2155 "Hook for functions that are allowed to block a state change.
2157 Each function gets as its single argument a property list, see
2158 `org-trigger-hook' for more information about this list.
2160 If any of the functions in this hook returns nil, the state change
2164 "Hook for functions that are triggered by a state change.
2166 Each function gets as its single argument a property list with at least
2167 the following elements:
2169 (:type type-of-change :position pos-at-entry-start
2170 :from old-state :to new-state)
2172 Depending on the type, more properties may be present.
2174 This mechanism is currently implemented for:
2176 TODO state changes
2177 ------------------
2178 :type todo-state-change
2179 :from previous state (keyword as a string), or nil, or a symbol
2180 'todo' or 'done', to indicate the general type of state.
2184 "Non-nil means undone TODO entries will block switching the parent to DONE.
2185 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2186 be blocked if any prior sibling is not yet done.
2187 Finally, if the parent is blocked because of ordered siblings of its own,
2188 the child will also be blocked.
2189 This variable needs to be set before org.el is loaded, and you need to
2190 restart Emacs after a change to make the change effective. The only way
2191 to change is while Emacs is running is through the customize interface."
2203 "Non-nil means unchecked boxes will block switching the parent to DONE.
2204 When this is nil, checkboxes have no influence on switching TODO states.
2205 When non-nil, you first need to check off all check boxes before the TODO
2206 entry can be switched to DONE.
2207 This variable needs to be set before org.el is loaded, and you need to
2208 restart Emacs after a change to make the change effective. The only way
2209 to change is while Emacs is running is through the customize interface."
2221 "Non-nil means inserting a TODO heading is treated as state change.
2223 logging will apply if appropriate. When nil, the new TODO item will
2224 be inserted directly, and no logging will take place."
2229 "Non-nil means switching TODO states with S-cursor counts as state change.
2230 This is the default behavior. However, setting this to nil allows a
2231 convenient way to select a TODO state and bypass any logging associated
2232 with that."
2237 "Tag changes that should be triggered by TODO state changes.
2238 This is a list. Each entry is
2240 (state-change (tag . flag) .......)
2242 State-change can be a string with a state, and empty string to indicate the
2243 state that has no TODO keyword, or it can be one of the symbols `todo'
2244 or `done', meaning any not-done or done state, respectively."
2258 "Information to record when a task moves to the DONE state.
2260 Possible values are:
2262 nil Don't add anything, just change the keyword
2263 time Add a time stamp to the task
2264 note Prompt for a note and add it with template `org-log-note-headings'
2266 This option can also be set with on a per-file-basis with
2268 #+STARTUP: nologdone
2269 #+STARTUP: logdone
2270 #+STARTUP: lognotedone
2272 You can have local logging settings for a subtree by setting the LOGGING
2273 property to one or more of these keywords."
2281 ;; Normalize old uses of org-log-done.
2288 "Information to record when the scheduling date of a tasks is modified.
2290 Possible values are:
2292 nil Don't add anything, just change the date
2293 time Add a time stamp to the task
2294 note Prompt for a note and add it with template `org-log-note-headings'
2296 This option can also be set with on a per-file-basis with
2298 #+STARTUP: nologreschedule
2299 #+STARTUP: logreschedule
2300 #+STARTUP: lognotereschedule"
2309 "Information to record when the deadline date of a tasks is modified.
2311 Possible values are:
2313 nil Don't add anything, just change the date
2314 time Add a time stamp to the task
2315 note Prompt for a note and add it with template `org-log-note-headings'
2317 This option can also be set with on a per-file-basis with
2319 #+STARTUP: nologredeadline
2320 #+STARTUP: logredeadline
2321 #+STARTUP: lognoteredeadline
2323 You can have local logging settings for a subtree by setting the LOGGING
2324 property to one or more of these keywords."
2333 "Non-nil means record a note when clocking out of an item.
2334 This can also be configured on a per-file basis by adding one of
2335 the following lines anywhere in the buffer:
2337 #+STARTUP: lognoteclock-out
2338 #+STARTUP: nolognoteclock-out"
2344 "Non-nil means the CLOSED time stamp will contain date and time.
2345 When nil, only the date will be recorded."
2359 "Headings for notes added to entries.
2360 The value is an alist, with the car being a symbol indicating the note
2361 context, and the cdr is the heading to be used. The heading may also be the
2362 empty string.
2363 %t in the heading will be replaced by a time stamp.
2364 %T will be an active time stamp instead the default inactive one
2365 %s will be replaced by the new TODO state, in double quotes.
2366 %S will be replaced by the old TODO state, in double quotes.
2367 %u will be replaced by the user name.
2368 %U will be replaced by the full user name.
2370 In fact, it is not a good idea to change the `state' entry, because
2371 agenda log mode depends on the format of these entries."
2377 "Heading when changing todo state (todo sequence only)"
2391 "Non-nil means insert state change notes and time stamps into a drawer.
2392 When nil, state changes notes will be inserted after the headline and
2393 any scheduling and clock lines, but not inside a drawer.
2395 The value of this variable should be the name of the drawer to use.
2396 LOGBOOK is proposed as the default drawer for this purpose, you can
2397 also set this to a string to define the drawer of your choice.
2401 If this variable is set, `org-log-state-notes-insert-after-drawers'
2402 will be ignored.
2404 You can set the property LOG_INTO_DRAWER to overrule this setting for
2405 a subtree."
2417 "Return the value of `org-log-into-drawer', but let properties overrule.
2418 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2419 used instead of the default value."
2427 "Non-nil means insert state change notes after any drawers in entry.
2428 Only the drawers that *immediately* follow the headline and the
2429 deadline/scheduled line are skipped.
2430 When nil, insert notes right after the heading and perhaps the line
2431 with deadline/scheduling if present.
2433 This variable will have no effect if `org-log-into-drawer' is
2434 set."
2440 "Non-nil means the latest state note will be directly after heading.
2441 When nil, the state change notes will be ordered according to time."
2447 "The TODO state to which a repeater should return the repeating task.
2448 By default this is the first task in a TODO sequence, or the previous state
2449 in a TODO_TYP set. But you can specify another task here.
2450 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2456 "Non-nil means record moving through the DONE state when triggering repeat.
2457 An auto-repeating task is immediately switched back to TODO when
2460 record a closing note, there will be no record of the task moving
2461 through DONE. This variable forces taking a note anyway.
2463 nil Don't force a record
2464 time Record a time stamp
2465 note Record a note
2467 This option can also be set with on a per-file-basis with
2469 #+STARTUP: logrepeat
2470 #+STARTUP: lognoterepeat
2471 #+STARTUP: nologrepeat
2473 You can have local logging settings for a subtree by setting the LOGGING
2474 property to one or more of these keywords."
2484 "Priorities in Org-mode."
2489 "Non-nil means priority commands are active.
2490 When nil, these commands will be disabled, so that you never accidentally
2491 set a priority."
2496 "The highest priority of TODO items. A character like ?A, ?B etc.
2497 Must have a smaller ASCII number than `org-lowest-priority'."
2502 "The lowest priority of TODO items. A character like ?A, ?B etc.
2503 Must have a larger ASCII number than `org-highest-priority'."
2508 "The default priority of TODO items.
2509 This is the priority an item gets if no explicit priority is given.
2510 When starting to cycle on an empty priority the first step in the cycle
2511 depends on `org-priority-start-cycle-with-default'. The resulting first
2512 step priority must not exceed the range from `org-highest-priority' to
2513 `org-lowest-priority' which means that `org-default-priority' has to be
2514 in this range exclusive or inclusive the range boundaries. Else the
2515 first step refuses to set the default and the second will fall back
2516 to (depending on the command used) the highest or lowest priority."
2521 "Non-nil means start with default priority when starting to cycle.
2522 When this is nil, the first step in the cycle will be (depending on the
2523 command used) one higher or lower than the default priority.
2524 See also `org-default-priority'."
2529 "Function to extract the priority from a string.
2530 The string is normally the headline. If this is nil Org computes the
2531 priority from the priority cookie like [#A] in the headline. It returns
2532 an integer, increasing by 1000 for each priority level.
2533 The user can set a different function here, which should take a string
2534 as an argument and return the numeric priority."
2539 "Options concerning time stamps and deadlines in Org-mode."
2544 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2545 When nil, these labeled time stamps are forces into the second line of an
2546 entry, just after the headline. When scheduling from the global TODO list,
2547 the time stamp will always be forced into the second line."
2552 "Formats for `format-time-string' which are used for time stamps.
2556 "Number of minutes to round time stamps to.
2557 These are two values, the first applies when first creating a time stamp.
2558 The second applies when changing it with the commands `S-up' and `S-down'.
2559 When changing the time stamp, this means that it will change in steps
2560 of N minutes, as given by the second value.
2562 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2563 numbers should be factors of 60, so for example 5, 10, 15.
2565 When this is larger than 1, you can still force an exact time stamp by using
2566 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2567 and by using a prefix arg to `S-up/down' to specify the exact number
2568 of minutes to shift."
2578 ;; Normalize old customizations of this variable.
2582 org-time-stamp-rounding-minutes)))
2585 "Non-nil means overlay custom formats over all time stamps.
2586 The formats are defined through the variable `org-time-stamp-custom-formats'.
2587 To turn this on on a per-file basis, insert anywhere in the file:
2588 #+STARTUP: customtime"
2596 "Custom formats for time stamps. See `format-time-string' for the syntax.
2597 These are overlayed over the default ISO format if the variable
2598 `org-display-custom-times' is set. Time like %H:%M should be at the
2599 end of the second format. The custom formats are also honored by export
2600 commands, if custom time display is turned on at the time of export."
2605 "Get the right format for a time string."
2610 f)))
2613 "The format string used when creating CLOCKSUM lines.
2614 This is also used when org-mode generates a time duration."
2620 org-mode generates a time duration."
2625 "The format string used when creating CLOCKSUM lines, or when
2626 org-mode generates a time duration."
2631 "No. of days before expiration during which a deadline becomes active.
2632 This variable governs the display in sparse trees and in the agenda.
2633 When 0 or negative, it means use this number (the absolute value of it)
2634 even if a deadline has a different individual lead time specified.
2636 Custom commands can set this variable in the options section."
2642 "Non-nil means assume future for incomplete date input from user.
2643 This affects the following situations:
2644 1. The user gives a month but not a year.
2647 2. The user gives a day, but no month.
2650 it will be considered as *this* month.
2652 If you set this variable to the symbol `time', then also the following
2653 will work:
2655 3. If the user gives a time, but no day. If the time is before now,
2656 to will be interpreted as tomorrow.
2658 Currently none of this works for ISO week specifications.
2660 When this option is nil, the current day, month and year will always be
2661 used as defaults.
2663 See also `org-agenda-jump-prefer-future'."
2671 "Should the agenda jump command prefer the future for incomplete dates?
2672 The default is to do the same as configured in `org-read-date-prefer-future'.
2673 But you can also set a deviating value here.
2674 This may t or nil, or the symbol `org-read-date-prefer-future'."
2679 org-read-date-prefer-future)
2684 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2686 Depending on the system Emacs is running on, certain dates cannot
2687 be represented with the type used internally to represent time.
2688 Dates between 1970-1-1 and 2038-1-1 can always be represented
2689 correctly. Some systems allow for earlier dates, some for later,
2690 some for both. One way to find out it to insert any date into an
2691 Org buffer, putting the cursor on the year and hitting S-up and
2692 S-down to test the range.
2694 When this variable is set to t, the date/time prompt will not let
2695 you specify dates outside the 1970-2037 range, so it is certain that
2696 these dates will work in whatever version of Emacs you are
2697 running, and also that you can move a file from one Emacs implementation
2698 to another. WHenever Org is forcing the year for you, it will display
2699 a message and beep.
2701 When this variable is nil, Org will check if the date is
2702 representable in the specific Emacs implementation you are using.
2703 If not, it will force a year, usually the current year, and beep
2704 to remind you. Currently this setting is not recommended because
2705 the likelihood that you will open your Org files in an Emacs that
2706 has limited date range is not negligible.
2708 A workaround for this problem is to use diary sexp dates for time
2709 stamps outside of this range."
2714 "Non-nil means display current interpretation of date prompt live.
2715 This display will be in an overlay, in the minibuffer."
2720 "Non-nil means pop up a calendar when prompting for a date.
2721 In the calendar, the date can be selected with mouse-1. However, the
2722 minibuffer will also be active, and you can simply enter the date as well.
2723 When nil, only the minibuffer will be available."
2731 "Hook to be used to set up keys for the date/time interface.
2732 Add key definitions to `minibuffer-local-map', which will be a temporary
2733 copy."
2738 "The hour when your day really ends. Must be an integer.
2739 This has influence for the following applications:
2741 the time given here, the day recognized as TODAY is actually yesterday.
2742 - When a date is read from the user and it is still before the time given
2743 here, the current date and time will be assumed to be yesterday, 23:59.
2744 Also, timestamps inserted in remember templates follow this rule.
2746 IMPORTANT: This is a feature whose implementation is and likely will
2747 remain incomplete. Really, it is only here because past midnight seems to
2748 be the favorite working time of John Wiegley :-)"
2753 "Non-nil means S-down will increase the time in a time stamp.
2754 When nil, S-up will increase."
2759 "Non-nil means make the calendar window follow timestamp changes.
2760 When a timestamp is modified and the calendar window is visible, it will be
2761 moved to the new date."
2766 "Options concerning tags in Org-mode."
2771 "List of tags allowed in Org-mode files.
2772 When this list is nil, Org-mode will base TAG input on what is already in the
2773 buffer.
2774 The value of this variable is an alist, the car of each entry must be a
2775 keyword as a string, the cdr may be a character that is used to select
2776 that tag through the fast-tag-selection interface.
2777 See the manual for details."
2792 "List of tags that will always appear in all Org-mode files.
2793 This is in addition to any in buffer settings or customizations
2794 of `org-tag-alist'.
2795 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2796 The value of this variable is an alist, the car of each entry must be a
2797 keyword as a string, the cdr may be a character that is used to select
2798 that tag through the fast-tag-selection interface.
2799 See the manual for details.
2800 To disable these tags on a per-file basis, insert anywhere in the file:
2801 #+STARTUP: noptag"
2812 "If non-nil, always offer completion for all tags of all agenda files.
2813 Instead of customizing this variable directly, you might want to
2814 set it locally for capture buffers, because there no list of
2815 tags in that file can be created dynamically (there are none).
2817 (add-hook 'org-capture-mode-hook
2818 (lambda ()
2819 (set (make-local-variable
2820 'org-complete-tags-always-offer-all-agenda-tags)
2821 t)))"
2826 "List of tags that can be inherited by all entries in the file.
2827 The tags will be inherited if the variable `org-use-tag-inheritance'
2828 says they should be.
2832 "Non-nil means use fast tag selection scheme.
2833 This is a special interface to select and deselect tags with single keys.
2834 When nil, fast selection is never used.
2835 When the symbol `auto', fast selection is used if and only if selection
2836 characters for tags have been configured, either through the variable
2837 `org-tag-alist' or through a #+TAGS line in the buffer.
2838 When t, fast selection is always used and selection keys are assigned
2839 automatically if necessary."
2847 "Non-nil means fast tag selection exits after first change.
2848 When nil, you have to press RET to exit it.
2849 During fast tag selection, you can toggle this flag with `C-c'.
2850 This variable can also have the value `expert'. In this case, the window
2851 displaying the tags menu is not even shown, until you press C-c again."
2859 "Non-nil means fast tags selection interface will also offer TODO states.
2863 "The column to which tags should be indented in a headline.
2864 If this number is positive, it specifies the column. If it is negative,
2865 it means that the tags should be flushright to that column. For example,
2866 -80 works well for a normal 80 character screen."
2871 "Non-nil keeps tags aligned when modifying headlines.
2872 Some operations (i.e. demoting) change the length of a headline and
2873 therefore shift the tags around. With this option turned on, after
2874 each such operation the tags are again aligned to `org-tags-column'."
2879 "Non-nil means tags in levels apply also for sublevels.
2880 When nil, only the tags directly given in a specific line apply there.
2881 This may also be a list of tags that should be inherited, or a regexp that
2882 matches tags that should be inherited. Additional control is possible
2883 with the variable `org-tags-exclude-from-inheritance' which gives an
2884 explicit list of tags to be excluded from inheritance., even if the value of
2885 `org-use-tag-inheritance' would select it for inheritance.
2887 If this option is t, a match early-on in a tree can lead to a large
2888 number of matches in the subtree when constructing the agenda or creating
2889 a sparse tree. If you only want to see the first match in a tree during
2890 a search, check out the variable `org-tags-match-list-sublevels'."
2899 "List of tags that should never be inherited.
2900 This is a way to exclude a few tags from inheritance. For way to do
2901 the opposite, to actively allow inheritance for selected tags,
2902 see the variable `org-use-tag-inheritance'."
2907 "Check if TAG is one that should be inherited."
2919 "Non-nil means list also sublevels of headlines matching a search.
2920 This variable applies to tags/property searches, and also to stuck
2921 projects because this search is based on a tags match as well.
2923 When set to the symbol `indented', sublevels are indented with
2924 leading dots.
2926 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2927 the sublevels of a headline matching a tag search often also match
2928 the same search. Listing all of them can create very long lists.
2929 Setting this variable to nil causes subtrees of a match to be skipped.
2931 This variable is semi-obsolete and probably should always be true. It
2932 is better to limit inheritance to certain tags using the variables
2933 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2941 "When set, tags are sorted using this function as a comparator."
2957 "Options concerning properties in Org-mode."
2962 "How property key/value pairs should be formatted by `indent-line'.
2963 When `indent-line' hits a property definition, it will format the line
2964 according to this format, mainly to make sure that the values are
2965 lined-up with respect to each other."
2970 "Non-nil means properties apply also for sublevels.
2972 This setting is chiefly used during property searches. Turning it on can
2973 cause significant overhead when doing a search, which is why it is not
2974 on by default.
2976 When nil, only the properties directly given in the current entry count.
2977 When t, every property is inherited. The value may also be a list of
2978 properties that should have inheritance, or a regular expression matching
2979 properties that should be inherited.
2981 However, note that some special properties use inheritance under special
2982 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2984 for valid values of a property.
2986 Note for programmers:
2987 When querying an entry with `org-entry-get', you can control if inheritance
2988 should be used. By default, `org-entry-get' looks only at the local
2989 properties. You can request inheritance by setting the inherit argument
2990 to t (to force inheritance) or to `selective' (to respect the setting
2991 in this variable)."
3000 "Check if PROPERTY is one that should be inherited."
3011 "The default column format, if no other format has been defined.
3012 This variable can be set on the per-file basis by inserting a line
3014 #+COLUMNS: %25ITEM ....."
3019 "The ellipses to be used when a field in column view is truncated.
3020 When this is the empty string, as many characters as possible are shown,
3021 but then there will be no visual indication that the field has been truncated.
3022 When this is a string of length N, the last N characters of a truncated
3023 field are replaced by this string. If the column is narrower than the
3024 ellipses string, only part of the ellipses string will be shown."
3029 "Function that modifies values for display in column view.
3030 For example, it can be used to cut out a certain part from a time stamp.
3031 The function must take 2 arguments:
3033 column-title The title of the column (*not* the property name)
3034 value The value that should be modified.
3036 The function should return the value that should be displayed,
3037 or nil if the normal value should be used."
3042 "The property that is being used to keep track of effort estimates.
3043 Effort estimates given in this property need to have the format H:MM."
3051 "List of property/value pairs that can be inherited by any entry.
3053 These are fixed values, for the preset properties. The user variable
3054 that can be used to add to this list is `org-global-properties'.
3056 The entries in this list are cons cells where the car is a property
3057 name and cdr is a string with the value. If the value represents
3062 "List of property/value pairs that can be inherited by any entry.
3064 This list will be combined with the constant `org-global-properties-fixed'.
3066 The entries in this list are cons cells where the car is a property
3067 name and cdr is a string with the value.
3069 You can set buffer-local values for the same purpose in the variable
3070 `org-file-properties' this by adding lines like
3072 #+PROPERTY: NAME VALUE"
3079 "List of property/value pairs that can be inherited by any entry.
3080 Valid for the current buffer.
3085 "Options concerning agenda views in Org-mode."
3090 "Variable used by org files to set a category for agenda display.
3091 Such files should use a file variable to set it, for example
3095 or contain a special line
3097 #+CATEGORY: ELisp
3099 If the file does not specify a category, then file's base name
3105 "The files to be used for agenda display.
3109 If an entry is a directory, all files in that directory that are matched by
3110 `org-agenda-file-regexp' will be part of the file list.
3112 If the value of the variable is not a list but a single file name, then
3113 the list of agenda files is actually stored and maintained in that file, one
3114 agenda file per line. In this file paths can be given relative to
3115 `org-directory'. Tilde expansion and environment variable substitution
3116 are also made."
3123 "Regular expression to match files for `org-agenda-files'.
3124 If any element in the list in that variable contains a directory instead
3125 of a normal file, all files in that directory that are matched by this
3126 regular expression will be included."
3131 "List of extra files to be searched by text search commands.
3132 These files will be search in addition to the agenda files by the
3133 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3134 Note that these files will only be searched for text search commands,
3135 not for the other agenda views like todo lists, tag searches or the weekly
3136 agenda. This variable is intended to list notes and possibly archive files
3137 that should also be searched by these two commands.
3138 In fact, if the first element in the list is the symbol `agenda-archives',
3139 than all archive files of all agenda files will be added to the search
3140 scope."
3151 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3152 A nil value means to remove them, after a query, from the list."
3157 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3158 The command `org-calendar-goto-agenda' will be bound to this key. The
3159 default is the character `c' because then `c' can be used to switch back and
3160 forth between agenda and calendar."
3165 "The key to be installed in `calendar-mode-map' for agenda-action.
3166 The command `org-agenda-action' will be bound to this key. The
3167 default is the character `k' because we use the same key in the agenda."
3172 "The key to be installed in `calendar-mode-map' for adding diary entries.
3173 This option is irrelevant until `org-agenda-diary-file' has been configured
3174 to point to an Org-mode file. When that is the case, the command
3175 `org-agenda-diary-entry' will be bound to the key given here, by default
3176 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3177 if you want to continue doing this, you need to change this to a different
3178 key."
3183 "File to which to add new entries with the `i' key in agenda and calendar.
3184 When this is the symbol `diary-file', the functionality in the Emacs
3185 calendar will be used to add entries to the `diary-file'. But when this
3186 points to a file, `org-agenda-diary-entry' will be used instead."
3202 org-calendar-insert-diary-entry-key
3206 "Options for embedding LaTeX code into Org-mode."
3214 "Options for creating images from LaTeX fragments.
3215 This is a property list with the following properties:
3217 `default' means use the foreground of the default face.
3219 `default' means use the background of the default face.
3220 :scale a scaling factor for the size of the images, to get more pixels
3221 :html-foreground, :html-background, :html-scale
3222 the same numbers for HTML export.
3223 :matchers a list indicating which matchers should be used to
3224 find LaTeX fragments. Valid members of this list are:
3235 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3236 When nil, just push out a message."
3245 \[PACKAGES]
3246 \[DEFAULT-PACKAGES]
3247 % The settings below are copied from fullpage.sty
3260 "The document header used for processing LaTeX fragments.
3261 It is imperative that this header make sure that no page number
3262 appears on the page. The package defined in the variables
3263 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3265 will be appended."
3272 "Set the packages alist and make sure it has 3 elements per entry."
3276 x))
3277 val)))
3281 "Get the packages alist and make sure it has 3 elements per entry."
3285 x))
3288 ;; The following variables are defined here because is it also used
3289 ;; when formatting latex fragments. Originally it was part of the
3290 ;; LaTeX exporter, which is why the name includes "export".
3307 )
3308 "Alist of default packages to be inserted in the header.
3309 Change this only if one of the packages here causes an incompatibility
3310 with another package you are using.
3311 The packages in this list are needed by one part or another of Org-mode
3312 to function properly.
3314 - inputenc, fontenc: for basic font and character selection
3315 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3316 for interpreting the entities in `org-entities'. You can skip some of these
3317 packages if you don't use any of the symbols in it.
3318 - graphicx: for including images
3319 - float, wrapfig: for figure placement
3320 - longtable: for long tables
3321 - hyperref: for cross references
3323 Therefore you should not modify this variable unless you know what you
3324 are doing. The one reason to change it anyway is that you might be loading
3325 some other package that conflicts with one of the default packages.
3327 If SNIPPET-FLAG is t, the package also needs to be included when
3328 compiling LaTeX snippets into images for inclusion into HTML."
3341 "Alist of packages to be inserted in every LaTeX header.
3342 These will be inserted after `org-export-latex-default-packages-alist'.
3344 SNIPPET-FLAG, when t, indicates that this package is also needed when
3345 turning LaTeX snippets into images for inclusion into HTML.
3346 Make sure that you only list packages here which:
3347 - you want in every file
3348 - do not conflict with the default packages in
3349 `org-export-latex-default-packages-alist'
3350 - do not conflict with the setup in `org-format-latex-header'."
3364 "Settings for Org-mode appearance."
3369 "Non-nil means fontify only the stars in each headline.
3370 When nil, the entire headline is fontified.
3371 Changing it requires restart of `font-lock-mode' to become effective
3372 also in regions already fontified."
3377 "Non-nil means hide the first N-1 stars in a headline.
3378 This works by using the face `org-hide' for these stars. This
3379 face is white for a light background, and black for a dark
3380 background. You may have to customize the face `org-hide' to
3381 make this work.
3382 Changing it requires restart of `font-lock-mode' to become effective
3383 also in regions already fontified.
3384 You may also set this on a per-file basis by adding one of the following
3385 lines to the buffer:
3387 #+STARTUP: hidestars
3388 #+STARTUP: showstars"
3393 "List of symbols corresponding to keywords to be hidden the org buffer.
3394 For example, a value '(title) for this list will make the document's title
3395 appear in the buffer without the initial #+TITLE: keyword."
3403 "Non-nil means change the face of a headline if it is marked DONE.
3404 Normally, only the TODO/DONE keyword indicates the state of a headline.
3405 When this is non-nil, the headline after the keyword is set to the
3406 `org-headline-done' as an additional indication."
3411 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3412 Changing this variable requires a restart of Emacs to take effect."
3417 "Non-nil means fontify the whole line for headings.
3418 This is useful when setting a background color for the
3419 org-level-* faces."
3424 "Non-nil means fontify what is treated specially by the exporters."
3429 "Non-nil mean font-lock should hide the emphasis marker characters."
3434 "Non-nil means show entities as UTF8 characters.
3440 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3445 "Regular expression for matching emphasis.
3446 After a match, the match groups contain these elements:
3447 0 The match of the full regular expression, including the characters
3448 before and after the proper match
3449 1 The character before the proper match, or empty at beginning of line
3450 2 The proper match, including the leading and trailing markers
3451 3 The leading marker like * or /, indicating the type of highlighting
3452 4 The text between the emphasis markers, not including the markers
3459 "Set variable and compute the emphasis regular expression."
3463 org-emphasis-alist org-emphasis-regexp-components)
3475 ;; make sure special characters appear at the right position in the class
3487 ;; Make the regexp
3495 body1
3507 body1
3515 "Components used to build the regular expression for emphasis.
3516 This is a list with five entries. Terminology: In an emphasis string
3520 specify what is allowed/forbidden in each part:
3522 pre Chars allowed as prematch. Beginning of line will be allowed too.
3523 post Chars allowed as postmatch. End of line will be allowed too.
3524 border The chars *forbidden* as border characters.
3526 non-shy groups here, and don't allow newline here.
3527 newline The maximum number of newlines allowed in an emphasis exp.
3529 Use customize to modify this, or restart Emacs after changing it."
3548 )
3549 "Special syntax for emphasized text.
3550 Text starting and ending with a special character will be emphasized, for
3551 example *bold*, _underlined_ and /italic/. This variable sets the marker
3552 characters, the face to be used by font-lock for highlighting in Org-mode
3553 Emacs buffers, and the HTML tags to be used for this.
3554 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3555 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3556 Use customize to modify this, or restart Emacs after changing it."
3571 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3574 ;;; Miscellaneous options
3577 "Completion in Org-mode."
3582 "Non-nil means use ido completion wherever possible.
3583 Note that `ido-mode' must be active for this variable to be relevant.
3584 If you decide to turn this variable on, you might well want to turn off
3585 `org-outline-path-complete-in-steps'.
3586 See also `org-completion-use-iswitchb'."
3591 "Non-nil means use iswitchb completion wherever possible.
3592 Note that `iswitchb-mode' must be active for this variable to be relevant.
3593 If you decide to turn this variable on, you might well want to turn off
3594 `org-outline-path-complete-in-steps'.
3595 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3601 Normal means, no org-mode-specific context."
3605 ;;; Functions and variables from their packages
3606 ;; Declared here to avoid compiler warnings
3608 ;; XEmacs only
3614 ;; Emacs only
3617 ;; Various packages
3635 org-format-agenda-item "org-agenda"
3666 ;;; Autoload and prepare some org modules
3668 ;; Some table stuff that needs to be defined here, because it is used
3669 ;; by the functions setting up org-mode or checking for table context.
3682 "Detect the first line outside a table when searching from within it.
3685 ;; Autoload the functions in org-table.el that are needed by functions here.
3690 org-table-convert org-table-convert-region org-table-copy-down
3691 org-table-copy-region org-table-create
3692 org-table-create-or-convert-from-region
3693 org-table-create-with-table.el org-table-current-dline
3694 org-table-cut-region org-table-delete-column org-table-edit-field
3695 org-table-edit-formulas org-table-end org-table-eval-formula
3696 org-table-export org-table-field-info
3697 org-table-get-stored-formulas org-table-goto-column
3698 org-table-hline-and-move org-table-import org-table-insert-column
3699 org-table-insert-hline org-table-insert-row org-table-iterate
3700 org-table-justify-field-maybe org-table-kill-row
3701 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3702 org-table-move-column org-table-move-column-left
3703 org-table-move-column-right org-table-move-row
3704 org-table-move-row-down org-table-move-row-up
3705 org-table-next-field org-table-next-row org-table-paste-rectangle
3706 org-table-previous-field org-table-recalculate
3707 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3708 org-table-toggle-coordinate-overlays
3709 org-table-toggle-formula-debugger org-table-wrap-region
3710 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3711 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3712 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3715 "Return t if the cursor is inside an org-type table.
3716 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3721 org-table-line-regexp)))
3722 nil))
3726 "Return t if and only if we are at a table.el table."
3732 "If there is a table.el table nearby, recognize it and move into it."
3738 nil
3748 t
3753 t)
3754 nil)
3755 nil))
3758 "Return t if the cursor is inside a hline in a table."
3763 nil))
3768 "Apply FUNCTION to the start of all tables in the buffer."
3784 ;; Declare and autoload functions from org-exp.el & Co
3792 org-insert-export-options-template
3793 org-table-clean-before-export))
3796 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3797 org-export-region-as-ascii))
3800 org-replace-region-by-latex org-export-region-as-latex
3801 org-export-as-latex org-export-as-pdf
3802 org-export-as-pdf-and-open))
3805 org-export-as-html-batch org-export-as-html-to-buffer
3806 org-replace-region-by-html org-export-region-as-html
3807 org-export-as-html))
3810 org-replace-region-by-docbook org-export-region-as-docbook
3811 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3812 org-export-as-docbook))
3815 org-export-icalendar-all-agenda-files
3816 org-export-icalendar-combine-agenda-files))
3820 ;; Declare and autoload functions from org-agenda.el
3825 org-todo-list org-tags-view org-agenda-list-stuck-projects
3826 org-diary org-agenda-to-appt
3827 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3829 ;; Autoload org-remember
3834 org-remember-apply-template org-remember org-remember-handler)))
3839 org-capture-import-remember-templates)))
3841 ;; Autoload org-clock.el
3856 "Return non-nil if clock is currently running.
3857 The return value is actually the clock marker."
3862 "org-clock"
3864 org-clock-goto org-clock-sum org-clock-display
3865 org-clock-remove-overlays org-clock-report
3866 org-clocktable-shift org-dblock-write:clocktable
3867 org-get-clocktable org-resolve-clocks)))
3870 "If this is a CLOCK line, update it and return t.
3871 Otherwise, return nil."
3880 ts te h m s neg)
3883 nil)
3888 ;; The clock is running here
3909 t))))))
3912 "Check if the current buffer contains the running clock.
3913 If yes, offer to stop it and to save the buffer with the changes."
3922 "Check if this line starts a clock table, if yes, shift the time block."
3926 ;; Autoload org-timer.el
3930 "org-timer"
3932 org-timer-change-times-in-region
3933 org-timer-set-timer
3934 org-timer-reset-timers
3935 org-timer-show-remaining-time)))
3937 ;; Autoload org-feed.el
3941 "org-feed"
3945 ;; Autoload org-indent.el
3947 ;; Define the variable already here, to make sure we have it.
3949 "Non-nil if Org-Indent mode is enabled.
3954 "org-indent"
3957 ;; Autoload org-mobile.el
3961 "org-mobile"
3964 ;; Autoload archiving code
3965 ;; The stuff that is needed for cycling and tags has to be defined here.
3968 "Options concerning archiving in Org-mode."
3973 "The location where subtrees should be archived.
3975 The value of this variable is a string, consisting of two parts,
3976 separated by a double-colon. The first part is a filename and
3977 the second part is a headline.
3979 When the filename is omitted, archiving happens in the same file.
3980 %s in the filename will be replaced by the current file
3981 name (without the directory part). Archiving to a different file
3982 is useful to keep archived entries from contributing to the
3983 Org-mode Agenda.
3985 The archived entries will be filed as subtrees of the specified
3986 headline. When the headline is omitted, the subtrees are simply
3987 filed away at the end of the file, as top-level entries. Also in
3988 the heading you can use %s to represent the file name, this can be
3989 useful when using the same archive for a number of different files.
3991 Here are a few examples:
3993 If the current file is Projects.org, archive in file
3994 Projects.org_archive, as top-level trees. This is the default.
3997 Archive in the current file, under the top-level headline
4001 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4004 Archive in file ~/org/archive.org (absolute path), under headlines
4008 Archive in file ./basement (relative path), as level 3 trees
4011 You may set this option on a per-file basis by adding to the buffer a
4012 line like
4014 #+ARCHIVE: basement::** Finished Tasks
4016 You may also define it locally for a subtree by setting an ARCHIVE property
4017 in the entry. If such a property is found in an entry, or anywhere up
4018 the hierarchy, it will be used."
4023 "The tag that marks a subtree as archived.
4024 An archived subtree does not open during visibility cycling, and does
4025 not contribute to the agenda listings.
4026 After changing this, font-lock must be restarted in the relevant buffers to
4027 get the proper fontification."
4033 "Non-nil means the agenda will skip any items located in archived trees.
4034 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4035 variable is no longer recommended, you should leave it at the value t.
4036 Instead, use the key `v' to cycle the archives-mode in the agenda."
4042 "Non-nil means ignore archived trees when creating column view."
4048 "Non-nil means `org-cycle' will open archived trees.
4049 An archived tree is a tree marked with the tag ARCHIVE.
4050 When nil, archived trees will stay folded. You can still open them with
4051 normal outline commands like `show-all', but not with the cycling commands."
4057 "Non-nil means sparse tree construction shows matches in archived trees.
4058 When nil, matches in these trees are highlighted, but the trees are kept in
4059 collapsed state."
4065 "Re-hide all archived subtrees after a visibility state change."
4076 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4079 "Cycle subtree even if it is archived."
4086 "Re-hide all archived subtrees after a visibility state change."
4101 flag)))
4108 org-archive-to-archive-sibling org-toggle-archive-tag
4109 org-archive-subtree-default
4110 org-archive-subtree-default-with-confirmation)))
4112 ;; Autoload Column View Code
4120 org-columns-compute org-agenda-columns org-columns-remove-overlays
4123 ;; Autoload ID code
4131 org-id-get-with-outline-path-completion
4132 org-id-get-with-outline-drilling org-id-store-link
4133 org-id-goto org-id-find org-id-store-link))
4135 ;; Autoload Plotting Code
4140 ;;; Variables for pre-computed regular expressions, all buffer local
4158 "Matches a headline and puts everything into groups:
4159 group 1: the stars
4160 group 2: The todo keyword, maybe
4161 group 3: Priority cookie
4162 group 4: True headline
4166 "Printf format to make regexp to match an exact headline.
4167 This regexp will match the headline of any node which hase the exact
4168 headline text that is put into the format, but may have any TODO state,
4172 "Matches a headline and puts TODO state into group 2 if present.
4227 "Regular expression to match a plain time or time range.
4228 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4229 groups carry important information:
4230 0 the full match
4231 1 the first time, range or not
4239 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4240 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4241 groups carry important information:
4242 0 the full match
4243 7 hours of duration
4252 "Regular expression to match a timestamp time or time range.
4253 After a match, the following groups carry important information:
4254 0 the full match
4255 1 date plus weekday, for back referencing to make sure both times are on the same day
4256 2 the first time, range or not
4311 "Variable associated with STARTUP options for org-mode.
4312 Each element is a list of three items: The startup options as written
4313 in the #+STARTUP line, the corresponding variable, and the value to
4314 set this variable to if the option is found. An optional forth element PUSH
4318 "Precompute regular expressions for current buffer."
4338 kwds kws0 kwsa key log value cat arch tags const links hw dws
4339 tail sep kws1 prio props ftags drawers beamer-p
4361 ;; general TODO-like setup
4373 links)))
4379 props)))
4384 ftags
4394 l var val)
4424 ))))
4441 ;; Process the TODO keywords
4443 ;; Use the global values as if they had been given locally.
4455 kws)))
4458 kwsa nil
4461 ;; 1 2
4469 kw)
4471 kws0)
4488 ;; Process the constants
4496 ;; Process the tags.
4507 tgs))
4515 ;; Compute the regular expressions and other local variables
4523 org-drawer-regexp
4527 org-not-done-keywords
4529 org-todo-regexp
4532 org-not-done-regexp
4536 org-not-done-heading-regexp
4540 org-todo-line-regexp
4544 org-complex-heading-regexp
4549 org-complex-heading-regexp-format
4558 org-nl-done-regexp
4562 org-todo-line-tags-regexp
4567 org-looking-at-done-regexp
4572 org-deadline-time-regexp
4574 org-deadline-line-regexp
4576 org-scheduled-regexp
4578 org-scheduled-time-regexp
4580 org-closed-time-regexp
4582 org-keyword-time-regexp
4588 org-keyword-time-not-clock-regexp
4594 org-maybe-keyword-time-regexp
4600 org-planning-or-clock-line-re
4605 org-all-time-keywords
4608 org-clock-string org-closed-string))
4609 )
4614 "Return the contents of FILE, as a string."
4628 "Extract the log state setting from a TODO keyword string.
4642 "Remove a pair of parenthesis at the end of each string in LIST."
4646 x))
4647 list))
4650 "Assign fast keys to a keyword-key alist.
4651 Respect keys that are already there."
4669 ;;; Some variables used in various places
4676 "Function to be called when `C-c C-c' is used.
4680 ;; FIXME: Occasionally check by commenting these, to make sure
4681 ;; no other functions uses these, forgetting to let-bind them.
4686 ;; Defined somewhere in this file, but used before definition.
4692 ;;;; Define the Org-mode
4695 (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"))
4698 ;; We use a before-change function to check if a table might need
4699 ;; an update.
4701 "Indicates that a table might need an update.
4702 This variable is set by `org-before-change-function'.
4705 "Every change indicates that a table might need an update."
4715 ;; org-outline-regexp ought to be a defconst but is let-binding
4716 ;; in some places -- e.g. see the macro org-with-limited-levels
4720 ;;;###autoload
4722 "Outline-based notes management and organizer, alias
4725 Org-mode develops organizational tasks around a NOTES file which
4726 contains information about projects as plain text. Org-mode is
4727 implemented on top of outline-mode, which is ideal to keep the content
4728 of large files well structured. It supports ToDo items, deadlines and
4729 time stamps, which magically appear in the diary listing of the Emacs
4730 calendar. Tables are easily created with a built-in table editor.
4731 Plain text URL-like links connect to websites, emails (VM), Usenet
4732 messages (Gnus), BBDB entries, and any files related to the project.
4733 For printing and sharing of notes, an Org-mode file (or a part of it)
4734 can be exported as a structured ASCII or HTML file.
4736 The following commands are available:
4740 ;; Get rid of Outline menus, they are not needed
4741 ;; Need to do this here because define-derived-mode sets up
4742 ;; the keymap so late. Still, it is a waste to call this each time
4743 ;; we switch another buffer into org-mode.
4746 ;; Assume this is Greg's port, it uses easymenu
4771 org-display-table 4
4774 org-ellipsis)))
4779 ;; tag faces set outside customize.... force initialization.
4781 ;; Calc embedded
4787 ;; Activate before-change-function
4791 ;; Check for running clock before killing a buffer
4793 ;; Paragraphs and auto-filling
4797 ;; Beginning/end of defun
4800 ;; Next error for sparse trees
4802 ;; Make sure dependence stuff works reliably, even for users who set it
4803 ;; too late :-(
4815 ;; Comment characters
4819 ;; Align options lines
4821 'align-mode-rules-list
4826 ;; Imenu
4830 ;; Make isearch reveal context
4833 ;; Emacs 21 and XEmacs make use of the hook
4835 ;; Emacs 22 deals with this through a special variable
4839 ;; Turn on org-beamer-mode?
4842 ;; Setup the pcomplete hooks
4855 ;; If empty file that did not turn on org-mode automatically, make it to.
4880 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4890 "Return today date, considering `org-extend-today-until'."
4895 ;;;; Font-Lock stuff, including the activators
4926 "Regular expression used to analyze links.
4927 Here is what the match groups contain after a match:
4928 1: http:
4929 2: http
4930 3: path
4931 4: [desc]
4939 "Number of stacked braces for sub/superscript matching.
4940 This has to be set before loading org.el to be effective."
4945 "Create a regular expression which will match a balanced sexp.
4946 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4947 as single character strings.
4948 The regexp returned will match the entire expression including the
4949 delimiters. It will also define a single group which contains the
4950 match except for the outermost delimiters. The maximum depth of
4951 stacked delimiters is N. Escaping delimiters is not possible."
4980 "Update the link regular expressions.
4981 This should be called after the variable `org-link-types' has changed."
4985 org-link-re-with-space
4991 org-link-re-with-space2
4997 org-link-re-with-space3
5002 org-angle-link-re
5008 org-plain-link-re
5012 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5013 org-bracket-link-regexp
5015 org-bracket-link-analytic-regexp
5023 org-bracket-link-analytic-regexp++
5031 org-any-link-re
5040 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5042 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5043 "Regular expression matching time strings for analysis.
5044 This one does not require the space after the date, so it can be used
5046 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5062 "Regular expression matching a time stamp or time stamp range.
5068 "Run through the buffer and add overlays to emphasised strings."
5077 'face
5090 rtn))
5093 "Insert or change an emphasis, i.e. a font like bold or italic.
5094 If there is an active region, change that region to a new emphasis.
5095 If there is no region, just insert the marker characters and position
5096 the cursor between them.
5097 CHAR should be either the marker character, or the first character of the
5098 HTML tag associated with that emphasis. If CHAR is a space, the means
5099 to remove the emphasis of the selected region.
5100 If char is not given (for example in an interactive call) it
5101 will be prompted for."
5152 "Run through the buffer and add overlays to links."
5161 nil
5167 t)))))
5175 t)))
5178 "When non-nil, fontify code in code blocks."
5189 "Fontify #+ lines and blocks, in the correct ways."
5192 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5193 limit t)
5201 end end1 quoting block-type ovl)
5204 ;; a single line of backend-specific content
5212 ; for backend-specific code
5213 t)
5215 ;; Truly a block
5227 beg end
5235 ;; remove old background overlays
5240 ;; add a background overlay
5254 t))
5267 ;; just any other in-buffer setting, but not indented
5271 t)
5280 t)
5288 "Run through the buffer and add overlays to links."
5296 t)))
5299 "Run through the buffer and add overlays to footnotes."
5306 'keymap org-mouse-map
5307 'help-echo
5309 "Footnote definition"
5311 'font-lock-fontified t
5312 'font-lock-multiline t
5316 "Run through the buffer and add overlays to bracketed links."
5320 ;; FIXME: above we should remove the escapes.
5321 ;; but that requires another match, protecting match data,
5322 ;; a lot of overhead for font-lock.
5329 ;; We need to remove the invisible property here. Table narrowing
5330 ;; may have made some of this invisible.
5348 t)))
5351 "Run through the buffer and add overlays to dates."
5363 t)))
5372 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5376 "Run through the buffer and add overlays to target matches."
5384 'keymap org-mouse-map
5388 t)))))
5391 "Find all radio targets in this file and update the regular expression."
5406 t)))
5413 ;; This should be with the exporter code, but we also use if for font-locking
5423 "Compute regular expression for stuff treated specially by exporters."
5430 org-latex-regexps)))
5458 org-entities)))
5462 org-latex-entities)
5463 nil))
5465 ))
5466 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5469 org-export-html-special-string-regexps)))
5474 ))))
5476 'org-latex-and-specials-regexp
5481 "Run through the buffer and add overlays to links."
5485 limit t))
5499 rtn)))
5502 "Restart `font-lock-mode', to force refontification."
5508 "Return a list of all targets in this file.
5509 With optional argument RADIO, only find radio targets."
5511 rtn)
5516 rtn)))
5519 "Make regular expression matching all strings in TARGETS.
5520 The regular expression finds the targets also if there is a line break
5521 between words."
5530 x)
5531 targets
5543 t)))
5546 "Compute the outline level of the heading at point.
5547 This function assumes that the cursor is at the beginning of a line matched
5548 by `outline-regexp'. Otherwise it returns garbage.
5549 If this is called at a normal headline, the level is the number of stars.
5550 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5557 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5564 "Functions that can manipulate `org-font-lock-extra-keywords'.
5565 This is calles after `org-font-lock-extra-keywords' is defined, but before
5566 it is installed to be used by font lock. This can be useful if something
5577 ;; Call the hook
5579 ;; Headlines
5586 ;; Table lines
5589 ;; Table internals
5594 ;; Drawers
5597 ;; Properties
5601 ;; Links
5611 ;; TODO lines
5614 ;; DONE
5620 nil)
5621 ;; Priorities
5623 ;; Tags
5625 ;; Special keywords
5630 ;; Emphasis
5635 ;; Checkboxes
5636 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5641 ;; Description list items
5644 ;; ARCHIVEd headings
5646 org-outline-regexp-bol
5649 ;; Specials
5653 ;; Code
5655 ;; COMMENT
5660 ;; Blocks and meta lines
5662 )))
5665 ;; Now set the full font-lock-keywords
5672 "Toggle the composition display of entities as UTF8 characters."
5684 "Find an entity to fontify."
5690 limit t)
5702 nil))))
5705 "Fontify string S like in Org-mode."
5717 "Get the right face for match N in font-lock matching of headlines."
5730 "Get the right face for a TODO keyword KWD.
5731 If KWD is a number, get the corresponding match group."
5739 "Create a face list that inherits INHERIT, but sets the foreground color.
5740 When FACE-OR-COLOR is not a string, just return it."
5744 face-or-color)
5745 face-or-color))
5748 "Add the special tag faces."
5757 "Add the special priority faces."
5764 org-priority-faces)))
5769 "Get the right face for a TODO keyword KWD.
5770 If KWD is a number, get the corresponding match group."
5777 "Remove fontification and activation overlays from links."
5782 deactivate-mark buffer-file-name buffer-file-truename)
5785 beg end
5787 ;; also remove line-prefix and wrap-prefix properties
5789 invisible t intangible t
5790 line-prefix t wrap-prefix t
5791 org-no-flyspell t org-emphasis t)
5793 invisible t intangible t
5794 org-no-flyspell t org-emphasis t)))
5804 "Remove specific display properties that have been added by font lock.
5805 The will remove the raise properties that are used to show superscripts
5806 and subscripts."
5816 "Add raise properties to sub/superscripts."
5820 org-match-substring-regexp
5821 org-match-substring-with-braces-regexp)
5822 limit t)
5832 ;; FIXME: Should we go back one character here, for a_b^c
5833 ;; (goto-char (1- pos)) ;????????????????????
5835 t
5837 'display
5853 t)))))
5855 ;;;; Visibility cycling, including org-goto and indirect buffer
5857 ;;; Cycling
5864 ;;;###autoload
5869 "TAB-action and visibility cycling for Org-mode.
5871 This is the command invoked in Org-mode by the TAB key. Its main purpose
5872 is outline visibility cycling, but it also invokes other actions
5873 in special contexts.
5875 - When this function is called with a prefix argument, rotate the entire
5876 buffer through 3 states (global cycling)
5877 1. OVERVIEW: Show only top-level headlines.
5878 2. CONTENTS: Show all headlines of all levels, but no body text.
5879 3. SHOW ALL: Show everything.
5880 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5881 determined by the variable `org-startup-folded', and by any VISIBILITY
5882 properties in the buffer.
5883 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5884 including any drawers.
5886 - When inside a table, re-align the table and move to the next field.
5888 - When point is at the beginning of a headline, rotate the subtree started
5889 by this line through 3 different states (local cycling)
5890 1. FOLDED: Only the main headline is shown.
5891 2. CHILDREN: The main headline and the direct children are shown.
5892 From this state, you can move to one of the children
5893 and zoom in further.
5894 3. SUBTREE: Show the entire subtree, including body text.
5895 If there is no subtree, switch directly from CHILDREN to FOLDED.
5897 - When point is at the beginning of an empty headline and the variable
5898 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5899 of the headline by demoting and promoting it to likely levels. This
5900 speeds up creation document structure by pressing TAB once or several
5901 times right after creating a new headline.
5903 - When there is a numeric prefix, go up to a heading with level ARG, do
5904 a `show-subtree' and return to the previous cursor position. If ARG
5905 is negative, go up that many levels.
5907 - When point is not at the beginning of a headline, execute the global
5908 binding for TAB, which is re-indenting the line. See the option
5909 `org-cycle-emulate-tab' for details.
5911 - Special case: if point is at the beginning of the buffer and there is
5912 no headline in line 1, this function will act as if called with prefix arg
5913 (C-u TAB, same as S-TAB) also when called without prefix arg.
5914 But only if also the variable `org-cycle-global-at-bob' is t."
5924 org-inlinetask-min-level
5929 limit-level)))
5932 outline-regexp
5940 org-cycle-hook))
5944 ;; special case: use global cycling
5958 ;; Table: enter it or move to the next field.
5969 ;; Global cycling: delegate to `org-cycle-internal-global'.
5972 ;; Drawers: delegate to `org-flag-drawer'.
5980 ;; Show-subtree, ARG levels up from here.
5988 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5994 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6001 ;; From there: TAB emulation and template completion.
6025 t
6034 "Do the global cycling action."
6038 ;; We just created the overview - now do table of contents
6039 ;; This can be slow in very large buffers, so indicate action
6049 ;; We just showed the table of contents - now show everything
6057 ;; Default action: go to overview
6065 "Do the local cycling action."
6067 ;; First, determine end of headline (EOH), end of subtree or item
6068 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6092 ;; Determine end invisible part of buffer (EOL)
6094 ;; XEmacs doesn't have `next-single-char-property-change'
6104 ;; Find out what to do next and set `this-command'
6107 ;; Nothing is hidden behind this heading
6119 org-cycle-skip-children-state-if-no-children))))
6120 ;; Entire subtree is hidden in one line: children view
6126 ;; Fold every list in subtree to top-level items.
6148 ;; We just showed the children, or no children are there,
6149 ;; now show everything.
6156 ;; Default action: hide the subtree.
6163 ;;;###autoload
6165 "Cycle the global visibility. For details see `org-cycle'.
6167 With a numeric prefix, show all headlines up to that level."
6183 "Set the visibility required by startup options and properties."
6198 "Switch subtree visibilities according to :VISIBILITY: property."
6205 nil t)
6230 "Switch to overview mode, showing only top-level headlines.
6231 Really, this shows all headlines with level equal or greater than the level
6232 of the first headline in the buffer. This is important, because if the
6233 first headline is not level one, then (hide-sublevels 1) gives confusing
6234 results."
6245 "Show all headlines in the buffer, like a table of contents.
6246 With numerical argument N, show content up to level N."
6249 ;; Visit all headings and show their offspring
6256 t)
6265 "Adjust the window after a change in outline visibility.
6266 This function is the default value of the hook `org-cycle-hook'."
6276 "Remove outline overlays that do not contain non-white stuff."
6286 "Fix visibility issues after moving a subtree."
6287 ;; First, find a reasonable region to look at:
6288 ;; Start two siblings above, end three below
6306 ;; Properly fold already folded siblings
6317 "Show empty lines above all visible headlines.
6318 The region to be covered depends on STATE when called through
6319 `org-cycle-hook'. Lisp program can use t for STATE to get the
6320 entire buffer covered. Note that an empty line is only shown if there
6321 are at least `org-cycle-separator-lines' empty lines before the headline."
6331 beg end b e)
6355 ;; Never hide empty lines at the end of the file.
6365 "Move to the parent and re-show empty lines before visible headlines."
6371 "Return `org-agenda-files' list, plus all open org-mode files.
6372 This is useful for operations that need to scan all of a user's
6373 open and agenda-wise Org files."
6381 files))
6384 "Return the beginning position of the current entry."
6388 "Return the end position of the current entry."
6392 "Re-hide all drawers after a visibility state change."
6418 "Is the end of the current subtree visible?"
6423 "Move cursor to the first headline and recenter the headline.
6424 Optional argument N means put the headline into the Nth line of the window."
6430 ;;; Saving and restoring visibility
6433 "Return a list of the locations of all outline overlays.
6434 These are overlays with the `invisible' property value `outline'.
6435 The return value is a list of cons cells, with start and stop
6436 positions for each overlay.
6437 If USE-MARKERS is set, return the positions as markers."
6455 "Create visibility overlays for all positions in DATA.
6456 DATA should have been made by `org-outline-overlay-data'."
6465 data)))))
6467 ;;; Folding of blocks
6478 "Call FUNCTION at the head of all source blocks in the current buffer.
6479 Optional arguments START and END can be used to limit the range."
6491 "Toggle the visibility of all blocks in the current buffer."
6495 "Fold all blocks in the current buffer."
6501 "Unfold all blocks in the current buffer."
6507 "Toggle visibility of block at point."
6518 "Toggle the visibility of the current block."
6525 ov)
6541 ;; make the block accessible to isearch
6543 ov 'isearch-open-invisible
6554 ;; org-tab-after-check-for-cycling-hook
6556 ;; Remove overlays when changing major mode
6561 ;;; Org-goto
6567 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6583 nil)
6584 (org-defkey map "q" 'org-goto-quit)
6585 (org-defkey map "n" 'outline-next-visible-heading)
6586 (org-defkey map "p" 'outline-previous-visible-heading)
6587 (org-defkey map "f" 'outline-forward-same-level)
6588 (org-defkey map "b" 'outline-backward-same-level)
6589 (org-defkey map "u" 'outline-up-heading))
6590 (org-defkey map "/" 'org-occur)
6591 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6592 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6593 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6594 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6595 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6596 map))
6598 (defconst org-goto-help
6599 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6600 RET=jump to location [Q]uit and return to previous location
6601 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6603 (defvar org-goto-start-pos) ; dynamically scoped parameter
6605 ;; FIXME: Docstring does not mention both interfaces
6606 (defun org-goto (&optional alternative-interface)
6607 "Look up a different location in the current file, keeping current visibility.
6609 When you want look-up or go to a different location in a document, the
6610 fastest way is often to fold the entire buffer and then dive into the tree.
6611 This method has the disadvantage, that the previous location will be folded,
6612 which may not be what you want.
6614 This command works around this by showing a copy of the current buffer
6615 in an indirect buffer, in overview mode. You can dive into the tree in
6616 that copy, use org-occur and incremental search to find a location.
6617 When pressing RET or `Q', the command returns to the original buffer in
6618 which the visibility is still unchanged. After RET is will also jump to
6619 the location selected in the indirect buffer and expose the headline
6620 hierarchy above."
6621 (interactive "P")
6622 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6623 (org-refile-use-outline-path t)
6624 (org-refile-target-verify-function nil)
6625 (interface
6626 (if (not alternative-interface)
6627 org-goto-interface
6628 (if (eq org-goto-interface 'outline)
6629 'outline-path-completion
6630 'outline)))
6631 (org-goto-start-pos (point))
6632 (selected-point
6633 (if (eq interface 'outline)
6634 (car (org-get-location (current-buffer) org-goto-help))
6635 (let ((pa (org-refile-get-location "Goto")))
6636 (org-refile-check-position pa)
6637 (nth 3 pa)))))
6638 (if selected-point
6639 (progn
6640 (org-mark-ring-push org-goto-start-pos)
6641 (goto-char selected-point)
6642 (if (or (outline-invisible-p) (org-invisible-p2))
6643 (org-show-context 'org-goto)))
6644 (message "Quit"))))
6646 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6647 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6648 (defvar org-goto-local-auto-isearch-map) ; defined below
6650 (defun org-get-location (buf help)
6651 "Let the user select a location in the Org-mode buffer BUF.
6652 This function uses a recursive edit. It returns the selected position
6653 or nil."
6654 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6655 (isearch-hide-immediately nil)
6656 (isearch-search-fun-function
6657 (lambda () 'org-goto-local-search-headings))
6658 (org-goto-selected-point org-goto-exit-command)
6659 (pop-up-frames nil)
6660 (special-display-buffer-names nil)
6661 (special-display-regexps nil)
6662 (special-display-function nil))
6663 (save-excursion
6664 (save-window-excursion
6665 (delete-other-windows)
6666 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6667 (org-pop-to-buffer-same-window
6668 (condition-case nil
6669 (make-indirect-buffer (current-buffer) "*org-goto*")
6670 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6671 (with-output-to-temp-buffer "*Help*"
6672 (princ help))
6673 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6674 (setq buffer-read-only nil)
6675 (let ((org-startup-truncated t)
6676 (org-startup-folded nil)
6677 (org-startup-align-all-tables nil))
6678 (org-mode)
6679 (org-overview))
6680 (setq buffer-read-only t)
6681 (if (and (boundp 'org-goto-start-pos)
6682 (integer-or-marker-p org-goto-start-pos))
6683 (let ((org-show-hierarchy-above t)
6684 (org-show-siblings t)
6685 (org-show-following-heading t))
6686 (goto-char org-goto-start-pos)
6687 (and (outline-invisible-p) (org-show-context)))
6688 (goto-char (point-min)))
6689 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6690 (message "Select location and press RET")
6691 (use-local-map org-goto-map)
6692 (recursive-edit)
6693 ))
6694 (kill-buffer "*org-goto*")
6695 (cons org-goto-selected-point org-goto-exit-command)))
6697 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6698 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6699 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6700 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6702 (defun org-goto-local-search-headings (string bound noerror)
6703 "Search and make sure that any matches are in headlines."
6704 (catch 'return
6705 (while (if isearch-forward
6706 (search-forward string bound noerror)
6707 (search-backward string bound noerror))
6708 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6709 (and (member :headline context)
6710 (not (member :tags context))))
6711 (throw 'return (point))))))
6713 (defun org-goto-local-auto-isearch ()
6714 "Start isearch."
6715 (interactive)
6716 (goto-char (point-min))
6717 (let ((keys (this-command-keys)))
6718 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6719 (isearch-mode t)
6720 (isearch-process-search-char (string-to-char keys)))))
6722 (defun org-goto-ret (&optional arg)
6723 "Finish `org-goto' by going to the new location."
6724 (interactive "P")
6725 (setq org-goto-selected-point (point)
6726 org-goto-exit-command 'return)
6727 (throw 'exit nil))
6729 (defun org-goto-left ()
6730 "Finish `org-goto' by going to the new location."
6731 (interactive)
6732 (if (org-on-heading-p)
6733 (progn
6734 (beginning-of-line 1)
6735 (setq org-goto-selected-point (point)
6736 org-goto-exit-command 'left)
6737 (throw 'exit nil))
6738 (error "Not on a heading")))
6740 (defun org-goto-right ()
6741 "Finish `org-goto' by going to the new location."
6742 (interactive)
6743 (if (org-on-heading-p)
6744 (progn
6745 (setq org-goto-selected-point (point)
6746 org-goto-exit-command 'right)
6747 (throw 'exit nil))
6748 (error "Not on a heading")))
6750 (defun org-goto-quit ()
6751 "Finish `org-goto' without cursor motion."
6752 (interactive)
6753 (setq org-goto-selected-point nil)
6754 (setq org-goto-exit-command 'quit)
6755 (throw 'exit nil))
6757 ;;; Indirect buffer display of subtrees
6759 (defvar org-indirect-dedicated-frame nil
6760 "This is the frame being used for indirect tree display.")
6761 (defvar org-last-indirect-buffer nil)
6763 (defun org-tree-to-indirect-buffer (&optional arg)
6764 "Create indirect buffer and narrow it to current subtree.
6765 With numerical prefix ARG, go up to this level and then take that tree.
6766 If ARG is negative, go up that many levels.
6767 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6768 indirect buffer previously made with this command, to avoid proliferation of
6769 indirect buffers. However, when you call the command with a \
6771 when `org-indirect-buffer-display' is `new-frame', the last buffer
6772 is kept so that you can work with several indirect buffers at the same time.
6773 If `org-indirect-buffer-display' is `dedicated-frame', the \
6775 requests that a new frame be made for the new buffer, so that the dedicated
6776 frame is not changed."
6777 (interactive "P")
6778 (let ((cbuf (current-buffer))
6779 (cwin (selected-window))
6780 (pos (point))
6781 beg end level heading ibuf)
6782 (save-excursion
6783 (org-back-to-heading t)
6784 (when (numberp arg)
6785 (setq level (org-outline-level))
6786 (if (< arg 0) (setq arg (+ level arg)))
6787 (while (> (setq level (org-outline-level)) arg)
6788 (outline-up-heading 1 t)))
6789 (setq beg (point)
6790 heading (org-get-heading))
6791 (org-end-of-subtree t t)
6792 (if (org-on-heading-p) (backward-char 1))
6793 (setq end (point)))
6794 (if (and (buffer-live-p org-last-indirect-buffer)
6795 (not (eq org-indirect-buffer-display 'new-frame))
6796 (not arg))
6797 (kill-buffer org-last-indirect-buffer))
6798 (setq ibuf (org-get-indirect-buffer cbuf)
6799 org-last-indirect-buffer ibuf)
6800 (cond
6801 ((or (eq org-indirect-buffer-display 'new-frame)
6802 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6803 (select-frame (make-frame))
6804 (delete-other-windows)
6805 (org-pop-to-buffer-same-window ibuf)
6806 (org-set-frame-title heading))
6807 ((eq org-indirect-buffer-display 'dedicated-frame)
6808 (raise-frame
6809 (select-frame (or (and org-indirect-dedicated-frame
6810 (frame-live-p org-indirect-dedicated-frame)
6811 org-indirect-dedicated-frame)
6812 (setq org-indirect-dedicated-frame (make-frame)))))
6813 (delete-other-windows)
6814 (org-pop-to-buffer-same-window ibuf)
6815 (org-set-frame-title (concat "Indirect: " heading)))
6816 ((eq org-indirect-buffer-display 'current-window)
6817 (org-pop-to-buffer-same-window ibuf))
6818 ((eq org-indirect-buffer-display 'other-window)
6819 (pop-to-buffer ibuf))
6820 (t (error "Invalid value")))
6821 (if (featurep 'xemacs)
6822 (save-excursion (org-mode) (turn-on-font-lock)))
6823 (narrow-to-region beg end)
6824 (show-all)
6825 (goto-char pos)
6826 (and (window-live-p cwin) (select-window cwin))))
6828 (defun org-get-indirect-buffer (&optional buffer)
6829 (setq buffer (or buffer (current-buffer)))
6830 (let ((n 1) (base (buffer-name buffer)) bname)
6831 (while (buffer-live-p
6832 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6833 (setq n (1+ n)))
6834 (condition-case nil
6835 (make-indirect-buffer buffer bname 'clone)
6836 (error (make-indirect-buffer buffer bname)))))
6838 (defun org-set-frame-title (title)
6839 "Set the title of the current frame to the string TITLE."
6840 ;; FIXME: how to name a single frame in XEmacs???
6841 (unless (featurep 'xemacs)
6842 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6844 ;;;; Structure editing
6846 ;;; Inserting headlines
6848 (defun org-previous-line-empty-p ()
6849 (save-excursion
6850 (and (not (bobp))
6851 (or (beginning-of-line 0) t)
6852 (save-match-data
6855 (defun org-insert-heading (&optional force-heading invisible-ok)
6856 "Insert a new heading or item with same depth at point.
6857 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6858 If point is at the beginning of a headline, insert a sibling before the
6859 current headline. If point is not at the beginning, split the line,
6860 create the new headline with the text in the current line after point
6861 \(but see also the variable `org-M-RET-may-split-line').
6863 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6864 This is important for non-interactive uses of the command."
6865 (interactive "P")
6866 (if (or (= (buffer-size) 0)
6867 (and (not (save-excursion
6868 (and (ignore-errors (org-back-to-heading invisible-ok))
6869 (org-on-heading-p))))
6870 (not (org-in-item-p))))
6871 (progn
6873 (run-hooks 'org-insert-heading-hook))
6874 (when (or force-heading (not (org-insert-item)))
6875 (let* ((empty-line-p nil)
6876 (level nil)
6877 (on-heading (org-on-heading-p))
6878 (head (save-excursion
6879 (condition-case nil
6880 (progn
6881 (org-back-to-heading invisible-ok)
6882 (when (and (not on-heading)
6883 (featurep 'org-inlinetask)
6884 (integerp org-inlinetask-min-level)
6885 (>= (length (match-string 0))
6886 org-inlinetask-min-level))
6887 ;; Find a heading level before the inline task
6888 (while (and (setq level (org-up-heading-safe))
6889 (>= level org-inlinetask-min-level)))
6890 (if (org-on-heading-p)
6891 (org-back-to-heading invisible-ok)
6892 (error "This should not happen")))
6893 (setq empty-line-p (org-previous-line-empty-p))
6894 (match-string 0))
6895 (error "*"))))
6896 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6897 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6898 pos hide-previous previous-pos)
6899 (cond
6900 ((and (org-on-heading-p) (bolp)
6901 (or (bobp)
6902 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6903 ;; insert before the current line
6904 (open-line (if blank 2 1)))
6905 ((and (bolp)
6906 (not org-insert-heading-respect-content)
6907 (or (bobp)
6908 (save-excursion
6909 (backward-char 1) (not (outline-invisible-p)))))
6910 ;; insert right here
6911 nil)
6912 (t
6913 ;; somewhere in the line
6914 (save-excursion
6915 (setq previous-pos (point-at-bol))
6916 (end-of-line)
6917 (setq hide-previous (outline-invisible-p)))
6918 (and org-insert-heading-respect-content (org-show-subtree))
6919 (let ((split
6920 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6921 (save-excursion
6922 (let ((p (point)))
6923 (goto-char (point-at-bol))
6924 (and (looking-at org-complex-heading-regexp)
6925 (> p (match-beginning 4)))))))
6926 tags pos)
6927 (cond
6928 (org-insert-heading-respect-content
6929 (org-end-of-subtree nil t)
6930 (when (featurep 'org-inlinetask)
6931 (while (and (not (eobp))
6933 (>= (length (match-string 1))
6934 org-inlinetask-min-level))
6935 (org-end-of-subtree nil t)))
6936 (or (bolp) (newline))
6937 (or (org-previous-line-empty-p)
6938 (and blank (newline)))
6939 (open-line 1))
6940 ((org-on-heading-p)
6941 (when hide-previous
6942 (show-children)
6943 (org-show-entry))
6945 (setq tags (and (match-end 2) (match-string 2)))
6946 (and (match-end 1)
6947 (delete-region (match-beginning 1) (match-end 1)))
6948 (setq pos (point-at-bol))
6949 (or split (end-of-line 1))
6950 (delete-horizontal-space)
6952 (buffer-substring (point-at-bol) (point)))
6953 (insert " "))
6954 (newline (if blank 2 1))
6955 (when tags
6956 (save-excursion
6957 (goto-char pos)
6958 (end-of-line 1)
6959 (insert " " tags)
6960 (org-set-tags nil 'align))))
6961 (t
6962 (or split (end-of-line 1))
6963 (newline (if blank 2 1)))))))
6964 (insert head) (just-one-space)
6965 (setq pos (point))
6966 (end-of-line 1)
6967 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6968 (when (and org-insert-heading-respect-content hide-previous)
6969 (save-excursion
6970 (goto-char previous-pos)
6971 (hide-subtree)))
6972 (run-hooks 'org-insert-heading-hook)))))
6974 (defun org-get-heading (&optional no-tags no-todo)
6975 "Return the heading of the current entry, without the stars.
6976 When NO-TAGS is non-nil, don't include tags.
6977 When NO-TODO is non-nil, don't include TODO keywords."
6978 (save-excursion
6979 (org-back-to-heading t)
6980 (cond
6981 ((and no-tags no-todo)
6982 (looking-at org-complex-heading-regexp)
6983 (match-string 4))
6984 (no-tags
6986 (match-string 1))
6987 (no-todo
6990 (match-string 2))
6992 (match-string 1)))))
6994 (defun org-heading-components ()
6995 "Return the components of the current heading.
6996 This is a list with the following elements:
6997 - the level as an integer
6998 - the reduced level, different if `org-odd-levels-only' is set.
6999 - the TODO keyword, or nil
7000 - the priority character, like ?A, or nil if no priority is given
7001 - the headline text itself, or the tags string if no headline text
7002 - the tags string, or nil."
7003 (save-excursion
7004 (org-back-to-heading t)
7005 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7006 (list (length (match-string 1))
7007 (org-reduced-level (length (match-string 1)))
7008 (org-match-string-no-properties 2)
7009 (and (match-end 3) (aref (match-string 3) 2))
7010 (org-match-string-no-properties 4)
7011 (org-match-string-no-properties 5)))))
7013 (defun org-get-entry ()
7014 "Get the entry text, after heading, entire subtree."
7015 (save-excursion
7016 (org-back-to-heading t)
7017 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7019 (defun org-insert-heading-after-current ()
7020 "Insert a new heading with same level as current, after current subtree."
7021 (interactive)
7022 (org-back-to-heading)
7023 (org-insert-heading)
7024 (org-move-subtree-down)
7025 (end-of-line 1))
7027 (defun org-insert-heading-respect-content ()
7028 (interactive)
7029 (let ((org-insert-heading-respect-content t))
7030 (org-insert-heading t)))
7032 (defun org-insert-todo-heading-respect-content (&optional force-state)
7033 (interactive "P")
7034 (let ((org-insert-heading-respect-content t))
7035 (org-insert-todo-heading force-state t)))
7037 (defun org-insert-todo-heading (arg &optional force-heading)
7038 "Insert a new heading with the same level and TODO state as current heading.
7039 If the heading has no TODO state, or if the state is DONE, use the first
7040 state (TODO by default). Also with prefix arg, force first state."
7041 (interactive "P")
7042 (when (or force-heading (not (org-insert-item 'checkbox)))
7043 (org-insert-heading force-heading)
7044 (save-excursion
7045 (org-back-to-heading)
7046 (outline-previous-heading)
7047 (looking-at org-todo-line-regexp))
7048 (let*
7049 ((new-mark-x
7050 (if (or arg
7051 (not (match-beginning 2))
7052 (member (match-string 2) org-done-keywords))
7053 (car org-todo-keywords-1)
7054 (match-string 2)))
7055 (new-mark
7056 (or
7057 (run-hook-with-args-until-success
7058 'org-todo-get-default-hook new-mark-x nil)
7059 new-mark-x)))
7060 (beginning-of-line 1)
7061 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7062 (if org-treat-insert-todo-heading-as-state-change
7063 (org-todo new-mark)
7064 (insert new-mark " "))))
7065 (when org-provide-todo-statistics
7066 (org-update-parent-todo-statistics))))
7068 (defun org-insert-subheading (arg)
7069 "Insert a new subheading and demote it.
7070 Works for outline headings and for plain lists alike."
7071 (interactive "P")
7072 (org-insert-heading arg)
7073 (cond
7074 ((org-on-heading-p) (org-do-demote))
7075 ((org-at-item-p) (org-indent-item))))
7077 (defun org-insert-todo-subheading (arg)
7078 "Insert a new subheading with TODO keyword or checkbox and demote it.
7079 Works for outline headings and for plain lists alike."
7080 (interactive "P")
7081 (org-insert-todo-heading arg)
7082 (cond
7083 ((org-on-heading-p) (org-do-demote))
7084 ((org-at-item-p) (org-indent-item))))
7086 ;;; Promotion and Demotion
7088 (defvar org-after-demote-entry-hook nil
7089 "Hook run after an entry has been demoted.
7090 The cursor will be at the beginning of the entry.
7091 When a subtree is being demoted, the hook will be called for each node.")
7093 (defvar org-after-promote-entry-hook nil
7094 "Hook run after an entry has been promoted.
7095 The cursor will be at the beginning of the entry.
7096 When a subtree is being promoted, the hook will be called for each node.")
7098 (defun org-promote-subtree ()
7099 "Promote the entire subtree.
7100 See also `org-promote'."
7101 (interactive)
7102 (save-excursion
7103 (org-with-limited-levels (org-map-tree 'org-promote)))
7104 (org-fix-position-after-promote))
7106 (defun org-demote-subtree ()
7107 "Demote the entire subtree. See `org-demote'.
7108 See also `org-promote'."
7109 (interactive)
7110 (save-excursion
7111 (org-with-limited-levels (org-map-tree 'org-demote)))
7112 (org-fix-position-after-promote))
7115 (defun org-do-promote ()
7116 "Promote the current heading higher up the tree.
7117 If the region is active in `transient-mark-mode', promote all headings
7118 in the region."
7119 (interactive)
7120 (save-excursion
7121 (if (org-region-active-p)
7122 (org-map-region 'org-promote (region-beginning) (region-end))
7123 (org-promote)))
7124 (org-fix-position-after-promote))
7126 (defun org-do-demote ()
7127 "Demote the current heading lower down the tree.
7128 If the region is active in `transient-mark-mode', demote all headings
7129 in the region."
7130 (interactive)
7131 (save-excursion
7132 (if (org-region-active-p)
7133 (org-map-region 'org-demote (region-beginning) (region-end))
7134 (org-demote)))
7135 (org-fix-position-after-promote))
7137 (defun org-fix-position-after-promote ()
7138 "Make sure that after pro/demotion cursor position is right."
7139 (let ((pos (point)))
7140 (when (save-excursion
7141 (beginning-of-line 1)
7142 (looking-at org-todo-line-regexp)
7143 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7144 (cond ((eobp) (insert " "))
7145 ((eolp) (insert " "))
7146 ((equal (char-after) ?\ ) (forward-char 1))))))
7148 (defun org-current-level ()
7149 "Return the level of the current entry, or nil if before the first headline.
7150 The level is the number of stars at the beginning of the headline."
7151 (save-excursion
7152 (org-with-limited-levels
7153 (ignore-errors
7154 (org-back-to-heading t)
7155 (funcall outline-level)))))
7157 (defun org-get-previous-line-level ()
7158 "Return the outline depth of the last headline before the current line.
7159 Returns 0 for the first headline in the buffer, and nil if before the
7160 first headline."
7161 (let ((current-level (org-current-level))
7162 (prev-level (when (> (line-number-at-pos) 1)
7163 (save-excursion
7164 (beginning-of-line 0)
7165 (org-current-level)))))
7166 (cond ((null current-level) nil) ; Before first headline
7167 ((null prev-level) 0) ; At first headline
7168 (prev-level))))
7170 (defun org-reduced-level (l)
7171 "Compute the effective level of a heading.
7172 This takes into account the setting of `org-odd-levels-only'."
7173 (cond
7174 ((zerop l) 0)
7175 (org-odd-levels-only (1+ (floor (/ l 2))))
7176 (t l)))
7178 (defun org-level-increment ()
7179 "Return the number of stars that will be added or removed at a
7180 time to headlines when structure editing, based on the value of
7181 `org-odd-levels-only'."
7182 (if org-odd-levels-only 2 1))
7184 (defun org-get-valid-level (level &optional change)
7185 "Rectify a level change under the influence of `org-odd-levels-only'
7186 LEVEL is a current level, CHANGE is by how much the level should be
7187 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7188 even level numbers will become the next higher odd number."
7189 (if org-odd-levels-only
7190 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7191 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7192 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7193 (max 1 (+ level (or change 0)))))
7195 (if (boundp 'define-obsolete-function-alias)
7196 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7197 (define-obsolete-function-alias 'org-get-legal-level
7198 'org-get-valid-level)
7199 (define-obsolete-function-alias 'org-get-legal-level
7200 'org-get-valid-level "23.1")))
7202 (defun org-promote ()
7203 "Promote the current heading higher up the tree.
7204 If the region is active in `transient-mark-mode', promote all headings
7205 in the region."
7206 (org-back-to-heading t)
7207 (let* ((level (save-match-data (funcall outline-level)))
7208 (after-change-functions (remove 'flyspell-after-change-function
7209 after-change-functions))
7210 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7211 (diff (abs (- level (length up-head) -1))))
7212 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7213 (replace-match up-head nil t)
7214 ;; Fixup tag positioning
7215 (and org-auto-align-tags (org-set-tags nil t))
7216 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7217 (run-hooks 'org-after-promote-entry-hook)))
7219 (defun org-demote ()
7220 "Demote the current heading lower down the tree.
7221 If the region is active in `transient-mark-mode', demote all headings
7222 in the region."
7223 (org-back-to-heading t)
7224 (let* ((level (save-match-data (funcall outline-level)))
7225 (after-change-functions (remove 'flyspell-after-change-function
7226 after-change-functions))
7227 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7228 (diff (abs (- level (length down-head) -1))))
7229 (replace-match down-head nil t)
7230 ;; Fixup tag positioning
7231 (and org-auto-align-tags (org-set-tags nil t))
7232 (if org-adapt-indentation (org-fixup-indentation diff))
7233 (run-hooks 'org-after-demote-entry-hook)))
7235 (defun org-cycle-level ()
7236 "Cycle the level of an empty headline through possible states.
7237 This goes first to child, then to parent, level, then up the hierarchy.
7238 After top level, it switches back to sibling level."
7239 (interactive)
7240 (let ((org-adapt-indentation nil))
7241 (when (org-point-at-end-of-empty-headline)
7242 (setq this-command 'org-cycle-level) ; Only needed for caching
7243 (let ((cur-level (org-current-level))
7244 (prev-level (org-get-previous-line-level)))
7245 (cond
7246 ;; If first headline in file, promote to top-level.
7247 ((= prev-level 0)
7248 (loop repeat (/ (- cur-level 1) (org-level-increment))
7249 do (org-do-promote)))
7250 ;; If same level as prev, demote one.
7251 ((= prev-level cur-level)
7252 (org-do-demote))
7253 ;; If parent is top-level, promote to top level if not already.
7254 ((= prev-level 1)
7255 (loop repeat (/ (- cur-level 1) (org-level-increment))
7256 do (org-do-promote)))
7257 ;; If top-level, return to prev-level.
7258 ((= cur-level 1)
7259 (loop repeat (/ (- prev-level 1) (org-level-increment))
7260 do (org-do-demote)))
7261 ;; If less than prev-level, promote one.
7262 ((< cur-level prev-level)
7263 (org-do-promote))
7264 ;; If deeper than prev-level, promote until higher than
7265 ;; prev-level.
7266 ((> cur-level prev-level)
7267 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7268 do (org-do-promote))))
7269 t))))
7271 (defun org-map-tree (fun)
7272 "Call FUN for every heading underneath the current one."
7273 (org-back-to-heading)
7274 (let ((level (funcall outline-level)))
7275 (save-excursion
7276 (funcall fun)
7277 (while (and (progn
7278 (outline-next-heading)
7279 (> (funcall outline-level) level))
7280 (not (eobp)))
7281 (funcall fun)))))
7283 (defun org-map-region (fun beg end)
7284 "Call FUN for every heading between BEG and END."
7285 (let ((org-ignore-region t))
7286 (save-excursion
7287 (setq end (copy-marker end))
7288 (goto-char beg)
7289 (if (and (re-search-forward org-outline-regexp-bol nil t)
7290 (< (point) end))
7291 (funcall fun))
7292 (while (and (progn
7293 (outline-next-heading)
7294 (< (point) end))
7295 (not (eobp)))
7296 (funcall fun)))))
7298 (defun org-fixup-indentation (diff)
7299 "Change the indentation in the current entry by DIFF.
7300 However, if any line in the current entry has no indentation, or if it
7301 would end up with no indentation after the change, nothing at all is done."
7302 (save-excursion
7303 (let ((end (save-excursion (outline-next-heading)
7304 (point-marker)))
7305 (prohibit (if (> diff 0)
7308 col)
7309 (unless (save-excursion (end-of-line 1)
7310 (re-search-forward prohibit end t))
7311 (while (and (< (point) end)
7313 (goto-char (match-end 0))
7314 (setq col (current-column))
7315 (if (< diff 0) (replace-match ""))
7316 (org-indent-to-column (+ diff col))))
7317 (move-marker end nil))))
7319 (defun org-convert-to-odd-levels ()
7320 "Convert an org-mode file with all levels allowed to one with odd levels.
7321 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7322 level 5 etc."
7323 (interactive)
7324 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7325 (let ((outline-level 'org-outline-level)
7326 (org-odd-levels-only nil) n)
7327 (save-excursion
7328 (goto-char (point-min))
7330 (setq n (- (length (match-string 0)) 2))
7331 (while (>= (setq n (1- n)) 0)
7332 (org-demote))
7333 (end-of-line 1))))))
7335 (defun org-convert-to-oddeven-levels ()
7336 "Convert an org-mode file with only odd levels to one with odd/even levels.
7337 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7338 file contains a section with an even level, conversion would
7339 destroy the structure of the file. An error is signaled in this
7340 case."
7341 (interactive)
7342 (goto-char (point-min))
7343 ;; First check if there are no even levels
7345 (org-show-context t)
7346 (error "Not all levels are odd in this file. Conversion not possible"))
7347 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7348 (let ((outline-regexp org-outline-regexp)
7349 (outline-level 'org-outline-level)
7350 (org-odd-levels-only nil) n)
7351 (save-excursion
7352 (goto-char (point-min))
7354 (setq n (/ (1- (length (match-string 0))) 2))
7355 (while (>= (setq n (1- n)) 0)
7356 (org-promote))
7357 (end-of-line 1))))))
7359 (defun org-tr-level (n)
7360 "Make N odd if required."
7361 (if org-odd-levels-only (1+ (/ n 2)) n))
7363 ;;; Vertical tree motion, cutting and pasting of subtrees
7365 (defun org-move-subtree-up (&optional arg)
7366 "Move the current subtree up past ARG headlines of the same level."
7367 (interactive "p")
7368 (org-move-subtree-down (- (prefix-numeric-value arg))))
7370 (defun org-move-subtree-down (&optional arg)
7371 "Move the current subtree down past ARG headlines of the same level."
7372 (interactive "p")
7373 (setq arg (prefix-numeric-value arg))
7374 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7375 'org-get-last-sibling))
7376 (ins-point (make-marker))
7377 (cnt (abs arg))
7378 (col (current-column))
7379 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7380 ;; Select the tree
7381 (org-back-to-heading)
7382 (setq beg0 (point))
7383 (save-excursion
7384 (setq ne-beg (org-back-over-empty-lines))
7385 (setq beg (point)))
7386 (save-match-data
7387 (save-excursion (outline-end-of-heading)
7388 (setq folded (outline-invisible-p)))
7389 (outline-end-of-subtree))
7390 (outline-next-heading)
7391 (setq ne-end (org-back-over-empty-lines))
7392 (setq end (point))
7393 (goto-char beg0)
7394 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7395 ;; include less whitespace
7396 (save-excursion
7397 (goto-char beg)
7398 (forward-line (- ne-beg ne-end))
7399 (setq beg (point))))
7400 ;; Find insertion point, with error handling
7401 (while (> cnt 0)
7402 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7403 (progn (goto-char beg0)
7404 (error "Cannot move past superior level or buffer limit")))
7405 (setq cnt (1- cnt)))
7406 (if (> arg 0)
7407 ;; Moving forward - still need to move over subtree
7408 (progn (org-end-of-subtree t t)
7409 (save-excursion
7410 (org-back-over-empty-lines)
7411 (or (bolp) (newline)))))
7412 (setq ne-ins (org-back-over-empty-lines))
7413 (move-marker ins-point (point))
7414 (setq txt (buffer-substring beg end))
7415 (org-save-markers-in-region beg end)
7416 (delete-region beg end)
7417 (org-remove-empty-overlays-at beg)
7418 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7419 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7421 (let ((bbb (point)))
7422 (insert-before-markers txt)
7423 (org-reinstall-markers-in-region bbb)
7424 (move-marker ins-point bbb))
7426 (setq ins-end (point))
7427 (goto-char ins-point)
7428 (org-skip-whitespace)
7429 (when (and (< arg 0)
7430 (org-first-sibling-p)
7431 (> ne-ins ne-beg))
7432 ;; Move whitespace back to beginning
7433 (save-excursion
7434 (goto-char ins-end)
7435 (let ((kill-whole-line t))
7436 (kill-line (- ne-ins ne-beg)) (point)))
7438 (move-marker ins-point nil)
7439 (if folded
7440 (hide-subtree)
7441 (org-show-entry)
7442 (show-children)
7443 (org-cycle-hide-drawers 'children))
7444 (org-clean-visibility-after-subtree-move)
7445 ;; move back to the initial column we were at
7446 (move-to-column col)))
7448 (defvar org-subtree-clip ""
7449 "Clipboard for cut and paste of subtrees.
7450 This is actually only a copy of the kill, because we use the normal kill
7451 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7453 (defvar org-subtree-clip-folded nil
7454 "Was the last copied subtree folded?
7455 This is used to fold the tree back after pasting.")
7457 (defun org-cut-subtree (&optional n)
7458 "Cut the current subtree into the clipboard.
7459 With prefix arg N, cut this many sequential subtrees.
7460 This is a short-hand for marking the subtree and then cutting it."
7461 (interactive "p")
7462 (org-copy-subtree n 'cut))
7464 (defun org-copy-subtree (&optional n cut force-store-markers)
7465 "Cut the current subtree into the clipboard.
7466 With prefix arg N, cut this many sequential subtrees.
7467 This is a short-hand for marking the subtree and then copying it.
7468 If CUT is non-nil, actually cut the subtree.
7469 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7470 of some markers in the region, even if CUT is non-nil. This is
7471 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7472 (interactive "p")
7473 (let (beg end folded (beg0 (point)))
7474 (if (org-called-interactively-p 'any)
7475 (org-back-to-heading nil) ; take what looks like a subtree
7476 (org-back-to-heading t)) ; take what is really there
7477 (org-back-over-empty-lines)
7478 (setq beg (point))
7480 (save-match-data
7481 (save-excursion (outline-end-of-heading)
7482 (setq folded (outline-invisible-p)))
7483 (condition-case nil
7484 (org-forward-same-level (1- n) t)
7485 (error nil))
7486 (org-end-of-subtree t t))
7487 (org-back-over-empty-lines)
7488 (setq end (point))
7489 (goto-char beg0)
7490 (when (> end beg)
7491 (setq org-subtree-clip-folded folded)
7492 (when (or cut force-store-markers)
7493 (org-save-markers-in-region beg end))
7494 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7495 (setq org-subtree-clip (current-kill 0))
7496 (message "%s: Subtree(s) with %d characters"
7497 (if cut "Cut" "Copied")
7498 (length org-subtree-clip)))))
7500 (defun org-paste-subtree (&optional level tree for-yank)
7501 "Paste the clipboard as a subtree, with modification of headline level.
7502 The entire subtree is promoted or demoted in order to match a new headline
7503 level.
7505 If the cursor is at the beginning of a headline, the same level as
7506 that headline is used to paste the tree
7508 If not, the new level is derived from the *visible* headings
7509 before and after the insertion point, and taken to be the inferior headline
7510 level of the two. So if the previous visible heading is level 3 and the
7511 next is level 4 (or vice versa), level 4 will be used for insertion.
7512 This makes sure that the subtree remains an independent subtree and does
7513 not swallow low level entries.
7515 You can also force a different level, either by using a numeric prefix
7516 argument, or by inserting the heading marker by hand. For example, if the
7519 If optional TREE is given, use this text instead of the kill ring.
7521 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7522 move back over whitespace before inserting, and move point to the end of
7523 the inserted text when done."
7524 (interactive "P")
7525 (setq tree (or tree (and kill-ring (current-kill 0))))
7526 (unless (org-kill-is-subtree-p tree)
7527 (error "%s"
7528 (substitute-command-keys
7530 (org-with-limited-levels
7531 (let* ((visp (not (outline-invisible-p)))
7532 (txt tree)
7534 (old-level (if (string-match org-outline-regexp-bol txt)
7535 (- (match-end 0) (match-beginning 0) 1)
7536 -1))
7537 (force-level (cond (level (prefix-numeric-value level))
7539 (string-match
7540 ^re_ (buffer-substring
7541 (point-at-bol) (point))))
7542 (- (match-end 1) (match-beginning 1)))
7543 ((and (bolp)
7544 (looking-at org-outline-regexp))
7545 (- (match-end 0) (point) 1))
7546 (t nil)))
7547 (previous-level (save-excursion
7548 (condition-case nil
7549 (progn
7550 (outline-previous-visible-heading 1)
7551 (if (looking-at re)
7552 (- (match-end 0) (match-beginning 0) 1)
7553 1))
7554 (error 1))))
7555 (next-level (save-excursion
7556 (condition-case nil
7557 (progn
7558 (or (looking-at org-outline-regexp)
7559 (outline-next-visible-heading 1))
7560 (if (looking-at re)
7561 (- (match-end 0) (match-beginning 0) 1)
7562 1))
7563 (error 1))))
7564 (new-level (or force-level (max previous-level next-level)))
7565 (shift (if (or (= old-level -1)
7566 (= new-level -1)
7567 (= old-level new-level))
7568 0
7569 (- new-level old-level)))
7570 (delta (if (> shift 0) -1 1))
7571 (func (if (> shift 0) 'org-demote 'org-promote))
7572 (org-odd-levels-only nil)
7573 beg end newend)
7574 ;; Remove the forced level indicator
7575 (if force-level
7576 (delete-region (point-at-bol) (point)))
7577 ;; Paste
7578 (beginning-of-line 1)
7579 (unless for-yank (org-back-over-empty-lines))
7580 (setq beg (point))
7581 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7582 (insert-before-markers txt)
7584 (setq newend (point))
7585 (org-reinstall-markers-in-region beg)
7586 (setq end (point))
7587 (goto-char beg)
7589 (setq beg (point))
7590 (if (and (outline-invisible-p) visp)
7591 (save-excursion (outline-show-heading)))
7592 ;; Shift if necessary
7593 (unless (= shift 0)
7594 (save-restriction
7595 (narrow-to-region beg end)
7596 (while (not (= shift 0))
7597 (org-map-region func (point-min) (point-max))
7598 (setq shift (+ delta shift)))
7599 (goto-char (point-min))
7600 (setq newend (point-max))))
7601 (when (or (org-called-interactively-p 'interactive) for-yank)
7602 (message "Clipboard pasted as level %d subtree" new-level))
7603 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7604 kill-ring
7605 (eq org-subtree-clip (current-kill 0))
7606 org-subtree-clip-folded)
7607 ;; The tree was folded before it was killed/copied
7608 (hide-subtree))
7609 (and for-yank (goto-char newend)))))
7611 (defun org-kill-is-subtree-p (&optional txt)
7612 "Check if the current kill is an outline subtree, or a set of trees.
7613 Returns nil if kill does not start with a headline, or if the first
7614 headline level is not the largest headline level in the tree.
7615 So this will actually accept several entries of equal levels as well,
7616 which is OK for `org-paste-subtree'.
7617 If optional TXT is given, check this string instead of the current kill."
7618 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7619 (re (org-get-limited-outline-regexp))
7620 (^re (concat "^" re))
7621 (start-level (and kill
7622 (string-match
7624 kill)
7625 (- (match-end 2) (match-beginning 2) 1)))
7626 (start (1+ (or (match-beginning 2) -1))))
7627 (if (not start-level)
7628 (progn
7629 nil) ;; does not even start with a heading
7630 (catch 'exit
7631 (while (setq start (string-match ^re kill (1+ start)))
7632 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7633 (throw 'exit nil)))
7634 t))))
7636 (defvar org-markers-to-move nil
7637 "Markers that should be moved with a cut-and-paste operation.
7638 Those markers are stored together with their positions relative to
7639 the start of the region.")
7641 (defun org-save-markers-in-region (beg end)
7642 "Check markers in region.
7643 If these markers are between BEG and END, record their position relative
7644 to BEG, so that after moving the block of text, we can put the markers back
7645 into place.
7646 This function gets called just before an entry or tree gets cut from the
7647 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7648 called immediately, to move the markers with the entries."
7649 (setq org-markers-to-move nil)
7650 (when (featurep 'org-clock)
7651 (org-clock-save-markers-for-cut-and-paste beg end))
7652 (when (featurep 'org-agenda)
7653 (org-agenda-save-markers-for-cut-and-paste beg end)))
7655 (defun org-check-and-save-marker (marker beg end)
7656 "Check if MARKER is between BEG and END.
7657 If yes, remember the marker and the distance to BEG."
7658 (when (and (marker-buffer marker)
7659 (equal (marker-buffer marker) (current-buffer)))
7660 (if (and (>= marker beg) (< marker end))
7661 (push (cons marker (- marker beg)) org-markers-to-move))))
7663 (defun org-reinstall-markers-in-region (beg)
7664 "Move all remembered markers to their position relative to BEG."
7665 (mapc (lambda (x)
7666 (move-marker (car x) (+ beg (cdr x))))
7667 org-markers-to-move)
7668 (setq org-markers-to-move nil))
7670 (defun org-narrow-to-subtree ()
7671 "Narrow buffer to the current subtree."
7672 (interactive)
7673 (save-excursion
7674 (save-match-data
7675 (org-with-limited-levels
7676 (narrow-to-region
7677 (progn (org-back-to-heading t) (point))
7678 (progn (org-end-of-subtree t t)
7679 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7680 (point)))))))
7682 (defun org-narrow-to-block ()
7683 "Narrow buffer to the current block."
7684 (interactive)
7687 (case-fold-search t) ;; allow #+BEGIN
7688 b_start b_end)
7689 (if (org-in-regexps-block-p bstart bend)
7690 (progn
7691 (save-excursion (re-search-backward bstart nil t)
7692 (setq b_start (match-beginning 0)))
7693 (save-excursion (re-search-forward bend nil t)
7694 (setq b_end (match-end 0)))
7695 (narrow-to-region b_start b_end))
7696 (error "Not in a block"))))
7698 (eval-when-compile
7699 (defvar org-property-drawer-re))
7701 (defvar org-property-start-re) ;; defined below
7702 (defun org-clone-subtree-with-time-shift (n &optional shift)
7703 "Clone the task (subtree) at point N times.
7704 The clones will be inserted as siblings.
7706 In interactive use, the user will be prompted for the number of
7707 clones to be produced, and for a time SHIFT, which may be a
7708 repeater as used in time stamps, for example `+3d'.
7710 When a valid repeater is given and the entry contains any time
7711 stamps, the clones will become a sequence in time, with time
7712 stamps in the subtree shifted for each clone produced. If SHIFT
7713 is nil or the empty string, time stamps will be left alone. The
7714 ID property of the original subtree is removed.
7716 If the original subtree did contain time stamps with a repeater,
7717 the following will happen:
7718 - the repeater will be removed in each clone
7719 - an additional clone will be produced, with the current, unshifted
7720 date(s) in the entry.
7721 - the original entry will be placed *after* all the clones, with
7722 repeater intact.
7723 - the start days in the repeater in the original entry will be shifted
7724 to past the last clone.
7725 I this way you can spell out a number of instances of a repeating task,
7726 and still retain the repeater to cover future instances of the task."
7727 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7728 (let (beg end template task idprop
7729 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7730 (if (not (and (integerp n) (> n 0)))
7731 (error "Invalid number of replications %s" n))
7734 shift)))
7735 (error "Invalid shift specification %s" shift))
7736 (when doshift
7737 (setq shift-n (string-to-number (match-string 1 shift))
7738 shift-what (cdr (assoc (match-string 2 shift)
7739 '(("d" . day) ("w" . week)
7740 ("m" . month) ("y" . year))))))
7741 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7742 (setq nmin 1 nmax n)
7743 (org-back-to-heading t)
7744 (setq beg (point))
7745 (setq idprop (org-entry-get nil "ID"))
7746 (org-end-of-subtree t t)
7748 (setq end (point))
7749 (setq template (buffer-substring beg end))
7750 ;; Remove clocks and empty drawers
7751 (with-temp-buffer
7752 (insert template)
7753 (goto-char (point-min))
7754 (while (re-search-forward
7756 (replace-match "")
7757 (kill-whole-line))
7758 (goto-char (point-min))
7759 (while (re-search-forward
7761 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7762 (setq template (buffer-substring (point-min) (point-max))))
7763 (when (and doshift
7765 (delete-region beg end)
7766 (setq end beg)
7767 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7768 (goto-char end)
7769 (loop for n from nmin to nmax do
7770 ;; prepare clone
7771 (with-temp-buffer
7772 (insert template)
7773 (org-mode)
7774 (goto-char (point-min))
7775 (and idprop (if org-clone-delete-id
7776 (org-entry-delete nil "ID")
7777 (org-id-get-create t)))
7778 (while (re-search-forward org-property-start-re nil t)
7779 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7780 (goto-char (point-min))
7781 (when doshift
7782 (while (re-search-forward org-ts-regexp-both nil t)
7783 (org-timestamp-change (* n shift-n) shift-what))
7784 (unless (= n n-no-remove)
7785 (goto-char (point-min))
7786 (while (re-search-forward org-ts-regexp nil t)
7787 (save-excursion
7788 (goto-char (match-beginning 0))
7790 (delete-region (match-beginning 1) (match-end 1)))))))
7791 (setq task (buffer-string)))
7792 (insert task))
7793 (goto-char beg)))
7795 ;;; Outline Sorting
7797 (defun org-sort (with-case)
7798 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7799 Optional argument WITH-CASE means sort case-sensitively.
7800 With a double prefix argument, also remove duplicate entries."
7801 (interactive "P")
7802 (cond
7803 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7804 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7805 (t
7806 (org-call-with-arg 'org-sort-entries with-case))))
7808 (defun org-sort-remove-invisible (s)
7809 (remove-text-properties 0 (length s) org-rm-props s)
7810 (while (string-match org-bracket-link-regexp s)
7811 (setq s (replace-match (if (match-end 2)
7812 (match-string 3 s)
7813 (match-string 1 s)) t t s)))
7814 s)
7816 (defvar org-priority-regexp) ; defined later in the file
7818 (defvar org-after-sorting-entries-or-items-hook nil
7819 "Hook that is run after a bunch of entries or items have been sorted.
7820 When children are sorted, the cursor is in the parent line when this
7821 hook gets called. When a region or a plain list is sorted, the cursor
7822 will be in the first entry of the sorted region/list.")
7824 (defun org-sort-entries
7825 (&optional with-case sorting-type getkey-func compare-func property)
7826 "Sort entries on a certain level of an outline tree.
7827 If there is an active region, the entries in the region are sorted.
7828 Else, if the cursor is before the first entry, sort the top-level items.
7829 Else, the children of the entry at point are sorted.
7831 Sorting can be alphabetically, numerically, by date/time as given by
7832 a time stamp, by a property or by priority.
7834 The command prompts for the sorting type unless it has been given to the
7835 function through the SORTING-TYPE argument, which needs to be a character,
7836 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7837 precise meaning of each character:
7839 n Numerically, by converting the beginning of the entry/item to a number.
7840 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7841 t By date/time, either the first active time stamp in the entry, or, if
7842 none exist, by the first inactive one.
7843 s By the scheduled date/time.
7844 d By deadline date/time.
7845 c By creation time, which is assumed to be the first inactive time stamp
7846 at the beginning of a line.
7847 p By priority according to the cookie.
7848 r By the value of a property.
7850 Capital letters will reverse the sort order.
7852 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7853 called with point at the beginning of the record. It must return either
7854 a string or a number that should serve as the sorting key for that record.
7856 Comparing entries ignores case by default. However, with an optional argument
7857 WITH-CASE, the sorting considers case as well."
7858 (interactive "P")
7859 (let ((case-func (if with-case 'identity 'downcase))
7860 start beg end stars re re2
7861 txt what tmp)
7862 ;; Find beginning and end of region to sort
7863 (cond
7864 ((org-region-active-p)
7865 ;; we will sort the region
7866 (setq end (region-end)
7867 what "region")
7868 (goto-char (region-beginning))
7869 (if (not (org-on-heading-p)) (outline-next-heading))
7870 (setq start (point)))
7871 ((or (org-on-heading-p)
7872 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7873 ;; we will sort the children of the current headline
7874 (org-back-to-heading)
7875 (setq start (point)
7876 end (progn (org-end-of-subtree t t)
7878 (org-back-over-empty-lines)
7879 (point))
7880 what "children")
7881 (goto-char start)
7882 (show-subtree)
7883 (outline-next-heading))
7884 (t
7885 ;; we will sort the top-level entries in this file
7886 (goto-char (point-min))
7887 (or (org-on-heading-p) (outline-next-heading))
7888 (setq start (point))
7889 (goto-char (point-max))
7890 (beginning-of-line 1)
7892 ;; File ends in a non-white line
7893 (end-of-line 1)
7895 (setq end (point-max))
7896 (setq what "top-level")
7897 (goto-char start)
7898 (show-all)))
7900 (setq beg (point))
7901 (if (>= beg end) (error "Nothing to sort"))
7904 (setq stars (match-string 1)
7905 re (concat "^" (regexp-quote stars) " +")
7907 txt (buffer-substring beg end))
7909 (if (and (not (equal stars "*")) (string-match re2 txt))
7910 (error "Region to sort contains a level above the first entry"))
7912 (unless sorting-type
7913 (message
7914 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7916 A/N/T/S/D/C/P/O/F means reversed:"
7917 what)
7918 (setq sorting-type (read-char-exclusive))
7920 (and (= (downcase sorting-type) ?f)
7921 (setq getkey-func
7922 (org-icompleting-read "Sort using function: "
7923 obarray 'fboundp t nil nil))
7924 (setq getkey-func (intern getkey-func)))
7926 (and (= (downcase sorting-type) ?r)
7927 (setq property
7928 (org-icompleting-read "Property: "
7929 (mapcar 'list (org-buffer-property-keys t))
7930 nil t))))
7932 (message "Sorting entries...")
7934 (save-restriction
7935 (narrow-to-region start end)
7936 (let ((dcst (downcase sorting-type))
7937 (case-fold-search nil)
7938 (now (current-time)))
7939 (sort-subr
7940 (/= dcst sorting-type)
7941 ;; This function moves to the beginning character of the "record" to
7942 ;; be sorted.
7943 (lambda nil
7944 (if (re-search-forward re nil t)
7945 (goto-char (match-beginning 0))
7946 (goto-char (point-max))))
7947 ;; This function moves to the last character of the "record" being
7948 ;; sorted.
7949 (lambda nil
7950 (save-match-data
7951 (condition-case nil
7952 (outline-forward-same-level 1)
7953 (error
7954 (goto-char (point-max))))))
7955 ;; This function returns the value that gets sorted against.
7956 (lambda nil
7957 (cond
7958 ((= dcst ?n)
7959 (if (looking-at org-complex-heading-regexp)
7960 (string-to-number (match-string 4))
7961 nil))
7962 ((= dcst ?a)
7963 (if (looking-at org-complex-heading-regexp)
7964 (funcall case-func (match-string 4))
7965 nil))
7966 ((= dcst ?t)
7967 (let ((end (save-excursion (outline-next-heading) (point))))
7968 (if (or (re-search-forward org-ts-regexp end t)
7969 (re-search-forward org-ts-regexp-both end t))
7970 (org-time-string-to-seconds (match-string 0))
7971 (org-float-time now))))
7972 ((= dcst ?c)
7973 (let ((end (save-excursion (outline-next-heading) (point))))
7974 (if (re-search-forward
7976 end t)
7977 (org-time-string-to-seconds (match-string 0))
7978 (org-float-time now))))
7979 ((= dcst ?s)
7980 (let ((end (save-excursion (outline-next-heading) (point))))
7981 (if (re-search-forward org-scheduled-time-regexp end t)
7982 (org-time-string-to-seconds (match-string 1))
7983 (org-float-time now))))
7984 ((= dcst ?d)
7985 (let ((end (save-excursion (outline-next-heading) (point))))
7986 (if (re-search-forward org-deadline-time-regexp end t)
7987 (org-time-string-to-seconds (match-string 1))
7988 (org-float-time now))))
7989 ((= dcst ?p)
7990 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7991 (string-to-char (match-string 2))
7992 org-default-priority))
7993 ((= dcst ?r)
7994 (or (org-entry-get nil property) ""))
7995 ((= dcst ?o)
7996 (if (looking-at org-complex-heading-regexp)
7997 (- 9999 (length (member (match-string 2)
7998 org-todo-keywords-1)))))
7999 ((= dcst ?f)
8000 (if getkey-func
8001 (progn
8002 (setq tmp (funcall getkey-func))
8003 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8004 tmp)
8005 (error "Invalid key function `%s'" getkey-func)))
8006 (t (error "Invalid sorting type `%c'" sorting-type))))
8007 nil
8008 (cond
8009 ((= dcst ?a) 'string<)
8010 ((= dcst ?f) compare-func)
8011 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8012 (t nil)))))
8013 (run-hooks 'org-after-sorting-entries-or-items-hook)
8014 (message "Sorting entries...done")))
8016 (defun org-do-sort (table what &optional with-case sorting-type)
8017 "Sort TABLE of WHAT according to SORTING-TYPE.
8018 The user will be prompted for the SORTING-TYPE if the call to this
8019 function does not specify it. WHAT is only for the prompt, to indicate
8020 what is being sorted. The sorting key will be extracted from
8021 the car of the elements of the table.
8022 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8023 (unless sorting-type
8024 (message
8025 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8026 what)
8027 (setq sorting-type (read-char-exclusive)))
8028 (let ((dcst (downcase sorting-type))
8029 extractfun comparefun)
8030 ;; Define the appropriate functions
8031 (cond
8032 ((= dcst ?n)
8033 (setq extractfun 'string-to-number
8034 comparefun (if (= dcst sorting-type) '< '>)))
8035 ((= dcst ?a)
8036 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8037 (lambda(x) (downcase (org-sort-remove-invisible x))))
8038 comparefun (if (= dcst sorting-type)
8039 'string<
8040 (lambda (a b) (and (not (string< a b))
8041 (not (string= a b)))))))
8042 ((= dcst ?t)
8043 (setq extractfun
8044 (lambda (x)
8045 (if (or (string-match org-ts-regexp x)
8046 (string-match org-ts-regexp-both x))
8047 (org-float-time
8048 (org-time-string-to-time (match-string 0 x)))
8049 0))
8050 comparefun (if (= dcst sorting-type) '< '>)))
8051 (t (error "Invalid sorting type `%c'" sorting-type)))
8053 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8054 table)
8055 (lambda (a b) (funcall comparefun (car a) (car b))))))
8058 ;;; The orgstruct minor mode
8060 ;; Define a minor mode which can be used in other modes in order to
8061 ;; integrate the org-mode structure editing commands.
8063 ;; This is really a hack, because the org-mode structure commands use
8064 ;; keys which normally belong to the major mode. Here is how it
8065 ;; works: The minor mode defines all the keys necessary to operate the
8066 ;; structure commands, but wraps the commands into a function which
8067 ;; tests if the cursor is currently at a headline or a plain list
8068 ;; item. If that is the case, the structure command is used,
8069 ;; temporarily setting many Org-mode variables like regular
8070 ;; expressions for filling etc. However, when any of those keys is
8071 ;; used at a different location, function uses `key-binding' to look
8072 ;; up if the key has an associated command in another currently active
8073 ;; keymap (minor modes, major mode, global), and executes that
8074 ;; command. There might be problems if any of the keys is otherwise
8075 ;; used as a prefix key.
8077 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8078 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8079 ;; addresses this by checking explicitly for both bindings.
8081 (defvar orgstruct-mode-map (make-sparse-keymap)
8082 "Keymap for the minor `orgstruct-mode'.")
8084 (defvar org-local-vars nil
8085 "List of local variables, for use by `orgstruct-mode'.")
8087 ;;;###autoload
8088 (define-minor-mode orgstruct-mode
8089 "Toggle the minor mode `orgstruct-mode'.
8090 This mode is for using Org-mode structure commands in other
8091 modes. The following keys behave as if Org-mode were active, if
8092 the cursor is on a headline, or on a plain list item (both as
8093 defined by Org-mode).
8095 M-up Move entry/item up
8096 M-down Move entry/item down
8097 M-left Promote
8098 M-right Demote
8099 M-S-up Move entry/item up
8100 M-S-down Move entry/item down
8101 M-S-left Promote subtree
8102 M-S-right Demote subtree
8103 M-q Fill paragraph and items like in Org-mode
8104 C-c ^ Sort entries
8105 C-c - Cycle list bullet
8106 TAB Cycle item visibility
8107 M-RET Insert new heading/item
8108 S-M-RET Insert new TODO heading / Checkbox item
8109 C-c C-c Set tags / toggle checkbox"
8110 nil " OrgStruct" nil
8111 (org-load-modules-maybe)
8112 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8114 ;;;###autoload
8115 (defun turn-on-orgstruct ()
8116 "Unconditionally turn on `orgstruct-mode'."
8117 (orgstruct-mode 1))
8119 (defun orgstruct++-mode (&optional arg)
8120 "Toggle `orgstruct-mode', the enhanced version of it.
8121 In addition to setting orgstruct-mode, this also exports all indentation
8122 and autofilling variables from org-mode into the buffer. It will also
8123 recognize item context in multiline items.
8124 Note that turning off orgstruct-mode will *not* remove the
8125 indentation/paragraph settings. This can only be done by refreshing the
8127 (interactive "P")
8128 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8129 (if (< arg 1)
8130 (orgstruct-mode -1)
8131 (orgstruct-mode 1)
8132 (let (var val)
8133 (mapc
8134 (lambda (x)
8135 (when (string-match
8137 (symbol-name (car x)))
8138 (setq var (car x) val (nth 1 x))
8139 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8140 org-local-vars)
8141 (org-set-local 'orgstruct-is-++ t))))
8143 (defvar orgstruct-is-++ nil
8144 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8145 (make-variable-buffer-local 'orgstruct-is-++)
8147 ;;;###autoload
8148 (defun turn-on-orgstruct++ ()
8149 "Unconditionally turn on `orgstruct++-mode'."
8150 (orgstruct++-mode 1))
8152 (defun orgstruct-error ()
8153 "Error when there is no default binding for a structure key."
8154 (interactive)
8155 (error "This key has no function outside structure elements"))
8157 (defun orgstruct-setup ()
8158 "Setup orgstruct keymaps."
8159 (let ((nfunc 0)
8160 (bindings
8161 (list
8162 '([(meta up)] org-metaup)
8163 '([(meta down)] org-metadown)
8164 '([(meta left)] org-metaleft)
8165 '([(meta right)] org-metaright)
8166 '([(meta shift up)] org-shiftmetaup)
8167 '([(meta shift down)] org-shiftmetadown)
8168 '([(meta shift left)] org-shiftmetaleft)
8169 '([(meta shift right)] org-shiftmetaright)
8170 '([?\e (up)] org-metaup)
8171 '([?\e (down)] org-metadown)
8172 '([?\e (left)] org-metaleft)
8173 '([?\e (right)] org-metaright)
8174 '([?\e (shift up)] org-shiftmetaup)
8175 '([?\e (shift down)] org-shiftmetadown)
8176 '([?\e (shift left)] org-shiftmetaleft)
8177 '([?\e (shift right)] org-shiftmetaright)
8178 '([(shift up)] org-shiftup)
8179 '([(shift down)] org-shiftdown)
8180 '([(shift left)] org-shiftleft)
8181 '([(shift right)] org-shiftright)
8182 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8183 '("\M-q" fill-paragraph)
8184 '("\C-c^" org-sort)
8185 '("\C-c-" org-cycle-list-bullet)))
8186 elt key fun cmd)
8187 (while (setq elt (pop bindings))
8188 (setq nfunc (1+ nfunc))
8189 (setq key (org-key (car elt))
8190 fun (nth 1 elt)
8191 cmd (orgstruct-make-binding fun nfunc key))
8192 (org-defkey orgstruct-mode-map key cmd))
8194 ;; Special treatment needed for TAB and RET
8195 (org-defkey orgstruct-mode-map [(tab)]
8196 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8197 (org-defkey orgstruct-mode-map "\C-i"
8198 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8200 (org-defkey orgstruct-mode-map "\M-\C-m"
8201 (orgstruct-make-binding 'org-insert-heading 105
8202 "\M-\C-m" [(meta return)]))
8203 (org-defkey orgstruct-mode-map [(meta return)]
8204 (orgstruct-make-binding 'org-insert-heading 106
8205 [(meta return)] "\M-\C-m"))
8207 (org-defkey orgstruct-mode-map [(shift meta return)]
8208 (orgstruct-make-binding 'org-insert-todo-heading 107
8209 [(meta return)] "\M-\C-m"))
8211 (org-defkey orgstruct-mode-map "\e\C-m"
8212 (orgstruct-make-binding 'org-insert-heading 108
8213 "\e\C-m" [?\e (return)]))
8214 (org-defkey orgstruct-mode-map [?\e (return)]
8215 (orgstruct-make-binding 'org-insert-heading 109
8216 [?\e (return)] "\e\C-m"))
8217 (org-defkey orgstruct-mode-map [?\e (shift return)]
8218 (orgstruct-make-binding 'org-insert-todo-heading 110
8219 [?\e (return)] "\e\C-m"))
8221 (unless org-local-vars
8222 (setq org-local-vars (org-get-local-variables)))
8224 t))
8226 (defun orgstruct-make-binding (fun n &rest keys)
8227 "Create a function for binding in the structure minor mode.
8228 FUN is the command to call inside a table. N is used to create a unique
8229 command name. KEYS are keys that should be checked in for a command
8230 to execute outside of tables."
8231 (eval
8232 (list 'defun
8233 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8234 '(arg)
8236 "Outside of structure, run the binding of `"
8237 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8238 "'.")
8239 '(interactive "p")
8240 (list 'if
8241 `(org-context-p 'headline 'item
8242 (and orgstruct-is-++
8243 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8244 'item-body))
8245 (list 'org-run-like-in-org-mode (list 'quote fun))
8246 (list 'let '(orgstruct-mode)
8247 (list 'call-interactively
8248 (append '(or)
8249 (mapcar (lambda (k)
8250 (list 'key-binding k))
8251 keys)
8252 '('orgstruct-error))))))))
8254 (defun org-context-p (&rest contexts)
8255 "Check if local context is any of CONTEXTS.
8256 Possible values in the list of contexts are `table', `headline', and `item'."
8257 (let ((pos (point)))
8258 (goto-char (point-at-bol))
8259 (prog1 (or (and (memq 'table contexts)
8261 (and (memq 'headline contexts)
8262 (looking-at org-outline-regexp))
8263 (and (memq 'item contexts)
8265 (and (memq 'item-body contexts)
8266 (org-in-item-p)))
8267 (goto-char pos))))
8269 (defun org-get-local-variables ()
8270 "Return a list of all local variables in an org-mode buffer."
8271 (let (varlist)
8272 (with-current-buffer (get-buffer-create "*Org tmp*")
8273 (erase-buffer)
8274 (org-mode)
8275 (setq varlist (buffer-local-variables)))
8276 (kill-buffer "*Org tmp*")
8277 (delq nil
8278 (mapcar
8279 (lambda (x)
8280 (setq x
8281 (if (symbolp x)
8282 (list x)
8283 (list (car x) (list 'quote (cdr x)))))
8284 (if (string-match
8285 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8286 (symbol-name (car x)))
8287 x nil))
8288 varlist))))
8290 (defun org-clone-local-variables (from-buffer &optional regexp)
8291 "Clone local variables from FROM-BUFFER.
8292 Optional argument REGEXP selects variables to clone."
8293 (mapc
8294 (lambda (pair)
8295 (and (symbolp (car pair))
8296 (or (null regexp)
8297 (string-match regexp (symbol-name (car pair))))
8298 (set (make-local-variable (car pair))
8299 (cdr pair))))
8300 (buffer-local-variables from-buffer)))
8302 ;;;###autoload
8303 (defun org-run-like-in-org-mode (cmd)
8304 "Run a command, pretending that the current buffer is in Org-mode.
8305 This will temporarily bind local variables that are typically bound in
8306 Org-mode to the values they have in Org-mode, and then interactively
8307 call CMD."
8308 (org-load-modules-maybe)
8309 (unless org-local-vars
8310 (setq org-local-vars (org-get-local-variables)))
8311 (eval (list 'let org-local-vars
8312 (list 'call-interactively (list 'quote cmd)))))
8314 ;;;; Archiving
8316 (defun org-get-category (&optional pos force-refresh)
8317 "Get the category applying to position POS."
8318 (if force-refresh (org-refresh-category-properties))
8319 (let ((pos (or pos (point))))
8320 (or (get-text-property pos 'org-category)
8321 (progn (org-refresh-category-properties)
8322 (get-text-property pos 'org-category)))))
8324 (defun org-refresh-category-properties ()
8325 "Refresh category text properties in the buffer."
8326 (let ((def-cat (cond
8327 ((null org-category)
8328 (if buffer-file-name
8329 (file-name-sans-extension
8330 (file-name-nondirectory buffer-file-name))
8331 "???"))
8332 ((symbolp org-category) (symbol-name org-category))
8333 (t org-category)))
8334 beg end cat pos optionp)
8335 (org-unmodified
8336 (save-excursion
8337 (save-restriction
8338 (widen)
8339 (goto-char (point-min))
8340 (put-text-property (point) (point-max) 'org-category def-cat)
8341 (while (re-search-forward
8343 (setq pos (match-end 0)
8344 optionp (equal (char-after (match-beginning 0)) ?#)
8345 cat (org-trim (match-string 2)))
8346 (if optionp
8347 (setq beg (point-at-bol) end (point-max))
8348 (org-back-to-heading t)
8349 (setq beg (point) end (org-end-of-subtree t t)))
8350 (put-text-property beg end 'org-category cat)
8351 (goto-char pos)))))))
8354 ;;;; Link Stuff
8356 ;;; Link abbreviations
8358 (defun org-link-expand-abbrev (link)
8359 "Apply replacements as defined in `org-link-abbrev-alist."
8361 (let* ((key (match-string 1 link))
8362 (as (or (assoc key org-link-abbrev-alist-local)
8363 (assoc key org-link-abbrev-alist)))
8364 (tag (and (match-end 2) (match-string 3 link)))
8365 rpl)
8366 (if (not as)
8367 link
8368 (setq rpl (cdr as))
8369 (cond
8370 ((symbolp rpl) (funcall rpl tag))
8371 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8372 ((string-match "%h" rpl)
8373 (replace-match (url-hexify-string (or tag "")) t t rpl))
8374 (t (concat rpl tag)))))
8375 link))
8377 ;;; Storing and inserting links
8379 (defvar org-insert-link-history nil
8380 "Minibuffer history for links inserted with `org-insert-link'.")
8382 (defvar org-stored-links nil
8383 "Contains the links stored with `org-store-link'.")
8385 (defvar org-store-link-plist nil
8386 "Plist with info about the most recently link created with `org-store-link'.")
8388 (defvar org-link-protocols nil
8389 "Link protocols added to Org-mode using `org-add-link-type'.")
8391 (defvar org-store-link-functions nil
8392 "List of functions that are called to create and store a link.
8393 Each function will be called in turn until one returns a non-nil
8394 value. Each function should check if it is responsible for creating
8395 this link (for example by looking at the major mode).
8396 If not, it must exit and return nil.
8397 If yes, it should return a non-nil value after a calling
8398 `org-store-link-props' with a list of properties and values.
8399 Special properties are:
8403 This is obligatory as well.
8404 :description Optional default description for the second pair
8405 of brackets in an Org-mode link. The user can still change
8406 this when inserting this link into an Org-mode buffer.
8408 In addition to these, any additional properties can be specified
8409 and then used in remember templates.")
8411 (defun org-add-link-type (type &optional follow export)
8412 "Add TYPE to the list of `org-link-types'.
8413 Re-compute all regular expressions depending on `org-link-types'
8415 FOLLOW and EXPORT are two functions.
8417 FOLLOW should take the link path as the single argument and do whatever
8418 is necessary to follow the link, for example find a file or display
8419 a mail message.
8421 EXPORT should format the link path for export to one of the export formats.
8422 It should be a function accepting three arguments:
8425 desc the description of the link, if any, or a description added by
8426 org-export-normalize-links if there is none
8427 format the export format, a symbol like `html' or `latex' or `ascii'..
8429 The function may use the FORMAT information to return different values
8430 depending on the format. The return value will be put literally into
8431 the exported file. If the return value is nil, this means Org should
8432 do what it normally does with links which do not have EXPORT defined.
8434 Org-mode has a built-in default for exporting links. If you are happy with
8435 this default, there is no need to define an export function for the link
8436 type. For a simple example of an export function, see `org-bbdb.el'."
8437 (add-to-list 'org-link-types type t)
8438 (org-make-link-regexps)
8439 (if (assoc type org-link-protocols)
8440 (setcdr (assoc type org-link-protocols) (list follow export))
8441 (push (list type follow export) org-link-protocols)))
8443 (defvar org-agenda-buffer-name)
8445 ;;;###autoload
8446 (defun org-store-link (arg)
8448 This link is added to `org-stored-links' and can later be inserted
8451 For some link types, a prefix arg is interpreted:
8452 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8453 For file links, arg negates `org-context-in-file-links'."
8454 (interactive "P")
8455 (org-load-modules-maybe)
8456 (setq org-store-link-plist nil) ; reset
8457 (org-with-limited-levels
8458 (let (link cpltxt desc description search txt custom-id agenda-link)
8459 (cond
8461 ((run-hook-with-args-until-success 'org-store-link-functions)
8462 (setq link (plist-get org-store-link-plist :link)
8463 desc (or (plist-get org-store-link-plist :description) link)))
8465 ((equal (buffer-name) "*Org Edit Src Example*")
8466 (let (label gc)
8467 (while (or (not label)
8468 (save-excursion
8469 (save-restriction
8470 (widen)
8471 (goto-char (point-min))
8472 (re-search-forward
8473 (regexp-quote (format org-coderef-label-format label))
8474 nil t))))
8475 (when label (message "Label exists already") (sit-for 2))
8476 (setq label (read-string "Code line label: " label)))
8477 (end-of-line 1)
8478 (setq link (format org-coderef-label-format label))
8479 (setq gc (- 79 (length link)))
8480 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8481 (insert link)
8482 (setq link (concat "(" label ")") desc nil)))
8484 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8485 ;; We are in the agenda, link to referenced location
8486 (let ((m (or (get-text-property (point) 'org-hd-marker)
8487 (get-text-property (point) 'org-marker))))
8488 (when m
8489 (org-with-point-at m
8490 (setq agenda-link
8491 (if (org-called-interactively-p 'any)
8492 (call-interactively 'org-store-link)
8493 (org-store-link nil)))))))
8495 ((eq major-mode 'calendar-mode)
8496 (let ((cd (calendar-cursor-to-date)))
8497 (setq link
8498 (format-time-string
8499 (car org-time-stamp-formats)
8500 (apply 'encode-time
8501 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8502 nil nil nil))))
8503 (org-store-link-props :type "calendar" :date cd)))
8505 ((eq major-mode 'w3-mode)
8506 (setq cpltxt (if (and (buffer-name)
8507 (not (string-match "Untitled" (buffer-name))))
8508 (buffer-name)
8509 (url-view-url t))
8510 link (org-make-link (url-view-url t)))
8511 (org-store-link-props :type "w3" :url (url-view-url t)))
8513 ((eq major-mode 'w3m-mode)
8514 (setq cpltxt (or w3m-current-title w3m-current-url)
8515 link (org-make-link w3m-current-url))
8516 (org-store-link-props :type "w3m" :url (url-view-url t)))
8518 ((setq search (run-hook-with-args-until-success
8519 'org-create-file-search-functions))
8520 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8521 "::" search))
8522 (setq cpltxt (or description link)))
8524 ((eq major-mode 'image-mode)
8525 (setq cpltxt (concat "file:"
8526 (abbreviate-file-name buffer-file-name))
8527 link (org-make-link cpltxt))
8528 (org-store-link-props :type "image" :file buffer-file-name))
8530 ((eq major-mode 'dired-mode)
8531 ;; link to the file in the current line
8532 (let ((file (dired-get-filename nil t)))
8533 (setq file (if file
8534 (abbreviate-file-name
8535 (expand-file-name (dired-get-filename nil t)))
8536 ;; otherwise, no file so use current directory.
8537 default-directory))
8538 (setq cpltxt (concat "file:" file)
8539 link (org-make-link cpltxt))))
8541 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8542 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8543 (cond
8545 (setq cpltxt
8546 (concat "file:"
8547 (abbreviate-file-name
8548 (buffer-file-name (buffer-base-buffer)))
8549 "::" (match-string 1))
8550 link (org-make-link cpltxt)))
8551 ((and (featurep 'org-id)
8552 (or (eq org-link-to-org-use-id t)
8553 (and (eq org-link-to-org-use-id 'create-if-interactive)
8554 (org-called-interactively-p 'any))
8555 (and (eq org-link-to-org-use-id
8556 'create-if-interactive-and-no-custom-id)
8557 (org-called-interactively-p 'any)
8558 (not custom-id))
8559 (and org-link-to-org-use-id
8560 (org-entry-get nil "ID"))))
8561 ;; We can make a link using the ID.
8562 (setq link (condition-case nil
8563 (prog1 (org-id-store-link)
8564 (setq desc (plist-get org-store-link-plist
8565 :description)))
8566 (error
8567 ;; probably before first headline, link to file only
8568 (concat "file:"
8569 (abbreviate-file-name
8570 (buffer-file-name (buffer-base-buffer))))))))
8571 (t
8572 ;; Just link to current headline
8573 (setq cpltxt (concat "file:"
8574 (abbreviate-file-name
8575 (buffer-file-name (buffer-base-buffer)))))
8576 ;; Add a context search string
8577 (when (org-xor org-context-in-file-links arg)
8578 (setq txt (cond
8579 ((org-on-heading-p) nil)
8580 ((org-region-active-p)
8581 (buffer-substring (region-beginning) (region-end)))
8582 (t nil)))
8584 (setq cpltxt
8585 (concat cpltxt "::"
8586 (condition-case nil
8587 (org-make-org-heading-search-string txt)
8588 (error "")))
8589 desc (or (nth 4 (ignore-errors
8590 (org-heading-components))) "NONE"))))
8592 (setq cpltxt (substring cpltxt 0 -2)))
8593 (setq link (org-make-link cpltxt)))))
8595 ((buffer-file-name (buffer-base-buffer))
8596 ;; Just link to this file here.
8597 (setq cpltxt (concat "file:"
8598 (abbreviate-file-name
8599 (buffer-file-name (buffer-base-buffer)))))
8600 ;; Add a context string
8601 (when (org-xor org-context-in-file-links arg)
8602 (setq txt (if (org-region-active-p)
8603 (buffer-substring (region-beginning) (region-end))
8604 (buffer-substring (point-at-bol) (point-at-eol))))
8605 ;; Only use search option if there is some text.
8607 (setq cpltxt
8608 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8609 desc "NONE")))
8610 (setq link (org-make-link cpltxt)))
8612 ((org-called-interactively-p 'interactive)
8613 (error "Cannot link to a buffer which is not visiting a file"))
8615 (t (setq link nil)))
8617 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8618 (setq link (or link cpltxt)
8619 desc (or desc cpltxt))
8620 (if (equal desc "NONE") (setq desc nil))
8622 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8623 (progn
8624 (setq org-stored-links
8625 (cons (list link desc) org-stored-links))
8626 (message "Stored: %s" (or desc link))
8627 (when custom-id
8628 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8629 "::#" custom-id))
8630 (setq org-stored-links
8631 (cons (list link desc) org-stored-links))))
8632 (or agenda-link (and link (org-make-link-string link desc)))))))
8634 (defun org-store-link-props (&rest plist)
8635 "Store link properties, extract names and addresses."
8636 (let (x adr)
8637 (when (setq x (plist-get plist :from))
8638 (setq adr (mail-extract-address-components x))
8639 (setq plist (plist-put plist :fromname (car adr)))
8640 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8641 (when (setq x (plist-get plist :to))
8642 (setq adr (mail-extract-address-components x))
8643 (setq plist (plist-put plist :toname (car adr)))
8644 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8645 (let ((from (plist-get plist :from))
8646 (to (plist-get plist :to)))
8647 (when (and from to org-from-is-user-regexp)
8648 (setq plist
8649 (plist-put plist :fromto
8650 (if (string-match org-from-is-user-regexp from)
8651 (concat "to %t")
8652 (concat "from %f"))))))
8653 (setq org-store-link-plist plist))
8655 (defun org-add-link-props (&rest plist)
8656 "Add these properties to the link property list."
8657 (let (key value)
8658 (while plist
8659 (setq key (pop plist) value (pop plist))
8660 (setq org-store-link-plist
8661 (plist-put org-store-link-plist key value)))))
8663 (defun org-email-link-description (&optional fmt)
8664 "Return the description part of an email link.
8665 This takes information from `org-store-link-plist' and formats it
8666 according to FMT (default from `org-email-link-description-format')."
8667 (setq fmt (or fmt org-email-link-description-format))
8668 (let* ((p org-store-link-plist)
8669 (to (plist-get p :toaddress))
8670 (from (plist-get p :fromaddress))
8671 (table
8672 (list
8673 (cons "%c" (plist-get p :fromto))
8674 (cons "%F" (plist-get p :from))
8675 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8676 (cons "%T" (plist-get p :to))
8677 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8678 (cons "%s" (plist-get p :subject))
8679 (cons "%d" (plist-get p :date))
8680 (cons "%m" (plist-get p :message-id)))))
8681 (when (string-match "%c" fmt)
8682 ;; Check if the user wrote this message
8683 (if (and org-from-is-user-regexp from to
8684 (save-match-data (string-match org-from-is-user-regexp from)))
8685 (setq fmt (replace-match "to %t" t t fmt))
8686 (setq fmt (replace-match "from %f" t t fmt))))
8687 (org-replace-escapes fmt table)))
8689 (defun org-make-org-heading-search-string (&optional string heading)
8690 "Make search string for STRING or current headline."
8691 (interactive)
8692 (let ((s (or string (org-get-heading)))
8693 (lines org-context-in-file-links))
8694 (unless (and string (not heading))
8695 ;; We are using a headline, clean up garbage in there.
8696 (if (string-match org-todo-regexp s)
8697 (setq s (replace-match "" t t s)))
8699 (setq s (replace-match "" t t s)))
8700 (setq s (org-trim s))
8703 (setq s (replace-match "" t t s)))
8704 (while (string-match org-ts-regexp s)
8705 (setq s (replace-match "" t t s))))
8706 (or string (setq s (concat "*" s))) ; Add * for headlines
8707 (when (and string (integerp lines) (> lines 0))
8709 (when (< lines (length slines))
8710 (setq s (mapconcat
8711 'identity
8712 (reverse (nthcdr (- (length slines) lines)
8716 (defun org-make-link (&rest strings)
8717 "Concatenate STRINGS."
8718 (apply 'concat strings))
8720 (defun org-make-link-string (link &optional description)
8721 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8723 (error "Empty link"))
8724 (when (and description
8725 (stringp description)
8727 (setq description nil))
8728 (when (stringp description)
8729 ;; Remove brackets from the description, they are fatal.
8731 (setq description (replace-match "{" t t description)))
8733 (setq description (replace-match "}" t t description))))
8734 (when (equal link description)
8735 ;; No description needed, it is identical
8736 (setq description nil))
8737 (when (and (not description)
8738 (not (string-match (org-image-file-name-regexp) link))
8739 (not (equal link (org-link-escape link))))
8740 (setq description (org-extract-attributes link)))
8741 (setq link
8742 (cond ((string-match (org-image-file-name-regexp) link) link)
8743 ((string-match org-link-types-re link)
8744 (concat (match-string 1 link)
8745 (org-link-escape (substring link (match-end 1)))))
8746 (t (org-link-escape link))))
8747 (concat "[[" link "]"
8748 (if description (concat "[" description "]") "")
8749 "]"))
8751 (defconst org-link-escape-chars
8752 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8753 "List of characters that should be escaped in link.
8754 This is the list that is used for internal purposes.")
8756 (defvar org-url-encoding-use-url-hexify nil)
8758 (defconst org-link-escape-chars-browser
8759 '(?\ )
8760 "List of escapes for characters that are problematic in links.
8761 This is the list that is used before handing over to the browser.")
8763 (defun org-link-escape (text &optional table merge)
8764 "Return percent escaped representation of TEXT.
8765 TEXT is a string with the text to escape.
8766 Optional argument TABLE is a list with characters that should be
8767 escaped. When nil, `org-link-escape-chars' is used.
8768 If optional argument MERGE is set, merge TABLE into
8769 `org-link-escape-chars'."
8770 (if (and org-url-encoding-use-url-hexify (not table))
8771 (url-hexify-string text)
8772 (cond
8773 ((and table merge)
8774 (mapc (lambda (defchr)
8775 (unless (member defchr table)
8776 (setq table (cons defchr table)))) org-link-escape-chars))
8777 ((null table)
8778 (setq table org-link-escape-chars)))
8779 (mapconcat
8780 (lambda (char)
8781 (if (or (member char table)
8782 (< char 32) (= char 37) (> char 126))
8783 (mapconcat (lambda (sequence-element)
8784 (format "%%%.2X" sequence-element))
8785 (or (encode-coding-char char 'utf-8)
8786 (error "Unable to percent escape character: %s"
8787 (char-to-string char))) "")
8788 (char-to-string char))) text "")))
8790 (defun org-link-unescape (str)
8791 "Unhex hexified unicode strings as returned from the JavaScript function
8792 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8793 (unless (and (null str) (string= "" str))
8794 (let ((pos 0) (case-fold-search t) unhexed)
8796 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8797 (setq str (replace-match unhexed t t str))
8798 (setq pos (+ pos (length unhexed))))))
8799 str)
8801 (defun org-link-unescape-compound (hex)
8802 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8803 Note: this function also decodes single byte encodings like
8805 (save-match-data
8806 (let* ((bytes (cdr (split-string hex "%")))
8807 (ret "")
8808 (eat 0)
8809 (sum 0))
8810 (while bytes
8811 (let* ((val (string-to-number (pop bytes) 16))
8812 (shift-xor
8813 (if (= 0 eat)
8814 (cond
8815 ((>= val 252) (cons 6 252))
8816 ((>= val 248) (cons 5 248))
8817 ((>= val 240) (cons 4 240))
8818 ((>= val 224) (cons 3 224))
8819 ((>= val 192) (cons 2 192))
8820 (t (cons 0 0)))
8821 (cons 6 128))))
8822 (if (>= val 192) (setq eat (car shift-xor)))
8823 (setq val (logxor val (cdr shift-xor)))
8824 (setq sum (+ (lsh sum (car shift-xor)) val))
8825 (if (> eat 0) (setq eat (- eat 1)))
8826 (cond
8827 ((= 0 eat) ;multi byte
8828 (setq ret (concat ret (org-char-to-string sum)))
8829 (setq sum 0))
8830 ((not bytes) ; single byte(s)
8831 (setq ret (org-link-unescape-single-byte-sequence hex))))
8832 )) ;; end (while bytes
8833 ret )))
8835 (defun org-link-unescape-single-byte-sequence (hex)
8836 "Unhexify hex-encoded single byte character sequences."
8837 (mapconcat (lambda (byte)
8838 (char-to-string (string-to-number byte 16)))
8839 (cdr (split-string hex "%")) ""))
8841 (defun org-xor (a b)
8842 "Exclusive or."
8843 (if a (not b) b))
8845 (defun org-fixup-message-id-for-http (s)
8846 "Replace special characters in a message id, so it can be used in an http query."
8847 (when (string-match "%" s)
8848 (setq s (mapconcat (lambda (c)
8849 (if (eq c ?%)
8850 "%25"
8851 (char-to-string c)))
8852 s "")))
8853 (while (string-match "<" s)
8854 (setq s (replace-match "%3C" t t s)))
8855 (while (string-match ">" s)
8856 (setq s (replace-match "%3E" t t s)))
8857 (while (string-match "@" s)
8858 (setq s (replace-match "%40" t t s)))
8859 s)
8861 ;;;###autoload
8862 (defun org-insert-link-global ()
8863 "Insert a link like Org-mode does.
8864 This command can be called in any mode to insert a link in Org-mode syntax."
8865 (interactive)
8866 (org-load-modules-maybe)
8867 (org-run-like-in-org-mode 'org-insert-link))
8869 (defun org-insert-link (&optional complete-file link-location)
8870 "Insert a link. At the prompt, enter the link.
8872 Completion can be used to insert any of the link protocol prefixes like
8873 http or ftp in use.
8875 The history can be used to select a link previously stored with
8876 `org-store-link'. When the empty string is entered (i.e. if you just
8877 press RET at the prompt), the link defaults to the most recently
8878 stored link. As SPC triggers completion in the minibuffer, you need to
8879 use M-SPC or C-q SPC to force the insertion of a space character.
8881 You will also be prompted for a description, and if one is given, it will
8882 be displayed in the buffer instead of the link.
8884 If there is already a link at point, this command will allow you to edit link
8885 and description parts.
8888 be selected using completion. The path to the file will be relative to the
8889 current directory if the file is in the current directory or a subdirectory.
8890 Otherwise, the link will be the absolute path as completed in the minibuffer
8891 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8892 option `org-link-file-path-type'.
8895 the current directory or below.
8898 `org-keep-stored-link-after-insertion'.
8900 If `org-make-link-description-function' is non-nil, this function will be
8901 called with the link target, and the result will be the default
8902 link description.
8904 If the LINK-LOCATION parameter is non-nil, this value will be
8905 used as the link location instead of reading one interactively."
8906 (interactive "P")
8907 (let* ((wcf (current-window-configuration))
8908 (region (if (org-region-active-p)
8909 (buffer-substring (region-beginning) (region-end))))
8910 (remove (and region (list (region-beginning) (region-end))))
8911 (desc region)
8912 tmphist ; byte-compile incorrectly complains about this
8913 (link link-location)
8914 entry file all-prefixes)
8915 (cond
8916 (link-location) ; specified by arg, just use it.
8917 ((org-in-regexp org-bracket-link-regexp 1)
8918 ;; We do have a link at point, and we are going to edit it.
8919 (setq remove (list (match-beginning 0) (match-end 0)))
8920 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8921 (setq link (read-string "Link: "
8922 (org-link-unescape
8923 (org-match-string-no-properties 1)))))
8924 ((or (org-in-regexp org-angle-link-re)
8925 (org-in-regexp org-plain-link-re))
8926 ;; Convert to bracket link
8927 (setq remove (list (match-beginning 0) (match-end 0))
8928 link (read-string "Link: "
8929 (org-remove-angle-brackets (match-string 0)))))
8930 ((member complete-file '((4) (16)))
8931 ;; Completing read for file names.
8932 (setq link (org-file-complete-link complete-file)))
8933 (t
8934 ;; Read link, with completion for stored links.
8935 (with-output-to-temp-buffer "*Org Links*"
8936 (princ "Insert a link.
8938 (when org-stored-links
8940 (princ (mapconcat
8941 (lambda (x)
8942 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8944 (let ((cw (selected-window)))
8945 (select-window (get-buffer-window "*Org Links*" 'visible))
8946 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8947 (unless (pos-visible-in-window-p (point-max))
8948 (org-fit-window-to-buffer))
8949 (and (window-live-p cw) (select-window cw)))
8950 ;; Fake a link history, containing the stored links.
8951 (setq tmphist (append (mapcar 'car org-stored-links)
8952 org-insert-link-history))
8953 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8954 (mapcar 'car org-link-abbrev-alist)
8955 org-link-types))
8956 (unwind-protect
8957 (progn
8958 (setq link
8959 (let ((org-completion-use-ido nil)
8960 (org-completion-use-iswitchb nil))
8961 (org-completing-read
8962 "Link: "
8963 (append
8964 (mapcar (lambda (x) (list (concat x ":")))
8965 all-prefixes)
8966 (mapcar 'car org-stored-links))
8967 nil nil nil
8968 'tmphist
8969 (car (car org-stored-links)))))
8971 (error "No link selected"))
8972 (if (or (member link all-prefixes)
8973 (and (equal ":" (substring link -1))
8974 (member (substring link 0 -1) all-prefixes)
8975 (setq link (substring link 0 -1))))
8976 (setq link (org-link-try-special-completion link))))
8977 (set-window-configuration wcf)
8978 (kill-buffer "*Org Links*"))
8979 (setq entry (assoc link org-stored-links))
8980 (or entry (push link org-insert-link-history))
8981 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8982 (not org-keep-stored-link-after-insertion))
8983 (setq org-stored-links (delq (assoc link org-stored-links)
8984 org-stored-links)))
8985 (setq desc (or desc (nth 1 entry)))))
8987 (if (string-match org-plain-link-re link)
8988 ;; URL-like link, normalize the use of angular brackets.
8989 (setq link (org-make-link (org-remove-angle-brackets link))))
8991 ;; Check if we are linking to the current file with a search option
8992 ;; If yes, simplify the link by using only the search option.
8993 (when (and buffer-file-name
8995 (let* ((path (match-string 1 link))
8996 (case-fold-search nil)
8997 (search (match-string 2 link)))
8998 (save-match-data
8999 (if (equal (file-truename buffer-file-name) (file-truename path))
9000 ;; We are linking to this same file, with a search option
9001 (setq link search)))))
9003 ;; Check if we can/should use a relative path. If yes, simplify the link
9005 (let* ((type (match-string 1 link))
9006 (path (match-string 2 link))
9007 (origpath path)
9008 (case-fold-search nil))
9009 (cond
9010 ((or (eq org-link-file-path-type 'absolute)
9011 (equal complete-file '(16)))
9012 (setq path (abbreviate-file-name (expand-file-name path))))
9013 ((eq org-link-file-path-type 'noabbrev)
9014 (setq path (expand-file-name path)))
9015 ((eq org-link-file-path-type 'relative)
9016 (setq path (file-relative-name path)))
9017 (t
9018 (save-match-data
9019 (if (string-match (concat "^" (regexp-quote
9020 (expand-file-name
9021 (file-name-as-directory
9022 default-directory))))
9023 (expand-file-name path))
9024 ;; We are linking a file with relative path name.
9025 (setq path (substring (expand-file-name path)
9026 (match-end 0)))
9027 (setq path (abbreviate-file-name (expand-file-name path)))))))
9028 (setq link (concat type path))
9029 (if (equal desc origpath)
9030 (setq desc path))))
9032 (if org-make-link-description-function
9033 (setq desc (funcall org-make-link-description-function link desc)))
9035 (setq desc (read-string "Description: " desc))
9037 (if remove (apply 'delete-region remove))
9038 (insert (org-make-link-string link desc))))
9040 (defun org-link-try-special-completion (type)
9041 "If there is completion support for link type TYPE, offer it."
9042 (let ((fun (intern (concat "org-" type "-complete-link"))))
9043 (if (functionp fun)
9044 (funcall fun)
9045 (read-string "Link (no completion support): " (concat type ":")))))
9047 (defun org-file-complete-link (&optional arg)
9048 "Create a file link using completion."
9049 (let (file link)
9050 (setq file (read-file-name "File: "))
9051 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9052 (pwd1 (file-name-as-directory (abbreviate-file-name
9053 (expand-file-name ".")))))
9054 (cond
9055 ((equal arg '(16))
9056 (setq link (org-make-link
9057 "file:"
9058 (abbreviate-file-name (expand-file-name file)))))
9060 (setq link (org-make-link "file:" (match-string 1 file))))
9062 (expand-file-name file))
9063 (setq link (org-make-link
9064 "file:" (match-string 1 (expand-file-name file)))))
9065 (t (setq link (org-make-link "file:" file)))))
9066 link))
9068 (defun org-completing-read (&rest args)
9069 "Completing-read with SPACE being a normal character."
9070 (let ((minibuffer-local-completion-map
9071 (copy-keymap minibuffer-local-completion-map)))
9072 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9073 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9074 (apply 'org-icompleting-read args)))
9076 (defun org-completing-read-no-i (&rest args)
9077 (let (org-completion-use-ido org-completion-use-iswitchb)
9078 (apply 'org-completing-read args)))
9080 (defun org-iswitchb-completing-read (prompt choices &rest args)
9081 "Use iswitch as a completing-read replacement to choose from choices.
9082 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9083 from."
9084 (let* ((iswitchb-use-virtual-buffers nil)
9085 (iswitchb-make-buflist-hook
9086 (lambda ()
9087 (setq iswitchb-temp-buflist choices))))
9088 (iswitchb-read-buffer prompt)))
9090 (defun org-icompleting-read (&rest args)
9091 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9092 (org-without-partial-completion
9093 (if (and org-completion-use-ido
9094 (fboundp 'ido-completing-read)
9095 (boundp 'ido-mode) ido-mode
9096 (listp (second args)))
9097 (let ((ido-enter-matching-directory nil))
9098 (apply 'ido-completing-read (concat (car args))
9099 (if (consp (car (nth 1 args)))
9100 (mapcar 'car (nth 1 args))
9101 (nth 1 args))
9102 (cddr args)))
9103 (if (and org-completion-use-iswitchb
9104 (boundp 'iswitchb-mode) iswitchb-mode
9105 (listp (second args)))
9106 (apply 'org-iswitchb-completing-read (concat (car args))
9107 (if (consp (car (nth 1 args)))
9108 (mapcar 'car (nth 1 args))
9109 (nth 1 args))
9110 (cddr args))
9111 (apply 'completing-read args)))))
9113 (defun org-extract-attributes (s)
9114 "Extract the attributes cookie from a string and set as text property."
9115 (let (a attr (start 0) key value)
9116 (save-match-data
9118 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9120 (setq key (match-string 1 a) value (match-string 2 a)
9121 start (match-end 0)
9122 attr (plist-put attr (intern key) value))))
9123 (org-add-props s nil 'org-attr attr))
9124 s))
9126 (defun org-extract-attributes-from-string (tag)
9127 (let (key value attr)
9129 (setq key (match-string 1 tag) value (match-string 2 tag)
9130 tag (replace-match "" t t tag)
9131 attr (plist-put attr (intern key) value)))
9132 (cons tag attr)))
9134 (defun org-attributes-to-string (plist)
9135 "Format a property list into an HTML attribute list."
9136 (let ((s "") key value)
9137 (while plist
9138 (setq key (pop plist) value (pop plist))
9139 (and value
9141 s))
9143 ;;; Opening/following a link
9145 (defvar org-link-search-failed nil)
9147 (defvar org-open-link-functions nil
9148 "Hook for functions finding a plain text link.
9149 These functions must take a single argument, the link content.
9150 They will be called for links that look like [[link text][description]]
9154 These functions will be called *before* Org attempts to resolve the
9155 link by doing text searches in the current buffer - so if you want a
9157 handle this as a special case.
9159 When the function does handle the link, it must return a non-nil value.
9160 If it decides that it is not responsible for this link, it must return
9161 nil to indicate that that Org-mode can continue with other options
9162 like exact and fuzzy text search.")
9164 (defun org-next-link ()
9165 "Move forward to the next link.
9166 If the link is in hidden text, expose it."
9167 (interactive)
9168 (when (and org-link-search-failed (eq this-command last-command))
9169 (goto-char (point-min))
9170 (message "Link search wrapped back to beginning of buffer"))
9171 (setq org-link-search-failed nil)
9172 (let* ((pos (point))
9173 (ct (org-context))
9174 (a (assoc :link ct)))
9175 (if a (goto-char (nth 2 a)))
9176 (if (re-search-forward org-any-link-re nil t)
9177 (progn
9178 (goto-char (match-beginning 0))
9179 (if (outline-invisible-p) (org-show-context)))
9180 (goto-char pos)
9181 (setq org-link-search-failed t)
9182 (error "No further link found"))))
9184 (defun org-previous-link ()
9185 "Move backward to the previous link.
9186 If the link is in hidden text, expose it."
9187 (interactive)
9188 (when (and org-link-search-failed (eq this-command last-command))
9189 (goto-char (point-max))
9190 (message "Link search wrapped back to end of buffer"))
9191 (setq org-link-search-failed nil)
9192 (let* ((pos (point))
9193 (ct (org-context))
9194 (a (assoc :link ct)))
9195 (if a (goto-char (nth 1 a)))
9196 (if (re-search-backward org-any-link-re nil t)
9197 (progn
9198 (goto-char (match-beginning 0))
9199 (if (outline-invisible-p) (org-show-context)))
9200 (goto-char pos)
9201 (setq org-link-search-failed t)
9202 (error "No further link found"))))
9204 (defun org-translate-link (s)
9205 "Translate a link string if a translation function has been defined."
9206 (if (and org-link-translation-function
9207 (fboundp org-link-translation-function)
9209 (progn
9210 (setq s (funcall org-link-translation-function
9211 (match-string 1) (match-string 2)))
9212 (concat (car s) ":" (cdr s)))
9213 s))
9215 (defun org-translate-link-from-planner (type path)
9216 "Translate a link from Emacs Planner syntax so that Org can follow it.
9217 This is still an experimental function, your mileage may vary."
9218 (cond
9219 ((member type '("http" "https" "news" "ftp"))
9220 ;; standard Internet links are the same.
9221 nil)
9222 ((and (equal type "irc") (string-match "^//" path))
9223 ;; Planner has two / at the beginning of an irc link, we have 1.
9224 ;; We should have zero, actually....
9225 (setq path (substring path 1)))
9226 ((and (equal type "lisp") (string-match "^/" path))
9227 ;; Planner has a slash, we do not.
9228 (setq type "elisp" path (substring path 1)))
9230 ;; A typical message link. Planner has the id after the final slash,
9231 ;; we separate it with a hash mark
9232 (setq path (concat (match-string 1 path) "#"
9233 (org-remove-angle-brackets (match-string 2 path)))))
9234 )
9235 (cons type path))
9237 (defun org-find-file-at-mouse (ev)
9238 "Open file link or URL at mouse."
9239 (interactive "e")
9240 (mouse-set-point ev)
9241 (org-open-at-point 'in-emacs))
9243 (defun org-open-at-mouse (ev)
9244 "Open file link or URL at mouse."
9245 (interactive "e")
9246 (mouse-set-point ev)
9247 (if (eq major-mode 'org-agenda-mode)
9248 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9249 (org-open-at-point))
9251 (defvar org-window-config-before-follow-link nil
9252 "The window configuration before following a link.
9253 This is saved in case the need arises to restore it.")
9255 (defvar org-open-link-marker (make-marker)
9256 "Marker pointing to the location where `org-open-at-point; was called.")
9258 ;;;###autoload
9259 (defun org-open-at-point-global ()
9260 "Follow a link like Org-mode does.
9261 This command can be called in any mode to follow a link that has
9262 Org-mode syntax."
9263 (interactive)
9264 (org-run-like-in-org-mode 'org-open-at-point))
9266 ;;;###autoload
9267 (defun org-open-link-from-string (s &optional arg reference-buffer)
9268 "Open a link in the string S, as if it was in Org-mode."
9270 (let ((reference-buffer (or reference-buffer (current-buffer))))
9271 (with-temp-buffer
9272 (let ((org-inhibit-startup t))
9273 (org-mode)
9274 (insert s)
9275 (goto-char (point-min))
9276 (when reference-buffer
9277 (setq org-link-abbrev-alist-local
9278 (with-current-buffer reference-buffer
9279 org-link-abbrev-alist-local)))
9280 (org-open-at-point arg reference-buffer)))))
9282 (defvar org-open-at-point-functions nil
9283 "Hook that is run when following a link at point.
9285 Functions in this hook must return t if they identify and follow
9286 a link at point. If they don't find anything interesting at point,
9287 they must return nil.")
9289 (defun org-open-at-point (&optional arg reference-buffer)
9290 "Open link at or after point.
9291 If there is no link at point, this function will search forward up to
9292 the end of the current line.
9293 Normally, files will be opened by an appropriate application. If the
9294 optional prefix argument ARG is non-nil, Emacs will visit the file.
9295 With a double prefix argument, try to open outside of Emacs, in the
9296 application the system uses for this file type."
9297 (interactive "P")
9298 ;; if in a code block, then open the block's results
9299 (unless (call-interactively #'org-babel-open-src-block-result)
9300 (org-load-modules-maybe)
9301 (move-marker org-open-link-marker (point))
9302 (setq org-window-config-before-follow-link (current-window-configuration))
9303 (org-remove-occur-highlights nil nil t)
9304 (cond
9305 ((and (org-on-heading-p)
9306 (not (org-in-regexp
9311 (not (get-text-property (point) 'org-linked-text)))
9312 (or (org-offer-links-in-entry arg)
9313 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9314 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9315 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9316 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9317 (not (org-in-regexp org-bracket-link-regexp)))
9318 (org-footnote-action))
9319 (t
9320 (let (type path link line search (pos (point)))
9321 (catch 'match
9322 (save-excursion
9324 (when (org-in-regexp org-bracket-link-regexp 1)
9325 (setq link (org-extract-attributes
9326 (org-link-unescape (org-match-string-no-properties 1))))
9328 (setq link (replace-match " " t t link)))
9329 (setq link (org-link-expand-abbrev link))
9330 (cond
9331 ((or (file-name-absolute-p link)
9333 (setq type "file" path link))
9334 ((string-match org-link-re-with-space3 link)
9335 (setq type (match-string 1 link) path (match-string 2 link)))
9336 (t (setq type "thisfile" path link)))
9337 (throw 'match t)))
9339 (when (get-text-property (point) 'org-linked-text)
9340 (setq type "thisfile"
9341 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9342 (1+ (point)) (point))
9343 path (buffer-substring
9344 (or (previous-single-property-change pos 'org-linked-text)
9345 (point-min))
9346 (or (next-single-property-change pos 'org-linked-text)
9347 (point-max))))
9348 (throw 'match t))
9350 (save-excursion
9351 (when (or (org-in-regexp org-angle-link-re)
9352 (org-in-regexp org-plain-link-re))
9353 (setq type (match-string 1) path (match-string 2))
9354 (throw 'match t)))
9355 (save-excursion
9357 (setq type "tags"
9358 path (match-string 1))
9359 (while (string-match ":" path)
9360 (setq path (replace-match "+" t t path)))
9361 (throw 'match t)))
9363 (setq type "tree-match"
9364 path (match-string 1))
9365 (throw 'match t)))
9366 (unless path
9367 (error "No link found"))
9369 ;; switch back to reference buffer
9370 ;; needed when if called in a temporary buffer through
9371 ;; org-open-link-from-string
9372 (with-current-buffer (or reference-buffer (current-buffer))
9374 ;; Remove any trailing spaces in path
9376 (setq path (replace-match "" t t path)))
9377 (if (and org-link-translation-function
9378 (fboundp org-link-translation-function))
9379 ;; Check if we need to translate the link
9380 (let ((tmp (funcall org-link-translation-function type path)))
9381 (setq type (car tmp) path (cdr tmp))))
9383 (cond
9385 ((assoc type org-link-protocols)
9386 (funcall (nth 1 (assoc type org-link-protocols)) path))
9388 ((equal type "mailto")
9389 (let ((cmd (car org-link-mailto-program))
9390 (args (cdr org-link-mailto-program)) args1
9391 (address path) (subject "") a)
9393 (setq address (match-string 1 path)
9394 subject (org-link-escape (match-string 2 path))))
9395 (while args
9396 (cond
9397 ((not (stringp (car args))) (push (pop args) args1))
9398 (t (setq a (pop args))
9399 (if (string-match "%a" a)
9400 (setq a (replace-match address t t a)))
9401 (if (string-match "%s" a)
9402 (setq a (replace-match subject t t a)))
9403 (push a args1))))
9404 (apply cmd (nreverse args1))))
9406 ((member type '("http" "https" "ftp" "news"))
9407 (browse-url (concat type ":" (org-link-escape
9408 path org-link-escape-chars-browser))))
9410 ((string= type "doi")
9411 (browse-url (concat "http://dx.doi.org/"
9412 (org-link-escape
9413 path org-link-escape-chars-browser))))
9415 ((member type '("message"))
9416 (browse-url (concat type ":" path)))
9418 ((string= type "tags")
9419 (org-tags-view arg path))
9421 ((string= type "tree-match")
9424 ((string= type "file")
9426 (setq line (string-to-number (match-string 1 path))
9427 path (substring path 0 (match-beginning 0)))
9429 (setq search (match-string 1 path)
9430 path (substring path 0 (match-beginning 0)))))
9431 (if (string-match "[*?{]" (file-name-nondirectory path))
9432 (dired path)
9433 (org-open-file path arg line search)))
9435 ((string= type "shell")
9436 (let ((cmd path))
9437 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9438 (string-match org-confirm-shell-link-not-regexp cmd))
9439 (not org-confirm-shell-link-function)
9440 (funcall org-confirm-shell-link-function
9442 (org-add-props cmd nil
9443 'face 'org-warning))))
9444 (progn
9445 (message "Executing %s" cmd)
9446 (shell-command cmd))
9447 (error "Abort"))))
9449 ((string= type "elisp")
9450 (let ((cmd path))
9451 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9452 (string-match org-confirm-elisp-link-not-regexp cmd))
9453 (not org-confirm-elisp-link-function)
9454 (funcall org-confirm-elisp-link-function
9456 (org-add-props cmd nil
9457 'face 'org-warning))))
9458 (message "%s => %s" cmd
9459 (if (equal (string-to-char cmd) ?\()
9460 (eval (read cmd))
9461 (call-interactively (read cmd))))
9462 (error "Abort"))))
9464 ((and (string= type "thisfile")
9465 (run-hook-with-args-until-success
9466 'org-open-link-functions path)))
9468 ((string= type "thisfile")
9469 (if arg
9470 (switch-to-buffer-other-window
9471 (org-get-buffer-for-internal-link (current-buffer)))
9472 (org-mark-ring-push))
9473 (let ((cmd `(org-link-search
9474 ,path
9475 ,(cond ((equal arg '(4)) ''occur)
9476 ((equal arg '(16)) ''org-occur)
9477 (t nil))
9478 ,pos)))
9479 (condition-case nil (eval cmd)
9480 (error (progn (widen) (eval cmd))))))
9482 (t
9483 (browse-url-at-point)))))))
9484 (move-marker org-open-link-marker nil)
9485 (run-hook-with-args 'org-follow-link-hook)))
9487 (defun org-offer-links-in-entry (&optional nth zero)
9488 "Offer links in the current entry and follow the selected link.
9489 If there is only one link, follow it immediately as well.
9490 If NTH is an integer, immediately pick the NTH link found.
9491 If ZERO is a string, check also this string for a link, and if
9492 there is one, offer it as link number zero."
9496 (cnt ?0)
9497 (in-emacs (if (integerp nth) nil nth))
9498 have-zero end links link c)
9499 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9500 (push (match-string 0 zero) links)
9501 (setq cnt (1- cnt) have-zero t))
9502 (save-excursion
9503 (org-back-to-heading t)
9504 (setq end (save-excursion (outline-next-heading) (point)))
9505 (while (re-search-forward re end t)
9506 (push (match-string 0) links))
9507 (setq links (org-uniquify (reverse links))))
9509 (cond
9510 ((null links)
9511 (message "No links"))
9512 ((equal (length links) 1)
9513 (setq link (list (car links))))
9514 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9515 (setq link (nth (if have-zero nth (1- nth)) links)))
9516 (t ; we have to select a link
9517 (save-excursion
9518 (save-window-excursion
9519 (delete-other-windows)
9520 (with-output-to-temp-buffer "*Select Link*"
9521 (mapc (lambda (l)
9522 (if (not (string-match org-bracket-link-regexp l))
9524 (org-remove-angle-brackets l)))
9525 (if (match-end 3)
9527 (match-string 3 l) (match-string 1 l)))
9529 (match-string 1 l))))))
9530 links))
9531 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9532 (message "Select link to open, RET to open all:")
9533 (setq c (read-char-exclusive))
9534 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9535 (when (equal c ?q) (error "Abort"))
9536 (if (equal c ?\C-m)
9537 (setq link links)
9538 (setq nth (- c ?0))
9539 (if have-zero (setq nth (1+ nth)))
9540 (unless (and (integerp nth) (>= (length links) nth))
9541 (error "Invalid link selection"))
9542 (setq link (list (nth (1- nth) links))))))
9543 (if link
9544 (let ((buf (current-buffer)))
9545 (dolist (l link)
9546 (org-open-link-from-string l in-emacs buf))
9547 t)
9548 nil)))
9550 ;; Add special file links that specify the way of opening
9552 (org-add-link-type "file+sys" 'org-open-file-with-system)
9553 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9554 (defun org-open-file-with-system (path)
9555 "Open file at PATH using the system way of opening it."
9556 (org-open-file path 'system))
9557 (defun org-open-file-with-emacs (path)
9558 "Open file at PATH in Emacs."
9559 (org-open-file path 'emacs))
9560 (defun org-remove-file-link-modifiers ()
9561 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9562 (goto-char (point-min))
9564 (org-if-unprotected
9565 (replace-match "file:" t t))))
9566 (eval-after-load "org-exp"
9567 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9568 'org-remove-file-link-modifiers))
9570 ;;;; Time estimates
9572 (defun org-get-effort (&optional pom)
9573 "Get the effort estimate for the current entry."
9574 (org-entry-get pom org-effort-property))
9576 ;;; File search
9578 (defvar org-create-file-search-functions nil
9579 "List of functions to construct the right search string for a file link.
9580 These functions are called in turn with point at the location to
9581 which the link should point.
9583 A function in the hook should first test if it would like to
9584 handle this file type, for example by checking the `major-mode'
9585 or the file extension. If it decides not to handle this file, it
9586 should just return nil to give other functions a chance. If it
9587 does handle the file, it must return the search string to be used
9588 when following the link. The search string will be part of the
9589 file link, given after a double colon, and `org-open-at-point'
9590 will automatically search for it. If special measures must be
9591 taken to make the search successful, another function should be
9592 added to the companion hook `org-execute-file-search-functions',
9593 which see.
9595 A function in this hook may also use `setq' to set the variable
9596 `description' to provide a suggestion for the descriptive text to
9597 be used for this link when it gets inserted into an Org-mode
9600 (defvar org-execute-file-search-functions nil
9601 "List of functions to execute a file search triggered by a link.
9603 Functions added to this hook must accept a single argument, the
9604 search string that was part of the file link, the part after the
9605 double colon. The function must first check if it would like to
9606 handle this search, for example by checking the `major-mode' or
9607 the file extension. If it decides not to handle this search, it
9608 should just return nil to give other functions a chance. If it
9609 does handle the search, it must return a non-nil value to keep
9610 other functions from trying.
9612 Each function can access the current prefix argument through the
9613 variable `current-prefix-argument'. Note that a single prefix is
9614 used to force opening a link in Emacs, so it may be good to only
9615 use a numeric or double prefix to guide the search function.
9617 In case this is needed, a function in this hook can also restore
9618 the window configuration before `org-open-at-point' was called using:
9620 (set-window-configuration org-window-config-before-follow-link)")
9622 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9623 (defun org-link-search (s &optional type avoid-pos)
9624 "Search for a link search option.
9625 If S is surrounded by forward slashes, it is interpreted as a
9626 regular expression. In org-mode files, this will create an `org-occur'
9627 sparse tree. In ordinary files, `occur' will be used to list matches.
9628 If the current buffer is in `dired-mode', grep will be used to search
9629 in all files. If AVOID-POS is given, ignore matches near that position."
9630 (let ((case-fold-search t)
9634 org-emphasis-alist)
9636 (pos (point))
9637 (pre nil) (post nil)
9638 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9639 (cond
9640 ;; First check if there are any special search functions
9641 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9642 ;; Now try the builtin stuff
9643 ((and (equal (string-to-char s0) ?#)
9644 (> (length s0) 1)
9645 (save-excursion
9646 (goto-char (point-min))
9647 (and
9648 (re-search-forward
9650 (setq type 'dedicated
9651 pos (match-beginning 0))))
9652 ;; There is an exact target for this
9653 (goto-char pos)
9654 (org-back-to-heading t)))
9655 ((save-excursion
9656 (goto-char (point-min))
9657 (and
9658 (re-search-forward
9659 (concat "<<" (regexp-quote s0) ">>") nil t)
9660 (setq type 'dedicated
9661 pos (match-beginning 0))))
9662 ;; There is an exact target for this
9663 (goto-char pos))
9665 (save-excursion
9666 (goto-char (point-min))
9667 (and
9668 (re-search-forward
9669 (concat "[^[]" (regexp-quote
9670 (format org-coderef-label-format
9671 (match-string 1 s0))))
9672 nil t)
9673 (setq type 'dedicated
9674 pos (1+ (match-beginning 0))))))
9675 ;; There is a coderef target for this
9676 (goto-char pos))
9678 ;; A regular expression
9679 (cond
9680 ((org-mode-p)
9681 (org-occur (match-string 1 s)))
9682 ;;((eq major-mode 'dired-mode)
9683 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9684 (t (org-do-occur (match-string 1 s)))))
9685 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9686 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9687 (goto-char (point-min))
9688 (cond
9689 ((let (case-fold-search)
9690 (re-search-forward (format org-complex-heading-regexp-format
9691 (regexp-quote s))
9692 nil t))
9693 ;; OK, found a match
9694 (setq type 'dedicated)
9695 (goto-char (match-beginning 0)))
9696 ((and (not org-link-search-inhibit-query)
9697 (eq org-link-search-must-match-exact-headline 'query-to-create)
9698 (y-or-n-p "No match - create this as a new heading? "))
9699 (goto-char (point-max))
9700 (or (bolp) (newline))
9702 (beginning-of-line 0))
9703 (t
9704 (goto-char pos)
9705 (error "No match"))))
9706 (t
9707 ;; A normal search string
9708 (when (equal (string-to-char s) ?*)
9709 ;; Anchor on headlines, post may include tags.
9712 s (substring s 1)))
9713 (remove-text-properties
9714 0 (length s)
9715 '(face nil mouse-face nil keymap nil fontified nil) s)
9716 ;; Make a series of regular expressions to find a match
9725 re4 (concat "[^a-zA-Z_]" re4_)
9727 re1 (concat pre re2 post)
9728 re3 (concat pre (if pre re4_ re4) post)
9729 re5 (concat pre ".*" re4)
9730 re2 (concat pre re2)
9731 re2a (concat pre (if pre re2a_ re2a))
9732 re4 (concat pre (if pre re4_ re4))
9736 ))
9737 (cond
9738 ((eq type 'org-occur) (org-occur reall))
9739 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9740 (t (goto-char (point-min))
9741 (setq type 'fuzzy)
9742 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9743 (org-search-not-self 1 re1 nil t)
9744 (org-search-not-self 1 re2 nil t)
9745 (org-search-not-self 1 re2a nil t)
9746 (org-search-not-self 1 re3 nil t)
9747 (org-search-not-self 1 re4 nil t)
9748 (org-search-not-self 1 re5 nil t)
9749 )
9750 (goto-char (match-beginning 1))
9751 (goto-char pos)
9752 (error "No match"))))))
9753 (and (org-mode-p) (org-show-context 'link-search))
9754 type))
9756 (defun org-search-not-self (group &rest args)
9757 "Execute `re-search-forward', but only accept matches that do not
9758 enclose the position of `org-open-link-marker'."
9759 (let ((m org-open-link-marker))
9760 (catch 'exit
9761 (while (apply 're-search-forward args)
9762 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9763 (goto-char (match-end group))
9764 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9765 (> (match-beginning 0) (marker-position m))
9766 (< (match-end 0) (marker-position m)))
9767 (save-match-data
9768 (or (not (org-in-regexp
9769 org-bracket-link-analytic-regexp 1))
9770 (not (match-end 4)) ; no description
9771 (and (<= (match-beginning 4) (point))
9772 (>= (match-end 4) (point))))))
9773 (throw 'exit (point))))))))
9775 (defun org-get-buffer-for-internal-link (buffer)
9776 "Return a buffer to be used for displaying the link target of internal links."
9777 (cond
9778 ((not org-display-internal-link-with-indirect-buffer)
9779 buffer)
9780 ((string-match "(Clone)$" (buffer-name buffer))
9781 (message "Buffer is already a clone, not making another one")
9782 ;; we also do not modify visibility in this case
9783 buffer)
9784 (t ; make a new indirect buffer for displaying the link
9785 (let* ((bn (buffer-name buffer))
9786 (ibn (concat bn "(Clone)"))
9787 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9788 (with-current-buffer ib (org-overview))
9789 ib))))
9791 (defun org-do-occur (regexp &optional cleanup)
9792 "Call the Emacs command `occur'.
9793 If CLEANUP is non-nil, remove the printout of the regular expression
9794 in the *Occur* buffer. This is useful if the regex is long and not useful
9795 to read."
9796 (occur regexp)
9797 (when cleanup
9798 (let ((cwin (selected-window)) win beg end)
9799 (when (setq win (get-buffer-window "*Occur*"))
9800 (select-window win))
9801 (goto-char (point-min))
9802 (when (re-search-forward "match[a-z]+" nil t)
9803 (setq beg (match-end 0))
9805 (setq end (1- (match-beginning 0)))))
9806 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9807 (goto-char (point-min))
9808 (select-window cwin))))
9810 ;;; The mark ring for links jumps
9812 (defvar org-mark-ring nil
9813 "Mark ring for positions before jumps in Org-mode.")
9814 (defvar org-mark-ring-last-goto nil
9815 "Last position in the mark ring used to go back.")
9816 ;; Fill and close the ring
9817 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9818 (loop for i from 1 to org-mark-ring-length do
9819 (push (make-marker) org-mark-ring))
9820 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9821 org-mark-ring)
9823 (defun org-mark-ring-push (&optional pos buffer)
9824 "Put the current position or POS into the mark ring and rotate it."
9825 (interactive)
9826 (setq pos (or pos (point)))
9827 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9828 (move-marker (car org-mark-ring)
9829 (or pos (point))
9830 (or buffer (current-buffer)))
9831 (message "%s"
9832 (substitute-command-keys
9835 (defun org-mark-ring-goto (&optional n)
9836 "Jump to the previous position in the mark ring.
9837 With prefix arg N, jump back that many stored positions. When
9838 called several times in succession, walk through the entire ring.
9839 Org-mode commands jumping to a different position in the current file,
9840 or to another Org-mode file, automatically push the old position
9841 onto the ring."
9842 (interactive "p")
9843 (let (p m)
9844 (if (eq last-command this-command)
9845 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9846 (setq p org-mark-ring))
9847 (setq org-mark-ring-last-goto p)
9848 (setq m (car p))
9849 (org-pop-to-buffer-same-window (marker-buffer m))
9850 (goto-char m)
9851 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9853 (defun org-remove-angle-brackets (s)
9854 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9855 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9856 s)
9857 (defun org-add-angle-brackets (s)
9858 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9859 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9860 s)
9861 (defun org-remove-double-quotes (s)
9864 s)
9866 ;;; Following specific links
9868 (defun org-follow-timestamp-link ()
9869 (cond
9870 ((org-at-date-range-p t)
9871 (let ((org-agenda-start-on-weekday)
9872 (t1 (match-string 1))
9873 (t2 (match-string 2)))
9874 (setq t1 (time-to-days (org-time-string-to-time t1))
9875 t2 (time-to-days (org-time-string-to-time t2)))
9876 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9877 ((org-at-timestamp-p t)
9878 (org-agenda-list nil (time-to-days (org-time-string-to-time
9879 (substring (match-string 1) 0 10)))
9880 1))
9881 (t (error "This should not happen"))))
9884 ;;; Following file links
9885 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9886 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9887 (declare-function mailcap-mime-info
9888 "mailcap" (string &optional request no-decode))
9889 (defvar org-wait nil)
9890 (defun org-open-file (path &optional in-emacs line search)
9891 "Open the file at PATH.
9892 First, this expands any special file name abbreviations. Then the
9893 configuration variable `org-file-apps' is checked if it contains an
9894 entry for this file type, and if yes, the corresponding command is launched.
9896 If no application is found, Emacs simply visits the file.
9898 With optional prefix argument IN-EMACS, Emacs will visit the file.
9900 prefix arg, Org tries to avoid opening in Emacs
9901 and to use an external application to visit the file.
9903 Optional LINE specifies a line to go to, optional SEARCH a string
9904 to search for. If LINE or SEARCH is given, the file will be
9905 opened in Emacs, unless an entry from org-file-apps that makes
9906 use of groups in a regexp matches.
9907 If the file does not exist, an error is thrown."
9908 (let* ((file (if (equal path "")
9909 buffer-file-name
9910 (substitute-in-file-name (expand-file-name path))))
9911 (file-apps (append org-file-apps (org-default-apps)))
9912 (apps (org-remove-if
9913 'org-file-apps-entry-match-against-dlink-p file-apps))
9914 (apps-dlink (org-remove-if-not
9915 'org-file-apps-entry-match-against-dlink-p file-apps))
9916 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9917 (dirp (if remp nil (file-directory-p file)))
9918 (file (if (and dirp org-open-directory-means-index-dot-org)
9919 (concat (file-name-as-directory file) "index.org")
9920 file))
9921 (a-m-a-p (assq 'auto-mode apps))
9922 (dfile (downcase file))
9923 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9924 (link (cond ((and (eq line nil)
9925 (eq search nil))
9926 file)
9927 (line
9928 (concat file "::" (number-to-string line)))
9929 (search
9930 (concat file "::" search))))
9931 (dlink (downcase link))
9932 (old-buffer (current-buffer))
9933 (old-pos (point))
9934 (old-mode major-mode)
9935 ext cmd link-match-data)
9937 (setq ext (match-string 1 dfile))
9939 (setq ext (match-string 1 dfile))))
9940 (cond
9941 ((member in-emacs '((16) system))
9942 (setq cmd (cdr (assoc 'system apps))))
9943 (in-emacs (setq cmd 'emacs))
9944 (t
9945 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9946 (and dirp (cdr (assoc 'directory apps)))
9947 ; first, try matching against apps-dlink
9948 ; if we get a match here, store the match data for later
9949 (let ((match (assoc-default dlink apps-dlink
9950 'string-match)))
9951 (if match
9952 (progn (setq link-match-data (match-data))
9953 match)
9954 (progn (setq in-emacs (or in-emacs line search))
9955 nil))) ; if we have no match in apps-dlink,
9956 ; always open the file in emacs if line or search
9957 ; is given (for backwards compatibility)
9958 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9959 'string-match)
9960 (cdr (assoc ext apps))
9961 (cdr (assoc t apps))))))
9962 (when (eq cmd 'system)
9963 (setq cmd (cdr (assoc 'system apps))))
9964 (when (eq cmd 'default)
9965 (setq cmd (cdr (assoc t apps))))
9966 (when (eq cmd 'mailcap)
9967 (require 'mailcap)
9968 (mailcap-parse-mailcaps)
9969 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9970 (command (mailcap-mime-info mime-type)))
9971 (if (stringp command)
9972 (setq cmd command)
9973 (setq cmd 'emacs))))
9974 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9975 (not (file-exists-p file))
9976 (not org-open-non-existing-files))
9977 (error "No such file: %s" file))
9978 (cond
9980 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9982 (setq cmd (replace-match "%s" t t cmd)))
9983 (while (string-match "%s" cmd)
9984 (setq cmd (replace-match
9985 (save-match-data
9986 (shell-quote-argument
9987 (convert-standard-filename file)))
9988 t t cmd)))
9990 ;; Replace "%1", "%2" etc. in command with group matches from regex
9991 (save-match-data
9992 (let ((match-index 1)
9993 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9994 (set-match-data link-match-data)
9995 (while (<= match-index number-of-groups)
9996 (let ((regex (concat "%" (number-to-string match-index)))
9997 (replace-with (match-string match-index dlink)))
9998 (while (string-match regex cmd)
9999 (setq cmd (replace-match replace-with t t cmd))))
10000 (setq match-index (+ match-index 1)))))
10002 (save-window-excursion
10003 (start-process-shell-command cmd nil cmd)
10004 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10005 ))
10006 ((or (stringp cmd)
10007 (eq cmd 'emacs))
10008 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10009 (widen)
10010 (if line (org-goto-line line)
10011 (if search (org-link-search search))))
10012 ((consp cmd)
10013 (let ((file (convert-standard-filename file)))
10014 (save-match-data
10015 (set-match-data link-match-data)
10016 (eval cmd))))
10017 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10018 (and (org-mode-p) (eq old-mode 'org-mode)
10019 (or (not (equal old-buffer (current-buffer)))
10020 (not (equal old-pos (point))))
10021 (org-mark-ring-push old-pos old-buffer))))
10023 (defun org-file-apps-entry-match-against-dlink-p (entry)
10024 "This function returns non-nil if `entry' uses a regular
10025 expression which should be matched against the whole link by
10026 org-open-file.
10028 It assumes that is the case when the entry uses a regular
10029 expression which has at least one grouping construct and the
10030 action is either a lisp form or a command string containing
10031 '%1', i.e. using at least one subexpression match as a
10032 parameter."
10033 (let ((selector (car entry))
10034 (action (cdr entry)))
10035 (if (stringp selector)
10036 (and (> (regexp-opt-depth selector) 0)
10037 (or (and (stringp action)
10038 (string-match "%[0-9]" action))
10039 (consp action)))
10040 nil)))
10042 (defun org-default-apps ()
10043 "Return the default applications for this operating system."
10044 (cond
10045 ((eq system-type 'darwin)
10046 org-file-apps-defaults-macosx)
10047 ((eq system-type 'windows-nt)
10048 org-file-apps-defaults-windowsnt)
10049 (t org-file-apps-defaults-gnu)))
10051 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10052 "Convert extensions to regular expressions in the cars of LIST.
10053 Also, weed out any non-string entries, because the return value is used
10054 only for regexp matching.
10055 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10056 point to the symbol `emacs', indicating that the file should
10057 be opened in Emacs."
10058 (append
10059 (delq nil
10060 (mapcar (lambda (x)
10061 (if (not (stringp (car x)))
10062 nil
10064 x
10066 list))
10067 (if add-auto-mode
10068 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10070 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10071 (defun org-file-remote-p (file)
10072 "Test whether FILE specifies a location on a remote system.
10073 Return non-nil if the location is indeed remote.
10077 (cond ((fboundp 'file-remote-p)
10078 (file-remote-p file))
10079 ((fboundp 'tramp-handle-file-remote-p)
10080 (tramp-handle-file-remote-p file))
10081 ((and (boundp 'ange-ftp-name-format)
10082 (string-match (car ange-ftp-name-format) file))
10083 t)
10084 (t nil)))
10087 ;;;; Refiling
10089 (defun org-get-org-file ()
10090 "Read a filename, with default directory `org-directory'."
10091 (let ((default (or org-default-notes-file remember-data-file)))
10092 (read-file-name (format "File name [%s]: " default)
10093 (file-name-as-directory org-directory)
10094 default)))
10096 (defun org-notes-order-reversed-p ()
10097 "Check if the current file should receive notes in reversed order."
10098 (cond
10099 ((not org-reverse-note-order) nil)
10100 ((eq t org-reverse-note-order) t)
10101 ((not (listp org-reverse-note-order)) nil)
10102 (t (catch 'exit
10103 (let ((all org-reverse-note-order)
10104 entry)
10105 (while (setq entry (pop all))
10106 (if (string-match (car entry) buffer-file-name)
10107 (throw 'exit (cdr entry))))
10108 nil)))))
10110 (defvar org-refile-target-table nil
10111 "The list of refile targets, created by `org-refile'.")
10113 (defvar org-agenda-new-buffers nil
10114 "Buffers created to visit agenda files.")
10116 (defvar org-refile-cache nil
10117 "Cache for refile targets.")
10119 (defvar org-refile-markers nil
10120 "All the markers used for caching refile locations.")
10122 (defun org-refile-marker (pos)
10123 "Get a new refile marker, but only if caching is in use."
10124 (if (not org-refile-use-cache)
10125 pos
10126 (let ((m (make-marker)))
10127 (move-marker m pos)
10128 (push m org-refile-markers)
10129 m)))
10131 (defun org-refile-cache-clear ()
10132 "Clear the refile cache and disable all the markers."
10133 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10134 (setq org-refile-markers nil)
10135 (setq org-refile-cache nil)
10136 (message "Refile cache has been cleared"))
10138 (defun org-refile-cache-check-set (set)
10139 "Check if all the markers in the cache still have live buffers."
10140 (let (marker)
10141 (catch 'exit
10142 (while (and set (setq marker (nth 3 (pop set))))
10143 ;; if org-refile-use-outline-path is 'file, marker may be nil
10144 (when (and marker (null (marker-buffer marker)))
10145 (message "not found") (sit-for 3)
10146 (throw 'exit nil)))
10147 t)))
10149 (defun org-refile-cache-put (set &rest identifiers)
10150 "Push the refile targets SET into the cache, under IDENTIFIERS."
10151 (let* ((key (sha1 (prin1-to-string identifiers)))
10152 (entry (assoc key org-refile-cache)))
10153 (if entry
10154 (setcdr entry set)
10155 (push (cons key set) org-refile-cache))))
10157 (defun org-refile-cache-get (&rest identifiers)
10158 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10159 (cond
10160 ((not org-refile-cache) nil)
10161 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10162 (t
10163 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10164 org-refile-cache))))
10165 (and set (org-refile-cache-check-set set) set)))))
10167 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10168 "Produce a table with refile targets."
10169 (let ((case-fold-search nil)
10170 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10171 (entries (or org-refile-targets '((nil . (:level . 1)))))
10172 targets tgs txt re files f desc descre fast-path-p level pos0)
10173 (message "Getting targets...")
10174 (with-current-buffer (or default-buffer (current-buffer))
10175 (while (setq entry (pop entries))
10176 (setq files (car entry) desc (cdr entry))
10177 (setq fast-path-p nil)
10178 (cond
10179 ((null files) (setq files (list (current-buffer))))
10180 ((eq files 'org-agenda-files)
10181 (setq files (org-agenda-files 'unrestricted)))
10182 ((and (symbolp files) (fboundp files))
10183 (setq files (funcall files)))
10184 ((and (symbolp files) (boundp files))
10185 (setq files (symbol-value files))))
10186 (if (stringp files) (setq files (list files)))
10187 (cond
10188 ((eq (car desc) :tag)
10190 ((eq (car desc) :todo)
10192 ((eq (car desc) :regexp)
10193 (setq descre (cdr desc)))
10194 ((eq (car desc) :level)
10196 (if org-odd-levels-only
10197 (1- (* 2 (cdr desc)))
10198 (cdr desc)))
10200 ((eq (car desc) :maxlevel)
10201 (setq fast-path-p t)
10203 (if org-odd-levels-only
10204 (1- (* 2 (cdr desc)))
10205 (cdr desc)))
10207 (t (error "Bad refiling target description %s" desc)))
10208 (while (setq f (pop files))
10209 (with-current-buffer
10210 (if (bufferp f) f (org-get-agenda-file-buffer f))
10211 (or
10212 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10213 (progn
10214 (if (bufferp f) (setq f (buffer-file-name
10215 (buffer-base-buffer f))))
10216 (setq f (and f (expand-file-name f)))
10217 (if (eq org-refile-use-outline-path 'file)
10218 (push (list (file-name-nondirectory f) f nil nil) tgs))
10219 (save-excursion
10220 (save-restriction
10221 (widen)
10222 (goto-char (point-min))
10223 (while (re-search-forward descre nil t)
10224 (goto-char (setq pos0 (point-at-bol)))
10225 (catch 'next
10226 (when org-refile-target-verify-function
10227 (save-match-data
10228 (or (funcall org-refile-target-verify-function)
10229 (throw 'next t))))
10230 (when (and (looking-at org-complex-heading-regexp)
10231 (not (member (match-string 4) excluded-entries)))
10232 (setq level (org-reduced-level
10233 (- (match-end 1) (match-beginning 1)))
10234 txt (org-link-display-format (match-string 4))
10236 re (format org-complex-heading-regexp-format
10237 (regexp-quote (match-string 4))))
10238 (when org-refile-use-outline-path
10239 (setq txt (mapconcat
10240 'org-protect-slash
10241 (append
10242 (if (eq org-refile-use-outline-path
10243 'file)
10244 (list (file-name-nondirectory
10245 (buffer-file-name
10246 (buffer-base-buffer))))
10247 (if (eq org-refile-use-outline-path
10248 'full-file-path)
10249 (list (buffer-file-name
10250 (buffer-base-buffer)))))
10251 (org-get-outline-path fast-path-p
10252 level txt)
10253 (list txt))
10254 "/")))
10255 (push (list txt f re (org-refile-marker (point)))
10256 tgs)))
10257 (when (= (point) pos0)
10258 ;; verification function has not moved point
10259 (goto-char (point-at-eol))))))))
10260 (when org-refile-use-cache
10261 (org-refile-cache-put tgs (buffer-file-name) descre))
10262 (setq targets (append tgs targets))
10263 ))))
10264 (message "Getting targets...done")
10265 (nreverse targets)))
10267 (defun org-protect-slash (s)
10268 (while (string-match "/" s)
10270 s)
10272 (defvar org-olpa (make-vector 20 nil))
10274 (defun org-get-outline-path (&optional fastp level heading)
10275 "Return the outline path to the current entry, as a list.
10277 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10278 routine which makes outline path derivations for an entire file,
10279 avoiding backtracing. Refile target collection makes use of that."
10280 (if fastp
10281 (progn
10282 (if (> level 19)
10283 (error "Outline path failure, more than 19 levels"))
10284 (loop for i from level upto 19 do
10285 (aset org-olpa i nil))
10286 (prog1
10287 (delq nil (append org-olpa nil))
10288 (aset org-olpa level heading)))
10289 (let (rtn case-fold-search)
10290 (save-excursion
10291 (save-restriction
10292 (widen)
10293 (while (org-up-heading-safe)
10294 (when (looking-at org-complex-heading-regexp)
10295 (push (org-match-string-no-properties 4) rtn)))
10296 rtn)))))
10298 (defun org-format-outline-path (path &optional width prefix)
10299 "Format the outline path PATH for display.
10300 Width is the maximum number of characters that is available.
10301 Prefix is a prefix to be included in the returned string,
10302 such as the file name."
10303 (setq width (or width 79))
10304 (if prefix (setq width (- width (length prefix))))
10305 (if (not path)
10306 (or prefix "")
10307 (let* ((nsteps (length path))
10308 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10309 (maxwidth (if (<= total-width width)
10310 10000 ;; everything fits
10311 ;; we need to shorten the level headings
10312 (/ (- width nsteps) nsteps)))
10313 (org-odd-levels-only nil)
10314 (n 0)
10315 (total (1+ (length prefix))))
10316 (setq maxwidth (max maxwidth 10))
10317 (concat prefix
10318 (mapconcat
10319 (lambda (h)
10320 (setq n (1+ n))
10321 (if (and (= n nsteps) (< maxwidth 10000))
10322 (setq maxwidth (- total-width total)))
10323 (if (< (length h) maxwidth)
10324 (progn (setq total (+ total (length h) 1)) h)
10325 (setq h (substring h 0 (- maxwidth 2))
10326 total (+ total maxwidth 1))
10328 (setq h (substring h 0 (match-beginning 0))))
10329 (setq h (concat h "..")))
10330 (org-add-props h nil 'face
10331 (nth (% (1- n) org-n-level-faces)
10332 org-level-faces))
10333 h)
10334 path "/")))))
10336 (defun org-display-outline-path (&optional file current)
10337 "Display the current outline path in the echo area."
10338 (interactive "P")
10339 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10340 (case-fold-search nil)
10341 (path (and (org-mode-p) (org-get-outline-path))))
10342 (if current (setq path (append path
10343 (save-excursion
10344 (org-back-to-heading t)
10345 (if (looking-at org-complex-heading-regexp)
10346 (list (match-string 4)))))))
10347 (message "%s"
10348 (org-format-outline-path
10349 path
10350 (1- (frame-width))
10351 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10353 (defvar org-refile-history nil
10354 "History for refiling operations.")
10356 (defvar org-after-refile-insert-hook nil
10357 "Hook run after `org-refile' has inserted its stuff at the new location.
10358 Note that this is still *before* the stuff will be removed from
10359 the *old* location.")
10361 (defvar org-capture-last-stored-marker)
10362 (defun org-refile (&optional goto default-buffer rfloc)
10363 "Move the entry or entries at point to another heading.
10364 The list of target headings is compiled using the information in
10365 `org-refile-targets', which see.
10367 At the target location, the entry is filed as a subitem of the target
10368 heading. Depending on `org-reverse-note-order', the new subitem will
10369 either be the first or the last subitem.
10371 If there is an active region, all entries in that region will be moved.
10372 However, the region must fulfill the requirement that the first heading
10373 is the first one sets the top-level of the moved text - at most siblings
10374 below it are allowed.
10376 With prefix arg GOTO, the command will only visit the target location
10377 and not actually move anything.
10380 go to the location where the last refiling operation has put the subtree.
10381 With a prefix argument of `2', refile to the running clock.
10383 RFLOC can be a refile location obtained in a different way.
10385 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10387 If you are using target caching (see `org-refile-use-cache'),
10388 You have to clear the target cache in order to find new targets.
10389 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10390 prefix argument (`C-u C-u C-u C-c C-w')."
10392 (interactive "P")
10393 (if (member goto '(0 (64)))
10394 (org-refile-cache-clear)
10395 (let* ((cbuf (current-buffer))
10396 (regionp (org-region-active-p))
10397 (region-start (and regionp (region-beginning)))
10398 (region-end (and regionp (region-end)))
10399 (region-length (and regionp (- region-end region-start)))
10400 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10401 pos it nbuf file re level reversed)
10402 (setq last-command nil)
10403 (when regionp
10404 (goto-char region-start)
10405 (or (bolp) (goto-char (point-at-bol)))
10406 (setq region-start (point))
10407 (unless (org-kill-is-subtree-p
10408 (buffer-substring region-start region-end))
10409 (error "The region is not a (sequence of) subtree(s)")))
10410 (if (equal goto '(16))
10411 (org-refile-goto-last-stored)
10412 (when (or
10413 (and (equal goto 2)
10414 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10415 (prog1
10416 (setq it (list (or org-clock-heading "running clock")
10417 (buffer-file-name
10418 (marker-buffer org-clock-hd-marker))
10419 ""
10420 (marker-position org-clock-hd-marker)))
10421 (setq goto nil)))
10422 (setq it (or rfloc
10423 (save-excursion
10424 (org-refile-get-location
10425 (if goto "Goto" "Refile to") default-buffer
10426 org-refile-allow-creating-parent-nodes)))))
10427 (setq file (nth 1 it)
10428 re (nth 2 it)
10429 pos (nth 3 it))
10430 (if (and (not goto)
10431 pos
10432 (equal (buffer-file-name) file)
10433 (if regionp
10434 (and (>= pos region-start)
10435 (<= pos region-end))
10436 (and (>= pos (point))
10437 (< pos (save-excursion
10438 (org-end-of-subtree t t))))))
10439 (error "Cannot refile to position inside the tree or region"))
10441 (setq nbuf (or (find-buffer-visiting file)
10442 (find-file-noselect file)))
10443 (if goto
10444 (progn
10445 (org-pop-to-buffer-same-window nbuf)
10446 (goto-char pos)
10447 (org-show-context 'org-goto))
10448 (if regionp
10449 (progn
10450 (org-kill-new (buffer-substring region-start region-end))
10451 (org-save-markers-in-region region-start region-end))
10452 (org-copy-subtree 1 nil t))
10453 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10454 (find-file-noselect file)))
10455 (setq reversed (org-notes-order-reversed-p))
10456 (save-excursion
10457 (save-restriction
10458 (widen)
10459 (if pos
10460 (progn
10461 (goto-char pos)
10462 (looking-at org-outline-regexp)
10463 (setq level (org-get-valid-level (funcall outline-level) 1))
10464 (goto-char
10465 (if reversed
10466 (or (outline-next-heading) (point-max))
10467 (or (save-excursion (org-get-next-sibling))
10468 (org-end-of-subtree t t)
10469 (point-max)))))
10470 (setq level 1)
10471 (if (not reversed)
10472 (goto-char (point-max))
10473 (goto-char (point-min))
10474 (or (outline-next-heading) (goto-char (point-max)))))
10475 (if (not (bolp)) (newline))
10476 (org-paste-subtree level)
10477 (when org-log-refile
10478 (org-add-log-setup 'refile nil nil 'findpos
10479 org-log-refile)
10480 (unless (eq org-log-refile 'note)
10481 (save-excursion (org-add-log-note))))
10482 (and org-auto-align-tags (org-set-tags nil t))
10483 (bookmark-set "org-refile-last-stored")
10484 ;; If we are refiling for capture, make sure that the
10485 ;; last-capture pointers point here
10486 (when (org-bound-and-true-p org-refile-for-capture)
10487 (bookmark-set "org-capture-last-stored-marker")
10488 (move-marker org-capture-last-stored-marker (point)))
10489 (if (fboundp 'deactivate-mark) (deactivate-mark))
10490 (run-hooks 'org-after-refile-insert-hook))))
10491 (if regionp
10492 (delete-region (point) (+ (point) region-length))
10493 (org-cut-subtree))
10494 (when (featurep 'org-inlinetask)
10495 (org-inlinetask-remove-END-maybe))
10496 (setq org-markers-to-move nil)
10499 (defun org-refile-goto-last-stored ()
10500 "Go to the location where the last refile was stored."
10501 (interactive)
10502 (bookmark-jump "org-refile-last-stored")
10503 (message "This is the location of the last refile"))
10505 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10506 "Prompt the user for a refile location, using PROMPT.
10507 PROMPT should not be suffixed with a colon and a space, because
10508 this function appends the default value from
10509 `org-refile-history' automatically, if that is not empty."
10510 (let ((org-refile-targets org-refile-targets)
10511 (org-refile-use-outline-path org-refile-use-outline-path)
10512 excluded-entries)
10513 (when (and (eq major-mode 'org-mode)
10514 (not org-refile-use-cache))
10515 (org-map-tree
10516 (lambda()
10517 (setq excluded-entries
10518 (append excluded-entries (list (org-get-heading t t)))))))
10519 (setq org-refile-target-table
10520 (org-refile-get-targets default-buffer excluded-entries)))
10521 (unless org-refile-target-table
10522 (error "No refile targets"))
10523 (let* ((prompt (concat prompt
10524 (and (car org-refile-history)
10525 (concat " (default " (car org-refile-history) ")"))
10526 ": "))
10527 (cbuf (current-buffer))
10528 (partial-completion-mode nil)
10529 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10530 (cfunc (if (and org-refile-use-outline-path
10531 org-outline-path-complete-in-steps)
10532 'org-olpath-completing-read
10533 'org-icompleting-read))
10534 (extra (if org-refile-use-outline-path "/" ""))
10535 (filename (and cfn (expand-file-name cfn)))
10536 (tbl (mapcar
10537 (lambda (x)
10538 (if (and (not (member org-refile-use-outline-path
10539 '(file full-file-path)))
10540 (not (equal filename (nth 1 x))))
10541 (cons (concat (car x) extra " ("
10542 (file-name-nondirectory (nth 1 x)) ")")
10543 (cdr x))
10544 (cons (concat (car x) extra) (cdr x))))
10545 org-refile-target-table))
10546 (completion-ignore-case t)
10547 pa answ parent-target child parent old-hist)
10548 (setq old-hist org-refile-history)
10549 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10550 nil 'org-refile-history (car org-refile-history)))
10551 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10552 (org-refile-check-position pa)
10553 (if pa
10554 (progn
10555 (when (or (not org-refile-history)
10556 (not (eq old-hist org-refile-history))
10557 (not (equal (car pa) (car org-refile-history))))
10558 (setq org-refile-history
10559 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10560 org-refile-history
10561 (cdr org-refile-history))))
10562 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10563 (pop org-refile-history)))
10564 pa)
10566 (progn
10567 (setq parent (match-string 1 answ)
10568 child (match-string 2 answ))
10569 (setq parent-target (or (assoc parent tbl)
10570 (assoc (concat parent "/") tbl)))
10571 (when (and parent-target
10572 (or (eq new-nodes t)
10573 (and (eq new-nodes 'confirm)
10575 child)))))
10576 (org-refile-new-child parent-target child)))
10577 (error "Invalid target location")))))
10579 (defun org-refile-check-position (refile-pointer)
10580 "Check if the refile pointer matches the readline to which it points."
10581 (let* ((file (nth 1 refile-pointer))
10582 (re (nth 2 refile-pointer))
10583 (pos (nth 3 refile-pointer))
10584 buffer)
10585 (when (org-string-nw-p re)
10586 (setq buffer (if (markerp pos)
10587 (marker-buffer pos)
10588 (or (find-buffer-visiting file)
10589 (find-file-noselect file))))
10590 (with-current-buffer buffer
10591 (save-excursion
10592 (save-restriction
10593 (widen)
10594 (goto-char pos)
10595 (beginning-of-line 1)
10596 (unless (org-looking-at-p re)
10597 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10599 (defun org-refile-new-child (parent-target child)
10600 "Use refile target PARENT-TARGET to add new CHILD below it."
10601 (unless parent-target
10602 (error "Cannot find parent for new node"))
10603 (let ((file (nth 1 parent-target))
10604 (pos (nth 3 parent-target))
10605 level)
10606 (with-current-buffer (or (find-buffer-visiting file)
10607 (find-file-noselect file))
10608 (save-excursion
10609 (save-restriction
10610 (widen)
10611 (if pos
10612 (goto-char pos)
10613 (goto-char (point-max))
10614 (if (not (bolp)) (newline)))
10615 (when (looking-at org-outline-regexp)
10616 (setq level (funcall outline-level))
10617 (org-end-of-subtree t t))
10618 (org-back-over-empty-lines)
10620 (if pos (org-get-valid-level level 1) 1) ?*)
10622 (beginning-of-line 0)
10623 (list (concat (car parent-target) "/" child) file "" (point)))))))
10625 (defun org-olpath-completing-read (prompt collection &rest args)
10626 "Read an outline path like a file name."
10627 (let ((thetable collection)
10628 (org-completion-use-ido nil) ; does not work with ido.
10629 (org-completion-use-iswitchb nil)) ; or iswitchb
10630 (apply
10631 'org-icompleting-read prompt
10632 (lambda (string predicate &optional flag)
10633 (let (rtn r f (l (length string)))
10634 (cond
10635 ((eq flag nil)
10636 ;; try completion
10637 (try-completion string thetable))
10638 ((eq flag t)
10639 ;; all-completions
10640 (setq rtn (all-completions string thetable predicate))
10641 (mapcar
10642 (lambda (x)
10643 (setq r (substring x l))
10644 (if (string-match " ([^)]*)$" x)
10645 (setq f (match-string 0 x))
10646 (setq f ""))
10647 (if (string-match "/" r)
10648 (concat string (substring r 0 (match-end 0)) f)
10649 x))
10650 rtn))
10651 ((eq flag 'lambda)
10652 ;; exact match?
10653 (assoc string thetable)))
10654 ))
10655 args)))
10657 ;;;; Dynamic blocks
10659 (defun org-find-dblock (name)
10660 "Find the first dynamic block with name NAME in the buffer.
10661 If not found, stay at current position and return nil."
10662 (let (pos)
10663 (save-excursion
10664 (goto-char (point-min))
10666 nil t)
10667 (match-beginning 0))))
10668 (if pos (goto-char pos))
10669 pos))
10671 (defconst org-dblock-start-re
10673 "Matches the start line of a dynamic block, with parameters.")
10676 "Matches the end of a dynamic block.")
10678 (defun org-create-dblock (plist)
10679 "Create a dynamic block section, with parameters taken from PLIST.
10680 PLIST must contain a :name entry which is used as name of the block."
10682 (end-of-line 1)
10683 (newline))
10684 (let ((col (current-column))
10685 (name (plist-get plist :name)))
10686 (insert "#+BEGIN: " name)
10687 (while plist
10688 (if (eq (car plist) :name)
10689 (setq plist (cddr plist))
10690 (insert " " (prin1-to-string (pop plist)))))
10692 (beginning-of-line -2)))
10694 (defun org-prepare-dblock ()
10695 "Prepare dynamic block for refresh.
10696 This empties the block, puts the cursor at the insert position and returns
10697 the property list including an extra property :name with the block name."
10698 (unless (looking-at org-dblock-start-re)
10699 (error "Not at a dynamic block"))
10700 (let* ((begdel (1+ (match-end 0)))
10701 (name (org-no-properties (match-string 1)))
10702 (params (append (list :name name)
10703 (read (concat "(" (match-string 3) ")")))))
10704 (save-excursion
10705 (beginning-of-line 1)
10707 (setq params (plist-put params :indentation-column (current-column))))
10708 (unless (re-search-forward org-dblock-end-re nil t)
10709 (error "Dynamic block not terminated"))
10710 (setq params
10711 (append params
10712 (list :content (buffer-substring
10713 begdel (match-beginning 0)))))
10714 (delete-region begdel (match-beginning 0))
10715 (goto-char begdel)
10716 (open-line 1)
10717 params))
10719 (defun org-map-dblocks (&optional command)
10720 "Apply COMMAND to all dynamic blocks in the current buffer.
10721 If COMMAND is not given, use `org-update-dblock'."
10722 (let ((cmd (or command 'org-update-dblock)))
10723 (save-excursion
10724 (goto-char (point-min))
10725 (while (re-search-forward org-dblock-start-re nil t)
10726 (goto-char (match-beginning 0))
10727 (save-excursion
10728 (condition-case nil
10729 (funcall cmd)
10730 (error (message "Error during update of dynamic block"))))
10731 (unless (re-search-forward org-dblock-end-re nil t)
10732 (error "Dynamic block not terminated"))))))
10734 (defun org-dblock-update (&optional arg)
10735 "User command for updating dynamic blocks.
10736 Update the dynamic block at point. With prefix ARG, update all dynamic
10737 blocks in the buffer."
10738 (interactive "P")
10739 (if arg
10740 (org-update-all-dblocks)
10741 (or (looking-at org-dblock-start-re)
10742 (org-beginning-of-dblock))
10743 (org-update-dblock)))
10745 (defun org-update-dblock ()
10746 "Update the dynamic block at point.
10747 This means to empty the block, parse for parameters and then call
10748 the correct writing function."
10749 (interactive)
10750 (save-window-excursion
10751 (let* ((pos (point))
10752 (line (org-current-line))
10753 (params (org-prepare-dblock))
10754 (name (plist-get params :name))
10755 (indent (plist-get params :indentation-column))
10756 (cmd (intern (concat "org-dblock-write:" name))))
10757 (message "Updating dynamic block `%s' at line %d..." name line)
10758 (funcall cmd params)
10759 (message "Updating dynamic block `%s' at line %d...done" name line)
10760 (goto-char pos)
10761 (when (and indent (> indent 0))
10762 (setq indent (make-string indent ?\ ))
10763 (save-excursion
10764 (org-beginning-of-dblock)
10765 (forward-line 1)
10766 (while (not (looking-at org-dblock-end-re))
10767 (insert indent)
10768 (beginning-of-line 2))
10769 (when (looking-at org-dblock-end-re)
10771 (replace-match ""))
10772 (insert indent)))))))
10774 (defun org-beginning-of-dblock ()
10775 "Find the beginning of the dynamic block at point.
10776 Error if there is no such block at point."
10777 (let ((pos (point))
10778 beg)
10779 (end-of-line 1)
10780 (if (and (re-search-backward org-dblock-start-re nil t)
10781 (setq beg (match-beginning 0))
10782 (re-search-forward org-dblock-end-re nil t)
10783 (> (match-end 0) pos))
10784 (goto-char beg)
10785 (goto-char pos)
10786 (error "Not in a dynamic block"))))
10788 (defun org-update-all-dblocks ()
10789 "Update all dynamic blocks in the buffer.
10790 This function can be used in a hook."
10791 (interactive)
10792 (when (org-mode-p)
10793 (org-map-dblocks 'org-update-dblock)))
10796 ;;;; Completion
10798 (defconst org-additional-option-like-keywords
10799 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10800 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10801 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10802 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10803 "BEGIN:" "END:"
10804 "ORGTBL" "TBLFM:" "TBLNAME:"
10805 "BEGIN_EXAMPLE" "END_EXAMPLE"
10806 "BEGIN_QUOTE" "END_QUOTE"
10807 "BEGIN_VERSE" "END_VERSE"
10808 "BEGIN_CENTER" "END_CENTER"
10809 "BEGIN_SRC" "END_SRC"
10810 "BEGIN_RESULT" "END_RESULT"
10811 "SOURCE:" "SRCNAME:" "FUNCTION:"
10812 "RESULTS:" "DATA:"
10813 "HEADER:" "HEADERS:"
10814 "BABEL:"
10815 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10816 "CAPTION:" "LABEL:"
10817 "SETUPFILE:"
10818 "INCLUDE:"
10819 "BIND:"
10820 "MACRO:"))
10822 (defcustom org-structure-template-alist
10823 '(
10836 ("L" "#+latex: "
10840 ("H" "#+html: "
10843 ("A" "#+ascii: ")
10844 ("i" "#+index: ?"
10845 "#+index: ?")
10846 ("I" "#+include %file ?"
10848 )
10849 "Structure completion elements.
10850 This is a list of abbreviation keys and values. The value gets inserted
10851 if you type `<' followed by the key and then press the completion key,
10852 usually `M-TAB'. %file will be replaced by a file name after prompting
10853 for the file using completion. The cursor will be placed at the position
10854 of the `?` in the template.
10855 There are two templates for each key, the first uses the original Org syntax,
10856 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10857 the default when the /org-mtags.el/ module has been loaded. See also the
10858 variable `org-mtags-prefer-muse-templates'.
10859 This is an experimental feature, it is undecided if it is going to stay in."
10860 :group 'org-completion
10861 :type '(repeat
10862 (string :tag "Key")
10863 (string :tag "Template")
10864 (string :tag "Muse Template")))
10866 (defun org-try-structure-completion ()
10867 "Try to complete a structure template before point.
10869 expands them."
10870 (let ((l (buffer-substring (point-at-bol) (point)))
10871 a)
10874 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10875 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10876 (match-beginning 1)) a)
10877 t)))
10879 (defun org-complete-expand-structure-template (start cell)
10880 "Expand a structure template."
10881 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10882 (rpl (nth (if musep 2 1) cell))
10883 (ind ""))
10884 (delete-region start (point))
10886 (cond
10887 ((bolp))
10889 (setq ind (buffer-substring (point-at-bol) (point))))
10890 (t (newline))))
10891 (setq start (point))
10892 (if (string-match "%file" rpl)
10893 (setq rpl (replace-match
10894 (concat
10896 (save-match-data
10897 (abbreviate-file-name (read-file-name "Include file: ")))
10899 t t rpl)))
10902 (insert rpl)
10905 ;;;; TODO, DEADLINE, Comments
10907 (defun org-toggle-comment ()
10908 "Change the COMMENT state of an entry."
10909 (interactive)
10910 (save-excursion
10911 (org-back-to-heading)
10912 (let (case-fold-search)
10913 (if (looking-at (concat org-outline-regexp
10915 (replace-match "" t t nil 1)
10916 (if (looking-at org-outline-regexp)
10917 (progn
10918 (goto-char (match-end 0))
10919 (insert org-comment-string " ")))))))
10921 (defvar org-last-todo-state-is-todo nil
10922 "This is non-nil when the last TODO state change led to a TODO state.
10923 If the last change removed the TODO tag or switched to DONE, then
10924 this is nil.")
10926 (defvar org-setting-tags nil) ; dynamically skipped
10928 (defvar org-todo-setup-filter-hook nil
10929 "Hook for functions that pre-filter todo specs.
10930 Each function takes a todo spec and returns either nil or the spec
10931 transformed into canonical form." )
10933 (defvar org-todo-get-default-hook nil
10934 "Hook for functions that get a default item for todo.
10935 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10936 nil or a string to be used for the todo mark." )
10938 (defvar org-agenda-headline-snapshot-before-repeat)
10940 (defun org-todo (&optional arg)
10941 "Change the TODO state of an item.
10942 The state of an item is given by a keyword at the start of the heading,
10943 like
10944 *** TODO Write paper
10945 *** DONE Call mom
10947 The different keywords are specified in the variable `org-todo-keywords'.
10949 So for this example: when the item starts with TODO, it is changed to DONE.
10950 When it starts with DONE, the DONE is removed. And when neither TODO nor
10951 DONE are present, add TODO at the beginning of the heading.
10954 state.
10955 With numeric prefix arg, switch to that state.
10957 keywords (nextset).
10960 For calling through lisp, arg is also interpreted in the following way:
10961 'none -> empty state
10963 'done -> switch to DONE
10964 'nextset -> switch to the next set of keywords
10965 'previousset -> switch to the previous set of keywords
10967 really is a member of `org-todo-keywords'."
10968 (interactive "P")
10969 (if (equal arg '(16)) (setq arg 'nextset))
10970 (let ((org-blocker-hook org-blocker-hook)
10971 (case-fold-search nil))
10972 (when (equal arg '(64))
10973 (setq arg nil org-blocker-hook nil))
10974 (when (and org-blocker-hook
10975 (or org-inhibit-blocking
10976 (org-entry-get nil "NOBLOCKING")))
10977 (setq org-blocker-hook nil))
10978 (save-excursion
10979 (catch 'exit
10980 (org-back-to-heading t)
10981 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
10983 (looking-at " *"))
10984 (let* ((match-data (match-data))
10985 (startpos (point-at-bol))
10986 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10987 (org-log-done org-log-done)
10988 (org-log-repeat org-log-repeat)
10989 (org-todo-log-states org-todo-log-states)
10990 (this (match-string 1))
10991 (hl-pos (match-beginning 0))
10992 (head (org-get-todo-sequence-head this))
10993 (ass (assoc head org-todo-kwd-alist))
10994 (interpret (nth 1 ass))
10995 (done-word (nth 3 ass))
10996 (final-done-word (nth 4 ass))
10997 (last-state (or this ""))
10998 (completion-ignore-case t)
10999 (member (member this org-todo-keywords-1))
11000 (tail (cdr member))
11001 (state (cond
11002 ((and org-todo-key-trigger
11003 (or (and (equal arg '(4))
11004 (eq org-use-fast-todo-selection 'prefix))
11005 (and (not arg) org-use-fast-todo-selection
11006 (not (eq org-use-fast-todo-selection
11007 'prefix)))))
11008 ;; Use fast selection
11009 (org-fast-todo-selection))
11010 ((and (equal arg '(4))
11011 (or (not org-use-fast-todo-selection)
11012 (not org-todo-key-trigger)))
11013 ;; Read a state with completion
11014 (org-icompleting-read
11015 "State: " (mapcar (lambda(x) (list x))
11016 org-todo-keywords-1)
11017 nil t))
11018 ((eq arg 'right)
11019 (if this
11020 (if tail (car tail) nil)
11021 (car org-todo-keywords-1)))
11022 ((eq arg 'left)
11023 (if (equal member org-todo-keywords-1)
11024 nil
11025 (if this
11026 (nth (- (length org-todo-keywords-1)
11027 (length tail) 2)
11028 org-todo-keywords-1)
11029 (org-last org-todo-keywords-1))))
11030 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11031 (setq arg nil))) ; hack to fall back to cycling
11032 (arg
11033 ;; user or caller requests a specific state
11034 (cond
11035 ((equal arg "") nil)
11036 ((eq arg 'none) nil)
11037 ((eq arg 'done) (or done-word (car org-done-keywords)))
11038 ((eq arg 'nextset)
11039 (or (car (cdr (member head org-todo-heads)))
11040 (car org-todo-heads)))
11041 ((eq arg 'previousset)
11042 (let ((org-todo-heads (reverse org-todo-heads)))
11043 (or (car (cdr (member head org-todo-heads)))
11044 (car org-todo-heads))))
11045 ((car (member arg org-todo-keywords-1)))
11046 ((stringp arg)
11047 (error "State `%s' not valid in this file" arg))
11048 ((nth (1- (prefix-numeric-value arg))
11049 org-todo-keywords-1))))
11050 ((null member) (or head (car org-todo-keywords-1)))
11051 ((equal this final-done-word) nil) ;; -> make empty
11052 ((null tail) nil) ;; -> first entry
11053 ((memq interpret '(type priority))
11054 (if (eq this-command last-command)
11055 (car tail)
11056 (if (> (length tail) 0)
11057 (or done-word (car org-done-keywords))
11058 nil)))
11059 (t
11060 (car tail))))
11061 (state (or
11062 (run-hook-with-args-until-success
11063 'org-todo-get-default-hook state last-state)
11064 state))
11065 (next (if state (concat " " state " ") " "))
11066 (change-plist (list :type 'todo-state-change :from this :to state
11067 :position startpos))
11068 dolog now-done-p)
11069 (when org-blocker-hook
11070 (setq org-last-todo-state-is-todo
11071 (not (member this org-done-keywords)))
11072 (unless (save-excursion
11073 (save-match-data
11074 (org-with-wide-buffer
11075 (run-hook-with-args-until-failure
11076 'org-blocker-hook change-plist))))
11077 (if (org-called-interactively-p 'interactive)
11078 (error "TODO state change from %s to %s blocked" this state)
11079 ;; fail silently
11080 (message "TODO state change from %s to %s blocked" this state)
11081 (throw 'exit nil))))
11082 (store-match-data match-data)
11083 (replace-match next t t)
11084 (unless (pos-visible-in-window-p hl-pos)
11085 (message "TODO state changed to %s" (org-trim next)))
11086 (unless head
11087 (setq head (org-get-todo-sequence-head state)
11088 ass (assoc head org-todo-kwd-alist)
11089 interpret (nth 1 ass)
11090 done-word (nth 3 ass)
11091 final-done-word (nth 4 ass)))
11092 (when (memq arg '(nextset previousset))
11093 (message "Keyword-Set %d/%d: %s"
11094 (- (length org-todo-sets) -1
11095 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11096 (length org-todo-sets)
11097 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11098 (setq org-last-todo-state-is-todo
11099 (not (member state org-done-keywords)))
11100 (setq now-done-p (and (member state org-done-keywords)
11101 (not (member this org-done-keywords))))
11102 (and logging (org-local-logging logging))
11103 (when (and (or org-todo-log-states org-log-done)
11104 (not (eq org-inhibit-logging t))
11105 (not (memq arg '(nextset previousset))))
11106 ;; we need to look at recording a time and note
11107 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11108 (nth 2 (assoc this org-todo-log-states))))
11109 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11110 (setq dolog 'time))
11111 (when (and state
11112 (member state org-not-done-keywords)
11113 (not (member this org-not-done-keywords)))
11114 ;; This is now a todo state and was not one before
11115 ;; If there was a CLOSED time stamp, get rid of it.
11116 (org-add-planning-info nil nil 'closed))
11117 (when (and now-done-p org-log-done)
11118 ;; It is now done, and it was not done before
11119 (org-add-planning-info 'closed (org-current-time))
11120 (if (and (not dolog) (eq 'note org-log-done))
11121 (org-add-log-setup 'done state this 'findpos 'note)))
11122 (when (and state dolog)
11123 ;; This is a non-nil state, and we need to log it
11124 (org-add-log-setup 'state state this 'findpos dolog)))
11125 ;; Fixup tag positioning
11126 (org-todo-trigger-tag-changes state)
11127 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11128 (when org-provide-todo-statistics
11129 (org-update-parent-todo-statistics))
11130 (run-hooks 'org-after-todo-state-change-hook)
11131 (if (and arg (not (member state org-done-keywords)))
11132 (setq head (org-get-todo-sequence-head state)))
11133 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11134 ;; Do we need to trigger a repeat?
11135 (when now-done-p
11136 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11137 ;; This is for the agenda, take a snapshot of the headline.
11138 (save-match-data
11139 (setq org-agenda-headline-snapshot-before-repeat
11140 (org-get-heading))))
11141 (org-auto-repeat-maybe state))
11142 ;; Fixup cursor location if close to the keyword
11143 (if (and (outline-on-heading-p)
11144 (not (bolp))
11145 (save-excursion (beginning-of-line 1)
11146 (looking-at org-todo-line-regexp))
11147 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11148 (progn
11149 (goto-char (or (match-end 2) (match-end 1)))
11150 (and (looking-at " ") (just-one-space))))
11151 (when org-trigger-hook
11152 (save-excursion
11153 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11155 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11156 "Block turning an entry into a TODO, using the hierarchy.
11157 This checks whether the current task should be blocked from state
11158 changes. Such blocking occurs when:
11160 1. The task has children which are not all in a completed state.
11162 2. A task has a parent with the property :ORDERED:, and there
11163 are siblings prior to the current task with incomplete
11164 status.
11166 3. The parent of the task is blocked because it has siblings that should
11167 be done first, or is child of a block grandparent TODO entry."
11169 (if (not org-enforce-todo-dependencies)
11170 t ; if locally turned off don't block
11171 (catch 'dont-block
11172 ;; If this is not a todo state change, or if this entry is already DONE,
11173 ;; do not block
11174 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11175 (member (plist-get change-plist :from)
11176 (cons 'done org-done-keywords))
11177 (member (plist-get change-plist :to)
11178 (cons 'todo org-not-done-keywords))
11179 (not (plist-get change-plist :to)))
11180 (throw 'dont-block t))
11181 ;; If this task has children, and any are undone, it's blocked
11182 (save-excursion
11183 (org-back-to-heading t)
11184 (let ((this-level (funcall outline-level)))
11185 (outline-next-heading)
11186 (let ((child-level (funcall outline-level)))
11187 (while (and (not (eobp))
11188 (> child-level this-level))
11189 ;; this todo has children, check whether they are all
11190 ;; completed
11191 (if (and (not (org-entry-is-done-p))
11192 (org-entry-is-todo-p))
11193 (throw 'dont-block nil))
11194 (outline-next-heading)
11195 (setq child-level (funcall outline-level))))))
11196 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11197 ;; any previous siblings are undone, it's blocked
11198 (save-excursion
11199 (org-back-to-heading t)
11200 (let* ((pos (point))
11201 (parent-pos (and (org-up-heading-safe) (point))))
11202 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11203 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11204 (forward-line 1)
11205 (re-search-forward org-not-done-heading-regexp pos t))
11206 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11207 ;; Search further up the hierarchy, to see if an anchestor is blocked
11208 (while t
11209 (goto-char parent-pos)
11210 (if (not (looking-at org-not-done-heading-regexp))
11211 (throw 'dont-block t)) ; do not block, parent is not a TODO
11212 (setq pos (point))
11213 (setq parent-pos (and (org-up-heading-safe) (point)))
11214 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11215 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11216 (forward-line 1)
11217 (re-search-forward org-not-done-heading-regexp pos t))
11218 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11220 (defcustom org-track-ordered-property-with-tag nil
11221 "Should the ORDERED property also be shown as a tag?
11222 The ORDERED property decides if an entry should require subtasks to be
11223 completed in sequence. Since a property is not very visible, setting
11224 this option means that toggling the ORDERED property with the command
11225 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11226 not relevant for the behavior, but it makes things more visible.
11228 Note that toggling the tag with tags commands will not change the property
11229 and therefore not influence behavior!
11231 This can be t, meaning the tag ORDERED should be used, It can also be a
11232 string to select a different tag for this task."
11233 :group 'org-todo
11234 :type '(choice
11235 (const :tag "No tracking" nil)
11236 (const :tag "Track with ORDERED tag" t)
11237 (string :tag "Use other tag")))
11239 (defun org-toggle-ordered-property ()
11240 "Toggle the ORDERED property of the current entry.
11241 For better visibility, you can track the value of this property with a tag.
11242 See variable `org-track-ordered-property-with-tag'."
11243 (interactive)
11244 (let* ((t1 org-track-ordered-property-with-tag)
11245 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11246 (save-excursion
11247 (org-back-to-heading)
11248 (if (org-entry-get nil "ORDERED")
11249 (progn
11250 (org-delete-property "ORDERED")
11251 (and tag (org-toggle-tag tag 'off))
11252 (message "Subtasks can be completed in arbitrary order"))
11253 (org-entry-put nil "ORDERED" "t")
11254 (and tag (org-toggle-tag tag 'on))
11255 (message "Subtasks must be completed in sequence")))))
11257 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11258 (defun org-block-todo-from-checkboxes (change-plist)
11259 "Block turning an entry into a TODO, using checkboxes.
11260 This checks whether the current task should be blocked from state
11261 changes because there are unchecked boxes in this entry."
11262 (if (not org-enforce-todo-checkbox-dependencies)
11263 t ; if locally turned off don't block
11264 (catch 'dont-block
11265 ;; If this is not a todo state change, or if this entry is already DONE,
11266 ;; do not block
11267 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11268 (member (plist-get change-plist :from)
11269 (cons 'done org-done-keywords))
11270 (member (plist-get change-plist :to)
11271 (cons 'todo org-not-done-keywords))
11272 (not (plist-get change-plist :to)))
11273 (throw 'dont-block t))
11274 ;; If this task has checkboxes that are not checked, it's blocked
11275 (save-excursion
11276 (org-back-to-heading t)
11277 (let ((beg (point)) end)
11278 (outline-next-heading)
11279 (setq end (point))
11280 (goto-char beg)
11282 end t)
11283 (progn
11284 (if (boundp 'org-blocked-by-checkboxes)
11285 (setq org-blocked-by-checkboxes t))
11286 (throw 'dont-block nil)))))
11287 t))) ; do not block
11289 (defun org-entry-blocked-p ()
11290 "Is the current entry blocked?"
11291 (if (org-entry-get nil "NOBLOCKING")
11292 nil ;; Never block this entry
11293 (not
11294 (run-hook-with-args-until-failure
11295 'org-blocker-hook
11296 (list :type 'todo-state-change
11297 :position (point)
11298 :from 'todo
11299 :to 'done)))))
11301 (defun org-update-statistics-cookies (all)
11302 "Update the statistics cookie, either from TODO or from checkboxes.
11303 This should be called with the cursor in a line with a statistics cookie."
11304 (interactive "P")
11305 (if all
11306 (progn
11307 (org-update-checkbox-count 'all)
11308 (org-map-entries 'org-update-parent-todo-statistics))
11309 (if (not (org-on-heading-p))
11310 (org-update-checkbox-count)
11311 (let ((pos (move-marker (make-marker) (point)))
11312 end l1 l2)
11313 (ignore-errors (org-back-to-heading t))
11314 (if (not (org-on-heading-p))
11315 (org-update-checkbox-count)
11316 (setq l1 (org-outline-level))
11317 (setq end (save-excursion
11318 (outline-next-heading)
11319 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11320 (point)))
11321 (if (and (save-excursion
11322 (re-search-forward
11324 (not (save-excursion (re-search-forward
11326 (org-update-checkbox-count)
11327 (if (and l2 (> l2 l1))
11328 (progn
11329 (goto-char end)
11330 (org-update-parent-todo-statistics))
11331 (goto-char pos)
11332 (beginning-of-line 1)
11333 (while (re-search-forward
11335 (point-at-eol) t)
11336 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11337 (goto-char pos)
11338 (move-marker pos nil)))))
11340 (defvar org-entry-property-inherited-from) ;; defined below
11341 (defun org-update-parent-todo-statistics ()
11342 "Update any statistics cookie in the parent of the current headline.
11343 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11344 the entire subtree and this will travel up the hierarchy and update
11345 statistics everywhere."
11346 (let* ((prop (save-excursion (org-up-heading-safe)
11347 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11348 (recursive (or (not org-hierarchical-todo-statistics)
11350 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11351 0))
11352 (first t)
11354 level ltoggle l1 new ndel
11355 (cnt-all 0) (cnt-done 0) is-percent kwd
11356 checkbox-beg ov ovs ove cookie-present)
11357 (catch 'exit
11358 (save-excursion
11359 (beginning-of-line 1)
11360 (setq ltoggle (funcall outline-level))
11361 ;; Three situations are to consider:
11363 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11364 ;; to the top-level ancestor on the headline;
11366 ;; 2. If parent has "recursive" property, repeat up to the
11367 ;; headline setting that property, taking inheritance into
11368 ;; account;
11370 ;; 3. Else, move up to direct parent and proceed only once.
11371 (while (and (setq level (org-up-heading-safe))
11372 (or recursive first)
11373 (>= (point) lim))
11374 (setq first nil cookie-present nil)
11375 (unless (and level
11376 (not (string-match
11378 (downcase (or (org-entry-get nil "COOKIE_DATA")
11379 "")))))
11380 (throw 'exit nil))
11381 (while (re-search-forward box-re (point-at-eol) t)
11382 (setq cnt-all 0 cnt-done 0 cookie-present t)
11383 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11384 (save-match-data
11385 (unless (outline-next-heading) (throw 'exit nil))
11386 (while (and (looking-at org-complex-heading-regexp)
11387 (> (setq l1 (length (match-string 1))) level))
11388 (setq kwd (and (or recursive (= l1 ltoggle))
11389 (match-string 2)))
11390 (if (or (eq org-provide-todo-statistics 'all-headlines)
11391 (and (listp org-provide-todo-statistics)
11392 (or (member kwd org-provide-todo-statistics)
11393 (member kwd org-done-keywords))))
11394 (setq cnt-all (1+ cnt-all))
11395 (if (eq org-provide-todo-statistics t)
11396 (and kwd (setq cnt-all (1+ cnt-all)))))
11397 (and (member kwd org-done-keywords)
11398 (setq cnt-done (1+ cnt-done)))
11399 (outline-next-heading)))
11400 (setq new
11401 (if is-percent
11402 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11403 (format "[%d/%d]" cnt-done cnt-all))
11404 ndel (- (match-end 0) checkbox-beg))
11405 ;; handle overlays when updating cookie from column view
11406 (when (setq ov (car (overlays-at checkbox-beg)))
11407 (setq ovs (overlay-start ov) ove (overlay-end ov))
11408 (delete-overlay ov))
11409 (goto-char checkbox-beg)
11410 (insert new)
11411 (delete-region (point) (+ (point) ndel))
11412 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11413 (when ov (move-overlay ov ovs ove)))
11414 (when cookie-present
11415 (run-hook-with-args 'org-after-todo-statistics-hook
11416 cnt-done (- cnt-all cnt-done))))))
11417 (run-hooks 'org-todo-statistics-hook)))
11419 (defvar org-after-todo-statistics-hook nil
11420 "Hook that is called after a TODO statistics cookie has been updated.
11421 Each function is called with two arguments: the number of not-done entries
11422 and the number of done entries.
11424 For example, the following function, when added to this hook, will switch
11425 an entry to DONE when all children are done, and back to TODO when new
11426 entries are set to a TODO status. Note that this hook is only called
11427 when there is a statistics cookie in the headline!
11429 (defun org-summary-todo (n-done n-not-done)
11431 (let (org-log-done org-log-states) ; turn off logging
11433 ")
11435 (defvar org-todo-statistics-hook nil
11436 "Hook that is run whenever Org thinks TODO statistics should be updated.
11437 This hook runs even if there is no statistics cookie present, in which case
11438 `org-after-todo-statistics-hook' would not run.")
11440 (defun org-todo-trigger-tag-changes (state)
11441 "Apply the changes defined in `org-todo-state-tags-triggers'."
11442 (let ((l org-todo-state-tags-triggers)
11443 changes)
11444 (when (or (not state) (equal state ""))
11445 (setq changes (append changes (cdr (assoc "" l)))))
11446 (when (and (stringp state) (> (length state) 0))
11447 (setq changes (append changes (cdr (assoc state l)))))
11448 (when (member state org-not-done-keywords)
11449 (setq changes (append changes (cdr (assoc 'todo l)))))
11450 (when (member state org-done-keywords)
11451 (setq changes (append changes (cdr (assoc 'done l)))))
11452 (dolist (c changes)
11453 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11455 (defun org-local-logging (value)
11456 "Get logging settings from a property VALUE."
11457 (let* (words w a)
11458 ;; directly set the variables, they are already local.
11459 (setq org-log-done nil
11460 org-log-repeat nil
11461 org-todo-log-states nil)
11462 (setq words (org-split-string value))
11463 (while (setq w (pop words))
11464 (cond
11465 ((setq a (assoc w org-startup-options))
11466 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11467 (set (nth 1 a) (nth 2 a))))
11468 ((setq a (org-extract-log-state-settings w))
11469 (and (member (car a) org-todo-keywords-1)
11470 (push a org-todo-log-states)))))))
11472 (defun org-get-todo-sequence-head (kwd)
11473 "Return the head of the TODO sequence to which KWD belongs.
11474 If KWD is not set, check if there is a text property remembering the
11475 right sequence."
11476 (let (p)
11477 (cond
11478 ((not kwd)
11479 (or (get-text-property (point-at-bol) 'org-todo-head)
11480 (progn
11481 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11482 nil (point-at-eol)))
11483 (get-text-property p 'org-todo-head))))
11484 ((not (member kwd org-todo-keywords-1))
11485 (car org-todo-keywords-1))
11486 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11488 (defun org-fast-todo-selection ()
11489 "Fast TODO keyword selection with single keys.
11490 Returns the new TODO keyword, or nil if no state change should occur."
11491 (let* ((fulltable org-todo-key-alist)
11492 (done-keywords org-done-keywords) ;; needed for the faces.
11493 (maxlen (apply 'max (mapcar
11494 (lambda (x)
11495 (if (stringp (car x)) (string-width (car x)) 0))
11496 fulltable)))
11497 (expert nil)
11498 (fwidth (+ maxlen 3 1 3))
11499 (ncol (/ (- (window-width) 4) fwidth))
11500 tg cnt e c tbl
11501 groups ingroup)
11502 (save-excursion
11503 (save-window-excursion
11504 (if expert
11505 (set-buffer (get-buffer-create " *Org todo*"))
11506 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11507 (erase-buffer)
11508 (org-set-local 'org-done-keywords done-keywords)
11509 (setq tbl fulltable cnt 0)
11510 (while (setq e (pop tbl))
11511 (cond
11512 ((equal e '(:startgroup))
11513 (push '() groups) (setq ingroup t)
11514 (when (not (= cnt 0))
11515 (setq cnt 0)
11517 (insert "{ "))
11518 ((equal e '(:endgroup))
11519 (setq ingroup nil cnt 0)
11521 ((equal e '(:newline))
11522 (when (not (= cnt 0))
11523 (setq cnt 0)
11525 (setq e (car tbl))
11526 (while (equal (car tbl) '(:newline))
11528 (setq tbl (cdr tbl)))))
11529 (t
11530 (setq tg (car e) c (cdr e))
11531 (if ingroup (push tg (car groups)))
11532 (setq tg (org-add-props tg nil 'face
11533 (org-get-todo-face tg)))
11534 (if (and (= cnt 0) (not ingroup)) (insert " "))
11535 (insert "[" c "] " tg (make-string
11536 (- fwidth 4 (length tg)) ?\ ))
11537 (when (= (setq cnt (1+ cnt)) ncol)
11539 (if ingroup (insert " "))
11540 (setq cnt 0)))))
11542 (goto-char (point-min))
11543 (if (not expert) (org-fit-window-to-buffer))
11544 (message "[a-z..]:Set [SPC]:clear")
11545 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11546 (cond
11547 ((or (= c ?\C-g)
11548 (and (= c ?q) (not (rassoc c fulltable))))
11549 (setq quit-flag t))
11550 ((= c ?\ ) nil)
11551 ((setq e (rassoc c fulltable) tg (car e))
11552 tg)
11553 (t (setq quit-flag t)))))))
11555 (defun org-entry-is-todo-p ()
11556 (member (org-get-todo-state) org-not-done-keywords))
11558 (defun org-entry-is-done-p ()
11559 (member (org-get-todo-state) org-done-keywords))
11561 (defun org-get-todo-state ()
11562 (save-excursion
11563 (org-back-to-heading t)
11564 (and (looking-at org-todo-line-regexp)
11565 (match-end 2)
11566 (match-string 2))))
11568 (defun org-at-date-range-p (&optional inactive-ok)
11569 "Is the cursor inside a date range?"
11570 (interactive)
11571 (save-excursion
11572 (catch 'exit
11573 (let ((pos (point)))
11575 (skip-chars-backward "<[")
11576 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11577 (>= (match-end 0) pos)
11578 (throw 'exit t))
11580 (skip-chars-backward "<[")
11581 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11582 (>= (match-end 0) pos)
11583 (throw 'exit t)))
11584 nil)))
11586 (defun org-get-repeat (&optional tagline)
11587 "Check if there is a deadline/schedule with repeater in this entry."
11588 (save-match-data
11589 (save-excursion
11590 (org-back-to-heading t)
11591 (and (re-search-forward (if tagline
11593 org-repeat-re)
11594 (org-entry-end-position) t)
11595 (match-string-no-properties 1)))))
11597 (defvar org-last-changed-timestamp)
11598 (defvar org-last-inserted-timestamp)
11599 (defvar org-log-post-message)
11600 (defvar org-log-note-purpose)
11601 (defvar org-log-note-how)
11602 (defvar org-log-note-extra)
11603 (defun org-auto-repeat-maybe (done-word)
11604 "Check if the current headline contains a repeated deadline/schedule.
11605 If yes, set TODO state back to what it was and change the base date
11606 of repeating deadline/scheduled time stamps to new date.
11607 This function is run automatically after each state change to a DONE state."
11608 ;; last-state is dynamically scoped into this function
11609 (let* ((repeat (org-get-repeat))
11610 (aa (assoc last-state org-todo-kwd-alist))
11611 (interpret (nth 1 aa))
11612 (head (nth 2 aa))
11613 (whata '(("d" . day) ("m" . month) ("y" . year)))
11614 (msg "Entry repeats: ")
11615 (org-log-done nil)
11616 (org-todo-log-states nil)
11617 re type n what ts time to-state)
11618 (when repeat
11619 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11620 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11621 org-todo-repeat-to-state))
11622 (unless (and to-state (member to-state org-todo-keywords-1))
11623 (setq to-state (if (eq interpret 'type) last-state head)))
11624 (org-todo to-state)
11625 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11626 (org-entry-put nil "LAST_REPEAT" (format-time-string
11627 (org-time-stamp-format t t))))
11628 (when org-log-repeat
11629 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11630 (memq 'org-add-log-note post-command-hook))
11631 ;; OK, we are already setup for some record
11632 (if (eq org-log-repeat 'note)
11633 ;; make sure we take a note, not only a time stamp
11634 (setq org-log-note-how 'note))
11635 ;; Set up for taking a record
11636 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11637 last-state
11638 'findpos org-log-repeat)))
11639 (org-back-to-heading t)
11640 (org-add-planning-info nil nil 'closed)
11644 (while (re-search-forward
11645 re (save-excursion (outline-next-heading) (point)) t)
11646 (setq type (if (match-end 1) org-scheduled-string
11647 (if (match-end 3) org-deadline-string "Plain:"))
11648 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11650 (setq n (string-to-number (match-string 2 ts))
11651 what (match-string 3 ts))
11652 (if (equal what "w") (setq n (* n 7) what "d"))
11653 ;; Preparation, see if we need to modify the start date for the change
11654 (when (match-end 1)
11655 (setq time (save-match-data (org-time-string-to-time ts)))
11656 (cond
11657 ((equal (match-string 1 ts) ".")
11658 ;; Shift starting date to today
11659 (org-timestamp-change
11660 (- (time-to-days (current-time)) (time-to-days time))
11661 'day))
11662 ((equal (match-string 1 ts) "+")
11663 (let ((nshiftmax 10) (nshift 0))
11664 (while (or (= nshift 0)
11665 (<= (time-to-days time)
11666 (time-to-days (current-time))))
11667 (when (= (incf nshift) nshiftmax)
11668 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11669 (error "Abort")))
11670 (org-timestamp-change n (cdr (assoc what whata)))
11671 (org-at-timestamp-p t)
11672 (setq ts (match-string 1))
11673 (setq time (save-match-data (org-time-string-to-time ts)))))
11674 (org-timestamp-change (- n) (cdr (assoc what whata)))
11675 ;; rematch, so that we have everything in place for the real shift
11676 (org-at-timestamp-p t)
11677 (setq ts (match-string 1))
11679 (org-timestamp-change n (cdr (assoc what whata)))
11680 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11681 (setq org-log-post-message msg)
11682 (message "%s" msg))))
11684 (defun org-show-todo-tree (arg)
11685 "Make a compact tree which shows all headlines marked with TODO.
11686 The tree will show the lines where the regexp matches, and all higher
11687 headlines above the match.
11689 With a numeric prefix N, construct a sparse tree for the Nth element
11690 of `org-todo-keywords-1'."
11691 (interactive "P")
11692 (let ((case-fold-search nil)
11693 (kwd-re
11694 (cond ((null arg) org-not-done-regexp)
11695 ((equal arg '(4))
11696 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11697 (mapcar 'list org-todo-keywords-1))))
11701 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11702 (regexp-quote (nth (1- (prefix-numeric-value arg))
11703 org-todo-keywords-1)))
11704 (t (error "Invalid prefix argument: %s" arg)))))
11705 (message "%d TODO entries found"
11706 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11708 (defun org-deadline (&optional remove time)
11710 With argument REMOVE, remove any deadline from the item.
11711 When TIME is set, it should be an internal time specification, and the
11712 scheduling will use the corresponding date."
11713 (interactive "P")
11714 (org-loop-over-siblings-in-active-region
11715 (let* ((old-date (org-entry-get nil "DEADLINE"))
11716 (repeater (and old-date
11717 (string-match
11719 old-date)
11720 (match-string 1 old-date))))
11721 (if remove
11722 (progn
11723 (when (and old-date org-log-redeadline)
11724 (org-add-log-setup 'deldeadline nil old-date 'findpos
11725 org-log-redeadline))
11726 (org-remove-timestamp-with-keyword org-deadline-string)
11727 (message "Item no longer has a deadline."))
11728 (org-add-planning-info 'deadline time 'closed)
11729 (when (and old-date org-log-redeadline
11730 (not (equal old-date
11731 (substring org-last-inserted-timestamp 1 -1))))
11732 (org-add-log-setup 'redeadline nil old-date 'findpos
11733 org-log-redeadline))
11734 (when repeater
11735 (save-excursion
11736 (org-back-to-heading t)
11737 (when (re-search-forward (concat org-deadline-string " "
11738 org-last-inserted-timestamp)
11739 (save-excursion
11740 (outline-next-heading) (point)) t)
11741 (goto-char (1- (match-end 0)))
11742 (insert " " repeater)
11743 (setq org-last-inserted-timestamp
11744 (concat (substring org-last-inserted-timestamp 0 -1)
11745 " " repeater
11746 (substring org-last-inserted-timestamp -1))))))
11747 (message "Deadline on %s" org-last-inserted-timestamp)))))
11749 (defun org-schedule (&optional remove time)
11750 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11751 With argument REMOVE, remove any scheduling date from the item.
11752 When TIME is set, it should be an internal time specification, and the
11753 scheduling will use the corresponding date."
11754 (interactive "P")
11755 (org-loop-over-siblings-in-active-region
11756 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11757 (repeater (and old-date
11758 (string-match
11760 old-date)
11761 (match-string 1 old-date))))
11762 (if remove
11763 (progn
11764 (when (and old-date org-log-reschedule)
11765 (org-add-log-setup 'delschedule nil old-date 'findpos
11766 org-log-reschedule))
11767 (org-remove-timestamp-with-keyword org-scheduled-string)
11768 (message "Item is no longer scheduled."))
11769 (org-add-planning-info 'scheduled time 'closed)
11770 (when (and old-date org-log-reschedule
11771 (not (equal old-date
11772 (substring org-last-inserted-timestamp 1 -1))))
11773 (org-add-log-setup 'reschedule nil old-date 'findpos
11774 org-log-reschedule))
11775 (when repeater
11776 (save-excursion
11777 (org-back-to-heading t)
11778 (when (re-search-forward (concat org-scheduled-string " "
11779 org-last-inserted-timestamp)
11780 (save-excursion
11781 (outline-next-heading) (point)) t)
11782 (goto-char (1- (match-end 0)))
11783 (insert " " repeater)
11784 (setq org-last-inserted-timestamp
11785 (concat (substring org-last-inserted-timestamp 0 -1)
11786 " " repeater
11787 (substring org-last-inserted-timestamp -1))))))
11788 (message "Scheduled to %s" org-last-inserted-timestamp)))))
11790 (defun org-get-scheduled-time (pom &optional inherit)
11791 "Get the scheduled time as a time tuple, of a format suitable
11792 for calling org-schedule with, or if there is no scheduling,
11793 returns nil."
11794 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11795 (when time
11796 (apply 'encode-time (org-parse-time-string time)))))
11798 (defun org-get-deadline-time (pom &optional inherit)
11799 "Get the deadline as a time tuple, of a format suitable for
11800 calling org-deadline with, or if there is no scheduling, returns
11801 nil."
11802 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11803 (when time
11804 (apply 'encode-time (org-parse-time-string time)))))
11806 (defun org-remove-timestamp-with-keyword (keyword)
11807 "Remove all time stamps with KEYWORD in the current entry."
11809 beg)
11810 (save-excursion
11811 (org-back-to-heading t)
11812 (setq beg (point))
11813 (outline-next-heading)
11814 (while (re-search-backward re beg t)
11815 (replace-match "")
11817 (equal (char-before) ?\ ))
11818 (backward-delete-char 1)
11820 (point-at-bol) (point-at-eol)))
11821 (delete-region (point-at-bol)
11822 (min (point-max) (1+ (point-at-eol))))))))))
11824 (defun org-add-planning-info (what &optional time &rest remove)
11825 "Insert new timestamp with keyword in the line directly after the headline.
11826 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11827 If non is given, the user is prompted for a date.
11828 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11829 be removed."
11830 (interactive)
11831 (let (org-time-was-given org-end-time-was-given ts
11832 end default-time default-input)
11834 (catch 'exit
11835 (when (and (not time) (memq what '(scheduled deadline)))
11836 ;; Try to get a default date/time from existing timestamp
11837 (save-excursion
11838 (org-back-to-heading t)
11839 (setq end (save-excursion (outline-next-heading) (point)))
11840 (when (re-search-forward (if (eq what 'scheduled)
11841 org-scheduled-time-regexp
11842 org-deadline-time-regexp)
11843 end t)
11844 (setq ts (match-string 1)
11845 default-time
11846 (apply 'encode-time (org-parse-time-string ts))
11847 default-input (and ts (org-get-compact-tod ts))))))
11848 (when what
11849 ;; If necessary, get the time from the user
11850 (setq time (or time (org-read-date nil 'to-time nil nil
11851 default-time default-input))))
11853 (when (and org-insert-labeled-timestamps-at-point
11854 (member what '(scheduled deadline)))
11855 (insert
11856 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11857 (org-insert-time-stamp time org-time-was-given
11858 nil nil nil (list org-end-time-was-given))
11859 (setq what nil))
11860 (save-excursion
11861 (save-restriction
11862 (let (col list elt ts buffer-invisibility-spec)
11863 (org-back-to-heading t)
11865 (goto-char (match-end 1))
11866 (setq col (current-column))
11867 (goto-char (match-end 0))
11869 (when (and (not what)
11870 (not (looking-at
11872 org-keyword-time-not-clock-regexp))))
11873 ;; Nothing to add, nothing to remove...... :-)
11874 (throw 'exit nil))
11875 (if (and (not (looking-at org-outline-regexp))
11878 (not (equal (match-string 1) org-clock-string)))
11879 (narrow-to-region (match-beginning 0) (match-end 0))
11881 (backward-char 1)
11882 (narrow-to-region (point) (point))
11883 (and org-adapt-indentation (org-indent-to-column col)))
11884 ;; Check if we have to remove something.
11885 (setq list (cons what remove))
11886 (while list
11887 (setq elt (pop list))
11888 (when (or (and (eq elt 'scheduled)
11889 (re-search-forward org-scheduled-time-regexp nil t))
11890 (and (eq elt 'deadline)
11891 (re-search-forward org-deadline-time-regexp nil t))
11892 (and (eq elt 'closed)
11893 (re-search-forward org-closed-time-regexp nil t)))
11894 (replace-match "")
11895 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11897 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11898 (when what
11899 (insert
11900 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11901 (cond ((eq what 'scheduled) org-scheduled-string)
11902 ((eq what 'deadline) org-deadline-string)
11903 ((eq what 'closed) org-closed-string))
11904 " ")
11905 (setq ts (org-insert-time-stamp
11906 time
11907 (or org-time-was-given
11908 (and (eq what 'closed) org-log-done-with-time))
11909 (eq what 'closed)
11910 nil nil (list org-end-time-was-given)))
11911 (insert
11912 (if (not (or (bolp) (eq (char-before) ?\ )
11913 (memq (char-after) '(32 10))
11914 (eobp))) " " ""))
11915 (end-of-line 1))
11916 (goto-char (point-min))
11917 (widen)
11920 (delete-region (1- (point)) (point-at-eol)))
11921 ts))))))
11923 (defvar org-log-note-marker (make-marker))
11924 (defvar org-log-note-purpose nil)
11925 (defvar org-log-note-state nil)
11926 (defvar org-log-note-previous-state nil)
11927 (defvar org-log-note-how nil)
11928 (defvar org-log-note-extra nil)
11929 (defvar org-log-note-window-configuration nil)
11930 (defvar org-log-note-return-to (make-marker))
11931 (defvar org-log-post-message nil
11932 "Message to be displayed after a log note has been stored.
11933 The auto-repeater uses this.")
11935 (defun org-add-note ()
11936 "Add a note to the current entry.
11937 This is done in the same way as adding a state change note."
11938 (interactive)
11939 (org-add-log-setup 'note nil nil 'findpos nil))
11941 (defvar org-property-end-re)
11942 (defun org-add-log-setup (&optional purpose state prev-state
11943 findpos how extra)
11944 "Set up the post command hook to take a note.
11945 If this is about to TODO state change, the new state is expected in STATE.
11946 When FINDPOS is non-nil, find the correct position for the note in
11947 the current entry. If not, assume that it can be inserted at point.
11948 HOW is an indicator what kind of note should be created.
11949 EXTRA is additional text that will be inserted into the notes buffer."
11950 (let* ((org-log-into-drawer (org-log-into-drawer))
11951 (drawer (cond ((stringp org-log-into-drawer)
11952 org-log-into-drawer)
11953 (org-log-into-drawer "LOGBOOK")
11954 (t nil))))
11955 (save-restriction
11956 (save-excursion
11957 (when findpos
11958 (org-back-to-heading t)
11959 (narrow-to-region (point) (save-excursion
11960 (outline-next-heading) (point)))
11964 (goto-char (match-end 0))
11965 (cond
11966 (drawer
11968 nil t)
11969 (progn
11970 (goto-char (match-end 0))
11971 (or org-log-states-order-reversed
11972 (and (re-search-forward org-property-end-re nil t)
11973 (goto-char (1- (match-beginning 0))))))
11975 (beginning-of-line 0)
11976 (org-indent-line-function)
11977 (beginning-of-line 2)
11978 (org-indent-line-function)
11979 (end-of-line 0)))
11980 ((and org-log-state-notes-insert-after-drawers
11981 (save-excursion
11982 (forward-line) (looking-at org-drawer-regexp)))
11983 (forward-line)
11984 (while (looking-at org-drawer-regexp)
11985 (goto-char (match-end 0))
11986 (re-search-forward org-property-end-re (point-max) t)
11987 (forward-line))
11988 (forward-line -1)))
11989 (unless org-log-states-order-reversed
11991 (org-skip-over-state-notes)
11993 (move-marker org-log-note-marker (point))
11994 (setq org-log-note-purpose purpose
11995 org-log-note-state state
11996 org-log-note-previous-state prev-state
11997 org-log-note-how how
11998 org-log-note-extra extra)
11999 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12001 (defun org-skip-over-state-notes ()
12002 "Skip past the list of State notes in an entry."
12004 (when (ignore-errors (goto-char (org-in-item-p)))
12005 (let* ((struct (org-list-struct))
12006 (prevs (org-list-prevs-alist struct)))
12008 (goto-char (or (org-list-get-next-item (point) struct prevs)
12009 (org-list-get-item-end (point) struct)))))))
12011 (defun org-add-log-note (&optional purpose)
12012 "Pop up a window for taking a note, and add this note later at point."
12013 (remove-hook 'post-command-hook 'org-add-log-note)
12014 (setq org-log-note-window-configuration (current-window-configuration))
12015 (delete-other-windows)
12016 (move-marker org-log-note-return-to (point))
12017 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12018 (goto-char org-log-note-marker)
12019 (org-switch-to-buffer-other-window "*Org Note*")
12020 (erase-buffer)
12021 (if (memq org-log-note-how '(time state))
12022 (let (current-prefix-arg) (org-store-log-note))
12023 (let ((org-inhibit-startup t)) (org-mode))
12024 (insert (format "# Insert note for %s.
12026 (cond
12027 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12028 ((eq org-log-note-purpose 'done) "closed todo item")
12029 ((eq org-log-note-purpose 'state)
12031 (or org-log-note-previous-state "")
12032 (or org-log-note-state "")))
12033 ((eq org-log-note-purpose 'reschedule)
12034 "rescheduling")
12035 ((eq org-log-note-purpose 'delschedule)
12036 "no longer scheduled")
12037 ((eq org-log-note-purpose 'redeadline)
12038 "changing deadline")
12039 ((eq org-log-note-purpose 'deldeadline)
12040 "removing deadline")
12041 ((eq org-log-note-purpose 'refile)
12042 "refiling")
12043 ((eq org-log-note-purpose 'note)
12044 "this entry")
12045 (t (error "This should not happen")))))
12046 (if org-log-note-extra (insert org-log-note-extra))
12047 (org-set-local 'org-finish-function 'org-store-log-note)))
12049 (defvar org-note-abort nil) ; dynamically scoped
12050 (defun org-store-log-note ()
12051 "Finish taking a log note, and insert it to where it belongs."
12052 (let ((txt (buffer-string))
12053 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12054 lines ind bul)
12055 (kill-buffer (current-buffer))
12057 (setq txt (replace-match "" t t txt)))
12059 (setq txt (replace-match "" t t txt)))
12062 (setq note
12063 (org-replace-escapes
12064 note
12065 (list (cons "%u" (user-login-name))
12066 (cons "%U" user-full-name)
12067 (cons "%t" (format-time-string
12068 (org-time-stamp-format 'long 'inactive)
12069 (current-time)))
12070 (cons "%T" (format-time-string
12071 (org-time-stamp-format 'long nil)
12072 (current-time)))
12073 (cons "%s" (if org-log-note-state
12075 ""))
12076 (cons "%S" (if org-log-note-previous-state
12080 (push note lines))
12081 (when (or current-prefix-arg org-note-abort)
12082 (when org-log-into-drawer
12083 (org-remove-empty-drawer-at
12084 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12085 org-log-note-marker))
12086 (setq lines nil))
12087 (when lines
12088 (with-current-buffer (marker-buffer org-log-note-marker)
12089 (save-excursion
12090 (goto-char org-log-note-marker)
12091 (move-marker org-log-note-marker nil)
12092 (end-of-line 1)
12094 (setq ind (save-excursion
12095 (if (ignore-errors (goto-char (org-in-item-p)))
12096 (let ((struct (org-list-struct)))
12097 (org-list-get-ind
12098 (org-list-get-top-point struct) struct))
12100 (cond
12101 ((and (org-at-heading-p)
12102 org-adapt-indentation)
12103 (1+ (org-current-level)))
12104 ((org-at-heading-p) 0)
12105 (t (org-get-indentation))))))
12106 (setq bul (org-list-bullet-string "-"))
12107 (org-indent-line-to ind)
12108 (insert bul (pop lines))
12109 (let ((ind-body (+ (length bul) ind)))
12110 (while lines
12112 (org-indent-line-to ind-body)
12113 (insert (pop lines))))
12114 (message "Note stored")
12115 (org-back-to-heading t)
12116 (org-cycle-hide-drawers 'children)))))
12117 (set-window-configuration org-log-note-window-configuration)
12118 (with-current-buffer (marker-buffer org-log-note-return-to)
12119 (goto-char org-log-note-return-to))
12120 (move-marker org-log-note-return-to nil)
12121 (and org-log-post-message (message "%s" org-log-post-message)))
12123 (defun org-remove-empty-drawer-at (drawer pos)
12124 "Remove an empty drawer DRAWER at position POS.
12125 POS may also be a marker."
12126 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12127 (save-excursion
12128 (save-restriction
12129 (widen)
12130 (goto-char pos)
12131 (if (org-in-regexp
12133 (replace-match ""))))))
12135 (defun org-sparse-tree (&optional arg)
12136 "Create a sparse tree, prompt for the details.
12137 This command can create sparse trees. You first need to select the type
12138 of match used to create the tree:
12140 t Show all TODO entries.
12141 T Show entries with a specific TODO keyword.
12142 m Show entries selected by a tags/property match.
12143 p Enter a property name and its value (both with completion on existing
12144 names/values) and show entries with that property.
12145 r Show entries matching a regular expression (`/' can be used as well)
12146 d Show deadlines due within `org-deadline-warning-days'.
12147 b Show deadlines and scheduled items before a date.
12148 a Show deadlines and scheduled items after a date."
12149 (interactive "P")
12150 (let (ans kwd value)
12151 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12152 (setq ans (read-char-exclusive))
12153 (cond
12154 ((equal ans ?d)
12155 (call-interactively 'org-check-deadlines))
12156 ((equal ans ?b)
12157 (call-interactively 'org-check-before-date))
12158 ((equal ans ?a)
12159 (call-interactively 'org-check-after-date))
12160 ((equal ans ?t)
12161 (org-show-todo-tree nil))
12162 ((equal ans ?T)
12163 (org-show-todo-tree '(4)))
12164 ((member ans '(?T ?m))
12165 (call-interactively 'org-match-sparse-tree))
12166 ((member ans '(?p ?P))
12167 (setq kwd (org-icompleting-read "Property: "
12168 (mapcar 'list (org-buffer-property-keys))))
12169 (setq value (org-icompleting-read "Value: "
12170 (mapcar 'list (org-property-values kwd))))
12173 (org-match-sparse-tree arg (concat kwd "=" value)))
12174 ((member ans '(?r ?R ?/))
12175 (call-interactively 'org-occur))
12178 (defvar org-occur-highlights nil
12179 "List of overlays used for occur matches.")
12180 (make-variable-buffer-local 'org-occur-highlights)
12181 (defvar org-occur-parameters nil
12182 "Parameters of the active org-occur calls.
12183 This is a list, each call to org-occur pushes as cons cell,
12184 containing the regular expression and the callback, onto the list.
12185 The list can contain several entries if `org-occur' has been called
12186 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12187 will only contain one set of parameters. When the highlights are
12188 removed (for example with `C-c C-c', or with the next edit (depending
12189 on `org-remove-highlights-with-change'), this variable is emptied
12190 as well.")
12191 (make-variable-buffer-local 'org-occur-parameters)
12193 (defun org-occur (regexp &optional keep-previous callback)
12194 "Make a compact tree which shows all matches of REGEXP.
12195 The tree will show the lines where the regexp matches, and all higher
12196 headlines above the match. It will also show the heading after the match,
12197 to make sure editing the matching entry is easy.
12198 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12199 call to `org-occur' will be kept, to allow stacking of calls to this
12200 command.
12201 If CALLBACK is non-nil, it is a function which is called to confirm
12202 that the match should indeed be shown."
12204 (when (equal regexp "")
12205 (error "Regexp cannot be empty"))
12206 (unless keep-previous
12207 (org-remove-occur-highlights nil nil t))
12208 (push (cons regexp callback) org-occur-parameters)
12209 (let ((cnt 0))
12210 (save-excursion
12211 (goto-char (point-min))
12212 (if (or (not keep-previous) ; do not want to keep
12213 (not org-occur-highlights)) ; no previous matches
12214 ;; hide everything
12215 (org-overview))
12216 (while (re-search-forward regexp nil t)
12217 (when (or (not callback)
12218 (save-match-data (funcall callback)))
12219 (setq cnt (1+ cnt))
12220 (when org-highlight-sparse-tree-matches
12221 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12222 (org-show-context 'occur-tree))))
12223 (when org-remove-highlights-with-change
12224 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12225 nil 'local))
12226 (unless org-sparse-tree-open-archived-trees
12227 (org-hide-archived-subtrees (point-min) (point-max)))
12228 (run-hooks 'org-occur-hook)
12229 (if (org-called-interactively-p 'interactive)
12230 (message "%d match(es) for regexp %s" cnt regexp))
12231 cnt))
12233 (defun org-occur-next-match (&optional n reset)
12234 "Function for `next-error-function' to find sparse tree matches.
12235 N is the number of matches to move, when negative move backwards.
12236 RESET is entirely ignored - this function always goes back to the
12237 starting point when no match is found."
12238 (let* ((limit (if (< n 0) (point-min) (point-max)))
12239 (search-func (if (< n 0)
12240 'previous-single-char-property-change
12241 'next-single-char-property-change))
12242 (n (abs n))
12243 (pos (point))
12244 p1)
12245 (catch 'exit
12246 (while (setq p1 (funcall search-func (point) 'org-type))
12247 (when (equal p1 limit)
12248 (goto-char pos)
12249 (error "No more matches"))
12250 (when (equal (get-char-property p1 'org-type) 'org-occur)
12251 (setq n (1- n))
12252 (when (= n 0)
12253 (goto-char p1)
12254 (throw 'exit (point))))
12255 (goto-char p1))
12256 (goto-char p1)
12257 (error "No more matches"))))
12259 (defun org-show-context (&optional key)
12260 "Make sure point and context are visible.
12261 How much context is shown depends upon the variables
12262 `org-show-hierarchy-above', `org-show-following-heading'. and
12263 `org-show-siblings'."
12264 (let ((heading-p (org-on-heading-p t))
12265 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12266 (following-p (org-get-alist-option org-show-following-heading key))
12267 (entry-p (org-get-alist-option org-show-entry-below key))
12268 (siblings-p (org-get-alist-option org-show-siblings key)))
12269 (catch 'exit
12270 ;; Show heading or entry text
12271 (if (and heading-p (not entry-p))
12272 (org-flag-heading nil) ; only show the heading
12273 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12274 (org-show-hidden-entry))) ; show entire entry
12275 (when following-p
12276 ;; Show next sibling, or heading below text
12277 (save-excursion
12278 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12279 (org-flag-heading nil))))
12280 (when siblings-p (org-show-siblings))
12281 (when hierarchy-p
12282 ;; show all higher headings, possibly with siblings
12283 (save-excursion
12284 (while (and (condition-case nil
12285 (progn (org-up-heading-all 1) t)
12286 (error nil))
12287 (not (bobp)))
12288 (org-flag-heading nil)
12289 (when siblings-p (org-show-siblings))))))))
12291 (defvar org-reveal-start-hook nil
12292 "Hook run before revealing a location.")
12294 (defun org-reveal (&optional siblings)
12295 "Show current entry, hierarchy above it, and the following headline.
12296 This can be used to show a consistent set of context around locations
12297 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12298 not t for the search context.
12300 With optional argument SIBLINGS, on each level of the hierarchy all
12301 siblings are shown. This repairs the tree structure to what it would
12302 look like when opened with hierarchical calls to `org-cycle'.
12304 go to the parent and show the
12305 entire tree."
12306 (interactive "P")
12307 (run-hooks 'org-reveal-start-hook)
12308 (let ((org-show-hierarchy-above t)
12309 (org-show-following-heading t)
12310 (org-show-siblings (if siblings t org-show-siblings)))
12311 (org-show-context nil))
12312 (when (equal siblings '(16))
12313 (save-excursion
12314 (when (org-up-heading-safe)
12315 (org-show-subtree)
12316 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12318 (defun org-highlight-new-match (beg end)
12319 "Highlight from BEG to END and mark the highlight is an occur headline."
12320 (let ((ov (make-overlay beg end)))
12321 (overlay-put ov 'face 'secondary-selection)
12322 (overlay-put ov 'org-type 'org-occur)
12323 (push ov org-occur-highlights)))
12325 (defun org-remove-occur-highlights (&optional beg end noremove)
12326 "Remove the occur highlights from the buffer.
12327 BEG and END are ignored. If NOREMOVE is nil, remove this function
12328 from the `before-change-functions' in the current buffer."
12329 (interactive)
12330 (unless org-inhibit-highlight-removal
12331 (mapc 'delete-overlay org-occur-highlights)
12332 (setq org-occur-highlights nil)
12333 (setq org-occur-parameters nil)
12334 (unless noremove
12335 (remove-hook 'before-change-functions
12336 'org-remove-occur-highlights 'local))))
12338 ;;;; Priorities
12341 "Regular expression matching the priority indicator.")
12343 (defvar org-remove-priority-next-time nil)
12345 (defun org-priority-up ()
12346 "Increase the priority of the current item."
12347 (interactive)
12348 (org-priority 'up))
12350 (defun org-priority-down ()
12351 "Decrease the priority of the current item."
12352 (interactive)
12353 (org-priority 'down))
12355 (defun org-priority (&optional action)
12356 "Change the priority of an item by ARG.
12357 ACTION can be `set', `up', `down', or a character."
12358 (interactive)
12359 (unless org-enable-priority-commands
12360 (error "Priority commands are disabled"))
12361 (setq action (or action 'set))
12362 (let (current new news have remove)
12363 (save-excursion
12364 (org-back-to-heading t)
12365 (if (looking-at org-priority-regexp)
12366 (setq current (string-to-char (match-string 2))
12367 have t))
12368 (cond
12369 ((eq action 'remove)
12370 (setq remove t new ?\ ))
12371 ((or (eq action 'set)
12372 (if (featurep 'xemacs) (characterp action) (integerp action)))
12373 (if (not (eq action 'set))
12374 (setq new action)
12375 (message "Priority %c-%c, SPC to remove: "
12376 org-highest-priority org-lowest-priority)
12377 (save-match-data
12378 (setq new (read-char-exclusive))))
12379 (if (and (= (upcase org-highest-priority) org-highest-priority)
12380 (= (upcase org-lowest-priority) org-lowest-priority))
12381 (setq new (upcase new)))
12382 (cond ((equal new ?\ ) (setq remove t))
12383 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12384 (error "Priority must be between `%c' and `%c'"
12385 org-highest-priority org-lowest-priority))))
12386 ((eq action 'up)
12387 (setq new (if have
12388 (1- current) ; normal cycling
12389 ;; last priority was empty
12390 (if (eq last-command this-command)
12391 org-lowest-priority ; wrap around empty to lowest
12392 ;; default
12393 (if org-priority-start-cycle-with-default
12394 org-default-priority
12395 (1- org-default-priority))))))
12396 ((eq action 'down)
12397 (setq new (if have
12398 (1+ current) ; normal cycling
12399 ;; last priority was empty
12400 (if (eq last-command this-command)
12401 org-highest-priority ; wrap around empty to highest
12402 ;; default
12403 (if org-priority-start-cycle-with-default
12404 org-default-priority
12405 (1+ org-default-priority))))))
12406 (t (error "Invalid action")))
12407 (if (or (< (upcase new) org-highest-priority)
12408 (> (upcase new) org-lowest-priority))
12409 (if (and (memq action '(up down))
12410 (not have) (not (eq last-command this-command)))
12411 ;; `new' is from default priority
12412 (error
12413 "The default can not be set, see `org-default-priority' why")
12414 ;; normal cycling: `new' is beyond highest/lowest priority
12415 ;; and is wrapped around to the empty priority
12416 (setq remove t)))
12417 (setq news (format "%c" new))
12418 (if have
12419 (if remove
12420 (replace-match "" t t nil 1)
12421 (replace-match news t t nil 2))
12422 (if remove
12423 (error "No priority cookie found in line")
12424 (let ((case-fold-search nil))
12425 (looking-at org-todo-line-regexp))
12426 (if (match-end 2)
12427 (progn
12428 (goto-char (match-end 2))
12429 (insert " [#" news "]"))
12430 (goto-char (match-beginning 3))
12431 (insert "[#" news "] "))))
12432 (org-preserve-lc (org-set-tags nil 'align)))
12433 (if remove
12434 (message "Priority removed")
12435 (message "Priority of current item set to %s" news))))
12437 (defun org-get-priority (s)
12438 "Find priority cookie and return priority."
12439 (if (functionp org-get-priority-function)
12440 (funcall org-get-priority-function)
12441 (save-match-data
12442 (if (not (string-match org-priority-regexp s))
12443 (* 1000 (- org-lowest-priority org-default-priority))
12444 (* 1000 (- org-lowest-priority
12445 (string-to-char (match-string 2 s))))))))
12447 ;;;; Tags
12449 (defvar org-agenda-archives-mode)
12450 (defvar org-map-continue-from nil
12451 "Position from where mapping should continue.
12452 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12454 (defvar org-scanner-tags nil
12455 "The current tag list while the tags scanner is running.")
12456 (defvar org-trust-scanner-tags nil
12457 "Should `org-get-tags-at' use the tags for the scanner.
12458 This is for internal dynamical scoping only.
12459 When this is non-nil, the function `org-get-tags-at' will return the value
12460 of `org-scanner-tags' instead of building the list by itself. This
12461 can lead to large speed-ups when the tags scanner is used in a file with
12462 many entries, and when the list of tags is retrieved, for example to
12463 obtain a list of properties. Building the tags list for each entry in such
12464 a file becomes an N^2 operation - but with this variable set, it scales
12465 as N.")
12467 (defun org-scan-tags (action matcher &optional todo-only)
12468 "Scan headline tags with inheritance and produce output ACTION.
12470 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12471 or `agenda' to produce an entry list for an agenda view. It can also be
12472 a Lisp form or a function that should be called at each matched headline, in
12473 this case the return value is a list of all return values from these calls.
12475 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12476 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12477 only lines with a TODO keyword are included in the output."
12478 (require 'org-agenda)
12481 (org-re
12483 (props (list 'face 'default
12484 'done-face 'org-agenda-done
12485 'undone-face 'default
12486 'mouse-face 'highlight
12487 'org-not-done-regexp org-not-done-regexp
12488 'org-todo-regexp org-todo-regexp
12489 'help-echo
12490 (format "mouse-2 or RET jump to org file %s"
12491 (abbreviate-file-name
12492 (or (buffer-file-name (buffer-base-buffer))
12493 (buffer-name (buffer-base-buffer)))))))
12494 (case-fold-search nil)
12495 (org-map-continue-from nil)
12496 lspos tags tags-list
12497 (tags-alist (list (cons 0 org-file-tags)))
12498 (llast 0) rtn rtn1 level category i txt
12499 todo marker entry priority)
12500 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12501 (setq action (list 'lambda nil action)))
12502 (save-excursion
12503 (goto-char (point-min))
12504 (when (eq action 'sparse-tree)
12505 (org-overview)
12506 (org-remove-occur-highlights))
12507 (while (re-search-forward re nil t)
12508 (catch :skip
12509 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12510 tags (if (match-end 4) (org-match-string-no-properties 4)))
12511 (goto-char (setq lspos (match-beginning 0)))
12512 (setq level (org-reduced-level (funcall outline-level))
12513 category (org-get-category))
12514 (setq i llast llast level)
12515 ;; remove tag lists from same and sublevels
12516 (while (>= i level)
12517 (when (setq entry (assoc i tags-alist))
12518 (setq tags-alist (delete entry tags-alist)))
12519 (setq i (1- i)))
12520 ;; add the next tags
12521 (when tags
12522 (setq tags (org-split-string tags ":")
12523 tags-alist
12524 (cons (cons level tags) tags-alist)))
12525 ;; compile tags for current headline
12526 (setq tags-list
12527 (if org-use-tag-inheritance
12528 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12529 tags)
12530 org-scanner-tags tags-list)
12531 (when org-use-tag-inheritance
12532 (setcdr (car tags-alist)
12533 (mapcar (lambda (x)
12534 (setq x (copy-sequence x))
12535 (org-add-prop-inherited x))
12536 (cdar tags-alist))))
12537 (when (and tags org-use-tag-inheritance
12538 (or (not (eq t org-use-tag-inheritance))
12539 org-tags-exclude-from-inheritance))
12540 ;; selective inheritance, remove uninherited ones
12541 (setcdr (car tags-alist)
12542 (org-remove-uninherited-tags (cdar tags-alist))))
12543 (when (and
12545 ;; eval matcher only when the todo condition is OK
12546 (and (or (not todo-only) (member todo org-not-done-keywords))
12547 (let ((case-fold-search t)) (eval matcher)))
12549 ;; Call the skipper, but return t if it does not skip,
12550 ;; so that the `and' form continues evaluating
12551 (progn
12552 (unless (eq action 'sparse-tree) (org-agenda-skip))
12553 t)
12555 ;; Check if timestamps are deselecting this entry
12556 (or (not todo-only)
12557 (and (member todo org-not-done-keywords)
12558 (or (not org-agenda-tags-todo-honor-ignore-options)
12559 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12561 ;; Extra check for the archive tag
12562 ;; FIXME: Does the skipper already do this????
12563 (or
12564 (not (member org-archive-tag tags-list))
12565 ;; we have an archive tag, should we use this anyway?
12566 (or (not org-agenda-skip-archived-trees)
12567 (and (eq action 'agenda) org-agenda-archives-mode))))
12569 ;; select this headline
12571 (cond
12572 ((eq action 'sparse-tree)
12573 (and org-highlight-sparse-tree-matches
12574 (org-get-heading) (match-end 0)
12575 (org-highlight-new-match
12576 (match-beginning 0) (match-beginning 1)))
12577 (org-show-context 'tags-tree))
12578 ((eq action 'agenda)
12579 (setq txt (org-format-agenda-item
12580 ""
12581 (concat
12582 (if (eq org-tags-match-list-sublevels 'indented)
12583 (make-string (1- level) ?.) "")
12584 (org-get-heading))
12585 category
12586 tags-list
12587 )
12588 priority (org-get-priority txt))
12589 (goto-char lspos)
12590 (setq marker (org-agenda-new-marker))
12591 (org-add-props txt props
12592 'org-marker marker 'org-hd-marker marker 'org-category category
12593 'todo-state todo
12594 'priority priority 'type "tagsmatch")
12595 (push txt rtn))
12596 ((functionp action)
12597 (setq org-map-continue-from nil)
12598 (save-excursion
12599 (setq rtn1 (funcall action))
12600 (push rtn1 rtn)))
12601 (t (error "Invalid action")))
12603 ;; if we are to skip sublevels, jump to end of subtree
12604 (unless org-tags-match-list-sublevels
12605 (org-end-of-subtree t)
12606 (backward-char 1))))
12607 ;; Get the correct position from where to continue
12608 (if org-map-continue-from
12609 (goto-char org-map-continue-from)
12610 (and (= (point) lspos) (end-of-line 1)))))
12611 (when (and (eq action 'sparse-tree)
12612 (not org-sparse-tree-open-archived-trees))
12613 (org-hide-archived-subtrees (point-min) (point-max)))
12614 (nreverse rtn)))
12616 (defun org-remove-uninherited-tags (tags)
12617 "Remove all tags that are not inherited from the list TAGS."
12618 (cond
12619 ((eq org-use-tag-inheritance t)
12620 (if org-tags-exclude-from-inheritance
12621 (org-delete-all org-tags-exclude-from-inheritance tags)
12622 tags))
12623 ((not org-use-tag-inheritance) nil)
12624 ((stringp org-use-tag-inheritance)
12625 (delq nil (mapcar
12626 (lambda (x)
12627 (if (and (string-match org-use-tag-inheritance x)
12628 (not (member x org-tags-exclude-from-inheritance)))
12629 x nil))
12630 tags)))
12631 ((listp org-use-tag-inheritance)
12632 (delq nil (mapcar
12633 (lambda (x)
12634 (if (member x org-use-tag-inheritance) x nil))
12635 tags)))))
12637 (defvar todo-only) ;; dynamically scoped
12639 (defun org-match-sparse-tree (&optional todo-only match)
12640 "Create a sparse tree according to tags string MATCH.
12641 MATCH can contain positive and negative selection of tags, like
12643 If optional argument TODO-ONLY is non-nil, only select lines that are
12644 also TODO lines."
12645 (interactive "P")
12646 (org-prepare-agenda-buffers (list (current-buffer)))
12647 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12649 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12651 (defvar org-cached-props nil)
12652 (defun org-cached-entry-get (pom property)
12653 (if (or (eq t org-use-property-inheritance)
12654 (and (stringp org-use-property-inheritance)
12655 (string-match org-use-property-inheritance property))
12656 (and (listp org-use-property-inheritance)
12657 (member property org-use-property-inheritance)))
12658 ;; Caching is not possible, check it directly
12659 (org-entry-get pom property 'inherit)
12660 ;; Get all properties, so that we can do complicated checks easily
12661 (cdr (assoc property (or org-cached-props
12662 (setq org-cached-props
12663 (org-entry-properties pom)))))))
12665 (defun org-global-tags-completion-table (&optional files)
12666 "Return the list of all tags in all agenda buffer/files.
12667 Optional FILES argument is a list of files to which can be used
12668 instead of the agenda files."
12669 (save-excursion
12670 (org-uniquify
12671 (delq nil
12672 (apply 'append
12673 (mapcar
12674 (lambda (file)
12675 (set-buffer (find-file-noselect file))
12676 (append (org-get-buffer-tags)
12677 (mapcar (lambda (x) (if (stringp (car-safe x))
12678 (list (car-safe x)) nil))
12679 org-tag-alist)))
12680 (if (and files (car files))
12681 files
12682 (org-agenda-files))))))))
12684 (defun org-make-tags-matcher (match)
12685 "Create the TAGS/TODO matcher form for the selection string MATCH."
12686 ;; todo-only is scoped dynamically into this function, and the function
12687 ;; may change it if the matcher asks for it.
12688 (unless match
12689 ;; Get a new match request, with completion
12690 (let ((org-last-tags-completion-table
12691 (org-global-tags-completion-table)))
12692 (setq match (org-completing-read-no-i
12693 "Match: " 'org-tags-completion-function nil nil nil
12694 'org-tags-history))))
12696 ;; Parse the string and create a lisp form
12697 (let ((match0 match)
12698 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12699 minus tag mm
12700 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12701 orterms term orlist re-p str-p level-p level-op time-p
12702 prop-p pn pv po gv rest)
12703 (if (string-match "/+" match)
12704 ;; match contains also a todo-matching request
12705 (progn
12706 (setq tagsmatch (substring match 0 (match-beginning 0))
12707 todomatch (substring match (match-end 0)))
12708 (if (string-match "^!" todomatch)
12709 (setq todo-only t todomatch (substring todomatch 1)))
12711 (setq todomatch nil)))
12712 ;; only matching tags
12713 (setq tagsmatch match todomatch nil))
12715 ;; Make the tags matcher
12717 (setq tagsmatcher t)
12718 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12719 (while (setq term (pop orterms))
12721 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12722 (while (string-match re term)
12723 (setq rest (substring term (match-end 0))
12724 minus (and (match-end 1)
12725 (equal (match-string 1 term) "-"))
12726 tag (save-match-data (replace-regexp-in-string
12728 (match-string 2 term)))
12729 re-p (equal (string-to-char tag) ?{)
12730 level-p (match-end 4)
12731 prop-p (match-end 5)
12732 mm (cond
12733 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12734 (level-p
12735 (setq level-op (org-op-to-function (match-string 3 term)))
12736 `(,level-op level ,(string-to-number
12737 (match-string 4 term))))
12738 (prop-p
12739 (setq pn (match-string 5 term)
12740 po (match-string 6 term)
12741 pv (match-string 7 term)
12742 re-p (equal (string-to-char pv) ?{)
12744 time-p (save-match-data
12746 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12747 (if time-p (setq pv (org-matcher-time pv)))
12748 (setq po (org-op-to-function po (if time-p 'time str-p)))
12749 (cond
12750 ((equal pn "CATEGORY")
12751 (setq gv '(get-text-property (point) 'org-category)))
12752 ((equal pn "TODO")
12753 (setq gv 'todo))
12754 (t
12755 (setq gv `(org-cached-entry-get nil ,pn))))
12756 (if re-p
12757 (if (eq po 'org<>)
12758 `(not (string-match ,pv (or ,gv "")))
12759 `(string-match ,pv (or ,gv "")))
12760 (if str-p
12761 `(,po (or ,gv "") ,pv)
12762 `(,po (string-to-number (or ,gv ""))
12763 ,(string-to-number pv) ))))
12764 (t `(member ,tag tags-list)))
12765 mm (if minus (list 'not mm) mm)
12766 term rest)
12767 (push mm tagsmatcher))
12768 (push (if (> (length tagsmatcher) 1)
12769 (cons 'and tagsmatcher)
12770 (car tagsmatcher))
12771 orlist)
12772 (setq tagsmatcher nil))
12773 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12774 (setq tagsmatcher
12775 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12776 ;; Make the todo matcher
12778 (setq todomatcher t)
12779 (setq orterms (org-split-string todomatch "|") orlist nil)
12780 (while (setq term (pop orterms))
12781 (while (string-match re term)
12782 (setq minus (and (match-end 1)
12783 (equal (match-string 1 term) "-"))
12784 kwd (match-string 2 term)
12785 re-p (equal (string-to-char kwd) ?{)
12786 term (substring term (match-end 0))
12787 mm (if re-p
12788 `(string-match ,(substring kwd 1 -1) todo)
12789 (list 'equal 'todo kwd))
12790 mm (if minus (list 'not mm) mm))
12791 (push mm todomatcher))
12792 (push (if (> (length todomatcher) 1)
12793 (cons 'and todomatcher)
12794 (car todomatcher))
12795 orlist)
12796 (setq todomatcher nil))
12797 (setq todomatcher (if (> (length orlist) 1)
12798 (cons 'or orlist) (car orlist))))
12800 ;; Return the string and lisp forms of the matcher
12801 (setq matcher (if todomatcher
12802 (list 'and tagsmatcher todomatcher)
12803 tagsmatcher))
12804 (cons match0 matcher)))
12806 (defun org-op-to-function (op &optional stringp)
12807 "Turn an operator into the appropriate function."
12808 (setq op
12809 (cond
12810 ((equal op "<" ) '(< string< org-time<))
12811 ((equal op ">" ) '(> org-string> org-time>))
12812 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12813 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12814 ((member op '("=" "==")) '(= string= org-time=))
12815 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12816 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12818 (defun org<> (a b) (not (= a b)))
12819 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12820 (defun org-string>= (a b) (not (string< a b)))
12821 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12822 (defun org-string<> (a b) (not (string= a b)))
12823 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12824 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12825 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12826 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12827 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12828 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12829 (defun org-2ft (s)
12830 "Convert S to a floating point time.
12831 If S is already a number, just return it. If it is a string, parse
12832 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12833 (cond
12834 ((numberp s) s)
12835 ((stringp s)
12836 (condition-case nil
12837 (float-time (apply 'encode-time (org-parse-time-string s)))
12838 (error 0.)))
12839 (t 0.)))
12841 (defun org-time-today ()
12842 "Time in seconds today at 0:00.
12843 Returns the float number of seconds since the beginning of the
12844 epoch to the beginning of today (00:00)."
12845 (float-time (apply 'encode-time
12846 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12848 (defun org-matcher-time (s)
12849 "Interpret a time comparison value."
12850 (save-match-data
12851 (cond
12852 ((string= s "<now>") (float-time))
12853 ((string= s "<today>") (org-time-today))
12854 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12855 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12857 (+ (org-time-today)
12858 (* (string-to-number (match-string 1 s))
12859 (cdr (assoc (match-string 2 s)
12860 '(("d" . 86400.0) ("w" . 604800.0)
12861 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12862 (t (org-2ft s)))))
12864 (defun org-match-any-p (re list)
12865 "Does re match any element of list?"
12866 (setq list (mapcar (lambda (x) (string-match re x)) list))
12867 (delq nil list))
12869 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12870 (defvar org-tags-overlay (make-overlay 1 1))
12871 (org-detach-overlay org-tags-overlay)
12873 (defun org-get-local-tags-at (&optional pos)
12874 "Get a list of tags defined in the current headline."
12875 (org-get-tags-at pos 'local))
12877 (defun org-get-local-tags ()
12878 "Get a list of tags defined in the current headline."
12879 (org-get-tags-at nil 'local))
12881 (defun org-get-tags-at (&optional pos local)
12882 "Get a list of all headline tags applicable at POS.
12883 POS defaults to point. If tags are inherited, the list contains
12884 the targets in the same sequence as the headlines appear, i.e.
12885 the tags of the current headline come last.
12886 When LOCAL is non-nil, only return tags from the current headline,
12887 ignore inherited ones."
12888 (interactive)
12889 (if (and org-trust-scanner-tags
12890 (or (not pos) (equal pos (point)))
12891 (not local))
12892 org-scanner-tags
12893 (let (tags ltags lastpos parent)
12894 (save-excursion
12895 (save-restriction
12896 (widen)
12897 (goto-char (or pos (point)))
12898 (save-match-data
12899 (catch 'done
12900 (condition-case nil
12901 (progn
12902 (org-back-to-heading t)
12903 (while (not (equal lastpos (point)))
12904 (setq lastpos (point))
12905 (when (looking-at
12907 (setq ltags (org-split-string
12908 (org-match-string-no-properties 1) ":"))
12909 (when parent
12910 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12911 (setq tags (append
12912 (if parent
12913 (org-remove-uninherited-tags ltags)
12914 ltags)
12915 tags)))
12916 (or org-use-tag-inheritance (throw 'done t))
12917 (if local (throw 'done t))
12918 (or (org-up-heading-safe) (error nil))
12919 (setq parent t)))
12920 (error nil)))))
12921 (if local
12922 tags
12923 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12925 (defun org-add-prop-inherited (s)
12926 (add-text-properties 0 (length s) '(inherited t) s)
12927 s)
12929 (defun org-toggle-tag (tag &optional onoff)
12930 "Toggle the tag TAG for the current line.
12931 If ONOFF is `on' or `off', don't toggle but set to this state."
12932 (let (res current)
12933 (save-excursion
12934 (org-back-to-heading t)
12936 (point-at-eol) t)
12937 (progn
12938 (setq current (match-string 1))
12939 (replace-match ""))
12940 (setq current ""))
12941 (setq current (nreverse (org-split-string current ":")))
12942 (cond
12943 ((eq onoff 'on)
12944 (setq res t)
12945 (or (member tag current) (push tag current)))
12946 ((eq onoff 'off)
12947 (or (not (member tag current)) (setq current (delete tag current))))
12948 (t (if (member tag current)
12949 (setq current (delete tag current))
12950 (setq res t)
12951 (push tag current))))
12952 (end-of-line 1)
12953 (if current
12954 (progn
12955 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12956 (org-set-tags nil t))
12957 (delete-horizontal-space))
12958 (run-hooks 'org-after-tags-change-hook))
12959 res))
12961 (defun org-align-tags-here (to-col)
12962 ;; Assumes that this is a headline
12963 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12964 (beginning-of-line 1)
12966 (< pos (match-beginning 2)))
12967 (progn
12968 (setq tags-l (- (match-end 2) (match-beginning 2)))
12969 (goto-char (match-beginning 1))
12970 (insert " ")
12971 (delete-region (point) (1+ (match-beginning 2)))
12972 (setq ncol (max (1+ (current-column))
12973 (1+ col)
12974 (if (> to-col 0)
12975 to-col
12976 (- (abs to-col) tags-l))))
12977 (setq p (point))
12978 (insert (make-string (- ncol (current-column)) ?\ ))
12979 (setq ncol (current-column))
12980 (when indent-tabs-mode (tabify p (point-at-eol)))
12981 (org-move-to-column (min ncol col) t))
12982 (goto-char pos))))
12984 (defun org-set-tags-command (&optional arg just-align)
12985 "Call the set-tags command for the current entry."
12986 (interactive "P")
12987 (if (org-on-heading-p)
12988 (org-set-tags arg just-align)
12989 (save-excursion
12990 (org-back-to-heading t)
12991 (org-set-tags arg just-align))))
12993 (defun org-set-tags-to (data)
12994 "Set the tags of the current entry to DATA, replacing the current tags.
12995 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12996 If DATA is nil or the empty string, any tags will be removed."
12997 (interactive "sTags: ")
12998 (setq data
12999 (cond
13000 ((eq data nil) "")
13001 ((equal data "") "")
13002 ((stringp data)
13003 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13004 ":"))
13005 ((listp data)
13006 (concat ":" (mapconcat 'identity data ":") ":"))
13007 (t nil)))
13008 (when data
13009 (save-excursion
13010 (org-back-to-heading t)
13011 (when (looking-at org-complex-heading-regexp)
13012 (if (match-end 5)
13013 (progn
13014 (goto-char (match-beginning 5))
13015 (insert data)
13016 (delete-region (point) (point-at-eol))
13017 (org-set-tags nil 'align))
13018 (goto-char (point-at-eol))
13019 (insert " " data)
13020 (org-set-tags nil 'align)))
13021 (beginning-of-line 1)
13023 (delete-region (match-beginning 1) (match-end 1))))))
13025 (defun org-align-all-tags ()
13026 "Align the tags i all headings."
13027 (interactive)
13028 (save-excursion
13029 (or (ignore-errors (org-back-to-heading t))
13030 (outline-next-heading))
13031 (if (org-on-heading-p)
13032 (org-set-tags t)
13033 (message "No headings"))))
13035 (defvar org-indent-indentation-per-level)
13036 (defun org-set-tags (&optional arg just-align)
13037 "Set the tags for the current headline.
13038 With prefix ARG, realign all tags in headings in the current buffer."
13039 (interactive "P")
13040 (let* ((re org-outline-regexp-bol)
13041 (current (org-get-tags-string))
13042 (col (current-column))
13043 (org-setting-tags t)
13044 table current-tags inherited-tags ; computed below when needed
13045 tags p0 c0 c1 rpl di tc level)
13046 (if arg
13047 (save-excursion
13048 (goto-char (point-min))
13049 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13050 (while (re-search-forward re nil t)
13051 (org-set-tags nil t)
13052 (end-of-line 1)))
13053 (message "All tags realigned to column %d" org-tags-column))
13054 (if just-align
13055 (setq tags current)
13056 ;; Get a new set of tags from the user
13057 (save-excursion
13058 (setq table (append org-tag-persistent-alist
13059 (or org-tag-alist (org-get-buffer-tags))
13060 (and
13061 org-complete-tags-always-offer-all-agenda-tags
13062 (org-global-tags-completion-table
13063 (org-agenda-files))))
13064 org-last-tags-completion-table table
13065 current-tags (org-split-string current ":")
13066 inherited-tags (nreverse
13067 (nthcdr (length current-tags)
13068 (nreverse (org-get-tags-at))))
13069 tags
13070 (if (or (eq t org-use-fast-tag-selection)
13071 (and org-use-fast-tag-selection
13072 (delq nil (mapcar 'cdr table))))
13073 (org-fast-tag-selection
13074 current-tags inherited-tags table
13075 (if org-fast-tag-selection-include-todo
13076 org-todo-key-alist))
13077 (let ((org-add-colon-after-tag-completion t))
13078 (org-trim
13079 (org-icompleting-read "Tags: "
13080 'org-tags-completion-function
13081 nil nil current 'org-tags-history))))))
13082 (while (string-match "[-+&]+" tags)
13083 ;; No boolean logic, just a list
13084 (setq tags (replace-match ":" t t tags))))
13086 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13088 (if org-tags-sort-function
13089 (setq tags (mapconcat 'identity
13090 (sort (org-split-string
13091 tags (org-re "[^[:alnum:]_@#%]+"))
13092 org-tags-sort-function) ":")))
13095 (setq tags "")
13096 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13097 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13099 ;; Insert new tags at the correct column
13100 (beginning-of-line 1)
13101 (setq level (or (and (looking-at org-outline-regexp)
13102 (- (match-end 0) (point) 1))
13103 1))
13104 (cond
13105 ((and (equal current "") (equal tags "")))
13106 ((re-search-forward
13108 (point-at-eol) t)
13109 (if (equal tags "")
13110 (setq rpl "")
13111 (goto-char (match-beginning 0))
13112 (setq c0 (current-column)
13113 ;; compute offset for the case of org-indent-mode active
13114 di (if org-indent-mode
13115 (* (1- org-indent-indentation-per-level) (1- level))
13116 0)
13117 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13118 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13119 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13120 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13121 (replace-match rpl t t)
13122 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13123 tags)
13124 (t (error "Tags alignment failed")))
13125 (org-move-to-column col)
13126 (unless just-align
13127 (run-hooks 'org-after-tags-change-hook)))))
13129 (defun org-change-tag-in-region (beg end tag off)
13130 "Add or remove TAG for each entry in the region.
13131 This works in the agenda, and also in an org-mode buffer."
13132 (interactive
13133 (list (region-beginning) (region-end)
13134 (let ((org-last-tags-completion-table
13135 (if (org-mode-p)
13136 (org-get-buffer-tags)
13137 (org-global-tags-completion-table))))
13138 (org-icompleting-read
13139 "Tag: " 'org-tags-completion-function nil nil nil
13140 'org-tags-history))
13141 (progn
13143 (equal (read-char-exclusive) ?r))))
13144 (if (fboundp 'deactivate-mark) (deactivate-mark))
13145 (let ((agendap (equal major-mode 'org-agenda-mode))
13146 l1 l2 m buf pos newhead (cnt 0))
13147 (goto-char end)
13148 (setq l2 (1- (org-current-line)))
13149 (goto-char beg)
13150 (setq l1 (org-current-line))
13151 (loop for l from l1 to l2 do
13152 (org-goto-line l)
13153 (setq m (get-text-property (point) 'org-hd-marker))
13154 (when (or (and (org-mode-p) (org-on-heading-p))
13155 (and agendap m))
13156 (setq buf (if agendap (marker-buffer m) (current-buffer))
13157 pos (if agendap m (point)))
13158 (with-current-buffer buf
13159 (save-excursion
13160 (save-restriction
13161 (goto-char pos)
13162 (setq cnt (1+ cnt))
13163 (org-toggle-tag tag (if off 'off 'on))
13164 (setq newhead (org-get-heading)))))
13165 (and agendap (org-agenda-change-all-lines newhead m))))
13166 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13168 (defun org-tags-completion-function (string predicate &optional flag)
13169 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13170 (confirm (lambda (x) (stringp (car x)))))
13172 (setq s1 (match-string 1 string)
13173 s2 (match-string 2 string))
13174 (setq s1 "" s2 string))
13175 (cond
13176 ((eq flag nil)
13177 ;; try completion
13178 (setq rtn (try-completion s2 ctable confirm))
13179 (if (stringp rtn)
13180 (setq rtn
13181 (concat s1 s2 (substring rtn (length s2))
13182 (if (and org-add-colon-after-tag-completion
13183 (assoc rtn ctable))
13184 ":" ""))))
13185 rtn)
13186 ((eq flag t)
13187 ;; all-completions
13188 (all-completions s2 ctable confirm)
13189 )
13190 ((eq flag 'lambda)
13191 ;; exact match?
13192 (assoc s2 ctable)))
13193 ))
13195 (defun org-fast-tag-insert (kwd tags face &optional end)
13196 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13197 (insert (format "%-12s" (concat kwd ":"))
13198 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13199 (or end "")))
13201 (defun org-fast-tag-show-exit (flag)
13202 (save-excursion
13203 (org-goto-line 3)
13205 (replace-match ""))
13206 (when flag
13207 (end-of-line 1)
13208 (org-move-to-column (- (window-width) 19) t)
13209 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13211 (defun org-set-current-tags-overlay (current prefix)
13212 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13213 (if (featurep 'xemacs)
13214 (org-overlay-display org-tags-overlay (concat prefix s)
13215 'secondary-selection)
13216 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13217 (org-overlay-display org-tags-overlay (concat prefix s)))))
13219 (defvar org-last-tag-selection-key nil)
13220 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13221 "Fast tag selection with single keys.
13222 CURRENT is the current list of tags in the headline, INHERITED is the
13223 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13224 possibly with grouping information. TODO-TABLE is a similar table with
13225 TODO keywords, should these have keys assigned to them.
13226 If the keys are nil, a-z are automatically assigned.
13227 Returns the new tags string, or nil to not change the current settings."
13228 (let* ((fulltable (append table todo-table))
13229 (maxlen (apply 'max (mapcar
13230 (lambda (x)
13231 (if (stringp (car x)) (string-width (car x)) 0))
13232 fulltable)))
13233 (buf (current-buffer))
13234 (expert (eq org-fast-tag-selection-single-key 'expert))
13235 (buffer-tags nil)
13236 (fwidth (+ maxlen 3 1 3))
13237 (ncol (/ (- (window-width) 4) fwidth))
13238 (i-face 'org-done)
13239 (c-face 'org-todo)
13240 tg cnt e c char c1 c2 ntable tbl rtn
13241 ov-start ov-end ov-prefix
13242 (exit-after-next org-fast-tag-selection-single-key)
13243 (done-keywords org-done-keywords)
13244 groups ingroup)
13245 (save-excursion
13246 (beginning-of-line 1)
13247 (if (looking-at
13249 (setq ov-start (match-beginning 1)
13250 ov-end (match-end 1)
13251 ov-prefix "")
13252 (setq ov-start (1- (point-at-eol))
13253 ov-end (1+ ov-start))
13255 (setq ov-prefix
13256 (concat
13257 (buffer-substring (1- (point)) (point))
13258 (if (> (current-column) org-tags-column)
13259 " "
13260 (make-string (- org-tags-column (current-column)) ?\ ))))))
13261 (move-overlay org-tags-overlay ov-start ov-end)
13262 (save-window-excursion
13263 (if expert
13264 (set-buffer (get-buffer-create " *Org tags*"))
13265 (delete-other-windows)
13266 (split-window-vertically)
13267 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13268 (erase-buffer)
13269 (org-set-local 'org-done-keywords done-keywords)
13272 (org-fast-tag-show-exit exit-after-next)
13273 (org-set-current-tags-overlay current ov-prefix)
13274 (setq tbl fulltable char ?a cnt 0)
13275 (while (setq e (pop tbl))
13276 (cond
13277 ((equal (car e) :startgroup)
13278 (push '() groups) (setq ingroup t)
13279 (when (not (= cnt 0))
13280 (setq cnt 0)
13282 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13283 ((equal (car e) :endgroup)
13284 (setq ingroup nil cnt 0)
13286 ((equal e '(:newline))
13287 (when (not (= cnt 0))
13288 (setq cnt 0)
13290 (setq e (car tbl))
13291 (while (equal (car tbl) '(:newline))
13293 (setq tbl (cdr tbl)))))
13294 (t
13295 (setq tg (copy-sequence (car e)) c2 nil)
13296 (if (cdr e)
13297 (setq c (cdr e))
13298 ;; automatically assign a character.
13299 (setq c1 (string-to-char
13300 (downcase (substring
13301 tg (if (= (string-to-char tg) ?@) 1 0)))))
13302 (if (or (rassoc c1 ntable) (rassoc c1 table))
13303 (while (or (rassoc char ntable) (rassoc char table))
13304 (setq char (1+ char)))
13305 (setq c2 c1))
13306 (setq c (or c2 char)))
13307 (if ingroup (push tg (car groups)))
13308 (setq tg (org-add-props tg nil 'face
13309 (cond
13310 ((not (assoc tg table))
13311 (org-get-todo-face tg))
13312 ((member tg current) c-face)
13313 ((member tg inherited) i-face)
13314 (t nil))))
13315 (if (and (= cnt 0) (not ingroup)) (insert " "))
13316 (insert "[" c "] " tg (make-string
13317 (- fwidth 4 (length tg)) ?\ ))
13318 (push (cons tg c) ntable)
13319 (when (= (setq cnt (1+ cnt)) ncol)
13321 (if ingroup (insert " "))
13322 (setq cnt 0)))))
13323 (setq ntable (nreverse ntable))
13325 (goto-char (point-min))
13326 (if (not expert) (org-fit-window-to-buffer))
13327 (setq rtn
13328 (catch 'exit
13329 (while t
13330 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13331 (if (not groups) "no " "")
13332 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13333 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13334 (setq org-last-tag-selection-key c)
13335 (cond
13337 ((= c ?!)
13338 (setq groups (not groups))
13339 (goto-char (point-min))
13340 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13341 ((= c ?\C-c)
13342 (if (not expert)
13343 (org-fast-tag-show-exit
13344 (setq exit-after-next (not exit-after-next)))
13345 (setq expert nil)
13346 (delete-other-windows)
13347 (set-window-buffer (split-window-vertically) " *Org tags*")
13348 (org-switch-to-buffer-other-window " *Org tags*")
13349 (org-fit-window-to-buffer)))
13350 ((or (= c ?\C-g)
13351 (and (= c ?q) (not (rassoc c ntable))))
13352 (org-detach-overlay org-tags-overlay)
13353 (setq quit-flag t))
13354 ((= c ?\ )
13355 (setq current nil)
13356 (if exit-after-next (setq exit-after-next 'now)))
13358 (condition-case nil
13359 (setq tg (org-icompleting-read
13360 "Tag: "
13361 (or buffer-tags
13362 (with-current-buffer buf
13363 (org-get-buffer-tags)))))
13364 (quit (setq tg "")))
13366 (add-to-list 'buffer-tags (list tg))
13367 (if (member tg current)
13368 (setq current (delete tg current))
13369 (push tg current)))
13370 (if exit-after-next (setq exit-after-next 'now)))
13371 ((setq e (rassoc c todo-table) tg (car e))
13372 (with-current-buffer buf
13373 (save-excursion (org-todo tg)))
13374 (if exit-after-next (setq exit-after-next 'now)))
13375 ((setq e (rassoc c ntable) tg (car e))
13376 (if (member tg current)
13377 (setq current (delete tg current))
13378 (loop for g in groups do
13379 (if (member tg g)
13380 (mapc (lambda (x)
13381 (setq current (delete x current)))
13382 g)))
13383 (push tg current))
13384 (if exit-after-next (setq exit-after-next 'now))))
13386 ;; Create a sorted list
13387 (setq current
13388 (sort current
13389 (lambda (a b)
13390 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13391 (if (eq exit-after-next 'now) (throw 'exit t))
13392 (goto-char (point-min))
13393 (beginning-of-line 2)
13394 (delete-region (point) (point-at-eol))
13395 (org-fast-tag-insert "Current" current c-face)
13396 (org-set-current-tags-overlay current ov-prefix)
13397 (while (re-search-forward
13399 (setq tg (match-string 1))
13400 (add-text-properties
13401 (match-beginning 1) (match-end 1)
13402 (list 'face
13403 (cond
13404 ((member tg current) c-face)
13405 ((member tg inherited) i-face)
13406 (t (get-text-property (match-beginning 1) 'face))))))
13407 (goto-char (point-min)))))
13408 (org-detach-overlay org-tags-overlay)
13409 (if rtn
13410 (mapconcat 'identity current ":")
13411 nil))))
13413 (defun org-get-tags-string ()
13414 "Get the TAGS string in the current headline."
13415 (unless (org-on-heading-p t)
13416 (error "Not on a heading"))
13417 (save-excursion
13418 (beginning-of-line 1)
13420 (org-match-string-no-properties 1)
13421 "")))
13423 (defun org-get-tags ()
13424 "Get the list of tags specified in the current headline."
13425 (org-split-string (org-get-tags-string) ":"))
13427 (defun org-get-buffer-tags ()
13428 "Get a table of all tags used in the buffer, for completion."
13429 (let (tags)
13430 (save-excursion
13431 (goto-char (point-min))
13432 (while (re-search-forward
13434 (when (equal (char-after (point-at-bol 0)) ?*)
13435 (mapc (lambda (x) (add-to-list 'tags x))
13436 (org-split-string (org-match-string-no-properties 1) ":")))))
13437 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13438 (mapcar 'list tags)))
13440 ;;;; The mapping API
13442 ;;;###autoload
13443 (defun org-map-entries (func &optional match scope &rest skip)
13444 "Call FUNC at each headline selected by MATCH in SCOPE.
13446 FUNC is a function or a lisp form. The function will be called without
13447 arguments, with the cursor positioned at the beginning of the headline.
13448 The return values of all calls to the function will be collected and
13449 returned as a list.
13451 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13452 does not need to preserve point. After evaluation, the cursor will be
13453 moved to the end of the line (presumably of the headline of the
13454 processed entry) and search continues from there. Under some
13455 circumstances, this may not produce the wanted results. For example,
13456 if you have removed (e.g. archived) the current (sub)tree it could
13457 mean that the next entry will be skipped entirely. In such cases, you
13458 can specify the position from where search should continue by making
13459 FUNC set the variable `org-map-continue-from' to the desired buffer
13460 position.
13462 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13463 Only headlines that are matched by this query will be considered during
13464 the iteration. When MATCH is nil or t, all headlines will be
13465 visited by the iteration.
13467 SCOPE determines the scope of this command. It can be any of:
13469 nil The current buffer, respecting the restriction if any
13470 tree The subtree started with the entry at point
13471 file The current buffer, without restriction
13472 file-with-archives
13473 The current buffer, and any archives associated with it
13474 agenda All agenda files
13475 agenda-with-archives
13476 All agenda files with any archive files associated with them
13477 \(file1 file2 ...)
13478 If this is a list, all files in the list will be scanned
13480 The remaining args are treated as settings for the skipping facilities of
13481 the scanner. The following items can be given here:
13483 archive skip trees with the archive tag.
13484 comment skip trees with the COMMENT keyword
13485 function or Emacs Lisp form:
13486 will be used as value for `org-agenda-skip-function', so whenever
13487 the function returns t, FUNC will not be called for that
13488 entry and search will continue from the point where the
13489 function leaves it.
13491 If your function needs to retrieve the tags including inherited tags
13492 at the *current* entry, you can use the value of the variable
13493 `org-scanner-tags' which will be much faster than getting the value
13494 with `org-get-tags-at'. If your function gets properties with
13495 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13496 to t around the call to `org-entry-properties' to get the same speedup.
13497 Note that if your function moves around to retrieve tags and properties at
13498 a *different* entry, you cannot use these techniques."
13499 (let* ((org-agenda-archives-mode nil) ; just to make sure
13500 (org-agenda-skip-archived-trees (memq 'archive skip))
13501 (org-agenda-skip-comment-trees (memq 'comment skip))
13502 (org-agenda-skip-function
13503 (car (org-delete-all '(comment archive) skip)))
13504 (org-tags-match-list-sublevels t)
13505 matcher file res
13506 org-todo-keywords-for-agenda
13507 org-done-keywords-for-agenda
13508 org-todo-keyword-alist-for-agenda
13509 org-drawers-for-agenda
13510 org-tag-alist-for-agenda)
13512 (cond
13513 ((eq match t) (setq matcher t))
13514 ((eq match nil) (setq matcher t))
13515 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13517 (save-excursion
13518 (save-restriction
13519 (when (eq scope 'tree)
13520 (org-back-to-heading t)
13521 (org-narrow-to-subtree)
13522 (setq scope nil))
13524 (if (not scope)
13525 (progn
13526 (org-prepare-agenda-buffers
13527 (list (buffer-file-name (current-buffer))))
13528 (setq res (org-scan-tags func matcher)))
13529 ;; Get the right scope
13530 (cond
13531 ((and scope (listp scope) (symbolp (car scope)))
13532 (setq scope (eval scope)))
13533 ((eq scope 'agenda)
13534 (setq scope (org-agenda-files t)))
13535 ((eq scope 'agenda-with-archives)
13536 (setq scope (org-agenda-files t))
13537 (setq scope (org-add-archive-files scope)))
13538 ((eq scope 'file)
13539 (setq scope (list (buffer-file-name))))
13540 ((eq scope 'file-with-archives)
13541 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13542 (org-prepare-agenda-buffers scope)
13543 (while (setq file (pop scope))
13544 (with-current-buffer (org-find-base-buffer-visiting file)
13545 (save-excursion
13546 (save-restriction
13547 (widen)
13548 (goto-char (point-min))
13549 (setq res (append res (org-scan-tags func matcher))))))))))
13550 res))
13552 ;;;; Properties
13554 ;;; Setting and retrieving properties
13556 (defconst org-special-properties
13557 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13558 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13559 "The special properties valid in Org-mode.
13561 These are properties that are not defined in the property drawer,
13562 but in some other way.")
13564 (defconst org-default-properties
13565 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13566 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13567 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13568 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13569 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13570 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13571 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13572 "Some properties that are used by Org-mode for various purposes.
13573 Being in this list makes sure that they are offered for completion.")
13576 "Regular expression matching the first line of a property drawer.")
13579 "Regular expression matching the last line of a property drawer.")
13582 "Regular expression matching the first line of a property drawer.")
13585 "Regular expression matching the first line of a property drawer.")
13587 (defconst org-property-drawer-re
13590 "Matches an entire property drawer.")
13592 (defconst org-clock-drawer-re
13595 "Matches an entire clock drawer.")
13597 (defsubst org-re-property (property)
13598 "Return a regexp matching PROPERTY.
13599 Match group 1 will be set to the value "
13602 (defun org-property-action ()
13603 "Do an action on properties."
13604 (interactive)
13605 (let (c)
13606 (org-at-property-p)
13607 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13608 (setq c (read-char-exclusive))
13609 (cond
13610 ((equal c ?s)
13611 (call-interactively 'org-set-property))
13612 ((equal c ?d)
13613 (call-interactively 'org-delete-property))
13614 ((equal c ?D)
13615 (call-interactively 'org-delete-property-globally))
13616 ((equal c ?c)
13617 (call-interactively 'org-compute-property-at-point))
13618 (t (error "No such property action %c" c)))))
13620 (defun org-set-effort (&optional value)
13621 "Set the effort property of the current entry.
13622 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13623 allowed value."
13624 (interactive "P")
13625 (if (equal value 0) (setq value 10))
13626 (let* ((completion-ignore-case t)
13627 (prop org-effort-property)
13628 (cur (org-entry-get nil prop))
13629 (allowed (org-property-get-allowed-values nil prop 'table))
13630 (existing (mapcar 'list (org-property-values prop)))
13631 rpl
13632 (val (cond
13633 ((stringp value) value)
13634 ((and allowed (integerp value))
13635 (or (car (nth (1- value) allowed))
13636 (car (org-last allowed))))
13637 (allowed
13638 (message "Select 1-9,0, [RET%s]: %s"
13639 (if cur (concat "=" cur) "")
13640 (mapconcat 'car allowed " "))
13641 (setq rpl (read-char-exclusive))
13643 cur
13644 (setq rpl (- rpl ?0))
13645 (if (equal rpl 0) (setq rpl 10))
13646 (if (and (> rpl 0) (<= rpl (length allowed)))
13647 (car (nth (1- rpl) allowed))
13648 (org-completing-read "Effort: " allowed nil))))
13649 (t
13650 (let (org-completion-use-ido org-completion-use-iswitchb)
13651 (org-completing-read
13653 (concat "[" cur "]") "")
13654 ": ")
13655 existing nil nil "" nil cur))))))
13656 (unless (equal (org-entry-get nil prop) val)
13657 (org-entry-put nil prop val))
13658 (message "%s is now %s" prop val)))
13660 (defun org-at-property-p ()
13661 "Is cursor inside a property drawer?"
13662 (save-excursion
13663 (beginning-of-line 1)
13665 (save-match-data ;; Used by calling procedures
13666 (let ((p (point))
13667 (range (unless (org-before-first-heading-p)
13668 (org-get-property-block))))
13669 (and range (<= (car range) p) (< p (cdr range))))))))
13671 (defun org-get-property-block (&optional beg end force)
13672 "Return the (beg . end) range of the body of the property drawer.
13673 BEG and END can be beginning and end of subtree, if not given
13674 they will be found.
13675 If the drawer does not exist and FORCE is non-nil, create the drawer."
13676 (catch 'exit
13677 (save-excursion
13678 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13679 (end (or end (progn (outline-next-heading) (point)))))
13680 (goto-char beg)
13681 (if (re-search-forward org-property-start-re end t)
13682 (setq beg (1+ (match-end 0)))
13683 (if force
13684 (save-excursion
13685 (org-insert-property-drawer)
13686 (setq end (progn (outline-next-heading) (point))))
13687 (throw 'exit nil))
13688 (goto-char beg)
13689 (if (re-search-forward org-property-start-re end t)
13690 (setq beg (1+ (match-end 0)))))
13691 (if (re-search-forward org-property-end-re end t)
13692 (setq end (match-beginning 0))
13693 (or force (throw 'exit nil))
13694 (goto-char beg)
13695 (setq end beg)
13696 (org-indent-line-function)
13698 (cons beg end)))))
13700 (defun org-entry-properties (&optional pom which specific)
13701 "Get all properties of the entry at point-or-marker POM.
13702 This includes the TODO keyword, the tags, time strings for deadline,
13703 scheduled, and clocking, and any additional properties defined in the
13704 entry. The return value is an alist, keys may occur multiple times
13705 if the property key was used several times.
13706 POM may also be nil, in which case the current entry is used.
13707 If WHICH is nil or `all', get all properties. If WHICH is
13708 `special' or `standard', only get that subclass. If WHICH
13709 is a string only get exactly this property. SPECIFIC can be a string, the
13710 specific property we are interested in. Specifying it can speed
13711 things up because then unnecessary parsing is avoided."
13712 (setq which (or which 'all))
13713 (org-with-point-at pom
13714 (let ((clockstr (substring org-clock-string 0 -1))
13715 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13716 (case-fold-search nil)
13717 beg end range props sum-props key key1 value string clocksum)
13718 (save-excursion
13719 (when (condition-case nil
13720 (and (org-mode-p) (org-back-to-heading t))
13721 (error nil))
13722 (setq beg (point))
13723 (setq sum-props (get-text-property (point) 'org-summaries))
13724 (setq clocksum (get-text-property (point) :org-clock-minutes))
13725 (outline-next-heading)
13726 (setq end (point))
13727 (when (memq which '(all special))
13728 ;; Get the special properties, like TODO and tags
13729 (goto-char beg)
13730 (when (and (or (not specific) (string= specific "TODO"))
13731 (looking-at org-todo-line-regexp) (match-end 2))
13732 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13733 (when (and (or (not specific) (string= specific "PRIORITY"))
13734 (looking-at org-priority-regexp))
13735 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13736 (when (or (not specific) (string= specific "FILE"))
13737 (push (cons "FILE" buffer-file-name) props))
13738 (when (and (or (not specific) (string= specific "TAGS"))
13739 (setq value (org-get-tags-string))
13741 (push (cons "TAGS" value) props))
13742 (when (and (or (not specific) (string= specific "ALLTAGS"))
13743 (setq value (org-get-tags-at)))
13744 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13745 ":"))
13746 props))
13747 (when (or (not specific) (string= specific "BLOCKED"))
13748 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13749 (when (or (not specific)
13750 (member specific
13751 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13752 "TIMESTAMP" "TIMESTAMP_IA")))
13753 (catch 'match
13754 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13755 (setq key (if (match-end 1)
13756 (substring (org-match-string-no-properties 1)
13757 0 -1))
13758 string (if (equal key clockstr)
13759 (org-no-properties
13760 (org-trim
13761 (buffer-substring
13762 (match-beginning 3) (goto-char
13763 (point-at-eol)))))
13764 (substring (org-match-string-no-properties 3)
13765 1 -1)))
13766 ;; Get the correct property name from the key. This is
13767 ;; necessary if the user has configured time keywords.
13768 (setq key1 (concat key ":"))
13769 (cond
13770 ((not key)
13771 (setq key
13772 (if (= (char-after (match-beginning 3)) ?\[)
13773 "TIMESTAMP_IA" "TIMESTAMP")))
13774 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13775 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13776 ((equal key1 org-closed-string) (setq key "CLOSED"))
13777 ((equal key1 org-clock-string) (setq key "CLOCK")))
13778 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13779 (progn
13780 (push (cons key string) props)
13781 ;; no need to search further if match is found
13782 (throw 'match t))
13783 (when (or (equal key "CLOCK") (not (assoc key props)))
13784 (push (cons key string) props))))))
13785 )
13787 (when (memq which '(all standard))
13788 ;; Get the standard properties, like :PROP: ...
13789 (setq range (org-get-property-block beg end))
13790 (when range
13791 (goto-char (car range))
13792 (while (re-search-forward
13794 (cdr range) t)
13795 (setq key (org-match-string-no-properties 1)
13796 value (org-trim (or (org-match-string-no-properties 2) "")))
13797 (unless (member key excluded)
13798 (push (cons key (or value "")) props)))))
13799 (if clocksum
13800 (push (cons "CLOCKSUM"
13801 (org-columns-number-to-string (/ (float clocksum) 60.)
13802 'add_times))
13803 props))
13804 (unless (assoc "CATEGORY" props)
13805 (push (cons "CATEGORY" (org-get-category)) props))
13806 (append sum-props (nreverse props)))))))
13808 (defun org-entry-get (pom property &optional inherit literal-nil)
13809 "Get value of PROPERTY for entry at point-or-marker POM.
13810 If INHERIT is non-nil and the entry does not have the property,
13811 then also check higher levels of the hierarchy.
13812 If INHERIT is the symbol `selective', use inheritance only if the setting
13813 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13814 If the property is present but empty, the return value is the empty string.
13815 If the property is not present at all, nil is returned.
13818 do not interpret it as the list atom nil. This is used for inheritance
13820 (org-with-point-at pom
13821 (if (and inherit (if (eq inherit 'selective)
13822 (org-property-inherit-p property)
13823 t))
13824 (org-entry-get-with-inheritance property literal-nil)
13825 (if (member property org-special-properties)
13826 ;; We need a special property. Use `org-entry-properties' to
13827 ;; retrieve it, but specify the wanted property
13828 (cdr (assoc property (org-entry-properties nil 'special property)))
13829 (let ((range (unless (org-before-first-heading-p)
13830 (org-get-property-block))))
13831 (if (and range
13832 (goto-char (car range))
13833 (re-search-forward
13834 (org-re-property property)
13835 (cdr range) t))
13836 ;; Found the property, return it.
13837 (if (match-end 1)
13838 (if literal-nil
13839 (org-match-string-no-properties 1)
13840 (org-not-nil (org-match-string-no-properties 1)))
13841 "")))))))
13843 (defun org-property-or-variable-value (var &optional inherit)
13844 "Check if there is a property fixing the value of VAR.
13845 If yes, return this value. If not, return the current value of the variable."
13846 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13848 (read prop)
13849 (symbol-value var))))
13851 (defun org-entry-delete (pom property)
13852 "Delete the property PROPERTY from entry at point-or-marker POM."
13853 (org-with-point-at pom
13854 (if (member property org-special-properties)
13855 nil ; cannot delete these properties.
13856 (let ((range (org-get-property-block)))
13857 (if (and range
13858 (goto-char (car range))
13859 (re-search-forward
13860 (org-re-property property)
13861 (cdr range) t))
13862 (progn
13863 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13864 t)
13865 nil)))))
13867 ;; Multi-values properties are properties that contain multiple values
13868 ;; These values are assumed to be single words, separated by whitespace.
13869 (defun org-entry-add-to-multivalued-property (pom property value)
13870 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13871 (let* ((old (org-entry-get pom property))
13873 (setq value (org-entry-protect-space value))
13874 (unless (member value values)
13875 (setq values (cons value values))
13876 (org-entry-put pom property
13877 (mapconcat 'identity values " ")))))
13879 (defun org-entry-remove-from-multivalued-property (pom property value)
13880 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13881 (let* ((old (org-entry-get pom property))
13883 (setq value (org-entry-protect-space value))
13884 (when (member value values)
13885 (setq values (delete value values))
13886 (org-entry-put pom property
13887 (mapconcat 'identity values " ")))))
13889 (defun org-entry-member-in-multivalued-property (pom property value)
13890 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13891 (let* ((old (org-entry-get pom property))
13893 (setq value (org-entry-protect-space value))
13894 (member value values)))
13896 (defun org-entry-get-multivalued-property (pom property)
13897 "Return a list of values in a multivalued property."
13898 (let* ((value (org-entry-get pom property))
13900 (mapcar 'org-entry-restore-space values)))
13902 (defun org-entry-put-multivalued-property (pom property &rest values)
13903 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13904 VALUES should be a list of strings. Spaces will be protected."
13905 (org-entry-put pom property
13906 (mapconcat 'org-entry-protect-space values " "))
13907 (let* ((value (org-entry-get pom property))
13909 (mapcar 'org-entry-restore-space values)))
13911 (defun org-entry-protect-space (s)
13912 "Protect spaces and newline in string S."
13913 (while (string-match " " s)
13914 (setq s (replace-match "%20" t t s)))
13916 (setq s (replace-match "%0A" t t s)))
13917 s)
13919 (defun org-entry-restore-space (s)
13920 "Restore spaces and newline in string S."
13921 (while (string-match "%20" s)
13922 (setq s (replace-match " " t t s)))
13923 (while (string-match "%0A" s)
13925 s)
13927 (defvar org-entry-property-inherited-from (make-marker)
13928 "Marker pointing to the entry from where a property was inherited.
13929 Each call to `org-entry-get-with-inheritance' will set this marker to the
13930 location of the entry where the inheritance search matched. If there was
13931 no match, the marker will point nowhere.
13932 Note that also `org-entry-get' calls this function, if the INHERIT flag
13933 is set.")
13935 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13936 "Get entry property, and search higher levels if not present.
13937 The search will stop at the first ancestor which has the property defined.
13939 should be considered as undefined (this is the meaning of nil here).
13941 (move-marker org-entry-property-inherited-from nil)
13942 (let (tmp)
13943 (unless (org-before-first-heading-p)
13944 (save-excursion
13945 (save-restriction
13946 (widen)
13947 (catch 'ex
13948 (while t
13949 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13950 (org-back-to-heading t)
13951 (move-marker org-entry-property-inherited-from (point))
13952 (throw 'ex tmp))
13953 (or (org-up-heading-safe) (throw 'ex nil)))))))
13954 (setq tmp (or tmp
13955 (cdr (assoc property org-file-properties))
13956 (cdr (assoc property org-global-properties))
13957 (cdr (assoc property org-global-properties-fixed))))
13958 (if literal-nil tmp (org-not-nil tmp))))
13960 (defvar org-property-changed-functions nil
13961 "Hook called when the value of a property has changed.
13962 Each hook function should accept two arguments, the name of the property
13963 and the new value.")
13965 (defun org-entry-put (pom property value)
13966 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13967 (org-with-point-at pom
13968 (org-back-to-heading t)
13969 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13970 range)
13971 (cond
13972 ((equal property "TODO")
13974 (not (member value org-todo-keywords-1)))
13976 (if (or (not value)
13978 (setq value 'none))
13979 (org-todo value)
13980 (org-set-tags nil 'align))
13981 ((equal property "PRIORITY")
13983 (string-to-char value) ?\ ))
13984 (org-set-tags nil 'align))
13985 ((equal property "SCHEDULED")
13986 (if (re-search-forward org-scheduled-time-regexp end t)
13987 (cond
13988 ((eq value 'earlier) (org-timestamp-change -1 'day))
13989 ((eq value 'later) (org-timestamp-change 1 'day))
13990 (t (call-interactively 'org-schedule)))
13991 (call-interactively 'org-schedule)))
13992 ((equal property "DEADLINE")
13993 (if (re-search-forward org-deadline-time-regexp end t)
13994 (cond
13995 ((eq value 'earlier) (org-timestamp-change -1 'day))
13996 ((eq value 'later) (org-timestamp-change 1 'day))
13997 (t (call-interactively 'org-deadline)))
13998 (call-interactively 'org-deadline)))
13999 ((member property org-special-properties)
14000 (error "The %s property can not yet be set with `org-entry-put'"
14001 property))
14002 (t ; a non-special property
14003 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14004 (setq range (org-get-property-block beg end 'force))
14005 (goto-char (car range))
14006 (if (re-search-forward
14007 (org-re-property property) (cdr range) t)
14008 (progn
14009 (delete-region (match-beginning 0) (match-end 0))
14010 (goto-char (match-beginning 0)))
14011 (goto-char (cdr range))
14013 (backward-char 1)
14014 (org-indent-line-function))
14015 (insert ":" property ":")
14016 (and value (insert " " value))
14017 (org-indent-line-function)))))
14018 (run-hook-with-args 'org-property-changed-functions property value)))
14020 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14021 "Get all property keys in the current buffer.
14022 With INCLUDE-SPECIALS, also list the special properties that reflect things
14023 like tags and TODO state.
14024 With INCLUDE-DEFAULTS, also include properties that has special meaning
14025 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14026 and others.
14027 With INCLUDE-COLUMNS, also include property names given in COLUMN
14028 formats in the current buffer."
14029 (let (rtn range cfmt s p)
14030 (save-excursion
14031 (save-restriction
14032 (widen)
14033 (goto-char (point-min))
14034 (while (re-search-forward org-property-start-re nil t)
14035 (setq range (org-get-property-block))
14036 (goto-char (car range))
14037 (while (re-search-forward
14039 (cdr range) t)
14040 (add-to-list 'rtn (org-match-string-no-properties 1)))
14041 (outline-next-heading))))
14043 (when include-specials
14044 (setq rtn (append org-special-properties rtn)))
14046 (when include-defaults
14047 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14048 (add-to-list 'rtn org-effort-property))
14050 (when include-columns
14051 (save-excursion
14052 (save-restriction
14053 (widen)
14054 (goto-char (point-min))
14055 (while (re-search-forward
14057 nil t)
14058 (setq cfmt (match-string 2) s 0)
14060 cfmt s)
14061 (setq s (match-end 0)
14062 p (match-string 1 cfmt))
14063 (unless (or (equal p "ITEM")
14064 (member p org-special-properties))
14065 (add-to-list 'rtn (match-string 1 cfmt))))))))
14067 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14069 (defun org-property-values (key)
14070 "Return a list of all values of property KEY in the current buffer."
14071 (save-excursion
14072 (save-restriction
14073 (widen)
14074 (goto-char (point-min))
14075 (let ((re (org-re-property key))
14076 values)
14077 (while (re-search-forward re nil t)
14078 (add-to-list 'values (org-trim (match-string 1))))
14079 (delete "" values)))))
14081 (defun org-insert-property-drawer ()
14082 "Insert a property drawer into the current entry."
14083 (interactive)
14084 (org-back-to-heading t)
14085 (looking-at org-outline-regexp)
14086 (let ((indent (if org-adapt-indentation
14087 (- (match-end 0)(match-beginning 0))
14088 0))
14089 (beg (point))
14091 end hiddenp)
14092 (outline-next-heading)
14093 (setq end (point))
14094 (goto-char beg)
14095 (while (re-search-forward re end t))
14096 (setq hiddenp (outline-invisible-p))
14097 (end-of-line 1)
14100 (if (member (match-string 1) '("CLOCK:" ":END:"))
14101 ;; just skip this line
14102 (beginning-of-line 2)
14103 ;; Drawer start, find the end
14105 (beginning-of-line 1)))
14106 (org-skip-over-state-notes)
14108 (if (eq (char-before) ?*) (forward-char 1))
14110 (beginning-of-line 0)
14111 (org-indent-to-column indent)
14112 (beginning-of-line 2)
14113 (org-indent-to-column indent)
14114 (beginning-of-line 0)
14115 (if hiddenp
14116 (save-excursion
14117 (org-back-to-heading t)
14118 (hide-entry))
14119 (org-flag-drawer t))))
14121 (defvar org-property-set-functions-alist nil
14122 "Property set function alist.
14123 Each entry should have the following format:
14125 (PROPERTY . READ-FUNCTION)
14127 The read function will be called with the same argument as
14128 `org-completing-read'.")
14130 (defun org-set-property-function (property)
14131 "Get the function that should be used to set PROPERTY.
14132 This is computed according to `org-property-set-functions-alist'."
14133 (or (cdr (assoc property org-property-set-functions-alist))
14134 'org-completing-read))
14136 (defun org-read-property-value (property)
14137 "Read PROPERTY value from user."
14138 (let* ((completion-ignore-case t)
14139 (allowed (org-property-get-allowed-values nil property 'table))
14140 (cur (org-entry-get nil property))
14141 (prompt (concat property " value"
14143 (concat " [" cur "]") "") ": "))
14144 (set-function (org-set-property-function property))
14145 (val (if allowed
14146 (funcall set-function prompt allowed nil
14147 (not (get-text-property 0 'org-unrestricted
14148 (caar allowed))))
14149 (let (org-completion-use-ido org-completion-use-iswitchb)
14150 (funcall set-function prompt
14151 (mapcar 'list (org-property-values property))
14152 nil nil "" nil cur)))))
14153 (if (equal val "")
14154 cur
14155 val)))
14157 (defvar org-last-set-property nil)
14158 (defun org-read-property-name ()
14159 "Read a property name."
14160 (let* ((completion-ignore-case t)
14161 (keys (org-buffer-property-keys nil t t))
14162 (default-prop (or (save-excursion
14163 (save-match-data
14164 (beginning-of-line)
14166 (null (string= (match-string 1) "END"))
14167 (match-string 1))))
14168 org-last-set-property))
14169 (property (org-icompleting-read
14170 (concat "Property"
14171 (if default-prop (concat " [" default-prop "]") "")
14172 ": ")
14173 (mapcar 'list keys)
14174 nil nil nil nil
14175 default-prop
14176 )))
14177 (if (member property keys)
14178 property
14179 (or (cdr (assoc (downcase property)
14180 (mapcar (lambda (x) (cons (downcase x) x))
14181 keys)))
14182 property))))
14184 (defun org-set-property (property value)
14185 "In the current entry, set PROPERTY to VALUE.
14186 When called interactively, this will prompt for a property name, offering
14187 completion on existing and default properties. And then it will prompt
14188 for a value, offering completion either on allowed values (via an inherited
14189 xxx_ALL property) or on existing values in other instances of this property
14190 in the current file."
14191 (interactive (list nil nil))
14192 (let* ((property (or property (org-read-property-name)))
14193 (value (or value (org-read-property-value property))))
14194 (setq org-last-set-property property)
14195 (unless (equal (org-entry-get nil property) value)
14196 (org-entry-put nil property value))))
14198 (defun org-delete-property (property)
14199 "In the current entry, delete PROPERTY."
14200 (interactive
14201 (let* ((completion-ignore-case t)
14202 (prop (org-icompleting-read "Property: "
14203 (org-entry-properties nil 'standard))))
14204 (list prop)))
14205 (message "Property %s %s" property
14206 (if (org-entry-delete nil property)
14207 "deleted"
14208 "was not present in the entry")))
14210 (defun org-delete-property-globally (property)
14211 "Remove PROPERTY globally, from all entries."
14212 (interactive
14213 (let* ((completion-ignore-case t)
14214 (prop (org-icompleting-read
14215 "Globally remove property: "
14216 (mapcar 'list (org-buffer-property-keys)))))
14217 (list prop)))
14218 (save-excursion
14219 (save-restriction
14220 (widen)
14221 (goto-char (point-min))
14222 (let ((cnt 0))
14223 (while (re-search-forward
14224 (org-re-property property)
14225 nil t)
14226 (setq cnt (1+ cnt))
14227 (replace-match ""))
14230 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14232 (defun org-compute-property-at-point ()
14233 "Compute the property at point.
14234 This looks for an enclosing column format, extracts the operator and
14235 then applies it to the property in the column format's scope."
14236 (interactive)
14237 (unless (org-at-property-p)
14238 (error "Not at a property"))
14239 (let ((prop (org-match-string-no-properties 2)))
14240 (org-columns-get-format-and-top-level)
14241 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14242 (error "No operator defined for property %s" prop))
14243 (org-columns-compute prop)))
14245 (defvar org-property-allowed-value-functions nil
14246 "Hook for functions supplying allowed values for a specific property.
14247 The functions must take a single argument, the name of the property, and
14249 the values, this means that these values are intended as defaults for
14250 completion, but that other values should be allowed too.
14251 The functions must return nil if they are not responsible for this
14252 property.")
14254 (defun org-property-get-allowed-values (pom property &optional table)
14255 "Get allowed values for the property PROPERTY.
14256 When TABLE is non-nil, return an alist that can directly be used for
14257 completion."
14258 (let (vals)
14259 (cond
14260 ((equal property "TODO")
14261 (setq vals (org-with-point-at pom
14262 (append org-todo-keywords-1 '("")))))
14263 ((equal property "PRIORITY")
14264 (let ((n org-lowest-priority))
14265 (while (>= n org-highest-priority)
14266 (push (char-to-string n) vals)
14267 (setq n (1- n)))))
14268 ((member property org-special-properties))
14269 ((setq vals (run-hook-with-args-until-success
14270 'org-property-allowed-value-functions property)))
14271 (t
14272 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14274 (setq vals (car (read-from-string (concat "(" vals ")"))))
14275 (setq vals (mapcar (lambda (x)
14276 (cond ((stringp x) x)
14277 ((numberp x) (number-to-string x))
14278 ((symbolp x) (symbol-name x))
14279 (t "???")))
14280 vals)))))
14281 (when (member ":ETC" vals)
14282 (setq vals (remove ":ETC" vals))
14283 (org-add-props (car vals) '(org-unrestricted t)))
14284 (if table (mapcar 'list vals) vals)))
14286 (defun org-property-previous-allowed-value (&optional previous)
14287 "Switch to the next allowed value for this property."
14288 (interactive)
14289 (org-property-next-allowed-value t))
14291 (defun org-property-next-allowed-value (&optional previous)
14292 "Switch to the next allowed value for this property."
14293 (interactive)
14294 (unless (org-at-property-p)
14295 (error "Not at a property"))
14296 (let* ((key (match-string 2))
14297 (value (match-string 3))
14298 (allowed (or (org-property-get-allowed-values (point) key)
14299 (and (member value '("[ ]" "[-]" "[X]"))
14300 '("[ ]" "[X]"))))
14301 nval)
14302 (unless allowed
14303 (error "Allowed values for this property have not been defined"))
14304 (if previous (setq allowed (reverse allowed)))
14305 (if (member value allowed)
14306 (setq nval (car (cdr (member value allowed)))))
14307 (setq nval (or nval (car allowed)))
14308 (if (equal nval value)
14309 (error "Only one allowed value for this property"))
14310 (org-at-property-p)
14311 (replace-match (concat " :" key ": " nval) t t)
14312 (org-indent-line-function)
14313 (beginning-of-line 1)
14315 (run-hook-with-args 'org-property-changed-functions key nval)))
14317 (defun org-find-olp (path &optional this-buffer)
14318 "Return a marker pointing to the entry at outline path OLP.
14319 If anything goes wrong, throw an error.
14320 You can wrap this call to catch the error like this:
14322 (condition-case msg
14323 (org-mobile-locate-entry (match-string 4))
14324 (error (nth 1 msg)))
14326 The return value will then be either a string with the error message,
14327 or a marker if everything is OK.
14329 If THIS-BUFFER is set, the outline path does not contain a file,
14330 only headings."
14331 (let* ((file (if this-buffer buffer-file-name (pop path)))
14332 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14333 (level 1)
14334 (lmin 1)
14335 (lmax 1)
14336 limit re end found pos heading cnt flevel)
14337 (unless buffer (error "File not found :%s" file))
14338 (with-current-buffer buffer
14339 (save-excursion
14340 (save-restriction
14341 (widen)
14342 (setq limit (point-max))
14343 (goto-char (point-min))
14344 (while (setq heading (pop path))
14345 (setq re (format org-complex-heading-regexp-format
14346 (regexp-quote heading)))
14347 (setq cnt 0 pos (point))
14348 (while (re-search-forward re end t)
14349 (setq level (- (match-end 1) (match-beginning 1)))
14350 (if (and (>= level lmin) (<= level lmax))
14351 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14352 (when (= cnt 0) (error "Heading not found on level %d: %s"
14353 lmax heading))
14354 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14355 lmax heading))
14356 (goto-char found)
14357 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14358 (setq end (save-excursion (org-end-of-subtree t t))))
14359 (when (org-on-heading-p)
14360 (move-marker (make-marker) (point))))))))
14362 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14363 "Find node HEADING in BUFFER.
14364 Return a marker to the heading if it was found, or nil if not.
14365 If POS-ONLY is set, return just the position instead of a marker.
14367 The heading text must match exact, but it may have a TODO keyword,
14368 a priority cookie and tags in the standard locations."
14369 (with-current-buffer (or buffer (current-buffer))
14370 (save-excursion
14371 (save-restriction
14372 (widen)
14373 (goto-char (point-min))
14374 (let (case-fold-search)
14375 (if (re-search-forward
14376 (format org-complex-heading-regexp-format
14377 (regexp-quote heading)) nil t)
14378 (if pos-only
14379 (match-beginning 0)
14380 (move-marker (make-marker) (match-beginning 0)))))))))
14382 (defun org-find-exact-heading-in-directory (heading &optional dir)
14383 "Find Org node headline HEADING in all .org files in directory DIR.
14384 When the target headline is found, return a marker to this location."
14385 (let ((files (directory-files (or dir default-directory)
14387 file visiting m buffer)
14388 (catch 'found
14389 (while (setq file (pop files))
14390 (message "trying %s" file)
14391 (setq visiting (org-find-base-buffer-visiting file))
14392 (setq buffer (or visiting (find-file-noselect file)))
14393 (setq m (org-find-exact-headline-in-buffer
14394 heading buffer))
14395 (when (and (not m) (not visiting)) (kill-buffer buffer))
14396 (and m (throw 'found m))))))
14398 (defun org-find-entry-with-id (ident)
14399 "Locate the entry that contains the ID property with exact value IDENT.
14400 IDENT can be a string, a symbol or a number, this function will search for
14401 the string representation of it.
14402 Return the position where this entry starts, or nil if there is no such entry."
14403 (interactive "sID: ")
14404 (let ((id (cond
14405 ((stringp ident) ident)
14406 ((symbol-name ident) (symbol-name ident))
14407 ((numberp ident) (number-to-string ident))
14408 (t (error "IDENT %s must be a string, symbol or number" ident))))
14409 (case-fold-search nil))
14410 (save-excursion
14411 (save-restriction
14412 (widen)
14413 (goto-char (point-min))
14414 (when (re-search-forward
14416 nil t)
14417 (org-back-to-heading t)
14418 (point))))))
14420 ;;;; Timestamps
14422 (defvar org-last-changed-timestamp nil)
14423 (defvar org-last-inserted-timestamp nil
14424 "The last time stamp inserted with `org-insert-time-stamp'.")
14425 (defvar org-time-was-given) ; dynamically scoped parameter
14426 (defvar org-end-time-was-given) ; dynamically scoped parameter
14427 (defvar org-ts-what) ; dynamically scoped parameter
14429 (defun org-time-stamp (arg &optional inactive)
14430 "Prompt for a date/time and insert a time stamp.
14431 If the user specifies a time like HH:MM, or if this command is called
14432 with a prefix argument, the time stamp will contain date and time.
14433 Otherwise, only the date will be included. All parts of a date not
14434 specified by the user will be filled in from the current date/time.
14435 So if you press just return without typing anything, the time stamp
14436 will represent the current date/time. If there is already a timestamp
14437 at the cursor, it will be modified."
14438 (interactive "P")
14439 (let* ((ts nil)
14440 (default-time
14441 ;; Default time is either today, or, when entering a range,
14442 ;; the range start.
14443 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14444 (save-excursion
14445 (re-search-backward
14447 (- (point) 20) t)))
14448 (apply 'encode-time (org-parse-time-string (match-string 1)))
14449 (current-time)))
14450 (default-input (and ts (org-get-compact-tod ts)))
14451 (repeater (save-excursion
14452 (save-match-data
14453 (beginning-of-line)
14454 (when (re-search-forward
14456 (save-excursion (progn (end-of-line) (point))) t)
14457 (match-string 0)))))
14458 org-time-was-given org-end-time-was-given time)
14459 (cond
14460 ((and (org-at-timestamp-p t)
14461 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14462 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14463 (insert "--")
14464 (setq time (let ((this-command this-command))
14465 (org-read-date arg 'totime nil nil
14466 default-time default-input)))
14467 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14468 ((org-at-timestamp-p t)
14469 (setq time (let ((this-command this-command))
14470 (org-read-date arg 'totime nil nil default-time default-input)))
14471 (when (org-at-timestamp-p t) ; just to get the match data
14472 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14473 (replace-match "")
14474 (setq org-last-changed-timestamp
14475 (org-insert-time-stamp
14476 time (or org-time-was-given arg)
14477 inactive nil nil (list org-end-time-was-given)))
14478 (when repeater (goto-char (1- (point))) (insert " " repeater)
14479 (setq org-last-changed-timestamp
14480 (concat (substring org-last-inserted-timestamp 0 -1)
14481 " " repeater ">"))))
14482 (message "Timestamp updated"))
14483 (t
14484 (setq time (let ((this-command this-command))
14485 (org-read-date arg 'totime nil nil default-time default-input)))
14486 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14487 nil nil (list org-end-time-was-given))))))
14489 ;; FIXME: can we use this for something else, like computing time differences?
14490 (defun org-get-compact-tod (s)
14491 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14492 (let* ((t1 (match-string 1 s))
14493 (h1 (string-to-number (match-string 2 s)))
14494 (m1 (string-to-number (match-string 3 s)))
14495 (t2 (and (match-end 4) (match-string 5 s)))
14496 (h2 (and t2 (string-to-number (match-string 6 s))))
14497 (m2 (and t2 (string-to-number (match-string 7 s))))
14498 dh dm)
14499 (if (not t2)
14500 t1
14501 (setq dh (- h2 h1) dm (- m2 m1))
14502 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14503 (concat t1 "+" (number-to-string dh)
14504 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14506 (defun org-time-stamp-inactive (&optional arg)
14507 "Insert an inactive time stamp.
14508 An inactive time stamp is enclosed in square brackets instead of angle
14509 brackets. It is inactive in the sense that it does not trigger agenda entries,
14510 does not link to the calendar and cannot be changed with the S-cursor keys.
14511 So these are more for recording a certain time/date."
14512 (interactive "P")
14513 (org-time-stamp arg 'inactive))
14515 (defvar org-date-ovl (make-overlay 1 1))
14516 (overlay-put org-date-ovl 'face 'org-warning)
14517 (org-detach-overlay org-date-ovl)
14519 (defvar org-ans1) ; dynamically scoped parameter
14520 (defvar org-ans2) ; dynamically scoped parameter
14522 (defvar org-plain-time-of-day-regexp) ; defined below
14524 (defvar org-overriding-default-time nil) ; dynamically scoped
14525 (defvar org-read-date-overlay nil)
14526 (defvar org-dcst nil) ; dynamically scoped
14527 (defvar org-read-date-history nil)
14528 (defvar org-read-date-final-answer nil)
14529 (defvar org-read-date-analyze-futurep nil)
14530 (defvar org-read-date-analyze-forced-year nil)
14532 (defun org-read-date (&optional with-time to-time from-string prompt
14533 default-time default-input)
14534 "Read a date, possibly a time, and make things smooth for the user.
14535 The prompt will suggest to enter an ISO date, but you can also enter anything
14536 which will at least partially be understood by `parse-time-string'.
14537 Unrecognized parts of the date will default to the current day, month, year,
14538 hour and minute. If this command is called to replace a timestamp at point,
14539 of to enter the second timestamp of a range, the default time is taken
14540 from the existing stamp. Furthermore, the command prefers the future,
14541 so if you are giving a date where the year is not given, and the day-month
14542 combination is already past in the current year, it will assume you
14543 mean next year. For details, see the manual. A few examples:
14545 3-2-5 --> 2003-02-05
14546 feb 15 --> currentyear-02-15
14547 2/15 --> currentyear-02-15
14548 sep 12 9 --> 2009-09-12
14549 12:45 --> today 12:45
14550 22 sept 0:34 --> currentyear-09-22 0:34
14551 12 --> currentyear-currentmonth-12
14552 Fri --> nearest Friday (today or later)
14553 etc.
14555 Furthermore you can specify a relative date by giving, as the *first* thing
14556 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14557 change in days weeks, months, years.
14558 With a single plus or minus, the date is relative to today. With a double
14559 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14560 +4d --> four days from today
14561 +4 --> same as above
14562 +2w --> two weeks from today
14563 ++5 --> five days from default date
14565 The function understands only English month and weekday abbreviations,
14566 but this can be configured with the variables `parse-time-months' and
14567 `parse-time-weekdays'.
14569 While prompting, a calendar is popped up - you can also select the
14570 date with the mouse (button 1). The calendar shows a period of three
14571 months. To scroll it to other months, use the keys `>' and `<'.
14572 If you don't like the calendar, turn it off with
14573 \(setq org-read-date-popup-calendar nil)
14575 With optional argument TO-TIME, the date will immediately be converted
14576 to an internal time.
14577 With an optional argument WITH-TIME, the prompt will suggest to also
14578 insert a time. Note that when WITH-TIME is not set, you can still
14579 enter a time, and this function will inform the calling routine about
14580 this change. The calling routine may then choose to change the format
14581 used to insert the time stamp into the buffer to include the time.
14582 With optional argument FROM-STRING, read from this string instead from
14583 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14584 the time/date that is used for everything that is not specified by the
14585 user."
14586 (require 'parse-time)
14587 (let* ((org-time-stamp-rounding-minutes
14588 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14589 (org-dcst org-display-custom-times)
14590 (ct (org-current-time))
14591 (def (or org-overriding-default-time default-time ct))
14592 (defdecode (decode-time def))
14593 (dummy (progn
14594 (when (< (nth 2 defdecode) org-extend-today-until)
14595 (setcar (nthcdr 2 defdecode) -1)
14596 (setcar (nthcdr 1 defdecode) 59)
14597 (setq def (apply 'encode-time defdecode)
14598 defdecode (decode-time def)))))
14599 (calendar-frame-setup nil)
14600 (calendar-setup nil)
14601 (calendar-move-hook nil)
14602 (calendar-view-diary-initially-flag nil)
14603 (calendar-view-holidays-initially-flag nil)
14604 (timestr (format-time-string
14605 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14606 (prompt (concat (if prompt (concat prompt " ") "")
14607 (format "Date+time [%s]: " timestr)))
14608 ans (org-ans0 "") org-ans1 org-ans2 final)
14610 (cond
14611 (from-string (setq ans from-string))
14612 (org-read-date-popup-calendar
14613 (save-excursion
14614 (save-window-excursion
14615 (calendar)
14616 (unwind-protect
14617 (progn
14618 (calendar-forward-day (- (time-to-days def)
14619 (calendar-absolute-from-gregorian
14620 (calendar-current-date))))
14621 (org-eval-in-calendar nil t)
14622 (let* ((old-map (current-local-map))
14623 (map (copy-keymap calendar-mode-map))
14624 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14625 (org-defkey map (kbd "RET") 'org-calendar-select)
14626 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14627 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14628 (org-defkey minibuffer-local-map [(meta shift left)]
14629 (lambda () (interactive)
14630 (org-eval-in-calendar '(calendar-backward-month 1))))
14631 (org-defkey minibuffer-local-map [(meta shift right)]
14632 (lambda () (interactive)
14633 (org-eval-in-calendar '(calendar-forward-month 1))))
14634 (org-defkey minibuffer-local-map [(meta shift up)]
14635 (lambda () (interactive)
14636 (org-eval-in-calendar '(calendar-backward-year 1))))
14637 (org-defkey minibuffer-local-map [(meta shift down)]
14638 (lambda () (interactive)
14639 (org-eval-in-calendar '(calendar-forward-year 1))))
14640 (org-defkey minibuffer-local-map [?\e (shift left)]
14641 (lambda () (interactive)
14642 (org-eval-in-calendar '(calendar-backward-month 1))))
14643 (org-defkey minibuffer-local-map [?\e (shift right)]
14644 (lambda () (interactive)
14645 (org-eval-in-calendar '(calendar-forward-month 1))))
14646 (org-defkey minibuffer-local-map [?\e (shift up)]
14647 (lambda () (interactive)
14648 (org-eval-in-calendar '(calendar-backward-year 1))))
14649 (org-defkey minibuffer-local-map [?\e (shift down)]
14650 (lambda () (interactive)
14651 (org-eval-in-calendar '(calendar-forward-year 1))))
14652 (org-defkey minibuffer-local-map [(shift up)]
14653 (lambda () (interactive)
14654 (org-eval-in-calendar '(calendar-backward-week 1))))
14655 (org-defkey minibuffer-local-map [(shift down)]
14656 (lambda () (interactive)
14657 (org-eval-in-calendar '(calendar-forward-week 1))))
14658 (org-defkey minibuffer-local-map [(shift left)]
14659 (lambda () (interactive)
14660 (org-eval-in-calendar '(calendar-backward-day 1))))
14661 (org-defkey minibuffer-local-map [(shift right)]
14662 (lambda () (interactive)
14663 (org-eval-in-calendar '(calendar-forward-day 1))))
14664 (org-defkey minibuffer-local-map ">"
14665 (lambda () (interactive)
14666 (org-eval-in-calendar '(scroll-calendar-left 1))))
14667 (org-defkey minibuffer-local-map "<"
14668 (lambda () (interactive)
14669 (org-eval-in-calendar '(scroll-calendar-right 1))))
14670 (org-defkey minibuffer-local-map "\C-v"
14671 (lambda () (interactive)
14672 (org-eval-in-calendar
14673 '(calendar-scroll-left-three-months 1))))
14674 (org-defkey minibuffer-local-map "\M-v"
14675 (lambda () (interactive)
14676 (org-eval-in-calendar
14677 '(calendar-scroll-right-three-months 1))))
14678 (run-hooks 'org-read-date-minibuffer-setup-hook)
14679 (unwind-protect
14680 (progn
14681 (use-local-map map)
14682 (add-hook 'post-command-hook 'org-read-date-display)
14683 (setq org-ans0 (read-string prompt default-input
14684 'org-read-date-history nil))
14685 ;; org-ans0: from prompt
14686 ;; org-ans1: from mouse click
14687 ;; org-ans2: from calendar motion
14688 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14689 (remove-hook 'post-command-hook 'org-read-date-display)
14690 (use-local-map old-map)
14691 (when org-read-date-overlay
14692 (delete-overlay org-read-date-overlay)
14693 (setq org-read-date-overlay nil)))))
14694 (bury-buffer "*Calendar*")))))
14696 (t ; Naked prompt only
14697 (unwind-protect
14698 (setq ans (read-string prompt default-input
14699 'org-read-date-history timestr))
14700 (when org-read-date-overlay
14701 (delete-overlay org-read-date-overlay)
14702 (setq org-read-date-overlay nil)))))
14704 (setq final (org-read-date-analyze ans def defdecode))
14706 (when org-read-date-analyze-forced-year
14707 (message "Year was forced into %s"
14708 (if org-read-date-force-compatible-dates
14709 "compatible range (1970-2037)"
14710 "range representable on this machine"))
14711 (ding))
14713 ;; One round trip to get rid of 34th of August and stuff like that....
14714 (setq final (decode-time (apply 'encode-time final)))
14716 (setq org-read-date-final-answer ans)
14718 (if to-time
14719 (apply 'encode-time final)
14720 (if (and (boundp 'org-time-was-given) org-time-was-given)
14721 (format "%04d-%02d-%02d %02d:%02d"
14722 (nth 5 final) (nth 4 final) (nth 3 final)
14723 (nth 2 final) (nth 1 final))
14724 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14726 (defvar def)
14727 (defvar defdecode)
14728 (defvar with-time)
14729 (defun org-read-date-display ()
14730 "Display the current date prompt interpretation in the minibuffer."
14731 (when org-read-date-display-live
14732 (when org-read-date-overlay
14733 (delete-overlay org-read-date-overlay))
14734 (let ((p (point)))
14735 (end-of-line 1)
14736 (while (not (equal (buffer-substring
14737 (max (point-min) (- (point) 4)) (point))
14738 " "))
14739 (insert " "))
14740 (goto-char p))
14741 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14742 " " (or org-ans1 org-ans2)))
14743 (org-end-time-was-given nil)
14744 (f (org-read-date-analyze ans def defdecode))
14745 (fmts (if org-dcst
14746 org-time-stamp-custom-formats
14747 org-time-stamp-formats))
14748 (fmt (if (or with-time
14749 (and (boundp 'org-time-was-given) org-time-was-given))
14750 (cdr fmts)
14751 (car fmts)))
14752 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14753 (when (and org-end-time-was-given
14754 (string-match org-plain-time-of-day-regexp txt))
14755 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14756 org-end-time-was-given
14757 (substring txt (match-end 0)))))
14758 (when org-read-date-analyze-futurep
14759 (setq txt (concat txt " (=>F)")))
14760 (setq org-read-date-overlay
14761 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14762 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14764 (defun org-read-date-analyze (ans def defdecode)
14765 "Analyze the combined answer of the date prompt."
14766 ;; FIXME: cleanup and comment
14767 (let ((nowdecode (decode-time (current-time)))
14768 delta deltan deltaw deltadef year month day
14769 hour minute second wday pm h2 m2 tl wday1
14770 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14771 (setq org-read-date-analyze-futurep nil
14772 org-read-date-analyze-forced-year nil)
14774 (setq ans "+0"))
14776 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14777 (setq ans (replace-match "" t t ans)
14778 deltan (car delta)
14779 deltaw (nth 1 delta)
14780 deltadef (nth 2 delta)))
14782 ;; Check if there is an iso week date in there
14783 ;; If yes, store the info and postpone interpreting it until the rest
14784 ;; of the parsing is done
14785 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14786 (setq iso-year (if (match-end 1)
14787 (org-small-year-to-year
14788 (string-to-number (match-string 1 ans))))
14789 iso-weekday (if (match-end 3)
14790 (string-to-number (match-string 3 ans)))
14791 iso-week (string-to-number (match-string 2 ans)))
14792 (setq ans (replace-match "" t t ans)))
14794 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14795 (when (string-match
14797 (setq year (if (match-end 2)
14798 (string-to-number (match-string 2 ans))
14799 (progn (setq kill-year t)
14800 (string-to-number (format-time-string "%Y"))))
14801 month (string-to-number (match-string 3 ans))
14802 day (string-to-number (match-string 4 ans)))
14803 (if (< year 100) (setq year (+ 2000 year)))
14805 t nil ans)))
14807 ;; Help matching dottet european dates
14808 (when (string-match
14809 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14810 (setq year (if (match-end 3)
14811 (string-to-number (match-string 3 ans))
14812 (progn (setq kill-year t)
14813 (string-to-number (format-time-string "%Y"))))
14814 day (string-to-number (match-string 1 ans))
14815 month (string-to-number (match-string 2 ans))
14817 t nil ans)))
14819 ;; Help matching american dates, like 5/30 or 5/30/7
14820 (when (string-match
14821 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14822 (setq year (if (match-end 4)
14823 (string-to-number (match-string 4 ans))
14824 (progn (setq kill-year t)
14825 (string-to-number (format-time-string "%Y"))))
14826 month (string-to-number (match-string 1 ans))
14827 day (string-to-number (match-string 2 ans)))
14828 (if (< year 100) (setq year (+ 2000 year)))
14830 t nil ans)))
14831 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14832 ;; If there is a time with am/pm, and *no* time without it, we convert
14833 ;; so that matching will be successful.
14834 (loop for i from 1 to 2 do ; twice, for end time as well
14837 (setq hour (string-to-number (match-string 1 ans))
14838 minute (if (match-end 3)
14839 (string-to-number (match-string 3 ans))
14840 0)
14841 pm (equal ?p
14842 (string-to-char (downcase (match-string 4 ans)))))
14843 (if (and (= hour 12) (not pm))
14844 (setq hour 0)
14845 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14846 (setq ans (replace-match (format "%02d:%02d" hour minute)
14847 t t ans))))
14849 ;; Check if a time range is given as a duration
14850 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14851 (setq hour (string-to-number (match-string 1 ans))
14852 h2 (+ hour (string-to-number (match-string 3 ans)))
14853 minute (string-to-number (match-string 2 ans))
14854 m2 (+ minute (if (match-end 5) (string-to-number
14855 (match-string 5 ans))0)))
14856 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14857 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14858 t t ans)))
14860 ;; Check if there is a time range
14861 (when (boundp 'org-end-time-was-given)
14862 (setq org-time-was-given nil)
14863 (when (and (string-match org-plain-time-of-day-regexp ans)
14864 (match-end 8))
14865 (setq org-end-time-was-given (match-string 8 ans))
14866 (setq ans (concat (substring ans 0 (match-beginning 7))
14867 (substring ans (match-end 7))))))
14869 (setq tl (parse-time-string ans)
14870 day (or (nth 3 tl) (nth 3 defdecode))
14871 month (or (nth 4 tl)
14872 (if (and org-read-date-prefer-future
14873 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14874 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14875 (nth 4 defdecode)))
14876 year (or (and (not kill-year) (nth 5 tl))
14877 (if (and org-read-date-prefer-future
14878 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14879 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14880 (nth 5 defdecode)))
14881 hour (or (nth 2 tl) (nth 2 defdecode))
14882 minute (or (nth 1 tl) (nth 1 defdecode))
14883 second (or (nth 0 tl) 0)
14884 wday (nth 6 tl))
14886 (when (and (eq org-read-date-prefer-future 'time)
14887 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14888 (equal day (nth 3 nowdecode))
14889 (equal month (nth 4 nowdecode))
14890 (equal year (nth 5 nowdecode))
14891 (nth 2 tl)
14892 (or (< (nth 2 tl) (nth 2 nowdecode))
14893 (and (= (nth 2 tl) (nth 2 nowdecode))
14894 (nth 1 tl)
14895 (< (nth 1 tl) (nth 1 nowdecode)))))
14896 (setq day (1+ day)
14897 futurep t))
14899 ;; Special date definitions below
14900 (cond
14901 (iso-week
14902 ;; There was an iso week
14903 (require 'cal-iso)
14904 (setq futurep nil)
14905 (setq year (or iso-year year)
14906 day (or iso-weekday wday 1)
14907 wday nil ; to make sure that the trigger below does not match
14908 iso-date (calendar-gregorian-from-absolute
14909 (calendar-absolute-from-iso
14910 (list iso-week day year))))
14911 ; FIXME: Should we also push ISO weeks into the future?
14912 ; (when (and org-read-date-prefer-future
14913 ; (not iso-year)
14914 ; (< (calendar-absolute-from-gregorian iso-date)
14915 ; (time-to-days (current-time))))
14916 ; (setq year (1+ year)
14917 ; iso-date (calendar-gregorian-from-absolute
14918 ; (calendar-absolute-from-iso
14919 ; (list iso-week day year)))))
14920 (setq month (car iso-date)
14921 year (nth 2 iso-date)
14922 day (nth 1 iso-date)))
14923 (deltan
14924 (setq futurep nil)
14925 (unless deltadef
14926 (let ((now (decode-time (current-time))))
14927 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14928 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14929 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14930 ((equal deltaw "m") (setq month (+ month deltan)))
14931 ((equal deltaw "y") (setq year (+ year deltan)))))
14932 ((and wday (not (nth 3 tl)))
14933 (setq futurep nil)
14934 ;; Weekday was given, but no day, so pick that day in the week
14935 ;; on or after the derived date.
14936 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14937 (unless (equal wday wday1)
14938 (setq day (+ day (% (- wday wday1 -7) 7))))))
14939 (if (and (boundp 'org-time-was-given)
14940 (nth 2 tl))
14941 (setq org-time-was-given t))
14942 (if (< year 100) (setq year (+ 2000 year)))
14943 ;; Check of the date is representable
14944 (if org-read-date-force-compatible-dates
14945 (progn
14946 (if (< year 1970)
14947 (setq year 1970 org-read-date-analyze-forced-year t))
14948 (if (> year 2037)
14949 (setq year 2037 org-read-date-analyze-forced-year t)))
14950 (condition-case nil
14951 (ignore (encode-time second minute hour day month year))
14952 (error
14953 (setq year (nth 5 defdecode))
14954 (setq org-read-date-analyze-forced-year t))))
14955 (setq org-read-date-analyze-futurep futurep)
14956 (list second minute hour day month year)))
14958 (defvar parse-time-weekdays)
14960 (defun org-read-date-get-relative (s today default)
14961 "Check string S for special relative date string.
14962 TODAY and DEFAULT are internal times, for today and for a default.
14963 Return shift list (N what def-flag)
14965 N is the number of WHATs to shift.
14966 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14967 the DEFAULT date rather than TODAY."
14968 (when (and
14969 (string-match
14970 (concat
14975 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14976 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14977 (string-to-char (substring (match-string 1 s) -1))
14978 ?+))
14979 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14980 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14981 (what (if (match-end 3) (match-string 3 s) "d"))
14982 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14983 (date (if rel default today))
14984 (wday (nth 6 (decode-time date)))
14985 delta)
14986 (if wday1
14987 (progn
14988 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14989 (if (= dir ?-) (setq delta (- delta 7)))
14990 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14991 (list delta "d" rel))
14992 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14994 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14995 "Turn a user-specified date into the internal representation.
14996 The internal representation needed by the calendar is (month day year).
14997 This is a wrapper to handle the brain-dead convention in calendar that
14998 user function argument order change dependent on argument order."
14999 (if (boundp 'calendar-date-style)
15000 (cond
15001 ((eq calendar-date-style 'american)
15002 (list arg1 arg2 arg3))
15003 ((eq calendar-date-style 'european)
15004 (list arg2 arg1 arg3))
15005 ((eq calendar-date-style 'iso)
15006 (list arg2 arg3 arg1)))
15007 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15008 (if (org-bound-and-true-p european-calendar-style)
15009 (list arg2 arg1 arg3)
15010 (list arg1 arg2 arg3)))))
15012 (defun org-eval-in-calendar (form &optional keepdate)
15013 "Eval FORM in the calendar window and return to current window.
15014 Also, store the cursor date in variable org-ans2."
15015 (let ((sf (selected-frame))
15016 (sw (selected-window)))
15017 (select-window (get-buffer-window "*Calendar*" t))
15018 (eval form)
15019 (when (and (not keepdate) (calendar-cursor-to-date))
15020 (let* ((date (calendar-cursor-to-date))
15021 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15022 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15023 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15024 (select-window sw)
15025 (org-select-frame-set-input-focus sf)))
15027 (defun org-calendar-select ()
15028 "Return to `org-read-date' with the date currently selected.
15029 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15030 (interactive)
15031 (when (calendar-cursor-to-date)
15032 (let* ((date (calendar-cursor-to-date))
15033 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15034 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15035 (if (active-minibuffer-window) (exit-minibuffer))))
15037 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15038 "Insert a date stamp for the date given by the internal TIME.
15039 WITH-HM means use the stamp format that includes the time of the day.
15040 INACTIVE means use square brackets instead of angular ones, so that the
15041 stamp will not contribute to the agenda.
15042 PRE and POST are optional strings to be inserted before and after the
15043 stamp.
15044 The command returns the inserted time stamp."
15045 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15046 stamp)
15047 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15048 (insert-before-markers (or pre ""))
15049 (when (listp extra)
15050 (setq extra (car extra))
15051 (if (and (stringp extra)
15053 (setq extra (format "-%02d:%02d"
15054 (string-to-number (match-string 1 extra))
15055 (string-to-number (match-string 2 extra))))
15056 (setq extra nil)))
15057 (when extra
15058 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15059 (insert-before-markers (setq stamp (format-time-string fmt time)))
15060 (insert-before-markers (or post ""))
15061 (setq org-last-inserted-timestamp stamp)))
15063 (defun org-toggle-time-stamp-overlays ()
15064 "Toggle the use of custom time stamp formats."
15065 (interactive)
15066 (setq org-display-custom-times (not org-display-custom-times))
15067 (unless org-display-custom-times
15068 (let ((p (point-min)) (bmp (buffer-modified-p)))
15069 (while (setq p (next-single-property-change p 'display))
15070 (if (and (get-text-property p 'display)
15071 (eq (get-text-property p 'face) 'org-date))
15072 (remove-text-properties
15073 p (setq p (next-single-property-change p 'display))
15074 '(display t))))
15075 (set-buffer-modified-p bmp)))
15076 (if (featurep 'xemacs)
15077 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15078 (org-restart-font-lock)
15079 (setq org-table-may-need-update t)
15080 (if org-display-custom-times
15081 (message "Time stamps are overlayed with custom format")
15082 (message "Time stamp overlays removed")))
15084 (defun org-display-custom-time (beg end)
15085 "Overlay modified time stamp format over timestamp between BEG and END."
15086 (let* ((ts (buffer-substring beg end))
15087 t1 w1 with-hm tf time str w2 (off 0))
15088 (save-match-data
15089 (setq t1 (org-parse-time-string ts t))
15090 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15091 (setq off (- (match-end 0) (match-beginning 0)))))
15092 (setq end (- end off))
15093 (setq w1 (- end beg)
15094 with-hm (and (nth 1 t1) (nth 2 t1))
15095 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15096 time (org-fix-decoded-time t1)
15097 str (org-add-props
15098 (format-time-string
15099 (substring tf 1 -1) (apply 'encode-time time))
15100 nil 'mouse-face 'highlight)
15101 w2 (length str))
15102 (if (not (= w2 w1))
15103 (add-text-properties (1+ beg) (+ 2 beg)
15104 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15105 (if (featurep 'xemacs)
15106 (progn
15107 (put-text-property beg end 'invisible t)
15108 (put-text-property beg end 'end-glyph (make-glyph str)))
15109 (put-text-property beg end 'display str))))
15111 (defun org-translate-time (string)
15112 "Translate all timestamps in STRING to custom format.
15113 But do this only if the variable `org-display-custom-times' is set."
15114 (when org-display-custom-times
15115 (save-match-data
15116 (let* ((start 0)
15117 (re org-ts-regexp-both)
15118 t1 with-hm inactive tf time str beg end)
15119 (while (setq start (string-match re string start))
15120 (setq beg (match-beginning 0)
15121 end (match-end 0)
15122 t1 (save-match-data
15123 (org-parse-time-string (substring string beg end) t))
15124 with-hm (and (nth 1 t1) (nth 2 t1))
15125 inactive (equal (substring string beg (1+ beg)) "[")
15126 tf (funcall (if with-hm 'cdr 'car)
15127 org-time-stamp-custom-formats)
15128 time (org-fix-decoded-time t1)
15129 str (format-time-string
15130 (concat
15131 (if inactive "[" "<") (substring tf 1 -1)
15132 (if inactive "]" ">"))
15133 (apply 'encode-time time))
15134 string (replace-match str t t string)
15135 start (+ start (length str)))))))
15136 string)
15138 (defun org-fix-decoded-time (time)
15139 "Set 0 instead of nil for the first 6 elements of time.
15140 Don't touch the rest."
15141 (let ((n 0))
15142 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15144 (defun org-days-to-time (timestamp-string)
15145 "Difference between TIMESTAMP-STRING and now in days."
15146 (- (time-to-days (org-time-string-to-time timestamp-string))
15147 (time-to-days (current-time))))
15149 (defun org-deadline-close (timestamp-string &optional ndays)
15150 "Is the time in TIMESTAMP-STRING close to the current date?"
15151 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15152 (and (< (org-days-to-time timestamp-string) ndays)
15153 (not (org-entry-is-done-p))))
15155 (defun org-get-wdays (ts)
15156 "Get the deadline lead time appropriate for timestring TS."
15157 (cond
15158 ((<= org-deadline-warning-days 0)
15159 ;; 0 or negative, enforce this value no matter what
15160 (- org-deadline-warning-days))
15162 ;; lead time is specified.
15163 (floor (* (string-to-number (match-string 1 ts))
15164 (cdr (assoc (match-string 2 ts)
15165 '(("d" . 1) ("w" . 7)
15166 ("m" . 30.4) ("y" . 365.25)))))))
15167 ;; go for the default.
15168 (t org-deadline-warning-days)))
15170 (defun org-calendar-select-mouse (ev)
15171 "Return to `org-read-date' with the date currently selected.
15172 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15173 (interactive "e")
15174 (mouse-set-point ev)
15175 (when (calendar-cursor-to-date)
15176 (let* ((date (calendar-cursor-to-date))
15177 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15178 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15179 (if (active-minibuffer-window) (exit-minibuffer))))
15181 (defun org-check-deadlines (ndays)
15182 "Check if there are any deadlines due or past due.
15183 A deadline is considered due if it happens within `org-deadline-warning-days'
15184 days from today's date. If the deadline appears in an entry marked DONE,
15185 it is not shown. The prefix arg NDAYS can be used to test that many
15187 (interactive "P")
15188 (let* ((org-warn-days
15189 (cond
15190 ((equal ndays '(4)) 100000)
15191 (ndays (prefix-numeric-value ndays))
15192 (t (abs org-deadline-warning-days))))
15193 (case-fold-search nil)
15195 (callback
15196 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15198 (message "%d deadlines past-due or due within %d days"
15199 (org-occur regexp nil callback)
15200 org-warn-days)))
15202 (defun org-check-before-date (date)
15203 "Check if there are deadlines or scheduled entries before DATE."
15204 (interactive (list (org-read-date)))
15205 (let ((case-fold-search nil)
15209 (callback
15210 (lambda () (time-less-p
15211 (org-time-string-to-time (match-string 2))
15212 (org-time-string-to-time date)))))
15213 (message "%d entries before %s"
15214 (org-occur regexp nil callback) date)))
15216 (defun org-check-after-date (date)
15217 "Check if there are deadlines or scheduled entries after DATE."
15218 (interactive (list (org-read-date)))
15219 (let ((case-fold-search nil)
15223 (callback
15224 (lambda () (not
15225 (time-less-p
15226 (org-time-string-to-time (match-string 2))
15227 (org-time-string-to-time date))))))
15228 (message "%d entries after %s"
15229 (org-occur regexp nil callback) date)))
15231 (defun org-evaluate-time-range (&optional to-buffer)
15232 "Evaluate a time range by computing the difference between start and end.
15233 Normally the result is just printed in the echo area, but with prefix arg
15234 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15235 If the time range is actually in a table, the result is inserted into the
15236 next column.
15237 For time difference computation, a year is assumed to be exactly 365
15238 days in order to avoid rounding problems."
15239 (interactive "P")
15240 (or
15241 (org-clock-update-time-maybe)
15242 (save-excursion
15243 (unless (org-at-date-range-p t)
15244 (goto-char (point-at-bol))
15245 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15246 (if (not (org-at-date-range-p t))
15247 (error "Not at a time-stamp range, and none found in current line")))
15248 (let* ((ts1 (match-string 1))
15249 (ts2 (match-string 2))
15250 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15251 (match-end (match-end 0))
15252 (time1 (org-time-string-to-time ts1))
15253 (time2 (org-time-string-to-time ts2))
15254 (t1 (org-float-time time1))
15255 (t2 (org-float-time time2))
15256 (diff (abs (- t2 t1)))
15257 (negative (< (- t2 t1) 0))
15258 ;; (ys (floor (* 365 24 60 60)))
15259 (ds (* 24 60 60))
15260 (hs (* 60 60))
15261 (fy "%dy %dd %02d:%02d")
15262 (fy1 "%dy %dd")
15263 (fd "%dd %02d:%02d")
15264 (fd1 "%dd")
15265 (fh "%02d:%02d")
15266 y d h m align)
15267 (if havetime
15268 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15269 y 0
15270 d (floor (/ diff ds)) diff (mod diff ds)
15271 h (floor (/ diff hs)) diff (mod diff hs)
15272 m (floor (/ diff 60)))
15273 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15274 y 0
15275 d (floor (+ (/ diff ds) 0.5))
15276 h 0 m 0))
15277 (if (not to-buffer)
15278 (message "%s" (org-make-tdiff-string y d h m))
15279 (if (org-at-table-p)
15280 (progn
15281 (goto-char match-end)
15282 (setq align t)
15283 (and (looking-at " *|") (goto-char (match-end 0))))
15284 (goto-char match-end))
15285 (if (looking-at
15287 (replace-match ""))
15288 (if negative (insert " -"))
15289 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15290 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15291 (insert " " (format fh h m))))
15292 (if align (org-table-align))
15293 (message "Time difference inserted")))))
15295 (defun org-make-tdiff-string (y d h m)
15296 (let ((fmt "")
15297 (l nil))
15298 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15299 l (push y l)))
15300 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15301 l (push d l)))
15302 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15303 l (push h l)))
15304 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15305 l (push m l)))
15306 (apply 'format fmt (nreverse l))))
15308 (defun org-time-string-to-time (s)
15309 (apply 'encode-time (org-parse-time-string s)))
15310 (defun org-time-string-to-seconds (s)
15311 (org-float-time (org-time-string-to-time s)))
15313 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15314 "Convert a time stamp to an absolute day number.
15315 If there is a specifier for a cyclic time stamp, get the closest date to
15316 DAYNR.
15317 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15318 The variable date is bound by the calendar when this is called."
15319 (cond
15321 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15322 daynr
15323 (+ daynr 1000)))
15325 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15326 (time-to-days (current-time))) (match-string 0 s)
15327 prefer show-all))
15328 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15330 (defun org-days-to-iso-week (days)
15331 "Return the iso week number."
15332 (require 'cal-iso)
15333 (car (calendar-iso-from-absolute days)))
15335 (defun org-small-year-to-year (year)
15336 "Convert 2-digit years into 4-digit years.
15337 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15338 The year 2000 cannot be abbreviated. Any year larger than 99
15339 is returned unchanged."
15340 (if (< year 38)
15341 (setq year (+ 2000 year))
15342 (if (< year 100)
15343 (setq year (+ 1900 year))))
15344 year)
15346 (defun org-time-from-absolute (d)
15347 "Return the time corresponding to date D.
15348 D may be an absolute day number, or a calendar-type list (month day year)."
15349 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15350 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15352 (defun org-calendar-holiday ()
15353 "List of holidays, for Diary display in Org-mode."
15354 (require 'holidays)
15355 (let ((hl (funcall
15356 (if (fboundp 'calendar-check-holidays)
15357 'calendar-check-holidays 'check-calendar-holidays) date)))
15358 (if hl (mapconcat 'identity hl "; "))))
15360 (defun org-diary-sexp-entry (sexp entry date)
15361 "Process a SEXP diary ENTRY for DATE."
15362 (require 'diary-lib)
15363 (let ((result (if calendar-debug-sexp
15364 (let ((stack-trace-on-error t))
15365 (eval (car (read-from-string sexp))))
15366 (condition-case nil
15367 (eval (car (read-from-string sexp)))
15368 (error
15369 (beep)
15370 (message "Bad sexp at line %d in %s: %s"
15371 (org-current-line)
15372 (buffer-file-name) sexp)
15373 (sleep-for 2))))))
15374 (cond ((stringp result) (split-string result "; "))
15375 ((and (consp result)
15376 (not (consp (cdr result)))
15377 (stringp (cdr result))) (cdr result))
15378 ((and (consp result)
15379 (stringp (car result))) result)
15380 (result entry)
15381 (t nil))))
15383 (defun org-diary-to-ical-string (frombuf)
15384 "Get iCalendar entries from diary entries in buffer FROMBUF.
15385 This uses the icalendar.el library."
15386 (let* ((tmpdir (if (featurep 'xemacs)
15387 (temp-directory)
15388 temporary-file-directory))
15389 (tmpfile (make-temp-name
15390 (expand-file-name "orgics" tmpdir)))
15391 buf rtn b e)
15392 (with-current-buffer frombuf
15393 (icalendar-export-region (point-min) (point-max) tmpfile)
15394 (setq buf (find-buffer-visiting tmpfile))
15395 (set-buffer buf)
15396 (goto-char (point-min))
15397 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15398 (setq b (match-beginning 0)))
15399 (goto-char (point-max))
15400 (if (re-search-backward "^END:VEVENT" nil t)
15401 (setq e (match-end 0)))
15403 (kill-buffer buf)
15404 (delete-file tmpfile)
15405 rtn))
15407 (defun org-closest-date (start current change prefer show-all)
15408 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15409 When PREFER is `past', return a date that is either CURRENT or past.
15410 When PREFER is `future', return a date that is either CURRENT or future.
15411 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15412 ;; Make the proper lists from the dates
15413 (catch 'exit
15414 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15415 dn dw sday cday n1 n2 n0
15416 d m y y1 y2 date1 date2 nmonths nm ny m2)
15418 (setq start (org-date-to-gregorian start)
15419 current (org-date-to-gregorian
15420 (if show-all
15421 current
15422 (time-to-days (current-time))))
15423 sday (calendar-absolute-from-gregorian start)
15424 cday (calendar-absolute-from-gregorian current))
15426 (if (<= cday sday) (throw 'exit sday))
15429 (setq dn (string-to-number (match-string 1 change))
15430 dw (cdr (assoc (match-string 2 change) a1)))
15431 (error "Invalid change specifier: %s" change))
15432 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15433 (cond
15434 ((eq dw 'day)
15435 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15436 n2 (+ n1 dn)))
15437 ((eq dw 'year)
15438 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15439 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15440 (setq date1 (list m d y1)
15441 n1 (calendar-absolute-from-gregorian date1)
15442 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15443 n2 (calendar-absolute-from-gregorian date2)))
15444 ((eq dw 'month)
15445 ;; approx number of month between the two dates
15446 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15447 ;; How often does dn fit in there?
15448 (setq d (nth 1 start) m (car start) y (nth 2 start)
15449 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15450 m (+ m nm)
15451 ny (floor (/ m 12))
15452 y (+ y ny)
15453 m (- m (* ny 12)))
15454 (while (> m 12) (setq m (- m 12) y (1+ y)))
15455 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15456 (setq m2 (+ m dn) y2 y)
15457 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15458 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15459 (while (<= n2 cday)
15460 (setq n1 n2 m m2 y y2)
15461 (setq m2 (+ m dn) y2 y)
15462 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15463 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15464 ;; Make sure n1 is the earlier date
15465 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15466 (if show-all
15467 (cond
15468 ((eq prefer 'past) (if (= cday n2) n2 n1))
15469 ((eq prefer 'future) (if (= cday n1) n1 n2))
15470 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15471 (cond
15472 ((eq prefer 'past) (if (= cday n2) n2 n1))
15473 ((eq prefer 'future) (if (= cday n1) n1 n2))
15474 (t (if (= cday n1) n1 n2)))))))
15476 (defun org-date-to-gregorian (date)
15477 "Turn any specification of DATE into a Gregorian date for the calendar."
15478 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15479 ((and (listp date) (= (length date) 3)) date)
15480 ((stringp date)
15481 (setq date (org-parse-time-string date))
15482 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15483 ((listp date)
15484 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15486 (defun org-parse-time-string (s &optional nodefault)
15487 "Parse the standard Org-mode time string.
15488 This should be a lot faster than the normal `parse-time-string'.
15489 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15490 hour and minute fields will be nil if not given."
15491 (if (string-match org-ts-regexp0 s)
15492 (list 0
15493 (if (or (match-beginning 8) (not nodefault))
15494 (string-to-number (or (match-string 8 s) "0")))
15495 (if (or (match-beginning 7) (not nodefault))
15496 (string-to-number (or (match-string 7 s) "0")))
15497 (string-to-number (match-string 4 s))
15498 (string-to-number (match-string 3 s))
15499 (string-to-number (match-string 2 s))
15500 nil nil nil)
15501 (error "Not a standard Org-mode time string: %s" s)))
15503 (defun org-timestamp-up (&optional arg)
15504 "Increase the date item at the cursor by one.
15505 If the cursor is on the year, change the year. If it is on the month,
15506 the day or the time, change that.
15507 With prefix ARG, change by that many units."
15508 (interactive "p")
15509 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15511 (defun org-timestamp-down (&optional arg)
15512 "Decrease the date item at the cursor by one.
15513 If the cursor is on the year, change the year. If it is on the month,
15514 the day or the time, change that.
15515 With prefix ARG, change by that many units."
15516 (interactive "p")
15517 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15519 (defun org-timestamp-up-day (&optional arg)
15520 "Increase the date in the time stamp by one day.
15521 With prefix ARG, change that many days."
15522 (interactive "p")
15523 (if (and (not (org-at-timestamp-p t))
15524 (org-on-heading-p))
15525 (org-todo 'up)
15526 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15528 (defun org-timestamp-down-day (&optional arg)
15529 "Decrease the date in the time stamp by one day.
15530 With prefix ARG, change that many days."
15531 (interactive "p")
15532 (if (and (not (org-at-timestamp-p t))
15533 (org-on-heading-p))
15534 (org-todo 'down)
15535 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15537 (defun org-at-timestamp-p (&optional inactive-ok)
15538 "Determine if the cursor is in or at a timestamp."
15539 (interactive)
15540 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15541 (pos (point))
15542 (ans (or (looking-at tsr)
15543 (save-excursion
15545 (if (> (point) (point-min)) (backward-char 1))
15546 (and (looking-at tsr)
15547 (> (- (match-end 0) pos) -1))))))
15548 (and ans
15549 (boundp 'org-ts-what)
15550 (setq org-ts-what
15551 (cond
15552 ((= pos (match-beginning 0)) 'bracket)
15553 ((= pos (1- (match-end 0))) 'bracket)
15554 ((org-pos-in-match-range pos 2) 'year)
15555 ((org-pos-in-match-range pos 3) 'month)
15556 ((org-pos-in-match-range pos 7) 'hour)
15557 ((org-pos-in-match-range pos 8) 'minute)
15558 ((or (org-pos-in-match-range pos 4)
15559 (org-pos-in-match-range pos 5)) 'day)
15560 ((and (> pos (or (match-end 8) (match-end 5)))
15561 (< pos (match-end 0)))
15562 (- pos (or (match-end 8) (match-end 5))))
15563 (t 'day))))
15564 ans))
15566 (defun org-toggle-timestamp-type ()
15567 "Toggle the type (<active> or [inactive]) of a time stamp."
15568 (interactive)
15569 (when (org-at-timestamp-p t)
15570 (let ((beg (match-beginning 0)) (end (match-end 0))
15571 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15572 (save-excursion
15573 (goto-char beg)
15574 (while (re-search-forward "[][<>]" end t)
15575 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15576 t t)))
15577 (message "Timestamp is now %sactive"
15578 (if (equal (char-after beg) ?<) "" "in")))))
15580 (defun org-timestamp-change (n &optional what updown)
15581 "Change the date in the time stamp at point.
15582 The date will be changed by N times WHAT. WHAT can be `day', `month',
15583 `year', `minute', `second'. If WHAT is not given, the cursor position
15584 in the timestamp determines what will be changed."
15585 (let ((pos (point))
15586 with-hm inactive
15587 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15588 org-ts-what
15589 extra rem
15590 ts time time0)
15591 (if (not (org-at-timestamp-p t))
15592 (error "Not at a timestamp"))
15593 (if (and (not what) (eq org-ts-what 'bracket))
15594 (org-toggle-timestamp-type)
15595 (if (and (not what) (not (eq org-ts-what 'day))
15596 org-display-custom-times
15597 (get-text-property (point) 'display)
15598 (not (get-text-property (1- (point)) 'display)))
15599 (setq org-ts-what 'day))
15600 (setq org-ts-what (or what org-ts-what)
15601 inactive (= (char-after (match-beginning 0)) ?\[)
15602 ts (match-string 0))
15603 (replace-match "")
15604 (if (string-match
15606 ts)
15607 (setq extra (match-string 1 ts)))
15609 (setq with-hm t))
15610 (setq time0 (org-parse-time-string ts))
15611 (when (and updown
15612 (eq org-ts-what 'minute)
15613 (not current-prefix-arg))
15614 ;; This looks like s-up and s-down. Change by one rounding step.
15615 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15616 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15617 (setcar (cdr time0) (+ (nth 1 time0)
15618 (if (> n 0) (- rem) (- dm rem))))))
15619 (setq time
15620 (encode-time (or (car time0) 0)
15621 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15622 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15623 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15624 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15625 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15626 (nthcdr 6 time0)))
15627 (when (and (member org-ts-what '(hour minute))
15628 extra
15630 (setq extra (org-modify-ts-extra
15631 extra
15632 (if (eq org-ts-what 'hour) 2 5)
15633 n dm)))
15634 (when (integerp org-ts-what)
15635 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15636 (if (eq what 'calendar)
15637 (let ((cal-date (org-get-date-from-calendar)))
15638 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15639 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15640 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15641 (setcar time0 (or (car time0) 0))
15642 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15643 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15644 (setq time (apply 'encode-time time0))))
15645 (setq org-last-changed-timestamp
15646 (org-insert-time-stamp time with-hm inactive nil nil extra))
15647 (org-clock-update-time-maybe)
15648 (goto-char pos)
15649 ;; Try to recenter the calendar window, if any
15650 (if (and org-calendar-follow-timestamp-change
15651 (get-buffer-window "*Calendar*" t)
15652 (memq org-ts-what '(day month year)))
15653 (org-recenter-calendar (time-to-days time))))))
15655 (defun org-modify-ts-extra (s pos n dm)
15656 "Change the different parts of the lead-time and repeat fields in timestamp."
15657 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15658 ng h m new rem)
15659 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15660 (cond
15661 ((or (org-pos-in-match-range pos 2)
15662 (org-pos-in-match-range pos 3))
15663 (setq m (string-to-number (match-string 3 s))
15664 h (string-to-number (match-string 2 s)))
15665 (if (org-pos-in-match-range pos 2)
15666 (setq h (+ h n))
15667 (setq n (* dm (org-no-warnings (signum n))))
15668 (when (not (= 0 (setq rem (% m dm))))
15669 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15670 (setq m (+ m n)))
15671 (if (< m 0) (setq m (+ m 60) h (1- h)))
15672 (if (> m 59) (setq m (- m 60) h (1+ h)))
15673 (setq h (min 24 (max 0 h)))
15674 (setq ng 1 new (format "-%02d:%02d" h m)))
15675 ((org-pos-in-match-range pos 6)
15676 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15677 ((org-pos-in-match-range pos 5)
15678 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15680 ((org-pos-in-match-range pos 9)
15681 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15682 ((org-pos-in-match-range pos 8)
15683 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15685 (when ng
15686 (setq s (concat
15687 (substring s 0 (match-beginning ng))
15688 new
15689 (substring s (match-end ng))))))
15690 s))
15692 (defun org-recenter-calendar (date)
15693 "If the calendar is visible, recenter it to DATE."
15694 (let* ((win (selected-window))
15695 (cwin (get-buffer-window "*Calendar*" t))
15696 (calendar-move-hook nil))
15697 (when cwin
15698 (select-window cwin)
15699 (calendar-goto-date (if (listp date) date
15700 (calendar-gregorian-from-absolute date)))
15701 (select-window win))))
15703 (defun org-goto-calendar (&optional arg)
15704 "Go to the Emacs calendar at the current date.
15705 If there is a time stamp in the current line, go to that date.
15706 A prefix ARG can be used to force the current date."
15707 (interactive "P")
15708 (let ((tsr org-ts-regexp) diff
15709 (calendar-move-hook nil)
15710 (calendar-view-holidays-initially-flag nil)
15711 (calendar-view-diary-initially-flag nil))
15712 (if (or (org-at-timestamp-p)
15713 (save-excursion
15714 (beginning-of-line 1)
15715 (looking-at (concat ".*" tsr))))
15716 (let ((d1 (time-to-days (current-time)))
15717 (d2 (time-to-days
15718 (org-time-string-to-time (match-string 1)))))
15719 (setq diff (- d2 d1))))
15720 (calendar)
15721 (calendar-goto-today)
15722 (if (and diff (not arg)) (calendar-forward-day diff))))
15724 (defun org-get-date-from-calendar ()
15725 "Return a list (month day year) of date at point in calendar."
15726 (with-current-buffer "*Calendar*"
15727 (save-match-data
15728 (calendar-cursor-to-date))))
15730 (defun org-date-from-calendar ()
15731 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15732 If there is already a time stamp at the cursor position, update it."
15733 (interactive)
15734 (if (org-at-timestamp-p t)
15735 (org-timestamp-change 0 'calendar)
15736 (let ((cal-date (org-get-date-from-calendar)))
15737 (org-insert-time-stamp
15738 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15740 (defun org-minutes-to-hh:mm-string (m)
15741 "Compute H:MM from a number of minutes."
15742 (let ((h (/ m 60)))
15743 (setq m (- m (* 60 h)))
15744 (format org-time-clocksum-format h m)))
15746 (defun org-hh:mm-string-to-minutes (s)
15747 "Convert a string H:MM to a number of minutes.
15748 If the string is just a number, interpret it as minutes.
15749 In fact, the first hh:mm or number in the string will be taken,
15750 there can be extra stuff in the string.
15751 If no number is found, the return value is 0."
15752 (cond
15753 ((integerp s) s)
15755 (+ (* (string-to-number (match-string 1 s)) 60)
15756 (string-to-number (match-string 2 s))))
15758 (string-to-number (match-string 1 s)))
15759 (t 0)))
15761 (defcustom org-effort-durations
15762 `(("h" . 60)
15763 ("d" . ,(* 60 8))
15764 ("w" . ,(* 60 8 5))
15765 ("m" . ,(* 60 8 5 4))
15766 ("y" . ,(* 60 8 5 40)))
15767 "Conversion factor to minutes for an effort modifier.
15769 Each entry has the form (MODIFIER . MINUTES).
15771 In an effort string, a number followed by MODIFIER is multiplied
15772 by the specified number of MINUTES to obtain an effort in
15773 minutes.
15777 :group 'org-agenda
15778 :type '(alist :key-type (string :tag "Modifier")
15779 :value-type (number :tag "Minutes")))
15781 (defun org-duration-string-to-minutes (s)
15782 "Convert a duration string S to minutes.
15784 A bare number is interpreted as minutes, modifiers can be set by
15785 customizing `org-effort-durations' (which see).
15787 Entries containing a colon are interpreted as H:MM by
15788 `org-hh:mm-string-to-minutes'."
15789 (let ((result 0)
15791 (regexp-opt (mapcar 'car org-effort-durations))
15793 (while (string-match re s)
15794 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15795 (string-to-number (match-string 1 s))))
15796 (setq s (replace-match "" nil t s)))
15797 (incf result (org-hh:mm-string-to-minutes s))
15798 result))
15800 ;;;; Files
15802 (defun org-save-all-org-buffers ()
15803 "Save all Org-mode buffers without user confirmation."
15804 (interactive)
15805 (message "Saving all Org-mode buffers...")
15806 (save-some-buffers t 'org-mode-p)
15807 (when (featurep 'org-id) (org-id-locations-save))
15808 (message "Saving all Org-mode buffers... done"))
15810 (defun org-revert-all-org-buffers ()
15811 "Revert all Org-mode buffers.
15812 Prompt for confirmation when there are unsaved changes.
15813 Be sure you know what you are doing before letting this function
15814 overwrite your changes.
15816 This function is useful in a setup where one tracks org files
15817 with a version control system, to revert on one machine after pulling
15818 changes from another. I believe the procedure must be like this:
15820 1. M-x org-save-all-org-buffers
15821 2. Pull changes from the other machine, resolve conflicts
15822 3. M-x org-revert-all-org-buffers"
15823 (interactive)
15824 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15825 (error "Abort"))
15826 (save-excursion
15827 (save-window-excursion
15828 (mapc
15829 (lambda (b)
15830 (when (and (with-current-buffer b (org-mode-p))
15831 (with-current-buffer b buffer-file-name))
15832 (org-pop-to-buffer-same-window b)
15833 (revert-buffer t 'no-confirm)))
15834 (buffer-list))
15835 (when (and (featurep 'org-id) org-id-track-globally)
15836 (org-id-locations-load)))))
15838 ;;;; Agenda files
15840 ;;;###autoload
15841 (defun org-switchb (&optional arg)
15842 "Switch between Org buffers.
15843 With a prefix argument, restrict available to files.
15844 With two prefix arguments, restrict available buffers to agenda files.
15846 Defaults to `iswitchb' for buffer name completion.
15847 Set `org-completion-use-ido' to make it use ido instead."
15848 (interactive "P")
15849 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15850 ((equal arg '(16)) (org-buffer-list 'agenda))
15851 (t (org-buffer-list))))
15852 (org-completion-use-iswitchb org-completion-use-iswitchb)
15853 (org-completion-use-ido org-completion-use-ido))
15854 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15855 (setq org-completion-use-iswitchb t))
15856 (org-pop-to-buffer-same-window
15857 (org-icompleting-read "Org buffer: "
15858 (mapcar 'list (mapcar 'buffer-name blist))
15859 nil t))))
15861 ;;; Define some older names previously used for this functionality
15862 ;;;###autoload
15863 (defalias 'org-ido-switchb 'org-switchb)
15864 ;;;###autoload
15865 (defalias 'org-iswitchb 'org-switchb)
15867 (defun org-buffer-list (&optional predicate exclude-tmp)
15868 "Return a list of Org buffers.
15869 PREDICATE can be `export', `files' or `agenda'.
15871 export restrict the list to Export buffers.
15872 files restrict the list to buffers visiting Org files.
15873 agenda restrict the list to buffers visiting agenda files.
15875 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15876 (let* ((bfn nil)
15877 (agenda-files (and (eq predicate 'agenda)
15878 (mapcar 'file-truename (org-agenda-files t))))
15879 (filter
15880 (cond
15881 ((eq predicate 'files)
15882 (lambda (b) (with-current-buffer b (org-mode-p))))
15883 ((eq predicate 'export)
15884 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15885 ((eq predicate 'agenda)
15886 (lambda (b)
15887 (with-current-buffer b
15888 (and (org-mode-p)
15889 (setq bfn (buffer-file-name b))
15890 (member (file-truename bfn) agenda-files)))))
15891 (t (lambda (b) (with-current-buffer b
15892 (or (org-mode-p)
15893 (string-match "\*Org .*Export"
15894 (buffer-name b)))))))))
15895 (delq nil
15896 (mapcar
15897 (lambda(b)
15898 (if (and (funcall filter b)
15899 (or (not exclude-tmp)
15900 (not (string-match "tmp" (buffer-name b)))))
15901 b
15902 nil))
15903 (buffer-list)))))
15905 (defun org-agenda-files (&optional unrestricted archives)
15906 "Get the list of agenda files.
15907 Optional UNRESTRICTED means return the full list even if a restriction
15908 is currently in place.
15909 When ARCHIVES is t, include all archive files that are really being
15910 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15911 `org-agenda-archives-mode' is t."
15912 (let ((files
15913 (cond
15914 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15915 ((stringp org-agenda-files) (org-read-agenda-file-list))
15916 ((listp org-agenda-files) org-agenda-files)
15917 (t (error "Invalid value of `org-agenda-files'")))))
15918 (setq files (apply 'append
15919 (mapcar (lambda (f)
15920 (if (file-directory-p f)
15921 (directory-files
15922 f t org-agenda-file-regexp)
15923 (list f)))
15924 files)))
15925 (when org-agenda-skip-unavailable-files
15926 (setq files (delq nil
15927 (mapcar (function
15928 (lambda (file)
15929 (and (file-readable-p file) file)))
15930 files))))
15931 (when (or (eq archives t)
15932 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15933 (setq files (org-add-archive-files files)))
15934 files))
15936 (defun org-agenda-file-p (&optional file)
15937 "Return non-nil, if FILE is an agenda file.
15938 If FILE is omitted, use the file associated with the current
15939 buffer."
15940 (member (or file (buffer-file-name))
15941 (org-agenda-files t)))
15943 (defun org-edit-agenda-file-list ()
15944 "Edit the list of agenda files.
15945 Depending on setup, this either uses customize to edit the variable
15946 `org-agenda-files', or it visits the file that is holding the list. In the
15947 latter case, the buffer is set up in a way that saving it automatically kills
15948 the buffer and restores the previous window configuration."
15949 (interactive)
15950 (if (stringp org-agenda-files)
15951 (let ((cw (current-window-configuration)))
15952 (find-file org-agenda-files)
15953 (org-set-local 'org-window-configuration cw)
15954 (org-add-hook 'after-save-hook
15955 (lambda ()
15956 (set-window-configuration
15957 (prog1 org-window-configuration
15958 (kill-buffer (current-buffer))))
15959 (org-install-agenda-files-menu)
15960 (message "New agenda file list installed"))
15961 nil 'local)
15962 (message "%s" (substitute-command-keys
15964 (customize-variable 'org-agenda-files)))
15966 (defun org-store-new-agenda-file-list (list)
15967 "Set new value for the agenda file list and save it correctly."
15968 (if (stringp org-agenda-files)
15969 (let ((fe (org-read-agenda-file-list t)) b u)
15970 (while (setq b (find-buffer-visiting org-agenda-files))
15971 (kill-buffer b))
15972 (with-temp-file org-agenda-files
15973 (insert
15974 (mapconcat
15975 (lambda (f) ;; Keep un-expanded entries.
15976 (if (setq u (assoc f fe))
15977 (cdr u)
15978 f))
15981 (let ((org-mode-hook nil) (org-inhibit-startup t)
15982 (org-insert-mode-line-in-empty-file nil))
15983 (setq org-agenda-files list)
15984 (customize-save-variable 'org-agenda-files org-agenda-files))))
15986 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15987 "Read the list of agenda files from a file.
15988 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15989 filenames, used by `org-store-new-agenda-file-list' to write back
15990 un-expanded file names."
15991 (when (file-directory-p org-agenda-files)
15992 (error "`org-agenda-files' cannot be a single directory"))
15993 (when (stringp org-agenda-files)
15994 (with-temp-buffer
15995 (insert-file-contents org-agenda-files)
15996 (mapcar
15997 (lambda (f)
15998 (let ((e (expand-file-name (substitute-in-file-name f)
15999 org-directory)))
16000 (if pair-with-expansion
16001 (cons e f)
16002 e)))
16005 ;;;###autoload
16006 (defun org-cycle-agenda-files ()
16007 "Cycle through the files in `org-agenda-files'.
16008 If the current buffer visits an agenda file, find the next one in the list.
16009 If the current buffer does not, find the first agenda file."
16010 (interactive)
16011 (let* ((fs (org-agenda-files t))
16012 (files (append fs (list (car fs))))
16013 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16014 file)
16015 (unless files (error "No agenda files"))
16016 (catch 'exit
16017 (while (setq file (pop files))
16018 (if (equal (file-truename file) tcf)
16019 (when (car files)
16020 (find-file (car files))
16021 (throw 'exit t))))
16022 (find-file (car fs)))
16023 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16025 (defun org-agenda-file-to-front (&optional to-end)
16026 "Move/add the current file to the top of the agenda file list.
16027 If the file is not present in the list, it is added to the front. If it is
16028 present, it is moved there. With optional argument TO-END, add/move to the
16029 end of the list."
16030 (interactive "P")
16031 (let ((org-agenda-skip-unavailable-files nil)
16032 (file-alist (mapcar (lambda (x)
16033 (cons (file-truename x) x))
16034 (org-agenda-files t)))
16035 (ctf (file-truename buffer-file-name))
16036 x had)
16037 (setq x (assoc ctf file-alist) had x)
16039 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16040 (if to-end
16041 (setq file-alist (append (delq x file-alist) (list x)))
16042 (setq file-alist (cons x (delq x file-alist))))
16043 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16044 (org-install-agenda-files-menu)
16045 (message "File %s to %s of agenda file list"
16046 (if had "moved" "added") (if to-end "end" "front"))))
16048 (defun org-remove-file (&optional file)
16049 "Remove current file from the list of files in variable `org-agenda-files'.
16050 These are the files which are being checked for agenda entries.
16051 Optional argument FILE means use this file instead of the current."
16052 (interactive)
16053 (let* ((org-agenda-skip-unavailable-files nil)
16054 (file (or file buffer-file-name))
16055 (true-file (file-truename file))
16056 (afile (abbreviate-file-name file))
16057 (files (delq nil (mapcar
16058 (lambda (x)
16059 (if (equal true-file
16060 (file-truename x))
16061 nil x))
16062 (org-agenda-files t)))))
16063 (if (not (= (length files) (length (org-agenda-files t))))
16064 (progn
16065 (org-store-new-agenda-file-list files)
16066 (org-install-agenda-files-menu)
16067 (message "Removed file: %s" afile))
16068 (message "File was not in list: %s (not removed)" afile))))
16070 (defun org-file-menu-entry (file)
16071 (vector file (list 'find-file file) t))
16073 (defun org-check-agenda-file (file)
16074 "Make sure FILE exists. If not, ask user what to do."
16075 (when (not (file-exists-p file))
16076 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16077 (abbreviate-file-name file))
16078 (let ((r (downcase (read-char-exclusive))))
16079 (cond
16080 ((equal r ?r)
16081 (org-remove-file file)
16082 (throw 'nextfile t))
16083 (t (error "Abort"))))))
16085 (defun org-get-agenda-file-buffer (file)
16086 "Get a buffer visiting FILE. If the buffer needs to be created, add
16087 it to the list of buffers which might be released later."
16088 (let ((buf (org-find-base-buffer-visiting file)))
16089 (if buf
16090 buf ; just return it
16091 ;; Make a new buffer and remember it
16092 (setq buf (find-file-noselect file))
16093 (if buf (push buf org-agenda-new-buffers))
16094 buf)))
16096 (defun org-release-buffers (blist)
16097 "Release all buffers in list, asking the user for confirmation when needed.
16098 When a buffer is unmodified, it is just killed. When modified, it is saved
16099 \(if the user agrees) and then killed."
16100 (let (buf file)
16101 (while (setq buf (pop blist))
16102 (setq file (buffer-file-name buf))
16103 (when (and (buffer-modified-p buf)
16104 file
16105 (y-or-n-p (format "Save file %s? " file)))
16106 (with-current-buffer buf (save-buffer)))
16107 (kill-buffer buf))))
16109 (defun org-prepare-agenda-buffers (files)
16110 "Create buffers for all agenda files, protect archived trees and comments."
16111 (interactive)
16112 (let ((pa '(:org-archived t))
16113 (pc '(:org-comment t))
16114 (pall '(:org-archived t :org-comment t))
16115 (inhibit-read-only t)
16116 (rea (concat ":" org-archive-tag ":"))
16117 bmp file re)
16118 (save-excursion
16119 (save-restriction
16120 (while (setq file (pop files))
16121 (catch 'nextfile
16122 (if (bufferp file)
16123 (set-buffer file)
16124 (org-check-agenda-file file)
16125 (set-buffer (org-get-agenda-file-buffer file)))
16126 (widen)
16127 (setq bmp (buffer-modified-p))
16128 (org-refresh-category-properties)
16129 (setq org-todo-keywords-for-agenda
16130 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16131 (setq org-done-keywords-for-agenda
16132 (append org-done-keywords-for-agenda org-done-keywords))
16133 (setq org-todo-keyword-alist-for-agenda
16134 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16135 (setq org-drawers-for-agenda
16136 (append org-drawers-for-agenda org-drawers))
16137 (setq org-tag-alist-for-agenda
16138 (append org-tag-alist-for-agenda org-tag-alist))
16140 (save-excursion
16141 (remove-text-properties (point-min) (point-max) pall)
16142 (when org-agenda-skip-archived-trees
16143 (goto-char (point-min))
16144 (while (re-search-forward rea nil t)
16145 (if (org-on-heading-p t)
16146 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16147 (goto-char (point-min))
16149 (while (re-search-forward re nil t)
16150 (add-text-properties
16151 (match-beginning 0) (org-end-of-subtree t) pc)))
16152 (set-buffer-modified-p bmp)))))
16153 (setq org-todo-keywords-for-agenda
16154 (org-uniquify org-todo-keywords-for-agenda))
16155 (setq org-todo-keyword-alist-for-agenda
16156 (org-uniquify org-todo-keyword-alist-for-agenda)
16157 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16159 ;;;; Embedded LaTeX
16161 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16162 "Keymap for the minor `org-cdlatex-mode'.")
16164 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16165 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16166 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16167 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16168 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16170 (defvar org-cdlatex-texmathp-advice-is-done nil
16171 "Flag remembering if we have applied the advice to texmathp already.")
16173 (define-minor-mode org-cdlatex-mode
16174 "Toggle the minor `org-cdlatex-mode'.
16175 This mode supports entering LaTeX environment and math in LaTeX fragments
16176 in Org-mode.
16178 nil " OCDL" nil
16179 (when org-cdlatex-mode (require 'cdlatex))
16180 (unless org-cdlatex-texmathp-advice-is-done
16181 (setq org-cdlatex-texmathp-advice-is-done t)
16182 (defadvice texmathp (around org-math-always-on activate)
16183 "Always return t in org-mode buffers.
16184 This is because we want to insert math symbols without dollars even outside
16185 the LaTeX math segments. If Orgmode thinks that point is actually inside
16186 an embedded LaTeX fragment, let texmathp do its job.
16188 (interactive)
16189 (let (p)
16190 (cond
16191 ((not (org-mode-p)) ad-do-it)
16192 ((eq this-command 'cdlatex-math-symbol)
16193 (setq ad-return-value t
16194 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16195 (t
16196 (let ((p (org-inside-LaTeX-fragment-p)))
16197 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16198 (setq ad-return-value t
16199 texmathp-why '("Org-mode embedded math" . 0))
16200 (if p ad-do-it)))))))))
16202 (defun turn-on-org-cdlatex ()
16203 "Unconditionally turn on `org-cdlatex-mode'."
16204 (org-cdlatex-mode 1))
16206 (defun org-inside-LaTeX-fragment-p ()
16207 "Test if point is inside a LaTeX fragment.
16209 sequence appearing also before point.
16210 Even though the matchers for math are configurable, this function assumes
16212 delimiters are skipped when they have been removed by customization.
16213 The return value is nil, or a cons cell with the delimiter and the
16214 position of this delimiter.
16216 This function does a reasonably good job, but can locally be fooled by
16217 for example currency specifications. For example it will assume being in
16219 fragments that are properly closed, but during editing, we have to live
16220 with the uncertainty caused by missing closing delimiters. This function
16221 looks only before point, not after."
16222 (catch 'exit
16223 (let ((pos (point))
16224 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16225 (lim (progn
16227 (point)))
16228 dd-on str (start 0) m re)
16229 (goto-char pos)
16230 (when dodollar
16232 re (nth 1 (assoc "$" org-latex-regexps)))
16233 (while (string-match re str start)
16234 (cond
16235 ((= (match-end 0) (length str))
16236 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16237 ((= (match-end 0) (- (length str) 5))
16238 (throw 'exit nil))
16239 (t (setq start (match-end 0))))))
16240 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16241 (goto-char pos)
16242 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16243 (and (match-beginning 2) (throw 'exit nil))
16244 ;; count $$
16246 (setq dd-on (not dd-on)))
16247 (goto-char pos)
16248 (if dd-on (cons "$$" m))))))
16250 (defun org-inside-latex-macro-p ()
16251 "Is point inside a LaTeX macro or its arguments?"
16252 (save-match-data
16253 (org-in-regexp
16256 (defun org-try-cdlatex-tab ()
16257 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16258 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16259 - inside a LaTeX fragment, or
16260 - after the first word in a line, where an abbreviation expansion could
16261 insert a LaTeX environment."
16262 (when org-cdlatex-mode
16263 (cond
16264 ((save-excursion
16265 (skip-chars-backward "a-zA-Z0-9*")
16267 (bolp))
16268 (cdlatex-tab) t)
16269 ((org-inside-LaTeX-fragment-p)
16270 (cdlatex-tab) t)
16271 (t nil))))
16273 (defun org-cdlatex-underscore-caret (&optional arg)
16274 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16275 Revert to the normal definition outside of these fragments."
16276 (interactive "P")
16277 (if (org-inside-LaTeX-fragment-p)
16278 (call-interactively 'cdlatex-sub-superscript)
16279 (let (org-cdlatex-mode)
16280 (call-interactively (key-binding (vector last-input-event))))))
16282 (defun org-cdlatex-math-modify (&optional arg)
16283 "Execute `cdlatex-math-modify' in LaTeX fragments.
16284 Revert to the normal definition outside of these fragments."
16285 (interactive "P")
16286 (if (org-inside-LaTeX-fragment-p)
16287 (call-interactively 'cdlatex-math-modify)
16288 (let (org-cdlatex-mode)
16289 (call-interactively (key-binding (vector last-input-event))))))
16291 (defvar org-latex-fragment-image-overlays nil
16292 "List of overlays carrying the images of latex fragments.")
16293 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16295 (defun org-remove-latex-fragment-image-overlays ()
16296 "Remove all overlays with LaTeX fragment images in current buffer."
16297 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16298 (setq org-latex-fragment-image-overlays nil))
16300 (defun org-preview-latex-fragment (&optional subtree)
16301 "Preview the LaTeX fragment at point, or all locally or globally.
16302 If the cursor is in a LaTeX fragment, create the image and overlay
16303 it over the source code. If there is no fragment at point, display
16304 all fragments in the current text, from one headline to the next. With
16305 prefix SUBTREE, display all fragments in the current subtree. With a
16307 the cursor is before the first headline,
16308 display all fragments in the buffer.
16310 (interactive "P")
16311 (org-remove-latex-fragment-image-overlays)
16312 (save-excursion
16313 (save-restriction
16314 (let (beg end at msg)
16315 (cond
16316 ((or (equal subtree '(16))
16317 (not (save-excursion
16318 (re-search-backward org-outline-regexp-bol nil t))))
16319 (setq beg (point-min) end (point-max)
16320 msg "Creating images for buffer...%s"))
16321 ((equal subtree '(4))
16322 (org-back-to-heading)
16323 (setq beg (point) end (org-end-of-subtree t)
16324 msg "Creating images for subtree...%s"))
16325 (t
16326 (if (setq at (org-inside-LaTeX-fragment-p))
16327 (goto-char (max (point-min) (- (cdr at) 2)))
16328 (org-back-to-heading))
16329 (setq beg (point) end (progn (outline-next-heading) (point))
16330 msg (if at "Creating image...%s"
16331 "Creating images for entry...%s"))))
16332 (message msg "")
16333 (narrow-to-region beg end)
16334 (goto-char beg)
16335 (org-format-latex
16336 (concat "ltxpng/" (file-name-sans-extension
16337 (file-name-nondirectory
16338 buffer-file-name)))
16339 default-directory 'overlays msg at 'forbuffer 'dvipng)
16340 (message msg "done. Use `C-c C-c' to remove images.")))))
16342 (defvar org-latex-regexps
16344 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16347 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16351 "Regular expressions for matching embedded LaTeX.")
16353 (defvar org-export-have-math nil) ;; dynamic scoping
16354 (defun org-format-latex (prefix &optional dir overlays msg at
16355 forbuffer processing-type)
16356 "Replace LaTeX fragments with links to an image, and produce images.
16357 Some of the options can be changed using the variable
16358 `org-format-latex-options'."
16359 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16360 (let* ((prefixnodir (file-name-nondirectory prefix))
16361 (absprefix (expand-file-name prefix dir))
16362 (todir (file-name-directory absprefix))
16363 (opt org-format-latex-options)
16364 (matchers (plist-get opt :matchers))
16365 (re-list org-latex-regexps)
16366 (org-format-latex-header-extra
16367 (plist-get (org-infile-export-plist) :latex-header-extra))
16368 (cnt 0) txt hash link beg end re e checkdir
16369 executables-checked string
16370 m n block linkfile movefile ov)
16371 ;; Check the different regular expressions
16372 (while (setq e (pop re-list))
16373 (setq m (car e) re (nth 1 e) n (nth 2 e)
16375 (when (member m matchers)
16376 (goto-char (point-min))
16377 (while (re-search-forward re nil t)
16378 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16379 (not (get-text-property (match-beginning n)
16380 'org-protected))
16381 (or (not overlays)
16382 (not (eq (get-char-property (match-beginning n)
16383 'org-overlay-type)
16384 'org-latex-overlay))))
16385 (setq org-export-have-math t)
16386 (cond
16387 ((eq processing-type 'verbatim)
16388 ;; Leave the text verbatim, just protect it
16389 (add-text-properties (match-beginning n) (match-end n)
16390 '(org-protected t)))
16391 ((eq processing-type 'mathjax)
16392 ;; Prepare for MathJax processing
16393 (setq string (match-string n))
16394 (if (member m '("$" "$1"))
16395 (save-excursion
16396 (delete-region (match-beginning n) (match-end n))
16397 (goto-char (match-beginning n))
16400 '(org-protected t))))
16401 (add-text-properties (match-beginning n) (match-end n)
16402 '(org-protected t))))
16403 ((or (eq processing-type 'dvipng) t)
16404 ;; Process to an image
16405 (setq txt (match-string n)
16406 beg (match-beginning n) end (match-end n)
16407 cnt (1+ cnt))
16408 (let (print-length print-level) ; make sure full list is printed
16409 (setq hash (sha1 (prin1-to-string
16410 (list org-format-latex-header
16411 org-format-latex-header-extra
16412 org-export-latex-default-packages-alist
16413 org-export-latex-packages-alist
16414 org-format-latex-options
16415 forbuffer txt)))
16416 linkfile (format "%s_%s.png" prefix hash)
16417 movefile (format "%s_%s.png" absprefix hash)))
16418 (setq link (concat block "[[file:" linkfile "]]" block))
16419 (if msg (message msg cnt))
16420 (goto-char beg)
16421 (unless checkdir ; make sure the directory exists
16422 (setq checkdir t)
16423 (or (file-directory-p todir) (make-directory todir t)))
16425 (unless executables-checked
16426 (org-check-external-command
16427 "latex" "needed to convert LaTeX fragments to images")
16428 (org-check-external-command
16429 "dvipng" "needed to convert LaTeX fragments to images")
16430 (setq executables-checked t))
16432 (unless (file-exists-p movefile)
16433 (org-create-formula-image
16434 txt movefile opt forbuffer))
16435 (if overlays
16436 (progn
16437 (mapc (lambda (o)
16438 (if (eq (overlay-get o 'org-overlay-type)
16439 'org-latex-overlay)
16440 (delete-overlay o)))
16441 (overlays-in beg end))
16442 (setq ov (make-overlay beg end))
16443 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16444 (if (featurep 'xemacs)
16445 (progn
16446 (overlay-put ov 'invisible t)
16447 (overlay-put
16448 ov 'end-glyph
16449 (make-glyph (vector 'png :file movefile))))
16450 (overlay-put
16451 ov 'display
16452 (list 'image :type 'png :file movefile :ascent 'center)))
16453 (push ov org-latex-fragment-image-overlays)
16454 (goto-char end))
16455 (delete-region beg end)
16456 (insert (org-add-props link
16457 (list 'org-latex-src
16458 (replace-regexp-in-string
16461 ;; This function borrows from Ganesh Swami's latex2png.el
16462 (defun org-create-formula-image (string tofile options buffer)
16463 "This calls dvipng."
16464 (require 'org-latex)
16465 (let* ((tmpdir (if (featurep 'xemacs)
16466 (temp-directory)
16467 temporary-file-directory))
16468 (texfilebase (make-temp-name
16469 (expand-file-name "orgtex" tmpdir)))
16470 (texfile (concat texfilebase ".tex"))
16471 (dvifile (concat texfilebase ".dvi"))
16472 (pngfile (concat texfilebase ".png"))
16473 (fnh (if (featurep 'xemacs)
16474 (font-height (get-face-font 'default))
16475 (face-attribute 'default :height nil)))
16476 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16477 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16478 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16479 "Black"))
16480 (bg (or (plist-get options (if buffer :background :html-background))
16481 "Transparent")))
16482 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16483 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16484 (with-temp-file texfile
16485 (insert (org-splice-latex-header
16486 org-format-latex-header
16487 org-export-latex-default-packages-alist
16488 org-export-latex-packages-alist t
16489 org-format-latex-header-extra))
16491 (require 'org-latex)
16492 (org-export-latex-fix-inputenc))
16493 (let ((dir default-directory))
16494 (condition-case nil
16495 (progn
16496 (cd tmpdir)
16497 (call-process "latex" nil nil nil texfile))
16498 (error nil))
16499 (cd dir))
16500 (if (not (file-exists-p dvifile))
16501 (progn (message "Failed to create dvi file from %s" texfile) nil)
16502 (condition-case nil
16503 (call-process "dvipng" nil nil nil
16504 "-fg" fg "-bg" bg
16505 "-D" dpi
16506 ;;"-x" scale "-y" scale
16507 "-T" "tight"
16508 "-o" pngfile
16509 dvifile)
16510 (error nil))
16511 (if (not (file-exists-p pngfile))
16512 (if org-format-latex-signal-error
16513 (error "Failed to create png file from %s" texfile)
16514 (message "Failed to create png file from %s" texfile)
16515 nil)
16516 ;; Use the requested file name and clean up
16517 (copy-file pngfile tofile 'replace)
16518 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16519 (delete-file (concat texfilebase e)))
16520 pngfile))))
16522 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16523 "Fill a LaTeX header template TPL.
16524 In the template, the following place holders will be recognized:
16527 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16529 [NO-PACKAGES] do not include PKG
16530 [EXTRA] the string EXTRA
16531 [NO-EXTRA] do not include EXTRA
16533 For backward compatibility, if both the positive and the negative place
16535 assumed to be present at the end of the template.
16536 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16537 EXTRA is a string.
16538 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16539 (let (rpl (end ""))
16541 (setq rpl (if (or (match-end 1) (not def-pkg))
16542 "" (org-latex-packages-to-string def-pkg snippets-p t))
16543 tpl (replace-match rpl t t tpl))
16544 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16547 (setq rpl (if (or (match-end 1) (not pkg))
16548 "" (org-latex-packages-to-string pkg snippets-p t))
16549 tpl (replace-match rpl t t tpl))
16550 (if pkg (setq end
16552 (org-latex-packages-to-string pkg snippets-p)))))
16555 (setq rpl (if (or (match-end 1) (not extra))
16557 tpl (replace-match rpl t t tpl))
16563 tpl)))
16565 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16567 (setq pkg (mapconcat (lambda(p)
16568 (cond
16569 ((stringp p) p)
16570 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16571 (format "%% Package %s omitted" (cadr p)))
16572 ((equal "" (car p))
16574 (t
16576 (car p) (cadr p)))))
16577 pkg
16581 (defun org-dvipng-color (attr)
16582 "Return an rgb color specification for dvipng."
16583 (apply 'format "rgb %s %s %s"
16584 (mapcar 'org-normalize-color
16585 (color-values (face-attribute 'default attr nil)))))
16587 (defun org-normalize-color (value)
16588 "Return string to be used as color value for an RGB component."
16589 (format "%g" (/ value 65535.0)))
16591 ;; Image display
16594 (defvar org-inline-image-overlays nil)
16595 (make-variable-buffer-local 'org-inline-image-overlays)
16597 (defun org-toggle-inline-images (&optional include-linked)
16598 "Toggle the display of inline images.
16599 INCLUDE-LINKED is passed to `org-display-inline-images'."
16600 (interactive "P")
16601 (if org-inline-image-overlays
16602 (progn
16603 (org-remove-inline-images)
16604 (message "Inline image display turned off"))
16605 (org-display-inline-images include-linked)
16606 (if org-inline-image-overlays
16607 (message "%d images displayed inline"
16608 (length org-inline-image-overlays))
16609 (message "No images to display inline"))))
16611 (defun org-display-inline-images (&optional include-linked refresh beg end)
16612 "Display inline images.
16613 Normally only links without a description part are inlined, because this
16614 is how it will work for export. When INCLUDE-LINKED is set, also links
16615 with a description part will be inlined. This can be nice for a quick
16616 look at those images, but it does not reflect what exported files will look
16617 like.
16618 When REFRESH is set, refresh existing images between BEG and END.
16619 This will create new image displays only if necessary.
16620 BEG and END default to the buffer boundaries."
16621 (interactive "P")
16622 (unless refresh
16623 (org-remove-inline-images)
16624 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16625 (save-excursion
16626 (save-restriction
16627 (widen)
16628 (setq beg (or beg (point-min)) end (or end (point-max)))
16629 (goto-char (point-min))
16631 (substring (org-image-file-name-regexp) 0 -2)
16633 old file ov img)
16634 (while (re-search-forward re end t)
16635 (setq old (get-char-property-and-overlay (match-beginning 1)
16636 'org-image-overlay))
16637 (setq file (expand-file-name
16638 (concat (or (match-string 3) "") (match-string 4))))
16639 (when (file-exists-p file)
16640 (if (and (car-safe old) refresh)
16641 (image-refresh (overlay-get (cdr old) 'display))
16642 (setq img (save-match-data (create-image file)))
16643 (when img
16644 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16645 (overlay-put ov 'display img)
16646 (overlay-put ov 'face 'default)
16647 (overlay-put ov 'org-image-overlay t)
16648 (overlay-put ov 'modification-hooks
16649 (list 'org-display-inline-modification-hook))
16650 (push ov org-inline-image-overlays)))))))))
16652 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16653 "Remove inline-display overlay if a corresponding region is modified."
16654 (let ((inhibit-modification-hooks t))
16655 (when (and ov after)
16656 (delete ov org-inline-image-overlays)
16657 (delete-overlay ov))))
16659 (defun org-remove-inline-images ()
16660 "Remove inline display of images."
16661 (interactive)
16662 (mapc 'delete-overlay org-inline-image-overlays)
16663 (setq org-inline-image-overlays nil))
16665 ;;;; Key bindings
16667 ;; Make `C-c C-x' a prefix key
16668 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16670 ;; TAB key with modifiers
16671 (org-defkey org-mode-map "\C-i" 'org-cycle)
16672 (org-defkey org-mode-map [(tab)] 'org-cycle)
16673 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16674 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16676 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16677 ;; The following line is necessary under Suse GNU/Linux
16678 (unless (featurep 'xemacs)
16679 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16680 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16681 (define-key org-mode-map [backtab] 'org-shifttab)
16683 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16684 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16685 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16687 ;; Cursor keys with modifiers
16688 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16689 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16690 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16691 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16693 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16694 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16695 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16696 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16698 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16699 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16700 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16701 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16703 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16704 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16705 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16706 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16708 ;; Babel keys
16709 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16710 (mapc (lambda (pair)
16711 (define-key org-babel-map (car pair) (cdr pair)))
16712 org-babel-key-bindings)
16714 ;;; Extra keys for tty access.
16715 ;; We only set them when really needed because otherwise the
16716 ;; menus don't show the simple keys
16718 (when (or org-use-extra-keys
16719 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16720 (not window-system))
16721 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16722 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16723 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16724 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16725 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16726 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16727 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16728 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16729 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16730 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16731 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16732 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16733 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16734 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16735 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16736 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16737 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16738 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16739 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16740 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16741 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16742 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16743 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16744 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16745 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16746 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16747 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16748 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16750 ;; All the other keys
16752 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16753 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16754 (if (boundp 'narrow-map)
16755 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16756 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16757 (if (boundp 'narrow-map)
16758 (org-defkey narrow-map "b" 'org-narrow-to-block)
16759 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16760 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16761 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16762 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16763 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16764 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16765 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16766 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16767 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16768 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16769 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16770 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16771 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16772 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16773 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16774 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16775 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16777 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16778 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16779 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16780 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16781 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16782 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16783 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16784 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16785 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16786 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16787 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16788 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16789 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16790 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16791 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16792 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16793 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16794 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16795 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16797 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16798 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16799 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16800 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16801 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16802 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16803 (org-defkey org-mode-map "\C-c^" 'org-sort)
16804 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16805 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16806 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16807 (org-defkey org-mode-map "\C-m" 'org-return)
16808 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16809 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16810 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16811 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16812 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16813 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16814 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16815 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16816 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16817 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16818 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16819 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16820 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16821 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16822 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16823 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16824 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16825 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16826 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16827 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16828 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16829 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16831 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16832 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16833 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16834 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16836 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16837 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16838 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16839 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16840 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16841 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16842 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16843 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16844 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16845 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16847 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16848 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16849 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16850 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16851 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16852 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16853 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16855 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16856 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16857 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16858 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16859 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16861 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16863 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16865 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16866 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16868 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16871 (when (featurep 'xemacs)
16872 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16875 (defconst org-speed-commands-default
16876 '(
16877 ("Outline Navigation")
16878 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16879 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16880 ("f" . (org-speed-move-safe 'org-forward-same-level))
16881 ("b" . (org-speed-move-safe 'org-backward-same-level))
16882 ("u" . (org-speed-move-safe 'outline-up-heading))
16883 ("j" . org-goto)
16884 ("g" . (org-refile t))
16885 ("Outline Visibility")
16886 ("c" . org-cycle)
16887 ("C" . org-shifttab)
16888 (" " . org-display-outline-path)
16889 ("Outline Structure Editing")
16890 ("U" . org-shiftmetaup)
16891 ("D" . org-shiftmetadown)
16892 ("r" . org-metaright)
16893 ("l" . org-metaleft)
16894 ("R" . org-shiftmetaright)
16895 ("L" . org-shiftmetaleft)
16896 ("i" . (progn (forward-char 1) (call-interactively
16897 'org-insert-heading-respect-content)))
16898 ("^" . org-sort)
16899 ("w" . org-refile)
16900 ("a" . org-archive-subtree-default-with-confirmation)
16901 ("." . org-mark-subtree)
16902 ("Clock Commands")
16903 ("I" . org-clock-in)
16904 ("O" . org-clock-out)
16905 ("Meta Data Editing")
16906 ("t" . org-todo)
16907 ("0" . (org-priority ?\ ))
16908 ("1" . (org-priority ?A))
16909 ("2" . (org-priority ?B))
16910 ("3" . (org-priority ?C))
16911 (";" . org-set-tags-command)
16912 ("e" . org-set-effort)
16913 ("Agenda Views etc")
16914 ("v" . org-agenda)
16915 ("/" . org-sparse-tree)
16916 ("Misc")
16917 ("o" . org-open-at-point)
16918 ("?" . org-speed-command-help)
16919 ("<" . (org-agenda-set-restriction-lock 'subtree))
16920 (">" . (org-agenda-remove-restriction-lock))
16921 )
16922 "The default speed commands.")
16924 (defun org-print-speed-command (e)
16925 (if (> (length (car e)) 1)
16926 (progn
16928 (princ (car e))
16930 (princ (make-string (length (car e)) ?-))
16932 (princ (car e))
16933 (princ " ")
16934 (if (symbolp (cdr e))
16935 (princ (symbol-name (cdr e)))
16936 (prin1 (cdr e)))
16939 (defun org-speed-command-help ()
16940 "Show the available speed commands."
16941 (interactive)
16942 (if (not org-use-speed-commands)
16943 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16944 (with-output-to-temp-buffer "*Help*"
16946 (mapc 'org-print-speed-command org-speed-commands-user)
16949 (mapc 'org-print-speed-command org-speed-commands-default))
16950 (with-current-buffer "*Help*"
16951 (setq truncate-lines t))))
16953 (defun org-speed-move-safe (cmd)
16954 "Execute CMD, but make sure that the cursor always ends up in a headline.
16955 If not, return to the original position and throw an error."
16956 (interactive)
16957 (let ((pos (point)))
16958 (call-interactively cmd)
16959 (unless (and (bolp) (org-on-heading-p))
16960 (goto-char pos)
16961 (error "Boundary reached while executing %s" cmd))))
16963 (defvar org-self-insert-command-undo-counter 0)
16965 (defvar org-table-auto-blank-field) ; defined in org-table.el
16966 (defvar org-speed-command nil)
16968 (defun org-speed-command-default-hook (keys)
16969 "Hook for activating single-letter speed commands.
16970 `org-speed-commands-default' specifies a minimal command set. Use
16971 `org-speed-commands-user' for further customization."
16972 (when (or (and (bolp) (looking-at org-outline-regexp))
16973 (and (functionp org-use-speed-commands)
16974 (funcall org-use-speed-commands)))
16975 (cdr (assoc keys (append org-speed-commands-user
16976 org-speed-commands-default)))))
16978 (defun org-babel-speed-command-hook (keys)
16979 "Hook for activating single-letter code block commands."
16980 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16981 (cdr (assoc keys org-babel-key-bindings))))
16983 (defcustom org-speed-command-hook
16984 '(org-speed-command-default-hook org-babel-speed-command-hook)
16985 "Hook for activating speed commands at strategic locations.
16986 Hook functions are called in sequence until a valid handler is
16987 found.
16989 Each hook takes a single argument, a user-pressed command key
16990 which is also a `self-insert-command' from the global map.
16992 Within the hook, examine the cursor position and the command key
16993 and return nil or a valid handler as appropriate. Handler could
16994 be one of an interactive command, a function, or a form.
16996 Set `org-use-speed-commands' to non-nil value to enable this
16997 hook. The default setting is `org-speed-command-default-hook'."
16998 :group 'org-structure
16999 :type 'hook)
17001 (defun org-self-insert-command (N)
17002 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17003 If the cursor is in a table looking at whitespace, the whitespace is
17004 overwritten, and the table is not marked as requiring realignment."
17005 (interactive "p")
17006 (cond
17007 ((and org-use-speed-commands
17008 (setq org-speed-command
17009 (run-hook-with-args-until-success
17010 'org-speed-command-hook (this-command-keys))))
17011 (cond
17012 ((commandp org-speed-command)
17013 (setq this-command org-speed-command)
17014 (call-interactively org-speed-command))
17015 ((functionp org-speed-command)
17016 (funcall org-speed-command))
17017 ((and org-speed-command (listp org-speed-command))
17018 (eval org-speed-command))
17019 (t (let (org-use-speed-commands)
17020 (call-interactively 'org-self-insert-command)))))
17021 ((and
17022 (org-table-p)
17023 (progn
17024 ;; check if we blank the field, and if that triggers align
17025 (and (featurep 'org-table) org-table-auto-blank-field
17026 (member last-command
17027 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17029 ;; got extra space, this field does not determine column width
17030 (let (org-table-may-need-update) (org-table-blank-field))
17031 ;; no extra space, this field may determine column width
17032 (org-table-blank-field)))
17033 t)
17034 (eq N 1)
17036 (let (org-table-may-need-update)
17037 (goto-char (1- (match-end 0)))
17038 (delete-char -1)
17039 (goto-char (match-beginning 0))
17040 (self-insert-command N)))
17041 (t
17042 (setq org-table-may-need-update t)
17043 (self-insert-command N)
17044 (org-fix-tags-on-the-fly)
17045 (if org-self-insert-cluster-for-undo
17046 (if (not (eq last-command 'org-self-insert-command))
17047 (setq org-self-insert-command-undo-counter 1)
17048 (if (>= org-self-insert-command-undo-counter 20)
17049 (setq org-self-insert-command-undo-counter 1)
17050 (and (> org-self-insert-command-undo-counter 0)
17051 buffer-undo-list (listp buffer-undo-list)
17052 (not (cadr buffer-undo-list)) ; remove nil entry
17053 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17054 (setq org-self-insert-command-undo-counter
17055 (1+ org-self-insert-command-undo-counter))))))))
17057 (defun org-fix-tags-on-the-fly ()
17058 (when (and (equal (char-after (point-at-bol)) ?*)
17059 (org-on-heading-p))
17060 (org-align-tags-here org-tags-column)))
17062 (defun org-delete-backward-char (N)
17063 "Like `delete-backward-char', insert whitespace at field end in tables.
17064 When deleting backwards, in tables this function will insert whitespace in
17066 still be marked for re-alignment if the field did fill the entire column,
17067 because, in this case the deletion might narrow the column."
17068 (interactive "p")
17069 (if (and (org-table-p)
17070 (eq N 1)
17071 (string-match "|" (buffer-substring (point-at-bol) (point)))
17072 (looking-at ".*?|"))
17073 (let ((pos (point))
17075 (c org-table-may-need-update))
17076 (backward-delete-char N)
17077 (if (not overwrite-mode)
17078 (progn
17079 (skip-chars-forward "^|")
17080 (insert " ")
17081 (goto-char (1- pos))))
17082 ;; noalign: if there were two spaces at the end, this field
17083 ;; does not determine the width of the column.
17084 (if noalign (setq org-table-may-need-update c)))
17085 (backward-delete-char N)
17086 (org-fix-tags-on-the-fly)))
17088 (defun org-delete-char (N)
17089 "Like `delete-char', but insert whitespace at field end in tables.
17090 When deleting characters, in tables this function will insert whitespace in
17092 still be marked for re-alignment if the field did fill the entire column,
17093 because, in this case the deletion might narrow the column."
17094 (interactive "p")
17095 (if (and (org-table-p)
17096 (not (bolp))
17097 (not (= (char-after) ?|))
17098 (eq N 1))
17099 (if (looking-at ".*?|")
17100 (let ((pos (point))
17102 (c org-table-may-need-update))
17103 (replace-match (concat
17104 (substring (match-string 0) 1 -1)
17105 " |"))
17106 (goto-char pos)
17107 ;; noalign: if there were two spaces at the end, this field
17108 ;; does not determine the width of the column.
17109 (if noalign (setq org-table-may-need-update c)))
17110 (delete-char N))
17111 (delete-char N)
17112 (org-fix-tags-on-the-fly)))
17114 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17115 (put 'org-self-insert-command 'delete-selection t)
17116 (put 'orgtbl-self-insert-command 'delete-selection t)
17117 (put 'org-delete-char 'delete-selection 'supersede)
17118 (put 'org-delete-backward-char 'delete-selection 'supersede)
17119 (put 'org-yank 'delete-selection 'yank)
17121 ;; Make `flyspell-mode' delay after some commands
17122 (put 'org-self-insert-command 'flyspell-delayed t)
17123 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17124 (put 'org-delete-char 'flyspell-delayed t)
17125 (put 'org-delete-backward-char 'flyspell-delayed t)
17127 ;; Make pabbrev-mode expand after org-mode commands
17128 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17129 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17131 ;; How to do this: Measure non-white length of current string
17132 ;; If equal to column width, we should realign.
17134 (defun org-remap (map &rest commands)
17135 "In MAP, remap the functions given in COMMANDS.
17136 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17137 (let (new old)
17138 (while commands
17139 (setq old (pop commands) new (pop commands))
17140 (if (fboundp 'command-remapping)
17141 (org-defkey map (vector 'remap old) new)
17142 (substitute-key-definition old new map global-map)))))
17144 (when (eq org-enable-table-editor 'optimized)
17145 ;; If the user wants maximum table support, we need to hijack
17146 ;; some standard editing functions
17147 (org-remap org-mode-map
17148 'self-insert-command 'org-self-insert-command
17149 'delete-char 'org-delete-char
17150 'delete-backward-char 'org-delete-backward-char)
17151 (org-defkey org-mode-map "|" 'org-force-self-insert))
17153 (defvar org-ctrl-c-ctrl-c-hook nil
17154 "Hook for functions attaching themselves to `C-c C-c'.
17156 This can be used to add additional functionality to the C-c C-c
17157 key which executes context-dependent commands. This hook is run
17158 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17159 run after the last test.
17161 Each function will be called with no arguments. The function
17162 must check if the context is appropriate for it to act. If yes,
17163 it should do its thing and then return a non-nil value. If the
17164 context is wrong, just do nothing and return nil.")
17166 (defvar org-ctrl-c-ctrl-c-final-hook nil
17167 "Hook for functions attaching themselves to `C-c C-c'.
17169 This can be used to add additional functionality to the C-c C-c
17170 key which executes context-dependent commands. This hook is run
17171 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17172 before the first test.
17174 Each function will be called with no arguments. The function
17175 must check if the context is appropriate for it to act. If yes,
17176 it should do its thing and then return a non-nil value. If the
17177 context is wrong, just do nothing and return nil.")
17179 (defvar org-tab-first-hook nil
17180 "Hook for functions to attach themselves to TAB.
17181 See `org-ctrl-c-ctrl-c-hook' for more information.
17182 This hook runs as the first action when TAB is pressed, even before
17183 `org-cycle' messes around with the `outline-regexp' to cater for
17184 inline tasks and plain list item folding.
17185 If any function in this hook returns t, any other actions that
17186 would have been caused by TAB (such as table field motion or visibility
17187 cycling) will not occur.")
17189 (defvar org-tab-after-check-for-table-hook nil
17190 "Hook for functions to attach themselves to TAB.
17191 See `org-ctrl-c-ctrl-c-hook' for more information.
17192 This hook runs after it has been established that the cursor is not in a
17193 table, but before checking if the cursor is in a headline or if global cycling
17194 should be done.
17195 If any function in this hook returns t, not other actions like visibility
17196 cycling will be done.")
17198 (defvar org-tab-after-check-for-cycling-hook nil
17199 "Hook for functions to attach themselves to TAB.
17200 See `org-ctrl-c-ctrl-c-hook' for more information.
17201 This hook runs after it has been established that not table field motion and
17202 not visibility should be done because of current context. This is probably
17203 the place where a package like yasnippets can hook in.")
17205 (defvar org-tab-before-tab-emulation-hook nil
17206 "Hook for functions to attach themselves to TAB.
17207 See `org-ctrl-c-ctrl-c-hook' for more information.
17208 This hook runs after every other options for TAB have been exhausted, but
17211 (defvar org-metaleft-hook nil
17212 "Hook for functions attaching themselves to `M-left'.
17213 See `org-ctrl-c-ctrl-c-hook' for more information.")
17214 (defvar org-metaright-hook nil
17215 "Hook for functions attaching themselves to `M-right'.
17216 See `org-ctrl-c-ctrl-c-hook' for more information.")
17217 (defvar org-metaup-hook nil
17218 "Hook for functions attaching themselves to `M-up'.
17219 See `org-ctrl-c-ctrl-c-hook' for more information.")
17220 (defvar org-metadown-hook nil
17221 "Hook for functions attaching themselves to `M-down'.
17222 See `org-ctrl-c-ctrl-c-hook' for more information.")
17223 (defvar org-shiftmetaleft-hook nil
17224 "Hook for functions attaching themselves to `M-S-left'.
17225 See `org-ctrl-c-ctrl-c-hook' for more information.")
17226 (defvar org-shiftmetaright-hook nil
17227 "Hook for functions attaching themselves to `M-S-right'.
17228 See `org-ctrl-c-ctrl-c-hook' for more information.")
17229 (defvar org-shiftmetaup-hook nil
17230 "Hook for functions attaching themselves to `M-S-up'.
17231 See `org-ctrl-c-ctrl-c-hook' for more information.")
17232 (defvar org-shiftmetadown-hook nil
17233 "Hook for functions attaching themselves to `M-S-down'.
17234 See `org-ctrl-c-ctrl-c-hook' for more information.")
17235 (defvar org-metareturn-hook nil
17236 "Hook for functions attaching themselves to `M-RET'.
17237 See `org-ctrl-c-ctrl-c-hook' for more information.")
17238 (defvar org-shiftup-hook nil
17239 "Hook for functions attaching themselves to `S-up'.
17240 See `org-ctrl-c-ctrl-c-hook' for more information.")
17241 (defvar org-shiftup-final-hook nil
17242 "Hook for functions attaching themselves to `S-up'.
17243 This one runs after all other options except shift-select have been excluded.
17244 See `org-ctrl-c-ctrl-c-hook' for more information.")
17245 (defvar org-shiftdown-hook nil
17246 "Hook for functions attaching themselves to `S-down'.
17247 See `org-ctrl-c-ctrl-c-hook' for more information.")
17248 (defvar org-shiftdown-final-hook nil
17249 "Hook for functions attaching themselves to `S-down'.
17250 This one runs after all other options except shift-select have been excluded.
17251 See `org-ctrl-c-ctrl-c-hook' for more information.")
17252 (defvar org-shiftleft-hook nil
17253 "Hook for functions attaching themselves to `S-left'.
17254 See `org-ctrl-c-ctrl-c-hook' for more information.")
17255 (defvar org-shiftleft-final-hook nil
17256 "Hook for functions attaching themselves to `S-left'.
17257 This one runs after all other options except shift-select have been excluded.
17258 See `org-ctrl-c-ctrl-c-hook' for more information.")
17259 (defvar org-shiftright-hook nil
17260 "Hook for functions attaching themselves to `S-right'.
17261 See `org-ctrl-c-ctrl-c-hook' for more information.")
17262 (defvar org-shiftright-final-hook nil
17263 "Hook for functions attaching themselves to `S-right'.
17264 This one runs after all other options except shift-select have been excluded.
17265 See `org-ctrl-c-ctrl-c-hook' for more information.")
17267 (defun org-modifier-cursor-error ()
17268 "Throw an error, a modified cursor command was applied in wrong context."
17269 (error "This command is active in special context like tables, headlines or items"))
17271 (defun org-shiftselect-error ()
17272 "Throw an error because Shift-Cursor command was applied in wrong context."
17273 (if (and (boundp 'shift-select-mode) shift-select-mode)
17274 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17275 (error "This command works only in special context like headlines or timestamps")))
17277 (defun org-call-for-shift-select (cmd)
17278 (let ((this-command-keys-shift-translated t))
17279 (call-interactively cmd)))
17281 (defun org-shifttab (&optional arg)
17282 "Global visibility cycling or move to previous table field.
17283 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17284 on context.
17285 See the individual commands for more information."
17286 (interactive "P")
17287 (cond
17288 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17289 ((integerp arg)
17290 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17291 (message "Content view to level: %d" arg)
17292 (org-content (prefix-numeric-value arg2))
17293 (setq org-cycle-global-status 'overview)))
17294 (t (call-interactively 'org-global-cycle))))
17296 (defun org-shiftmetaleft ()
17297 "Promote subtree or delete table column.
17298 Calls `org-promote-subtree', `org-outdent-item',
17299 or `org-table-delete-column', depending on context.
17300 See the individual commands for more information."
17301 (interactive)
17302 (cond
17303 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17304 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17305 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17306 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17307 (t (org-modifier-cursor-error))))
17309 (defun org-shiftmetaright ()
17310 "Demote subtree or insert table column.
17311 Calls `org-demote-subtree', `org-indent-item',
17312 or `org-table-insert-column', depending on context.
17313 See the individual commands for more information."
17314 (interactive)
17315 (cond
17316 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17317 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17318 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17319 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17320 (t (org-modifier-cursor-error))))
17322 (defun org-shiftmetaup (&optional arg)
17323 "Move subtree up or kill table row.
17324 Calls `org-move-subtree-up' or `org-table-kill-row' or
17325 `org-move-item-up' depending on context. See the individual commands
17326 for more information."
17327 (interactive "P")
17328 (cond
17329 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17330 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17331 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17332 ((org-at-item-p) (call-interactively 'org-move-item-up))
17333 (t (org-modifier-cursor-error))))
17335 (defun org-shiftmetadown (&optional arg)
17336 "Move subtree down or insert table row.
17337 Calls `org-move-subtree-down' or `org-table-insert-row' or
17338 `org-move-item-down', depending on context. See the individual
17339 commands for more information."
17340 (interactive "P")
17341 (cond
17342 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17343 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17344 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17345 ((org-at-item-p) (call-interactively 'org-move-item-down))
17346 (t (org-modifier-cursor-error))))
17348 (defsubst org-hidden-tree-error ()
17349 (error
17350 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17352 (defun org-metaleft (&optional arg)
17353 "Promote heading or move table column to left.
17354 Calls `org-do-promote' or `org-table-move-column', depending on context.
17355 With no specific context, calls the Emacs default `backward-word'.
17356 See the individual commands for more information."
17357 (interactive "P")
17358 (cond
17359 ((run-hook-with-args-until-success 'org-metaleft-hook))
17360 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17361 ((org-with-limited-levels
17362 (or (org-on-heading-p)
17363 (and (org-region-active-p)
17364 (save-excursion
17365 (goto-char (region-beginning))
17366 (org-on-heading-p)))))
17367 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17368 (call-interactively 'org-do-promote))
17369 ;; At an inline task.
17370 ((org-on-heading-p)
17371 (call-interactively 'org-inlinetask-promote))
17372 ((or (org-at-item-p)
17373 (and (org-region-active-p)
17374 (save-excursion
17375 (goto-char (region-beginning))
17376 (org-at-item-p))))
17377 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17378 (call-interactively 'org-outdent-item))
17379 (t (call-interactively 'backward-word))))
17381 (defun org-metaright (&optional arg)
17382 "Demote subtree or move table column to right.
17383 Calls `org-do-demote' or `org-table-move-column', depending on context.
17384 With no specific context, calls the Emacs default `forward-word'.
17385 See the individual commands for more information."
17386 (interactive "P")
17387 (cond
17388 ((run-hook-with-args-until-success 'org-metaright-hook))
17389 ((org-at-table-p) (call-interactively 'org-table-move-column))
17390 ((org-with-limited-levels
17391 (or (org-on-heading-p)
17392 (and (org-region-active-p)
17393 (save-excursion
17394 (goto-char (region-beginning))
17395 (org-on-heading-p)))))
17396 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17397 (call-interactively 'org-do-demote))
17398 ;; At an inline task.
17399 ((org-on-heading-p)
17400 (call-interactively 'org-inlinetask-demote))
17401 ((or (org-at-item-p)
17402 (and (org-region-active-p)
17403 (save-excursion
17404 (goto-char (region-beginning))
17405 (org-at-item-p))))
17406 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17407 (call-interactively 'org-indent-item))
17408 (t (call-interactively 'forward-word))))
17410 (defun org-check-for-hidden (what)
17411 "Check if there are hidden headlines/items in the current visual line.
17412 WHAT can be either `headlines' or `items'. If the current line is
17413 an outline or item heading and it has a folded subtree below it,
17414 this function returns t, nil otherwise."
17415 (let ((re (cond
17416 ((eq what 'headlines) org-outline-regexp-bol)
17417 ((eq what 'items) (org-item-beginning-re))
17418 (t (error "This should not happen"))))
17419 beg end)
17420 (save-excursion
17421 (catch 'exit
17422 (unless (org-region-active-p)
17423 (setq beg (point-at-bol))
17424 (beginning-of-line 2)
17425 (while (and (not (eobp)) ;; this is like `next-line'
17426 (get-char-property (1- (point)) 'invisible))
17427 (beginning-of-line 2))
17428 (setq end (point))
17429 (goto-char beg)
17430 (goto-char (point-at-eol))
17431 (setq end (max end (point)))
17432 (while (re-search-forward re end t)
17433 (if (get-char-property (match-beginning 0) 'invisible)
17434 (throw 'exit t))))
17435 nil))))
17437 (defun org-metaup (&optional arg)
17438 "Move subtree up or move table row up.
17439 Calls `org-move-subtree-up' or `org-table-move-row' or
17440 `org-move-item-up', depending on context. See the individual commands
17441 for more information."
17442 (interactive "P")
17443 (cond
17444 ((run-hook-with-args-until-success 'org-metaup-hook))
17445 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17446 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17447 ((org-at-item-p) (call-interactively 'org-move-item-up))
17448 (t (transpose-lines 1) (beginning-of-line -1))))
17450 (defun org-metadown (&optional arg)
17451 "Move subtree down or move table row down.
17452 Calls `org-move-subtree-down' or `org-table-move-row' or
17453 `org-move-item-down', depending on context. See the individual
17454 commands for more information."
17455 (interactive "P")
17456 (cond
17457 ((run-hook-with-args-until-success 'org-metadown-hook))
17458 ((org-at-table-p) (call-interactively 'org-table-move-row))
17459 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17460 ((org-at-item-p) (call-interactively 'org-move-item-down))
17461 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17463 (defun org-shiftup (&optional arg)
17464 "Increase item in timestamp or increase priority of current headline.
17465 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17466 depending on context. See the individual commands for more information."
17467 (interactive "P")
17468 (cond
17469 ((run-hook-with-args-until-success 'org-shiftup-hook))
17470 ((and org-support-shift-select (org-region-active-p))
17471 (org-call-for-shift-select 'previous-line))
17472 ((org-at-timestamp-p t)
17473 (call-interactively (if org-edit-timestamp-down-means-later
17474 'org-timestamp-down 'org-timestamp-up)))
17475 ((and (not (eq org-support-shift-select 'always))
17476 org-enable-priority-commands
17477 (org-on-heading-p))
17478 (call-interactively 'org-priority-up))
17479 ((and (not org-support-shift-select) (org-at-item-p))
17480 (call-interactively 'org-previous-item))
17481 ((org-clocktable-try-shift 'up arg))
17482 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17483 (org-support-shift-select
17484 (org-call-for-shift-select 'previous-line))
17485 (t (org-shiftselect-error))))
17487 (defun org-shiftdown (&optional arg)
17488 "Decrease item in timestamp or decrease priority of current headline.
17489 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17490 depending on context. See the individual commands for more information."
17491 (interactive "P")
17492 (cond
17493 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17494 ((and org-support-shift-select (org-region-active-p))
17495 (org-call-for-shift-select 'next-line))
17496 ((org-at-timestamp-p t)
17497 (call-interactively (if org-edit-timestamp-down-means-later
17498 'org-timestamp-up 'org-timestamp-down)))
17499 ((and (not (eq org-support-shift-select 'always))
17500 org-enable-priority-commands
17501 (org-on-heading-p))
17502 (call-interactively 'org-priority-down))
17503 ((and (not org-support-shift-select) (org-at-item-p))
17504 (call-interactively 'org-next-item))
17505 ((org-clocktable-try-shift 'down arg))
17506 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17507 (org-support-shift-select
17508 (org-call-for-shift-select 'next-line))
17509 (t (org-shiftselect-error))))
17511 (defun org-shiftright (&optional arg)
17512 "Cycle the thing at point or in the current line, depending on context.
17513 Depending on context, this does one of the following:
17515 - switch a timestamp at point one day into the future
17516 - on a headline, switch to the next TODO keyword.
17517 - on an item, switch entire list to the next bullet type
17518 - on a property line, switch to the next allowed value
17519 - on a clocktable definition line, move time block into the future"
17520 (interactive "P")
17521 (cond
17522 ((run-hook-with-args-until-success 'org-shiftright-hook))
17523 ((and org-support-shift-select (org-region-active-p))
17524 (org-call-for-shift-select 'forward-char))
17525 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17526 ((and (not (eq org-support-shift-select 'always))
17527 (org-on-heading-p))
17528 (let ((org-inhibit-logging
17529 (not org-treat-S-cursor-todo-selection-as-state-change))
17530 (org-inhibit-blocking
17531 (not org-treat-S-cursor-todo-selection-as-state-change)))
17532 (org-call-with-arg 'org-todo 'right)))
17533 ((or (and org-support-shift-select
17534 (not (eq org-support-shift-select 'always))
17535 (org-at-item-bullet-p))
17536 (and (not org-support-shift-select) (org-at-item-p)))
17537 (org-call-with-arg 'org-cycle-list-bullet nil))
17538 ((and (not (eq org-support-shift-select 'always))
17539 (org-at-property-p))
17540 (call-interactively 'org-property-next-allowed-value))
17541 ((org-clocktable-try-shift 'right arg))
17542 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17543 (org-support-shift-select
17544 (org-call-for-shift-select 'forward-char))
17545 (t (org-shiftselect-error))))
17547 (defun org-shiftleft (&optional arg)
17548 "Cycle the thing at point or in the current line, depending on context.
17549 Depending on context, this does one of the following:
17551 - switch a timestamp at point one day into the past
17552 - on a headline, switch to the previous TODO keyword.
17553 - on an item, switch entire list to the previous bullet type
17554 - on a property line, switch to the previous allowed value
17555 - on a clocktable definition line, move time block into the past"
17556 (interactive "P")
17557 (cond
17558 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17559 ((and org-support-shift-select (org-region-active-p))
17560 (org-call-for-shift-select 'backward-char))
17561 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17562 ((and (not (eq org-support-shift-select 'always))
17563 (org-on-heading-p))
17564 (let ((org-inhibit-logging
17565 (not org-treat-S-cursor-todo-selection-as-state-change))
17566 (org-inhibit-blocking
17567 (not org-treat-S-cursor-todo-selection-as-state-change)))
17568 (org-call-with-arg 'org-todo 'left)))
17569 ((or (and org-support-shift-select
17570 (not (eq org-support-shift-select 'always))
17571 (org-at-item-bullet-p))
17572 (and (not org-support-shift-select) (org-at-item-p)))
17573 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17574 ((and (not (eq org-support-shift-select 'always))
17575 (org-at-property-p))
17576 (call-interactively 'org-property-previous-allowed-value))
17577 ((org-clocktable-try-shift 'left arg))
17578 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17579 (org-support-shift-select
17580 (org-call-for-shift-select 'backward-char))
17581 (t (org-shiftselect-error))))
17583 (defun org-shiftcontrolright ()
17584 "Switch to next TODO set."
17585 (interactive)
17586 (cond
17587 ((and org-support-shift-select (org-region-active-p))
17588 (org-call-for-shift-select 'forward-word))
17589 ((and (not (eq org-support-shift-select 'always))
17590 (org-on-heading-p))
17591 (org-call-with-arg 'org-todo 'nextset))
17592 (org-support-shift-select
17593 (org-call-for-shift-select 'forward-word))
17594 (t (org-shiftselect-error))))
17596 (defun org-shiftcontrolleft ()
17597 "Switch to previous TODO set."
17598 (interactive)
17599 (cond
17600 ((and org-support-shift-select (org-region-active-p))
17601 (org-call-for-shift-select 'backward-word))
17602 ((and (not (eq org-support-shift-select 'always))
17603 (org-on-heading-p))
17604 (org-call-with-arg 'org-todo 'previousset))
17605 (org-support-shift-select
17606 (org-call-for-shift-select 'backward-word))
17607 (t (org-shiftselect-error))))
17609 (defun org-shiftcontrolup ()
17610 "Change timestamps synchronously up in CLOCK log lines."
17611 (interactive)
17612 (cond ((and (not org-support-shift-select)
17613 (org-at-clock-log-p)
17614 (org-at-timestamp-p t))
17615 (org-clock-timestamps-up))
17616 (t (org-shiftselect-error))))
17618 (defun org-shiftcontroldown ()
17619 "Change timestamps synchronously down in CLOCK log lines."
17620 (interactive)
17621 (cond ((and (not org-support-shift-select)
17622 (org-at-clock-log-p)
17623 (org-at-timestamp-p t))
17624 (org-clock-timestamps-down))
17625 (t (org-shiftselect-error))))
17627 (defun org-ctrl-c-ret ()
17628 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17629 (interactive)
17630 (cond
17631 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17632 (t (call-interactively 'org-insert-heading))))
17634 (defun org-copy-special ()
17635 "Copy region in table or copy current subtree.
17636 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17637 See the individual commands for more information."
17638 (interactive)
17639 (call-interactively
17640 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17642 (defun org-cut-special ()
17643 "Cut region in table or cut current subtree.
17644 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17645 See the individual commands for more information."
17646 (interactive)
17647 (call-interactively
17648 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17650 (defun org-paste-special (arg)
17651 "Paste rectangular region into table, or past subtree relative to level.
17652 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17653 See the individual commands for more information."
17654 (interactive "P")
17655 (if (org-at-table-p)
17656 (org-table-paste-rectangle)
17657 (org-paste-subtree arg)))
17659 (defun org-edit-special (&optional arg)
17660 "Call a special editor for the stuff at point.
17661 When at a table, call the formula editor with `org-table-edit-formulas'.
17662 When at the first line of an src example, call `org-edit-src-code'.
17663 When in an #+include line, visit the include file. Otherwise call
17664 `ffap' to visit the file at point."
17665 (interactive)
17666 ;; possibly prep session before editing source
17667 (when arg
17668 (let* ((info (org-babel-get-src-block-info))
17669 (lang (nth 0 info))
17670 (params (nth 2 info))
17671 (session (cdr (assoc :session params))))
17672 (when (and info session) ;; we are in a source-code block with a session
17673 (funcall
17674 (intern (concat "org-babel-prep-session:" lang)) session params))))
17675 (cond ;; proceed with `org-edit-special'
17676 ((save-excursion
17677 (beginning-of-line 1)
17678 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17679 (find-file (org-trim (match-string 1))))
17680 ((org-edit-src-code))
17681 ((org-edit-fixed-width-region))
17682 ((org-at-table.el-p)
17683 (org-edit-src-code))
17684 ((or (org-at-table-p)
17685 (save-excursion
17686 (beginning-of-line 1)
17688 (call-interactively 'org-table-edit-formulas))
17689 (t (call-interactively 'ffap))))
17691 (defun org-ctrl-c-ctrl-c (&optional arg)
17692 "Set tags in headline, or update according to changed information at point.
17694 This command does many different things, depending on context:
17696 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17697 this is what we do.
17699 - If the cursor is on a statistics cookie, update it.
17701 - If the cursor is in a headline, prompt for tags and insert them
17702 into the current line, aligned to `org-tags-column'. When called
17703 with prefix arg, realign all tags in the current buffer.
17705 - If the cursor is in one of the special #+KEYWORD lines, this
17706 triggers scanning the buffer for these lines and updating the
17707 information.
17709 - If the cursor is inside a table, realign the table. This command
17710 works even if the automatic table editor has been turned off.
17712 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17713 the entire table.
17715 - If the cursor is at a footnote reference or definition, jump to
17716 the corresponding definition or references, respectively.
17718 - If the cursor is a the beginning of a dynamic block, update it.
17720 - If the current buffer is a capture buffer, close note and file it.
17722 - If the cursor is on a <<<target>>>, update radio targets and
17723 corresponding links in this buffer.
17725 - If the cursor is on a numbered item in a plain list, renumber the
17726 ordered list.
17728 - If the cursor is on a checkbox, toggle it.
17730 - If the cursor is on a code block, evaluate it. The variable
17731 `org-confirm-babel-evaluate' can be used to control prompting
17732 before code block evaluation, by default every code block
17733 evaluation requires confirmation. Code block evaluation can be
17734 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17735 (interactive "P")
17736 (let ((org-enable-table-editor t))
17737 (cond
17738 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17739 org-occur-highlights
17740 org-latex-fragment-image-overlays)
17741 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17742 (org-remove-occur-highlights)
17743 (org-remove-latex-fragment-image-overlays)
17744 (message "Temporary highlights/overlays removed from current buffer"))
17745 ((and (local-variable-p 'org-finish-function (current-buffer))
17746 (fboundp org-finish-function))
17747 (funcall org-finish-function))
17748 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17749 ((or (looking-at org-property-start-re)
17750 (org-at-property-p))
17751 (call-interactively 'org-property-action))
17752 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17754 (or (org-on-heading-p) (org-at-item-p)))
17755 (call-interactively 'org-update-statistics-cookies))
17756 ((org-on-heading-p) (call-interactively 'org-set-tags))
17757 ((org-at-table.el-p)
17758 (message "Use C-c ' to edit table.el tables"))
17759 ((org-at-table-p)
17760 (org-table-maybe-eval-formula)
17761 (if arg
17762 (call-interactively 'org-table-recalculate)
17763 (org-table-maybe-recalculate-line))
17764 (call-interactively 'org-table-align)
17765 (orgtbl-send-table 'maybe))
17766 ((or (org-footnote-at-reference-p)
17767 (org-footnote-at-definition-p))
17768 (call-interactively 'org-footnote-action))
17769 ((org-at-item-checkbox-p)
17770 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17771 ;; list only if at top item.
17772 (let* ((cbox (match-string 1))
17773 (struct (org-list-struct))
17774 (old-struct (copy-tree struct))
17775 (parents (org-list-parents-alist struct))
17776 (prevs (org-list-prevs-alist struct))
17777 (orderedp (org-entry-get nil "ORDERED"))
17778 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17779 block-item)
17780 ;; Use a light version of `org-toggle-checkbox' to avoid
17781 ;; computing list structure twice.
17782 (org-list-set-checkbox (point-at-bol) struct
17783 (cond
17784 ((equal arg '(16)) "[-]")
17785 ((equal arg '(4)) nil)
17786 ((equal "[X]" cbox) "[ ]")
17787 (t "[X]")))
17788 (org-list-struct-fix-ind struct parents)
17789 (org-list-struct-fix-bul struct prevs)
17790 (setq block-item
17791 (org-list-struct-fix-box struct parents prevs orderedp))
17792 (when block-item
17793 (message
17794 "Checkboxes were removed due to unchecked box at line %d"
17795 (org-current-line block-item)))
17796 (org-list-struct-apply-struct struct old-struct)
17797 (org-update-checkbox-count-maybe)
17798 (when firstp (org-list-send-list 'maybe))))
17799 ((org-at-item-p)
17800 ;; Cursor at an item: repair list. Do checkbox related actions
17801 ;; only if function was called with an argument. Send list only
17802 ;; if at top item.
17803 (let* ((struct (org-list-struct))
17804 (old-struct (copy-tree struct))
17805 (parents (org-list-parents-alist struct))
17806 (prevs (org-list-prevs-alist struct))
17807 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17808 (org-list-struct-fix-ind struct parents)
17809 (org-list-struct-fix-bul struct prevs)
17810 (when arg
17811 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17812 (org-list-struct-fix-box struct parents prevs))
17813 (org-list-struct-apply-struct struct old-struct)
17814 (when arg (org-update-checkbox-count-maybe))
17815 (when firstp (org-list-send-list 'maybe))))
17816 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17817 ;; Dynamic block
17818 (beginning-of-line 1)
17819 (save-excursion (org-update-dblock)))
17820 ((save-excursion
17821 (beginning-of-line 1)
17823 (cond
17824 ((equal (match-string 1) "TBLFM")
17825 ;; Recalculate the table before this line
17826 (save-excursion
17827 (beginning-of-line 1)
17829 (if (org-at-table-p)
17830 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17831 (t
17832 (let ((org-inhibit-startup-visibility-stuff t)
17833 (org-startup-align-all-tables nil))
17834 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17835 (message "Local setup has been refreshed"))))
17836 ((org-clock-update-time-maybe))
17837 (t
17838 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17839 (error "C-c C-c can do nothing useful at this location"))))))
17841 (defun org-mode-restart ()
17842 "Restart Org-mode, to scan again for special lines.
17843 Also updates the keyword regular expressions."
17844 (interactive)
17845 (org-mode)
17846 (message "Org-mode restarted"))
17848 (defun org-kill-note-or-show-branches ()
17849 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17850 (interactive)
17851 (if (not org-finish-function)
17852 (progn
17853 (hide-subtree)
17854 (call-interactively 'show-branches))
17855 (let ((org-note-abort t))
17856 (funcall org-finish-function))))
17858 (defun org-return (&optional indent)
17859 "Goto next table row or insert a newline.
17860 Calls `org-table-next-row' or `newline', depending on context.
17861 See the individual commands for more information."
17862 (interactive)
17863 (cond
17864 ((bobp) (if indent (newline-and-indent) (newline)))
17865 ((org-at-table-p)
17866 (org-table-justify-field-maybe)
17867 (call-interactively 'org-table-next-row))
17868 ;; when `newline-and-indent' is called within a list, make sure
17869 ;; text moved stays inside the item.
17870 ((and (org-in-item-p) indent)
17871 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17872 (progn
17873 (newline)
17874 (org-indent-line-to (length (match-string 0))))
17875 (let ((ind (org-get-indentation)))
17876 (newline)
17877 (if (org-looking-back org-list-end-re)
17878 (org-indent-line-function)
17879 (org-indent-line-to ind)))))
17880 ((and org-return-follows-link
17881 (eq (get-text-property (point) 'face) 'org-link))
17882 (call-interactively 'org-open-at-point))
17883 ((and (org-at-heading-p)
17884 (looking-at
17886 (org-show-entry)
17887 (end-of-line 1)
17888 (newline))
17889 (t (if indent (newline-and-indent) (newline)))))
17891 (defun org-return-indent ()
17892 "Goto next table row or insert a newline and indent.
17893 Calls `org-table-next-row' or `newline-and-indent', depending on
17894 context. See the individual commands for more information."
17895 (interactive)
17896 (org-return t))
17898 (defun org-ctrl-c-star ()
17899 "Compute table, or change heading status of lines.
17900 Calls `org-table-recalculate' or `org-toggle-heading',
17901 depending on context."
17902 (interactive)
17903 (cond
17904 ((org-at-table-p)
17905 (call-interactively 'org-table-recalculate))
17906 (t
17907 ;; Convert all lines in region to list items
17908 (call-interactively 'org-toggle-heading))))
17910 (defun org-ctrl-c-minus ()
17911 "Insert separator line in table or modify bullet status of line.
17912 Also turns a plain line or a region of lines into list items.
17913 Calls `org-table-insert-hline', `org-toggle-item', or
17914 `org-cycle-list-bullet', depending on context."
17915 (interactive)
17916 (cond
17917 ((org-at-table-p)
17918 (call-interactively 'org-table-insert-hline))
17919 ((org-region-active-p)
17920 (call-interactively 'org-toggle-item))
17921 ((org-in-item-p)
17922 (call-interactively 'org-cycle-list-bullet))
17923 (t
17924 (call-interactively 'org-toggle-item))))
17926 (defun org-toggle-item (arg)
17927 "Convert headings or normal lines to items, items to normal lines.
17928 If there is no active region, only the current line is considered.
17930 If the first non blank line in the region is an headline, convert
17931 all headlines to items, shifting text accordingly.
17933 If it is an item, convert all items to normal lines.
17935 If it is normal text, change region into an item. With a prefix
17936 argument ARG, change each line in region into an item."
17937 (interactive "P")
17938 (let ((shift-text
17939 (function
17940 ;; Shift text in current section to IND, from point to END.
17941 ;; The function leaves point to END line.
17942 (lambda (ind end)
17943 (let ((min-i 1000) (end (copy-marker end)))
17944 ;; First determine the minimum indentation (MIN-I) of
17945 ;; the text.
17946 (save-excursion
17947 (catch 'exit
17948 (while (< (point) end)
17949 (let ((i (org-get-indentation)))
17950 (cond
17951 ;; Skip blank lines and inline tasks.
17953 ((looking-at org-outline-regexp-bol))
17954 ;; We can't find less than 0 indentation.
17955 ((zerop i) (throw 'exit (setq min-i 0)))
17956 ((< i min-i) (setq min-i i))))
17957 (forward-line))))
17958 ;; Then indent each line so that a line indented to
17959 ;; MIN-I becomes indented to IND. Ignore blank lines
17960 ;; and inline tasks in the process.
17961 (let ((delta (- ind min-i)))
17962 (while (< (point) end)
17964 (looking-at org-outline-regexp-bol))
17965 (org-indent-line-to (+ (org-get-indentation) delta)))
17966 (forward-line)))))))
17967 (skip-blanks
17968 (function
17969 ;; Return beginning of first non-blank line, starting from
17970 ;; line at POS.
17971 (lambda (pos)
17972 (save-excursion
17973 (goto-char pos)
17975 (point-at-bol)))))
17976 beg end)
17977 ;; Determine boundaries of changes.
17978 (if (org-region-active-p)
17979 (setq beg (funcall skip-blanks (region-beginning))
17980 end (copy-marker (region-end)))
17981 (setq beg (funcall skip-blanks (point-at-bol))
17982 end (copy-marker (point-at-eol))))
17983 ;; Depending on the starting line, choose an action on the text
17984 ;; between BEG and END.
17985 (org-with-limited-levels
17986 (save-excursion
17987 (goto-char beg)
17988 (cond
17989 ;; Case 1. Start at an item: de-itemize. Note that it only
17990 ;; happens when a region is active: `org-ctrl-c-minus'
17991 ;; would call `org-cycle-list-bullet' otherwise.
17992 ((org-at-item-p)
17993 (while (< (point) end)
17994 (when (org-at-item-p)
17996 (delete-region (point) (match-end 0)))
17997 (forward-line)))
17998 ;; Case 2. Start at an heading: convert to items.
17999 ((org-on-heading-p)
18000 (let* ((bul (org-list-bullet-string "-"))
18001 (bul-len (length bul))
18002 ;; Indentation of the first heading. It should be
18003 ;; relative to the indentation of its parent, if any.
18004 (start-ind (save-excursion
18005 (cond
18006 ((not org-adapt-indentation) 0)
18007 ((not (outline-previous-heading)) 0)
18008 (t (length (match-string 0))))))
18009 ;; Level of first heading. Further headings will be
18010 ;; compared to it to determine hierarchy in the list.
18011 (ref-level (org-reduced-level (org-outline-level))))
18012 (while (< (point) end)
18013 (let* ((level (org-reduced-level (org-outline-level)))
18014 (delta (max 0 (- level ref-level))))
18015 ;; If current headline is less indented than the first
18016 ;; one, set it as reference, in order to preserve
18017 ;; subtrees.
18018 (when (< level ref-level) (setq ref-level level))
18019 (replace-match bul t t)
18020 (org-indent-line-to (+ start-ind (* delta bul-len)))
18021 ;; Ensure all text down to END (or SECTION-END) belongs
18022 ;; to the newly created item.
18023 (let ((section-end (save-excursion
18024 (or (outline-next-heading) (point)))))
18025 (forward-line)
18026 (funcall shift-text
18027 (+ start-ind (* (1+ delta) bul-len))
18028 (min end section-end)))))))
18029 ;; Case 3. Normal line with ARG: turn each non-item line into
18030 ;; an item.
18031 (arg
18032 (while (< (point) end)
18033 (unless (or (org-on-heading-p) (org-at-item-p))
18035 (replace-match
18037 (forward-line)))
18038 ;; Case 4. Normal line without ARG: make the first line of
18039 ;; region an item, and shift indentation of others
18040 ;; lines to set them as item's body.
18041 (t (let* ((bul (org-list-bullet-string "-"))
18042 (bul-len (length bul))
18043 (ref-ind (org-get-indentation)))
18045 (insert bul)
18046 (forward-line)
18047 (while (< (point) end)
18048 ;; Ensure that lines less indented than first one
18049 ;; still get included in item body.
18050 (funcall shift-text
18051 (+ ref-ind bul-len)
18052 (min end (save-excursion (or (outline-next-heading)
18053 (point)))))
18054 (forward-line)))))))))
18056 (defun org-toggle-heading (&optional nstars)
18057 "Convert headings to normal text, or items or text to headings.
18058 If there is no active region, only the current line is considered.
18060 If the first non blank line is an headline, remove the stars from
18061 all headlines in the region.
18063 If it is a plain list item, turn all plain list items into headings.
18065 If it is a normal line, turn each and every normal line (i.e. not
18066 an heading or an item) in the region into a heading.
18068 When converting a line into a heading, the number of stars is chosen
18069 such that the lines become children of the current entry. However,
18070 when a prefix argument is given, its value determines the number of
18071 stars to add."
18072 (interactive "P")
18073 (let ((skip-blanks
18074 (function
18075 ;; Return beginning of first non-blank line, starting from
18076 ;; line at POS.
18077 (lambda (pos)
18078 (save-excursion
18079 (goto-char pos)
18081 (point-at-bol)))))
18082 beg end)
18083 ;; Determine boundaries of changes. If region ends at a bol, do
18084 ;; not consider the last line to be in the region.
18085 (if (org-region-active-p)
18086 (setq beg (funcall skip-blanks (region-beginning))
18087 end (copy-marker (save-excursion
18088 (goto-char (region-end))
18089 (if (bolp) (point) (point-at-eol)))))
18090 (setq beg (funcall skip-blanks (point-at-bol))
18091 end (copy-marker (point-at-eol))))
18092 ;; Ensure inline tasks don't count as headings.
18093 (org-with-limited-levels
18094 (save-excursion
18095 (goto-char beg)
18096 (cond
18097 ;; Case 1. Started at an heading: de-star headings.
18098 ((org-on-heading-p)
18099 (while (< (point) end)
18100 (when (org-on-heading-p t)
18101 (looking-at org-outline-regexp) (replace-match ""))
18102 (forward-line)))
18103 ;; Case 2. Started at an item: change items into headlines.
18104 ;; One star will be added by `org-list-to-subtree'.
18105 ((org-at-item-p)
18106 (let* ((stars (make-string
18107 (if nstars
18108 ;; subtract the star that will be added again by
18109 ;; `org-list-to-subtree'
18110 (1- (prefix-numeric-value current-prefix-arg))
18111 (or (org-current-level) 0))
18112 ?*))
18113 (add-stars
18114 (cond (nstars "") ; stars from prefix only
18115 ((equal stars "") "") ; before first heading
18116 (org-odd-levels-only "*") ; inside heading, odd
18117 (t "")))) ; inside heading, oddeven
18118 (while (< (point) end)
18119 (when (org-at-item-p)
18120 ;; Pay attention to cases when region ends before list.
18121 (let* ((struct (org-list-struct))
18122 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18123 (save-restriction
18124 (narrow-to-region (point) list-end)
18125 (insert
18126 (org-list-to-subtree
18127 (org-list-parse-list t)
18128 '(:istart (concat stars add-stars (funcall get-stars depth))
18129 :icount (concat stars add-stars (funcall get-stars depth))))))))
18130 (forward-line))))
18131 ;; Case 3. Started at normal text: make every line an heading,
18132 ;; skipping headlines and items.
18133 (t (let* ((stars (make-string
18134 (if nstars
18135 (prefix-numeric-value current-prefix-arg)
18136 (or (org-current-level) 0))
18137 ?*))
18138 (add-stars
18139 (cond (nstars "") ; stars from prefix only
18140 ((equal stars "") "*") ; before first heading
18141 (org-odd-levels-only "**") ; inside heading, odd
18142 (t "*"))) ; inside heading, oddeven
18143 (rpl (concat stars add-stars " ")))
18144 (while (< (point) end)
18145 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18147 (replace-match (concat rpl (match-string 2))))
18148 (forward-line)))))))))
18150 (defun org-meta-return (&optional arg)
18151 "Insert a new heading or wrap a region in a table.
18152 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18153 See the individual commands for more information."
18154 (interactive "P")
18155 (cond
18156 ((run-hook-with-args-until-success 'org-metareturn-hook))
18157 ((org-at-table-p)
18158 (call-interactively 'org-table-wrap-region))
18159 (t (call-interactively 'org-insert-heading))))
18161 ;;; Menu entries
18163 ;; Define the Org-mode menus
18164 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18165 '("Tbl"
18166 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18167 ["Next Field" org-cycle (org-at-table-p)]
18168 ["Previous Field" org-shifttab (org-at-table-p)]
18169 ["Next Row" org-return (org-at-table-p)]
18170 "--"
18171 ["Blank Field" org-table-blank-field (org-at-table-p)]
18172 ["Edit Field" org-table-edit-field (org-at-table-p)]
18173 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18174 "--"
18175 ("Column"
18176 ["Move Column Left" org-metaleft (org-at-table-p)]
18177 ["Move Column Right" org-metaright (org-at-table-p)]
18178 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18179 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18180 ("Row"
18181 ["Move Row Up" org-metaup (org-at-table-p)]
18182 ["Move Row Down" org-metadown (org-at-table-p)]
18183 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18184 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18185 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18186 "--"
18187 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18188 ("Rectangle"
18189 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18190 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18191 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18192 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18193 "--"
18194 ("Calculate"
18195 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18196 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18197 ["Edit Formulas" org-edit-special (org-at-table-p)]
18198 "--"
18199 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18200 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18201 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18202 "--"
18203 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18204 "--"
18205 ["Sum Column/Rectangle" org-table-sum
18206 (or (org-at-table-p) (org-region-active-p))]
18207 ["Which Column?" org-table-current-column (org-at-table-p)])
18208 ["Debug Formulas"
18209 org-table-toggle-formula-debugger
18210 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18211 ["Show Col/Row Numbers"
18212 org-table-toggle-coordinate-overlays
18213 :style toggle
18214 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18215 "--"
18216 ["Create" org-table-create (and (not (org-at-table-p))
18217 org-enable-table-editor)]
18218 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18219 ["Import from File" org-table-import (not (org-at-table-p))]
18220 ["Export to File" org-table-export (org-at-table-p)]
18221 "--"
18222 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18224 (easy-menu-define org-org-menu org-mode-map "Org menu"
18225 '("Org"
18226 ("Show/Hide"
18227 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18228 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18229 ["Sparse Tree..." org-sparse-tree t]
18230 ["Reveal Context" org-reveal t]
18231 ["Show All" show-all t]
18232 "--"
18233 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18234 "--"
18235 ["New Heading" org-insert-heading t]
18236 ("Navigate Headings"
18237 ["Up" outline-up-heading t]
18238 ["Next" outline-next-visible-heading t]
18239 ["Previous" outline-previous-visible-heading t]
18240 ["Next Same Level" outline-forward-same-level t]
18241 ["Previous Same Level" outline-backward-same-level t]
18242 "--"
18243 ["Jump" org-goto t])
18244 ("Edit Structure"
18245 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18246 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18247 "--"
18248 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18249 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18250 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18251 "--"
18252 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18253 "--"
18254 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18255 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18256 ["Demote Heading" org-metaright (not (org-at-table-p))]
18257 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18258 "--"
18259 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18260 "--"
18261 ["Convert to odd levels" org-convert-to-odd-levels t]
18262 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18263 ("Editing"
18264 ["Emphasis..." org-emphasize t]
18265 ["Edit Source Example" org-edit-special t]
18266 "--"
18267 ["Footnote new/jump" org-footnote-action t]
18268 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18269 ("Archive"
18270 ["Archive (default method)" org-archive-subtree-default t]
18271 "--"
18272 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18273 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18274 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18275 )
18276 "--"
18277 ("Hyperlinks"
18278 ["Store Link (Global)" org-store-link t]
18279 ["Find existing link to here" org-occur-link-in-agenda-files t]
18280 ["Insert Link" org-insert-link t]
18281 ["Follow Link" org-open-at-point t]
18282 "--"
18283 ["Next link" org-next-link t]
18284 ["Previous link" org-previous-link t]
18285 "--"
18286 ["Descriptive Links"
18287 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18288 :style radio
18289 :selected (member '(org-link) buffer-invisibility-spec)]
18290 ["Literal Links"
18291 (progn
18292 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18293 :style radio
18294 :selected (not (member '(org-link) buffer-invisibility-spec))])
18295 "--"
18296 ("TODO Lists"
18297 ["TODO/DONE/-" org-todo t]
18298 ("Select keyword"
18299 ["Next keyword" org-shiftright (org-on-heading-p)]
18300 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18301 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18302 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18303 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18304 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18305 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18306 "--"
18307 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18308 :selected org-enforce-todo-dependencies :style toggle :active t]
18309 "Settings for tree at point"
18310 ["Do Children sequentially" org-toggle-ordered-property :style radio
18311 :selected (org-entry-get nil "ORDERED")
18312 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18313 ["Do Children parallel" org-toggle-ordered-property :style radio
18314 :selected (not (org-entry-get nil "ORDERED"))
18315 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18316 "--"
18317 ["Set Priority" org-priority t]
18318 ["Priority Up" org-shiftup t]
18319 ["Priority Down" org-shiftdown t]
18320 "--"
18321 ["Get news from all feeds" org-feed-update-all t]
18322 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18323 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18324 ("TAGS and Properties"
18325 ["Set Tags" org-set-tags-command t]
18326 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18327 "--"
18328 ["Set property" org-set-property t]
18329 ["Column view of properties" org-columns t]
18330 ["Insert Column View DBlock" org-insert-columns-dblock t])
18331 ("Dates and Scheduling"
18332 ["Timestamp" org-time-stamp t]
18333 ["Timestamp (inactive)" org-time-stamp-inactive t]
18334 ("Change Date"
18335 ["1 Day Later" org-shiftright t]
18336 ["1 Day Earlier" org-shiftleft t]
18337 ["1 ... Later" org-shiftup t]
18338 ["1 ... Earlier" org-shiftdown t])
18339 ["Compute Time Range" org-evaluate-time-range t]
18340 ["Schedule Item" org-schedule t]
18341 ["Deadline" org-deadline t]
18342 "--"
18343 ["Custom time format" org-toggle-time-stamp-overlays
18344 :style radio :selected org-display-custom-times]
18345 "--"
18346 ["Goto Calendar" org-goto-calendar t]
18347 ["Date from Calendar" org-date-from-calendar t]
18348 "--"
18349 ["Start/Restart Timer" org-timer-start t]
18350 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18351 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18352 ["Insert Timer String" org-timer t]
18353 ["Insert Timer Item" org-timer-item t])
18354 ("Logging work"
18355 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18356 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18357 ["Clock out" org-clock-out t]
18358 ["Clock cancel" org-clock-cancel t]
18359 "--"
18360 ["Mark as default task" org-clock-mark-default-task t]
18361 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18362 ["Goto running clock" org-clock-goto t]
18363 "--"
18364 ["Display times" org-clock-display t]
18365 ["Create clock table" org-clock-report t]
18366 "--"
18367 ["Record DONE time"
18368 (progn (setq org-log-done (not org-log-done))
18369 (message "Switching to %s will %s record a timestamp"
18370 (car org-done-keywords)
18371 (if org-log-done "automatically" "not")))
18372 :style toggle :selected org-log-done])
18373 "--"
18374 ["Agenda Command..." org-agenda t]
18375 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18376 ("File List for Agenda")
18377 ("Special views current file"
18378 ["TODO Tree" org-show-todo-tree t]
18379 ["Check Deadlines" org-check-deadlines t]
18380 ["Timeline" org-timeline t]
18381 ["Tags/Property tree" org-match-sparse-tree t])
18382 "--"
18383 ["Export/Publish..." org-export t]
18384 ("LaTeX"
18385 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18386 :selected org-cdlatex-mode]
18387 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18388 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18389 ["Modify math symbol" org-cdlatex-math-modify
18390 (org-inside-LaTeX-fragment-p)]
18391 ["Insert citation" org-reftex-citation t]
18392 "--"
18393 ["Template for BEAMER" org-insert-beamer-options-template t])
18394 "--"
18395 ("MobileOrg"
18396 ["Push Files and Views" org-mobile-push t]
18397 ["Get Captured and Flagged" org-mobile-pull t]
18398 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18399 "--"
18400 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18401 "--"
18402 ("Documentation"
18403 ["Show Version" org-version t]
18404 ["Info Documentation" org-info t])
18405 ("Customize"
18406 ["Browse Org Group" org-customize t]
18407 "--"
18408 ["Expand This Menu" org-create-customize-menu
18409 (fboundp 'customize-menu-create)])
18410 ["Send bug report" org-submit-bug-report t]
18411 "--"
18412 ("Refresh/Reload"
18413 ["Refresh setup current buffer" org-mode-restart t]
18414 ["Reload Org (after update)" org-reload t]
18415 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18416 ))
18418 (defun org-info (&optional node)
18419 "Read documentation for Org-mode in the info system.
18420 With optional NODE, go directly to that node."
18421 (interactive)
18422 (info (format "(org)%s" (or node ""))))
18424 ;;;###autoload
18425 (defun org-submit-bug-report ()
18426 "Submit a bug report on Org-mode via mail.
18428 Don't hesitate to report any problems or inaccurate documentation.
18430 If you don't have setup sending mail from (X)Emacs, please copy the
18431 output buffer into your mail program, as it gives us important
18432 information about your Org-mode version and configuration."
18433 (interactive)
18434 (require 'reporter)
18435 (org-load-modules-maybe)
18436 (org-require-autoloaded-modules)
18437 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18438 (reporter-submit-bug-report
18439 "emacs-orgmode@gnu.org"
18440 (org-version)
18441 (let (list)
18442 (save-window-excursion
18443 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18444 (delete-other-windows)
18445 (erase-buffer)
18446 (insert "You are about to submit a bug report to the Org-mode mailing list.
18448 We would like to add your full Org-mode and Outline configuration to the
18449 bug report. This greatly simplifies the work of the maintainer and
18450 other experts on the mailing list.
18452 HOWEVER, some variables you have customized may contain private
18453 information. The names of customers, colleagues, or friends, might
18454 appear in the form of file names, tags, todo states, or search strings.
18455 If you answer yes to the prompt, you might want to check and remove
18456 such private information before sending the email.")
18457 (add-text-properties (point-min) (point-max) '(face org-warning))
18458 (when (yes-or-no-p "Include your Org-mode configuration ")
18459 (mapatoms
18460 (lambda (v)
18461 (and (boundp v)
18463 (or (and (symbol-value v)
18465 (and
18466 (get v 'custom-type) (get v 'standard-value)
18467 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18468 (push v list)))))
18469 (kill-buffer (get-buffer "*Warn about privacy*"))
18470 list))
18471 nil nil
18472 "Remember to cover the basics, that is, what you expected to happen and
18473 what in fact did happen. You don't know how to make a good report? See
18475 http://orgmode.org/manual/Feedback.html#Feedback
18477 Your bug report will be posted to the Org-mode mailing list.
18478 ------------------------------------------------------------------------")
18479 (save-excursion
18484 (defun org-install-agenda-files-menu ()
18485 (let ((bl (buffer-list)))
18486 (save-excursion
18487 (while bl
18488 (set-buffer (pop bl))
18489 (if (org-mode-p) (setq bl nil)))
18490 (when (org-mode-p)
18491 (easy-menu-change
18492 '("Org") "File List for Agenda"
18493 (append
18494 (list
18495 ["Edit File List" (org-edit-agenda-file-list) t]
18496 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18497 ["Remove Current File from List" org-remove-file t]
18498 ["Cycle through agenda files" org-cycle-agenda-files t]
18499 ["Occur in all agenda files" org-occur-in-agenda-files t]
18500 "--")
18501 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18503 ;;;; Documentation
18505 ;;;###autoload
18506 (defun org-require-autoloaded-modules ()
18507 (interactive)
18508 (mapc 'require
18509 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18510 org-docbook org-exp org-html org-icalendar
18511 org-id org-latex
18512 org-publish org-remember org-table
18513 org-timer org-xoxo)))
18515 ;;;###autoload
18516 (defun org-reload (&optional uncompiled)
18517 "Reload all org lisp files.
18518 With prefix arg UNCOMPILED, load the uncompiled versions."
18519 (interactive "P")
18520 (require 'find-func)
18522 (dir-org (file-name-directory (org-find-library-name "org")))
18523 (dir-org-contrib (ignore-errors
18524 (file-name-directory
18525 (org-find-library-name "org-contribdir"))))
18526 (babel-files
18527 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18528 (append (list nil "comint" "eval" "exp" "keys"
18529 "lob" "ref" "table" "tangle")
18530 (delq nil
18531 (mapcar
18532 (lambda (lang)
18533 (when (cdr lang) (symbol-name (car lang))))
18534 org-babel-load-languages)))))
18535 (files
18536 (append (directory-files dir-org t file-re)
18537 babel-files
18538 (and dir-org-contrib
18539 (directory-files dir-org-contrib t file-re))))
18540 (remove-re (concat (if (featurep 'xemacs)
18541 "org-colview" "org-colview-xemacs")
18543 (setq files (mapcar 'file-name-sans-extension files))
18544 (setq files (mapcar
18545 (lambda (x) (if (string-match remove-re x) nil x))
18546 files))
18547 (setq files (delq nil files))
18548 (mapc
18549 (lambda (f)
18550 (when (featurep (intern (file-name-nondirectory f)))
18551 (if (and (not uncompiled)
18552 (file-exists-p (concat f ".elc")))
18553 (load (concat f ".elc") nil nil t)
18554 (load (concat f ".el") nil nil t))))
18555 files))
18556 (org-version))
18558 ;;;###autoload
18559 (defun org-customize ()
18560 "Call the customize function with org as argument."
18561 (interactive)
18562 (org-load-modules-maybe)
18563 (org-require-autoloaded-modules)
18564 (customize-browse 'org))
18566 (defun org-create-customize-menu ()
18567 "Create a full customization menu for Org-mode, insert it into the menu."
18568 (interactive)
18569 (org-load-modules-maybe)
18570 (org-require-autoloaded-modules)
18571 (if (fboundp 'customize-menu-create)
18572 (progn
18573 (easy-menu-change
18574 '("Org") "Customize"
18575 `(["Browse Org group" org-customize t]
18576 "--"
18577 ,(customize-menu-create 'org)
18578 ["Set" Custom-set t]
18579 ["Save" Custom-save t]
18580 ["Reset to Current" Custom-reset-current t]
18581 ["Reset to Saved" Custom-reset-saved t]
18582 ["Reset to Standard Settings" Custom-reset-standard t]))
18584 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18586 ;;;; Miscellaneous stuff
18588 ;;; Generally useful functions
18590 (defun org-get-at-bol (property)
18591 "Get text property PROPERTY at beginning of line."
18592 (get-text-property (point-at-bol) property))
18594 (defun org-find-text-property-in-string (prop s)
18595 "Return the first non-nil value of property PROP in string S."
18596 (or (get-text-property 0 prop s)
18597 (get-text-property (or (next-single-property-change 0 prop s) 0)
18598 prop s)))
18600 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18601 "Display the given MESSAGE as a warning."
18602 (if (fboundp 'display-warning)
18603 (display-warning 'org message
18604 (if (featurep 'xemacs) 'warning :warning))
18605 (let ((buf (get-buffer-create "*Org warnings*")))
18606 (with-current-buffer buf
18607 (goto-char (point-max))
18608 (insert "Warning (Org): " message)
18609 (unless (bolp)
18610 (newline)))
18611 (display-buffer buf)
18612 (sit-for 0))))
18614 (defun org-eval (form)
18615 "Eval FORM and return result."
18616 (condition-case error
18617 (eval form)
18618 (error (format "%%![Error: %s]" error))))
18620 (defun org-in-commented-line ()
18621 "Is point in a line starting with `#'?"
18622 (equal (char-after (point-at-bol)) ?#))
18624 (defun org-in-indented-comment-line ()
18625 "Is point in a line starting with `#' after some white space?"
18626 (save-excursion
18627 (save-match-data
18628 (goto-char (point-at-bol))
18631 (defun org-in-verbatim-emphasis ()
18632 (save-match-data
18633 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18635 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18636 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18637 (if (and marker (marker-buffer marker)
18638 (buffer-live-p (marker-buffer marker)))
18639 (progn
18640 (org-pop-to-buffer-same-window (marker-buffer marker))
18641 (if (or (> marker (point-max)) (< marker (point-min)))
18642 (widen))
18643 (goto-char marker)
18644 (org-show-context 'org-goto))
18645 (if bookmark
18646 (bookmark-jump bookmark)
18647 (error "Cannot find location"))))
18649 (defun org-quote-csv-field (s)
18650 "Quote field for inclusion in CSV material."
18653 s))
18655 (defun org-force-self-insert (N)
18656 "Needed to enforce self-insert under remapping."
18657 (interactive "p")
18658 (self-insert-command N))
18660 (defun org-string-width (s)
18661 "Compute width of string, ignoring invisible characters.
18662 This ignores character with invisibility property `org-link', and also
18663 characters with property `org-cwidth', because these will become invisible
18664 upon the next fontification round."
18665 (let (b l)
18666 (when (or (eq t buffer-invisibility-spec)
18667 (assq 'org-link buffer-invisibility-spec))
18668 (while (setq b (text-property-any 0 (length s)
18669 'invisible 'org-link s))
18670 (setq s (concat (substring s 0 b)
18671 (substring s (or (next-single-property-change
18672 b 'invisible s) (length s)))))))
18673 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18674 (setq s (concat (substring s 0 b)
18675 (substring s (or (next-single-property-change
18676 b 'org-cwidth s) (length s))))))
18677 (setq l (string-width s) b -1)
18678 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18679 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18680 l))
18682 (defun org-shorten-string (s maxlength)
18683 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18684 If the string is shorter or has length MAXLENGTH, just return the
18685 original string. If it is longer, the functions finds a space in the
18686 string, breaks this string off at that locations and adds three dots
18687 as ellipsis. Including the ellipsis, the string will not be longer
18688 than MAXLENGTH. If finding a good breaking point in the string does
18689 not work, the string is just chopped off in the middle of a word
18690 if necessary."
18691 (if (<= (length s) maxlength)
18692 s
18693 (let* ((n (max (- maxlength 4) 1))
18695 (if (string-match re s)
18696 (concat (match-string 1 s) "...")
18697 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18699 (defun org-get-indentation (&optional line)
18700 "Get the indentation of the current line, interpreting tabs.
18701 When LINE is given, assume it represents a line and compute its indentation."
18702 (if line
18703 (if (string-match "^ *" (org-remove-tabs line))
18704 (match-end 0))
18705 (save-excursion
18706 (beginning-of-line 1)
18708 (current-column))))
18710 (defun org-get-string-indentation (s)
18711 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18712 (let ((n -1) (i 0) (w tab-width) c)
18713 (catch 'exit
18714 (while (< (setq n (1+ n)) (length s))
18715 (setq c (aref s n))
18716 (cond ((= c ?\ ) (setq i (1+ i)))
18718 (t (throw 'exit t)))))
18719 i))
18721 (defun org-remove-tabs (s &optional width)
18722 "Replace tabulators in S with spaces.
18723 Assumes that s is a single line, starting in column 0."
18724 (setq width (or width tab-width))
18726 (setq s (replace-match
18727 (make-string
18728 (- (* width (/ (+ (match-beginning 0) width) width))
18729 (match-beginning 0)) ?\ )
18730 t t s)))
18731 s)
18733 (defun org-fix-indentation (line ind)
18734 "Fix indentation in LINE.
18735 IND is a cons cell with target and minimum indentation.
18736 If the current indentation in LINE is smaller than the minimum,
18737 leave it alone. If it is larger than ind, set it to the target."
18738 (let* ((l (org-remove-tabs line))
18739 (i (org-get-indentation l))
18740 (i1 (car ind)) (i2 (cdr ind)))
18741 (if (>= i i2) (setq l (substring line i2)))
18742 (if (> i1 0)
18743 (concat (make-string i1 ?\ ) l)
18744 l)))
18746 (defun org-remove-indentation (code &optional n)
18747 "Remove the maximum common indentation from the lines in CODE.
18748 N may optionally be the number of spaces to remove."
18749 (with-temp-buffer
18750 (insert code)
18751 (org-do-remove-indentation n)
18752 (buffer-string)))
18754 (defun org-do-remove-indentation (&optional n)
18755 "Remove the maximum common indentation from the buffer."
18756 (untabify (point-min) (point-max))
18757 (let ((min 10000) re)
18758 (if n
18759 (setq min n)
18760 (goto-char (point-min))
18762 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18763 (unless (or (= min 0) (= min 10000))
18765 (goto-char (point-min))
18766 (while (re-search-forward re nil t)
18767 (replace-match "")
18768 (end-of-line 1))
18769 min)))
18771 (defun org-fill-template (template alist)
18772 "Find each %key of ALIST in TEMPLATE and replace it."
18773 (let ((case-fold-search nil)
18774 entry key value)
18775 (setq alist (sort (copy-sequence alist)
18776 (lambda (a b) (< (length (car a)) (length (car b))))))
18777 (while (setq entry (pop alist))
18778 (setq template
18779 (replace-regexp-in-string
18780 (concat "%" (regexp-quote (car entry)))
18781 (cdr entry) template t t)))
18782 template))
18784 (defun org-base-buffer (buffer)
18785 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18786 (if (not buffer)
18787 buffer
18788 (or (buffer-base-buffer buffer)
18789 buffer)))
18791 (defun org-trim (s)
18792 "Remove whitespace at beginning and end of string."
18795 s)
18797 (defun org-wrap (string &optional width lines)
18798 "Wrap string to either a number of lines, or a width in characters.
18799 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18800 that costs. If there is a word longer than WIDTH, the text is actually
18801 wrapped to the length of that word.
18802 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18803 many lines, whatever width that takes.
18804 The return value is a list of lines, without newlines at the end."
18806 (maxword (apply 'max (mapcar 'org-string-width words)))
18807 w ll)
18808 (cond (width
18809 (org-do-wrap words (max maxword width)))
18810 (lines
18811 (setq w maxword)
18812 (setq ll (org-do-wrap words maxword))
18813 (if (<= (length ll) lines)
18814 ll
18815 (setq ll words)
18816 (while (> (length ll) lines)
18817 (setq w (1+ w))
18818 (setq ll (org-do-wrap words w)))
18819 ll))
18820 (t (error "Cannot wrap this")))))
18822 (defun org-do-wrap (words width)
18823 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18824 (let (lines line)
18825 (while words
18826 (setq line (pop words))
18827 (while (and words (< (+ (length line) (length (car words))) width))
18828 (setq line (concat line " " (pop words))))
18829 (setq lines (push line lines)))
18830 (nreverse lines)))
18832 (defun org-split-string (string &optional separators)
18833 "Splits STRING into substrings at SEPARATORS.
18834 No empty strings are returned if there are matches at the beginning
18835 and end of string."
18837 (start 0)
18838 notfirst
18839 (list nil))
18840 (while (and (string-match rexp string
18841 (if (and notfirst
18842 (= start (match-beginning 0))
18843 (< start (length string)))
18844 (1+ start) start))
18845 (< (match-beginning 0) (length string)))
18846 (setq notfirst t)
18847 (or (eq (match-beginning 0) 0)
18848 (and (eq (match-beginning 0) (match-end 0))
18849 (eq (match-beginning 0) start))
18850 (setq list
18851 (cons (substring string start (match-beginning 0))
18852 list)))
18853 (setq start (match-end 0)))
18854 (or (eq start (length string))
18855 (setq list
18856 (cons (substring string start)
18857 list)))
18858 (nreverse list)))
18860 (defun org-quote-vert (s)
18862 (while (string-match "|" s)
18864 s)
18866 (defun org-uuidgen-p (s)
18867 "Is S an ID created by UUIDGEN?"
18868 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18870 (defun org-context ()
18871 "Return a list of contexts of the current cursor position.
18872 If several contexts apply, all are returned.
18873 Each context entry is a list with a symbol naming the context, and
18874 two positions indicating start and end of the context. Possible
18875 contexts are:
18877 :headline anywhere in a headline
18878 :headline-stars on the leading stars in a headline
18879 :todo-keyword on a TODO keyword (including DONE) in a headline
18880 :tags on the TAGS in a headline
18881 :priority on the priority cookie in a headline
18882 :item on the first line of a plain list item
18883 :item-bullet on the bullet/number of a plain list item
18884 :checkbox on the checkbox in a plain list item
18885 :table in an org-mode table
18886 :table-special on a special filed in a table
18887 :table-table in a table.el table
18888 :link on a hyperlink
18889 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18890 :target on a <<target>>
18891 :radio-target on a <<<radio-target>>>
18892 :latex-fragment on a LaTeX fragment
18893 :latex-preview on a LaTeX fragment with overlayed preview image
18895 This function expects the position to be visible because it uses font-lock
18896 faces as a help to recognize the following contexts: :table-special, :link,
18897 and :keyword."
18898 (let* ((f (get-text-property (point) 'face))
18899 (faces (if (listp f) f (list f)))
18900 (p (point)) clist o)
18901 ;; First the large context
18902 (cond
18903 ((org-on-heading-p t)
18904 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18905 (when (progn
18906 (beginning-of-line 1)
18907 (looking-at org-todo-line-tags-regexp))
18908 (push (org-point-in-group p 1 :headline-stars) clist)
18909 (push (org-point-in-group p 2 :todo-keyword) clist)
18910 (push (org-point-in-group p 4 :tags) clist))
18911 (goto-char p)
18914 (push (org-point-in-group p 0 :priority) clist)))
18916 ((org-at-item-p)
18917 (push (org-point-in-group p 2 :item-bullet) clist)
18918 (push (list :item (point-at-bol)
18919 (save-excursion (org-end-of-item) (point)))
18920 clist)
18921 (and (org-at-item-checkbox-p)
18922 (push (org-point-in-group p 0 :checkbox) clist)))
18924 ((org-at-table-p)
18925 (push (list :table (org-table-begin) (org-table-end)) clist)
18926 (if (memq 'org-formula faces)
18927 (push (list :table-special
18928 (previous-single-property-change p 'face)
18929 (next-single-property-change p 'face)) clist)))
18930 ((org-at-table-p 'any)
18931 (push (list :table-table) clist)))
18932 (goto-char p)
18934 ;; Now the small context
18935 (cond
18936 ((org-at-timestamp-p)
18937 (push (org-point-in-group p 0 :timestamp) clist))
18938 ((memq 'org-link faces)
18939 (push (list :link
18940 (previous-single-property-change p 'face)
18941 (next-single-property-change p 'face)) clist))
18942 ((memq 'org-special-keyword faces)
18943 (push (list :keyword
18944 (previous-single-property-change p 'face)
18945 (next-single-property-change p 'face)) clist))
18946 ((org-on-target-p)
18947 (push (org-point-in-group p 0 :target) clist)
18948 (goto-char (1- (match-beginning 0)))
18949 (if (looking-at org-radio-target-regexp)
18950 (push (org-point-in-group p 0 :radio-target) clist))
18951 (goto-char p))
18952 ((setq o (car (delq nil
18953 (mapcar
18954 (lambda (x)
18955 (if (memq x org-latex-fragment-image-overlays) x))
18956 (overlays-at (point))))))
18957 (push (list :latex-fragment
18958 (overlay-start o) (overlay-end o)) clist)
18959 (push (list :latex-preview
18960 (overlay-start o) (overlay-end o)) clist))
18961 ((org-inside-LaTeX-fragment-p)
18962 ;; FIXME: positions wrong.
18963 (push (list :latex-fragment (point) (point)) clist)))
18965 (setq clist (nreverse (delq nil clist)))
18966 clist))
18968 ;; FIXME: Compare with at-regexp-p Do we need both?
18969 (defun org-in-regexp (re &optional nlines visually)
18970 "Check if point is inside a match of regexp.
18971 Normally only the current line is checked, but you can include NLINES extra
18972 lines both before and after point into the search.
18973 If VISUALLY is set, require that the cursor is not after the match but
18974 really on, so that the block visually is on the match."
18975 (catch 'exit
18976 (let ((pos (point))
18977 (eol (point-at-eol (+ 1 (or nlines 0))))
18978 (inc (if visually 1 0)))
18979 (save-excursion
18980 (beginning-of-line (- 1 (or nlines 0)))
18981 (while (re-search-forward re eol t)
18982 (if (and (<= (match-beginning 0) pos)
18983 (>= (+ inc (match-end 0)) pos))
18984 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18986 (defun org-at-regexp-p (regexp)
18987 "Is point inside a match of REGEXP in the current line?"
18988 (catch 'exit
18989 (save-excursion
18990 (let ((pos (point)) (end (point-at-eol)))
18991 (beginning-of-line 1)
18992 (while (re-search-forward regexp end t)
18993 (if (and (<= (match-beginning 0) pos)
18994 (>= (match-end 0) pos))
18995 (throw 'exit t)))
18996 nil))))
18998 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18999 "Return t if the current point is between matches of START-RE and END-RE.
19000 This will also return t if point is on one of the two matches or
19001 in an unfinished block. END-RE can be a string or a form
19002 returning a string.
19004 An optional third argument bounds the search for START-RE. It
19005 defaults to previous heading or `point-min'."
19006 (let ((pos (point))
19007 (limit (or bound (save-excursion (outline-previous-heading)))))
19008 (save-excursion
19009 ;; we're on a block when point is on start-re...
19010 (or (org-at-regexp-p start-re)
19011 ;; ... or start-re can be found above...
19012 (and (re-search-backward start-re limit t)
19013 ;; ... but no end-re between start-re and point.
19014 (not (re-search-forward (eval end-re) pos t)))))))
19016 (defun org-in-block-p (names)
19017 "Is point inside any block whose name belongs to NAMES?
19019 NAMES is a list of strings containing names of blocks."
19020 (save-match-data
19021 (catch 'exit
19022 (let ((case-fold-search t))
19023 (mapc (lambda (name)
19024 (let ((n (regexp-quote name)))
19025 (when (org-in-regexps-block-p
19028 (throw 'exit t))))
19029 names))
19030 nil)))
19032 (defun org-occur-in-agenda-files (regexp &optional nlines)
19033 "Call `multi-occur' with buffers for all agenda files."
19035 (let* ((files (org-agenda-files))
19036 (tnames (mapcar 'file-truename files))
19037 (extra org-agenda-text-search-extra-files)
19038 f)
19039 (when (eq (car extra) 'agenda-archives)
19040 (setq extra (cdr extra))
19041 (setq files (org-add-archive-files files)))
19042 (while (setq f (pop extra))
19043 (unless (member (file-truename f) tnames)
19044 (add-to-list 'files f 'append)
19045 (add-to-list 'tnames (file-truename f) 'append)))
19046 (multi-occur
19047 (mapcar (lambda (x)
19048 (with-current-buffer
19049 (or (get-file-buffer x) (find-file-noselect x))
19050 (widen)
19051 (current-buffer)))
19052 files)
19053 regexp)))
19055 (if (boundp 'occur-mode-find-occurrence-hook)
19056 ;; Emacs 23
19057 (add-hook 'occur-mode-find-occurrence-hook
19058 (lambda ()
19059 (when (org-mode-p)
19060 (org-reveal))))
19061 ;; Emacs 22
19062 (defadvice occur-mode-goto-occurrence
19063 (after org-occur-reveal activate)
19064 (and (org-mode-p) (org-reveal)))
19065 (defadvice occur-mode-goto-occurrence-other-window
19066 (after org-occur-reveal activate)
19067 (and (org-mode-p) (org-reveal)))
19068 (defadvice occur-mode-display-occurrence
19069 (after org-occur-reveal activate)
19070 (when (org-mode-p)
19071 (let ((pos (occur-mode-find-occurrence)))
19072 (with-current-buffer (marker-buffer pos)
19073 (save-excursion
19074 (goto-char pos)
19075 (org-reveal)))))))
19077 (defun org-occur-link-in-agenda-files ()
19078 "Create a link and search for it in the agendas.
19079 The link is not stored in `org-stored-links', it is just created
19080 for the search purpose."
19081 (interactive)
19082 (let ((link (condition-case nil
19083 (org-store-link nil)
19084 (error "Unable to create a link to here"))))
19085 (org-occur-in-agenda-files (regexp-quote link))))
19087 (defun org-uniquify (list)
19088 "Remove duplicate elements from LIST."
19089 (let (res)
19090 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19091 res))
19093 (defun org-delete-all (elts list)
19094 "Remove all elements in ELTS from LIST."
19095 (while elts
19096 (setq list (delete (pop elts) list)))
19097 list)
19099 (defun org-count (cl-item cl-seq)
19100 "Count the number of occurrences of ITEM in SEQ.
19101 Taken from `count' in cl-seq.el with all keyword arguments removed."
19102 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19103 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19104 (while (< cl-start cl-end)
19105 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19106 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19107 (setq cl-start (1+ cl-start)))
19108 cl-count))
19110 (defun org-remove-if (predicate seq)
19111 "Remove everything from SEQ that fulfills PREDICATE."
19112 (let (res e)
19113 (while seq
19114 (setq e (pop seq))
19115 (if (not (funcall predicate e)) (push e res)))
19116 (nreverse res)))
19118 (defun org-remove-if-not (predicate seq)
19119 "Remove everything from SEQ that does not fulfill PREDICATE."
19120 (let (res e)
19121 (while seq
19122 (setq e (pop seq))
19123 (if (funcall predicate e) (push e res)))
19124 (nreverse res)))
19126 (defun org-back-over-empty-lines ()
19127 "Move backwards over whitespace, to the beginning of the first empty line.
19128 Returns the number of empty lines passed."
19129 (let ((pos (point)))
19130 (if (cdr (assoc 'heading org-blank-before-new-entry))
19132 (forward-line -1))
19133 (beginning-of-line 2)
19134 (goto-char (min (point) pos))
19135 (count-lines (point) pos)))
19137 (defun org-skip-whitespace ()
19140 (defun org-point-in-group (point group &optional context)
19141 "Check if POINT is in match-group GROUP.
19142 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19143 match. If the match group does not exist or point is not inside it,
19144 return nil."
19145 (and (match-beginning group)
19146 (>= point (match-beginning group))
19147 (<= point (match-end group))
19148 (if context
19149 (list context (match-beginning group) (match-end group))
19150 t)))
19152 (defun org-switch-to-buffer-other-window (&rest args)
19153 "Switch to buffer in a second window on the current frame.
19154 In particular, do not allow pop-up frames.
19155 Returns the newly created buffer."
19156 (let (pop-up-frames special-display-buffer-names special-display-regexps
19157 special-display-function)
19158 (apply 'switch-to-buffer-other-window args)))
19160 (defun org-combine-plists (&rest plists)
19161 "Create a single property list from all plists in PLISTS.
19162 The process starts by copying the first list, and then setting properties
19163 from the other lists. Settings in the last list are the most significant
19164 ones and overrule settings in the other lists."
19165 (let ((rtn (copy-sequence (pop plists)))
19166 p v ls)
19167 (while plists
19168 (setq ls (pop plists))
19169 (while ls
19170 (setq p (pop ls) v (pop ls))
19171 (setq rtn (plist-put rtn p v))))
19172 rtn))
19174 (defun org-move-line-down (arg)
19175 "Move the current line down. With prefix argument, move it past ARG lines."
19176 (interactive "p")
19177 (let ((col (current-column))
19178 beg end pos)
19179 (beginning-of-line 1) (setq beg (point))
19180 (beginning-of-line 2) (setq end (point))
19181 (beginning-of-line (+ 1 arg))
19182 (setq pos (move-marker (make-marker) (point)))
19183 (insert (delete-and-extract-region beg end))
19184 (goto-char pos)
19185 (org-move-to-column col)))
19187 (defun org-move-line-up (arg)
19188 "Move the current line up. With prefix argument, move it past ARG lines."
19189 (interactive "p")
19190 (let ((col (current-column))
19191 beg end pos)
19192 (beginning-of-line 1) (setq beg (point))
19193 (beginning-of-line 2) (setq end (point))
19194 (beginning-of-line (- arg))
19195 (setq pos (move-marker (make-marker) (point)))
19196 (insert (delete-and-extract-region beg end))
19197 (goto-char pos)
19198 (org-move-to-column col)))
19200 (defun org-replace-escapes (string table)
19201 "Replace %-escapes in STRING with values in TABLE.
19203 The sequences in STRING may contain normal field width and padding information,
19205 so values can contain further %-escapes if they are define later in TABLE."
19206 (let ((tbl (copy-alist table))
19207 (case-fold-search nil)
19208 (pchg 0)
19209 e re rpl)
19210 (while (setq e (pop tbl))
19211 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19212 (when (and (cdr e) (string-match re (cdr e)))
19213 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19214 (safe "SREF"))
19215 (add-text-properties 0 3 (list 'sref sref) safe)
19216 (setcdr e (replace-match safe t t (cdr e)))))
19217 (while (string-match re string)
19218 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19219 (cdr e)))
19220 (setq string (replace-match rpl t t string))))
19221 (while (setq pchg (next-property-change pchg string))
19222 (let ((sref (get-text-property pchg 'sref string)))
19223 (when (and sref (string-match "SREF" string pchg))
19224 (setq string (replace-match sref t t string)))))
19225 string))
19227 (defun org-sublist (list start end)
19228 "Return a section of LIST, from START to END.
19229 Counting starts at 1."
19230 (let (rtn (c start))
19231 (setq list (nthcdr (1- start) list))
19232 (while (and list (<= c end))
19233 (push (pop list) rtn)
19234 (setq c (1+ c)))
19235 (nreverse rtn)))
19237 (defun org-find-base-buffer-visiting (file)
19238 "Like `find-buffer-visiting' but always return the base buffer and
19239 not an indirect buffer."
19240 (let ((buf (or (get-file-buffer file)
19241 (find-buffer-visiting file))))
19242 (if buf
19243 (or (buffer-base-buffer buf) buf)
19244 nil)))
19246 (defun org-image-file-name-regexp (&optional extensions)
19247 "Return regexp matching the file names of images.
19248 If EXTENSIONS is given, only match these."
19249 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19250 (image-file-name-regexp)
19251 (let ((image-file-name-extensions
19252 (or extensions
19253 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19254 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19256 (regexp-opt (nconc (mapcar 'upcase
19257 image-file-name-extensions)
19258 image-file-name-extensions)
19259 t)
19262 (defun org-file-image-p (file &optional extensions)
19263 "Return non-nil if FILE is an image."
19264 (save-match-data
19265 (string-match (org-image-file-name-regexp extensions) file)))
19267 (defun org-get-cursor-date ()
19268 "Return the date at cursor in as a time.
19269 This works in the calendar and in the agenda, anywhere else it just
19270 returns the current time."
19271 (let (date day defd)
19272 (cond
19273 ((eq major-mode 'calendar-mode)
19274 (setq date (calendar-cursor-to-date)
19275 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19276 ((eq major-mode 'org-agenda-mode)
19277 (setq day (get-text-property (point) 'day))
19278 (if day
19279 (setq date (calendar-gregorian-from-absolute day)
19280 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19281 (nth 2 date))))))
19282 (or defd (current-time))))
19284 (defvar org-agenda-action-marker (make-marker)
19285 "Marker pointing to the entry for the next agenda action.")
19287 (defun org-mark-entry-for-agenda-action ()
19288 "Mark the current entry as target of an agenda action.
19289 Agenda actions are actions executed from the agenda with the key `k',
19290 which make use of the date at the cursor."
19291 (interactive)
19292 (move-marker org-agenda-action-marker
19293 (save-excursion (org-back-to-heading t) (point))
19294 (current-buffer))
19295 (message
19296 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19298 (defun org-mark-subtree ()
19299 "Mark the current subtree.
19300 This puts point at the start of the current subtree, and mark at the end.
19302 If point is in an inline task, mark that task instead."
19303 (interactive)
19304 (let ((inline-task-p
19305 (and (featurep 'org-inlinetask)
19306 (org-inlinetask-in-task-p)))
19307 (beg))
19308 ;; Get beginning of subtree
19309 (cond
19310 (inline-task-p (org-inlinetask-goto-beginning))
19311 ((org-at-heading-p) (beginning-of-line))
19312 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19313 (setq beg (point))
19314 ;; Get end of it
19315 (if inline-task-p
19316 (org-inlinetask-goto-end)
19317 (org-end-of-subtree))
19318 ;; Mark zone
19319 (push-mark (point) nil t)
19320 (goto-char beg)))
19322 ;;; Paragraph filling stuff.
19323 ;; We want this to be just right, so use the full arsenal.
19325 (defun org-indent-line-function ()
19326 "Indent line depending on context."
19327 (interactive)
19328 (let* ((pos (point))
19329 (itemp (org-at-item-p))
19330 (case-fold-search t)
19332 (inline-task-p (and (featurep 'org-inlinetask)
19333 (org-inlinetask-in-task-p)))
19334 (inline-re (and inline-task-p
19335 (org-inlinetask-outline-regexp)))
19336 column)
19337 (beginning-of-line 1)
19338 (cond
19339 ;; Comments
19340 ((looking-at "# ") (setq column 0))
19341 ;; Headings
19342 ((looking-at org-outline-regexp) (setq column 0))
19343 ;; Included files
19345 ;; Footnote definition
19346 ((looking-at org-footnote-definition-re) (setq column 0))
19347 ;; Literal examples
19349 (setq column (org-get-indentation))) ; do nothing
19350 ;; Lists
19351 ((ignore-errors (goto-char (org-in-item-p)))
19352 (setq column (if itemp
19353 (org-get-indentation)
19354 (org-list-item-body-column (point))))
19355 (goto-char pos))
19356 ;; Drawers
19358 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19359 (save-excursion
19360 (goto-char (1- (match-beginning 1)))
19361 (setq column (current-column))))
19362 ;; Special blocks
19364 (save-excursion
19365 (re-search-backward
19367 (setq column (org-get-indentation (match-string 0))))
19370 (save-excursion
19372 (setq column
19373 (if (equal (downcase (match-string 1)) "src")
19374 ;; src blocks: let `org-edit-src-exit' handle them
19375 (org-get-indentation)
19376 (org-get-indentation (match-string 0)))))
19377 ;; This line has nothing special, look at the previous relevant
19378 ;; line to compute indentation
19379 (t
19380 (beginning-of-line 0)
19381 (while (and (not (bobp))
19382 (not (looking-at org-drawer-regexp))
19383 ;; When point started in an inline task, do not move
19384 ;; above task starting line.
19385 (not (and inline-task-p (looking-at inline-re)))
19386 ;; Skip drawers, blocks, empty lines, verbatim,
19387 ;; comments, tables, footnotes definitions, lists,
19388 ;; inline tasks.
19390 (re-search-backward org-drawer-regexp nil t))
19394 (looking-at org-footnote-definition-re)
19395 (and (ignore-errors (goto-char (org-in-item-p)))
19396 (goto-char
19397 (org-list-get-top-point (org-list-struct))))
19398 (and (not inline-task-p)
19399 (featurep 'org-inlinetask)
19400 (org-inlinetask-in-task-p)
19401 (or (org-inlinetask-goto-beginning) t))))
19402 (beginning-of-line 0))
19403 (cond
19404 ;; There was an heading above.
19406 (if (not org-adapt-indentation)
19407 (setq column 0)
19408 (goto-char (match-end 0))
19409 (setq column (current-column))))
19410 ;; A drawer had started and is unfinished
19411 ((looking-at org-drawer-regexp)
19412 (goto-char (1- (match-beginning 1)))
19413 (setq column (current-column)))
19414 ;; Else, nothing noticeable found: get indentation and go on.
19415 (t (setq column (org-get-indentation))))))
19416 ;; Now apply indentation and move cursor accordingly
19417 (goto-char pos)
19418 (if (<= (current-column) (current-indentation))
19419 (org-indent-line-to column)
19420 (save-excursion (org-indent-line-to column)))
19421 ;; Special polishing for properties, see `org-property-format'
19422 (setq column (current-column))
19423 (beginning-of-line 1)
19424 (if (looking-at
19426 (replace-match (concat (match-string 1)
19427 (format org-property-format
19428 (match-string 2) (match-string 3)))
19429 t t))
19430 (org-move-to-column column)))
19432 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19433 "Variable to store copy of `adaptive-fill-regexp'.
19434 Since `adaptive-fill-regexp' is set to never match, we need to
19435 store a backup of its value before entering `org-mode' so that
19436 the functionality can be provided as a fall-back.")
19438 (defun org-set-autofill-regexps ()
19439 (interactive)
19440 ;; In the paragraph separator we include headlines, because filling
19441 ;; text in a line directly attached to a headline would otherwise
19442 ;; fill the headline as well.
19445 ;; The paragraph starter includes hand-formatted lists.
19446 (org-set-local
19447 'paragraph-start
19448 (concat
19457 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19458 ;; But only if the user has not turned off tables or fixed-width regions
19459 (org-set-local
19460 'auto-fill-inhibit-regexp
19461 (concat org-outline-regexp
19464 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19465 (concat
19467 (if org-enable-table-editor "|" "")
19468 (if org-enable-fixed-width-editor ":" "")
19469 "]"))))
19470 ;; We use our own fill-paragraph function, to make sure that tables
19471 ;; and fixed-width regions are not wrapped. That function will pass
19472 ;; through to `fill-paragraph' when appropriate.
19473 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19474 ;; Prevent auto-fill from inserting unwanted new items.
19475 (org-set-local 'fill-nobreak-predicate
19476 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19477 fill-nobreak-predicate
19478 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19479 ;; Adaptive filling: To get full control, first make sure that
19480 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19481 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19482 (org-set-local 'org-adaptive-fill-regexp-backup
19483 adaptive-fill-regexp))
19485 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19486 (org-set-local 'adaptive-fill-function
19487 'org-adaptive-fill-function)
19488 (org-set-local
19489 'align-mode-rules-list
19490 '((org-in-buffer-settings
19492 (modes . '(org-mode))))))
19494 (defun org-fill-item-nobreak-p ()
19495 "Non-nil when a line break at point would insert a new item."
19496 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19498 (defun org-fill-paragraph (&optional justify)
19499 "Re-align a table, pass through to fill-paragraph if no table."
19500 (let ((table-p (org-at-table-p))
19501 (table.el-p (org-at-table.el-p))
19502 (itemp (org-in-item-p)))
19503 (cond ((and (equal (char-after (point-at-bol)) ?*)
19504 (save-excursion (goto-char (point-at-bol))
19505 (looking-at org-outline-regexp)))
19506 t) ; skip headlines
19507 (table.el-p t) ; skip table.el tables
19508 (table-p (org-table-align) t) ; align Org tables
19509 (itemp ; align text in items
19510 (let* ((struct (save-excursion (goto-char itemp)
19511 (org-list-struct)))
19512 (parents (org-list-parents-alist struct))
19513 (children (org-list-get-children itemp struct parents))
19514 beg end prev next prefix)
19515 ;; Determine in which part of item point is: before
19516 ;; first child, after last child, between two
19517 ;; sub-lists, or simply in item if there's no child.
19518 (cond
19519 ((not children)
19520 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19521 beg itemp
19522 end (org-list-get-item-end itemp struct)))
19523 ((< (point) (setq next (car children)))
19524 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19525 beg itemp
19526 end next))
19527 ((> (point) (setq prev (car (last children))))
19528 (setq beg (org-list-get-item-end prev struct)
19529 end (org-list-get-item-end itemp struct)
19530 prefix (save-excursion
19531 (goto-char beg)
19533 (make-string (current-column) ?\ ))))
19534 (t (catch 'exit
19535 (while (setq next (pop children))
19536 (if (> (point) next)
19537 (setq prev next)
19538 (setq beg (org-list-get-item-end prev struct)
19539 end next
19540 prefix (save-excursion
19541 (goto-char beg)
19543 (make-string (current-column) ?\ )))
19544 (throw 'exit nil))))))
19545 ;; Use `fill-paragraph' with buffer narrowed to item
19546 ;; without any child, and with our computed PREFIX.
19547 (flet ((fill-context-prefix (from to &optional flr) prefix))
19548 (save-restriction
19549 (narrow-to-region beg end)
19550 (save-excursion (fill-paragraph justify)))) t))
19551 ;; Special case where point is not in a list but is on
19552 ;; a paragraph adjacent to a list: make sure this paragraph
19553 ;; doesn't get merged with the end of the list by narrowing
19554 ;; buffer first.
19555 ((save-excursion (forward-paragraph -1)
19556 (setq itemp (org-in-item-p)))
19557 (let ((struct (save-excursion (goto-char itemp)
19558 (org-list-struct))))
19559 (save-restriction
19560 (narrow-to-region (org-list-get-bottom-point struct)
19561 (save-excursion (forward-paragraph 1)
19562 (point)))
19563 (fill-paragraph justify) t)))
19564 ;; Else simply call `fill-paragraph'.
19565 (t nil))))
19567 ;; For reference, this is the default value of adaptive-fill-regexp
19570 (defun org-adaptive-fill-function ()
19571 "Return a fill prefix for org-mode files."
19572 (let (itemp)
19573 (save-excursion
19574 (cond
19575 ;; Comment line
19577 (match-string-no-properties 0))
19578 ;; Plain list item
19579 ((org-at-item-p)
19580 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19581 ;; Point is in a list after `backward-paragraph': original
19582 ;; point wasn't in the list, or filling would have been taken
19583 ;; care of by `org-auto-fill-function', but the list and the
19584 ;; real paragraph are not separated by a blank line. Thus, move
19585 ;; point after the list to go back to real paragraph and
19586 ;; determine fill-prefix.
19587 ((setq itemp (org-in-item-p))
19588 (goto-char itemp)
19589 (let* ((struct (org-list-struct))
19590 (bottom (org-list-get-bottom-point struct)))
19591 (goto-char bottom)
19592 (make-string (org-get-indentation) ?\ )))
19593 ;; Other text
19594 ((looking-at org-adaptive-fill-regexp-backup)
19595 (match-string-no-properties 0))))))
19597 (defun org-auto-fill-function ()
19598 "Auto-fill function."
19599 (let (itemp prefix)
19600 ;; When in a list, compute an appropriate fill-prefix and make
19601 ;; sure it will be used by `do-auto-fill'.
19602 (if (setq itemp (org-in-item-p))
19603 (progn
19604 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19605 (flet ((fill-context-prefix (from to &optional flr) prefix))
19606 (do-auto-fill)))
19607 ;; Else just use `do-auto-fill'.
19608 (do-auto-fill))))
19610 ;;; Other stuff.
19612 (defun org-toggle-fixed-width-section (arg)
19613 "Toggle the fixed-width export.
19614 If there is no active region, the QUOTE keyword at the current headline is
19615 inserted or removed. When present, it causes the text between this headline
19616 and the next to be exported as fixed-width text, and unmodified.
19617 If there is an active region, this command adds or removes a colon as the
19618 first character of this line. If the first character of a line is a colon,
19619 this line is also exported in fixed-width font."
19620 (interactive "P")
19621 (let* ((cc 0)
19622 (regionp (org-region-active-p))
19623 (beg (if regionp (region-beginning) (point)))
19624 (end (if regionp (region-end)))
19625 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19626 (case-fold-search nil)
19628 off)
19629 (if regionp
19630 (save-excursion
19631 (goto-char beg)
19632 (setq cc (current-column))
19633 (beginning-of-line 1)
19634 (setq off (looking-at re))
19635 (while (> nlines 0)
19636 (setq nlines (1- nlines))
19637 (beginning-of-line 1)
19638 (cond
19639 (arg
19640 (org-move-to-column cc t)
19642 (forward-line -1))
19643 ((and off (looking-at re))
19644 (replace-match "" t t nil 1))
19645 ((not off) (org-move-to-column cc t) (insert ": ")))
19646 (forward-line 1)))
19647 (save-excursion
19648 (org-back-to-heading)
19649 (if (looking-at (concat org-outline-regexp
19651 (replace-match "" t t nil 1)
19652 (if (looking-at org-outline-regexp)
19653 (progn
19654 (goto-char (match-end 0))
19655 (insert org-quote-string " "))))))))
19657 (defun org-reftex-citation ()
19658 "Use reftex-citation to insert a citation into the buffer.
19659 This looks for a line like
19661 #+BIBLIOGRAPHY: foo plain option:-d
19663 and derives from it that foo.bib is the bibliography file relevant
19664 for this document. It then installs the necessary environment for RefTeX
19665 to work in this buffer and calls `reftex-citation' to insert a citation
19666 into the buffer.
19668 Export of such citations to both LaTeX and HTML is handled by the contributed
19669 package org-exp-bibtex by Taru Karttunen."
19670 (interactive)
19671 (let ((reftex-docstruct-symbol 'rds)
19673 rds bib)
19674 (save-excursion
19675 (save-restriction
19676 (widen)
19677 (let ((case-fold-search t)
19679 (if (not (save-excursion
19680 (or (re-search-forward re nil t)
19681 (re-search-backward re nil t))))
19682 (error "No bibliography defined in file")
19683 (setq bib (concat (match-string 1) ".bib")
19684 rds (list (list 'bib bib)))))))
19685 (call-interactively 'reftex-citation)))
19687 ;;;; Functions extending outline functionality
19689 (defun org-beginning-of-line (&optional arg)
19690 "Go to the beginning of the current line. If that is invisible, continue
19691 to a visible line beginning. This makes the function of C-a more intuitive.
19692 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19693 first attempt, and only move to after the tags when the cursor is already
19694 beyond the end of the headline."
19695 (interactive "P")
19696 (let ((pos (point))
19697 (special (if (consp org-special-ctrl-a/e)
19698 (car org-special-ctrl-a/e)
19699 org-special-ctrl-a/e))
19700 refpos)
19701 (if (org-bound-and-true-p line-move-visual)
19702 (beginning-of-visual-line 1)
19703 (beginning-of-line 1))
19704 (if (and arg (fboundp 'move-beginning-of-line))
19705 (call-interactively 'move-beginning-of-line)
19706 (if (bobp)
19707 nil
19708 (backward-char 1)
19709 (if (org-truely-invisible-p)
19710 (while (and (not (bobp)) (org-truely-invisible-p))
19711 (backward-char 1)
19712 (beginning-of-line 1))
19713 (forward-char 1))))
19714 (when special
19715 (cond
19716 ((and (looking-at org-complex-heading-regexp)
19717 (= (char-after (match-end 1)) ?\ ))
19718 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19719 (point-at-eol)))
19720 (goto-char
19721 (if (eq special t)
19722 (cond ((> pos refpos) refpos)
19723 ((= pos (point)) refpos)
19724 (t (point)))
19725 (cond ((> pos (point)) (point))
19726 ((not (eq last-command this-command)) (point))
19727 (t refpos)))))
19728 ((org-at-item-p)
19729 (goto-char
19730 (if (eq special t)
19731 (cond ((> pos (match-end 0)) (match-end 0))
19732 ((= pos (point)) (match-end 0))
19733 (t (point)))
19734 (cond ((> pos (point)) (point))
19735 ((not (eq last-command this-command)) (point))
19736 (t (match-end 0))))))))
19737 (org-no-warnings
19738 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19740 (defun org-end-of-line (&optional arg)
19741 "Go to the end of the line.
19742 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19743 first attempt, and only move to after the tags when the cursor is already
19744 beyond the end of the headline."
19745 (interactive "P")
19746 (let ((special (if (consp org-special-ctrl-a/e)
19747 (cdr org-special-ctrl-a/e)
19748 org-special-ctrl-a/e)))
19749 (if (or (not special)
19750 (not (org-on-heading-p))
19751 arg)
19752 (call-interactively
19753 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19754 ((fboundp 'move-end-of-line) 'move-end-of-line)
19755 (t 'end-of-line)))
19756 (let ((pos (point)))
19757 (beginning-of-line 1)
19759 (if (eq special t)
19760 (if (or (< pos (match-beginning 1))
19761 (= pos (match-end 0)))
19762 (goto-char (match-beginning 1))
19763 (goto-char (match-end 0)))
19764 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19765 (goto-char (match-end 0))
19766 (goto-char (match-beginning 1))))
19767 (call-interactively (if (fboundp 'move-end-of-line)
19768 'move-end-of-line
19769 'end-of-line)))))
19770 (org-no-warnings
19771 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19773 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19774 (define-key org-mode-map "\C-e" 'org-end-of-line)
19776 (defun org-backward-sentence (&optional arg)
19777 "Go to beginning of sentence, or beginning of table field.
19778 This will call `backward-sentence' or `org-table-beginning-of-field',
19779 depending on context."
19780 (interactive "P")
19781 (cond
19782 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19783 (t (call-interactively 'backward-sentence))))
19785 (defun org-forward-sentence (&optional arg)
19786 "Go to end of sentence, or end of table field.
19787 This will call `forward-sentence' or `org-table-end-of-field',
19788 depending on context."
19789 (interactive "P")
19790 (cond
19791 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19792 (t (call-interactively 'forward-sentence))))
19794 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19795 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19797 (defun org-kill-line (&optional arg)
19798 "Kill line, to tags or end of line."
19799 (interactive "P")
19800 (cond
19801 ((or (not org-special-ctrl-k)
19802 (bolp)
19803 (not (org-on-heading-p)))
19804 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19805 org-ctrl-k-protect-subtree)
19806 (if (or (eq org-ctrl-k-protect-subtree 'error)
19807 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19808 (error "C-k aborted - would kill hidden subtree")))
19809 (call-interactively 'kill-line))
19811 (kill-region (point) (match-beginning 1))
19812 (org-set-tags nil t))
19813 (t (kill-region (point) (point-at-eol)))))
19815 (define-key org-mode-map "\C-k" 'org-kill-line)
19817 (defun org-yank (&optional arg)
19818 "Yank. If the kill is a subtree, treat it specially.
19819 This command will look at the current kill and check if is a single
19820 subtree, or a series of subtrees[1]. If it passes the test, and if the
19821 cursor is at the beginning of a line or after the stars of a currently
19822 empty headline, then the yank is handled specially. How exactly depends
19823 on the value of the following variables, both set by default.
19825 org-yank-folded-subtrees
19826 When set, the subtree(s) will be folded after insertion, but only
19827 if doing so would now swallow text after the yanked text.
19829 org-yank-adjusted-subtrees
19830 When set, the subtree will be promoted or demoted in order to
19831 fit into the local outline tree structure, which means that the level
19832 will be adjusted so that it becomes the smaller one of the two
19833 *visible* surrounding headings.
19835 Any prefix to this command will cause `yank' to be called directly with
19837 will just
19838 plainly yank the text as it is.
19840 \[1] The test checks if the first non-white line is a heading
19841 and if there are no other headings with fewer stars."
19842 (interactive "P")
19843 (org-yank-generic 'yank arg))
19845 (defun org-yank-generic (command arg)
19846 "Perform some yank-like command.
19848 This function implements the behavior described in the `org-yank'
19849 documentation. However, it has been generalized to work for any
19850 interactive command with similar behavior."
19852 ;; pretend to be command COMMAND
19853 (setq this-command command)
19855 (if arg
19856 (call-interactively command)
19858 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19859 (and (org-kill-is-subtree-p)
19860 (or (bolp)
19862 (string-match
19864 (buffer-substring (point-at-bol) (point)))))))
19865 swallowp)
19866 (cond
19867 ((and subtreep org-yank-folded-subtrees)
19868 (let ((beg (point))
19869 end)
19870 (if (and subtreep org-yank-adjusted-subtrees)
19871 (org-paste-subtree nil nil 'for-yank)
19872 (call-interactively command))
19874 (setq end (point))
19875 (goto-char beg)
19876 (when (and (bolp) subtreep
19877 (not (setq swallowp
19878 (org-yank-folding-would-swallow-text beg end))))
19879 (org-with-limited-levels
19880 (or (looking-at org-outline-regexp)
19881 (re-search-forward org-outline-regexp-bol end t))
19882 (while (and (< (point) end) (looking-at org-outline-regexp))
19883 (hide-subtree)
19884 (org-cycle-show-empty-lines 'folded)
19885 (condition-case nil
19886 (outline-forward-same-level 1)
19887 (error (goto-char end))))))
19888 (when swallowp
19889 (message
19890 "Inserted text not folded because that would swallow text"))
19892 (goto-char end)
19894 (beginning-of-line 1)
19895 (push-mark beg 'nomsg)))
19896 ((and subtreep org-yank-adjusted-subtrees)
19897 (let ((beg (point-at-bol)))
19898 (org-paste-subtree nil nil 'for-yank)
19899 (push-mark beg 'nomsg)))
19900 (t
19901 (call-interactively command))))))
19903 (defun org-yank-folding-would-swallow-text (beg end)
19904 "Would hide-subtree at BEG swallow any text after END?"
19905 (let (level)
19906 (org-with-limited-levels
19907 (save-excursion
19908 (goto-char beg)
19909 (when (or (looking-at org-outline-regexp)
19910 (re-search-forward org-outline-regexp-bol end t))
19911 (setq level (org-outline-level)))
19912 (goto-char end)
19914 (if (or (eobp)
19915 (and (bolp) (looking-at org-outline-regexp)
19916 (<= (org-outline-level) level)))
19917 nil ; Nothing would be swallowed
19918 t))))) ; something would swallow
19920 (define-key org-mode-map "\C-y" 'org-yank)
19922 (defun org-truely-invisible-p ()
19923 "Check if point is at a character currently not visible.
19924 This version does not only check the character property, but also
19925 `visible-mode'."
19926 ;; Early versions of noutline don't have `outline-invisible-p'.
19927 (if (org-bound-and-true-p visible-mode)
19928 nil
19929 (outline-invisible-p)))
19931 (defun org-invisible-p2 ()
19932 "Check if point is at a character currently not visible."
19933 (save-excursion
19934 (if (and (eolp) (not (bobp))) (backward-char 1))
19935 ;; Early versions of noutline don't have `outline-invisible-p'.
19936 (outline-invisible-p)))
19938 (defun org-back-to-heading (&optional invisible-ok)
19939 "Call `outline-back-to-heading', but provide a better error message."
19940 (condition-case nil
19941 (outline-back-to-heading invisible-ok)
19942 (error (error "Before first headline at position %d in buffer %s"
19943 (point) (current-buffer)))))
19945 (defun org-beginning-of-defun ()
19946 "Go to the beginning of the subtree, i.e. back to the heading."
19947 (org-back-to-heading))
19948 (defun org-end-of-defun ()
19949 "Go to the end of the subtree."
19950 (org-end-of-subtree nil t))
19952 (defun org-before-first-heading-p ()
19953 "Before first heading?"
19954 (save-excursion
19955 (end-of-line)
19956 (null (re-search-backward org-outline-regexp-bol nil t))))
19958 (defun org-on-heading-p (&optional ignored)
19959 (outline-on-heading-p t))
19960 (defun org-at-heading-p (&optional ignored)
19961 (outline-on-heading-p t))
19963 (defun org-point-at-end-of-empty-headline ()
19964 "If point is at the end of an empty headline, return t, else nil.
19965 If the heading only contains a TODO keyword, it is still still considered
19966 empty."
19968 (save-excursion
19969 (beginning-of-line 1)
19970 (let ((case-fold-search nil))
19973 (defun org-at-heading-or-item-p ()
19974 (or (org-on-heading-p) (org-at-item-p)))
19976 (defun org-on-target-p ()
19977 (or (org-in-regexp org-radio-target-regexp)
19978 (org-in-regexp org-target-regexp)))
19980 (defun org-up-heading-all (arg)
19981 "Move to the heading line of which the present line is a subheading.
19982 This function considers both visible and invisible heading lines.
19983 With argument, move up ARG levels."
19984 (if (fboundp 'outline-up-heading-all)
19985 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19986 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19988 (defun org-up-heading-safe ()
19989 "Move to the heading line of which the present line is a subheading.
19990 This version will not throw an error. It will return the level of the
19991 headline found, or nil if no higher level is found.
19993 Also, this function will be a lot faster than `outline-up-heading',
19994 because it relies on stars being the outline starters. This can really
19995 make a significant difference in outlines with very many siblings."
19996 (let (start-level re)
19997 (org-back-to-heading t)
19998 (setq start-level (funcall outline-level))
19999 (if (equal start-level 1)
20000 nil
20002 (if (re-search-backward re nil t)
20003 (funcall outline-level)))))
20005 (defun org-first-sibling-p ()
20006 "Is this heading the first child of its parents?"
20007 (interactive)
20008 (let ((re org-outline-regexp-bol)
20009 level l)
20010 (unless (org-at-heading-p t)
20011 (error "Not at a heading"))
20012 (setq level (funcall outline-level))
20013 (save-excursion
20014 (if (not (re-search-backward re nil t))
20015 t
20016 (setq l (funcall outline-level))
20017 (< l level)))))
20019 (defun org-goto-sibling (&optional previous)
20020 "Goto the next sibling, even if it is invisible.
20021 When PREVIOUS is set, go to the previous sibling instead. Returns t
20022 when a sibling was found. When none is found, return nil and don't
20023 move point."
20024 (let ((fun (if previous 're-search-backward 're-search-forward))
20025 (pos (point))
20026 (re org-outline-regexp-bol)
20027 level l)
20028 (when (condition-case nil (org-back-to-heading t) (error nil))
20029 (setq level (funcall outline-level))
20030 (catch 'exit
20031 (or previous (forward-char 1))
20032 (while (funcall fun re nil t)
20033 (setq l (funcall outline-level))
20034 (when (< l level) (goto-char pos) (throw 'exit nil))
20035 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20036 (goto-char pos)
20037 nil))))
20039 (defun org-show-siblings ()
20040 "Show all siblings of the current headline."
20041 (save-excursion
20042 (while (org-goto-sibling) (org-flag-heading nil)))
20043 (save-excursion
20044 (while (org-goto-sibling 'previous)
20045 (org-flag-heading nil))))
20047 (defun org-goto-first-child ()
20048 "Goto the first child, even if it is invisible.
20049 Return t when a child was found. Otherwise don't move point and
20050 return nil."
20051 (let (level (pos (point)) (re org-outline-regexp-bol))
20052 (when (condition-case nil (org-back-to-heading t) (error nil))
20053 (setq level (outline-level))
20054 (forward-char 1)
20055 (if (and (re-search-forward re nil t) (> (outline-level) level))
20056 (progn (goto-char (match-beginning 0)) t)
20057 (goto-char pos) nil))))
20059 (defun org-show-hidden-entry ()
20060 "Show an entry where even the heading is hidden."
20061 (save-excursion
20062 (org-show-entry)))
20064 (defun org-flag-heading (flag &optional entry)
20065 "Flag the current heading. FLAG non-nil means make invisible.
20066 When ENTRY is non-nil, show the entire entry."
20067 (save-excursion
20068 (org-back-to-heading t)
20069 ;; Check if we should show the entire entry
20070 (if entry
20071 (progn
20072 (org-show-entry)
20073 (save-excursion
20074 (and (outline-next-heading)
20075 (org-flag-heading nil))))
20076 (outline-flag-region (max (point-min) (1- (point)))
20077 (save-excursion (outline-end-of-heading) (point))
20078 flag))))
20080 (defun org-get-next-sibling ()
20081 "Move to next heading of the same level, and return point.
20082 If there is no such heading, return nil.
20083 This is like outline-next-sibling, but invisible headings are ok."
20084 (let ((level (funcall outline-level)))
20085 (outline-next-heading)
20086 (while (and (not (eobp)) (> (funcall outline-level) level))
20087 (outline-next-heading))
20088 (if (or (eobp) (< (funcall outline-level) level))
20089 nil
20090 (point))))
20092 (defun org-get-last-sibling ()
20093 "Move to previous heading of the same level, and return point.
20094 If there is no such heading, return nil."
20095 (let ((opoint (point))
20096 (level (funcall outline-level)))
20097 (outline-previous-heading)
20098 (when (and (/= (point) opoint) (outline-on-heading-p t))
20099 (while (and (> (funcall outline-level) level)
20100 (not (bobp)))
20101 (outline-previous-heading))
20102 (if (< (funcall outline-level) level)
20103 nil
20104 (point)))))
20106 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20107 ;; This contains an exact copy of the original function, but it uses
20108 ;; `org-back-to-heading', to make it work also in invisible
20109 ;; trees. And is uses an invisible-OK argument.
20110 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20111 ;; Furthermore, when used inside Org, finding the end of a large subtree
20112 ;; with many children and grandchildren etc, this can be much faster
20113 ;; than the outline version.
20114 (org-back-to-heading invisible-OK)
20115 (let ((first t)
20116 (level (funcall outline-level)))
20117 (if (and (org-mode-p) (< level 1000))
20118 ;; A true heading (not a plain list item), in Org-mode
20119 ;; This means we can easily find the end by looking
20120 ;; only for the right number of stars. Using a regexp to do
20121 ;; this is so much faster than using a Lisp loop.
20123 (forward-char 1)
20124 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20125 ;; something else, do it the slow way
20126 (while (and (not (eobp))
20127 (or first (> (funcall outline-level) level)))
20128 (setq first nil)
20129 (outline-next-heading)))
20130 (unless to-heading
20132 (progn
20133 ;; Go to end of line before heading
20134 (forward-char -1)
20136 ;; leave blank line before heading
20137 (forward-char -1))))))
20138 (point))
20140 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20141 "Use Org version in org-mode, for dramatic speed-up."
20142 (if (org-mode-p)
20143 (progn
20144 (org-end-of-subtree nil t)
20145 (unless (eobp) (backward-char 1)))
20146 ad-do-it))
20148 (defun org-end-of-meta-data-and-drawers ()
20149 "Jump to the first text after meta data and drawers in the current entry.
20150 This will move over empty lines, lines with planning time stamps,
20151 clocking lines, and drawers."
20152 (org-back-to-heading t)
20153 (let ((end (save-excursion (outline-next-heading) (point)))
20156 (forward-line 1)
20157 (while (re-search-forward re end t)
20158 (if (not (match-end 1))
20159 ;; empty or planning line
20160 (forward-line 1)
20161 ;; a drawer, find the end
20163 (forward-line 1)))
20165 (point)))
20167 (defun org-forward-same-level (arg &optional invisible-ok)
20168 "Move forward to the arg'th subheading at same level as this one.
20169 Stop at the first and last subheadings of a superior heading.
20170 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20171 it wil also look at invisible ones."
20172 (interactive "p")
20173 (org-back-to-heading invisible-ok)
20174 (org-on-heading-p)
20175 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20177 l)
20178 (forward-char 1)
20179 (while (> arg 0)
20180 (while (and (re-search-forward re nil 'move)
20181 (setq l (- (match-end 0) (match-beginning 0) 1))
20182 (= l level)
20183 (not invisible-ok)
20184 (progn (backward-char 1) (outline-invisible-p)))
20185 (if (< l level) (setq arg 1)))
20186 (setq arg (1- arg)))
20187 (beginning-of-line 1)))
20189 (defun org-backward-same-level (arg &optional invisible-ok)
20190 "Move backward to the arg'th subheading at same level as this one.
20191 Stop at the first and last subheadings of a superior heading."
20192 (interactive "p")
20193 (org-back-to-heading)
20194 (org-on-heading-p)
20195 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20197 l)
20198 (while (> arg 0)
20199 (while (and (re-search-backward re nil 'move)
20200 (setq l (- (match-end 0) (match-beginning 0) 1))
20201 (= l level)
20202 (not invisible-ok)
20203 (outline-invisible-p))
20204 (if (< l level) (setq arg 1)))
20205 (setq arg (1- arg)))))
20207 (defun org-show-subtree ()
20208 "Show everything after this heading at deeper levels."
20209 (outline-flag-region
20210 (point)
20211 (save-excursion
20212 (org-end-of-subtree t t))
20213 nil))
20215 (defun org-show-entry ()
20216 "Show the body directly following this heading.
20217 Show the heading too, if it is currently invisible."
20218 (interactive)
20219 (save-excursion
20220 (condition-case nil
20221 (progn
20222 (org-back-to-heading t)
20223 (outline-flag-region
20224 (max (point-min) (1- (point)))
20225 (save-excursion
20226 (if (re-search-forward
20228 (match-beginning 1)
20229 (point-max)))
20230 nil)
20231 (org-cycle-hide-drawers 'children))
20232 (error nil))))
20234 (defun org-make-options-regexp (kwds &optional extra)
20235 "Make a regular expression for keyword lines."
20236 (concat
20237 "^"
20244 ;; Make isearch reveal the necessary context
20245 (defun org-isearch-end ()
20246 "Reveal context after isearch exits."
20247 (when isearch-success ; only if search was successful
20248 (if (featurep 'xemacs)
20249 ;; Under XEmacs, the hook is run in the correct place,
20250 ;; we directly show the context.
20251 (org-show-context 'isearch)
20252 ;; In Emacs the hook runs *before* restoring the overlays.
20253 ;; So we have to use a one-time post-command-hook to do this.
20254 ;; (Emacs 22 has a special variable, see function `org-mode')
20255 (unless (and (boundp 'isearch-mode-end-hook-quit)
20256 isearch-mode-end-hook-quit)
20257 ;; Only when the isearch was not quitted.
20258 (org-add-hook 'post-command-hook 'org-isearch-post-command
20259 'append 'local)))))
20261 (defun org-isearch-post-command ()
20262 "Remove self from hook, and show context."
20263 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20264 (org-show-context 'isearch))
20267 ;;;; Integration with and fixes for other packages
20269 ;;; Imenu support
20271 (defvar org-imenu-markers nil
20272 "All markers currently used by Imenu.")
20273 (make-variable-buffer-local 'org-imenu-markers)
20275 (defun org-imenu-new-marker (&optional pos)
20276 "Return a new marker for use by Imenu, and remember the marker."
20277 (let ((m (make-marker)))
20278 (move-marker m (or pos (point)))
20279 (push m org-imenu-markers)
20280 m))
20282 (defun org-imenu-get-tree ()
20283 "Produce the index for Imenu."
20284 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20285 (setq org-imenu-markers nil)
20286 (let* ((n org-imenu-depth)
20287 (re (concat "^" (org-get-limited-outline-regexp)))
20288 (subs (make-vector (1+ n) nil))
20289 (last-level 0)
20290 m level head)
20291 (save-excursion
20292 (save-restriction
20293 (widen)
20294 (goto-char (point-max))
20295 (while (re-search-backward re nil t)
20296 (setq level (org-reduced-level (funcall outline-level)))
20297 (when (<= level n)
20298 (looking-at org-complex-heading-regexp)
20299 (setq head (org-link-display-format
20300 (org-match-string-no-properties 4))
20301 m (org-imenu-new-marker))
20302 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20303 (if (>= level last-level)
20304 (push (cons head m) (aref subs level))
20305 (push (cons head (aref subs (1+ level))) (aref subs level))
20306 (loop for i from (1+ level) to n do (aset subs i nil)))
20307 (setq last-level level)))))
20308 (aref subs 1)))
20310 (eval-after-load "imenu"
20311 '(progn
20312 (add-hook 'imenu-after-jump-hook
20313 (lambda ()
20314 (if (org-mode-p)
20315 (org-show-context 'org-goto))))))
20317 (defun org-link-display-format (link)
20318 "Replace a link with either the description, or the link target
20319 if no description is present"
20320 (save-match-data
20321 (if (string-match org-bracket-link-analytic-regexp link)
20322 (replace-match (if (match-end 5)
20323 (match-string 5 link)
20324 (concat (match-string 1 link)
20325 (match-string 3 link)))
20326 nil t link)
20327 link)))
20329 ;; Speedbar support
20331 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20332 "Overlay marking the agenda restriction line in speedbar.")
20333 (overlay-put org-speedbar-restriction-lock-overlay
20334 'face 'org-agenda-restriction-lock)
20335 (overlay-put org-speedbar-restriction-lock-overlay
20336 'help-echo "Agendas are currently limited to this item.")
20337 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20339 (defun org-speedbar-set-agenda-restriction ()
20340 "Restrict future agenda commands to the location at point in speedbar.
20342 (interactive)
20343 (require 'org-agenda)
20344 (let (p m tp np dir txt)
20345 (cond
20346 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20347 'org-imenu t))
20348 (setq m (get-text-property p 'org-imenu-marker))
20349 (with-current-buffer (marker-buffer m)
20350 (goto-char m)
20351 (org-agenda-set-restriction-lock 'subtree)))
20352 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20353 'speedbar-function 'speedbar-find-file))
20354 (setq tp (previous-single-property-change
20355 (1+ p) 'speedbar-function)
20356 np (next-single-property-change
20357 tp 'speedbar-function)
20358 dir (speedbar-line-directory)
20359 txt (buffer-substring-no-properties (or tp (point-min))
20360 (or np (point-max))))
20361 (with-current-buffer (find-file-noselect
20362 (let ((default-directory dir))
20363 (expand-file-name txt)))
20364 (unless (org-mode-p)
20365 (error "Cannot restrict to non-Org-mode file"))
20366 (org-agenda-set-restriction-lock 'file)))
20367 (t (error "Don't know how to restrict Org-mode's agenda")))
20368 (move-overlay org-speedbar-restriction-lock-overlay
20369 (point-at-bol) (point-at-eol))
20370 (setq current-prefix-arg nil)
20371 (org-agenda-maybe-redo)))
20373 (eval-after-load "speedbar"
20374 '(progn
20375 (speedbar-add-supported-extension ".org")
20376 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20377 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20378 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20379 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20380 (add-hook 'speedbar-visiting-tag-hook
20381 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20383 ;;; Fixes and Hacks for problems with other packages
20385 ;; Make flyspell not check words in links, to not mess up our keymap
20386 (defun org-mode-flyspell-verify ()
20387 "Don't let flyspell put overlays at active buttons, or on
20388 {todo,all-time,additional-option-like}-keywords."
20389 (let ((pos (max (1- (point)) (point-min)))
20390 (word (thing-at-point 'word)))
20391 (and (not (get-text-property pos 'keymap))
20392 (not (get-text-property pos 'org-no-flyspell))
20393 (not (member word org-todo-keywords-1))
20394 (not (member word org-all-time-keywords))
20395 (not (member word org-additional-option-like-keywords)))))
20397 (defun org-remove-flyspell-overlays-in (beg end)
20398 "Remove flyspell overlays in region."
20399 (and (org-bound-and-true-p flyspell-mode)
20400 (fboundp 'flyspell-delete-region-overlays)
20401 (flyspell-delete-region-overlays beg end))
20402 (add-text-properties beg end '(org-no-flyspell t)))
20404 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20405 (eval-after-load "bookmark"
20406 '(if (boundp 'bookmark-after-jump-hook)
20407 ;; We can use the hook
20408 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20409 ;; Hook not available, use advice
20410 (defadvice bookmark-jump (after org-make-visible activate)
20411 "Make the position visible."
20412 (org-bookmark-jump-unhide))))
20414 ;; Make sure saveplace shows the location if it was hidden
20415 (eval-after-load "saveplace"
20416 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20417 "Make the position visible."
20418 (org-bookmark-jump-unhide)))
20420 ;; Make sure ecb shows the location if it was hidden
20421 (eval-after-load "ecb"
20422 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20423 "Make hierarchy visible when jumping into location from ECB tree buffer."
20424 (if (org-mode-p)
20425 (org-show-context))))
20427 (defun org-bookmark-jump-unhide ()
20428 "Unhide the current position, to show the bookmark location."
20429 (and (org-mode-p)
20430 (or (outline-invisible-p)
20431 (save-excursion (goto-char (max (point-min) (1- (point))))
20432 (outline-invisible-p)))
20433 (org-show-context 'bookmark-jump)))
20435 ;; Make session.el ignore our circular variable
20436 (eval-after-load "session"
20437 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20439 ;;;; Experimental code
20441 (defun org-closed-in-range ()
20442 "Sparse tree of items closed in a certain time range.
20443 Still experimental, may disappear in the future."
20444 (interactive)
20445 ;; Get the time interval from the user.
20446 (let* ((time1 (org-float-time
20447 (org-read-date nil 'to-time nil "Starting date: ")))
20448 (time2 (org-float-time
20449 (org-read-date nil 'to-time nil "End date:")))
20450 ;; callback function
20451 (callback (lambda ()
20452 (let ((time
20453 (org-float-time
20454 (apply 'encode-time
20455 (org-parse-time-string
20456 (match-string 1))))))
20457 ;; check if time in interval
20458 (and (>= time time1) (<= time time2))))))
20459 ;; make tree, check each match with the callback
20462 ;;;; Finish up
20464 (provide 'org)
20466 (run-hooks 'org-load-hook)
20468 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20470 ;;; org.el ends here