| blob | 9df6839edd949ee59169d27749da7b54d4da3fe8 |
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.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
114 ;; babel
123 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
155 :key-type
192 ;;;; Customization variables
194 "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
197 identifier."
201 ;;; Version
207 "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
234 ;;; Compatibility constants
236 ;;; The custom variables
239 "Outline-based notes management and organizer."
245 "Mode hook for Org-mode, run after the mode was turned on."
250 "Hook that is run after org.el has been loaded."
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 "List of TODO entry keyword sequences and their interpretation.
1988 Each sequence starts with a symbol, either `sequence' or `type',
1989 indicating if the keywords should be interpreted as a sequence of
1990 action steps, or as different types of TODO items. The first
1991 keywords are states requiring action - these states will select a headline
1992 for inclusion into the global TODO list Org-mode produces. If one of
1995 the last keyword is treated as the only DONE state of the sequence.
1998 additional state where no keyword is present. For details about this
1999 cycling, see the manual.
2001 TODO keywords and interpretation can also be set on a per-file basis with
2002 the special #+SEQ_TODO and #+TYP_TODO lines.
2004 Each keyword can optionally specify a character for fast state selection
2005 \(in combination with the variable `org-use-fast-todo-selection')
2006 and specifiers for state change logging, using the same syntax
2009 indicates to record a time stamp each time this state is selected.
2011 Each keyword may also specify if a timestamp or a note should be
2012 recorded when entering or leaving the state, by adding additional
2013 characters in the parenthesis after the keyword. This looks like this:
2015 record only the time of the state change. With X and Y being either
2017 Y when leaving the state if and only if the *target* state does not
2018 define X. You may omit any of the fast-selection key or X or /Y,
2019 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2021 For backward compatibility, this variable may also be just a list
2022 of keywords - in this case the interpretation (sequence or type) will be
2023 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2033 ;;Quick and dirty way to see
2034 ;;`org-todo-interpretations'. This takes the
2035 ;;place of item arguments
2036 :convert-widget
2043 org-todo-interpretation-widgets))
2044 widget))
2075 "Controls how TODO keywords are interpreted.
2076 This variable is in principle obsolete and is only used for
2077 backward compatibility, if the interpretation of todo keywords is
2078 not given already in `org-todo-keywords'. See that variable for
2079 more information."
2086 "Non-nil means use the fast todo selection scheme with C-c C-t.
2087 This variable describes if and under what circumstances the cycling
2088 mechanism for TODO keywords will be replaced by a single-key, direct
2089 selection scheme.
2091 When nil, fast selection is never used.
2093 When the symbol `prefix', it will be used when `org-todo' is called with
2094 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2095 in an agenda buffer.
2097 When t, fast selection is used by default. In this case, the prefix
2098 argument forces cycling instead.
2100 In all cases, the special interface is only used if access keys have actually
2101 been assigned by the user, i.e. if keywords in the configuration are followed
2102 by a letter in parenthesis, like TODO(t)."
2110 "Non-nil means update todo statistics after insert and toggle.
2111 ALL-HEADLINES means update todo statistics by including headlines
2112 with no TODO keyword as well, counting them as not done.
2113 A list of TODO keywords means the same, but skip keywords that are
2114 not in this list.
2116 When this is set, todo statistics is updated in the parent of the
2117 current entry each time a todo state is changed."
2127 "Non-nil means TODO statistics covers just direct children.
2128 When nil, all entries in the subtree are considered.
2129 This has only an effect if `org-provide-todo-statistics' is set.
2130 To set this to nil for only a single subtree, use a COOKIE_DATA
2136 "Hook which is run after the state of a TODO item was changed.
2137 The new state (a string with a TODO keyword, or nil) is available in the
2138 Lisp variable `state'."
2143 "Hook for functions that are allowed to block a state change.
2145 Each function gets as its single argument a property list, see
2146 `org-trigger-hook' for more information about this list.
2148 If any of the functions in this hook returns nil, the state change
2152 "Hook for functions that are triggered by a state change.
2154 Each function gets as its single argument a property list with at least
2155 the following elements:
2157 (:type type-of-change :position pos-at-entry-start
2158 :from old-state :to new-state)
2160 Depending on the type, more properties may be present.
2162 This mechanism is currently implemented for:
2164 TODO state changes
2165 ------------------
2166 :type todo-state-change
2167 :from previous state (keyword as a string), or nil, or a symbol
2168 'todo' or 'done', to indicate the general type of state.
2172 "Non-nil means undone TODO entries will block switching the parent to DONE.
2173 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2174 be blocked if any prior sibling is not yet done.
2175 Finally, if the parent is blocked because of ordered siblings of its own,
2176 the child will also be blocked.
2177 This variable needs to be set before org.el is loaded, and you need to
2178 restart Emacs after a change to make the change effective. The only way
2179 to change is while Emacs is running is through the customize interface."
2191 "Non-nil means unchecked boxes will block switching the parent to DONE.
2192 When this is nil, checkboxes have no influence on switching TODO states.
2193 When non-nil, you first need to check off all check boxes before the TODO
2194 entry can be switched to DONE.
2195 This variable needs to be set before org.el is loaded, and you need to
2196 restart Emacs after a change to make the change effective. The only way
2197 to change is while Emacs is running is through the customize interface."
2209 "Non-nil means inserting a TODO heading is treated as state change.
2211 logging will apply if appropriate. When nil, the new TODO item will
2212 be inserted directly, and no logging will take place."
2217 "Non-nil means switching TODO states with S-cursor counts as state change.
2218 This is the default behavior. However, setting this to nil allows a
2219 convenient way to select a TODO state and bypass any logging associated
2220 with that."
2225 "Tag changes that should be triggered by TODO state changes.
2226 This is a list. Each entry is
2228 (state-change (tag . flag) .......)
2230 State-change can be a string with a state, and empty string to indicate the
2231 state that has no TODO keyword, or it can be one of the symbols `todo'
2232 or `done', meaning any not-done or done state, respectively."
2246 "Information to record when a task moves to the DONE state.
2248 Possible values are:
2250 nil Don't add anything, just change the keyword
2251 time Add a time stamp to the task
2252 note Prompt for a note and add it with template `org-log-note-headings'
2254 This option can also be set with on a per-file-basis with
2256 #+STARTUP: nologdone
2257 #+STARTUP: logdone
2258 #+STARTUP: lognotedone
2260 You can have local logging settings for a subtree by setting the LOGGING
2261 property to one or more of these keywords."
2269 ;; Normalize old uses of org-log-done.
2276 "Information to record when the scheduling date of a tasks is modified.
2278 Possible values are:
2280 nil Don't add anything, just change the date
2281 time Add a time stamp to the task
2282 note Prompt for a note and add it with template `org-log-note-headings'
2284 This option can also be set with on a per-file-basis with
2286 #+STARTUP: nologreschedule
2287 #+STARTUP: logreschedule
2288 #+STARTUP: lognotereschedule"
2297 "Information to record when the deadline date of a tasks is modified.
2299 Possible values are:
2301 nil Don't add anything, just change the date
2302 time Add a time stamp to the task
2303 note Prompt for a note and add it with template `org-log-note-headings'
2305 This option can also be set with on a per-file-basis with
2307 #+STARTUP: nologredeadline
2308 #+STARTUP: logredeadline
2309 #+STARTUP: lognoteredeadline
2311 You can have local logging settings for a subtree by setting the LOGGING
2312 property to one or more of these keywords."
2321 "Non-nil means record a note when clocking out of an item.
2322 This can also be configured on a per-file basis by adding one of
2323 the following lines anywhere in the buffer:
2325 #+STARTUP: lognoteclock-out
2326 #+STARTUP: nolognoteclock-out"
2332 "Non-nil means the CLOSED time stamp will contain date and time.
2333 When nil, only the date will be recorded."
2347 "Headings for notes added to entries.
2348 The value is an alist, with the car being a symbol indicating the note
2349 context, and the cdr is the heading to be used. The heading may also be the
2350 empty string.
2351 %t in the heading will be replaced by a time stamp.
2352 %T will be an active time stamp instead the default inactive one
2353 %s will be replaced by the new TODO state, in double quotes.
2354 %S will be replaced by the old TODO state, in double quotes.
2355 %u will be replaced by the user name.
2356 %U will be replaced by the full user name.
2358 In fact, it is not a good idea to change the `state' entry, because
2359 agenda log mode depends on the format of these entries."
2365 "Heading when changing todo state (todo sequence only)"
2379 "Non-nil means insert state change notes and time stamps into a drawer.
2380 When nil, state changes notes will be inserted after the headline and
2381 any scheduling and clock lines, but not inside a drawer.
2383 The value of this variable should be the name of the drawer to use.
2384 LOGBOOK is proposed as the default drawer for this purpose, you can
2385 also set this to a string to define the drawer of your choice.
2389 If this variable is set, `org-log-state-notes-insert-after-drawers'
2390 will be ignored.
2392 You can set the property LOG_INTO_DRAWER to overrule this setting for
2393 a subtree."
2405 "Return the value of `org-log-into-drawer', but let properties overrule.
2406 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2407 used instead of the default value."
2415 "Non-nil means insert state change notes after any drawers in entry.
2416 Only the drawers that *immediately* follow the headline and the
2417 deadline/scheduled line are skipped.
2418 When nil, insert notes right after the heading and perhaps the line
2419 with deadline/scheduling if present.
2421 This variable will have no effect if `org-log-into-drawer' is
2422 set."
2428 "Non-nil means the latest state note will be directly after heading.
2429 When nil, the state change notes will be ordered according to time."
2435 "The TODO state to which a repeater should return the repeating task.
2436 By default this is the first task in a TODO sequence, or the previous state
2437 in a TODO_TYP set. But you can specify another task here.
2438 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2444 "Non-nil means record moving through the DONE state when triggering repeat.
2445 An auto-repeating task is immediately switched back to TODO when
2448 record a closing note, there will be no record of the task moving
2449 through DONE. This variable forces taking a note anyway.
2451 nil Don't force a record
2452 time Record a time stamp
2453 note Record a note
2455 This option can also be set with on a per-file-basis with
2457 #+STARTUP: logrepeat
2458 #+STARTUP: lognoterepeat
2459 #+STARTUP: nologrepeat
2461 You can have local logging settings for a subtree by setting the LOGGING
2462 property to one or more of these keywords."
2472 "Priorities in Org-mode."
2477 "Non-nil means priority commands are active.
2478 When nil, these commands will be disabled, so that you never accidentally
2479 set a priority."
2484 "The highest priority of TODO items. A character like ?A, ?B etc.
2485 Must have a smaller ASCII number than `org-lowest-priority'."
2490 "The lowest priority of TODO items. A character like ?A, ?B etc.
2491 Must have a larger ASCII number than `org-highest-priority'."
2496 "The default priority of TODO items.
2497 This is the priority an item gets if no explicit priority is given.
2498 When starting to cycle on an empty priority the first step in the cycle
2499 depends on `org-priority-start-cycle-with-default'. The resulting first
2500 step priority must not exceed the range from `org-highest-priority' to
2501 `org-lowest-priority' which means that `org-default-priority' has to be
2502 in this range exclusive or inclusive the range boundaries. Else the
2503 first step refuses to set the default and the second will fall back
2504 to (depending on the command used) the highest or lowest priority."
2509 "Non-nil means start with default priority when starting to cycle.
2510 When this is nil, the first step in the cycle will be (depending on the
2511 command used) one higher or lower than the default priority.
2512 See also `org-default-priority'."
2517 "Function to extract the priority from a string.
2518 The string is normally the headline. If this is nil Org computes the
2519 priority from the priority cookie like [#A] in the headline. It returns
2520 an integer, increasing by 1000 for each priority level.
2521 The user can set a different function here, which should take a string
2522 as an argument and return the numeric priority."
2527 "Options concerning time stamps and deadlines in Org-mode."
2532 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2533 When nil, these labeled time stamps are forces into the second line of an
2534 entry, just after the headline. When scheduling from the global TODO list,
2535 the time stamp will always be forced into the second line."
2540 "Formats for `format-time-string' which are used for time stamps.
2544 "Number of minutes to round time stamps to.
2545 These are two values, the first applies when first creating a time stamp.
2546 The second applies when changing it with the commands `S-up' and `S-down'.
2547 When changing the time stamp, this means that it will change in steps
2548 of N minutes, as given by the second value.
2550 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2551 numbers should be factors of 60, so for example 5, 10, 15.
2553 When this is larger than 1, you can still force an exact time stamp by using
2554 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2555 and by using a prefix arg to `S-up/down' to specify the exact number
2556 of minutes to shift."
2566 ;; Normalize old customizations of this variable.
2570 org-time-stamp-rounding-minutes)))
2573 "Non-nil means overlay custom formats over all time stamps.
2574 The formats are defined through the variable `org-time-stamp-custom-formats'.
2575 To turn this on on a per-file basis, insert anywhere in the file:
2576 #+STARTUP: customtime"
2584 "Custom formats for time stamps. See `format-time-string' for the syntax.
2585 These are overlayed over the default ISO format if the variable
2586 `org-display-custom-times' is set. Time like %H:%M should be at the
2587 end of the second format. The custom formats are also honored by export
2588 commands, if custom time display is turned on at the time of export."
2593 "Get the right format for a time string."
2598 f)))
2601 "The format string used when creating CLOCKSUM lines.
2602 This is also used when org-mode generates a time duration."
2608 org-mode generates a time duration."
2613 "The format string used when creating CLOCKSUM lines, or when
2614 org-mode generates a time duration."
2619 "No. of days before expiration during which a deadline becomes active.
2620 This variable governs the display in sparse trees and in the agenda.
2621 When 0 or negative, it means use this number (the absolute value of it)
2622 even if a deadline has a different individual lead time specified.
2624 Custom commands can set this variable in the options section."
2630 "Non-nil means assume future for incomplete date input from user.
2631 This affects the following situations:
2632 1. The user gives a month but not a year.
2635 2. The user gives a day, but no month.
2638 it will be considered as *this* month.
2640 If you set this variable to the symbol `time', then also the following
2641 will work:
2643 3. If the user gives a time, but no day. If the time is before now,
2644 to will be interpreted as tomorrow.
2646 Currently none of this works for ISO week specifications.
2648 When this option is nil, the current day, month and year will always be
2649 used as defaults.
2651 See also `org-agenda-jump-prefer-future'."
2659 "Should the agenda jump command prefer the future for incomplete dates?
2660 The default is to do the same as configured in `org-read-date-prefer-future'.
2661 But you can also set a deviating value here.
2662 This may t or nil, or the symbol `org-read-date-prefer-future'."
2667 org-read-date-prefer-future)
2672 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2674 Depending on the system Emacs is running on, certain dates cannot
2675 be represented with the type used internally to represent time.
2676 Dates between 1970-1-1 and 2038-1-1 can always be represented
2677 correctly. Some systems allow for earlier dates, some for later,
2678 some for both. One way to find out it to insert any date into an
2679 Org buffer, putting the cursor on the year and hitting S-up and
2680 S-down to test the range.
2682 When this variable is set to t, the date/time prompt will not let
2683 you specify dates outside the 1970-2037 range, so it is certain that
2684 these dates will work in whatever version of Emacs you are
2685 running, and also that you can move a file from one Emacs implementation
2686 to another. WHenever Org is forcing the year for you, it will display
2687 a message and beep.
2689 When this variable is nil, Org will check if the date is
2690 representable in the specific Emacs implementation you are using.
2691 If not, it will force a year, usually the current year, and beep
2692 to remind you. Currently this setting is not recommended because
2693 the likelihood that you will open your Org files in an Emacs that
2694 has limited date range is not negligible.
2696 A workaround for this problem is to use diary sexp dates for time
2697 stamps outside of this range."
2702 "Non-nil means display current interpretation of date prompt live.
2703 This display will be in an overlay, in the minibuffer."
2708 "Non-nil means pop up a calendar when prompting for a date.
2709 In the calendar, the date can be selected with mouse-1. However, the
2710 minibuffer will also be active, and you can simply enter the date as well.
2711 When nil, only the minibuffer will be available."
2719 "Hook to be used to set up keys for the date/time interface.
2720 Add key definitions to `minibuffer-local-map', which will be a temporary
2721 copy."
2726 "The hour when your day really ends. Must be an integer.
2727 This has influence for the following applications:
2729 the time given here, the day recognized as TODAY is actually yesterday.
2730 - When a date is read from the user and it is still before the time given
2731 here, the current date and time will be assumed to be yesterday, 23:59.
2732 Also, timestamps inserted in remember templates follow this rule.
2734 IMPORTANT: This is a feature whose implementation is and likely will
2735 remain incomplete. Really, it is only here because past midnight seems to
2736 be the favorite working time of John Wiegley :-)"
2741 "Non-nil means S-down will increase the time in a time stamp.
2742 When nil, S-up will increase."
2747 "Non-nil means make the calendar window follow timestamp changes.
2748 When a timestamp is modified and the calendar window is visible, it will be
2749 moved to the new date."
2754 "Options concerning tags in Org-mode."
2759 "List of tags allowed in Org-mode files.
2760 When this list is nil, Org-mode will base TAG input on what is already in the
2761 buffer.
2762 The value of this variable is an alist, the car of each entry must be a
2763 keyword as a string, the cdr may be a character that is used to select
2764 that tag through the fast-tag-selection interface.
2765 See the manual for details."
2780 "List of tags that will always appear in all Org-mode files.
2781 This is in addition to any in buffer settings or customizations
2782 of `org-tag-alist'.
2783 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2784 The value of this variable is an alist, the car of each entry must be a
2785 keyword as a string, the cdr may be a character that is used to select
2786 that tag through the fast-tag-selection interface.
2787 See the manual for details.
2788 To disable these tags on a per-file basis, insert anywhere in the file:
2789 #+STARTUP: noptag"
2800 "If non-nil, always offer completion for all tags of all agenda files.
2801 Instead of customizing this variable directly, you might want to
2802 set it locally for capture buffers, because there no list of
2803 tags in that file can be created dynamically (there are none).
2805 (add-hook 'org-capture-mode-hook
2806 (lambda ()
2807 (set (make-local-variable
2808 'org-complete-tags-always-offer-all-agenda-tags)
2809 t)))"
2814 "List of tags that can be inherited by all entries in the file.
2815 The tags will be inherited if the variable `org-use-tag-inheritance'
2816 says they should be.
2820 "Non-nil means use fast tag selection scheme.
2821 This is a special interface to select and deselect tags with single keys.
2822 When nil, fast selection is never used.
2823 When the symbol `auto', fast selection is used if and only if selection
2824 characters for tags have been configured, either through the variable
2825 `org-tag-alist' or through a #+TAGS line in the buffer.
2826 When t, fast selection is always used and selection keys are assigned
2827 automatically if necessary."
2835 "Non-nil means fast tag selection exits after first change.
2836 When nil, you have to press RET to exit it.
2837 During fast tag selection, you can toggle this flag with `C-c'.
2838 This variable can also have the value `expert'. In this case, the window
2839 displaying the tags menu is not even shown, until you press C-c again."
2847 "Non-nil means fast tags selection interface will also offer TODO states.
2851 "The column to which tags should be indented in a headline.
2852 If this number is positive, it specifies the column. If it is negative,
2853 it means that the tags should be flushright to that column. For example,
2854 -80 works well for a normal 80 character screen."
2859 "Non-nil keeps tags aligned when modifying headlines.
2860 Some operations (i.e. demoting) change the length of a headline and
2861 therefore shift the tags around. With this option turned on, after
2862 each such operation the tags are again aligned to `org-tags-column'."
2867 "Non-nil means tags in levels apply also for sublevels.
2868 When nil, only the tags directly given in a specific line apply there.
2869 This may also be a list of tags that should be inherited, or a regexp that
2870 matches tags that should be inherited. Additional control is possible
2871 with the variable `org-tags-exclude-from-inheritance' which gives an
2872 explicit list of tags to be excluded from inheritance., even if the value of
2873 `org-use-tag-inheritance' would select it for inheritance.
2875 If this option is t, a match early-on in a tree can lead to a large
2876 number of matches in the subtree when constructing the agenda or creating
2877 a sparse tree. If you only want to see the first match in a tree during
2878 a search, check out the variable `org-tags-match-list-sublevels'."
2887 "List of tags that should never be inherited.
2888 This is a way to exclude a few tags from inheritance. For way to do
2889 the opposite, to actively allow inheritance for selected tags,
2890 see the variable `org-use-tag-inheritance'."
2895 "Check if TAG is one that should be inherited."
2907 "Non-nil means list also sublevels of headlines matching a search.
2908 This variable applies to tags/property searches, and also to stuck
2909 projects because this search is based on a tags match as well.
2911 When set to the symbol `indented', sublevels are indented with
2912 leading dots.
2914 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2915 the sublevels of a headline matching a tag search often also match
2916 the same search. Listing all of them can create very long lists.
2917 Setting this variable to nil causes subtrees of a match to be skipped.
2919 This variable is semi-obsolete and probably should always be true. It
2920 is better to limit inheritance to certain tags using the variables
2921 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2929 "When set, tags are sorted using this function as a comparator."
2945 "Options concerning properties in Org-mode."
2950 "How property key/value pairs should be formatted by `indent-line'.
2951 When `indent-line' hits a property definition, it will format the line
2952 according to this format, mainly to make sure that the values are
2953 lined-up with respect to each other."
2958 "Non-nil means properties apply also for sublevels.
2960 This setting is chiefly used during property searches. Turning it on can
2961 cause significant overhead when doing a search, which is why it is not
2962 on by default.
2964 When nil, only the properties directly given in the current entry count.
2965 When t, every property is inherited. The value may also be a list of
2966 properties that should have inheritance, or a regular expression matching
2967 properties that should be inherited.
2969 However, note that some special properties use inheritance under special
2970 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2972 for valid values of a property.
2974 Note for programmers:
2975 When querying an entry with `org-entry-get', you can control if inheritance
2976 should be used. By default, `org-entry-get' looks only at the local
2977 properties. You can request inheritance by setting the inherit argument
2978 to t (to force inheritance) or to `selective' (to respect the setting
2979 in this variable)."
2988 "Check if PROPERTY is one that should be inherited."
2999 "The default column format, if no other format has been defined.
3000 This variable can be set on the per-file basis by inserting a line
3002 #+COLUMNS: %25ITEM ....."
3007 "The ellipses to be used when a field in column view is truncated.
3008 When this is the empty string, as many characters as possible are shown,
3009 but then there will be no visual indication that the field has been truncated.
3010 When this is a string of length N, the last N characters of a truncated
3011 field are replaced by this string. If the column is narrower than the
3012 ellipses string, only part of the ellipses string will be shown."
3017 "Function that modifies values for display in column view.
3018 For example, it can be used to cut out a certain part from a time stamp.
3019 The function must take 2 arguments:
3021 column-title The title of the column (*not* the property name)
3022 value The value that should be modified.
3024 The function should return the value that should be displayed,
3025 or nil if the normal value should be used."
3030 "The property that is being used to keep track of effort estimates.
3031 Effort estimates given in this property need to have the format H:MM."
3039 "List of property/value pairs that can be inherited by any entry.
3041 These are fixed values, for the preset properties. The user variable
3042 that can be used to add to this list is `org-global-properties'.
3044 The entries in this list are cons cells where the car is a property
3045 name and cdr is a string with the value. If the value represents
3050 "List of property/value pairs that can be inherited by any entry.
3052 This list will be combined with the constant `org-global-properties-fixed'.
3054 The entries in this list are cons cells where the car is a property
3055 name and cdr is a string with the value.
3057 You can set buffer-local values for the same purpose in the variable
3058 `org-file-properties' this by adding lines like
3060 #+PROPERTY: NAME VALUE"
3067 "List of property/value pairs that can be inherited by any entry.
3068 Valid for the current buffer.
3073 "Options concerning agenda views in Org-mode."
3078 "Variable used by org files to set a category for agenda display.
3079 Such files should use a file variable to set it, for example
3083 or contain a special line
3085 #+CATEGORY: ELisp
3087 If the file does not specify a category, then file's base name
3093 "The files to be used for agenda display.
3097 If an entry is a directory, all files in that directory that are matched by
3098 `org-agenda-file-regexp' will be part of the file list.
3100 If the value of the variable is not a list but a single file name, then
3101 the list of agenda files is actually stored and maintained in that file, one
3102 agenda file per line. In this file paths can be given relative to
3103 `org-directory'. Tilde expansion and environment variable substitution
3104 are also made."
3111 "Regular expression to match files for `org-agenda-files'.
3112 If any element in the list in that variable contains a directory instead
3113 of a normal file, all files in that directory that are matched by this
3114 regular expression will be included."
3119 "List of extra files to be searched by text search commands.
3120 These files will be search in addition to the agenda files by the
3121 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3122 Note that these files will only be searched for text search commands,
3123 not for the other agenda views like todo lists, tag searches or the weekly
3124 agenda. This variable is intended to list notes and possibly archive files
3125 that should also be searched by these two commands.
3126 In fact, if the first element in the list is the symbol `agenda-archives',
3127 than all archive files of all agenda files will be added to the search
3128 scope."
3139 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3140 A nil value means to remove them, after a query, from the list."
3145 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3146 The command `org-calendar-goto-agenda' will be bound to this key. The
3147 default is the character `c' because then `c' can be used to switch back and
3148 forth between agenda and calendar."
3153 "The key to be installed in `calendar-mode-map' for agenda-action.
3154 The command `org-agenda-action' will be bound to this key. The
3155 default is the character `k' because we use the same key in the agenda."
3160 "The key to be installed in `calendar-mode-map' for adding diary entries.
3161 This option is irrelevant until `org-agenda-diary-file' has been configured
3162 to point to an Org-mode file. When that is the case, the command
3163 `org-agenda-diary-entry' will be bound to the key given here, by default
3164 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3165 if you want to continue doing this, you need to change this to a different
3166 key."
3171 "File to which to add new entries with the `i' key in agenda and calendar.
3172 When this is the symbol `diary-file', the functionality in the Emacs
3173 calendar will be used to add entries to the `diary-file'. But when this
3174 points to a file, `org-agenda-diary-entry' will be used instead."
3190 org-calendar-insert-diary-entry-key
3194 "Options for embedding LaTeX code into Org-mode."
3202 "Options for creating images from LaTeX fragments.
3203 This is a property list with the following properties:
3205 `default' means use the foreground of the default face.
3207 `default' means use the background of the default face.
3208 :scale a scaling factor for the size of the images, to get more pixels
3209 :html-foreground, :html-background, :html-scale
3210 the same numbers for HTML export.
3211 :matchers a list indicating which matchers should be used to
3212 find LaTeX fragments. Valid members of this list are:
3223 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3224 When nil, just push out a message."
3233 \[PACKAGES]
3234 \[DEFAULT-PACKAGES]
3235 % The settings below are copied from fullpage.sty
3248 "The document header used for processing LaTeX fragments.
3249 It is imperative that this header make sure that no page number
3250 appears on the page. The package defined in the variables
3251 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3253 will be appended."
3260 "Set the packages alist and make sure it has 3 elements per entry."
3264 x))
3265 val)))
3269 "Get the packages alist and make sure it has 3 elements per entry."
3273 x))
3276 ;; The following variables are defined here because is it also used
3277 ;; when formatting latex fragments. Originally it was part of the
3278 ;; LaTeX exporter, which is why the name includes "export".
3295 )
3296 "Alist of default packages to be inserted in the header.
3297 Change this only if one of the packages here causes an incompatibility
3298 with another package you are using.
3299 The packages in this list are needed by one part or another of Org-mode
3300 to function properly.
3302 - inputenc, fontenc: for basic font and character selection
3303 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3304 for interpreting the entities in `org-entities'. You can skip some of these
3305 packages if you don't use any of the symbols in it.
3306 - graphicx: for including images
3307 - float, wrapfig: for figure placement
3308 - longtable: for long tables
3309 - hyperref: for cross references
3311 Therefore you should not modify this variable unless you know what you
3312 are doing. The one reason to change it anyway is that you might be loading
3313 some other package that conflicts with one of the default packages.
3315 If SNIPPET-FLAG is t, the package also needs to be included when
3316 compiling LaTeX snippets into images for inclusion into HTML."
3329 "Alist of packages to be inserted in every LaTeX header.
3330 These will be inserted after `org-export-latex-default-packages-alist'.
3332 SNIPPET-FLAG, when t, indicates that this package is also needed when
3333 turning LaTeX snippets into images for inclusion into HTML.
3334 Make sure that you only list packages here which:
3335 - you want in every file
3336 - do not conflict with the default packages in
3337 `org-export-latex-default-packages-alist'
3338 - do not conflict with the setup in `org-format-latex-header'."
3352 "Settings for Org-mode appearance."
3357 "Non-nil means fontify only the stars in each headline.
3358 When nil, the entire headline is fontified.
3359 Changing it requires restart of `font-lock-mode' to become effective
3360 also in regions already fontified."
3365 "Non-nil means hide the first N-1 stars in a headline.
3366 This works by using the face `org-hide' for these stars. This
3367 face is white for a light background, and black for a dark
3368 background. You may have to customize the face `org-hide' to
3369 make this work.
3370 Changing it requires restart of `font-lock-mode' to become effective
3371 also in regions already fontified.
3372 You may also set this on a per-file basis by adding one of the following
3373 lines to the buffer:
3375 #+STARTUP: hidestars
3376 #+STARTUP: showstars"
3381 "List of symbols corresponding to keywords to be hidden the org buffer.
3382 For example, a value '(title) for this list will make the document's title
3383 appear in the buffer without the initial #+TITLE: keyword."
3391 "Non-nil means change the face of a headline if it is marked DONE.
3392 Normally, only the TODO/DONE keyword indicates the state of a headline.
3393 When this is non-nil, the headline after the keyword is set to the
3394 `org-headline-done' as an additional indication."
3399 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3400 Changing this variable requires a restart of Emacs to take effect."
3405 "Non-nil means fontify the whole line for headings.
3406 This is useful when setting a background color for the
3407 org-level-* faces."
3412 "Non-nil means fontify what is treated specially by the exporters."
3417 "Non-nil mean font-lock should hide the emphasis marker characters."
3422 "Non-nil means show entities as UTF8 characters.
3428 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3433 "Regular expression for matching emphasis.
3434 After a match, the match groups contain these elements:
3435 0 The match of the full regular expression, including the characters
3436 before and after the proper match
3437 1 The character before the proper match, or empty at beginning of line
3438 2 The proper match, including the leading and trailing markers
3439 3 The leading marker like * or /, indicating the type of highlighting
3440 4 The text between the emphasis markers, not including the markers
3447 "Set variable and compute the emphasis regular expression."
3451 org-emphasis-alist org-emphasis-regexp-components)
3463 ;; make sure special characters appear at the right position in the class
3475 ;; Make the regexp
3483 body1
3495 body1
3503 "Components used to build the regular expression for emphasis.
3504 This is a list with five entries. Terminology: In an emphasis string
3508 specify what is allowed/forbidden in each part:
3510 pre Chars allowed as prematch. Beginning of line will be allowed too.
3511 post Chars allowed as postmatch. End of line will be allowed too.
3512 border The chars *forbidden* as border characters.
3514 non-shy groups here, and don't allow newline here.
3515 newline The maximum number of newlines allowed in an emphasis exp.
3517 Use customize to modify this, or restart Emacs after changing it."
3536 )
3537 "Special syntax for emphasized text.
3538 Text starting and ending with a special character will be emphasized, for
3539 example *bold*, _underlined_ and /italic/. This variable sets the marker
3540 characters, the face to be used by font-lock for highlighting in Org-mode
3541 Emacs buffers, and the HTML tags to be used for this.
3542 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3543 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3544 Use customize to modify this, or restart Emacs after changing it."
3559 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3562 ;;; Miscellaneous options
3565 "Completion in Org-mode."
3570 "Non-nil means use ido completion wherever possible.
3571 Note that `ido-mode' must be active for this variable to be relevant.
3572 If you decide to turn this variable on, you might well want to turn off
3573 `org-outline-path-complete-in-steps'.
3574 See also `org-completion-use-iswitchb'."
3579 "Non-nil means use iswitchb completion wherever possible.
3580 Note that `iswitchb-mode' must be active for this variable to be relevant.
3581 If you decide to turn this variable on, you might well want to turn off
3582 `org-outline-path-complete-in-steps'.
3583 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3589 Normal means, no org-mode-specific context."
3593 ;;; Functions and variables from their packages
3594 ;; Declared here to avoid compiler warnings
3596 ;; XEmacs only
3602 ;; Emacs only
3605 ;; Various packages
3623 org-format-agenda-item "org-agenda"
3654 ;;; Autoload and prepare some org modules
3656 ;; Some table stuff that needs to be defined here, because it is used
3657 ;; by the functions setting up org-mode or checking for table context.
3670 "Detect the first line outside a table when searching from within it.
3673 ;; Autoload the functions in org-table.el that are needed by functions here.
3678 org-table-convert org-table-convert-region org-table-copy-down
3679 org-table-copy-region org-table-create
3680 org-table-create-or-convert-from-region
3681 org-table-create-with-table.el org-table-current-dline
3682 org-table-cut-region org-table-delete-column org-table-edit-field
3683 org-table-edit-formulas org-table-end org-table-eval-formula
3684 org-table-export org-table-field-info
3685 org-table-get-stored-formulas org-table-goto-column
3686 org-table-hline-and-move org-table-import org-table-insert-column
3687 org-table-insert-hline org-table-insert-row org-table-iterate
3688 org-table-justify-field-maybe org-table-kill-row
3689 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3690 org-table-move-column org-table-move-column-left
3691 org-table-move-column-right org-table-move-row
3692 org-table-move-row-down org-table-move-row-up
3693 org-table-next-field org-table-next-row org-table-paste-rectangle
3694 org-table-previous-field org-table-recalculate
3695 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3696 org-table-toggle-coordinate-overlays
3697 org-table-toggle-formula-debugger org-table-wrap-region
3698 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3699 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3700 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3703 "Return t if the cursor is inside an org-type table.
3704 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3709 org-table-line-regexp)))
3710 nil))
3714 "Return t if and only if we are at a table.el table."
3720 "If there is a table.el table nearby, recognize it and move into it."
3726 nil
3736 t
3741 t)
3742 nil)
3743 nil))
3746 "Return t if the cursor is inside a hline in a table."
3751 nil))
3756 "Apply FUNCTION to the start of all tables in the buffer."
3772 ;; Declare and autoload functions from org-exp.el & Co
3780 org-insert-export-options-template
3781 org-table-clean-before-export))
3784 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3785 org-export-region-as-ascii))
3788 org-replace-region-by-latex org-export-region-as-latex
3789 org-export-as-latex org-export-as-pdf
3790 org-export-as-pdf-and-open))
3793 org-export-as-html-batch org-export-as-html-to-buffer
3794 org-replace-region-by-html org-export-region-as-html
3795 org-export-as-html))
3798 org-replace-region-by-docbook org-export-region-as-docbook
3799 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3800 org-export-as-docbook))
3803 org-export-icalendar-all-agenda-files
3804 org-export-icalendar-combine-agenda-files))
3808 ;; Declare and autoload functions from org-agenda.el
3813 org-todo-list org-tags-view org-agenda-list-stuck-projects
3814 org-diary org-agenda-to-appt
3815 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3817 ;; Autoload org-remember
3822 org-remember-apply-template org-remember org-remember-handler)))
3827 org-capture-import-remember-templates)))
3829 ;; Autoload org-clock.el
3844 "Return non-nil if clock is currently running.
3845 The return value is actually the clock marker."
3850 "org-clock"
3852 org-clock-goto org-clock-sum org-clock-display
3853 org-clock-remove-overlays org-clock-report
3854 org-clocktable-shift org-dblock-write:clocktable
3855 org-get-clocktable org-resolve-clocks)))
3858 "If this is a CLOCK line, update it and return t.
3859 Otherwise, return nil."
3868 ts te h m s neg)
3871 nil)
3876 ;; The clock is running here
3897 t))))))
3900 "Check if the current buffer contains the running clock.
3901 If yes, offer to stop it and to save the buffer with the changes."
3910 "Check if this line starts a clock table, if yes, shift the time block."
3914 ;; Autoload org-timer.el
3918 "org-timer"
3920 org-timer-change-times-in-region
3921 org-timer-set-timer
3922 org-timer-reset-timers
3923 org-timer-show-remaining-time)))
3925 ;; Autoload org-feed.el
3929 "org-feed"
3933 ;; Autoload org-indent.el
3935 ;; Define the variable already here, to make sure we have it.
3937 "Non-nil if Org-Indent mode is enabled.
3942 "org-indent"
3945 ;; Autoload org-mobile.el
3949 "org-mobile"
3952 ;; Autoload archiving code
3953 ;; The stuff that is needed for cycling and tags has to be defined here.
3956 "Options concerning archiving in Org-mode."
3961 "The location where subtrees should be archived.
3963 The value of this variable is a string, consisting of two parts,
3964 separated by a double-colon. The first part is a filename and
3965 the second part is a headline.
3967 When the filename is omitted, archiving happens in the same file.
3968 %s in the filename will be replaced by the current file
3969 name (without the directory part). Archiving to a different file
3970 is useful to keep archived entries from contributing to the
3971 Org-mode Agenda.
3973 The archived entries will be filed as subtrees of the specified
3974 headline. When the headline is omitted, the subtrees are simply
3975 filed away at the end of the file, as top-level entries. Also in
3976 the heading you can use %s to represent the file name, this can be
3977 useful when using the same archive for a number of different files.
3979 Here are a few examples:
3981 If the current file is Projects.org, archive in file
3982 Projects.org_archive, as top-level trees. This is the default.
3985 Archive in the current file, under the top-level headline
3989 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3992 Archive in file ~/org/archive.org (absolute path), under headlines
3996 Archive in file ./basement (relative path), as level 3 trees
3999 You may set this option on a per-file basis by adding to the buffer a
4000 line like
4002 #+ARCHIVE: basement::** Finished Tasks
4004 You may also define it locally for a subtree by setting an ARCHIVE property
4005 in the entry. If such a property is found in an entry, or anywhere up
4006 the hierarchy, it will be used."
4011 "The tag that marks a subtree as archived.
4012 An archived subtree does not open during visibility cycling, and does
4013 not contribute to the agenda listings.
4014 After changing this, font-lock must be restarted in the relevant buffers to
4015 get the proper fontification."
4021 "Non-nil means the agenda will skip any items located in archived trees.
4022 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4023 variable is no longer recommended, you should leave it at the value t.
4024 Instead, use the key `v' to cycle the archives-mode in the agenda."
4030 "Non-nil means ignore archived trees when creating column view."
4036 "Non-nil means `org-cycle' will open archived trees.
4037 An archived tree is a tree marked with the tag ARCHIVE.
4038 When nil, archived trees will stay folded. You can still open them with
4039 normal outline commands like `show-all', but not with the cycling commands."
4045 "Non-nil means sparse tree construction shows matches in archived trees.
4046 When nil, matches in these trees are highlighted, but the trees are kept in
4047 collapsed state."
4053 "Re-hide all archived subtrees after a visibility state change."
4064 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4067 "Cycle subtree even if it is archived."
4074 "Re-hide all archived subtrees after a visibility state change."
4089 flag)))
4096 org-archive-to-archive-sibling org-toggle-archive-tag
4097 org-archive-subtree-default
4098 org-archive-subtree-default-with-confirmation)))
4100 ;; Autoload Column View Code
4108 org-columns-compute org-agenda-columns org-columns-remove-overlays
4111 ;; Autoload ID code
4119 org-id-get-with-outline-path-completion
4120 org-id-get-with-outline-drilling org-id-store-link
4121 org-id-goto org-id-find org-id-store-link))
4123 ;; Autoload Plotting Code
4128 ;;; Variables for pre-computed regular expressions, all buffer local
4146 "Matches a headline and puts everything into groups:
4147 group 1: the stars
4148 group 2: The todo keyword, maybe
4149 group 3: Priority cookie
4150 group 4: True headline
4154 "Printf format to make regexp to match an exact headline.
4155 This regexp will match the headline of any node which hase the exact
4156 headline text that is put into the format, but may have any TODO state,
4160 "Matches a headline and puts TODO state into group 2 if present.
4215 "Regular expression to match a plain time or time range.
4216 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4217 groups carry important information:
4218 0 the full match
4219 1 the first time, range or not
4227 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
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 7 hours of duration
4240 "Regular expression to match a timestamp time or time range.
4241 After a match, the following groups carry important information:
4242 0 the full match
4243 1 date plus weekday, for back referencing to make sure both times are on the same day
4244 2 the first time, range or not
4299 "Variable associated with STARTUP options for org-mode.
4300 Each element is a list of three items: The startup options as written
4301 in the #+STARTUP line, the corresponding variable, and the value to
4302 set this variable to if the option is found. An optional forth element PUSH
4306 "Precompute regular expressions for current buffer."
4326 kwds kws0 kwsa key log value cat arch tags const links hw dws
4327 tail sep kws1 prio props ftags drawers beamer-p
4349 ;; general TODO-like setup
4361 links)))
4367 props)))
4372 ftags
4382 l var val)
4412 ))))
4429 ;; Process the TODO keywords
4431 ;; Use the global values as if they had been given locally.
4443 kws)))
4446 kwsa nil
4449 ;; 1 2
4457 kw)
4459 kws0)
4476 ;; Process the constants
4484 ;; Process the tags.
4495 tgs))
4503 ;; Compute the regular expressions and other local variables
4511 org-drawer-regexp
4515 org-not-done-keywords
4517 org-todo-regexp
4520 org-not-done-regexp
4524 org-not-done-heading-regexp
4528 org-todo-line-regexp
4532 org-complex-heading-regexp
4537 org-complex-heading-regexp-format
4546 org-nl-done-regexp
4550 org-todo-line-tags-regexp
4555 org-looking-at-done-regexp
4560 org-deadline-time-regexp
4562 org-deadline-line-regexp
4564 org-scheduled-regexp
4566 org-scheduled-time-regexp
4568 org-closed-time-regexp
4570 org-keyword-time-regexp
4576 org-keyword-time-not-clock-regexp
4582 org-maybe-keyword-time-regexp
4588 org-planning-or-clock-line-re
4593 org-all-time-keywords
4596 org-clock-string org-closed-string))
4597 )
4602 "Return the contents of FILE, as a string."
4616 "Extract the log state setting from a TODO keyword string.
4630 "Remove a pair of parenthesis at the end of each string in LIST."
4634 x))
4635 list))
4638 "Assign fast keys to a keyword-key alist.
4639 Respect keys that are already there."
4657 ;;; Some variables used in various places
4664 "Function to be called when `C-c C-c' is used.
4668 ;; FIXME: Occasionally check by commenting these, to make sure
4669 ;; no other functions uses these, forgetting to let-bind them.
4674 ;; Defined somewhere in this file, but used before definition.
4680 ;;;; Define the Org-mode
4683 (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"))
4686 ;; We use a before-change function to check if a table might need
4687 ;; an update.
4689 "Indicates that a table might need an update.
4690 This variable is set by `org-before-change-function'.
4693 "Every change indicates that a table might need an update."
4703 ;; org-outline-regexp ought to be a defconst but is let-binding
4704 ;; in some places -- e.g. see the macro org-with-limited-levels
4708 ;;;###autoload
4710 "Outline-based notes management and organizer, alias
4713 Org-mode develops organizational tasks around a NOTES file which
4714 contains information about projects as plain text. Org-mode is
4715 implemented on top of outline-mode, which is ideal to keep the content
4716 of large files well structured. It supports ToDo items, deadlines and
4717 time stamps, which magically appear in the diary listing of the Emacs
4718 calendar. Tables are easily created with a built-in table editor.
4719 Plain text URL-like links connect to websites, emails (VM), Usenet
4720 messages (Gnus), BBDB entries, and any files related to the project.
4721 For printing and sharing of notes, an Org-mode file (or a part of it)
4722 can be exported as a structured ASCII or HTML file.
4724 The following commands are available:
4728 ;; Get rid of Outline menus, they are not needed
4729 ;; Need to do this here because define-derived-mode sets up
4730 ;; the keymap so late. Still, it is a waste to call this each time
4731 ;; we switch another buffer into org-mode.
4734 ;; Assume this is Greg's port, it uses easymenu
4759 org-display-table 4
4762 org-ellipsis)))
4767 ;; tag faces set outside customize.... force initialization.
4769 ;; Calc embedded
4775 ;; Activate before-change-function
4779 ;; Check for running clock before killing a buffer
4781 ;; Paragraphs and auto-filling
4785 ;; Beginning/end of defun
4788 ;; Next error for sparse trees
4790 ;; Make sure dependence stuff works reliably, even for users who set it
4791 ;; too late :-(
4803 ;; Comment characters
4807 ;; Align options lines
4809 'align-mode-rules-list
4814 ;; Imenu
4818 ;; Make isearch reveal context
4821 ;; Emacs 21 and XEmacs make use of the hook
4823 ;; Emacs 22 deals with this through a special variable
4827 ;; Turn on org-beamer-mode?
4830 ;; Setup the pcomplete hooks
4843 ;; If empty file that did not turn on org-mode automatically, make it to.
4868 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4878 "Return today date, considering `org-extend-today-until'."
4883 ;;;; Font-Lock stuff, including the activators
4914 "Regular expression used to analyze links.
4915 Here is what the match groups contain after a match:
4916 1: http:
4917 2: http
4918 3: path
4919 4: [desc]
4927 "Number of stacked braces for sub/superscript matching.
4928 This has to be set before loading org.el to be effective."
4933 "Create a regular expression which will match a balanced sexp.
4934 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4935 as single character strings.
4936 The regexp returned will match the entire expression including the
4937 delimiters. It will also define a single group which contains the
4938 match except for the outermost delimiters. The maximum depth of
4939 stacked delimiters is N. Escaping delimiters is not possible."
4968 "Update the link regular expressions.
4969 This should be called after the variable `org-link-types' has changed."
4973 org-link-re-with-space
4979 org-link-re-with-space2
4985 org-link-re-with-space3
4990 org-angle-link-re
4996 org-plain-link-re
5000 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5001 org-bracket-link-regexp
5003 org-bracket-link-analytic-regexp
5011 org-bracket-link-analytic-regexp++
5019 org-any-link-re
5028 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5030 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5031 "Regular expression matching time strings for analysis.
5032 This one does not require the space after the date, so it can be used
5034 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5050 "Regular expression matching a time stamp or time stamp range.
5056 "Run through the buffer and add overlays to emphasised strings."
5065 'face
5078 rtn))
5081 "Insert or change an emphasis, i.e. a font like bold or italic.
5082 If there is an active region, change that region to a new emphasis.
5083 If there is no region, just insert the marker characters and position
5084 the cursor between them.
5085 CHAR should be either the marker character, or the first character of the
5086 HTML tag associated with that emphasis. If CHAR is a space, the means
5087 to remove the emphasis of the selected region.
5088 If char is not given (for example in an interactive call) it
5089 will be prompted for."
5140 "Run through the buffer and add overlays to links."
5149 nil
5155 t)))))
5163 t)))
5166 "When non-nil, fontify code in code blocks."
5177 "Fontify #+ lines and blocks, in the correct ways."
5180 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5181 limit t)
5189 end end1 quoting block-type ovl)
5192 ;; a single line of backend-specific content
5200 ; for backend-specific code
5201 t)
5203 ;; Truly a block
5215 beg end
5223 ;; remove old background overlays
5228 ;; add a background overlay
5242 t))
5255 ;; just any other in-buffer setting, but not indented
5259 t)
5268 t)
5276 "Run through the buffer and add overlays to links."
5284 t)))
5287 "Run through the buffer and add overlays to footnotes."
5294 'keymap org-mouse-map
5295 'help-echo
5297 "Footnote definition"
5299 'font-lock-fontified t
5300 'font-lock-multiline t
5304 "Run through the buffer and add overlays to bracketed links."
5308 ;; FIXME: above we should remove the escapes.
5309 ;; but that requires another match, protecting match data,
5310 ;; a lot of overhead for font-lock.
5317 ;; We need to remove the invisible property here. Table narrowing
5318 ;; may have made some of this invisible.
5336 t)))
5339 "Run through the buffer and add overlays to dates."
5351 t)))
5360 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5364 "Run through the buffer and add overlays to target matches."
5372 'keymap org-mouse-map
5376 t)))))
5379 "Find all radio targets in this file and update the regular expression."
5394 t)))
5401 ;; This should be with the exporter code, but we also use if for font-locking
5411 "Compute regular expression for stuff treated specially by exporters."
5418 org-latex-regexps)))
5446 org-entities)))
5450 org-latex-entities)
5451 nil))
5453 ))
5454 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5457 org-export-html-special-string-regexps)))
5462 ))))
5464 'org-latex-and-specials-regexp
5469 "Run through the buffer and add overlays to links."
5473 limit t))
5487 rtn)))
5490 "Restart `font-lock-mode', to force refontification."
5496 "Return a list of all targets in this file.
5497 With optional argument RADIO, only find radio targets."
5499 rtn)
5504 rtn)))
5507 "Make regular expression matching all strings in TARGETS.
5508 The regular expression finds the targets also if there is a line break
5509 between words."
5518 x)
5519 targets
5531 t)))
5534 "Compute the outline level of the heading at point.
5535 This function assumes that the cursor is at the beginning of a line matched
5536 by `outline-regexp'. Otherwise it returns garbage.
5537 If this is called at a normal headline, the level is the number of stars.
5538 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5545 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5552 "Functions that can manipulate `org-font-lock-extra-keywords'.
5553 This is calles after `org-font-lock-extra-keywords' is defined, but before
5554 it is installed to be used by font lock. This can be useful if something
5565 ;; Call the hook
5567 ;; Headlines
5574 ;; Table lines
5577 ;; Table internals
5582 ;; Drawers
5585 ;; Properties
5589 ;; Links
5599 ;; TODO lines
5602 ;; DONE
5608 nil)
5609 ;; Priorities
5611 ;; Tags
5613 ;; Special keywords
5618 ;; Emphasis
5623 ;; Checkboxes
5624 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5629 ;; Description list items
5632 ;; ARCHIVEd headings
5634 org-outline-regexp-bol
5637 ;; Specials
5641 ;; Code
5643 ;; COMMENT
5648 ;; Blocks and meta lines
5650 )))
5653 ;; Now set the full font-lock-keywords
5660 "Toggle the composition display of entities as UTF8 characters."
5672 "Find an entity to fontify."
5678 limit t)
5690 nil))))
5693 "Fontify string S like in Org-mode."
5705 "Get the right face for match N in font-lock matching of headlines."
5718 "Get the right face for a TODO keyword KWD.
5719 If KWD is a number, get the corresponding match group."
5727 "Create a face list that inherits INHERIT, but sets the foreground color.
5728 When FACE-OR-COLOR is not a string, just return it."
5732 face-or-color)
5733 face-or-color))
5736 "Add the special tag faces."
5745 "Add the special priority faces."
5752 org-priority-faces)))
5757 "Get the right face for a TODO keyword KWD.
5758 If KWD is a number, get the corresponding match group."
5765 "Remove fontification and activation overlays from links."
5770 deactivate-mark buffer-file-name buffer-file-truename)
5773 beg end
5775 ;; also remove line-prefix and wrap-prefix properties
5777 invisible t intangible t
5778 line-prefix t wrap-prefix t
5779 org-no-flyspell t org-emphasis t)
5781 invisible t intangible t
5782 org-no-flyspell t org-emphasis t)))
5792 "Remove specific display properties that have been added by font lock.
5793 The will remove the raise properties that are used to show superscripts
5794 and subscripts."
5804 "Add raise properties to sub/superscripts."
5808 org-match-substring-regexp
5809 org-match-substring-with-braces-regexp)
5810 limit t)
5820 ;; FIXME: Should we go back one character here, for a_b^c
5821 ;; (goto-char (1- pos)) ;????????????????????
5823 t
5825 'display
5841 t)))))
5843 ;;;; Visibility cycling, including org-goto and indirect buffer
5845 ;;; Cycling
5852 ;;;###autoload
5857 "TAB-action and visibility cycling for Org-mode.
5859 This is the command invoked in Org-mode by the TAB key. Its main purpose
5860 is outline visibility cycling, but it also invokes other actions
5861 in special contexts.
5863 - When this function is called with a prefix argument, rotate the entire
5864 buffer through 3 states (global cycling)
5865 1. OVERVIEW: Show only top-level headlines.
5866 2. CONTENTS: Show all headlines of all levels, but no body text.
5867 3. SHOW ALL: Show everything.
5868 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5869 determined by the variable `org-startup-folded', and by any VISIBILITY
5870 properties in the buffer.
5871 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5872 including any drawers.
5874 - When inside a table, re-align the table and move to the next field.
5876 - When point is at the beginning of a headline, rotate the subtree started
5877 by this line through 3 different states (local cycling)
5878 1. FOLDED: Only the main headline is shown.
5879 2. CHILDREN: The main headline and the direct children are shown.
5880 From this state, you can move to one of the children
5881 and zoom in further.
5882 3. SUBTREE: Show the entire subtree, including body text.
5883 If there is no subtree, switch directly from CHILDREN to FOLDED.
5885 - When point is at the beginning of an empty headline and the variable
5886 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5887 of the headline by demoting and promoting it to likely levels. This
5888 speeds up creation document structure by pressing TAB once or several
5889 times right after creating a new headline.
5891 - When there is a numeric prefix, go up to a heading with level ARG, do
5892 a `show-subtree' and return to the previous cursor position. If ARG
5893 is negative, go up that many levels.
5895 - When point is not at the beginning of a headline, execute the global
5896 binding for TAB, which is re-indenting the line. See the option
5897 `org-cycle-emulate-tab' for details.
5899 - Special case: if point is at the beginning of the buffer and there is
5900 no headline in line 1, this function will act as if called with prefix arg
5901 (C-u TAB, same as S-TAB) also when called without prefix arg.
5902 But only if also the variable `org-cycle-global-at-bob' is t."
5912 org-inlinetask-min-level
5917 limit-level)))
5920 outline-regexp
5928 org-cycle-hook))
5932 ;; special case: use global cycling
5946 ;; Table: enter it or move to the next field.
5957 ;; Global cycling: delegate to `org-cycle-internal-global'.
5960 ;; Drawers: delegate to `org-flag-drawer'.
5968 ;; Show-subtree, ARG levels up from here.
5976 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5982 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5989 ;; From there: TAB emulation and template completion.
6013 t
6022 "Do the global cycling action."
6026 ;; We just created the overview - now do table of contents
6027 ;; This can be slow in very large buffers, so indicate action
6037 ;; We just showed the table of contents - now show everything
6045 ;; Default action: go to overview
6053 "Do the local cycling action."
6055 ;; First, determine end of headline (EOH), end of subtree or item
6056 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6080 ;; Determine end invisible part of buffer (EOL)
6082 ;; XEmacs doesn't have `next-single-char-property-change'
6092 ;; Find out what to do next and set `this-command'
6095 ;; Nothing is hidden behind this heading
6107 org-cycle-skip-children-state-if-no-children))))
6108 ;; Entire subtree is hidden in one line: children view
6114 ;; Fold every list in subtree to top-level items.
6136 ;; We just showed the children, or no children are there,
6137 ;; now show everything.
6144 ;; Default action: hide the subtree.
6151 ;;;###autoload
6153 "Cycle the global visibility. For details see `org-cycle'.
6155 With a numeric prefix, show all headlines up to that level."
6171 "Set the visibility required by startup options and properties."
6186 "Switch subtree visibilities according to :VISIBILITY: property."
6193 nil t)
6218 "Switch to overview mode, showing only top-level headlines.
6219 Really, this shows all headlines with level equal or greater than the level
6220 of the first headline in the buffer. This is important, because if the
6221 first headline is not level one, then (hide-sublevels 1) gives confusing
6222 results."
6233 "Show all headlines in the buffer, like a table of contents.
6234 With numerical argument N, show content up to level N."
6237 ;; Visit all headings and show their offspring
6244 t)
6253 "Adjust the window after a change in outline visibility.
6254 This function is the default value of the hook `org-cycle-hook'."
6264 "Remove outline overlays that do not contain non-white stuff."
6274 "Fix visibility issues after moving a subtree."
6275 ;; First, find a reasonable region to look at:
6276 ;; Start two siblings above, end three below
6294 ;; Properly fold already folded siblings
6305 "Show empty lines above all visible headlines.
6306 The region to be covered depends on STATE when called through
6307 `org-cycle-hook'. Lisp program can use t for STATE to get the
6308 entire buffer covered. Note that an empty line is only shown if there
6309 are at least `org-cycle-separator-lines' empty lines before the headline."
6319 beg end b e)
6343 ;; Never hide empty lines at the end of the file.
6353 "Move to the parent and re-show empty lines before visible headlines."
6359 "Return `org-agenda-files' list, plus all open org-mode files.
6360 This is useful for operations that need to scan all of a user's
6361 open and agenda-wise Org files."
6369 files))
6372 "Return the beginning position of the current entry."
6376 "Return the end position of the current entry."
6380 "Re-hide all drawers after a visibility state change."
6406 "Is the end of the current subtree visible?"
6411 "Move cursor to the first headline and recenter the headline.
6412 Optional argument N means put the headline into the Nth line of the window."
6418 ;;; Saving and restoring visibility
6421 "Return a list of the locations of all outline overlays.
6422 These are overlays with the `invisible' property value `outline'.
6423 The return value is a list of cons cells, with start and stop
6424 positions for each overlay.
6425 If USE-MARKERS is set, return the positions as markers."
6443 "Create visibility overlays for all positions in DATA.
6444 DATA should have been made by `org-outline-overlay-data'."
6453 data)))))
6455 ;;; Folding of blocks
6466 "Call FUNCTION at the head of all source blocks in the current buffer.
6467 Optional arguments START and END can be used to limit the range."
6479 "Toggle the visibility of all blocks in the current buffer."
6483 "Fold all blocks in the current buffer."
6489 "Unfold all blocks in the current buffer."
6495 "Toggle visibility of block at point."
6506 "Toggle the visibility of the current block."
6513 ov)
6529 ;; make the block accessible to isearch
6531 ov 'isearch-open-invisible
6542 ;; org-tab-after-check-for-cycling-hook
6544 ;; Remove overlays when changing major mode
6549 ;;; Org-goto
6555 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6571 nil)
6572 (org-defkey map "q" 'org-goto-quit)
6573 (org-defkey map "n" 'outline-next-visible-heading)
6574 (org-defkey map "p" 'outline-previous-visible-heading)
6575 (org-defkey map "f" 'outline-forward-same-level)
6576 (org-defkey map "b" 'outline-backward-same-level)
6577 (org-defkey map "u" 'outline-up-heading))
6578 (org-defkey map "/" 'org-occur)
6579 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6580 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6581 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6582 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6583 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6584 map))
6586 (defconst org-goto-help
6587 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6588 RET=jump to location [Q]uit and return to previous location
6589 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6591 (defvar org-goto-start-pos) ; dynamically scoped parameter
6593 ;; FIXME: Docstring does not mention both interfaces
6594 (defun org-goto (&optional alternative-interface)
6595 "Look up a different location in the current file, keeping current visibility.
6597 When you want look-up or go to a different location in a document, the
6598 fastest way is often to fold the entire buffer and then dive into the tree.
6599 This method has the disadvantage, that the previous location will be folded,
6600 which may not be what you want.
6602 This command works around this by showing a copy of the current buffer
6603 in an indirect buffer, in overview mode. You can dive into the tree in
6604 that copy, use org-occur and incremental search to find a location.
6605 When pressing RET or `Q', the command returns to the original buffer in
6606 which the visibility is still unchanged. After RET is will also jump to
6607 the location selected in the indirect buffer and expose the headline
6608 hierarchy above."
6609 (interactive "P")
6610 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6611 (org-refile-use-outline-path t)
6612 (org-refile-target-verify-function nil)
6613 (interface
6614 (if (not alternative-interface)
6615 org-goto-interface
6616 (if (eq org-goto-interface 'outline)
6617 'outline-path-completion
6618 'outline)))
6619 (org-goto-start-pos (point))
6620 (selected-point
6621 (if (eq interface 'outline)
6622 (car (org-get-location (current-buffer) org-goto-help))
6623 (let ((pa (org-refile-get-location "Goto")))
6624 (org-refile-check-position pa)
6625 (nth 3 pa)))))
6626 (if selected-point
6627 (progn
6628 (org-mark-ring-push org-goto-start-pos)
6629 (goto-char selected-point)
6630 (if (or (outline-invisible-p) (org-invisible-p2))
6631 (org-show-context 'org-goto)))
6632 (message "Quit"))))
6634 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6635 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6636 (defvar org-goto-local-auto-isearch-map) ; defined below
6638 (defun org-get-location (buf help)
6639 "Let the user select a location in the Org-mode buffer BUF.
6640 This function uses a recursive edit. It returns the selected position
6641 or nil."
6642 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6643 (isearch-hide-immediately nil)
6644 (isearch-search-fun-function
6645 (lambda () 'org-goto-local-search-headings))
6646 (org-goto-selected-point org-goto-exit-command)
6647 (pop-up-frames nil)
6648 (special-display-buffer-names nil)
6649 (special-display-regexps nil)
6650 (special-display-function nil))
6651 (save-excursion
6652 (save-window-excursion
6653 (delete-other-windows)
6654 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6655 (org-pop-to-buffer-same-window
6656 (condition-case nil
6657 (make-indirect-buffer (current-buffer) "*org-goto*")
6658 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6659 (with-output-to-temp-buffer "*Help*"
6660 (princ help))
6661 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6662 (setq buffer-read-only nil)
6663 (let ((org-startup-truncated t)
6664 (org-startup-folded nil)
6665 (org-startup-align-all-tables nil))
6666 (org-mode)
6667 (org-overview))
6668 (setq buffer-read-only t)
6669 (if (and (boundp 'org-goto-start-pos)
6670 (integer-or-marker-p org-goto-start-pos))
6671 (let ((org-show-hierarchy-above t)
6672 (org-show-siblings t)
6673 (org-show-following-heading t))
6674 (goto-char org-goto-start-pos)
6675 (and (outline-invisible-p) (org-show-context)))
6676 (goto-char (point-min)))
6677 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6678 (message "Select location and press RET")
6679 (use-local-map org-goto-map)
6680 (recursive-edit)
6681 ))
6682 (kill-buffer "*org-goto*")
6683 (cons org-goto-selected-point org-goto-exit-command)))
6685 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6686 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6687 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6688 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6690 (defun org-goto-local-search-headings (string bound noerror)
6691 "Search and make sure that any matches are in headlines."
6692 (catch 'return
6693 (while (if isearch-forward
6694 (search-forward string bound noerror)
6695 (search-backward string bound noerror))
6696 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6697 (and (member :headline context)
6698 (not (member :tags context))))
6699 (throw 'return (point))))))
6701 (defun org-goto-local-auto-isearch ()
6702 "Start isearch."
6703 (interactive)
6704 (goto-char (point-min))
6705 (let ((keys (this-command-keys)))
6706 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6707 (isearch-mode t)
6708 (isearch-process-search-char (string-to-char keys)))))
6710 (defun org-goto-ret (&optional arg)
6711 "Finish `org-goto' by going to the new location."
6712 (interactive "P")
6713 (setq org-goto-selected-point (point)
6714 org-goto-exit-command 'return)
6715 (throw 'exit nil))
6717 (defun org-goto-left ()
6718 "Finish `org-goto' by going to the new location."
6719 (interactive)
6720 (if (org-on-heading-p)
6721 (progn
6722 (beginning-of-line 1)
6723 (setq org-goto-selected-point (point)
6724 org-goto-exit-command 'left)
6725 (throw 'exit nil))
6726 (error "Not on a heading")))
6728 (defun org-goto-right ()
6729 "Finish `org-goto' by going to the new location."
6730 (interactive)
6731 (if (org-on-heading-p)
6732 (progn
6733 (setq org-goto-selected-point (point)
6734 org-goto-exit-command 'right)
6735 (throw 'exit nil))
6736 (error "Not on a heading")))
6738 (defun org-goto-quit ()
6739 "Finish `org-goto' without cursor motion."
6740 (interactive)
6741 (setq org-goto-selected-point nil)
6742 (setq org-goto-exit-command 'quit)
6743 (throw 'exit nil))
6745 ;;; Indirect buffer display of subtrees
6747 (defvar org-indirect-dedicated-frame nil
6748 "This is the frame being used for indirect tree display.")
6749 (defvar org-last-indirect-buffer nil)
6751 (defun org-tree-to-indirect-buffer (&optional arg)
6752 "Create indirect buffer and narrow it to current subtree.
6753 With numerical prefix ARG, go up to this level and then take that tree.
6754 If ARG is negative, go up that many levels.
6755 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6756 indirect buffer previously made with this command, to avoid proliferation of
6757 indirect buffers. However, when you call the command with a \
6759 when `org-indirect-buffer-display' is `new-frame', the last buffer
6760 is kept so that you can work with several indirect buffers at the same time.
6761 If `org-indirect-buffer-display' is `dedicated-frame', the \
6763 requests that a new frame be made for the new buffer, so that the dedicated
6764 frame is not changed."
6765 (interactive "P")
6766 (let ((cbuf (current-buffer))
6767 (cwin (selected-window))
6768 (pos (point))
6769 beg end level heading ibuf)
6770 (save-excursion
6771 (org-back-to-heading t)
6772 (when (numberp arg)
6773 (setq level (org-outline-level))
6774 (if (< arg 0) (setq arg (+ level arg)))
6775 (while (> (setq level (org-outline-level)) arg)
6776 (outline-up-heading 1 t)))
6777 (setq beg (point)
6778 heading (org-get-heading))
6779 (org-end-of-subtree t t)
6780 (if (org-on-heading-p) (backward-char 1))
6781 (setq end (point)))
6782 (if (and (buffer-live-p org-last-indirect-buffer)
6783 (not (eq org-indirect-buffer-display 'new-frame))
6784 (not arg))
6785 (kill-buffer org-last-indirect-buffer))
6786 (setq ibuf (org-get-indirect-buffer cbuf)
6787 org-last-indirect-buffer ibuf)
6788 (cond
6789 ((or (eq org-indirect-buffer-display 'new-frame)
6790 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6791 (select-frame (make-frame))
6792 (delete-other-windows)
6793 (org-pop-to-buffer-same-window ibuf)
6794 (org-set-frame-title heading))
6795 ((eq org-indirect-buffer-display 'dedicated-frame)
6796 (raise-frame
6797 (select-frame (or (and org-indirect-dedicated-frame
6798 (frame-live-p org-indirect-dedicated-frame)
6799 org-indirect-dedicated-frame)
6800 (setq org-indirect-dedicated-frame (make-frame)))))
6801 (delete-other-windows)
6802 (org-pop-to-buffer-same-window ibuf)
6803 (org-set-frame-title (concat "Indirect: " heading)))
6804 ((eq org-indirect-buffer-display 'current-window)
6805 (org-pop-to-buffer-same-window ibuf))
6806 ((eq org-indirect-buffer-display 'other-window)
6807 (pop-to-buffer ibuf))
6808 (t (error "Invalid value")))
6809 (if (featurep 'xemacs)
6810 (save-excursion (org-mode) (turn-on-font-lock)))
6811 (narrow-to-region beg end)
6812 (show-all)
6813 (goto-char pos)
6814 (and (window-live-p cwin) (select-window cwin))))
6816 (defun org-get-indirect-buffer (&optional buffer)
6817 (setq buffer (or buffer (current-buffer)))
6818 (let ((n 1) (base (buffer-name buffer)) bname)
6819 (while (buffer-live-p
6820 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6821 (setq n (1+ n)))
6822 (condition-case nil
6823 (make-indirect-buffer buffer bname 'clone)
6824 (error (make-indirect-buffer buffer bname)))))
6826 (defun org-set-frame-title (title)
6827 "Set the title of the current frame to the string TITLE."
6828 ;; FIXME: how to name a single frame in XEmacs???
6829 (unless (featurep 'xemacs)
6830 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6832 ;;;; Structure editing
6834 ;;; Inserting headlines
6836 (defun org-previous-line-empty-p ()
6837 (save-excursion
6838 (and (not (bobp))
6839 (or (beginning-of-line 0) t)
6840 (save-match-data
6843 (defun org-insert-heading (&optional force-heading invisible-ok)
6844 "Insert a new heading or item with same depth at point.
6845 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6846 If point is at the beginning of a headline, insert a sibling before the
6847 current headline. If point is not at the beginning, split the line,
6848 create the new headline with the text in the current line after point
6849 \(but see also the variable `org-M-RET-may-split-line').
6851 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6852 This is important for non-interactive uses of the command."
6853 (interactive "P")
6854 (if (or (= (buffer-size) 0)
6855 (and (not (save-excursion
6856 (and (ignore-errors (org-back-to-heading invisible-ok))
6857 (org-on-heading-p))))
6858 (not (org-in-item-p))))
6859 (progn
6861 (run-hooks 'org-insert-heading-hook))
6862 (when (or force-heading (not (org-insert-item)))
6863 (let* ((empty-line-p nil)
6864 (level nil)
6865 (on-heading (org-on-heading-p))
6866 (head (save-excursion
6867 (condition-case nil
6868 (progn
6869 (org-back-to-heading invisible-ok)
6870 (when (and (not on-heading)
6871 (featurep 'org-inlinetask)
6872 (integerp org-inlinetask-min-level)
6873 (>= (length (match-string 0))
6874 org-inlinetask-min-level))
6875 ;; Find a heading level before the inline task
6876 (while (and (setq level (org-up-heading-safe))
6877 (>= level org-inlinetask-min-level)))
6878 (if (org-on-heading-p)
6879 (org-back-to-heading invisible-ok)
6880 (error "This should not happen")))
6881 (setq empty-line-p (org-previous-line-empty-p))
6882 (match-string 0))
6883 (error "*"))))
6884 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6885 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6886 pos hide-previous previous-pos)
6887 (cond
6888 ((and (org-on-heading-p) (bolp)
6889 (or (bobp)
6890 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6891 ;; insert before the current line
6892 (open-line (if blank 2 1)))
6893 ((and (bolp)
6894 (not org-insert-heading-respect-content)
6895 (or (bobp)
6896 (save-excursion
6897 (backward-char 1) (not (outline-invisible-p)))))
6898 ;; insert right here
6899 nil)
6900 (t
6901 ;; somewhere in the line
6902 (save-excursion
6903 (setq previous-pos (point-at-bol))
6904 (end-of-line)
6905 (setq hide-previous (outline-invisible-p)))
6906 (and org-insert-heading-respect-content (org-show-subtree))
6907 (let ((split
6908 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6909 (save-excursion
6910 (let ((p (point)))
6911 (goto-char (point-at-bol))
6912 (and (looking-at org-complex-heading-regexp)
6913 (> p (match-beginning 4)))))))
6914 tags pos)
6915 (cond
6916 (org-insert-heading-respect-content
6917 (org-end-of-subtree nil t)
6918 (when (featurep 'org-inlinetask)
6919 (while (and (not (eobp))
6921 (>= (length (match-string 1))
6922 org-inlinetask-min-level))
6923 (org-end-of-subtree nil t)))
6924 (or (bolp) (newline))
6925 (or (org-previous-line-empty-p)
6926 (and blank (newline)))
6927 (open-line 1))
6928 ((org-on-heading-p)
6929 (when hide-previous
6930 (show-children)
6931 (org-show-entry))
6933 (setq tags (and (match-end 2) (match-string 2)))
6934 (and (match-end 1)
6935 (delete-region (match-beginning 1) (match-end 1)))
6936 (setq pos (point-at-bol))
6937 (or split (end-of-line 1))
6938 (delete-horizontal-space)
6940 (buffer-substring (point-at-bol) (point)))
6941 (insert " "))
6942 (newline (if blank 2 1))
6943 (when tags
6944 (save-excursion
6945 (goto-char pos)
6946 (end-of-line 1)
6947 (insert " " tags)
6948 (org-set-tags nil 'align))))
6949 (t
6950 (or split (end-of-line 1))
6951 (newline (if blank 2 1)))))))
6952 (insert head) (just-one-space)
6953 (setq pos (point))
6954 (end-of-line 1)
6955 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6956 (when (and org-insert-heading-respect-content hide-previous)
6957 (save-excursion
6958 (goto-char previous-pos)
6959 (hide-subtree)))
6960 (run-hooks 'org-insert-heading-hook)))))
6962 (defun org-get-heading (&optional no-tags no-todo)
6963 "Return the heading of the current entry, without the stars.
6964 When NO-TAGS is non-nil, don't include tags.
6965 When NO-TODO is non-nil, don't include TODO keywords."
6966 (save-excursion
6967 (org-back-to-heading t)
6968 (cond
6969 ((and no-tags no-todo)
6970 (looking-at org-complex-heading-regexp)
6971 (match-string 4))
6972 (no-tags
6974 (match-string 1))
6975 (no-todo
6978 (match-string 2))
6980 (match-string 1)))))
6982 (defun org-heading-components ()
6983 "Return the components of the current heading.
6984 This is a list with the following elements:
6985 - the level as an integer
6986 - the reduced level, different if `org-odd-levels-only' is set.
6987 - the TODO keyword, or nil
6988 - the priority character, like ?A, or nil if no priority is given
6989 - the headline text itself, or the tags string if no headline text
6990 - the tags string, or nil."
6991 (save-excursion
6992 (org-back-to-heading t)
6993 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6994 (list (length (match-string 1))
6995 (org-reduced-level (length (match-string 1)))
6996 (org-match-string-no-properties 2)
6997 (and (match-end 3) (aref (match-string 3) 2))
6998 (org-match-string-no-properties 4)
6999 (org-match-string-no-properties 5)))))
7001 (defun org-get-entry ()
7002 "Get the entry text, after heading, entire subtree."
7003 (save-excursion
7004 (org-back-to-heading t)
7005 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7007 (defun org-insert-heading-after-current ()
7008 "Insert a new heading with same level as current, after current subtree."
7009 (interactive)
7010 (org-back-to-heading)
7011 (org-insert-heading)
7012 (org-move-subtree-down)
7013 (end-of-line 1))
7015 (defun org-insert-heading-respect-content ()
7016 (interactive)
7017 (let ((org-insert-heading-respect-content t))
7018 (org-insert-heading t)))
7020 (defun org-insert-todo-heading-respect-content (&optional force-state)
7021 (interactive "P")
7022 (let ((org-insert-heading-respect-content t))
7023 (org-insert-todo-heading force-state t)))
7025 (defun org-insert-todo-heading (arg &optional force-heading)
7026 "Insert a new heading with the same level and TODO state as current heading.
7027 If the heading has no TODO state, or if the state is DONE, use the first
7028 state (TODO by default). Also with prefix arg, force first state."
7029 (interactive "P")
7030 (when (or force-heading (not (org-insert-item 'checkbox)))
7031 (org-insert-heading force-heading)
7032 (save-excursion
7033 (org-back-to-heading)
7034 (outline-previous-heading)
7035 (looking-at org-todo-line-regexp))
7036 (let*
7037 ((new-mark-x
7038 (if (or arg
7039 (not (match-beginning 2))
7040 (member (match-string 2) org-done-keywords))
7041 (car org-todo-keywords-1)
7042 (match-string 2)))
7043 (new-mark
7044 (or
7045 (run-hook-with-args-until-success
7046 'org-todo-get-default-hook new-mark-x nil)
7047 new-mark-x)))
7048 (beginning-of-line 1)
7049 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7050 (if org-treat-insert-todo-heading-as-state-change
7051 (org-todo new-mark)
7052 (insert new-mark " "))))
7053 (when org-provide-todo-statistics
7054 (org-update-parent-todo-statistics))))
7056 (defun org-insert-subheading (arg)
7057 "Insert a new subheading and demote it.
7058 Works for outline headings and for plain lists alike."
7059 (interactive "P")
7060 (org-insert-heading arg)
7061 (cond
7062 ((org-on-heading-p) (org-do-demote))
7063 ((org-at-item-p) (org-indent-item))))
7065 (defun org-insert-todo-subheading (arg)
7066 "Insert a new subheading with TODO keyword or checkbox and demote it.
7067 Works for outline headings and for plain lists alike."
7068 (interactive "P")
7069 (org-insert-todo-heading arg)
7070 (cond
7071 ((org-on-heading-p) (org-do-demote))
7072 ((org-at-item-p) (org-indent-item))))
7074 ;;; Promotion and Demotion
7076 (defvar org-after-demote-entry-hook nil
7077 "Hook run after an entry has been demoted.
7078 The cursor will be at the beginning of the entry.
7079 When a subtree is being demoted, the hook will be called for each node.")
7081 (defvar org-after-promote-entry-hook nil
7082 "Hook run after an entry has been promoted.
7083 The cursor will be at the beginning of the entry.
7084 When a subtree is being promoted, the hook will be called for each node.")
7086 (defun org-promote-subtree ()
7087 "Promote the entire subtree.
7088 See also `org-promote'."
7089 (interactive)
7090 (save-excursion
7091 (org-with-limited-levels (org-map-tree 'org-promote)))
7092 (org-fix-position-after-promote))
7094 (defun org-demote-subtree ()
7095 "Demote the entire subtree. See `org-demote'.
7096 See also `org-promote'."
7097 (interactive)
7098 (save-excursion
7099 (org-with-limited-levels (org-map-tree 'org-demote)))
7100 (org-fix-position-after-promote))
7103 (defun org-do-promote ()
7104 "Promote the current heading higher up the tree.
7105 If the region is active in `transient-mark-mode', promote all headings
7106 in the region."
7107 (interactive)
7108 (save-excursion
7109 (if (org-region-active-p)
7110 (org-map-region 'org-promote (region-beginning) (region-end))
7111 (org-promote)))
7112 (org-fix-position-after-promote))
7114 (defun org-do-demote ()
7115 "Demote the current heading lower down the tree.
7116 If the region is active in `transient-mark-mode', demote all headings
7117 in the region."
7118 (interactive)
7119 (save-excursion
7120 (if (org-region-active-p)
7121 (org-map-region 'org-demote (region-beginning) (region-end))
7122 (org-demote)))
7123 (org-fix-position-after-promote))
7125 (defun org-fix-position-after-promote ()
7126 "Make sure that after pro/demotion cursor position is right."
7127 (let ((pos (point)))
7128 (when (save-excursion
7129 (beginning-of-line 1)
7130 (looking-at org-todo-line-regexp)
7131 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7132 (cond ((eobp) (insert " "))
7133 ((eolp) (insert " "))
7134 ((equal (char-after) ?\ ) (forward-char 1))))))
7136 (defun org-current-level ()
7137 "Return the level of the current entry, or nil if before the first headline.
7138 The level is the number of stars at the beginning of the headline."
7139 (save-excursion
7140 (org-with-limited-levels
7141 (ignore-errors
7142 (org-back-to-heading t)
7143 (funcall outline-level)))))
7145 (defun org-get-previous-line-level ()
7146 "Return the outline depth of the last headline before the current line.
7147 Returns 0 for the first headline in the buffer, and nil if before the
7148 first headline."
7149 (let ((current-level (org-current-level))
7150 (prev-level (when (> (line-number-at-pos) 1)
7151 (save-excursion
7152 (beginning-of-line 0)
7153 (org-current-level)))))
7154 (cond ((null current-level) nil) ; Before first headline
7155 ((null prev-level) 0) ; At first headline
7156 (prev-level))))
7158 (defun org-reduced-level (l)
7159 "Compute the effective level of a heading.
7160 This takes into account the setting of `org-odd-levels-only'."
7161 (cond
7162 ((zerop l) 0)
7163 (org-odd-levels-only (1+ (floor (/ l 2))))
7164 (t l)))
7166 (defun org-level-increment ()
7167 "Return the number of stars that will be added or removed at a
7168 time to headlines when structure editing, based on the value of
7169 `org-odd-levels-only'."
7170 (if org-odd-levels-only 2 1))
7172 (defun org-get-valid-level (level &optional change)
7173 "Rectify a level change under the influence of `org-odd-levels-only'
7174 LEVEL is a current level, CHANGE is by how much the level should be
7175 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7176 even level numbers will become the next higher odd number."
7177 (if org-odd-levels-only
7178 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7179 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7180 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7181 (max 1 (+ level (or change 0)))))
7183 (if (boundp 'define-obsolete-function-alias)
7184 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7185 (define-obsolete-function-alias 'org-get-legal-level
7186 'org-get-valid-level)
7187 (define-obsolete-function-alias 'org-get-legal-level
7188 'org-get-valid-level "23.1")))
7190 (defun org-promote ()
7191 "Promote the current heading higher up the tree.
7192 If the region is active in `transient-mark-mode', promote all headings
7193 in the region."
7194 (org-back-to-heading t)
7195 (let* ((level (save-match-data (funcall outline-level)))
7196 (after-change-functions (remove 'flyspell-after-change-function
7197 after-change-functions))
7198 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7199 (diff (abs (- level (length up-head) -1))))
7200 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7201 (replace-match up-head nil t)
7202 ;; Fixup tag positioning
7203 (and org-auto-align-tags (org-set-tags nil t))
7204 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7205 (run-hooks 'org-after-promote-entry-hook)))
7207 (defun org-demote ()
7208 "Demote the current heading lower down the tree.
7209 If the region is active in `transient-mark-mode', demote all headings
7210 in the region."
7211 (org-back-to-heading t)
7212 (let* ((level (save-match-data (funcall outline-level)))
7213 (after-change-functions (remove 'flyspell-after-change-function
7214 after-change-functions))
7215 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7216 (diff (abs (- level (length down-head) -1))))
7217 (replace-match down-head nil t)
7218 ;; Fixup tag positioning
7219 (and org-auto-align-tags (org-set-tags nil t))
7220 (if org-adapt-indentation (org-fixup-indentation diff))
7221 (run-hooks 'org-after-demote-entry-hook)))
7223 (defun org-cycle-level ()
7224 "Cycle the level of an empty headline through possible states.
7225 This goes first to child, then to parent, level, then up the hierarchy.
7226 After top level, it switches back to sibling level."
7227 (interactive)
7228 (let ((org-adapt-indentation nil))
7229 (when (org-point-at-end-of-empty-headline)
7230 (setq this-command 'org-cycle-level) ; Only needed for caching
7231 (let ((cur-level (org-current-level))
7232 (prev-level (org-get-previous-line-level)))
7233 (cond
7234 ;; If first headline in file, promote to top-level.
7235 ((= prev-level 0)
7236 (loop repeat (/ (- cur-level 1) (org-level-increment))
7237 do (org-do-promote)))
7238 ;; If same level as prev, demote one.
7239 ((= prev-level cur-level)
7240 (org-do-demote))
7241 ;; If parent is top-level, promote to top level if not already.
7242 ((= prev-level 1)
7243 (loop repeat (/ (- cur-level 1) (org-level-increment))
7244 do (org-do-promote)))
7245 ;; If top-level, return to prev-level.
7246 ((= cur-level 1)
7247 (loop repeat (/ (- prev-level 1) (org-level-increment))
7248 do (org-do-demote)))
7249 ;; If less than prev-level, promote one.
7250 ((< cur-level prev-level)
7251 (org-do-promote))
7252 ;; If deeper than prev-level, promote until higher than
7253 ;; prev-level.
7254 ((> cur-level prev-level)
7255 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7256 do (org-do-promote))))
7257 t))))
7259 (defun org-map-tree (fun)
7260 "Call FUN for every heading underneath the current one."
7261 (org-back-to-heading)
7262 (let ((level (funcall outline-level)))
7263 (save-excursion
7264 (funcall fun)
7265 (while (and (progn
7266 (outline-next-heading)
7267 (> (funcall outline-level) level))
7268 (not (eobp)))
7269 (funcall fun)))))
7271 (defun org-map-region (fun beg end)
7272 "Call FUN for every heading between BEG and END."
7273 (let ((org-ignore-region t))
7274 (save-excursion
7275 (setq end (copy-marker end))
7276 (goto-char beg)
7277 (if (and (re-search-forward org-outline-regexp-bol nil t)
7278 (< (point) end))
7279 (funcall fun))
7280 (while (and (progn
7281 (outline-next-heading)
7282 (< (point) end))
7283 (not (eobp)))
7284 (funcall fun)))))
7286 (defun org-fixup-indentation (diff)
7287 "Change the indentation in the current entry by DIFF.
7288 However, if any line in the current entry has no indentation, or if it
7289 would end up with no indentation after the change, nothing at all is done."
7290 (save-excursion
7291 (let ((end (save-excursion (outline-next-heading)
7292 (point-marker)))
7293 (prohibit (if (> diff 0)
7296 col)
7297 (unless (save-excursion (end-of-line 1)
7298 (re-search-forward prohibit end t))
7299 (while (and (< (point) end)
7301 (goto-char (match-end 0))
7302 (setq col (current-column))
7303 (if (< diff 0) (replace-match ""))
7304 (org-indent-to-column (+ diff col))))
7305 (move-marker end nil))))
7307 (defun org-convert-to-odd-levels ()
7308 "Convert an org-mode file with all levels allowed to one with odd levels.
7309 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7310 level 5 etc."
7311 (interactive)
7312 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7313 (let ((outline-level 'org-outline-level)
7314 (org-odd-levels-only nil) n)
7315 (save-excursion
7316 (goto-char (point-min))
7318 (setq n (- (length (match-string 0)) 2))
7319 (while (>= (setq n (1- n)) 0)
7320 (org-demote))
7321 (end-of-line 1))))))
7323 (defun org-convert-to-oddeven-levels ()
7324 "Convert an org-mode file with only odd levels to one with odd/even levels.
7325 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7326 file contains a section with an even level, conversion would
7327 destroy the structure of the file. An error is signaled in this
7328 case."
7329 (interactive)
7330 (goto-char (point-min))
7331 ;; First check if there are no even levels
7333 (org-show-context t)
7334 (error "Not all levels are odd in this file. Conversion not possible"))
7335 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7336 (let ((outline-regexp org-outline-regexp)
7337 (outline-level 'org-outline-level)
7338 (org-odd-levels-only nil) n)
7339 (save-excursion
7340 (goto-char (point-min))
7342 (setq n (/ (1- (length (match-string 0))) 2))
7343 (while (>= (setq n (1- n)) 0)
7344 (org-promote))
7345 (end-of-line 1))))))
7347 (defun org-tr-level (n)
7348 "Make N odd if required."
7349 (if org-odd-levels-only (1+ (/ n 2)) n))
7351 ;;; Vertical tree motion, cutting and pasting of subtrees
7353 (defun org-move-subtree-up (&optional arg)
7354 "Move the current subtree up past ARG headlines of the same level."
7355 (interactive "p")
7356 (org-move-subtree-down (- (prefix-numeric-value arg))))
7358 (defun org-move-subtree-down (&optional arg)
7359 "Move the current subtree down past ARG headlines of the same level."
7360 (interactive "p")
7361 (setq arg (prefix-numeric-value arg))
7362 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7363 'org-get-last-sibling))
7364 (ins-point (make-marker))
7365 (cnt (abs arg))
7366 (col (current-column))
7367 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7368 ;; Select the tree
7369 (org-back-to-heading)
7370 (setq beg0 (point))
7371 (save-excursion
7372 (setq ne-beg (org-back-over-empty-lines))
7373 (setq beg (point)))
7374 (save-match-data
7375 (save-excursion (outline-end-of-heading)
7376 (setq folded (outline-invisible-p)))
7377 (outline-end-of-subtree))
7378 (outline-next-heading)
7379 (setq ne-end (org-back-over-empty-lines))
7380 (setq end (point))
7381 (goto-char beg0)
7382 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7383 ;; include less whitespace
7384 (save-excursion
7385 (goto-char beg)
7386 (forward-line (- ne-beg ne-end))
7387 (setq beg (point))))
7388 ;; Find insertion point, with error handling
7389 (while (> cnt 0)
7390 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7391 (progn (goto-char beg0)
7392 (error "Cannot move past superior level or buffer limit")))
7393 (setq cnt (1- cnt)))
7394 (if (> arg 0)
7395 ;; Moving forward - still need to move over subtree
7396 (progn (org-end-of-subtree t t)
7397 (save-excursion
7398 (org-back-over-empty-lines)
7399 (or (bolp) (newline)))))
7400 (setq ne-ins (org-back-over-empty-lines))
7401 (move-marker ins-point (point))
7402 (setq txt (buffer-substring beg end))
7403 (org-save-markers-in-region beg end)
7404 (delete-region beg end)
7405 (org-remove-empty-overlays-at beg)
7406 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7407 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7409 (let ((bbb (point)))
7410 (insert-before-markers txt)
7411 (org-reinstall-markers-in-region bbb)
7412 (move-marker ins-point bbb))
7414 (setq ins-end (point))
7415 (goto-char ins-point)
7416 (org-skip-whitespace)
7417 (when (and (< arg 0)
7418 (org-first-sibling-p)
7419 (> ne-ins ne-beg))
7420 ;; Move whitespace back to beginning
7421 (save-excursion
7422 (goto-char ins-end)
7423 (let ((kill-whole-line t))
7424 (kill-line (- ne-ins ne-beg)) (point)))
7426 (move-marker ins-point nil)
7427 (if folded
7428 (hide-subtree)
7429 (org-show-entry)
7430 (show-children)
7431 (org-cycle-hide-drawers 'children))
7432 (org-clean-visibility-after-subtree-move)
7433 ;; move back to the initial column we were at
7434 (move-to-column col)))
7436 (defvar org-subtree-clip ""
7437 "Clipboard for cut and paste of subtrees.
7438 This is actually only a copy of the kill, because we use the normal kill
7439 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7441 (defvar org-subtree-clip-folded nil
7442 "Was the last copied subtree folded?
7443 This is used to fold the tree back after pasting.")
7445 (defun org-cut-subtree (&optional n)
7446 "Cut the current subtree into the clipboard.
7447 With prefix arg N, cut this many sequential subtrees.
7448 This is a short-hand for marking the subtree and then cutting it."
7449 (interactive "p")
7450 (org-copy-subtree n 'cut))
7452 (defun org-copy-subtree (&optional n cut force-store-markers)
7453 "Cut the current subtree into the clipboard.
7454 With prefix arg N, cut this many sequential subtrees.
7455 This is a short-hand for marking the subtree and then copying it.
7456 If CUT is non-nil, actually cut the subtree.
7457 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7458 of some markers in the region, even if CUT is non-nil. This is
7459 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7460 (interactive "p")
7461 (let (beg end folded (beg0 (point)))
7462 (if (org-called-interactively-p 'any)
7463 (org-back-to-heading nil) ; take what looks like a subtree
7464 (org-back-to-heading t)) ; take what is really there
7465 (org-back-over-empty-lines)
7466 (setq beg (point))
7468 (save-match-data
7469 (save-excursion (outline-end-of-heading)
7470 (setq folded (outline-invisible-p)))
7471 (condition-case nil
7472 (org-forward-same-level (1- n) t)
7473 (error nil))
7474 (org-end-of-subtree t t))
7475 (org-back-over-empty-lines)
7476 (setq end (point))
7477 (goto-char beg0)
7478 (when (> end beg)
7479 (setq org-subtree-clip-folded folded)
7480 (when (or cut force-store-markers)
7481 (org-save-markers-in-region beg end))
7482 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7483 (setq org-subtree-clip (current-kill 0))
7484 (message "%s: Subtree(s) with %d characters"
7485 (if cut "Cut" "Copied")
7486 (length org-subtree-clip)))))
7488 (defun org-paste-subtree (&optional level tree for-yank)
7489 "Paste the clipboard as a subtree, with modification of headline level.
7490 The entire subtree is promoted or demoted in order to match a new headline
7491 level.
7493 If the cursor is at the beginning of a headline, the same level as
7494 that headline is used to paste the tree
7496 If not, the new level is derived from the *visible* headings
7497 before and after the insertion point, and taken to be the inferior headline
7498 level of the two. So if the previous visible heading is level 3 and the
7499 next is level 4 (or vice versa), level 4 will be used for insertion.
7500 This makes sure that the subtree remains an independent subtree and does
7501 not swallow low level entries.
7503 You can also force a different level, either by using a numeric prefix
7504 argument, or by inserting the heading marker by hand. For example, if the
7507 If optional TREE is given, use this text instead of the kill ring.
7509 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7510 move back over whitespace before inserting, and move point to the end of
7511 the inserted text when done."
7512 (interactive "P")
7513 (setq tree (or tree (and kill-ring (current-kill 0))))
7514 (unless (org-kill-is-subtree-p tree)
7515 (error "%s"
7516 (substitute-command-keys
7518 (org-with-limited-levels
7519 (let* ((visp (not (outline-invisible-p)))
7520 (txt tree)
7522 (old-level (if (string-match org-outline-regexp-bol txt)
7523 (- (match-end 0) (match-beginning 0) 1)
7524 -1))
7525 (force-level (cond (level (prefix-numeric-value level))
7527 (string-match
7528 ^re_ (buffer-substring
7529 (point-at-bol) (point))))
7530 (- (match-end 1) (match-beginning 1)))
7531 ((and (bolp)
7532 (looking-at org-outline-regexp))
7533 (- (match-end 0) (point) 1))
7534 (t nil)))
7535 (previous-level (save-excursion
7536 (condition-case nil
7537 (progn
7538 (outline-previous-visible-heading 1)
7539 (if (looking-at re)
7540 (- (match-end 0) (match-beginning 0) 1)
7541 1))
7542 (error 1))))
7543 (next-level (save-excursion
7544 (condition-case nil
7545 (progn
7546 (or (looking-at org-outline-regexp)
7547 (outline-next-visible-heading 1))
7548 (if (looking-at re)
7549 (- (match-end 0) (match-beginning 0) 1)
7550 1))
7551 (error 1))))
7552 (new-level (or force-level (max previous-level next-level)))
7553 (shift (if (or (= old-level -1)
7554 (= new-level -1)
7555 (= old-level new-level))
7556 0
7557 (- new-level old-level)))
7558 (delta (if (> shift 0) -1 1))
7559 (func (if (> shift 0) 'org-demote 'org-promote))
7560 (org-odd-levels-only nil)
7561 beg end newend)
7562 ;; Remove the forced level indicator
7563 (if force-level
7564 (delete-region (point-at-bol) (point)))
7565 ;; Paste
7566 (beginning-of-line 1)
7567 (unless for-yank (org-back-over-empty-lines))
7568 (setq beg (point))
7569 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7570 (insert-before-markers txt)
7572 (setq newend (point))
7573 (org-reinstall-markers-in-region beg)
7574 (setq end (point))
7575 (goto-char beg)
7577 (setq beg (point))
7578 (if (and (outline-invisible-p) visp)
7579 (save-excursion (outline-show-heading)))
7580 ;; Shift if necessary
7581 (unless (= shift 0)
7582 (save-restriction
7583 (narrow-to-region beg end)
7584 (while (not (= shift 0))
7585 (org-map-region func (point-min) (point-max))
7586 (setq shift (+ delta shift)))
7587 (goto-char (point-min))
7588 (setq newend (point-max))))
7589 (when (or (org-called-interactively-p 'interactive) for-yank)
7590 (message "Clipboard pasted as level %d subtree" new-level))
7591 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7592 kill-ring
7593 (eq org-subtree-clip (current-kill 0))
7594 org-subtree-clip-folded)
7595 ;; The tree was folded before it was killed/copied
7596 (hide-subtree))
7597 (and for-yank (goto-char newend)))))
7599 (defun org-kill-is-subtree-p (&optional txt)
7600 "Check if the current kill is an outline subtree, or a set of trees.
7601 Returns nil if kill does not start with a headline, or if the first
7602 headline level is not the largest headline level in the tree.
7603 So this will actually accept several entries of equal levels as well,
7604 which is OK for `org-paste-subtree'.
7605 If optional TXT is given, check this string instead of the current kill."
7606 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7607 (re (org-get-limited-outline-regexp))
7608 (^re (concat "^" re))
7609 (start-level (and kill
7610 (string-match
7612 kill)
7613 (- (match-end 2) (match-beginning 2) 1)))
7614 (start (1+ (or (match-beginning 2) -1))))
7615 (if (not start-level)
7616 (progn
7617 nil) ;; does not even start with a heading
7618 (catch 'exit
7619 (while (setq start (string-match ^re kill (1+ start)))
7620 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7621 (throw 'exit nil)))
7622 t))))
7624 (defvar org-markers-to-move nil
7625 "Markers that should be moved with a cut-and-paste operation.
7626 Those markers are stored together with their positions relative to
7627 the start of the region.")
7629 (defun org-save-markers-in-region (beg end)
7630 "Check markers in region.
7631 If these markers are between BEG and END, record their position relative
7632 to BEG, so that after moving the block of text, we can put the markers back
7633 into place.
7634 This function gets called just before an entry or tree gets cut from the
7635 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7636 called immediately, to move the markers with the entries."
7637 (setq org-markers-to-move nil)
7638 (when (featurep 'org-clock)
7639 (org-clock-save-markers-for-cut-and-paste beg end))
7640 (when (featurep 'org-agenda)
7641 (org-agenda-save-markers-for-cut-and-paste beg end)))
7643 (defun org-check-and-save-marker (marker beg end)
7644 "Check if MARKER is between BEG and END.
7645 If yes, remember the marker and the distance to BEG."
7646 (when (and (marker-buffer marker)
7647 (equal (marker-buffer marker) (current-buffer)))
7648 (if (and (>= marker beg) (< marker end))
7649 (push (cons marker (- marker beg)) org-markers-to-move))))
7651 (defun org-reinstall-markers-in-region (beg)
7652 "Move all remembered markers to their position relative to BEG."
7653 (mapc (lambda (x)
7654 (move-marker (car x) (+ beg (cdr x))))
7655 org-markers-to-move)
7656 (setq org-markers-to-move nil))
7658 (defun org-narrow-to-subtree ()
7659 "Narrow buffer to the current subtree."
7660 (interactive)
7661 (save-excursion
7662 (save-match-data
7663 (org-with-limited-levels
7664 (narrow-to-region
7665 (progn (org-back-to-heading t) (point))
7666 (progn (org-end-of-subtree t t)
7667 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7668 (point)))))))
7670 (defun org-narrow-to-block ()
7671 "Narrow buffer to the current block."
7672 (interactive)
7673 (let* ((case-fold-search t)
7676 (if blockp
7677 (narrow-to-region (car blockp) (cdr blockp))
7678 (error "Not in a block"))))
7680 (eval-when-compile
7681 (defvar org-property-drawer-re))
7683 (defvar org-property-start-re) ;; defined below
7684 (defun org-clone-subtree-with-time-shift (n &optional shift)
7685 "Clone the task (subtree) at point N times.
7686 The clones will be inserted as siblings.
7688 In interactive use, the user will be prompted for the number of
7689 clones to be produced, and for a time SHIFT, which may be a
7690 repeater as used in time stamps, for example `+3d'.
7692 When a valid repeater is given and the entry contains any time
7693 stamps, the clones will become a sequence in time, with time
7694 stamps in the subtree shifted for each clone produced. If SHIFT
7695 is nil or the empty string, time stamps will be left alone. The
7696 ID property of the original subtree is removed.
7698 If the original subtree did contain time stamps with a repeater,
7699 the following will happen:
7700 - the repeater will be removed in each clone
7701 - an additional clone will be produced, with the current, unshifted
7702 date(s) in the entry.
7703 - the original entry will be placed *after* all the clones, with
7704 repeater intact.
7705 - the start days in the repeater in the original entry will be shifted
7706 to past the last clone.
7707 I this way you can spell out a number of instances of a repeating task,
7708 and still retain the repeater to cover future instances of the task."
7709 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7710 (let (beg end template task idprop
7711 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7712 (if (not (and (integerp n) (> n 0)))
7713 (error "Invalid number of replications %s" n))
7716 shift)))
7717 (error "Invalid shift specification %s" shift))
7718 (when doshift
7719 (setq shift-n (string-to-number (match-string 1 shift))
7720 shift-what (cdr (assoc (match-string 2 shift)
7721 '(("d" . day) ("w" . week)
7722 ("m" . month) ("y" . year))))))
7723 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7724 (setq nmin 1 nmax n)
7725 (org-back-to-heading t)
7726 (setq beg (point))
7727 (setq idprop (org-entry-get nil "ID"))
7728 (org-end-of-subtree t t)
7730 (setq end (point))
7731 (setq template (buffer-substring beg end))
7732 ;; Remove clocks and empty drawers
7733 (with-temp-buffer
7734 (insert template)
7735 (goto-char (point-min))
7736 (while (re-search-forward
7738 (replace-match "")
7739 (kill-whole-line))
7740 (goto-char (point-min))
7741 (while (re-search-forward
7743 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7744 (setq template (buffer-substring (point-min) (point-max))))
7745 (when (and doshift
7747 (delete-region beg end)
7748 (setq end beg)
7749 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7750 (goto-char end)
7751 (loop for n from nmin to nmax do
7752 ;; prepare clone
7753 (with-temp-buffer
7754 (insert template)
7755 (org-mode)
7756 (goto-char (point-min))
7757 (and idprop (if org-clone-delete-id
7758 (org-entry-delete nil "ID")
7759 (org-id-get-create t)))
7760 (while (re-search-forward org-property-start-re nil t)
7761 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7762 (goto-char (point-min))
7763 (when doshift
7764 (while (re-search-forward org-ts-regexp-both nil t)
7765 (org-timestamp-change (* n shift-n) shift-what))
7766 (unless (= n n-no-remove)
7767 (goto-char (point-min))
7768 (while (re-search-forward org-ts-regexp nil t)
7769 (save-excursion
7770 (goto-char (match-beginning 0))
7772 (delete-region (match-beginning 1) (match-end 1)))))))
7773 (setq task (buffer-string)))
7774 (insert task))
7775 (goto-char beg)))
7777 ;;; Outline Sorting
7779 (defun org-sort (with-case)
7780 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7781 Optional argument WITH-CASE means sort case-sensitively.
7782 With a double prefix argument, also remove duplicate entries."
7783 (interactive "P")
7784 (cond
7785 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7786 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7787 (t
7788 (org-call-with-arg 'org-sort-entries with-case))))
7790 (defun org-sort-remove-invisible (s)
7791 (remove-text-properties 0 (length s) org-rm-props s)
7792 (while (string-match org-bracket-link-regexp s)
7793 (setq s (replace-match (if (match-end 2)
7794 (match-string 3 s)
7795 (match-string 1 s)) t t s)))
7796 s)
7798 (defvar org-priority-regexp) ; defined later in the file
7800 (defvar org-after-sorting-entries-or-items-hook nil
7801 "Hook that is run after a bunch of entries or items have been sorted.
7802 When children are sorted, the cursor is in the parent line when this
7803 hook gets called. When a region or a plain list is sorted, the cursor
7804 will be in the first entry of the sorted region/list.")
7806 (defun org-sort-entries
7807 (&optional with-case sorting-type getkey-func compare-func property)
7808 "Sort entries on a certain level of an outline tree.
7809 If there is an active region, the entries in the region are sorted.
7810 Else, if the cursor is before the first entry, sort the top-level items.
7811 Else, the children of the entry at point are sorted.
7813 Sorting can be alphabetically, numerically, by date/time as given by
7814 a time stamp, by a property or by priority.
7816 The command prompts for the sorting type unless it has been given to the
7817 function through the SORTING-TYPE argument, which needs to be a character,
7818 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7819 precise meaning of each character:
7821 n Numerically, by converting the beginning of the entry/item to a number.
7822 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7823 t By date/time, either the first active time stamp in the entry, or, if
7824 none exist, by the first inactive one.
7825 s By the scheduled date/time.
7826 d By deadline date/time.
7827 c By creation time, which is assumed to be the first inactive time stamp
7828 at the beginning of a line.
7829 p By priority according to the cookie.
7830 r By the value of a property.
7832 Capital letters will reverse the sort order.
7834 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7835 called with point at the beginning of the record. It must return either
7836 a string or a number that should serve as the sorting key for that record.
7838 Comparing entries ignores case by default. However, with an optional argument
7839 WITH-CASE, the sorting considers case as well."
7840 (interactive "P")
7841 (let ((case-func (if with-case 'identity 'downcase))
7842 start beg end stars re re2
7843 txt what tmp)
7844 ;; Find beginning and end of region to sort
7845 (cond
7846 ((org-region-active-p)
7847 ;; we will sort the region
7848 (setq end (region-end)
7849 what "region")
7850 (goto-char (region-beginning))
7851 (if (not (org-on-heading-p)) (outline-next-heading))
7852 (setq start (point)))
7853 ((or (org-on-heading-p)
7854 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7855 ;; we will sort the children of the current headline
7856 (org-back-to-heading)
7857 (setq start (point)
7858 end (progn (org-end-of-subtree t t)
7860 (org-back-over-empty-lines)
7861 (point))
7862 what "children")
7863 (goto-char start)
7864 (show-subtree)
7865 (outline-next-heading))
7866 (t
7867 ;; we will sort the top-level entries in this file
7868 (goto-char (point-min))
7869 (or (org-on-heading-p) (outline-next-heading))
7870 (setq start (point))
7871 (goto-char (point-max))
7872 (beginning-of-line 1)
7874 ;; File ends in a non-white line
7875 (end-of-line 1)
7877 (setq end (point-max))
7878 (setq what "top-level")
7879 (goto-char start)
7880 (show-all)))
7882 (setq beg (point))
7883 (if (>= beg end) (error "Nothing to sort"))
7886 (setq stars (match-string 1)
7887 re (concat "^" (regexp-quote stars) " +")
7889 txt (buffer-substring beg end))
7891 (if (and (not (equal stars "*")) (string-match re2 txt))
7892 (error "Region to sort contains a level above the first entry"))
7894 (unless sorting-type
7895 (message
7896 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7898 A/N/T/S/D/C/P/O/F means reversed:"
7899 what)
7900 (setq sorting-type (read-char-exclusive))
7902 (and (= (downcase sorting-type) ?f)
7903 (setq getkey-func
7904 (org-icompleting-read "Sort using function: "
7905 obarray 'fboundp t nil nil))
7906 (setq getkey-func (intern getkey-func)))
7908 (and (= (downcase sorting-type) ?r)
7909 (setq property
7910 (org-icompleting-read "Property: "
7911 (mapcar 'list (org-buffer-property-keys t))
7912 nil t))))
7914 (message "Sorting entries...")
7916 (save-restriction
7917 (narrow-to-region start end)
7918 (let ((dcst (downcase sorting-type))
7919 (case-fold-search nil)
7920 (now (current-time)))
7921 (sort-subr
7922 (/= dcst sorting-type)
7923 ;; This function moves to the beginning character of the "record" to
7924 ;; be sorted.
7925 (lambda nil
7926 (if (re-search-forward re nil t)
7927 (goto-char (match-beginning 0))
7928 (goto-char (point-max))))
7929 ;; This function moves to the last character of the "record" being
7930 ;; sorted.
7931 (lambda nil
7932 (save-match-data
7933 (condition-case nil
7934 (outline-forward-same-level 1)
7935 (error
7936 (goto-char (point-max))))))
7937 ;; This function returns the value that gets sorted against.
7938 (lambda nil
7939 (cond
7940 ((= dcst ?n)
7941 (if (looking-at org-complex-heading-regexp)
7942 (string-to-number (match-string 4))
7943 nil))
7944 ((= dcst ?a)
7945 (if (looking-at org-complex-heading-regexp)
7946 (funcall case-func (match-string 4))
7947 nil))
7948 ((= dcst ?t)
7949 (let ((end (save-excursion (outline-next-heading) (point))))
7950 (if (or (re-search-forward org-ts-regexp end t)
7951 (re-search-forward org-ts-regexp-both end t))
7952 (org-time-string-to-seconds (match-string 0))
7953 (org-float-time now))))
7954 ((= dcst ?c)
7955 (let ((end (save-excursion (outline-next-heading) (point))))
7956 (if (re-search-forward
7958 end t)
7959 (org-time-string-to-seconds (match-string 0))
7960 (org-float-time now))))
7961 ((= dcst ?s)
7962 (let ((end (save-excursion (outline-next-heading) (point))))
7963 (if (re-search-forward org-scheduled-time-regexp end t)
7964 (org-time-string-to-seconds (match-string 1))
7965 (org-float-time now))))
7966 ((= dcst ?d)
7967 (let ((end (save-excursion (outline-next-heading) (point))))
7968 (if (re-search-forward org-deadline-time-regexp end t)
7969 (org-time-string-to-seconds (match-string 1))
7970 (org-float-time now))))
7971 ((= dcst ?p)
7972 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7973 (string-to-char (match-string 2))
7974 org-default-priority))
7975 ((= dcst ?r)
7976 (or (org-entry-get nil property) ""))
7977 ((= dcst ?o)
7978 (if (looking-at org-complex-heading-regexp)
7979 (- 9999 (length (member (match-string 2)
7980 org-todo-keywords-1)))))
7981 ((= dcst ?f)
7982 (if getkey-func
7983 (progn
7984 (setq tmp (funcall getkey-func))
7985 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7986 tmp)
7987 (error "Invalid key function `%s'" getkey-func)))
7988 (t (error "Invalid sorting type `%c'" sorting-type))))
7989 nil
7990 (cond
7991 ((= dcst ?a) 'string<)
7992 ((= dcst ?f) compare-func)
7993 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7994 (t nil)))))
7995 (run-hooks 'org-after-sorting-entries-or-items-hook)
7996 (message "Sorting entries...done")))
7998 (defun org-do-sort (table what &optional with-case sorting-type)
7999 "Sort TABLE of WHAT according to SORTING-TYPE.
8000 The user will be prompted for the SORTING-TYPE if the call to this
8001 function does not specify it. WHAT is only for the prompt, to indicate
8002 what is being sorted. The sorting key will be extracted from
8003 the car of the elements of the table.
8004 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8005 (unless sorting-type
8006 (message
8007 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8008 what)
8009 (setq sorting-type (read-char-exclusive)))
8010 (let ((dcst (downcase sorting-type))
8011 extractfun comparefun)
8012 ;; Define the appropriate functions
8013 (cond
8014 ((= dcst ?n)
8015 (setq extractfun 'string-to-number
8016 comparefun (if (= dcst sorting-type) '< '>)))
8017 ((= dcst ?a)
8018 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8019 (lambda(x) (downcase (org-sort-remove-invisible x))))
8020 comparefun (if (= dcst sorting-type)
8021 'string<
8022 (lambda (a b) (and (not (string< a b))
8023 (not (string= a b)))))))
8024 ((= dcst ?t)
8025 (setq extractfun
8026 (lambda (x)
8027 (if (or (string-match org-ts-regexp x)
8028 (string-match org-ts-regexp-both x))
8029 (org-float-time
8030 (org-time-string-to-time (match-string 0 x)))
8031 0))
8032 comparefun (if (= dcst sorting-type) '< '>)))
8033 (t (error "Invalid sorting type `%c'" sorting-type)))
8035 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8036 table)
8037 (lambda (a b) (funcall comparefun (car a) (car b))))))
8040 ;;; The orgstruct minor mode
8042 ;; Define a minor mode which can be used in other modes in order to
8043 ;; integrate the org-mode structure editing commands.
8045 ;; This is really a hack, because the org-mode structure commands use
8046 ;; keys which normally belong to the major mode. Here is how it
8047 ;; works: The minor mode defines all the keys necessary to operate the
8048 ;; structure commands, but wraps the commands into a function which
8049 ;; tests if the cursor is currently at a headline or a plain list
8050 ;; item. If that is the case, the structure command is used,
8051 ;; temporarily setting many Org-mode variables like regular
8052 ;; expressions for filling etc. However, when any of those keys is
8053 ;; used at a different location, function uses `key-binding' to look
8054 ;; up if the key has an associated command in another currently active
8055 ;; keymap (minor modes, major mode, global), and executes that
8056 ;; command. There might be problems if any of the keys is otherwise
8057 ;; used as a prefix key.
8059 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8060 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8061 ;; addresses this by checking explicitly for both bindings.
8063 (defvar orgstruct-mode-map (make-sparse-keymap)
8064 "Keymap for the minor `orgstruct-mode'.")
8066 (defvar org-local-vars nil
8067 "List of local variables, for use by `orgstruct-mode'.")
8069 ;;;###autoload
8070 (define-minor-mode orgstruct-mode
8071 "Toggle the minor mode `orgstruct-mode'.
8072 This mode is for using Org-mode structure commands in other
8073 modes. The following keys behave as if Org-mode were active, if
8074 the cursor is on a headline, or on a plain list item (both as
8075 defined by Org-mode).
8077 M-up Move entry/item up
8078 M-down Move entry/item down
8079 M-left Promote
8080 M-right Demote
8081 M-S-up Move entry/item up
8082 M-S-down Move entry/item down
8083 M-S-left Promote subtree
8084 M-S-right Demote subtree
8085 M-q Fill paragraph and items like in Org-mode
8086 C-c ^ Sort entries
8087 C-c - Cycle list bullet
8088 TAB Cycle item visibility
8089 M-RET Insert new heading/item
8090 S-M-RET Insert new TODO heading / Checkbox item
8091 C-c C-c Set tags / toggle checkbox"
8092 nil " OrgStruct" nil
8093 (org-load-modules-maybe)
8094 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8096 ;;;###autoload
8097 (defun turn-on-orgstruct ()
8098 "Unconditionally turn on `orgstruct-mode'."
8099 (orgstruct-mode 1))
8101 (defun orgstruct++-mode (&optional arg)
8102 "Toggle `orgstruct-mode', the enhanced version of it.
8103 In addition to setting orgstruct-mode, this also exports all indentation
8104 and autofilling variables from org-mode into the buffer. It will also
8105 recognize item context in multiline items.
8106 Note that turning off orgstruct-mode will *not* remove the
8107 indentation/paragraph settings. This can only be done by refreshing the
8109 (interactive "P")
8110 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8111 (if (< arg 1)
8112 (orgstruct-mode -1)
8113 (orgstruct-mode 1)
8114 (let (var val)
8115 (mapc
8116 (lambda (x)
8117 (when (string-match
8119 (symbol-name (car x)))
8120 (setq var (car x) val (nth 1 x))
8121 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8122 org-local-vars)
8123 (org-set-local 'orgstruct-is-++ t))))
8125 (defvar orgstruct-is-++ nil
8126 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8127 (make-variable-buffer-local 'orgstruct-is-++)
8129 ;;;###autoload
8130 (defun turn-on-orgstruct++ ()
8131 "Unconditionally turn on `orgstruct++-mode'."
8132 (orgstruct++-mode 1))
8134 (defun orgstruct-error ()
8135 "Error when there is no default binding for a structure key."
8136 (interactive)
8137 (error "This key has no function outside structure elements"))
8139 (defun orgstruct-setup ()
8140 "Setup orgstruct keymaps."
8141 (let ((nfunc 0)
8142 (bindings
8143 (list
8144 '([(meta up)] org-metaup)
8145 '([(meta down)] org-metadown)
8146 '([(meta left)] org-metaleft)
8147 '([(meta right)] org-metaright)
8148 '([(meta shift up)] org-shiftmetaup)
8149 '([(meta shift down)] org-shiftmetadown)
8150 '([(meta shift left)] org-shiftmetaleft)
8151 '([(meta shift right)] org-shiftmetaright)
8152 '([?\e (up)] org-metaup)
8153 '([?\e (down)] org-metadown)
8154 '([?\e (left)] org-metaleft)
8155 '([?\e (right)] org-metaright)
8156 '([?\e (shift up)] org-shiftmetaup)
8157 '([?\e (shift down)] org-shiftmetadown)
8158 '([?\e (shift left)] org-shiftmetaleft)
8159 '([?\e (shift right)] org-shiftmetaright)
8160 '([(shift up)] org-shiftup)
8161 '([(shift down)] org-shiftdown)
8162 '([(shift left)] org-shiftleft)
8163 '([(shift right)] org-shiftright)
8164 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8165 '("\M-q" fill-paragraph)
8166 '("\C-c^" org-sort)
8167 '("\C-c-" org-cycle-list-bullet)))
8168 elt key fun cmd)
8169 (while (setq elt (pop bindings))
8170 (setq nfunc (1+ nfunc))
8171 (setq key (org-key (car elt))
8172 fun (nth 1 elt)
8173 cmd (orgstruct-make-binding fun nfunc key))
8174 (org-defkey orgstruct-mode-map key cmd))
8176 ;; Special treatment needed for TAB and RET
8177 (org-defkey orgstruct-mode-map [(tab)]
8178 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8179 (org-defkey orgstruct-mode-map "\C-i"
8180 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8182 (org-defkey orgstruct-mode-map "\M-\C-m"
8183 (orgstruct-make-binding 'org-insert-heading 105
8184 "\M-\C-m" [(meta return)]))
8185 (org-defkey orgstruct-mode-map [(meta return)]
8186 (orgstruct-make-binding 'org-insert-heading 106
8187 [(meta return)] "\M-\C-m"))
8189 (org-defkey orgstruct-mode-map [(shift meta return)]
8190 (orgstruct-make-binding 'org-insert-todo-heading 107
8191 [(meta return)] "\M-\C-m"))
8193 (org-defkey orgstruct-mode-map "\e\C-m"
8194 (orgstruct-make-binding 'org-insert-heading 108
8195 "\e\C-m" [?\e (return)]))
8196 (org-defkey orgstruct-mode-map [?\e (return)]
8197 (orgstruct-make-binding 'org-insert-heading 109
8198 [?\e (return)] "\e\C-m"))
8199 (org-defkey orgstruct-mode-map [?\e (shift return)]
8200 (orgstruct-make-binding 'org-insert-todo-heading 110
8201 [?\e (return)] "\e\C-m"))
8203 (unless org-local-vars
8204 (setq org-local-vars (org-get-local-variables)))
8206 t))
8208 (defun orgstruct-make-binding (fun n &rest keys)
8209 "Create a function for binding in the structure minor mode.
8210 FUN is the command to call inside a table. N is used to create a unique
8211 command name. KEYS are keys that should be checked in for a command
8212 to execute outside of tables."
8213 (eval
8214 (list 'defun
8215 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8216 '(arg)
8218 "Outside of structure, run the binding of `"
8219 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8220 "'.")
8221 '(interactive "p")
8222 (list 'if
8223 `(org-context-p 'headline 'item
8224 (and orgstruct-is-++
8225 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8226 'item-body))
8227 (list 'org-run-like-in-org-mode (list 'quote fun))
8228 (list 'let '(orgstruct-mode)
8229 (list 'call-interactively
8230 (append '(or)
8231 (mapcar (lambda (k)
8232 (list 'key-binding k))
8233 keys)
8234 '('orgstruct-error))))))))
8236 (defun org-context-p (&rest contexts)
8237 "Check if local context is any of CONTEXTS.
8238 Possible values in the list of contexts are `table', `headline', and `item'."
8239 (let ((pos (point)))
8240 (goto-char (point-at-bol))
8241 (prog1 (or (and (memq 'table contexts)
8243 (and (memq 'headline contexts)
8244 (looking-at org-outline-regexp))
8245 (and (memq 'item contexts)
8247 (and (memq 'item-body contexts)
8248 (org-in-item-p)))
8249 (goto-char pos))))
8251 (defun org-get-local-variables ()
8252 "Return a list of all local variables in an org-mode buffer."
8253 (let (varlist)
8254 (with-current-buffer (get-buffer-create "*Org tmp*")
8255 (erase-buffer)
8256 (org-mode)
8257 (setq varlist (buffer-local-variables)))
8258 (kill-buffer "*Org tmp*")
8259 (delq nil
8260 (mapcar
8261 (lambda (x)
8262 (setq x
8263 (if (symbolp x)
8264 (list x)
8265 (list (car x) (list 'quote (cdr x)))))
8266 (if (string-match
8267 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8268 (symbol-name (car x)))
8269 x nil))
8270 varlist))))
8272 (defun org-clone-local-variables (from-buffer &optional regexp)
8273 "Clone local variables from FROM-BUFFER.
8274 Optional argument REGEXP selects variables to clone."
8275 (mapc
8276 (lambda (pair)
8277 (and (symbolp (car pair))
8278 (or (null regexp)
8279 (string-match regexp (symbol-name (car pair))))
8280 (set (make-local-variable (car pair))
8281 (cdr pair))))
8282 (buffer-local-variables from-buffer)))
8284 ;;;###autoload
8285 (defun org-run-like-in-org-mode (cmd)
8286 "Run a command, pretending that the current buffer is in Org-mode.
8287 This will temporarily bind local variables that are typically bound in
8288 Org-mode to the values they have in Org-mode, and then interactively
8289 call CMD."
8290 (org-load-modules-maybe)
8291 (unless org-local-vars
8292 (setq org-local-vars (org-get-local-variables)))
8293 (eval (list 'let org-local-vars
8294 (list 'call-interactively (list 'quote cmd)))))
8296 ;;;; Archiving
8298 (defun org-get-category (&optional pos force-refresh)
8299 "Get the category applying to position POS."
8300 (if force-refresh (org-refresh-category-properties))
8301 (let ((pos (or pos (point))))
8302 (or (get-text-property pos 'org-category)
8303 (progn (org-refresh-category-properties)
8304 (get-text-property pos 'org-category)))))
8306 (defun org-refresh-category-properties ()
8307 "Refresh category text properties in the buffer."
8308 (let ((def-cat (cond
8309 ((null org-category)
8310 (if buffer-file-name
8311 (file-name-sans-extension
8312 (file-name-nondirectory buffer-file-name))
8313 "???"))
8314 ((symbolp org-category) (symbol-name org-category))
8315 (t org-category)))
8316 beg end cat pos optionp)
8317 (org-unmodified
8318 (save-excursion
8319 (save-restriction
8320 (widen)
8321 (goto-char (point-min))
8322 (put-text-property (point) (point-max) 'org-category def-cat)
8323 (while (re-search-forward
8325 (setq pos (match-end 0)
8326 optionp (equal (char-after (match-beginning 0)) ?#)
8327 cat (org-trim (match-string 2)))
8328 (if optionp
8329 (setq beg (point-at-bol) end (point-max))
8330 (org-back-to-heading t)
8331 (setq beg (point) end (org-end-of-subtree t t)))
8332 (put-text-property beg end 'org-category cat)
8333 (goto-char pos)))))))
8336 ;;;; Link Stuff
8338 ;;; Link abbreviations
8340 (defun org-link-expand-abbrev (link)
8341 "Apply replacements as defined in `org-link-abbrev-alist."
8343 (let* ((key (match-string 1 link))
8344 (as (or (assoc key org-link-abbrev-alist-local)
8345 (assoc key org-link-abbrev-alist)))
8346 (tag (and (match-end 2) (match-string 3 link)))
8347 rpl)
8348 (if (not as)
8349 link
8350 (setq rpl (cdr as))
8351 (cond
8352 ((symbolp rpl) (funcall rpl tag))
8353 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8354 ((string-match "%h" rpl)
8355 (replace-match (url-hexify-string (or tag "")) t t rpl))
8356 (t (concat rpl tag)))))
8357 link))
8359 ;;; Storing and inserting links
8361 (defvar org-insert-link-history nil
8362 "Minibuffer history for links inserted with `org-insert-link'.")
8364 (defvar org-stored-links nil
8365 "Contains the links stored with `org-store-link'.")
8367 (defvar org-store-link-plist nil
8368 "Plist with info about the most recently link created with `org-store-link'.")
8370 (defvar org-link-protocols nil
8371 "Link protocols added to Org-mode using `org-add-link-type'.")
8373 (defvar org-store-link-functions nil
8374 "List of functions that are called to create and store a link.
8375 Each function will be called in turn until one returns a non-nil
8376 value. Each function should check if it is responsible for creating
8377 this link (for example by looking at the major mode).
8378 If not, it must exit and return nil.
8379 If yes, it should return a non-nil value after a calling
8380 `org-store-link-props' with a list of properties and values.
8381 Special properties are:
8385 This is obligatory as well.
8386 :description Optional default description for the second pair
8387 of brackets in an Org-mode link. The user can still change
8388 this when inserting this link into an Org-mode buffer.
8390 In addition to these, any additional properties can be specified
8391 and then used in remember templates.")
8393 (defun org-add-link-type (type &optional follow export)
8394 "Add TYPE to the list of `org-link-types'.
8395 Re-compute all regular expressions depending on `org-link-types'
8397 FOLLOW and EXPORT are two functions.
8399 FOLLOW should take the link path as the single argument and do whatever
8400 is necessary to follow the link, for example find a file or display
8401 a mail message.
8403 EXPORT should format the link path for export to one of the export formats.
8404 It should be a function accepting three arguments:
8407 desc the description of the link, if any, or a description added by
8408 org-export-normalize-links if there is none
8409 format the export format, a symbol like `html' or `latex' or `ascii'..
8411 The function may use the FORMAT information to return different values
8412 depending on the format. The return value will be put literally into
8413 the exported file. If the return value is nil, this means Org should
8414 do what it normally does with links which do not have EXPORT defined.
8416 Org-mode has a built-in default for exporting links. If you are happy with
8417 this default, there is no need to define an export function for the link
8418 type. For a simple example of an export function, see `org-bbdb.el'."
8419 (add-to-list 'org-link-types type t)
8420 (org-make-link-regexps)
8421 (if (assoc type org-link-protocols)
8422 (setcdr (assoc type org-link-protocols) (list follow export))
8423 (push (list type follow export) org-link-protocols)))
8425 (defvar org-agenda-buffer-name)
8427 ;;;###autoload
8428 (defun org-store-link (arg)
8430 This link is added to `org-stored-links' and can later be inserted
8433 For some link types, a prefix arg is interpreted:
8434 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8435 For file links, arg negates `org-context-in-file-links'."
8436 (interactive "P")
8437 (org-load-modules-maybe)
8438 (setq org-store-link-plist nil) ; reset
8439 (org-with-limited-levels
8440 (let (link cpltxt desc description search txt custom-id agenda-link)
8441 (cond
8443 ((run-hook-with-args-until-success 'org-store-link-functions)
8444 (setq link (plist-get org-store-link-plist :link)
8445 desc (or (plist-get org-store-link-plist :description) link)))
8447 ((equal (buffer-name) "*Org Edit Src Example*")
8448 (let (label gc)
8449 (while (or (not label)
8450 (save-excursion
8451 (save-restriction
8452 (widen)
8453 (goto-char (point-min))
8454 (re-search-forward
8455 (regexp-quote (format org-coderef-label-format label))
8456 nil t))))
8457 (when label (message "Label exists already") (sit-for 2))
8458 (setq label (read-string "Code line label: " label)))
8459 (end-of-line 1)
8460 (setq link (format org-coderef-label-format label))
8461 (setq gc (- 79 (length link)))
8462 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8463 (insert link)
8464 (setq link (concat "(" label ")") desc nil)))
8466 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8467 ;; We are in the agenda, link to referenced location
8468 (let ((m (or (get-text-property (point) 'org-hd-marker)
8469 (get-text-property (point) 'org-marker))))
8470 (when m
8471 (org-with-point-at m
8472 (setq agenda-link
8473 (if (org-called-interactively-p 'any)
8474 (call-interactively 'org-store-link)
8475 (org-store-link nil)))))))
8477 ((eq major-mode 'calendar-mode)
8478 (let ((cd (calendar-cursor-to-date)))
8479 (setq link
8480 (format-time-string
8481 (car org-time-stamp-formats)
8482 (apply 'encode-time
8483 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8484 nil nil nil))))
8485 (org-store-link-props :type "calendar" :date cd)))
8487 ((eq major-mode 'w3-mode)
8488 (setq cpltxt (if (and (buffer-name)
8489 (not (string-match "Untitled" (buffer-name))))
8490 (buffer-name)
8491 (url-view-url t))
8492 link (org-make-link (url-view-url t)))
8493 (org-store-link-props :type "w3" :url (url-view-url t)))
8495 ((eq major-mode 'w3m-mode)
8496 (setq cpltxt (or w3m-current-title w3m-current-url)
8497 link (org-make-link w3m-current-url))
8498 (org-store-link-props :type "w3m" :url (url-view-url t)))
8500 ((setq search (run-hook-with-args-until-success
8501 'org-create-file-search-functions))
8502 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8503 "::" search))
8504 (setq cpltxt (or description link)))
8506 ((eq major-mode 'image-mode)
8507 (setq cpltxt (concat "file:"
8508 (abbreviate-file-name buffer-file-name))
8509 link (org-make-link cpltxt))
8510 (org-store-link-props :type "image" :file buffer-file-name))
8512 ((eq major-mode 'dired-mode)
8513 ;; link to the file in the current line
8514 (let ((file (dired-get-filename nil t)))
8515 (setq file (if file
8516 (abbreviate-file-name
8517 (expand-file-name (dired-get-filename nil t)))
8518 ;; otherwise, no file so use current directory.
8519 default-directory))
8520 (setq cpltxt (concat "file:" file)
8521 link (org-make-link cpltxt))))
8523 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8524 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8525 (cond
8527 (setq cpltxt
8528 (concat "file:"
8529 (abbreviate-file-name
8530 (buffer-file-name (buffer-base-buffer)))
8531 "::" (match-string 1))
8532 link (org-make-link cpltxt)))
8533 ((and (featurep 'org-id)
8534 (or (eq org-link-to-org-use-id t)
8535 (and (eq org-link-to-org-use-id 'create-if-interactive)
8536 (org-called-interactively-p 'any))
8537 (and (eq org-link-to-org-use-id
8538 'create-if-interactive-and-no-custom-id)
8539 (org-called-interactively-p 'any)
8540 (not custom-id))
8541 (and org-link-to-org-use-id
8542 (org-entry-get nil "ID"))))
8543 ;; We can make a link using the ID.
8544 (setq link (condition-case nil
8545 (prog1 (org-id-store-link)
8546 (setq desc (plist-get org-store-link-plist
8547 :description)))
8548 (error
8549 ;; probably before first headline, link to file only
8550 (concat "file:"
8551 (abbreviate-file-name
8552 (buffer-file-name (buffer-base-buffer))))))))
8553 (t
8554 ;; Just link to current headline
8555 (setq cpltxt (concat "file:"
8556 (abbreviate-file-name
8557 (buffer-file-name (buffer-base-buffer)))))
8558 ;; Add a context search string
8559 (when (org-xor org-context-in-file-links arg)
8560 (setq txt (cond
8561 ((org-on-heading-p) nil)
8562 ((org-region-active-p)
8563 (buffer-substring (region-beginning) (region-end)))
8564 (t nil)))
8566 (setq cpltxt
8567 (concat cpltxt "::"
8568 (condition-case nil
8569 (org-make-org-heading-search-string txt)
8570 (error "")))
8571 desc (or (nth 4 (ignore-errors
8572 (org-heading-components))) "NONE"))))
8574 (setq cpltxt (substring cpltxt 0 -2)))
8575 (setq link (org-make-link cpltxt)))))
8577 ((buffer-file-name (buffer-base-buffer))
8578 ;; Just link to this file here.
8579 (setq cpltxt (concat "file:"
8580 (abbreviate-file-name
8581 (buffer-file-name (buffer-base-buffer)))))
8582 ;; Add a context string
8583 (when (org-xor org-context-in-file-links arg)
8584 (setq txt (if (org-region-active-p)
8585 (buffer-substring (region-beginning) (region-end))
8586 (buffer-substring (point-at-bol) (point-at-eol))))
8587 ;; Only use search option if there is some text.
8589 (setq cpltxt
8590 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8591 desc "NONE")))
8592 (setq link (org-make-link cpltxt)))
8594 ((org-called-interactively-p 'interactive)
8595 (error "Cannot link to a buffer which is not visiting a file"))
8597 (t (setq link nil)))
8599 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8600 (setq link (or link cpltxt)
8601 desc (or desc cpltxt))
8602 (if (equal desc "NONE") (setq desc nil))
8604 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8605 (progn
8606 (setq org-stored-links
8607 (cons (list link desc) org-stored-links))
8608 (message "Stored: %s" (or desc link))
8609 (when custom-id
8610 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8611 "::#" custom-id))
8612 (setq org-stored-links
8613 (cons (list link desc) org-stored-links))))
8614 (or agenda-link (and link (org-make-link-string link desc)))))))
8616 (defun org-store-link-props (&rest plist)
8617 "Store link properties, extract names and addresses."
8618 (let (x adr)
8619 (when (setq x (plist-get plist :from))
8620 (setq adr (mail-extract-address-components x))
8621 (setq plist (plist-put plist :fromname (car adr)))
8622 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8623 (when (setq x (plist-get plist :to))
8624 (setq adr (mail-extract-address-components x))
8625 (setq plist (plist-put plist :toname (car adr)))
8626 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8627 (let ((from (plist-get plist :from))
8628 (to (plist-get plist :to)))
8629 (when (and from to org-from-is-user-regexp)
8630 (setq plist
8631 (plist-put plist :fromto
8632 (if (string-match org-from-is-user-regexp from)
8633 (concat "to %t")
8634 (concat "from %f"))))))
8635 (setq org-store-link-plist plist))
8637 (defun org-add-link-props (&rest plist)
8638 "Add these properties to the link property list."
8639 (let (key value)
8640 (while plist
8641 (setq key (pop plist) value (pop plist))
8642 (setq org-store-link-plist
8643 (plist-put org-store-link-plist key value)))))
8645 (defun org-email-link-description (&optional fmt)
8646 "Return the description part of an email link.
8647 This takes information from `org-store-link-plist' and formats it
8648 according to FMT (default from `org-email-link-description-format')."
8649 (setq fmt (or fmt org-email-link-description-format))
8650 (let* ((p org-store-link-plist)
8651 (to (plist-get p :toaddress))
8652 (from (plist-get p :fromaddress))
8653 (table
8654 (list
8655 (cons "%c" (plist-get p :fromto))
8656 (cons "%F" (plist-get p :from))
8657 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8658 (cons "%T" (plist-get p :to))
8659 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8660 (cons "%s" (plist-get p :subject))
8661 (cons "%d" (plist-get p :date))
8662 (cons "%m" (plist-get p :message-id)))))
8663 (when (string-match "%c" fmt)
8664 ;; Check if the user wrote this message
8665 (if (and org-from-is-user-regexp from to
8666 (save-match-data (string-match org-from-is-user-regexp from)))
8667 (setq fmt (replace-match "to %t" t t fmt))
8668 (setq fmt (replace-match "from %f" t t fmt))))
8669 (org-replace-escapes fmt table)))
8671 (defun org-make-org-heading-search-string (&optional string heading)
8672 "Make search string for STRING or current headline."
8673 (interactive)
8674 (let ((s (or string (org-get-heading)))
8675 (lines org-context-in-file-links))
8676 (unless (and string (not heading))
8677 ;; We are using a headline, clean up garbage in there.
8678 (if (string-match org-todo-regexp s)
8679 (setq s (replace-match "" t t s)))
8681 (setq s (replace-match "" t t s)))
8682 (setq s (org-trim s))
8685 (setq s (replace-match "" t t s)))
8686 (while (string-match org-ts-regexp s)
8687 (setq s (replace-match "" t t s))))
8688 (or string (setq s (concat "*" s))) ; Add * for headlines
8689 (when (and string (integerp lines) (> lines 0))
8691 (when (< lines (length slines))
8692 (setq s (mapconcat
8693 'identity
8694 (reverse (nthcdr (- (length slines) lines)
8698 (defun org-make-link (&rest strings)
8699 "Concatenate STRINGS."
8700 (apply 'concat strings))
8702 (defun org-make-link-string (link &optional description)
8703 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8705 (error "Empty link"))
8706 (when (and description
8707 (stringp description)
8709 (setq description nil))
8710 (when (stringp description)
8711 ;; Remove brackets from the description, they are fatal.
8713 (setq description (replace-match "{" t t description)))
8715 (setq description (replace-match "}" t t description))))
8716 (when (equal link description)
8717 ;; No description needed, it is identical
8718 (setq description nil))
8719 (when (and (not description)
8720 (not (string-match (org-image-file-name-regexp) link))
8721 (not (equal link (org-link-escape link))))
8722 (setq description (org-extract-attributes link)))
8723 (setq link
8724 (cond ((string-match (org-image-file-name-regexp) link) link)
8725 ((string-match org-link-types-re link)
8726 (concat (match-string 1 link)
8727 (org-link-escape (substring link (match-end 1)))))
8728 (t (org-link-escape link))))
8729 (concat "[[" link "]"
8730 (if description (concat "[" description "]") "")
8731 "]"))
8733 (defconst org-link-escape-chars
8734 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8735 "List of characters that should be escaped in link.
8736 This is the list that is used for internal purposes.")
8738 (defvar org-url-encoding-use-url-hexify nil)
8740 (defconst org-link-escape-chars-browser
8741 '(?\ )
8742 "List of escapes for characters that are problematic in links.
8743 This is the list that is used before handing over to the browser.")
8745 (defun org-link-escape (text &optional table merge)
8746 "Return percent escaped representation of TEXT.
8747 TEXT is a string with the text to escape.
8748 Optional argument TABLE is a list with characters that should be
8749 escaped. When nil, `org-link-escape-chars' is used.
8750 If optional argument MERGE is set, merge TABLE into
8751 `org-link-escape-chars'."
8752 (if (and org-url-encoding-use-url-hexify (not table))
8753 (url-hexify-string text)
8754 (cond
8755 ((and table merge)
8756 (mapc (lambda (defchr)
8757 (unless (member defchr table)
8758 (setq table (cons defchr table)))) org-link-escape-chars))
8759 ((null table)
8760 (setq table org-link-escape-chars)))
8761 (mapconcat
8762 (lambda (char)
8763 (if (or (member char table)
8764 (< char 32) (= char 37) (> char 126))
8765 (mapconcat (lambda (sequence-element)
8766 (format "%%%.2X" sequence-element))
8767 (or (encode-coding-char char 'utf-8)
8768 (error "Unable to percent escape character: %s"
8769 (char-to-string char))) "")
8770 (char-to-string char))) text "")))
8772 (defun org-link-unescape (str)
8773 "Unhex hexified unicode strings as returned from the JavaScript function
8774 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8775 (unless (and (null str) (string= "" str))
8776 (let ((pos 0) (case-fold-search t) unhexed)
8778 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8779 (setq str (replace-match unhexed t t str))
8780 (setq pos (+ pos (length unhexed))))))
8781 str)
8783 (defun org-link-unescape-compound (hex)
8784 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8785 Note: this function also decodes single byte encodings like
8787 (save-match-data
8788 (let* ((bytes (cdr (split-string hex "%")))
8789 (ret "")
8790 (eat 0)
8791 (sum 0))
8792 (while bytes
8793 (let* ((val (string-to-number (pop bytes) 16))
8794 (shift-xor
8795 (if (= 0 eat)
8796 (cond
8797 ((>= val 252) (cons 6 252))
8798 ((>= val 248) (cons 5 248))
8799 ((>= val 240) (cons 4 240))
8800 ((>= val 224) (cons 3 224))
8801 ((>= val 192) (cons 2 192))
8802 (t (cons 0 0)))
8803 (cons 6 128))))
8804 (if (>= val 192) (setq eat (car shift-xor)))
8805 (setq val (logxor val (cdr shift-xor)))
8806 (setq sum (+ (lsh sum (car shift-xor)) val))
8807 (if (> eat 0) (setq eat (- eat 1)))
8808 (cond
8809 ((= 0 eat) ;multi byte
8810 (setq ret (concat ret (org-char-to-string sum)))
8811 (setq sum 0))
8812 ((not bytes) ; single byte(s)
8813 (setq ret (org-link-unescape-single-byte-sequence hex))))
8814 )) ;; end (while bytes
8815 ret )))
8817 (defun org-link-unescape-single-byte-sequence (hex)
8818 "Unhexify hex-encoded single byte character sequences."
8819 (mapconcat (lambda (byte)
8820 (char-to-string (string-to-number byte 16)))
8821 (cdr (split-string hex "%")) ""))
8823 (defun org-xor (a b)
8824 "Exclusive or."
8825 (if a (not b) b))
8827 (defun org-fixup-message-id-for-http (s)
8828 "Replace special characters in a message id, so it can be used in an http query."
8829 (when (string-match "%" s)
8830 (setq s (mapconcat (lambda (c)
8831 (if (eq c ?%)
8832 "%25"
8833 (char-to-string c)))
8834 s "")))
8835 (while (string-match "<" s)
8836 (setq s (replace-match "%3C" t t s)))
8837 (while (string-match ">" s)
8838 (setq s (replace-match "%3E" t t s)))
8839 (while (string-match "@" s)
8840 (setq s (replace-match "%40" t t s)))
8841 s)
8843 ;;;###autoload
8844 (defun org-insert-link-global ()
8845 "Insert a link like Org-mode does.
8846 This command can be called in any mode to insert a link in Org-mode syntax."
8847 (interactive)
8848 (org-load-modules-maybe)
8849 (org-run-like-in-org-mode 'org-insert-link))
8851 (defun org-insert-link (&optional complete-file link-location)
8852 "Insert a link. At the prompt, enter the link.
8854 Completion can be used to insert any of the link protocol prefixes like
8855 http or ftp in use.
8857 The history can be used to select a link previously stored with
8858 `org-store-link'. When the empty string is entered (i.e. if you just
8859 press RET at the prompt), the link defaults to the most recently
8860 stored link. As SPC triggers completion in the minibuffer, you need to
8861 use M-SPC or C-q SPC to force the insertion of a space character.
8863 You will also be prompted for a description, and if one is given, it will
8864 be displayed in the buffer instead of the link.
8866 If there is already a link at point, this command will allow you to edit link
8867 and description parts.
8870 be selected using completion. The path to the file will be relative to the
8871 current directory if the file is in the current directory or a subdirectory.
8872 Otherwise, the link will be the absolute path as completed in the minibuffer
8873 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8874 option `org-link-file-path-type'.
8877 the current directory or below.
8880 `org-keep-stored-link-after-insertion'.
8882 If `org-make-link-description-function' is non-nil, this function will be
8883 called with the link target, and the result will be the default
8884 link description.
8886 If the LINK-LOCATION parameter is non-nil, this value will be
8887 used as the link location instead of reading one interactively."
8888 (interactive "P")
8889 (let* ((wcf (current-window-configuration))
8890 (region (if (org-region-active-p)
8891 (buffer-substring (region-beginning) (region-end))))
8892 (remove (and region (list (region-beginning) (region-end))))
8893 (desc region)
8894 tmphist ; byte-compile incorrectly complains about this
8895 (link link-location)
8896 entry file all-prefixes)
8897 (cond
8898 (link-location) ; specified by arg, just use it.
8899 ((org-in-regexp org-bracket-link-regexp 1)
8900 ;; We do have a link at point, and we are going to edit it.
8901 (setq remove (list (match-beginning 0) (match-end 0)))
8902 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8903 (setq link (read-string "Link: "
8904 (org-link-unescape
8905 (org-match-string-no-properties 1)))))
8906 ((or (org-in-regexp org-angle-link-re)
8907 (org-in-regexp org-plain-link-re))
8908 ;; Convert to bracket link
8909 (setq remove (list (match-beginning 0) (match-end 0))
8910 link (read-string "Link: "
8911 (org-remove-angle-brackets (match-string 0)))))
8912 ((member complete-file '((4) (16)))
8913 ;; Completing read for file names.
8914 (setq link (org-file-complete-link complete-file)))
8915 (t
8916 ;; Read link, with completion for stored links.
8917 (with-output-to-temp-buffer "*Org Links*"
8918 (princ "Insert a link.
8920 (when org-stored-links
8922 (princ (mapconcat
8923 (lambda (x)
8924 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8926 (let ((cw (selected-window)))
8927 (select-window (get-buffer-window "*Org Links*" 'visible))
8928 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8929 (unless (pos-visible-in-window-p (point-max))
8930 (org-fit-window-to-buffer))
8931 (and (window-live-p cw) (select-window cw)))
8932 ;; Fake a link history, containing the stored links.
8933 (setq tmphist (append (mapcar 'car org-stored-links)
8934 org-insert-link-history))
8935 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8936 (mapcar 'car org-link-abbrev-alist)
8937 org-link-types))
8938 (unwind-protect
8939 (progn
8940 (setq link
8941 (let ((org-completion-use-ido nil)
8942 (org-completion-use-iswitchb nil))
8943 (org-completing-read
8944 "Link: "
8945 (append
8946 (mapcar (lambda (x) (list (concat x ":")))
8947 all-prefixes)
8948 (mapcar 'car org-stored-links))
8949 nil nil nil
8950 'tmphist
8951 (car (car org-stored-links)))))
8953 (error "No link selected"))
8954 (if (or (member link all-prefixes)
8955 (and (equal ":" (substring link -1))
8956 (member (substring link 0 -1) all-prefixes)
8957 (setq link (substring link 0 -1))))
8958 (setq link (org-link-try-special-completion link))))
8959 (set-window-configuration wcf)
8960 (kill-buffer "*Org Links*"))
8961 (setq entry (assoc link org-stored-links))
8962 (or entry (push link org-insert-link-history))
8963 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8964 (not org-keep-stored-link-after-insertion))
8965 (setq org-stored-links (delq (assoc link org-stored-links)
8966 org-stored-links)))
8967 (setq desc (or desc (nth 1 entry)))))
8969 (if (string-match org-plain-link-re link)
8970 ;; URL-like link, normalize the use of angular brackets.
8971 (setq link (org-make-link (org-remove-angle-brackets link))))
8973 ;; Check if we are linking to the current file with a search option
8974 ;; If yes, simplify the link by using only the search option.
8975 (when (and buffer-file-name
8977 (let* ((path (match-string 1 link))
8978 (case-fold-search nil)
8979 (search (match-string 2 link)))
8980 (save-match-data
8981 (if (equal (file-truename buffer-file-name) (file-truename path))
8982 ;; We are linking to this same file, with a search option
8983 (setq link search)))))
8985 ;; Check if we can/should use a relative path. If yes, simplify the link
8987 (let* ((type (match-string 1 link))
8988 (path (match-string 2 link))
8989 (origpath path)
8990 (case-fold-search nil))
8991 (cond
8992 ((or (eq org-link-file-path-type 'absolute)
8993 (equal complete-file '(16)))
8994 (setq path (abbreviate-file-name (expand-file-name path))))
8995 ((eq org-link-file-path-type 'noabbrev)
8996 (setq path (expand-file-name path)))
8997 ((eq org-link-file-path-type 'relative)
8998 (setq path (file-relative-name path)))
8999 (t
9000 (save-match-data
9001 (if (string-match (concat "^" (regexp-quote
9002 (expand-file-name
9003 (file-name-as-directory
9004 default-directory))))
9005 (expand-file-name path))
9006 ;; We are linking a file with relative path name.
9007 (setq path (substring (expand-file-name path)
9008 (match-end 0)))
9009 (setq path (abbreviate-file-name (expand-file-name path)))))))
9010 (setq link (concat type path))
9011 (if (equal desc origpath)
9012 (setq desc path))))
9014 (if org-make-link-description-function
9015 (setq desc (funcall org-make-link-description-function link desc)))
9017 (setq desc (read-string "Description: " desc))
9019 (if remove (apply 'delete-region remove))
9020 (insert (org-make-link-string link desc))))
9022 (defun org-link-try-special-completion (type)
9023 "If there is completion support for link type TYPE, offer it."
9024 (let ((fun (intern (concat "org-" type "-complete-link"))))
9025 (if (functionp fun)
9026 (funcall fun)
9027 (read-string "Link (no completion support): " (concat type ":")))))
9029 (defun org-file-complete-link (&optional arg)
9030 "Create a file link using completion."
9031 (let (file link)
9032 (setq file (read-file-name "File: "))
9033 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9034 (pwd1 (file-name-as-directory (abbreviate-file-name
9035 (expand-file-name ".")))))
9036 (cond
9037 ((equal arg '(16))
9038 (setq link (org-make-link
9039 "file:"
9040 (abbreviate-file-name (expand-file-name file)))))
9042 (setq link (org-make-link "file:" (match-string 1 file))))
9044 (expand-file-name file))
9045 (setq link (org-make-link
9046 "file:" (match-string 1 (expand-file-name file)))))
9047 (t (setq link (org-make-link "file:" file)))))
9048 link))
9050 (defun org-completing-read (&rest args)
9051 "Completing-read with SPACE being a normal character."
9052 (let ((minibuffer-local-completion-map
9053 (copy-keymap minibuffer-local-completion-map)))
9054 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9055 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9056 (apply 'org-icompleting-read args)))
9058 (defun org-completing-read-no-i (&rest args)
9059 (let (org-completion-use-ido org-completion-use-iswitchb)
9060 (apply 'org-completing-read args)))
9062 (defun org-iswitchb-completing-read (prompt choices &rest args)
9063 "Use iswitch as a completing-read replacement to choose from choices.
9064 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9065 from."
9066 (let* ((iswitchb-use-virtual-buffers nil)
9067 (iswitchb-make-buflist-hook
9068 (lambda ()
9069 (setq iswitchb-temp-buflist choices))))
9070 (iswitchb-read-buffer prompt)))
9072 (defun org-icompleting-read (&rest args)
9073 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9074 (org-without-partial-completion
9075 (if (and org-completion-use-ido
9076 (fboundp 'ido-completing-read)
9077 (boundp 'ido-mode) ido-mode
9078 (listp (second args)))
9079 (let ((ido-enter-matching-directory nil))
9080 (apply 'ido-completing-read (concat (car args))
9081 (if (consp (car (nth 1 args)))
9082 (mapcar 'car (nth 1 args))
9083 (nth 1 args))
9084 (cddr args)))
9085 (if (and org-completion-use-iswitchb
9086 (boundp 'iswitchb-mode) iswitchb-mode
9087 (listp (second args)))
9088 (apply 'org-iswitchb-completing-read (concat (car args))
9089 (if (consp (car (nth 1 args)))
9090 (mapcar 'car (nth 1 args))
9091 (nth 1 args))
9092 (cddr args))
9093 (apply 'completing-read args)))))
9095 (defun org-extract-attributes (s)
9096 "Extract the attributes cookie from a string and set as text property."
9097 (let (a attr (start 0) key value)
9098 (save-match-data
9100 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9102 (setq key (match-string 1 a) value (match-string 2 a)
9103 start (match-end 0)
9104 attr (plist-put attr (intern key) value))))
9105 (org-add-props s nil 'org-attr attr))
9106 s))
9108 (defun org-extract-attributes-from-string (tag)
9109 (let (key value attr)
9111 (setq key (match-string 1 tag) value (match-string 2 tag)
9112 tag (replace-match "" t t tag)
9113 attr (plist-put attr (intern key) value)))
9114 (cons tag attr)))
9116 (defun org-attributes-to-string (plist)
9117 "Format a property list into an HTML attribute list."
9118 (let ((s "") key value)
9119 (while plist
9120 (setq key (pop plist) value (pop plist))
9121 (and value
9123 s))
9125 ;;; Opening/following a link
9127 (defvar org-link-search-failed nil)
9129 (defvar org-open-link-functions nil
9130 "Hook for functions finding a plain text link.
9131 These functions must take a single argument, the link content.
9132 They will be called for links that look like [[link text][description]]
9136 These functions will be called *before* Org attempts to resolve the
9137 link by doing text searches in the current buffer - so if you want a
9139 handle this as a special case.
9141 When the function does handle the link, it must return a non-nil value.
9142 If it decides that it is not responsible for this link, it must return
9143 nil to indicate that that Org-mode can continue with other options
9144 like exact and fuzzy text search.")
9146 (defun org-next-link ()
9147 "Move forward to the next link.
9148 If the link is in hidden text, expose it."
9149 (interactive)
9150 (when (and org-link-search-failed (eq this-command last-command))
9151 (goto-char (point-min))
9152 (message "Link search wrapped back to beginning of buffer"))
9153 (setq org-link-search-failed nil)
9154 (let* ((pos (point))
9155 (ct (org-context))
9156 (a (assoc :link ct)))
9157 (if a (goto-char (nth 2 a)))
9158 (if (re-search-forward org-any-link-re nil t)
9159 (progn
9160 (goto-char (match-beginning 0))
9161 (if (outline-invisible-p) (org-show-context)))
9162 (goto-char pos)
9163 (setq org-link-search-failed t)
9164 (error "No further link found"))))
9166 (defun org-previous-link ()
9167 "Move backward to the previous link.
9168 If the link is in hidden text, expose it."
9169 (interactive)
9170 (when (and org-link-search-failed (eq this-command last-command))
9171 (goto-char (point-max))
9172 (message "Link search wrapped back to end of buffer"))
9173 (setq org-link-search-failed nil)
9174 (let* ((pos (point))
9175 (ct (org-context))
9176 (a (assoc :link ct)))
9177 (if a (goto-char (nth 1 a)))
9178 (if (re-search-backward org-any-link-re nil t)
9179 (progn
9180 (goto-char (match-beginning 0))
9181 (if (outline-invisible-p) (org-show-context)))
9182 (goto-char pos)
9183 (setq org-link-search-failed t)
9184 (error "No further link found"))))
9186 (defun org-translate-link (s)
9187 "Translate a link string if a translation function has been defined."
9188 (if (and org-link-translation-function
9189 (fboundp org-link-translation-function)
9191 (progn
9192 (setq s (funcall org-link-translation-function
9193 (match-string 1) (match-string 2)))
9194 (concat (car s) ":" (cdr s)))
9195 s))
9197 (defun org-translate-link-from-planner (type path)
9198 "Translate a link from Emacs Planner syntax so that Org can follow it.
9199 This is still an experimental function, your mileage may vary."
9200 (cond
9201 ((member type '("http" "https" "news" "ftp"))
9202 ;; standard Internet links are the same.
9203 nil)
9204 ((and (equal type "irc") (string-match "^//" path))
9205 ;; Planner has two / at the beginning of an irc link, we have 1.
9206 ;; We should have zero, actually....
9207 (setq path (substring path 1)))
9208 ((and (equal type "lisp") (string-match "^/" path))
9209 ;; Planner has a slash, we do not.
9210 (setq type "elisp" path (substring path 1)))
9212 ;; A typical message link. Planner has the id after the final slash,
9213 ;; we separate it with a hash mark
9214 (setq path (concat (match-string 1 path) "#"
9215 (org-remove-angle-brackets (match-string 2 path)))))
9216 )
9217 (cons type path))
9219 (defun org-find-file-at-mouse (ev)
9220 "Open file link or URL at mouse."
9221 (interactive "e")
9222 (mouse-set-point ev)
9223 (org-open-at-point 'in-emacs))
9225 (defun org-open-at-mouse (ev)
9226 "Open file link or URL at mouse."
9227 (interactive "e")
9228 (mouse-set-point ev)
9229 (if (eq major-mode 'org-agenda-mode)
9230 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9231 (org-open-at-point))
9233 (defvar org-window-config-before-follow-link nil
9234 "The window configuration before following a link.
9235 This is saved in case the need arises to restore it.")
9237 (defvar org-open-link-marker (make-marker)
9238 "Marker pointing to the location where `org-open-at-point; was called.")
9240 ;;;###autoload
9241 (defun org-open-at-point-global ()
9242 "Follow a link like Org-mode does.
9243 This command can be called in any mode to follow a link that has
9244 Org-mode syntax."
9245 (interactive)
9246 (org-run-like-in-org-mode 'org-open-at-point))
9248 ;;;###autoload
9249 (defun org-open-link-from-string (s &optional arg reference-buffer)
9250 "Open a link in the string S, as if it was in Org-mode."
9252 (let ((reference-buffer (or reference-buffer (current-buffer))))
9253 (with-temp-buffer
9254 (let ((org-inhibit-startup t))
9255 (org-mode)
9256 (insert s)
9257 (goto-char (point-min))
9258 (when reference-buffer
9259 (setq org-link-abbrev-alist-local
9260 (with-current-buffer reference-buffer
9261 org-link-abbrev-alist-local)))
9262 (org-open-at-point arg reference-buffer)))))
9264 (defvar org-open-at-point-functions nil
9265 "Hook that is run when following a link at point.
9267 Functions in this hook must return t if they identify and follow
9268 a link at point. If they don't find anything interesting at point,
9269 they must return nil.")
9271 (defun org-open-at-point (&optional arg reference-buffer)
9272 "Open link at or after point.
9273 If there is no link at point, this function will search forward up to
9274 the end of the current line.
9275 Normally, files will be opened by an appropriate application. If the
9276 optional prefix argument ARG is non-nil, Emacs will visit the file.
9277 With a double prefix argument, try to open outside of Emacs, in the
9278 application the system uses for this file type."
9279 (interactive "P")
9280 ;; if in a code block, then open the block's results
9281 (unless (call-interactively #'org-babel-open-src-block-result)
9282 (org-load-modules-maybe)
9283 (move-marker org-open-link-marker (point))
9284 (setq org-window-config-before-follow-link (current-window-configuration))
9285 (org-remove-occur-highlights nil nil t)
9286 (cond
9287 ((and (org-on-heading-p)
9288 (not (org-in-regexp
9293 (not (get-text-property (point) 'org-linked-text)))
9294 (or (org-offer-links-in-entry arg)
9295 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9296 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9297 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9298 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9299 (not (org-in-regexp org-bracket-link-regexp)))
9300 (org-footnote-action))
9301 (t
9302 (let (type path link line search (pos (point)))
9303 (catch 'match
9304 (save-excursion
9306 (when (org-in-regexp org-bracket-link-regexp 1)
9307 (setq link (org-extract-attributes
9308 (org-link-unescape (org-match-string-no-properties 1))))
9310 (setq link (replace-match " " t t link)))
9311 (setq link (org-link-expand-abbrev link))
9312 (cond
9313 ((or (file-name-absolute-p link)
9315 (setq type "file" path link))
9316 ((string-match org-link-re-with-space3 link)
9317 (setq type (match-string 1 link) path (match-string 2 link)))
9318 (t (setq type "thisfile" path link)))
9319 (throw 'match t)))
9321 (when (get-text-property (point) 'org-linked-text)
9322 (setq type "thisfile"
9323 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9324 (1+ (point)) (point))
9325 path (buffer-substring
9326 (or (previous-single-property-change pos 'org-linked-text)
9327 (point-min))
9328 (or (next-single-property-change pos 'org-linked-text)
9329 (point-max))))
9330 (throw 'match t))
9332 (save-excursion
9333 (when (or (org-in-regexp org-angle-link-re)
9334 (org-in-regexp org-plain-link-re))
9335 (setq type (match-string 1) path (match-string 2))
9336 (throw 'match t)))
9337 (save-excursion
9339 (setq type "tags"
9340 path (match-string 1))
9341 (while (string-match ":" path)
9342 (setq path (replace-match "+" t t path)))
9343 (throw 'match t)))
9345 (setq type "tree-match"
9346 path (match-string 1))
9347 (throw 'match t)))
9348 (unless path
9349 (error "No link found"))
9351 ;; switch back to reference buffer
9352 ;; needed when if called in a temporary buffer through
9353 ;; org-open-link-from-string
9354 (with-current-buffer (or reference-buffer (current-buffer))
9356 ;; Remove any trailing spaces in path
9358 (setq path (replace-match "" t t path)))
9359 (if (and org-link-translation-function
9360 (fboundp org-link-translation-function))
9361 ;; Check if we need to translate the link
9362 (let ((tmp (funcall org-link-translation-function type path)))
9363 (setq type (car tmp) path (cdr tmp))))
9365 (cond
9367 ((assoc type org-link-protocols)
9368 (funcall (nth 1 (assoc type org-link-protocols)) path))
9370 ((equal type "mailto")
9371 (let ((cmd (car org-link-mailto-program))
9372 (args (cdr org-link-mailto-program)) args1
9373 (address path) (subject "") a)
9375 (setq address (match-string 1 path)
9376 subject (org-link-escape (match-string 2 path))))
9377 (while args
9378 (cond
9379 ((not (stringp (car args))) (push (pop args) args1))
9380 (t (setq a (pop args))
9381 (if (string-match "%a" a)
9382 (setq a (replace-match address t t a)))
9383 (if (string-match "%s" a)
9384 (setq a (replace-match subject t t a)))
9385 (push a args1))))
9386 (apply cmd (nreverse args1))))
9388 ((member type '("http" "https" "ftp" "news"))
9389 (browse-url (concat type ":" (org-link-escape
9390 path org-link-escape-chars-browser))))
9392 ((string= type "doi")
9393 (browse-url (concat "http://dx.doi.org/"
9394 (org-link-escape
9395 path org-link-escape-chars-browser))))
9397 ((member type '("message"))
9398 (browse-url (concat type ":" path)))
9400 ((string= type "tags")
9401 (org-tags-view arg path))
9403 ((string= type "tree-match")
9406 ((string= type "file")
9408 (setq line (string-to-number (match-string 1 path))
9409 path (substring path 0 (match-beginning 0)))
9411 (setq search (match-string 1 path)
9412 path (substring path 0 (match-beginning 0)))))
9413 (if (string-match "[*?{]" (file-name-nondirectory path))
9414 (dired path)
9415 (org-open-file path arg line search)))
9417 ((string= type "shell")
9418 (let ((cmd path))
9419 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9420 (string-match org-confirm-shell-link-not-regexp cmd))
9421 (not org-confirm-shell-link-function)
9422 (funcall org-confirm-shell-link-function
9424 (org-add-props cmd nil
9425 'face 'org-warning))))
9426 (progn
9427 (message "Executing %s" cmd)
9428 (shell-command cmd))
9429 (error "Abort"))))
9431 ((string= type "elisp")
9432 (let ((cmd path))
9433 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9434 (string-match org-confirm-elisp-link-not-regexp cmd))
9435 (not org-confirm-elisp-link-function)
9436 (funcall org-confirm-elisp-link-function
9438 (org-add-props cmd nil
9439 'face 'org-warning))))
9440 (message "%s => %s" cmd
9441 (if (equal (string-to-char cmd) ?\()
9442 (eval (read cmd))
9443 (call-interactively (read cmd))))
9444 (error "Abort"))))
9446 ((and (string= type "thisfile")
9447 (run-hook-with-args-until-success
9448 'org-open-link-functions path)))
9450 ((string= type "thisfile")
9451 (if arg
9452 (switch-to-buffer-other-window
9453 (org-get-buffer-for-internal-link (current-buffer)))
9454 (org-mark-ring-push))
9455 (let ((cmd `(org-link-search
9456 ,path
9457 ,(cond ((equal arg '(4)) ''occur)
9458 ((equal arg '(16)) ''org-occur)
9459 (t nil))
9460 ,pos)))
9461 (condition-case nil (eval cmd)
9462 (error (progn (widen) (eval cmd))))))
9464 (t
9465 (browse-url-at-point)))))))
9466 (move-marker org-open-link-marker nil)
9467 (run-hook-with-args 'org-follow-link-hook)))
9469 (defun org-offer-links-in-entry (&optional nth zero)
9470 "Offer links in the current entry and follow the selected link.
9471 If there is only one link, follow it immediately as well.
9472 If NTH is an integer, immediately pick the NTH link found.
9473 If ZERO is a string, check also this string for a link, and if
9474 there is one, offer it as link number zero."
9478 (cnt ?0)
9479 (in-emacs (if (integerp nth) nil nth))
9480 have-zero end links link c)
9481 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9482 (push (match-string 0 zero) links)
9483 (setq cnt (1- cnt) have-zero t))
9484 (save-excursion
9485 (org-back-to-heading t)
9486 (setq end (save-excursion (outline-next-heading) (point)))
9487 (while (re-search-forward re end t)
9488 (push (match-string 0) links))
9489 (setq links (org-uniquify (reverse links))))
9491 (cond
9492 ((null links)
9493 (message "No links"))
9494 ((equal (length links) 1)
9495 (setq link (list (car links))))
9496 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9497 (setq link (nth (if have-zero nth (1- nth)) links)))
9498 (t ; we have to select a link
9499 (save-excursion
9500 (save-window-excursion
9501 (delete-other-windows)
9502 (with-output-to-temp-buffer "*Select Link*"
9503 (mapc (lambda (l)
9504 (if (not (string-match org-bracket-link-regexp l))
9506 (org-remove-angle-brackets l)))
9507 (if (match-end 3)
9509 (match-string 3 l) (match-string 1 l)))
9511 (match-string 1 l))))))
9512 links))
9513 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9514 (message "Select link to open, RET to open all:")
9515 (setq c (read-char-exclusive))
9516 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9517 (when (equal c ?q) (error "Abort"))
9518 (if (equal c ?\C-m)
9519 (setq link links)
9520 (setq nth (- c ?0))
9521 (if have-zero (setq nth (1+ nth)))
9522 (unless (and (integerp nth) (>= (length links) nth))
9523 (error "Invalid link selection"))
9524 (setq link (list (nth (1- nth) links))))))
9525 (if link
9526 (let ((buf (current-buffer)))
9527 (dolist (l link)
9528 (org-open-link-from-string l in-emacs buf))
9529 t)
9530 nil)))
9532 ;; Add special file links that specify the way of opening
9534 (org-add-link-type "file+sys" 'org-open-file-with-system)
9535 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9536 (defun org-open-file-with-system (path)
9537 "Open file at PATH using the system way of opening it."
9538 (org-open-file path 'system))
9539 (defun org-open-file-with-emacs (path)
9540 "Open file at PATH in Emacs."
9541 (org-open-file path 'emacs))
9542 (defun org-remove-file-link-modifiers ()
9543 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9544 (goto-char (point-min))
9546 (org-if-unprotected
9547 (replace-match "file:" t t))))
9548 (eval-after-load "org-exp"
9549 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9550 'org-remove-file-link-modifiers))
9552 ;;;; Time estimates
9554 (defun org-get-effort (&optional pom)
9555 "Get the effort estimate for the current entry."
9556 (org-entry-get pom org-effort-property))
9558 ;;; File search
9560 (defvar org-create-file-search-functions nil
9561 "List of functions to construct the right search string for a file link.
9562 These functions are called in turn with point at the location to
9563 which the link should point.
9565 A function in the hook should first test if it would like to
9566 handle this file type, for example by checking the `major-mode'
9567 or the file extension. If it decides not to handle this file, it
9568 should just return nil to give other functions a chance. If it
9569 does handle the file, it must return the search string to be used
9570 when following the link. The search string will be part of the
9571 file link, given after a double colon, and `org-open-at-point'
9572 will automatically search for it. If special measures must be
9573 taken to make the search successful, another function should be
9574 added to the companion hook `org-execute-file-search-functions',
9575 which see.
9577 A function in this hook may also use `setq' to set the variable
9578 `description' to provide a suggestion for the descriptive text to
9579 be used for this link when it gets inserted into an Org-mode
9582 (defvar org-execute-file-search-functions nil
9583 "List of functions to execute a file search triggered by a link.
9585 Functions added to this hook must accept a single argument, the
9586 search string that was part of the file link, the part after the
9587 double colon. The function must first check if it would like to
9588 handle this search, for example by checking the `major-mode' or
9589 the file extension. If it decides not to handle this search, it
9590 should just return nil to give other functions a chance. If it
9591 does handle the search, it must return a non-nil value to keep
9592 other functions from trying.
9594 Each function can access the current prefix argument through the
9595 variable `current-prefix-argument'. Note that a single prefix is
9596 used to force opening a link in Emacs, so it may be good to only
9597 use a numeric or double prefix to guide the search function.
9599 In case this is needed, a function in this hook can also restore
9600 the window configuration before `org-open-at-point' was called using:
9602 (set-window-configuration org-window-config-before-follow-link)")
9604 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9605 (defun org-link-search (s &optional type avoid-pos)
9606 "Search for a link search option.
9607 If S is surrounded by forward slashes, it is interpreted as a
9608 regular expression. In org-mode files, this will create an `org-occur'
9609 sparse tree. In ordinary files, `occur' will be used to list matches.
9610 If the current buffer is in `dired-mode', grep will be used to search
9611 in all files. If AVOID-POS is given, ignore matches near that position."
9612 (let ((case-fold-search t)
9616 org-emphasis-alist)
9618 (pos (point))
9619 (pre nil) (post nil)
9620 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9621 (cond
9622 ;; First check if there are any special search functions
9623 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9624 ;; Now try the builtin stuff
9625 ((and (equal (string-to-char s0) ?#)
9626 (> (length s0) 1)
9627 (save-excursion
9628 (goto-char (point-min))
9629 (and
9630 (re-search-forward
9632 (setq type 'dedicated
9633 pos (match-beginning 0))))
9634 ;; There is an exact target for this
9635 (goto-char pos)
9636 (org-back-to-heading t)))
9637 ((save-excursion
9638 (goto-char (point-min))
9639 (and
9640 (re-search-forward
9641 (concat "<<" (regexp-quote s0) ">>") nil t)
9642 (setq type 'dedicated
9643 pos (match-beginning 0))))
9644 ;; There is an exact target for this
9645 (goto-char pos))
9647 (save-excursion
9648 (goto-char (point-min))
9649 (and
9650 (re-search-forward
9651 (concat "[^[]" (regexp-quote
9652 (format org-coderef-label-format
9653 (match-string 1 s0))))
9654 nil t)
9655 (setq type 'dedicated
9656 pos (1+ (match-beginning 0))))))
9657 ;; There is a coderef target for this
9658 (goto-char pos))
9660 ;; A regular expression
9661 (cond
9662 ((org-mode-p)
9663 (org-occur (match-string 1 s)))
9664 ;;((eq major-mode 'dired-mode)
9665 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9666 (t (org-do-occur (match-string 1 s)))))
9667 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9668 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9669 (goto-char (point-min))
9670 (cond
9671 ((let (case-fold-search)
9672 (re-search-forward (format org-complex-heading-regexp-format
9673 (regexp-quote s))
9674 nil t))
9675 ;; OK, found a match
9676 (setq type 'dedicated)
9677 (goto-char (match-beginning 0)))
9678 ((and (not org-link-search-inhibit-query)
9679 (eq org-link-search-must-match-exact-headline 'query-to-create)
9680 (y-or-n-p "No match - create this as a new heading? "))
9681 (goto-char (point-max))
9682 (or (bolp) (newline))
9684 (beginning-of-line 0))
9685 (t
9686 (goto-char pos)
9687 (error "No match"))))
9688 (t
9689 ;; A normal search string
9690 (when (equal (string-to-char s) ?*)
9691 ;; Anchor on headlines, post may include tags.
9694 s (substring s 1)))
9695 (remove-text-properties
9696 0 (length s)
9697 '(face nil mouse-face nil keymap nil fontified nil) s)
9698 ;; Make a series of regular expressions to find a match
9707 re4 (concat "[^a-zA-Z_]" re4_)
9709 re1 (concat pre re2 post)
9710 re3 (concat pre (if pre re4_ re4) post)
9711 re5 (concat pre ".*" re4)
9712 re2 (concat pre re2)
9713 re2a (concat pre (if pre re2a_ re2a))
9714 re4 (concat pre (if pre re4_ re4))
9718 ))
9719 (cond
9720 ((eq type 'org-occur) (org-occur reall))
9721 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9722 (t (goto-char (point-min))
9723 (setq type 'fuzzy)
9724 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9725 (org-search-not-self 1 re1 nil t)
9726 (org-search-not-self 1 re2 nil t)
9727 (org-search-not-self 1 re2a nil t)
9728 (org-search-not-self 1 re3 nil t)
9729 (org-search-not-self 1 re4 nil t)
9730 (org-search-not-self 1 re5 nil t)
9731 )
9732 (goto-char (match-beginning 1))
9733 (goto-char pos)
9734 (error "No match"))))))
9735 (and (org-mode-p) (org-show-context 'link-search))
9736 type))
9738 (defun org-search-not-self (group &rest args)
9739 "Execute `re-search-forward', but only accept matches that do not
9740 enclose the position of `org-open-link-marker'."
9741 (let ((m org-open-link-marker))
9742 (catch 'exit
9743 (while (apply 're-search-forward args)
9744 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9745 (goto-char (match-end group))
9746 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9747 (> (match-beginning 0) (marker-position m))
9748 (< (match-end 0) (marker-position m)))
9749 (save-match-data
9750 (or (not (org-in-regexp
9751 org-bracket-link-analytic-regexp 1))
9752 (not (match-end 4)) ; no description
9753 (and (<= (match-beginning 4) (point))
9754 (>= (match-end 4) (point))))))
9755 (throw 'exit (point))))))))
9757 (defun org-get-buffer-for-internal-link (buffer)
9758 "Return a buffer to be used for displaying the link target of internal links."
9759 (cond
9760 ((not org-display-internal-link-with-indirect-buffer)
9761 buffer)
9762 ((string-match "(Clone)$" (buffer-name buffer))
9763 (message "Buffer is already a clone, not making another one")
9764 ;; we also do not modify visibility in this case
9765 buffer)
9766 (t ; make a new indirect buffer for displaying the link
9767 (let* ((bn (buffer-name buffer))
9768 (ibn (concat bn "(Clone)"))
9769 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9770 (with-current-buffer ib (org-overview))
9771 ib))))
9773 (defun org-do-occur (regexp &optional cleanup)
9774 "Call the Emacs command `occur'.
9775 If CLEANUP is non-nil, remove the printout of the regular expression
9776 in the *Occur* buffer. This is useful if the regex is long and not useful
9777 to read."
9778 (occur regexp)
9779 (when cleanup
9780 (let ((cwin (selected-window)) win beg end)
9781 (when (setq win (get-buffer-window "*Occur*"))
9782 (select-window win))
9783 (goto-char (point-min))
9784 (when (re-search-forward "match[a-z]+" nil t)
9785 (setq beg (match-end 0))
9787 (setq end (1- (match-beginning 0)))))
9788 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9789 (goto-char (point-min))
9790 (select-window cwin))))
9792 ;;; The mark ring for links jumps
9794 (defvar org-mark-ring nil
9795 "Mark ring for positions before jumps in Org-mode.")
9796 (defvar org-mark-ring-last-goto nil
9797 "Last position in the mark ring used to go back.")
9798 ;; Fill and close the ring
9799 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9800 (loop for i from 1 to org-mark-ring-length do
9801 (push (make-marker) org-mark-ring))
9802 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9803 org-mark-ring)
9805 (defun org-mark-ring-push (&optional pos buffer)
9806 "Put the current position or POS into the mark ring and rotate it."
9807 (interactive)
9808 (setq pos (or pos (point)))
9809 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9810 (move-marker (car org-mark-ring)
9811 (or pos (point))
9812 (or buffer (current-buffer)))
9813 (message "%s"
9814 (substitute-command-keys
9817 (defun org-mark-ring-goto (&optional n)
9818 "Jump to the previous position in the mark ring.
9819 With prefix arg N, jump back that many stored positions. When
9820 called several times in succession, walk through the entire ring.
9821 Org-mode commands jumping to a different position in the current file,
9822 or to another Org-mode file, automatically push the old position
9823 onto the ring."
9824 (interactive "p")
9825 (let (p m)
9826 (if (eq last-command this-command)
9827 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9828 (setq p org-mark-ring))
9829 (setq org-mark-ring-last-goto p)
9830 (setq m (car p))
9831 (org-pop-to-buffer-same-window (marker-buffer m))
9832 (goto-char m)
9833 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9835 (defun org-remove-angle-brackets (s)
9836 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9837 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9838 s)
9839 (defun org-add-angle-brackets (s)
9840 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9841 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9842 s)
9843 (defun org-remove-double-quotes (s)
9846 s)
9848 ;;; Following specific links
9850 (defun org-follow-timestamp-link ()
9851 (cond
9852 ((org-at-date-range-p t)
9853 (let ((org-agenda-start-on-weekday)
9854 (t1 (match-string 1))
9855 (t2 (match-string 2)))
9856 (setq t1 (time-to-days (org-time-string-to-time t1))
9857 t2 (time-to-days (org-time-string-to-time t2)))
9858 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9859 ((org-at-timestamp-p t)
9860 (org-agenda-list nil (time-to-days (org-time-string-to-time
9861 (substring (match-string 1) 0 10)))
9862 1))
9863 (t (error "This should not happen"))))
9866 ;;; Following file links
9867 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9868 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9869 (declare-function mailcap-mime-info
9870 "mailcap" (string &optional request no-decode))
9871 (defvar org-wait nil)
9872 (defun org-open-file (path &optional in-emacs line search)
9873 "Open the file at PATH.
9874 First, this expands any special file name abbreviations. Then the
9875 configuration variable `org-file-apps' is checked if it contains an
9876 entry for this file type, and if yes, the corresponding command is launched.
9878 If no application is found, Emacs simply visits the file.
9880 With optional prefix argument IN-EMACS, Emacs will visit the file.
9882 prefix arg, Org tries to avoid opening in Emacs
9883 and to use an external application to visit the file.
9885 Optional LINE specifies a line to go to, optional SEARCH a string
9886 to search for. If LINE or SEARCH is given, the file will be
9887 opened in Emacs, unless an entry from org-file-apps that makes
9888 use of groups in a regexp matches.
9889 If the file does not exist, an error is thrown."
9890 (let* ((file (if (equal path "")
9891 buffer-file-name
9892 (substitute-in-file-name (expand-file-name path))))
9893 (file-apps (append org-file-apps (org-default-apps)))
9894 (apps (org-remove-if
9895 'org-file-apps-entry-match-against-dlink-p file-apps))
9896 (apps-dlink (org-remove-if-not
9897 'org-file-apps-entry-match-against-dlink-p file-apps))
9898 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9899 (dirp (if remp nil (file-directory-p file)))
9900 (file (if (and dirp org-open-directory-means-index-dot-org)
9901 (concat (file-name-as-directory file) "index.org")
9902 file))
9903 (a-m-a-p (assq 'auto-mode apps))
9904 (dfile (downcase file))
9905 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9906 (link (cond ((and (eq line nil)
9907 (eq search nil))
9908 file)
9909 (line
9910 (concat file "::" (number-to-string line)))
9911 (search
9912 (concat file "::" search))))
9913 (dlink (downcase link))
9914 (old-buffer (current-buffer))
9915 (old-pos (point))
9916 (old-mode major-mode)
9917 ext cmd link-match-data)
9919 (setq ext (match-string 1 dfile))
9921 (setq ext (match-string 1 dfile))))
9922 (cond
9923 ((member in-emacs '((16) system))
9924 (setq cmd (cdr (assoc 'system apps))))
9925 (in-emacs (setq cmd 'emacs))
9926 (t
9927 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9928 (and dirp (cdr (assoc 'directory apps)))
9929 ; first, try matching against apps-dlink
9930 ; if we get a match here, store the match data for later
9931 (let ((match (assoc-default dlink apps-dlink
9932 'string-match)))
9933 (if match
9934 (progn (setq link-match-data (match-data))
9935 match)
9936 (progn (setq in-emacs (or in-emacs line search))
9937 nil))) ; if we have no match in apps-dlink,
9938 ; always open the file in emacs if line or search
9939 ; is given (for backwards compatibility)
9940 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9941 'string-match)
9942 (cdr (assoc ext apps))
9943 (cdr (assoc t apps))))))
9944 (when (eq cmd 'system)
9945 (setq cmd (cdr (assoc 'system apps))))
9946 (when (eq cmd 'default)
9947 (setq cmd (cdr (assoc t apps))))
9948 (when (eq cmd 'mailcap)
9949 (require 'mailcap)
9950 (mailcap-parse-mailcaps)
9951 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9952 (command (mailcap-mime-info mime-type)))
9953 (if (stringp command)
9954 (setq cmd command)
9955 (setq cmd 'emacs))))
9956 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9957 (not (file-exists-p file))
9958 (not org-open-non-existing-files))
9959 (error "No such file: %s" file))
9960 (cond
9962 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9964 (setq cmd (replace-match "%s" t t cmd)))
9965 (while (string-match "%s" cmd)
9966 (setq cmd (replace-match
9967 (save-match-data
9968 (shell-quote-argument
9969 (convert-standard-filename file)))
9970 t t cmd)))
9972 ;; Replace "%1", "%2" etc. in command with group matches from regex
9973 (save-match-data
9974 (let ((match-index 1)
9975 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9976 (set-match-data link-match-data)
9977 (while (<= match-index number-of-groups)
9978 (let ((regex (concat "%" (number-to-string match-index)))
9979 (replace-with (match-string match-index dlink)))
9980 (while (string-match regex cmd)
9981 (setq cmd (replace-match replace-with t t cmd))))
9982 (setq match-index (+ match-index 1)))))
9984 (save-window-excursion
9985 (start-process-shell-command cmd nil cmd)
9986 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9987 ))
9988 ((or (stringp cmd)
9989 (eq cmd 'emacs))
9990 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9991 (widen)
9992 (if line (org-goto-line line)
9993 (if search (org-link-search search))))
9994 ((consp cmd)
9995 (let ((file (convert-standard-filename file)))
9996 (save-match-data
9997 (set-match-data link-match-data)
9998 (eval cmd))))
9999 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10000 (and (org-mode-p) (eq old-mode 'org-mode)
10001 (or (not (equal old-buffer (current-buffer)))
10002 (not (equal old-pos (point))))
10003 (org-mark-ring-push old-pos old-buffer))))
10005 (defun org-file-apps-entry-match-against-dlink-p (entry)
10006 "This function returns non-nil if `entry' uses a regular
10007 expression which should be matched against the whole link by
10008 org-open-file.
10010 It assumes that is the case when the entry uses a regular
10011 expression which has at least one grouping construct and the
10012 action is either a lisp form or a command string containing
10013 '%1', i.e. using at least one subexpression match as a
10014 parameter."
10015 (let ((selector (car entry))
10016 (action (cdr entry)))
10017 (if (stringp selector)
10018 (and (> (regexp-opt-depth selector) 0)
10019 (or (and (stringp action)
10020 (string-match "%[0-9]" action))
10021 (consp action)))
10022 nil)))
10024 (defun org-default-apps ()
10025 "Return the default applications for this operating system."
10026 (cond
10027 ((eq system-type 'darwin)
10028 org-file-apps-defaults-macosx)
10029 ((eq system-type 'windows-nt)
10030 org-file-apps-defaults-windowsnt)
10031 (t org-file-apps-defaults-gnu)))
10033 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10034 "Convert extensions to regular expressions in the cars of LIST.
10035 Also, weed out any non-string entries, because the return value is used
10036 only for regexp matching.
10037 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10038 point to the symbol `emacs', indicating that the file should
10039 be opened in Emacs."
10040 (append
10041 (delq nil
10042 (mapcar (lambda (x)
10043 (if (not (stringp (car x)))
10044 nil
10046 x
10048 list))
10049 (if add-auto-mode
10050 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10052 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10053 (defun org-file-remote-p (file)
10054 "Test whether FILE specifies a location on a remote system.
10055 Return non-nil if the location is indeed remote.
10059 (cond ((fboundp 'file-remote-p)
10060 (file-remote-p file))
10061 ((fboundp 'tramp-handle-file-remote-p)
10062 (tramp-handle-file-remote-p file))
10063 ((and (boundp 'ange-ftp-name-format)
10064 (string-match (car ange-ftp-name-format) file))
10065 t)
10066 (t nil)))
10069 ;;;; Refiling
10071 (defun org-get-org-file ()
10072 "Read a filename, with default directory `org-directory'."
10073 (let ((default (or org-default-notes-file remember-data-file)))
10074 (read-file-name (format "File name [%s]: " default)
10075 (file-name-as-directory org-directory)
10076 default)))
10078 (defun org-notes-order-reversed-p ()
10079 "Check if the current file should receive notes in reversed order."
10080 (cond
10081 ((not org-reverse-note-order) nil)
10082 ((eq t org-reverse-note-order) t)
10083 ((not (listp org-reverse-note-order)) nil)
10084 (t (catch 'exit
10085 (let ((all org-reverse-note-order)
10086 entry)
10087 (while (setq entry (pop all))
10088 (if (string-match (car entry) buffer-file-name)
10089 (throw 'exit (cdr entry))))
10090 nil)))))
10092 (defvar org-refile-target-table nil
10093 "The list of refile targets, created by `org-refile'.")
10095 (defvar org-agenda-new-buffers nil
10096 "Buffers created to visit agenda files.")
10098 (defvar org-refile-cache nil
10099 "Cache for refile targets.")
10101 (defvar org-refile-markers nil
10102 "All the markers used for caching refile locations.")
10104 (defun org-refile-marker (pos)
10105 "Get a new refile marker, but only if caching is in use."
10106 (if (not org-refile-use-cache)
10107 pos
10108 (let ((m (make-marker)))
10109 (move-marker m pos)
10110 (push m org-refile-markers)
10111 m)))
10113 (defun org-refile-cache-clear ()
10114 "Clear the refile cache and disable all the markers."
10115 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10116 (setq org-refile-markers nil)
10117 (setq org-refile-cache nil)
10118 (message "Refile cache has been cleared"))
10120 (defun org-refile-cache-check-set (set)
10121 "Check if all the markers in the cache still have live buffers."
10122 (let (marker)
10123 (catch 'exit
10124 (while (and set (setq marker (nth 3 (pop set))))
10125 ;; if org-refile-use-outline-path is 'file, marker may be nil
10126 (when (and marker (null (marker-buffer marker)))
10127 (message "not found") (sit-for 3)
10128 (throw 'exit nil)))
10129 t)))
10131 (defun org-refile-cache-put (set &rest identifiers)
10132 "Push the refile targets SET into the cache, under IDENTIFIERS."
10133 (let* ((key (sha1 (prin1-to-string identifiers)))
10134 (entry (assoc key org-refile-cache)))
10135 (if entry
10136 (setcdr entry set)
10137 (push (cons key set) org-refile-cache))))
10139 (defun org-refile-cache-get (&rest identifiers)
10140 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10141 (cond
10142 ((not org-refile-cache) nil)
10143 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10144 (t
10145 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10146 org-refile-cache))))
10147 (and set (org-refile-cache-check-set set) set)))))
10149 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10150 "Produce a table with refile targets."
10151 (let ((case-fold-search nil)
10152 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10153 (entries (or org-refile-targets '((nil . (:level . 1)))))
10154 targets tgs txt re files f desc descre fast-path-p level pos0)
10155 (message "Getting targets...")
10156 (with-current-buffer (or default-buffer (current-buffer))
10157 (while (setq entry (pop entries))
10158 (setq files (car entry) desc (cdr entry))
10159 (setq fast-path-p nil)
10160 (cond
10161 ((null files) (setq files (list (current-buffer))))
10162 ((eq files 'org-agenda-files)
10163 (setq files (org-agenda-files 'unrestricted)))
10164 ((and (symbolp files) (fboundp files))
10165 (setq files (funcall files)))
10166 ((and (symbolp files) (boundp files))
10167 (setq files (symbol-value files))))
10168 (if (stringp files) (setq files (list files)))
10169 (cond
10170 ((eq (car desc) :tag)
10172 ((eq (car desc) :todo)
10174 ((eq (car desc) :regexp)
10175 (setq descre (cdr desc)))
10176 ((eq (car desc) :level)
10178 (if org-odd-levels-only
10179 (1- (* 2 (cdr desc)))
10180 (cdr desc)))
10182 ((eq (car desc) :maxlevel)
10183 (setq fast-path-p t)
10185 (if org-odd-levels-only
10186 (1- (* 2 (cdr desc)))
10187 (cdr desc)))
10189 (t (error "Bad refiling target description %s" desc)))
10190 (while (setq f (pop files))
10191 (with-current-buffer
10192 (if (bufferp f) f (org-get-agenda-file-buffer f))
10193 (or
10194 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10195 (progn
10196 (if (bufferp f) (setq f (buffer-file-name
10197 (buffer-base-buffer f))))
10198 (setq f (and f (expand-file-name f)))
10199 (if (eq org-refile-use-outline-path 'file)
10200 (push (list (file-name-nondirectory f) f nil nil) tgs))
10201 (save-excursion
10202 (save-restriction
10203 (widen)
10204 (goto-char (point-min))
10205 (while (re-search-forward descre nil t)
10206 (goto-char (setq pos0 (point-at-bol)))
10207 (catch 'next
10208 (when org-refile-target-verify-function
10209 (save-match-data
10210 (or (funcall org-refile-target-verify-function)
10211 (throw 'next t))))
10212 (when (and (looking-at org-complex-heading-regexp)
10213 (not (member (match-string 4) excluded-entries)))
10214 (setq level (org-reduced-level
10215 (- (match-end 1) (match-beginning 1)))
10216 txt (org-link-display-format (match-string 4))
10218 re (format org-complex-heading-regexp-format
10219 (regexp-quote (match-string 4))))
10220 (when org-refile-use-outline-path
10221 (setq txt (mapconcat
10222 'org-protect-slash
10223 (append
10224 (if (eq org-refile-use-outline-path
10225 'file)
10226 (list (file-name-nondirectory
10227 (buffer-file-name
10228 (buffer-base-buffer))))
10229 (if (eq org-refile-use-outline-path
10230 'full-file-path)
10231 (list (buffer-file-name
10232 (buffer-base-buffer)))))
10233 (org-get-outline-path fast-path-p
10234 level txt)
10235 (list txt))
10236 "/")))
10237 (push (list txt f re (org-refile-marker (point)))
10238 tgs)))
10239 (when (= (point) pos0)
10240 ;; verification function has not moved point
10241 (goto-char (point-at-eol))))))))
10242 (when org-refile-use-cache
10243 (org-refile-cache-put tgs (buffer-file-name) descre))
10244 (setq targets (append tgs targets))
10245 ))))
10246 (message "Getting targets...done")
10247 (nreverse targets)))
10249 (defun org-protect-slash (s)
10250 (while (string-match "/" s)
10252 s)
10254 (defvar org-olpa (make-vector 20 nil))
10256 (defun org-get-outline-path (&optional fastp level heading)
10257 "Return the outline path to the current entry, as a list.
10259 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10260 routine which makes outline path derivations for an entire file,
10261 avoiding backtracing. Refile target collection makes use of that."
10262 (if fastp
10263 (progn
10264 (if (> level 19)
10265 (error "Outline path failure, more than 19 levels"))
10266 (loop for i from level upto 19 do
10267 (aset org-olpa i nil))
10268 (prog1
10269 (delq nil (append org-olpa nil))
10270 (aset org-olpa level heading)))
10271 (let (rtn case-fold-search)
10272 (save-excursion
10273 (save-restriction
10274 (widen)
10275 (while (org-up-heading-safe)
10276 (when (looking-at org-complex-heading-regexp)
10277 (push (org-match-string-no-properties 4) rtn)))
10278 rtn)))))
10280 (defun org-format-outline-path (path &optional width prefix)
10281 "Format the outline path PATH for display.
10282 Width is the maximum number of characters that is available.
10283 Prefix is a prefix to be included in the returned string,
10284 such as the file name."
10285 (setq width (or width 79))
10286 (if prefix (setq width (- width (length prefix))))
10287 (if (not path)
10288 (or prefix "")
10289 (let* ((nsteps (length path))
10290 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10291 (maxwidth (if (<= total-width width)
10292 10000 ;; everything fits
10293 ;; we need to shorten the level headings
10294 (/ (- width nsteps) nsteps)))
10295 (org-odd-levels-only nil)
10296 (n 0)
10297 (total (1+ (length prefix))))
10298 (setq maxwidth (max maxwidth 10))
10299 (concat prefix
10300 (mapconcat
10301 (lambda (h)
10302 (setq n (1+ n))
10303 (if (and (= n nsteps) (< maxwidth 10000))
10304 (setq maxwidth (- total-width total)))
10305 (if (< (length h) maxwidth)
10306 (progn (setq total (+ total (length h) 1)) h)
10307 (setq h (substring h 0 (- maxwidth 2))
10308 total (+ total maxwidth 1))
10310 (setq h (substring h 0 (match-beginning 0))))
10311 (setq h (concat h "..")))
10312 (org-add-props h nil 'face
10313 (nth (% (1- n) org-n-level-faces)
10314 org-level-faces))
10315 h)
10316 path "/")))))
10318 (defun org-display-outline-path (&optional file current)
10319 "Display the current outline path in the echo area."
10320 (interactive "P")
10321 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10322 (case-fold-search nil)
10323 (path (and (org-mode-p) (org-get-outline-path))))
10324 (if current (setq path (append path
10325 (save-excursion
10326 (org-back-to-heading t)
10327 (if (looking-at org-complex-heading-regexp)
10328 (list (match-string 4)))))))
10329 (message "%s"
10330 (org-format-outline-path
10331 path
10332 (1- (frame-width))
10333 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10335 (defvar org-refile-history nil
10336 "History for refiling operations.")
10338 (defvar org-after-refile-insert-hook nil
10339 "Hook run after `org-refile' has inserted its stuff at the new location.
10340 Note that this is still *before* the stuff will be removed from
10341 the *old* location.")
10343 (defvar org-capture-last-stored-marker)
10344 (defun org-refile (&optional goto default-buffer rfloc)
10345 "Move the entry or entries at point to another heading.
10346 The list of target headings is compiled using the information in
10347 `org-refile-targets', which see.
10349 At the target location, the entry is filed as a subitem of the target
10350 heading. Depending on `org-reverse-note-order', the new subitem will
10351 either be the first or the last subitem.
10353 If there is an active region, all entries in that region will be moved.
10354 However, the region must fulfill the requirement that the first heading
10355 is the first one sets the top-level of the moved text - at most siblings
10356 below it are allowed.
10358 With prefix arg GOTO, the command will only visit the target location
10359 and not actually move anything.
10362 go to the location where the last refiling operation has put the subtree.
10363 With a prefix argument of `2', refile to the running clock.
10365 RFLOC can be a refile location obtained in a different way.
10367 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10369 If you are using target caching (see `org-refile-use-cache'),
10370 You have to clear the target cache in order to find new targets.
10371 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10372 prefix argument (`C-u C-u C-u C-c C-w')."
10374 (interactive "P")
10375 (if (member goto '(0 (64)))
10376 (org-refile-cache-clear)
10377 (let* ((cbuf (current-buffer))
10378 (regionp (org-region-active-p))
10379 (region-start (and regionp (region-beginning)))
10380 (region-end (and regionp (region-end)))
10381 (region-length (and regionp (- region-end region-start)))
10382 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10383 pos it nbuf file re level reversed)
10384 (setq last-command nil)
10385 (when regionp
10386 (goto-char region-start)
10387 (or (bolp) (goto-char (point-at-bol)))
10388 (setq region-start (point))
10389 (unless (org-kill-is-subtree-p
10390 (buffer-substring region-start region-end))
10391 (error "The region is not a (sequence of) subtree(s)")))
10392 (if (equal goto '(16))
10393 (org-refile-goto-last-stored)
10394 (when (or
10395 (and (equal goto 2)
10396 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10397 (prog1
10398 (setq it (list (or org-clock-heading "running clock")
10399 (buffer-file-name
10400 (marker-buffer org-clock-hd-marker))
10401 ""
10402 (marker-position org-clock-hd-marker)))
10403 (setq goto nil)))
10404 (setq it (or rfloc
10405 (save-excursion
10406 (org-refile-get-location
10407 (if goto "Goto" "Refile to") default-buffer
10408 org-refile-allow-creating-parent-nodes)))))
10409 (setq file (nth 1 it)
10410 re (nth 2 it)
10411 pos (nth 3 it))
10412 (if (and (not goto)
10413 pos
10414 (equal (buffer-file-name) file)
10415 (if regionp
10416 (and (>= pos region-start)
10417 (<= pos region-end))
10418 (and (>= pos (point))
10419 (< pos (save-excursion
10420 (org-end-of-subtree t t))))))
10421 (error "Cannot refile to position inside the tree or region"))
10423 (setq nbuf (or (find-buffer-visiting file)
10424 (find-file-noselect file)))
10425 (if goto
10426 (progn
10427 (org-pop-to-buffer-same-window nbuf)
10428 (goto-char pos)
10429 (org-show-context 'org-goto))
10430 (if regionp
10431 (progn
10432 (org-kill-new (buffer-substring region-start region-end))
10433 (org-save-markers-in-region region-start region-end))
10434 (org-copy-subtree 1 nil t))
10435 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10436 (find-file-noselect file)))
10437 (setq reversed (org-notes-order-reversed-p))
10438 (save-excursion
10439 (save-restriction
10440 (widen)
10441 (if pos
10442 (progn
10443 (goto-char pos)
10444 (looking-at org-outline-regexp)
10445 (setq level (org-get-valid-level (funcall outline-level) 1))
10446 (goto-char
10447 (if reversed
10448 (or (outline-next-heading) (point-max))
10449 (or (save-excursion (org-get-next-sibling))
10450 (org-end-of-subtree t t)
10451 (point-max)))))
10452 (setq level 1)
10453 (if (not reversed)
10454 (goto-char (point-max))
10455 (goto-char (point-min))
10456 (or (outline-next-heading) (goto-char (point-max)))))
10457 (if (not (bolp)) (newline))
10458 (org-paste-subtree level)
10459 (when org-log-refile
10460 (org-add-log-setup 'refile nil nil 'findpos
10461 org-log-refile)
10462 (unless (eq org-log-refile 'note)
10463 (save-excursion (org-add-log-note))))
10464 (and org-auto-align-tags (org-set-tags nil t))
10465 (bookmark-set "org-refile-last-stored")
10466 ;; If we are refiling for capture, make sure that the
10467 ;; last-capture pointers point here
10468 (when (org-bound-and-true-p org-refile-for-capture)
10469 (bookmark-set "org-capture-last-stored-marker")
10470 (move-marker org-capture-last-stored-marker (point)))
10471 (if (fboundp 'deactivate-mark) (deactivate-mark))
10472 (run-hooks 'org-after-refile-insert-hook))))
10473 (if regionp
10474 (delete-region (point) (+ (point) region-length))
10475 (org-cut-subtree))
10476 (when (featurep 'org-inlinetask)
10477 (org-inlinetask-remove-END-maybe))
10478 (setq org-markers-to-move nil)
10481 (defun org-refile-goto-last-stored ()
10482 "Go to the location where the last refile was stored."
10483 (interactive)
10484 (bookmark-jump "org-refile-last-stored")
10485 (message "This is the location of the last refile"))
10487 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10488 "Prompt the user for a refile location, using PROMPT.
10489 PROMPT should not be suffixed with a colon and a space, because
10490 this function appends the default value from
10491 `org-refile-history' automatically, if that is not empty."
10492 (let ((org-refile-targets org-refile-targets)
10493 (org-refile-use-outline-path org-refile-use-outline-path)
10494 excluded-entries)
10495 (when (and (eq major-mode 'org-mode)
10496 (not org-refile-use-cache))
10497 (org-map-tree
10498 (lambda()
10499 (setq excluded-entries
10500 (append excluded-entries (list (org-get-heading t t)))))))
10501 (setq org-refile-target-table
10502 (org-refile-get-targets default-buffer excluded-entries)))
10503 (unless org-refile-target-table
10504 (error "No refile targets"))
10505 (let* ((prompt (concat prompt
10506 (and (car org-refile-history)
10507 (concat " (default " (car org-refile-history) ")"))
10508 ": "))
10509 (cbuf (current-buffer))
10510 (partial-completion-mode nil)
10511 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10512 (cfunc (if (and org-refile-use-outline-path
10513 org-outline-path-complete-in-steps)
10514 'org-olpath-completing-read
10515 'org-icompleting-read))
10516 (extra (if org-refile-use-outline-path "/" ""))
10517 (filename (and cfn (expand-file-name cfn)))
10518 (tbl (mapcar
10519 (lambda (x)
10520 (if (and (not (member org-refile-use-outline-path
10521 '(file full-file-path)))
10522 (not (equal filename (nth 1 x))))
10523 (cons (concat (car x) extra " ("
10524 (file-name-nondirectory (nth 1 x)) ")")
10525 (cdr x))
10526 (cons (concat (car x) extra) (cdr x))))
10527 org-refile-target-table))
10528 (completion-ignore-case t)
10529 pa answ parent-target child parent old-hist)
10530 (setq old-hist org-refile-history)
10531 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10532 nil 'org-refile-history (car org-refile-history)))
10533 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10534 (org-refile-check-position pa)
10535 (if pa
10536 (progn
10537 (when (or (not org-refile-history)
10538 (not (eq old-hist org-refile-history))
10539 (not (equal (car pa) (car org-refile-history))))
10540 (setq org-refile-history
10541 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10542 org-refile-history
10543 (cdr org-refile-history))))
10544 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10545 (pop org-refile-history)))
10546 pa)
10548 (progn
10549 (setq parent (match-string 1 answ)
10550 child (match-string 2 answ))
10551 (setq parent-target (or (assoc parent tbl)
10552 (assoc (concat parent "/") tbl)))
10553 (when (and parent-target
10554 (or (eq new-nodes t)
10555 (and (eq new-nodes 'confirm)
10557 child)))))
10558 (org-refile-new-child parent-target child)))
10559 (error "Invalid target location")))))
10561 (defun org-refile-check-position (refile-pointer)
10562 "Check if the refile pointer matches the readline to which it points."
10563 (let* ((file (nth 1 refile-pointer))
10564 (re (nth 2 refile-pointer))
10565 (pos (nth 3 refile-pointer))
10566 buffer)
10567 (when (org-string-nw-p re)
10568 (setq buffer (if (markerp pos)
10569 (marker-buffer pos)
10570 (or (find-buffer-visiting file)
10571 (find-file-noselect file))))
10572 (with-current-buffer buffer
10573 (save-excursion
10574 (save-restriction
10575 (widen)
10576 (goto-char pos)
10577 (beginning-of-line 1)
10578 (unless (org-looking-at-p re)
10579 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10581 (defun org-refile-new-child (parent-target child)
10582 "Use refile target PARENT-TARGET to add new CHILD below it."
10583 (unless parent-target
10584 (error "Cannot find parent for new node"))
10585 (let ((file (nth 1 parent-target))
10586 (pos (nth 3 parent-target))
10587 level)
10588 (with-current-buffer (or (find-buffer-visiting file)
10589 (find-file-noselect file))
10590 (save-excursion
10591 (save-restriction
10592 (widen)
10593 (if pos
10594 (goto-char pos)
10595 (goto-char (point-max))
10596 (if (not (bolp)) (newline)))
10597 (when (looking-at org-outline-regexp)
10598 (setq level (funcall outline-level))
10599 (org-end-of-subtree t t))
10600 (org-back-over-empty-lines)
10602 (if pos (org-get-valid-level level 1) 1) ?*)
10604 (beginning-of-line 0)
10605 (list (concat (car parent-target) "/" child) file "" (point)))))))
10607 (defun org-olpath-completing-read (prompt collection &rest args)
10608 "Read an outline path like a file name."
10609 (let ((thetable collection)
10610 (org-completion-use-ido nil) ; does not work with ido.
10611 (org-completion-use-iswitchb nil)) ; or iswitchb
10612 (apply
10613 'org-icompleting-read prompt
10614 (lambda (string predicate &optional flag)
10615 (let (rtn r f (l (length string)))
10616 (cond
10617 ((eq flag nil)
10618 ;; try completion
10619 (try-completion string thetable))
10620 ((eq flag t)
10621 ;; all-completions
10622 (setq rtn (all-completions string thetable predicate))
10623 (mapcar
10624 (lambda (x)
10625 (setq r (substring x l))
10626 (if (string-match " ([^)]*)$" x)
10627 (setq f (match-string 0 x))
10628 (setq f ""))
10629 (if (string-match "/" r)
10630 (concat string (substring r 0 (match-end 0)) f)
10631 x))
10632 rtn))
10633 ((eq flag 'lambda)
10634 ;; exact match?
10635 (assoc string thetable)))
10636 ))
10637 args)))
10639 ;;;; Dynamic blocks
10641 (defun org-find-dblock (name)
10642 "Find the first dynamic block with name NAME in the buffer.
10643 If not found, stay at current position and return nil."
10644 (let (pos)
10645 (save-excursion
10646 (goto-char (point-min))
10648 nil t)
10649 (match-beginning 0))))
10650 (if pos (goto-char pos))
10651 pos))
10653 (defconst org-dblock-start-re
10655 "Matches the start line of a dynamic block, with parameters.")
10658 "Matches the end of a dynamic block.")
10660 (defun org-create-dblock (plist)
10661 "Create a dynamic block section, with parameters taken from PLIST.
10662 PLIST must contain a :name entry which is used as name of the block."
10664 (end-of-line 1)
10665 (newline))
10666 (let ((col (current-column))
10667 (name (plist-get plist :name)))
10668 (insert "#+BEGIN: " name)
10669 (while plist
10670 (if (eq (car plist) :name)
10671 (setq plist (cddr plist))
10672 (insert " " (prin1-to-string (pop plist)))))
10674 (beginning-of-line -2)))
10676 (defun org-prepare-dblock ()
10677 "Prepare dynamic block for refresh.
10678 This empties the block, puts the cursor at the insert position and returns
10679 the property list including an extra property :name with the block name."
10680 (unless (looking-at org-dblock-start-re)
10681 (error "Not at a dynamic block"))
10682 (let* ((begdel (1+ (match-end 0)))
10683 (name (org-no-properties (match-string 1)))
10684 (params (append (list :name name)
10685 (read (concat "(" (match-string 3) ")")))))
10686 (save-excursion
10687 (beginning-of-line 1)
10689 (setq params (plist-put params :indentation-column (current-column))))
10690 (unless (re-search-forward org-dblock-end-re nil t)
10691 (error "Dynamic block not terminated"))
10692 (setq params
10693 (append params
10694 (list :content (buffer-substring
10695 begdel (match-beginning 0)))))
10696 (delete-region begdel (match-beginning 0))
10697 (goto-char begdel)
10698 (open-line 1)
10699 params))
10701 (defun org-map-dblocks (&optional command)
10702 "Apply COMMAND to all dynamic blocks in the current buffer.
10703 If COMMAND is not given, use `org-update-dblock'."
10704 (let ((cmd (or command 'org-update-dblock)))
10705 (save-excursion
10706 (goto-char (point-min))
10707 (while (re-search-forward org-dblock-start-re nil t)
10708 (goto-char (match-beginning 0))
10709 (save-excursion
10710 (condition-case nil
10711 (funcall cmd)
10712 (error (message "Error during update of dynamic block"))))
10713 (unless (re-search-forward org-dblock-end-re nil t)
10714 (error "Dynamic block not terminated"))))))
10716 (defun org-dblock-update (&optional arg)
10717 "User command for updating dynamic blocks.
10718 Update the dynamic block at point. With prefix ARG, update all dynamic
10719 blocks in the buffer."
10720 (interactive "P")
10721 (if arg
10722 (org-update-all-dblocks)
10723 (or (looking-at org-dblock-start-re)
10724 (org-beginning-of-dblock))
10725 (org-update-dblock)))
10727 (defun org-update-dblock ()
10728 "Update the dynamic block at point.
10729 This means to empty the block, parse for parameters and then call
10730 the correct writing function."
10731 (interactive)
10732 (save-window-excursion
10733 (let* ((pos (point))
10734 (line (org-current-line))
10735 (params (org-prepare-dblock))
10736 (name (plist-get params :name))
10737 (indent (plist-get params :indentation-column))
10738 (cmd (intern (concat "org-dblock-write:" name))))
10739 (message "Updating dynamic block `%s' at line %d..." name line)
10740 (funcall cmd params)
10741 (message "Updating dynamic block `%s' at line %d...done" name line)
10742 (goto-char pos)
10743 (when (and indent (> indent 0))
10744 (setq indent (make-string indent ?\ ))
10745 (save-excursion
10746 (org-beginning-of-dblock)
10747 (forward-line 1)
10748 (while (not (looking-at org-dblock-end-re))
10749 (insert indent)
10750 (beginning-of-line 2))
10751 (when (looking-at org-dblock-end-re)
10753 (replace-match ""))
10754 (insert indent)))))))
10756 (defun org-beginning-of-dblock ()
10757 "Find the beginning of the dynamic block at point.
10758 Error if there is no such block at point."
10759 (let ((pos (point))
10760 beg)
10761 (end-of-line 1)
10762 (if (and (re-search-backward org-dblock-start-re nil t)
10763 (setq beg (match-beginning 0))
10764 (re-search-forward org-dblock-end-re nil t)
10765 (> (match-end 0) pos))
10766 (goto-char beg)
10767 (goto-char pos)
10768 (error "Not in a dynamic block"))))
10770 (defun org-update-all-dblocks ()
10771 "Update all dynamic blocks in the buffer.
10772 This function can be used in a hook."
10773 (interactive)
10774 (when (org-mode-p)
10775 (org-map-dblocks 'org-update-dblock)))
10778 ;;;; Completion
10780 (defconst org-additional-option-like-keywords
10781 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10782 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10783 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10784 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10785 "BEGIN:" "END:"
10786 "ORGTBL" "TBLFM:" "TBLNAME:"
10787 "BEGIN_EXAMPLE" "END_EXAMPLE"
10788 "BEGIN_QUOTE" "END_QUOTE"
10789 "BEGIN_VERSE" "END_VERSE"
10790 "BEGIN_CENTER" "END_CENTER"
10791 "BEGIN_SRC" "END_SRC"
10792 "BEGIN_RESULT" "END_RESULT"
10793 "SOURCE:" "SRCNAME:" "FUNCTION:"
10794 "RESULTS:" "DATA:"
10795 "HEADER:" "HEADERS:"
10796 "BABEL:"
10797 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10798 "CAPTION:" "LABEL:"
10799 "SETUPFILE:"
10800 "INCLUDE:"
10801 "BIND:"
10802 "MACRO:"))
10804 (defcustom org-structure-template-alist
10805 '(
10818 ("L" "#+latex: "
10822 ("H" "#+html: "
10825 ("A" "#+ascii: ")
10826 ("i" "#+index: ?"
10827 "#+index: ?")
10828 ("I" "#+include %file ?"
10830 )
10831 "Structure completion elements.
10832 This is a list of abbreviation keys and values. The value gets inserted
10833 if you type `<' followed by the key and then press the completion key,
10834 usually `M-TAB'. %file will be replaced by a file name after prompting
10835 for the file using completion. The cursor will be placed at the position
10836 of the `?` in the template.
10837 There are two templates for each key, the first uses the original Org syntax,
10838 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10839 the default when the /org-mtags.el/ module has been loaded. See also the
10840 variable `org-mtags-prefer-muse-templates'.
10841 This is an experimental feature, it is undecided if it is going to stay in."
10842 :group 'org-completion
10843 :type '(repeat
10844 (string :tag "Key")
10845 (string :tag "Template")
10846 (string :tag "Muse Template")))
10848 (defun org-try-structure-completion ()
10849 "Try to complete a structure template before point.
10851 expands them."
10852 (let ((l (buffer-substring (point-at-bol) (point)))
10853 a)
10856 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10857 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10858 (match-beginning 1)) a)
10859 t)))
10861 (defun org-complete-expand-structure-template (start cell)
10862 "Expand a structure template."
10863 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10864 (rpl (nth (if musep 2 1) cell))
10865 (ind ""))
10866 (delete-region start (point))
10868 (cond
10869 ((bolp))
10871 (setq ind (buffer-substring (point-at-bol) (point))))
10872 (t (newline))))
10873 (setq start (point))
10874 (if (string-match "%file" rpl)
10875 (setq rpl (replace-match
10876 (concat
10878 (save-match-data
10879 (abbreviate-file-name (read-file-name "Include file: ")))
10881 t t rpl)))
10884 (insert rpl)
10887 ;;;; TODO, DEADLINE, Comments
10889 (defun org-toggle-comment ()
10890 "Change the COMMENT state of an entry."
10891 (interactive)
10892 (save-excursion
10893 (org-back-to-heading)
10894 (let (case-fold-search)
10895 (if (looking-at (concat org-outline-regexp
10897 (replace-match "" t t nil 1)
10898 (if (looking-at org-outline-regexp)
10899 (progn
10900 (goto-char (match-end 0))
10901 (insert org-comment-string " ")))))))
10903 (defvar org-last-todo-state-is-todo nil
10904 "This is non-nil when the last TODO state change led to a TODO state.
10905 If the last change removed the TODO tag or switched to DONE, then
10906 this is nil.")
10908 (defvar org-setting-tags nil) ; dynamically skipped
10910 (defvar org-todo-setup-filter-hook nil
10911 "Hook for functions that pre-filter todo specs.
10912 Each function takes a todo spec and returns either nil or the spec
10913 transformed into canonical form." )
10915 (defvar org-todo-get-default-hook nil
10916 "Hook for functions that get a default item for todo.
10917 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10918 nil or a string to be used for the todo mark." )
10920 (defvar org-agenda-headline-snapshot-before-repeat)
10922 (defun org-current-effective-time ()
10923 "Return current time adjusted for `org-extend-today-until' variable"
10924 (let* ((ct (org-current-time))
10925 (dct (decode-time ct))
10926 (ct1
10927 (if (< (nth 2 dct) org-extend-today-until)
10928 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
10929 ct)))
10930 ct1))
10932 (defun org-todo-yesterday (&optional arg)
10933 "Like `org-todo' but the time of change will be 23:59 of yesterday"
10934 (interactive "P")
10935 (let* ((hour (third (decode-time
10936 (org-current-time))))
10937 (org-extend-today-until (1+ hour)))
10938 (org-todo arg)))
10940 (defun org-agenda-todo-yesterday (&optional arg)
10941 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday"
10942 (interactive "P")
10943 (let* ((hour (third (decode-time
10944 (org-current-time))))
10945 (org-extend-today-until (1+ hour)))
10946 (org-agenda-todo arg)))
10948 (defun org-todo (&optional arg)
10949 "Change the TODO state of an item.
10950 The state of an item is given by a keyword at the start of the heading,
10951 like
10952 *** TODO Write paper
10953 *** DONE Call mom
10955 The different keywords are specified in the variable `org-todo-keywords'.
10957 So for this example: when the item starts with TODO, it is changed to DONE.
10958 When it starts with DONE, the DONE is removed. And when neither TODO nor
10959 DONE are present, add TODO at the beginning of the heading.
10962 state.
10963 With numeric prefix arg, switch to that state.
10965 keywords (nextset).
10968 For calling through lisp, arg is also interpreted in the following way:
10969 'none -> empty state
10971 'done -> switch to DONE
10972 'nextset -> switch to the next set of keywords
10973 'previousset -> switch to the previous set of keywords
10975 really is a member of `org-todo-keywords'."
10976 (interactive "P")
10977 (if (equal arg '(16)) (setq arg 'nextset))
10978 (let ((org-blocker-hook org-blocker-hook)
10979 (case-fold-search nil))
10980 (when (equal arg '(64))
10981 (setq arg nil org-blocker-hook nil))
10982 (when (and org-blocker-hook
10983 (or org-inhibit-blocking
10984 (org-entry-get nil "NOBLOCKING")))
10985 (setq org-blocker-hook nil))
10986 (save-excursion
10987 (catch 'exit
10988 (org-back-to-heading t)
10989 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
10991 (looking-at " *"))
10992 (let* ((match-data (match-data))
10993 (startpos (point-at-bol))
10994 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10995 (org-log-done org-log-done)
10996 (org-log-repeat org-log-repeat)
10997 (org-todo-log-states org-todo-log-states)
10998 (this (match-string 1))
10999 (hl-pos (match-beginning 0))
11000 (head (org-get-todo-sequence-head this))
11001 (ass (assoc head org-todo-kwd-alist))
11002 (interpret (nth 1 ass))
11003 (done-word (nth 3 ass))
11004 (final-done-word (nth 4 ass))
11005 (last-state (or this ""))
11006 (completion-ignore-case t)
11007 (member (member this org-todo-keywords-1))
11008 (tail (cdr member))
11009 (state (cond
11010 ((and org-todo-key-trigger
11011 (or (and (equal arg '(4))
11012 (eq org-use-fast-todo-selection 'prefix))
11013 (and (not arg) org-use-fast-todo-selection
11014 (not (eq org-use-fast-todo-selection
11015 'prefix)))))
11016 ;; Use fast selection
11017 (org-fast-todo-selection))
11018 ((and (equal arg '(4))
11019 (or (not org-use-fast-todo-selection)
11020 (not org-todo-key-trigger)))
11021 ;; Read a state with completion
11022 (org-icompleting-read
11023 "State: " (mapcar (lambda(x) (list x))
11024 org-todo-keywords-1)
11025 nil t))
11026 ((eq arg 'right)
11027 (if this
11028 (if tail (car tail) nil)
11029 (car org-todo-keywords-1)))
11030 ((eq arg 'left)
11031 (if (equal member org-todo-keywords-1)
11032 nil
11033 (if this
11034 (nth (- (length org-todo-keywords-1)
11035 (length tail) 2)
11036 org-todo-keywords-1)
11037 (org-last org-todo-keywords-1))))
11038 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11039 (setq arg nil))) ; hack to fall back to cycling
11040 (arg
11041 ;; user or caller requests a specific state
11042 (cond
11043 ((equal arg "") nil)
11044 ((eq arg 'none) nil)
11045 ((eq arg 'done) (or done-word (car org-done-keywords)))
11046 ((eq arg 'nextset)
11047 (or (car (cdr (member head org-todo-heads)))
11048 (car org-todo-heads)))
11049 ((eq arg 'previousset)
11050 (let ((org-todo-heads (reverse org-todo-heads)))
11051 (or (car (cdr (member head org-todo-heads)))
11052 (car org-todo-heads))))
11053 ((car (member arg org-todo-keywords-1)))
11054 ((stringp arg)
11055 (error "State `%s' not valid in this file" arg))
11056 ((nth (1- (prefix-numeric-value arg))
11057 org-todo-keywords-1))))
11058 ((null member) (or head (car org-todo-keywords-1)))
11059 ((equal this final-done-word) nil) ;; -> make empty
11060 ((null tail) nil) ;; -> first entry
11061 ((memq interpret '(type priority))
11062 (if (eq this-command last-command)
11063 (car tail)
11064 (if (> (length tail) 0)
11065 (or done-word (car org-done-keywords))
11066 nil)))
11067 (t
11068 (car tail))))
11069 (state (or
11070 (run-hook-with-args-until-success
11071 'org-todo-get-default-hook state last-state)
11072 state))
11073 (next (if state (concat " " state " ") " "))
11074 (change-plist (list :type 'todo-state-change :from this :to state
11075 :position startpos))
11076 dolog now-done-p)
11077 (when org-blocker-hook
11078 (setq org-last-todo-state-is-todo
11079 (not (member this org-done-keywords)))
11080 (unless (save-excursion
11081 (save-match-data
11082 (org-with-wide-buffer
11083 (run-hook-with-args-until-failure
11084 'org-blocker-hook change-plist))))
11085 (if (org-called-interactively-p 'interactive)
11086 (error "TODO state change from %s to %s blocked" this state)
11087 ;; fail silently
11088 (message "TODO state change from %s to %s blocked" this state)
11089 (throw 'exit nil))))
11090 (store-match-data match-data)
11091 (replace-match next t t)
11092 (unless (pos-visible-in-window-p hl-pos)
11093 (message "TODO state changed to %s" (org-trim next)))
11094 (unless head
11095 (setq head (org-get-todo-sequence-head state)
11096 ass (assoc head org-todo-kwd-alist)
11097 interpret (nth 1 ass)
11098 done-word (nth 3 ass)
11099 final-done-word (nth 4 ass)))
11100 (when (memq arg '(nextset previousset))
11101 (message "Keyword-Set %d/%d: %s"
11102 (- (length org-todo-sets) -1
11103 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11104 (length org-todo-sets)
11105 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11106 (setq org-last-todo-state-is-todo
11107 (not (member state org-done-keywords)))
11108 (setq now-done-p (and (member state org-done-keywords)
11109 (not (member this org-done-keywords))))
11110 (and logging (org-local-logging logging))
11111 (when (and (or org-todo-log-states org-log-done)
11112 (not (eq org-inhibit-logging t))
11113 (not (memq arg '(nextset previousset))))
11114 ;; we need to look at recording a time and note
11115 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11116 (nth 2 (assoc this org-todo-log-states))))
11117 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11118 (setq dolog 'time))
11119 (when (and state
11120 (member state org-not-done-keywords)
11121 (not (member this org-not-done-keywords)))
11122 ;; This is now a todo state and was not one before
11123 ;; If there was a CLOSED time stamp, get rid of it.
11124 (org-add-planning-info nil nil 'closed))
11125 (when (and now-done-p org-log-done)
11126 ;; It is now done, and it was not done before
11127 (org-add-planning-info 'closed (org-current-effective-time))
11128 (if (and (not dolog) (eq 'note org-log-done))
11129 (org-add-log-setup 'done state this 'findpos 'note)))
11130 (when (and state dolog)
11131 ;; This is a non-nil state, and we need to log it
11132 (org-add-log-setup 'state state this 'findpos dolog)))
11133 ;; Fixup tag positioning
11134 (org-todo-trigger-tag-changes state)
11135 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11136 (when org-provide-todo-statistics
11137 (org-update-parent-todo-statistics))
11138 (run-hooks 'org-after-todo-state-change-hook)
11139 (if (and arg (not (member state org-done-keywords)))
11140 (setq head (org-get-todo-sequence-head state)))
11141 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11142 ;; Do we need to trigger a repeat?
11143 (when now-done-p
11144 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11145 ;; This is for the agenda, take a snapshot of the headline.
11146 (save-match-data
11147 (setq org-agenda-headline-snapshot-before-repeat
11148 (org-get-heading))))
11149 (org-auto-repeat-maybe state))
11150 ;; Fixup cursor location if close to the keyword
11151 (if (and (outline-on-heading-p)
11152 (not (bolp))
11153 (save-excursion (beginning-of-line 1)
11154 (looking-at org-todo-line-regexp))
11155 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11156 (progn
11157 (goto-char (or (match-end 2) (match-end 1)))
11158 (and (looking-at " ") (just-one-space))))
11159 (when org-trigger-hook
11160 (save-excursion
11161 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11163 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11164 "Block turning an entry into a TODO, using the hierarchy.
11165 This checks whether the current task should be blocked from state
11166 changes. Such blocking occurs when:
11168 1. The task has children which are not all in a completed state.
11170 2. A task has a parent with the property :ORDERED:, and there
11171 are siblings prior to the current task with incomplete
11172 status.
11174 3. The parent of the task is blocked because it has siblings that should
11175 be done first, or is child of a block grandparent TODO entry."
11177 (if (not org-enforce-todo-dependencies)
11178 t ; if locally turned off don't block
11179 (catch 'dont-block
11180 ;; If this is not a todo state change, or if this entry is already DONE,
11181 ;; do not block
11182 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11183 (member (plist-get change-plist :from)
11184 (cons 'done org-done-keywords))
11185 (member (plist-get change-plist :to)
11186 (cons 'todo org-not-done-keywords))
11187 (not (plist-get change-plist :to)))
11188 (throw 'dont-block t))
11189 ;; If this task has children, and any are undone, it's blocked
11190 (save-excursion
11191 (org-back-to-heading t)
11192 (let ((this-level (funcall outline-level)))
11193 (outline-next-heading)
11194 (let ((child-level (funcall outline-level)))
11195 (while (and (not (eobp))
11196 (> child-level this-level))
11197 ;; this todo has children, check whether they are all
11198 ;; completed
11199 (if (and (not (org-entry-is-done-p))
11200 (org-entry-is-todo-p))
11201 (throw 'dont-block nil))
11202 (outline-next-heading)
11203 (setq child-level (funcall outline-level))))))
11204 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11205 ;; any previous siblings are undone, it's blocked
11206 (save-excursion
11207 (org-back-to-heading t)
11208 (let* ((pos (point))
11209 (parent-pos (and (org-up-heading-safe) (point))))
11210 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11211 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11212 (forward-line 1)
11213 (re-search-forward org-not-done-heading-regexp pos t))
11214 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11215 ;; Search further up the hierarchy, to see if an anchestor is blocked
11216 (while t
11217 (goto-char parent-pos)
11218 (if (not (looking-at org-not-done-heading-regexp))
11219 (throw 'dont-block t)) ; do not block, parent is not a TODO
11220 (setq pos (point))
11221 (setq parent-pos (and (org-up-heading-safe) (point)))
11222 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11223 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11224 (forward-line 1)
11225 (re-search-forward org-not-done-heading-regexp pos t))
11226 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11228 (defcustom org-track-ordered-property-with-tag nil
11229 "Should the ORDERED property also be shown as a tag?
11230 The ORDERED property decides if an entry should require subtasks to be
11231 completed in sequence. Since a property is not very visible, setting
11232 this option means that toggling the ORDERED property with the command
11233 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11234 not relevant for the behavior, but it makes things more visible.
11236 Note that toggling the tag with tags commands will not change the property
11237 and therefore not influence behavior!
11239 This can be t, meaning the tag ORDERED should be used, It can also be a
11240 string to select a different tag for this task."
11241 :group 'org-todo
11242 :type '(choice
11243 (const :tag "No tracking" nil)
11244 (const :tag "Track with ORDERED tag" t)
11245 (string :tag "Use other tag")))
11247 (defun org-toggle-ordered-property ()
11248 "Toggle the ORDERED property of the current entry.
11249 For better visibility, you can track the value of this property with a tag.
11250 See variable `org-track-ordered-property-with-tag'."
11251 (interactive)
11252 (let* ((t1 org-track-ordered-property-with-tag)
11253 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11254 (save-excursion
11255 (org-back-to-heading)
11256 (if (org-entry-get nil "ORDERED")
11257 (progn
11258 (org-delete-property "ORDERED")
11259 (and tag (org-toggle-tag tag 'off))
11260 (message "Subtasks can be completed in arbitrary order"))
11261 (org-entry-put nil "ORDERED" "t")
11262 (and tag (org-toggle-tag tag 'on))
11263 (message "Subtasks must be completed in sequence")))))
11265 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11266 (defun org-block-todo-from-checkboxes (change-plist)
11267 "Block turning an entry into a TODO, using checkboxes.
11268 This checks whether the current task should be blocked from state
11269 changes because there are unchecked boxes in this entry."
11270 (if (not org-enforce-todo-checkbox-dependencies)
11271 t ; if locally turned off don't block
11272 (catch 'dont-block
11273 ;; If this is not a todo state change, or if this entry is already DONE,
11274 ;; do not block
11275 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11276 (member (plist-get change-plist :from)
11277 (cons 'done org-done-keywords))
11278 (member (plist-get change-plist :to)
11279 (cons 'todo org-not-done-keywords))
11280 (not (plist-get change-plist :to)))
11281 (throw 'dont-block t))
11282 ;; If this task has checkboxes that are not checked, it's blocked
11283 (save-excursion
11284 (org-back-to-heading t)
11285 (let ((beg (point)) end)
11286 (outline-next-heading)
11287 (setq end (point))
11288 (goto-char beg)
11290 end t)
11291 (progn
11292 (if (boundp 'org-blocked-by-checkboxes)
11293 (setq org-blocked-by-checkboxes t))
11294 (throw 'dont-block nil)))))
11295 t))) ; do not block
11297 (defun org-entry-blocked-p ()
11298 "Is the current entry blocked?"
11299 (if (org-entry-get nil "NOBLOCKING")
11300 nil ;; Never block this entry
11301 (not
11302 (run-hook-with-args-until-failure
11303 'org-blocker-hook
11304 (list :type 'todo-state-change
11305 :position (point)
11306 :from 'todo
11307 :to 'done)))))
11309 (defun org-update-statistics-cookies (all)
11310 "Update the statistics cookie, either from TODO or from checkboxes.
11311 This should be called with the cursor in a line with a statistics cookie."
11312 (interactive "P")
11313 (if all
11314 (progn
11315 (org-update-checkbox-count 'all)
11316 (org-map-entries 'org-update-parent-todo-statistics))
11317 (if (not (org-on-heading-p))
11318 (org-update-checkbox-count)
11319 (let ((pos (move-marker (make-marker) (point)))
11320 end l1 l2)
11321 (ignore-errors (org-back-to-heading t))
11322 (if (not (org-on-heading-p))
11323 (org-update-checkbox-count)
11324 (setq l1 (org-outline-level))
11325 (setq end (save-excursion
11326 (outline-next-heading)
11327 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11328 (point)))
11329 (if (and (save-excursion
11330 (re-search-forward
11332 (not (save-excursion (re-search-forward
11334 (org-update-checkbox-count)
11335 (if (and l2 (> l2 l1))
11336 (progn
11337 (goto-char end)
11338 (org-update-parent-todo-statistics))
11339 (goto-char pos)
11340 (beginning-of-line 1)
11341 (while (re-search-forward
11343 (point-at-eol) t)
11344 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11345 (goto-char pos)
11346 (move-marker pos nil)))))
11348 (defvar org-entry-property-inherited-from) ;; defined below
11349 (defun org-update-parent-todo-statistics ()
11350 "Update any statistics cookie in the parent of the current headline.
11351 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11352 the entire subtree and this will travel up the hierarchy and update
11353 statistics everywhere."
11354 (let* ((prop (save-excursion (org-up-heading-safe)
11355 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11356 (recursive (or (not org-hierarchical-todo-statistics)
11358 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11359 0))
11360 (first t)
11362 level ltoggle l1 new ndel
11363 (cnt-all 0) (cnt-done 0) is-percent kwd
11364 checkbox-beg ov ovs ove cookie-present)
11365 (catch 'exit
11366 (save-excursion
11367 (beginning-of-line 1)
11368 (setq ltoggle (funcall outline-level))
11369 ;; Three situations are to consider:
11371 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11372 ;; to the top-level ancestor on the headline;
11374 ;; 2. If parent has "recursive" property, repeat up to the
11375 ;; headline setting that property, taking inheritance into
11376 ;; account;
11378 ;; 3. Else, move up to direct parent and proceed only once.
11379 (while (and (setq level (org-up-heading-safe))
11380 (or recursive first)
11381 (>= (point) lim))
11382 (setq first nil cookie-present nil)
11383 (unless (and level
11384 (not (string-match
11386 (downcase (or (org-entry-get nil "COOKIE_DATA")
11387 "")))))
11388 (throw 'exit nil))
11389 (while (re-search-forward box-re (point-at-eol) t)
11390 (setq cnt-all 0 cnt-done 0 cookie-present t)
11391 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11392 (save-match-data
11393 (unless (outline-next-heading) (throw 'exit nil))
11394 (while (and (looking-at org-complex-heading-regexp)
11395 (> (setq l1 (length (match-string 1))) level))
11396 (setq kwd (and (or recursive (= l1 ltoggle))
11397 (match-string 2)))
11398 (if (or (eq org-provide-todo-statistics 'all-headlines)
11399 (and (listp org-provide-todo-statistics)
11400 (or (member kwd org-provide-todo-statistics)
11401 (member kwd org-done-keywords))))
11402 (setq cnt-all (1+ cnt-all))
11403 (if (eq org-provide-todo-statistics t)
11404 (and kwd (setq cnt-all (1+ cnt-all)))))
11405 (and (member kwd org-done-keywords)
11406 (setq cnt-done (1+ cnt-done)))
11407 (outline-next-heading)))
11408 (setq new
11409 (if is-percent
11410 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11411 (format "[%d/%d]" cnt-done cnt-all))
11412 ndel (- (match-end 0) checkbox-beg))
11413 ;; handle overlays when updating cookie from column view
11414 (when (setq ov (car (overlays-at checkbox-beg)))
11415 (setq ovs (overlay-start ov) ove (overlay-end ov))
11416 (delete-overlay ov))
11417 (goto-char checkbox-beg)
11418 (insert new)
11419 (delete-region (point) (+ (point) ndel))
11420 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11421 (when ov (move-overlay ov ovs ove)))
11422 (when cookie-present
11423 (run-hook-with-args 'org-after-todo-statistics-hook
11424 cnt-done (- cnt-all cnt-done))))))
11425 (run-hooks 'org-todo-statistics-hook)))
11427 (defvar org-after-todo-statistics-hook nil
11428 "Hook that is called after a TODO statistics cookie has been updated.
11429 Each function is called with two arguments: the number of not-done entries
11430 and the number of done entries.
11432 For example, the following function, when added to this hook, will switch
11433 an entry to DONE when all children are done, and back to TODO when new
11434 entries are set to a TODO status. Note that this hook is only called
11435 when there is a statistics cookie in the headline!
11437 (defun org-summary-todo (n-done n-not-done)
11439 (let (org-log-done org-log-states) ; turn off logging
11441 ")
11443 (defvar org-todo-statistics-hook nil
11444 "Hook that is run whenever Org thinks TODO statistics should be updated.
11445 This hook runs even if there is no statistics cookie present, in which case
11446 `org-after-todo-statistics-hook' would not run.")
11448 (defun org-todo-trigger-tag-changes (state)
11449 "Apply the changes defined in `org-todo-state-tags-triggers'."
11450 (let ((l org-todo-state-tags-triggers)
11451 changes)
11452 (when (or (not state) (equal state ""))
11453 (setq changes (append changes (cdr (assoc "" l)))))
11454 (when (and (stringp state) (> (length state) 0))
11455 (setq changes (append changes (cdr (assoc state l)))))
11456 (when (member state org-not-done-keywords)
11457 (setq changes (append changes (cdr (assoc 'todo l)))))
11458 (when (member state org-done-keywords)
11459 (setq changes (append changes (cdr (assoc 'done l)))))
11460 (dolist (c changes)
11461 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11463 (defun org-local-logging (value)
11464 "Get logging settings from a property VALUE."
11465 (let* (words w a)
11466 ;; directly set the variables, they are already local.
11467 (setq org-log-done nil
11468 org-log-repeat nil
11469 org-todo-log-states nil)
11470 (setq words (org-split-string value))
11471 (while (setq w (pop words))
11472 (cond
11473 ((setq a (assoc w org-startup-options))
11474 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11475 (set (nth 1 a) (nth 2 a))))
11476 ((setq a (org-extract-log-state-settings w))
11477 (and (member (car a) org-todo-keywords-1)
11478 (push a org-todo-log-states)))))))
11480 (defun org-get-todo-sequence-head (kwd)
11481 "Return the head of the TODO sequence to which KWD belongs.
11482 If KWD is not set, check if there is a text property remembering the
11483 right sequence."
11484 (let (p)
11485 (cond
11486 ((not kwd)
11487 (or (get-text-property (point-at-bol) 'org-todo-head)
11488 (progn
11489 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11490 nil (point-at-eol)))
11491 (get-text-property p 'org-todo-head))))
11492 ((not (member kwd org-todo-keywords-1))
11493 (car org-todo-keywords-1))
11494 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11496 (defun org-fast-todo-selection ()
11497 "Fast TODO keyword selection with single keys.
11498 Returns the new TODO keyword, or nil if no state change should occur."
11499 (let* ((fulltable org-todo-key-alist)
11500 (done-keywords org-done-keywords) ;; needed for the faces.
11501 (maxlen (apply 'max (mapcar
11502 (lambda (x)
11503 (if (stringp (car x)) (string-width (car x)) 0))
11504 fulltable)))
11505 (expert nil)
11506 (fwidth (+ maxlen 3 1 3))
11507 (ncol (/ (- (window-width) 4) fwidth))
11508 tg cnt e c tbl
11509 groups ingroup)
11510 (save-excursion
11511 (save-window-excursion
11512 (if expert
11513 (set-buffer (get-buffer-create " *Org todo*"))
11514 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11515 (erase-buffer)
11516 (org-set-local 'org-done-keywords done-keywords)
11517 (setq tbl fulltable cnt 0)
11518 (while (setq e (pop tbl))
11519 (cond
11520 ((equal e '(:startgroup))
11521 (push '() groups) (setq ingroup t)
11522 (when (not (= cnt 0))
11523 (setq cnt 0)
11525 (insert "{ "))
11526 ((equal e '(:endgroup))
11527 (setq ingroup nil cnt 0)
11529 ((equal e '(:newline))
11530 (when (not (= cnt 0))
11531 (setq cnt 0)
11533 (setq e (car tbl))
11534 (while (equal (car tbl) '(:newline))
11536 (setq tbl (cdr tbl)))))
11537 (t
11538 (setq tg (car e) c (cdr e))
11539 (if ingroup (push tg (car groups)))
11540 (setq tg (org-add-props tg nil 'face
11541 (org-get-todo-face tg)))
11542 (if (and (= cnt 0) (not ingroup)) (insert " "))
11543 (insert "[" c "] " tg (make-string
11544 (- fwidth 4 (length tg)) ?\ ))
11545 (when (= (setq cnt (1+ cnt)) ncol)
11547 (if ingroup (insert " "))
11548 (setq cnt 0)))))
11550 (goto-char (point-min))
11551 (if (not expert) (org-fit-window-to-buffer))
11552 (message "[a-z..]:Set [SPC]:clear")
11553 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11554 (cond
11555 ((or (= c ?\C-g)
11556 (and (= c ?q) (not (rassoc c fulltable))))
11557 (setq quit-flag t))
11558 ((= c ?\ ) nil)
11559 ((setq e (rassoc c fulltable) tg (car e))
11560 tg)
11561 (t (setq quit-flag t)))))))
11563 (defun org-entry-is-todo-p ()
11564 (member (org-get-todo-state) org-not-done-keywords))
11566 (defun org-entry-is-done-p ()
11567 (member (org-get-todo-state) org-done-keywords))
11569 (defun org-get-todo-state ()
11570 (save-excursion
11571 (org-back-to-heading t)
11572 (and (looking-at org-todo-line-regexp)
11573 (match-end 2)
11574 (match-string 2))))
11576 (defun org-at-date-range-p (&optional inactive-ok)
11577 "Is the cursor inside a date range?"
11578 (interactive)
11579 (save-excursion
11580 (catch 'exit
11581 (let ((pos (point)))
11583 (skip-chars-backward "<[")
11584 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11585 (>= (match-end 0) pos)
11586 (throw 'exit t))
11588 (skip-chars-backward "<[")
11589 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11590 (>= (match-end 0) pos)
11591 (throw 'exit t)))
11592 nil)))
11594 (defun org-get-repeat (&optional tagline)
11595 "Check if there is a deadline/schedule with repeater in this entry."
11596 (save-match-data
11597 (save-excursion
11598 (org-back-to-heading t)
11599 (and (re-search-forward (if tagline
11601 org-repeat-re)
11602 (org-entry-end-position) t)
11603 (match-string-no-properties 1)))))
11605 (defvar org-last-changed-timestamp)
11606 (defvar org-last-inserted-timestamp)
11607 (defvar org-log-post-message)
11608 (defvar org-log-note-purpose)
11609 (defvar org-log-note-how)
11610 (defvar org-log-note-extra)
11611 (defun org-auto-repeat-maybe (done-word)
11612 "Check if the current headline contains a repeated deadline/schedule.
11613 If yes, set TODO state back to what it was and change the base date
11614 of repeating deadline/scheduled time stamps to new date.
11615 This function is run automatically after each state change to a DONE state."
11616 ;; last-state is dynamically scoped into this function
11617 (let* ((repeat (org-get-repeat))
11618 (aa (assoc last-state org-todo-kwd-alist))
11619 (interpret (nth 1 aa))
11620 (head (nth 2 aa))
11621 (whata '(("d" . day) ("m" . month) ("y" . year)))
11622 (msg "Entry repeats: ")
11623 (org-log-done nil)
11624 (org-todo-log-states nil)
11625 re type n what ts time to-state)
11626 (when repeat
11627 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11628 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11629 org-todo-repeat-to-state))
11630 (unless (and to-state (member to-state org-todo-keywords-1))
11631 (setq to-state (if (eq interpret 'type) last-state head)))
11632 (org-todo to-state)
11633 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11634 (org-entry-put nil "LAST_REPEAT" (format-time-string
11635 (org-time-stamp-format t t))))
11636 (when org-log-repeat
11637 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11638 (memq 'org-add-log-note post-command-hook))
11639 ;; OK, we are already setup for some record
11640 (if (eq org-log-repeat 'note)
11641 ;; make sure we take a note, not only a time stamp
11642 (setq org-log-note-how 'note))
11643 ;; Set up for taking a record
11644 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11645 last-state
11646 'findpos org-log-repeat)))
11647 (org-back-to-heading t)
11648 (org-add-planning-info nil nil 'closed)
11652 (while (re-search-forward
11653 re (save-excursion (outline-next-heading) (point)) t)
11654 (setq type (if (match-end 1) org-scheduled-string
11655 (if (match-end 3) org-deadline-string "Plain:"))
11656 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11658 (setq n (string-to-number (match-string 2 ts))
11659 what (match-string 3 ts))
11660 (if (equal what "w") (setq n (* n 7) what "d"))
11661 ;; Preparation, see if we need to modify the start date for the change
11662 (when (match-end 1)
11663 (setq time (save-match-data (org-time-string-to-time ts)))
11664 (cond
11665 ((equal (match-string 1 ts) ".")
11666 ;; Shift starting date to today
11667 (org-timestamp-change
11668 (- (org-today) (time-to-days time))
11669 'day))
11670 ((equal (match-string 1 ts) "+")
11671 (let ((nshiftmax 10) (nshift 0))
11672 (while (or (= nshift 0)
11673 (<= (time-to-days time)
11674 (time-to-days (current-time))))
11675 (when (= (incf nshift) nshiftmax)
11676 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11677 (error "Abort")))
11678 (org-timestamp-change n (cdr (assoc what whata)))
11679 (org-at-timestamp-p t)
11680 (setq ts (match-string 1))
11681 (setq time (save-match-data (org-time-string-to-time ts)))))
11682 (org-timestamp-change (- n) (cdr (assoc what whata)))
11683 ;; rematch, so that we have everything in place for the real shift
11684 (org-at-timestamp-p t)
11685 (setq ts (match-string 1))
11687 (org-timestamp-change n (cdr (assoc what whata)))
11688 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11689 (setq org-log-post-message msg)
11690 (message "%s" msg))))
11692 (defun org-show-todo-tree (arg)
11693 "Make a compact tree which shows all headlines marked with TODO.
11694 The tree will show the lines where the regexp matches, and all higher
11695 headlines above the match.
11697 With a numeric prefix N, construct a sparse tree for the Nth element
11698 of `org-todo-keywords-1'."
11699 (interactive "P")
11700 (let ((case-fold-search nil)
11701 (kwd-re
11702 (cond ((null arg) org-not-done-regexp)
11703 ((equal arg '(4))
11704 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11705 (mapcar 'list org-todo-keywords-1))))
11709 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11710 (regexp-quote (nth (1- (prefix-numeric-value arg))
11711 org-todo-keywords-1)))
11712 (t (error "Invalid prefix argument: %s" arg)))))
11713 (message "%d TODO entries found"
11714 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11716 (defun org-deadline (&optional remove time)
11718 With argument REMOVE, remove any deadline from the item.
11719 With argument TIME, set the deadline at the corresponding date. TIME
11721 (interactive "P")
11722 (let* ((old-date (org-entry-get nil "DEADLINE"))
11723 (repeater (and old-date
11724 (string-match
11726 old-date)
11727 (match-string 1 old-date))))
11728 (if remove
11729 (progn
11730 (when (and old-date org-log-redeadline)
11731 (org-add-log-setup 'deldeadline nil old-date 'findpos
11732 org-log-redeadline))
11733 (org-remove-timestamp-with-keyword org-deadline-string)
11734 (message "Item no longer has a deadline."))
11735 (org-add-planning-info 'deadline time 'closed)
11736 (when (and old-date org-log-redeadline
11737 (not (equal old-date
11738 (substring org-last-inserted-timestamp 1 -1))))
11739 (org-add-log-setup 'redeadline nil old-date 'findpos
11740 org-log-redeadline))
11741 (when repeater
11742 (save-excursion
11743 (org-back-to-heading t)
11744 (when (re-search-forward (concat org-deadline-string " "
11745 org-last-inserted-timestamp)
11746 (save-excursion
11747 (outline-next-heading) (point)) t)
11748 (goto-char (1- (match-end 0)))
11749 (insert " " repeater)
11750 (setq org-last-inserted-timestamp
11751 (concat (substring org-last-inserted-timestamp 0 -1)
11752 " " repeater
11753 (substring org-last-inserted-timestamp -1))))))
11754 (message "Deadline on %s" org-last-inserted-timestamp))))
11756 (defun org-schedule (&optional remove time)
11757 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11758 With argument REMOVE, remove any scheduling date from the item.
11759 With argument TIME, scheduled at the corresponding date. TIME can
11761 (interactive "P")
11762 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11763 (repeater (and old-date
11764 (string-match
11766 old-date)
11767 (match-string 1 old-date))))
11768 (if remove
11769 (progn
11770 (when (and old-date org-log-reschedule)
11771 (org-add-log-setup 'delschedule nil old-date 'findpos
11772 org-log-reschedule))
11773 (org-remove-timestamp-with-keyword org-scheduled-string)
11774 (message "Item is no longer scheduled."))
11775 (org-add-planning-info 'scheduled time 'closed)
11776 (when (and old-date org-log-reschedule
11777 (not (equal old-date
11778 (substring org-last-inserted-timestamp 1 -1))))
11779 (org-add-log-setup 'reschedule nil old-date 'findpos
11780 org-log-reschedule))
11781 (when repeater
11782 (save-excursion
11783 (org-back-to-heading t)
11784 (when (re-search-forward (concat org-scheduled-string " "
11785 org-last-inserted-timestamp)
11786 (save-excursion
11787 (outline-next-heading) (point)) t)
11788 (goto-char (1- (match-end 0)))
11789 (insert " " repeater)
11790 (setq org-last-inserted-timestamp
11791 (concat (substring org-last-inserted-timestamp 0 -1)
11792 " " repeater
11793 (substring org-last-inserted-timestamp -1))))))
11794 (message "Scheduled to %s" org-last-inserted-timestamp))))
11796 (defun org-get-scheduled-time (pom &optional inherit)
11797 "Get the scheduled time as a time tuple, of a format suitable
11798 for calling org-schedule with, or if there is no scheduling,
11799 returns nil."
11800 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11801 (when time
11802 (apply 'encode-time (org-parse-time-string time)))))
11804 (defun org-get-deadline-time (pom &optional inherit)
11805 "Get the deadline as a time tuple, of a format suitable for
11806 calling org-deadline with, or if there is no scheduling, returns
11807 nil."
11808 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11809 (when time
11810 (apply 'encode-time (org-parse-time-string time)))))
11812 (defun org-remove-timestamp-with-keyword (keyword)
11813 "Remove all time stamps with KEYWORD in the current entry."
11815 beg)
11816 (save-excursion
11817 (org-back-to-heading t)
11818 (setq beg (point))
11819 (outline-next-heading)
11820 (while (re-search-backward re beg t)
11821 (replace-match "")
11823 (equal (char-before) ?\ ))
11824 (backward-delete-char 1)
11826 (point-at-bol) (point-at-eol)))
11827 (delete-region (point-at-bol)
11828 (min (point-max) (1+ (point-at-eol))))))))))
11830 (defun org-add-planning-info (what &optional time &rest remove)
11831 "Insert new timestamp with keyword in the line directly after the headline.
11832 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11833 If non is given, the user is prompted for a date.
11834 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11835 be removed."
11836 (interactive)
11837 (let (org-time-was-given org-end-time-was-given ts
11838 end default-time default-input)
11840 (catch 'exit
11841 (when (and (memq what '(scheduled deadline))
11842 (or (not time)
11843 (and (stringp time)
11844 (string-match "^[-+]+[0-9]" time))))
11845 ;; Try to get a default date/time from existing timestamp
11846 (save-excursion
11847 (org-back-to-heading t)
11848 (setq end (save-excursion (outline-next-heading) (point)))
11849 (when (re-search-forward (if (eq what 'scheduled)
11850 org-scheduled-time-regexp
11851 org-deadline-time-regexp)
11852 end t)
11853 (setq ts (match-string 1)
11854 default-time
11855 (apply 'encode-time (org-parse-time-string ts))
11856 default-input (and ts (org-get-compact-tod ts))))))
11857 (when what
11858 (setq time
11859 (if (and (stringp time)
11860 (string-match "^[-+]+[0-9]" time))
11861 ;; This is a relative time, set the proper date
11862 (apply 'encode-time
11863 (org-read-date-analyze
11864 time default-time (decode-time default-time)))
11865 ;; If necessary, get the time from the user
11866 (or time (org-read-date nil 'to-time nil nil
11867 default-time default-input)))))
11869 (when (and org-insert-labeled-timestamps-at-point
11870 (member what '(scheduled deadline)))
11871 (insert
11872 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11873 (org-insert-time-stamp time org-time-was-given
11874 nil nil nil (list org-end-time-was-given))
11875 (setq what nil))
11876 (save-excursion
11877 (save-restriction
11878 (let (col list elt ts buffer-invisibility-spec)
11879 (org-back-to-heading t)
11881 (goto-char (match-end 1))
11882 (setq col (current-column))
11883 (goto-char (match-end 0))
11885 (when (and (not what)
11886 (not (looking-at
11888 org-keyword-time-not-clock-regexp))))
11889 ;; Nothing to add, nothing to remove...... :-)
11890 (throw 'exit nil))
11891 (if (and (not (looking-at org-outline-regexp))
11894 (not (equal (match-string 1) org-clock-string)))
11895 (narrow-to-region (match-beginning 0) (match-end 0))
11897 (backward-char 1)
11898 (narrow-to-region (point) (point))
11899 (and org-adapt-indentation (org-indent-to-column col)))
11900 ;; Check if we have to remove something.
11901 (setq list (cons what remove))
11902 (while list
11903 (setq elt (pop list))
11904 (when (or (and (eq elt 'scheduled)
11905 (re-search-forward org-scheduled-time-regexp nil t))
11906 (and (eq elt 'deadline)
11907 (re-search-forward org-deadline-time-regexp nil t))
11908 (and (eq elt 'closed)
11909 (re-search-forward org-closed-time-regexp nil t)))
11910 (replace-match "")
11911 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11913 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11914 (when what
11915 (insert
11916 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11917 (cond ((eq what 'scheduled) org-scheduled-string)
11918 ((eq what 'deadline) org-deadline-string)
11919 ((eq what 'closed) org-closed-string))
11920 " ")
11921 (setq ts (org-insert-time-stamp
11922 time
11923 (or org-time-was-given
11924 (and (eq what 'closed) org-log-done-with-time))
11925 (eq what 'closed)
11926 nil nil (list org-end-time-was-given)))
11927 (insert
11928 (if (not (or (bolp) (eq (char-before) ?\ )
11929 (memq (char-after) '(32 10))
11930 (eobp))) " " ""))
11931 (end-of-line 1))
11932 (goto-char (point-min))
11933 (widen)
11936 (delete-region (1- (point)) (point-at-eol)))
11937 ts))))))
11939 (defvar org-log-note-marker (make-marker))
11940 (defvar org-log-note-purpose nil)
11941 (defvar org-log-note-state nil)
11942 (defvar org-log-note-previous-state nil)
11943 (defvar org-log-note-how nil)
11944 (defvar org-log-note-extra nil)
11945 (defvar org-log-note-window-configuration nil)
11946 (defvar org-log-note-return-to (make-marker))
11947 (defvar org-log-note-effective-time nil
11948 "Remembered current time so that dynamically scoped
11949 `org-extend-today-until' affects tha timestamps in state change
11950 log")
11952 (defvar org-log-post-message nil
11953 "Message to be displayed after a log note has been stored.
11954 The auto-repeater uses this.")
11956 (defun org-add-note ()
11957 "Add a note to the current entry.
11958 This is done in the same way as adding a state change note."
11959 (interactive)
11960 (org-add-log-setup 'note nil nil 'findpos nil))
11962 (defvar org-property-end-re)
11963 (defun org-add-log-setup (&optional purpose state prev-state
11964 findpos how extra)
11965 "Set up the post command hook to take a note.
11966 If this is about to TODO state change, the new state is expected in STATE.
11967 When FINDPOS is non-nil, find the correct position for the note in
11968 the current entry. If not, assume that it can be inserted at point.
11969 HOW is an indicator what kind of note should be created.
11970 EXTRA is additional text that will be inserted into the notes buffer."
11971 (let* ((org-log-into-drawer (org-log-into-drawer))
11972 (drawer (cond ((stringp org-log-into-drawer)
11973 org-log-into-drawer)
11974 (org-log-into-drawer "LOGBOOK")
11975 (t nil))))
11976 (save-restriction
11977 (save-excursion
11978 (when findpos
11979 (org-back-to-heading t)
11980 (narrow-to-region (point) (save-excursion
11981 (outline-next-heading) (point)))
11985 (goto-char (match-end 0))
11986 (cond
11987 (drawer
11989 nil t)
11990 (progn
11991 (goto-char (match-end 0))
11992 (or org-log-states-order-reversed
11993 (and (re-search-forward org-property-end-re nil t)
11994 (goto-char (1- (match-beginning 0))))))
11996 (beginning-of-line 0)
11997 (org-indent-line-function)
11998 (beginning-of-line 2)
11999 (org-indent-line-function)
12000 (end-of-line 0)))
12001 ((and org-log-state-notes-insert-after-drawers
12002 (save-excursion
12003 (forward-line) (looking-at org-drawer-regexp)))
12004 (forward-line)
12005 (while (looking-at org-drawer-regexp)
12006 (goto-char (match-end 0))
12007 (re-search-forward org-property-end-re (point-max) t)
12008 (forward-line))
12009 (forward-line -1)))
12010 (unless org-log-states-order-reversed
12012 (org-skip-over-state-notes)
12014 (move-marker org-log-note-marker (point))
12015 (setq org-log-note-purpose purpose
12016 org-log-note-state state
12017 org-log-note-previous-state prev-state
12018 org-log-note-how how
12019 org-log-note-extra extra
12020 org-log-note-effective-time (org-current-effective-time))
12021 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12023 (defun org-skip-over-state-notes ()
12024 "Skip past the list of State notes in an entry."
12026 (when (ignore-errors (goto-char (org-in-item-p)))
12027 (let* ((struct (org-list-struct))
12028 (prevs (org-list-prevs-alist struct)))
12030 (goto-char (or (org-list-get-next-item (point) struct prevs)
12031 (org-list-get-item-end (point) struct)))))))
12033 (defun org-add-log-note (&optional purpose)
12034 "Pop up a window for taking a note, and add this note later at point."
12035 (remove-hook 'post-command-hook 'org-add-log-note)
12036 (setq org-log-note-window-configuration (current-window-configuration))
12037 (delete-other-windows)
12038 (move-marker org-log-note-return-to (point))
12039 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12040 (goto-char org-log-note-marker)
12041 (org-switch-to-buffer-other-window "*Org Note*")
12042 (erase-buffer)
12043 (if (memq org-log-note-how '(time state))
12044 (let (current-prefix-arg) (org-store-log-note))
12045 (let ((org-inhibit-startup t)) (org-mode))
12046 (insert (format "# Insert note for %s.
12048 (cond
12049 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12050 ((eq org-log-note-purpose 'done) "closed todo item")
12051 ((eq org-log-note-purpose 'state)
12053 (or org-log-note-previous-state "")
12054 (or org-log-note-state "")))
12055 ((eq org-log-note-purpose 'reschedule)
12056 "rescheduling")
12057 ((eq org-log-note-purpose 'delschedule)
12058 "no longer scheduled")
12059 ((eq org-log-note-purpose 'redeadline)
12060 "changing deadline")
12061 ((eq org-log-note-purpose 'deldeadline)
12062 "removing deadline")
12063 ((eq org-log-note-purpose 'refile)
12064 "refiling")
12065 ((eq org-log-note-purpose 'note)
12066 "this entry")
12067 (t (error "This should not happen")))))
12068 (if org-log-note-extra (insert org-log-note-extra))
12069 (org-set-local 'org-finish-function 'org-store-log-note)))
12071 (defvar org-note-abort nil) ; dynamically scoped
12072 (defun org-store-log-note ()
12073 "Finish taking a log note, and insert it to where it belongs."
12074 (let ((txt (buffer-string))
12075 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12076 lines ind bul)
12077 (kill-buffer (current-buffer))
12079 (setq txt (replace-match "" t t txt)))
12081 (setq txt (replace-match "" t t txt)))
12084 (setq note
12085 (org-replace-escapes
12086 note
12087 (list (cons "%u" (user-login-name))
12088 (cons "%U" user-full-name)
12089 (cons "%t" (format-time-string
12090 (org-time-stamp-format 'long 'inactive)
12091 org-log-note-effective-time))
12092 (cons "%T" (format-time-string
12093 (org-time-stamp-format 'long nil)
12094 org-log-note-effective-time))
12095 (cons "%s" (if org-log-note-state
12097 ""))
12098 (cons "%S" (if org-log-note-previous-state
12102 (push note lines))
12103 (when (or current-prefix-arg org-note-abort)
12104 (when org-log-into-drawer
12105 (org-remove-empty-drawer-at
12106 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12107 org-log-note-marker))
12108 (setq lines nil))
12109 (when lines
12110 (with-current-buffer (marker-buffer org-log-note-marker)
12111 (save-excursion
12112 (goto-char org-log-note-marker)
12113 (move-marker org-log-note-marker nil)
12114 (end-of-line 1)
12116 (setq ind (save-excursion
12117 (if (ignore-errors (goto-char (org-in-item-p)))
12118 (let ((struct (org-list-struct)))
12119 (org-list-get-ind
12120 (org-list-get-top-point struct) struct))
12122 (cond
12123 ((and (org-at-heading-p)
12124 org-adapt-indentation)
12125 (1+ (org-current-level)))
12126 ((org-at-heading-p) 0)
12127 (t (org-get-indentation))))))
12128 (setq bul (org-list-bullet-string "-"))
12129 (org-indent-line-to ind)
12130 (insert bul (pop lines))
12131 (let ((ind-body (+ (length bul) ind)))
12132 (while lines
12134 (org-indent-line-to ind-body)
12135 (insert (pop lines))))
12136 (message "Note stored")
12137 (org-back-to-heading t)
12138 (org-cycle-hide-drawers 'children)))))
12139 (set-window-configuration org-log-note-window-configuration)
12140 (with-current-buffer (marker-buffer org-log-note-return-to)
12141 (goto-char org-log-note-return-to))
12142 (move-marker org-log-note-return-to nil)
12143 (and org-log-post-message (message "%s" org-log-post-message)))
12145 (defun org-remove-empty-drawer-at (drawer pos)
12146 "Remove an empty drawer DRAWER at position POS.
12147 POS may also be a marker."
12148 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12149 (save-excursion
12150 (save-restriction
12151 (widen)
12152 (goto-char pos)
12153 (if (org-in-regexp
12155 (replace-match ""))))))
12157 (defun org-sparse-tree (&optional arg)
12158 "Create a sparse tree, prompt for the details.
12159 This command can create sparse trees. You first need to select the type
12160 of match used to create the tree:
12162 t Show all TODO entries.
12163 T Show entries with a specific TODO keyword.
12164 m Show entries selected by a tags/property match.
12165 p Enter a property name and its value (both with completion on existing
12166 names/values) and show entries with that property.
12167 r Show entries matching a regular expression (`/' can be used as well)
12168 d Show deadlines due within `org-deadline-warning-days'.
12169 b Show deadlines and scheduled items before a date.
12170 a Show deadlines and scheduled items after a date."
12171 (interactive "P")
12172 (let (ans kwd value)
12173 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12174 (setq ans (read-char-exclusive))
12175 (cond
12176 ((equal ans ?d)
12177 (call-interactively 'org-check-deadlines))
12178 ((equal ans ?b)
12179 (call-interactively 'org-check-before-date))
12180 ((equal ans ?a)
12181 (call-interactively 'org-check-after-date))
12182 ((equal ans ?t)
12183 (org-show-todo-tree nil))
12184 ((equal ans ?T)
12185 (org-show-todo-tree '(4)))
12186 ((member ans '(?T ?m))
12187 (call-interactively 'org-match-sparse-tree))
12188 ((member ans '(?p ?P))
12189 (setq kwd (org-icompleting-read "Property: "
12190 (mapcar 'list (org-buffer-property-keys))))
12191 (setq value (org-icompleting-read "Value: "
12192 (mapcar 'list (org-property-values kwd))))
12195 (org-match-sparse-tree arg (concat kwd "=" value)))
12196 ((member ans '(?r ?R ?/))
12197 (call-interactively 'org-occur))
12200 (defvar org-occur-highlights nil
12201 "List of overlays used for occur matches.")
12202 (make-variable-buffer-local 'org-occur-highlights)
12203 (defvar org-occur-parameters nil
12204 "Parameters of the active org-occur calls.
12205 This is a list, each call to org-occur pushes as cons cell,
12206 containing the regular expression and the callback, onto the list.
12207 The list can contain several entries if `org-occur' has been called
12208 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12209 will only contain one set of parameters. When the highlights are
12210 removed (for example with `C-c C-c', or with the next edit (depending
12211 on `org-remove-highlights-with-change'), this variable is emptied
12212 as well.")
12213 (make-variable-buffer-local 'org-occur-parameters)
12215 (defun org-occur (regexp &optional keep-previous callback)
12216 "Make a compact tree which shows all matches of REGEXP.
12217 The tree will show the lines where the regexp matches, and all higher
12218 headlines above the match. It will also show the heading after the match,
12219 to make sure editing the matching entry is easy.
12220 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12221 call to `org-occur' will be kept, to allow stacking of calls to this
12222 command.
12223 If CALLBACK is non-nil, it is a function which is called to confirm
12224 that the match should indeed be shown."
12226 (when (equal regexp "")
12227 (error "Regexp cannot be empty"))
12228 (unless keep-previous
12229 (org-remove-occur-highlights nil nil t))
12230 (push (cons regexp callback) org-occur-parameters)
12231 (let ((cnt 0))
12232 (save-excursion
12233 (goto-char (point-min))
12234 (if (or (not keep-previous) ; do not want to keep
12235 (not org-occur-highlights)) ; no previous matches
12236 ;; hide everything
12237 (org-overview))
12238 (while (re-search-forward regexp nil t)
12239 (when (or (not callback)
12240 (save-match-data (funcall callback)))
12241 (setq cnt (1+ cnt))
12242 (when org-highlight-sparse-tree-matches
12243 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12244 (org-show-context 'occur-tree))))
12245 (when org-remove-highlights-with-change
12246 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12247 nil 'local))
12248 (unless org-sparse-tree-open-archived-trees
12249 (org-hide-archived-subtrees (point-min) (point-max)))
12250 (run-hooks 'org-occur-hook)
12251 (if (org-called-interactively-p 'interactive)
12252 (message "%d match(es) for regexp %s" cnt regexp))
12253 cnt))
12255 (defun org-occur-next-match (&optional n reset)
12256 "Function for `next-error-function' to find sparse tree matches.
12257 N is the number of matches to move, when negative move backwards.
12258 RESET is entirely ignored - this function always goes back to the
12259 starting point when no match is found."
12260 (let* ((limit (if (< n 0) (point-min) (point-max)))
12261 (search-func (if (< n 0)
12262 'previous-single-char-property-change
12263 'next-single-char-property-change))
12264 (n (abs n))
12265 (pos (point))
12266 p1)
12267 (catch 'exit
12268 (while (setq p1 (funcall search-func (point) 'org-type))
12269 (when (equal p1 limit)
12270 (goto-char pos)
12271 (error "No more matches"))
12272 (when (equal (get-char-property p1 'org-type) 'org-occur)
12273 (setq n (1- n))
12274 (when (= n 0)
12275 (goto-char p1)
12276 (throw 'exit (point))))
12277 (goto-char p1))
12278 (goto-char p1)
12279 (error "No more matches"))))
12281 (defun org-show-context (&optional key)
12282 "Make sure point and context are visible.
12283 How much context is shown depends upon the variables
12284 `org-show-hierarchy-above', `org-show-following-heading'. and
12285 `org-show-siblings'."
12286 (let ((heading-p (org-on-heading-p t))
12287 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12288 (following-p (org-get-alist-option org-show-following-heading key))
12289 (entry-p (org-get-alist-option org-show-entry-below key))
12290 (siblings-p (org-get-alist-option org-show-siblings key)))
12291 (catch 'exit
12292 ;; Show heading or entry text
12293 (if (and heading-p (not entry-p))
12294 (org-flag-heading nil) ; only show the heading
12295 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12296 (org-show-hidden-entry))) ; show entire entry
12297 (when following-p
12298 ;; Show next sibling, or heading below text
12299 (save-excursion
12300 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12301 (org-flag-heading nil))))
12302 (when siblings-p (org-show-siblings))
12303 (when hierarchy-p
12304 ;; show all higher headings, possibly with siblings
12305 (save-excursion
12306 (while (and (condition-case nil
12307 (progn (org-up-heading-all 1) t)
12308 (error nil))
12309 (not (bobp)))
12310 (org-flag-heading nil)
12311 (when siblings-p (org-show-siblings))))))))
12313 (defvar org-reveal-start-hook nil
12314 "Hook run before revealing a location.")
12316 (defun org-reveal (&optional siblings)
12317 "Show current entry, hierarchy above it, and the following headline.
12318 This can be used to show a consistent set of context around locations
12319 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12320 not t for the search context.
12322 With optional argument SIBLINGS, on each level of the hierarchy all
12323 siblings are shown. This repairs the tree structure to what it would
12324 look like when opened with hierarchical calls to `org-cycle'.
12326 go to the parent and show the
12327 entire tree."
12328 (interactive "P")
12329 (run-hooks 'org-reveal-start-hook)
12330 (let ((org-show-hierarchy-above t)
12331 (org-show-following-heading t)
12332 (org-show-siblings (if siblings t org-show-siblings)))
12333 (org-show-context nil))
12334 (when (equal siblings '(16))
12335 (save-excursion
12336 (when (org-up-heading-safe)
12337 (org-show-subtree)
12338 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12340 (defun org-highlight-new-match (beg end)
12341 "Highlight from BEG to END and mark the highlight is an occur headline."
12342 (let ((ov (make-overlay beg end)))
12343 (overlay-put ov 'face 'secondary-selection)
12344 (overlay-put ov 'org-type 'org-occur)
12345 (push ov org-occur-highlights)))
12347 (defun org-remove-occur-highlights (&optional beg end noremove)
12348 "Remove the occur highlights from the buffer.
12349 BEG and END are ignored. If NOREMOVE is nil, remove this function
12350 from the `before-change-functions' in the current buffer."
12351 (interactive)
12352 (unless org-inhibit-highlight-removal
12353 (mapc 'delete-overlay org-occur-highlights)
12354 (setq org-occur-highlights nil)
12355 (setq org-occur-parameters nil)
12356 (unless noremove
12357 (remove-hook 'before-change-functions
12358 'org-remove-occur-highlights 'local))))
12360 ;;;; Priorities
12363 "Regular expression matching the priority indicator.")
12365 (defvar org-remove-priority-next-time nil)
12367 (defun org-priority-up ()
12368 "Increase the priority of the current item."
12369 (interactive)
12370 (org-priority 'up))
12372 (defun org-priority-down ()
12373 "Decrease the priority of the current item."
12374 (interactive)
12375 (org-priority 'down))
12377 (defun org-priority (&optional action)
12378 "Change the priority of an item by ARG.
12379 ACTION can be `set', `up', `down', or a character."
12380 (interactive)
12381 (unless org-enable-priority-commands
12382 (error "Priority commands are disabled"))
12383 (setq action (or action 'set))
12384 (let (current new news have remove)
12385 (save-excursion
12386 (org-back-to-heading t)
12387 (if (looking-at org-priority-regexp)
12388 (setq current (string-to-char (match-string 2))
12389 have t))
12390 (cond
12391 ((eq action 'remove)
12392 (setq remove t new ?\ ))
12393 ((or (eq action 'set)
12394 (if (featurep 'xemacs) (characterp action) (integerp action)))
12395 (if (not (eq action 'set))
12396 (setq new action)
12397 (message "Priority %c-%c, SPC to remove: "
12398 org-highest-priority org-lowest-priority)
12399 (save-match-data
12400 (setq new (read-char-exclusive))))
12401 (if (and (= (upcase org-highest-priority) org-highest-priority)
12402 (= (upcase org-lowest-priority) org-lowest-priority))
12403 (setq new (upcase new)))
12404 (cond ((equal new ?\ ) (setq remove t))
12405 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12406 (error "Priority must be between `%c' and `%c'"
12407 org-highest-priority org-lowest-priority))))
12408 ((eq action 'up)
12409 (setq new (if have
12410 (1- current) ; normal cycling
12411 ;; last priority was empty
12412 (if (eq last-command this-command)
12413 org-lowest-priority ; wrap around empty to lowest
12414 ;; default
12415 (if org-priority-start-cycle-with-default
12416 org-default-priority
12417 (1- org-default-priority))))))
12418 ((eq action 'down)
12419 (setq new (if have
12420 (1+ current) ; normal cycling
12421 ;; last priority was empty
12422 (if (eq last-command this-command)
12423 org-highest-priority ; wrap around empty to highest
12424 ;; default
12425 (if org-priority-start-cycle-with-default
12426 org-default-priority
12427 (1+ org-default-priority))))))
12428 (t (error "Invalid action")))
12429 (if (or (< (upcase new) org-highest-priority)
12430 (> (upcase new) org-lowest-priority))
12431 (if (and (memq action '(up down))
12432 (not have) (not (eq last-command this-command)))
12433 ;; `new' is from default priority
12434 (error
12435 "The default can not be set, see `org-default-priority' why")
12436 ;; normal cycling: `new' is beyond highest/lowest priority
12437 ;; and is wrapped around to the empty priority
12438 (setq remove t)))
12439 (setq news (format "%c" new))
12440 (if have
12441 (if remove
12442 (replace-match "" t t nil 1)
12443 (replace-match news t t nil 2))
12444 (if remove
12445 (error "No priority cookie found in line")
12446 (let ((case-fold-search nil))
12447 (looking-at org-todo-line-regexp))
12448 (if (match-end 2)
12449 (progn
12450 (goto-char (match-end 2))
12451 (insert " [#" news "]"))
12452 (goto-char (match-beginning 3))
12453 (insert "[#" news "] "))))
12454 (org-preserve-lc (org-set-tags nil 'align)))
12455 (if remove
12456 (message "Priority removed")
12457 (message "Priority of current item set to %s" news))))
12459 (defun org-get-priority (s)
12460 "Find priority cookie and return priority."
12461 (if (functionp org-get-priority-function)
12462 (funcall org-get-priority-function)
12463 (save-match-data
12464 (if (not (string-match org-priority-regexp s))
12465 (* 1000 (- org-lowest-priority org-default-priority))
12466 (* 1000 (- org-lowest-priority
12467 (string-to-char (match-string 2 s))))))))
12469 ;;;; Tags
12471 (defvar org-agenda-archives-mode)
12472 (defvar org-map-continue-from nil
12473 "Position from where mapping should continue.
12474 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12476 (defvar org-scanner-tags nil
12477 "The current tag list while the tags scanner is running.")
12478 (defvar org-trust-scanner-tags nil
12479 "Should `org-get-tags-at' use the tags for the scanner.
12480 This is for internal dynamical scoping only.
12481 When this is non-nil, the function `org-get-tags-at' will return the value
12482 of `org-scanner-tags' instead of building the list by itself. This
12483 can lead to large speed-ups when the tags scanner is used in a file with
12484 many entries, and when the list of tags is retrieved, for example to
12485 obtain a list of properties. Building the tags list for each entry in such
12486 a file becomes an N^2 operation - but with this variable set, it scales
12487 as N.")
12489 (defun org-scan-tags (action matcher &optional todo-only)
12490 "Scan headline tags with inheritance and produce output ACTION.
12492 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12493 or `agenda' to produce an entry list for an agenda view. It can also be
12494 a Lisp form or a function that should be called at each matched headline, in
12495 this case the return value is a list of all return values from these calls.
12497 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12498 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12499 only lines with a TODO keyword are included in the output."
12500 (require 'org-agenda)
12503 (org-re
12505 (props (list 'face 'default
12506 'done-face 'org-agenda-done
12507 'undone-face 'default
12508 'mouse-face 'highlight
12509 'org-not-done-regexp org-not-done-regexp
12510 'org-todo-regexp org-todo-regexp
12511 'help-echo
12512 (format "mouse-2 or RET jump to org file %s"
12513 (abbreviate-file-name
12514 (or (buffer-file-name (buffer-base-buffer))
12515 (buffer-name (buffer-base-buffer)))))))
12516 (case-fold-search nil)
12517 (org-map-continue-from nil)
12518 lspos tags tags-list
12519 (tags-alist (list (cons 0 org-file-tags)))
12520 (llast 0) rtn rtn1 level category i txt
12521 todo marker entry priority)
12522 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12523 (setq action (list 'lambda nil action)))
12524 (save-excursion
12525 (goto-char (point-min))
12526 (when (eq action 'sparse-tree)
12527 (org-overview)
12528 (org-remove-occur-highlights))
12529 (while (re-search-forward re nil t)
12530 (catch :skip
12531 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12532 tags (if (match-end 4) (org-match-string-no-properties 4)))
12533 (goto-char (setq lspos (match-beginning 0)))
12534 (setq level (org-reduced-level (funcall outline-level))
12535 category (org-get-category))
12536 (setq i llast llast level)
12537 ;; remove tag lists from same and sublevels
12538 (while (>= i level)
12539 (when (setq entry (assoc i tags-alist))
12540 (setq tags-alist (delete entry tags-alist)))
12541 (setq i (1- i)))
12542 ;; add the next tags
12543 (when tags
12544 (setq tags (org-split-string tags ":")
12545 tags-alist
12546 (cons (cons level tags) tags-alist)))
12547 ;; compile tags for current headline
12548 (setq tags-list
12549 (if org-use-tag-inheritance
12550 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12551 tags)
12552 org-scanner-tags tags-list)
12553 (when org-use-tag-inheritance
12554 (setcdr (car tags-alist)
12555 (mapcar (lambda (x)
12556 (setq x (copy-sequence x))
12557 (org-add-prop-inherited x))
12558 (cdar tags-alist))))
12559 (when (and tags org-use-tag-inheritance
12560 (or (not (eq t org-use-tag-inheritance))
12561 org-tags-exclude-from-inheritance))
12562 ;; selective inheritance, remove uninherited ones
12563 (setcdr (car tags-alist)
12564 (org-remove-uninherited-tags (cdar tags-alist))))
12565 (when (and
12567 ;; eval matcher only when the todo condition is OK
12568 (and (or (not todo-only) (member todo org-not-done-keywords))
12569 (let ((case-fold-search t)) (eval matcher)))
12571 ;; Call the skipper, but return t if it does not skip,
12572 ;; so that the `and' form continues evaluating
12573 (progn
12574 (unless (eq action 'sparse-tree) (org-agenda-skip))
12575 t)
12577 ;; Check if timestamps are deselecting this entry
12578 (or (not todo-only)
12579 (and (member todo org-not-done-keywords)
12580 (or (not org-agenda-tags-todo-honor-ignore-options)
12581 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12583 ;; Extra check for the archive tag
12584 ;; FIXME: Does the skipper already do this????
12585 (or
12586 (not (member org-archive-tag tags-list))
12587 ;; we have an archive tag, should we use this anyway?
12588 (or (not org-agenda-skip-archived-trees)
12589 (and (eq action 'agenda) org-agenda-archives-mode))))
12591 ;; select this headline
12593 (cond
12594 ((eq action 'sparse-tree)
12595 (and org-highlight-sparse-tree-matches
12596 (org-get-heading) (match-end 0)
12597 (org-highlight-new-match
12598 (match-beginning 0) (match-beginning 1)))
12599 (org-show-context 'tags-tree))
12600 ((eq action 'agenda)
12601 (setq txt (org-format-agenda-item
12602 ""
12603 (concat
12604 (if (eq org-tags-match-list-sublevels 'indented)
12605 (make-string (1- level) ?.) "")
12606 (org-get-heading))
12607 category
12608 tags-list
12609 )
12610 priority (org-get-priority txt))
12611 (goto-char lspos)
12612 (setq marker (org-agenda-new-marker))
12613 (org-add-props txt props
12614 'org-marker marker 'org-hd-marker marker 'org-category category
12615 'todo-state todo
12616 'priority priority 'type "tagsmatch")
12617 (push txt rtn))
12618 ((functionp action)
12619 (setq org-map-continue-from nil)
12620 (save-excursion
12621 (setq rtn1 (funcall action))
12622 (push rtn1 rtn)))
12623 (t (error "Invalid action")))
12625 ;; if we are to skip sublevels, jump to end of subtree
12626 (unless org-tags-match-list-sublevels
12627 (org-end-of-subtree t)
12628 (backward-char 1))))
12629 ;; Get the correct position from where to continue
12630 (if org-map-continue-from
12631 (goto-char org-map-continue-from)
12632 (and (= (point) lspos) (end-of-line 1)))))
12633 (when (and (eq action 'sparse-tree)
12634 (not org-sparse-tree-open-archived-trees))
12635 (org-hide-archived-subtrees (point-min) (point-max)))
12636 (nreverse rtn)))
12638 (defun org-remove-uninherited-tags (tags)
12639 "Remove all tags that are not inherited from the list TAGS."
12640 (cond
12641 ((eq org-use-tag-inheritance t)
12642 (if org-tags-exclude-from-inheritance
12643 (org-delete-all org-tags-exclude-from-inheritance tags)
12644 tags))
12645 ((not org-use-tag-inheritance) nil)
12646 ((stringp org-use-tag-inheritance)
12647 (delq nil (mapcar
12648 (lambda (x)
12649 (if (and (string-match org-use-tag-inheritance x)
12650 (not (member x org-tags-exclude-from-inheritance)))
12651 x nil))
12652 tags)))
12653 ((listp org-use-tag-inheritance)
12654 (delq nil (mapcar
12655 (lambda (x)
12656 (if (member x org-use-tag-inheritance) x nil))
12657 tags)))))
12659 (defvar todo-only) ;; dynamically scoped
12661 (defun org-match-sparse-tree (&optional todo-only match)
12662 "Create a sparse tree according to tags string MATCH.
12663 MATCH can contain positive and negative selection of tags, like
12665 If optional argument TODO-ONLY is non-nil, only select lines that are
12666 also TODO lines."
12667 (interactive "P")
12668 (org-prepare-agenda-buffers (list (current-buffer)))
12669 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12671 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12673 (defvar org-cached-props nil)
12674 (defun org-cached-entry-get (pom property)
12675 (if (or (eq t org-use-property-inheritance)
12676 (and (stringp org-use-property-inheritance)
12677 (string-match org-use-property-inheritance property))
12678 (and (listp org-use-property-inheritance)
12679 (member property org-use-property-inheritance)))
12680 ;; Caching is not possible, check it directly
12681 (org-entry-get pom property 'inherit)
12682 ;; Get all properties, so that we can do complicated checks easily
12683 (cdr (assoc property (or org-cached-props
12684 (setq org-cached-props
12685 (org-entry-properties pom)))))))
12687 (defun org-global-tags-completion-table (&optional files)
12688 "Return the list of all tags in all agenda buffer/files.
12689 Optional FILES argument is a list of files to which can be used
12690 instead of the agenda files."
12691 (save-excursion
12692 (org-uniquify
12693 (delq nil
12694 (apply 'append
12695 (mapcar
12696 (lambda (file)
12697 (set-buffer (find-file-noselect file))
12698 (append (org-get-buffer-tags)
12699 (mapcar (lambda (x) (if (stringp (car-safe x))
12700 (list (car-safe x)) nil))
12701 org-tag-alist)))
12702 (if (and files (car files))
12703 files
12704 (org-agenda-files))))))))
12706 (defun org-make-tags-matcher (match)
12707 "Create the TAGS/TODO matcher form for the selection string MATCH."
12708 ;; todo-only is scoped dynamically into this function, and the function
12709 ;; may change it if the matcher asks for it.
12710 (unless match
12711 ;; Get a new match request, with completion
12712 (let ((org-last-tags-completion-table
12713 (org-global-tags-completion-table)))
12714 (setq match (org-completing-read-no-i
12715 "Match: " 'org-tags-completion-function nil nil nil
12716 'org-tags-history))))
12718 ;; Parse the string and create a lisp form
12719 (let ((match0 match)
12720 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12721 minus tag mm
12722 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12723 orterms term orlist re-p str-p level-p level-op time-p
12724 prop-p pn pv po gv rest)
12725 (if (string-match "/+" match)
12726 ;; match contains also a todo-matching request
12727 (progn
12728 (setq tagsmatch (substring match 0 (match-beginning 0))
12729 todomatch (substring match (match-end 0)))
12730 (if (string-match "^!" todomatch)
12731 (setq todo-only t todomatch (substring todomatch 1)))
12733 (setq todomatch nil)))
12734 ;; only matching tags
12735 (setq tagsmatch match todomatch nil))
12737 ;; Make the tags matcher
12739 (setq tagsmatcher t)
12740 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12741 (while (setq term (pop orterms))
12743 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12744 (while (string-match re term)
12745 (setq rest (substring term (match-end 0))
12746 minus (and (match-end 1)
12747 (equal (match-string 1 term) "-"))
12748 tag (save-match-data (replace-regexp-in-string
12750 (match-string 2 term)))
12751 re-p (equal (string-to-char tag) ?{)
12752 level-p (match-end 4)
12753 prop-p (match-end 5)
12754 mm (cond
12755 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12756 (level-p
12757 (setq level-op (org-op-to-function (match-string 3 term)))
12758 `(,level-op level ,(string-to-number
12759 (match-string 4 term))))
12760 (prop-p
12761 (setq pn (match-string 5 term)
12762 po (match-string 6 term)
12763 pv (match-string 7 term)
12764 re-p (equal (string-to-char pv) ?{)
12766 time-p (save-match-data
12768 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12769 (if time-p (setq pv (org-matcher-time pv)))
12770 (setq po (org-op-to-function po (if time-p 'time str-p)))
12771 (cond
12772 ((equal pn "CATEGORY")
12773 (setq gv '(get-text-property (point) 'org-category)))
12774 ((equal pn "TODO")
12775 (setq gv 'todo))
12776 (t
12777 (setq gv `(org-cached-entry-get nil ,pn))))
12778 (if re-p
12779 (if (eq po 'org<>)
12780 `(not (string-match ,pv (or ,gv "")))
12781 `(string-match ,pv (or ,gv "")))
12782 (if str-p
12783 `(,po (or ,gv "") ,pv)
12784 `(,po (string-to-number (or ,gv ""))
12785 ,(string-to-number pv) ))))
12786 (t `(member ,tag tags-list)))
12787 mm (if minus (list 'not mm) mm)
12788 term rest)
12789 (push mm tagsmatcher))
12790 (push (if (> (length tagsmatcher) 1)
12791 (cons 'and tagsmatcher)
12792 (car tagsmatcher))
12793 orlist)
12794 (setq tagsmatcher nil))
12795 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12796 (setq tagsmatcher
12797 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12798 ;; Make the todo matcher
12800 (setq todomatcher t)
12801 (setq orterms (org-split-string todomatch "|") orlist nil)
12802 (while (setq term (pop orterms))
12803 (while (string-match re term)
12804 (setq minus (and (match-end 1)
12805 (equal (match-string 1 term) "-"))
12806 kwd (match-string 2 term)
12807 re-p (equal (string-to-char kwd) ?{)
12808 term (substring term (match-end 0))
12809 mm (if re-p
12810 `(string-match ,(substring kwd 1 -1) todo)
12811 (list 'equal 'todo kwd))
12812 mm (if minus (list 'not mm) mm))
12813 (push mm todomatcher))
12814 (push (if (> (length todomatcher) 1)
12815 (cons 'and todomatcher)
12816 (car todomatcher))
12817 orlist)
12818 (setq todomatcher nil))
12819 (setq todomatcher (if (> (length orlist) 1)
12820 (cons 'or orlist) (car orlist))))
12822 ;; Return the string and lisp forms of the matcher
12823 (setq matcher (if todomatcher
12824 (list 'and tagsmatcher todomatcher)
12825 tagsmatcher))
12826 (cons match0 matcher)))
12828 (defun org-op-to-function (op &optional stringp)
12829 "Turn an operator into the appropriate function."
12830 (setq op
12831 (cond
12832 ((equal op "<" ) '(< string< org-time<))
12833 ((equal op ">" ) '(> org-string> org-time>))
12834 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12835 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12836 ((member op '("=" "==")) '(= string= org-time=))
12837 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12838 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12840 (defun org<> (a b) (not (= a b)))
12841 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12842 (defun org-string>= (a b) (not (string< a b)))
12843 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12844 (defun org-string<> (a b) (not (string= a b)))
12845 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12846 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12847 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12848 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12849 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12850 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12851 (defun org-2ft (s)
12852 "Convert S to a floating point time.
12853 If S is already a number, just return it. If it is a string, parse
12854 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12855 (cond
12856 ((numberp s) s)
12857 ((stringp s)
12858 (condition-case nil
12859 (float-time (apply 'encode-time (org-parse-time-string s)))
12860 (error 0.)))
12861 (t 0.)))
12863 (defun org-time-today ()
12864 "Time in seconds today at 0:00.
12865 Returns the float number of seconds since the beginning of the
12866 epoch to the beginning of today (00:00)."
12867 (float-time (apply 'encode-time
12868 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12870 (defun org-matcher-time (s)
12871 "Interpret a time comparison value."
12872 (save-match-data
12873 (cond
12874 ((string= s "<now>") (float-time))
12875 ((string= s "<today>") (org-time-today))
12876 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12877 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12879 (+ (org-time-today)
12880 (* (string-to-number (match-string 1 s))
12881 (cdr (assoc (match-string 2 s)
12882 '(("d" . 86400.0) ("w" . 604800.0)
12883 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12884 (t (org-2ft s)))))
12886 (defun org-match-any-p (re list)
12887 "Does re match any element of list?"
12888 (setq list (mapcar (lambda (x) (string-match re x)) list))
12889 (delq nil list))
12891 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12892 (defvar org-tags-overlay (make-overlay 1 1))
12893 (org-detach-overlay org-tags-overlay)
12895 (defun org-get-local-tags-at (&optional pos)
12896 "Get a list of tags defined in the current headline."
12897 (org-get-tags-at pos 'local))
12899 (defun org-get-local-tags ()
12900 "Get a list of tags defined in the current headline."
12901 (org-get-tags-at nil 'local))
12903 (defun org-get-tags-at (&optional pos local)
12904 "Get a list of all headline tags applicable at POS.
12905 POS defaults to point. If tags are inherited, the list contains
12906 the targets in the same sequence as the headlines appear, i.e.
12907 the tags of the current headline come last.
12908 When LOCAL is non-nil, only return tags from the current headline,
12909 ignore inherited ones."
12910 (interactive)
12911 (if (and org-trust-scanner-tags
12912 (or (not pos) (equal pos (point)))
12913 (not local))
12914 org-scanner-tags
12915 (let (tags ltags lastpos parent)
12916 (save-excursion
12917 (save-restriction
12918 (widen)
12919 (goto-char (or pos (point)))
12920 (save-match-data
12921 (catch 'done
12922 (condition-case nil
12923 (progn
12924 (org-back-to-heading t)
12925 (while (not (equal lastpos (point)))
12926 (setq lastpos (point))
12927 (when (looking-at
12929 (setq ltags (org-split-string
12930 (org-match-string-no-properties 1) ":"))
12931 (when parent
12932 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12933 (setq tags (append
12934 (if parent
12935 (org-remove-uninherited-tags ltags)
12936 ltags)
12937 tags)))
12938 (or org-use-tag-inheritance (throw 'done t))
12939 (if local (throw 'done t))
12940 (or (org-up-heading-safe) (error nil))
12941 (setq parent t)))
12942 (error nil)))))
12943 (if local
12944 tags
12945 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12947 (defun org-add-prop-inherited (s)
12948 (add-text-properties 0 (length s) '(inherited t) s)
12949 s)
12951 (defun org-toggle-tag (tag &optional onoff)
12952 "Toggle the tag TAG for the current line.
12953 If ONOFF is `on' or `off', don't toggle but set to this state."
12954 (let (res current)
12955 (save-excursion
12956 (org-back-to-heading t)
12958 (point-at-eol) t)
12959 (progn
12960 (setq current (match-string 1))
12961 (replace-match ""))
12962 (setq current ""))
12963 (setq current (nreverse (org-split-string current ":")))
12964 (cond
12965 ((eq onoff 'on)
12966 (setq res t)
12967 (or (member tag current) (push tag current)))
12968 ((eq onoff 'off)
12969 (or (not (member tag current)) (setq current (delete tag current))))
12970 (t (if (member tag current)
12971 (setq current (delete tag current))
12972 (setq res t)
12973 (push tag current))))
12974 (end-of-line 1)
12975 (if current
12976 (progn
12977 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12978 (org-set-tags nil t))
12979 (delete-horizontal-space))
12980 (run-hooks 'org-after-tags-change-hook))
12981 res))
12983 (defun org-align-tags-here (to-col)
12984 ;; Assumes that this is a headline
12985 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12986 (beginning-of-line 1)
12988 (< pos (match-beginning 2)))
12989 (progn
12990 (setq tags-l (- (match-end 2) (match-beginning 2)))
12991 (goto-char (match-beginning 1))
12992 (insert " ")
12993 (delete-region (point) (1+ (match-beginning 2)))
12994 (setq ncol (max (1+ (current-column))
12995 (1+ col)
12996 (if (> to-col 0)
12997 to-col
12998 (- (abs to-col) tags-l))))
12999 (setq p (point))
13000 (insert (make-string (- ncol (current-column)) ?\ ))
13001 (setq ncol (current-column))
13002 (when indent-tabs-mode (tabify p (point-at-eol)))
13003 (org-move-to-column (min ncol col) t))
13004 (goto-char pos))))
13006 (defun org-set-tags-command (&optional arg just-align)
13007 "Call the set-tags command for the current entry."
13008 (interactive "P")
13009 (if (org-on-heading-p)
13010 (org-set-tags arg just-align)
13011 (save-excursion
13012 (org-back-to-heading t)
13013 (org-set-tags arg just-align))))
13015 (defun org-set-tags-to (data)
13016 "Set the tags of the current entry to DATA, replacing the current tags.
13017 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13018 If DATA is nil or the empty string, any tags will be removed."
13019 (interactive "sTags: ")
13020 (setq data
13021 (cond
13022 ((eq data nil) "")
13023 ((equal data "") "")
13024 ((stringp data)
13025 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13026 ":"))
13027 ((listp data)
13028 (concat ":" (mapconcat 'identity data ":") ":"))
13029 (t nil)))
13030 (when data
13031 (save-excursion
13032 (org-back-to-heading t)
13033 (when (looking-at org-complex-heading-regexp)
13034 (if (match-end 5)
13035 (progn
13036 (goto-char (match-beginning 5))
13037 (insert data)
13038 (delete-region (point) (point-at-eol))
13039 (org-set-tags nil 'align))
13040 (goto-char (point-at-eol))
13041 (insert " " data)
13042 (org-set-tags nil 'align)))
13043 (beginning-of-line 1)
13045 (delete-region (match-beginning 1) (match-end 1))))))
13047 (defun org-align-all-tags ()
13048 "Align the tags i all headings."
13049 (interactive)
13050 (save-excursion
13051 (or (ignore-errors (org-back-to-heading t))
13052 (outline-next-heading))
13053 (if (org-on-heading-p)
13054 (org-set-tags t)
13055 (message "No headings"))))
13057 (defvar org-indent-indentation-per-level)
13058 (defun org-set-tags (&optional arg just-align)
13059 "Set the tags for the current headline.
13060 With prefix ARG, realign all tags in headings in the current buffer."
13061 (interactive "P")
13062 (let* ((re org-outline-regexp-bol)
13063 (current (org-get-tags-string))
13064 (col (current-column))
13065 (org-setting-tags t)
13066 table current-tags inherited-tags ; computed below when needed
13067 tags p0 c0 c1 rpl di tc level)
13068 (if arg
13069 (save-excursion
13070 (goto-char (point-min))
13071 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13072 (while (re-search-forward re nil t)
13073 (org-set-tags nil t)
13074 (end-of-line 1)))
13075 (message "All tags realigned to column %d" org-tags-column))
13076 (if just-align
13077 (setq tags current)
13078 ;; Get a new set of tags from the user
13079 (save-excursion
13080 (setq table (append org-tag-persistent-alist
13081 (or org-tag-alist (org-get-buffer-tags))
13082 (and
13083 org-complete-tags-always-offer-all-agenda-tags
13084 (org-global-tags-completion-table
13085 (org-agenda-files))))
13086 org-last-tags-completion-table table
13087 current-tags (org-split-string current ":")
13088 inherited-tags (nreverse
13089 (nthcdr (length current-tags)
13090 (nreverse (org-get-tags-at))))
13091 tags
13092 (if (or (eq t org-use-fast-tag-selection)
13093 (and org-use-fast-tag-selection
13094 (delq nil (mapcar 'cdr table))))
13095 (org-fast-tag-selection
13096 current-tags inherited-tags table
13097 (if org-fast-tag-selection-include-todo
13098 org-todo-key-alist))
13099 (let ((org-add-colon-after-tag-completion t))
13100 (org-trim
13101 (org-icompleting-read "Tags: "
13102 'org-tags-completion-function
13103 nil nil current 'org-tags-history))))))
13104 (while (string-match "[-+&]+" tags)
13105 ;; No boolean logic, just a list
13106 (setq tags (replace-match ":" t t tags))))
13108 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13110 (if org-tags-sort-function
13111 (setq tags (mapconcat 'identity
13112 (sort (org-split-string
13113 tags (org-re "[^[:alnum:]_@#%]+"))
13114 org-tags-sort-function) ":")))
13117 (setq tags "")
13118 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13119 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13121 ;; Insert new tags at the correct column
13122 (beginning-of-line 1)
13123 (setq level (or (and (looking-at org-outline-regexp)
13124 (- (match-end 0) (point) 1))
13125 1))
13126 (cond
13127 ((and (equal current "") (equal tags "")))
13128 ((re-search-forward
13130 (point-at-eol) t)
13131 (if (equal tags "")
13132 (setq rpl "")
13133 (goto-char (match-beginning 0))
13134 (setq c0 (current-column)
13135 ;; compute offset for the case of org-indent-mode active
13136 di (if org-indent-mode
13137 (* (1- org-indent-indentation-per-level) (1- level))
13138 0)
13139 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13140 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13141 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13142 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13143 (replace-match rpl t t)
13144 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13145 tags)
13146 (t (error "Tags alignment failed")))
13147 (org-move-to-column col)
13148 (unless just-align
13149 (run-hooks 'org-after-tags-change-hook)))))
13151 (defun org-change-tag-in-region (beg end tag off)
13152 "Add or remove TAG for each entry in the region.
13153 This works in the agenda, and also in an org-mode buffer."
13154 (interactive
13155 (list (region-beginning) (region-end)
13156 (let ((org-last-tags-completion-table
13157 (if (org-mode-p)
13158 (org-get-buffer-tags)
13159 (org-global-tags-completion-table))))
13160 (org-icompleting-read
13161 "Tag: " 'org-tags-completion-function nil nil nil
13162 'org-tags-history))
13163 (progn
13165 (equal (read-char-exclusive) ?r))))
13166 (if (fboundp 'deactivate-mark) (deactivate-mark))
13167 (let ((agendap (equal major-mode 'org-agenda-mode))
13168 l1 l2 m buf pos newhead (cnt 0))
13169 (goto-char end)
13170 (setq l2 (1- (org-current-line)))
13171 (goto-char beg)
13172 (setq l1 (org-current-line))
13173 (loop for l from l1 to l2 do
13174 (org-goto-line l)
13175 (setq m (get-text-property (point) 'org-hd-marker))
13176 (when (or (and (org-mode-p) (org-on-heading-p))
13177 (and agendap m))
13178 (setq buf (if agendap (marker-buffer m) (current-buffer))
13179 pos (if agendap m (point)))
13180 (with-current-buffer buf
13181 (save-excursion
13182 (save-restriction
13183 (goto-char pos)
13184 (setq cnt (1+ cnt))
13185 (org-toggle-tag tag (if off 'off 'on))
13186 (setq newhead (org-get-heading)))))
13187 (and agendap (org-agenda-change-all-lines newhead m))))
13188 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13190 (defun org-tags-completion-function (string predicate &optional flag)
13191 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13192 (confirm (lambda (x) (stringp (car x)))))
13194 (setq s1 (match-string 1 string)
13195 s2 (match-string 2 string))
13196 (setq s1 "" s2 string))
13197 (cond
13198 ((eq flag nil)
13199 ;; try completion
13200 (setq rtn (try-completion s2 ctable confirm))
13201 (if (stringp rtn)
13202 (setq rtn
13203 (concat s1 s2 (substring rtn (length s2))
13204 (if (and org-add-colon-after-tag-completion
13205 (assoc rtn ctable))
13206 ":" ""))))
13207 rtn)
13208 ((eq flag t)
13209 ;; all-completions
13210 (all-completions s2 ctable confirm)
13211 )
13212 ((eq flag 'lambda)
13213 ;; exact match?
13214 (assoc s2 ctable)))
13215 ))
13217 (defun org-fast-tag-insert (kwd tags face &optional end)
13218 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13219 (insert (format "%-12s" (concat kwd ":"))
13220 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13221 (or end "")))
13223 (defun org-fast-tag-show-exit (flag)
13224 (save-excursion
13225 (org-goto-line 3)
13227 (replace-match ""))
13228 (when flag
13229 (end-of-line 1)
13230 (org-move-to-column (- (window-width) 19) t)
13231 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13233 (defun org-set-current-tags-overlay (current prefix)
13234 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13235 (if (featurep 'xemacs)
13236 (org-overlay-display org-tags-overlay (concat prefix s)
13237 'secondary-selection)
13238 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13239 (org-overlay-display org-tags-overlay (concat prefix s)))))
13241 (defvar org-last-tag-selection-key nil)
13242 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13243 "Fast tag selection with single keys.
13244 CURRENT is the current list of tags in the headline, INHERITED is the
13245 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13246 possibly with grouping information. TODO-TABLE is a similar table with
13247 TODO keywords, should these have keys assigned to them.
13248 If the keys are nil, a-z are automatically assigned.
13249 Returns the new tags string, or nil to not change the current settings."
13250 (let* ((fulltable (append table todo-table))
13251 (maxlen (apply 'max (mapcar
13252 (lambda (x)
13253 (if (stringp (car x)) (string-width (car x)) 0))
13254 fulltable)))
13255 (buf (current-buffer))
13256 (expert (eq org-fast-tag-selection-single-key 'expert))
13257 (buffer-tags nil)
13258 (fwidth (+ maxlen 3 1 3))
13259 (ncol (/ (- (window-width) 4) fwidth))
13260 (i-face 'org-done)
13261 (c-face 'org-todo)
13262 tg cnt e c char c1 c2 ntable tbl rtn
13263 ov-start ov-end ov-prefix
13264 (exit-after-next org-fast-tag-selection-single-key)
13265 (done-keywords org-done-keywords)
13266 groups ingroup)
13267 (save-excursion
13268 (beginning-of-line 1)
13269 (if (looking-at
13271 (setq ov-start (match-beginning 1)
13272 ov-end (match-end 1)
13273 ov-prefix "")
13274 (setq ov-start (1- (point-at-eol))
13275 ov-end (1+ ov-start))
13277 (setq ov-prefix
13278 (concat
13279 (buffer-substring (1- (point)) (point))
13280 (if (> (current-column) org-tags-column)
13281 " "
13282 (make-string (- org-tags-column (current-column)) ?\ ))))))
13283 (move-overlay org-tags-overlay ov-start ov-end)
13284 (save-window-excursion
13285 (if expert
13286 (set-buffer (get-buffer-create " *Org tags*"))
13287 (delete-other-windows)
13288 (split-window-vertically)
13289 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13290 (erase-buffer)
13291 (org-set-local 'org-done-keywords done-keywords)
13294 (org-fast-tag-show-exit exit-after-next)
13295 (org-set-current-tags-overlay current ov-prefix)
13296 (setq tbl fulltable char ?a cnt 0)
13297 (while (setq e (pop tbl))
13298 (cond
13299 ((equal (car e) :startgroup)
13300 (push '() groups) (setq ingroup t)
13301 (when (not (= cnt 0))
13302 (setq cnt 0)
13304 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13305 ((equal (car e) :endgroup)
13306 (setq ingroup nil cnt 0)
13308 ((equal e '(:newline))
13309 (when (not (= cnt 0))
13310 (setq cnt 0)
13312 (setq e (car tbl))
13313 (while (equal (car tbl) '(:newline))
13315 (setq tbl (cdr tbl)))))
13316 (t
13317 (setq tg (copy-sequence (car e)) c2 nil)
13318 (if (cdr e)
13319 (setq c (cdr e))
13320 ;; automatically assign a character.
13321 (setq c1 (string-to-char
13322 (downcase (substring
13323 tg (if (= (string-to-char tg) ?@) 1 0)))))
13324 (if (or (rassoc c1 ntable) (rassoc c1 table))
13325 (while (or (rassoc char ntable) (rassoc char table))
13326 (setq char (1+ char)))
13327 (setq c2 c1))
13328 (setq c (or c2 char)))
13329 (if ingroup (push tg (car groups)))
13330 (setq tg (org-add-props tg nil 'face
13331 (cond
13332 ((not (assoc tg table))
13333 (org-get-todo-face tg))
13334 ((member tg current) c-face)
13335 ((member tg inherited) i-face)
13336 (t nil))))
13337 (if (and (= cnt 0) (not ingroup)) (insert " "))
13338 (insert "[" c "] " tg (make-string
13339 (- fwidth 4 (length tg)) ?\ ))
13340 (push (cons tg c) ntable)
13341 (when (= (setq cnt (1+ cnt)) ncol)
13343 (if ingroup (insert " "))
13344 (setq cnt 0)))))
13345 (setq ntable (nreverse ntable))
13347 (goto-char (point-min))
13348 (if (not expert) (org-fit-window-to-buffer))
13349 (setq rtn
13350 (catch 'exit
13351 (while t
13352 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13353 (if (not groups) "no " "")
13354 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13355 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13356 (setq org-last-tag-selection-key c)
13357 (cond
13359 ((= c ?!)
13360 (setq groups (not groups))
13361 (goto-char (point-min))
13362 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13363 ((= c ?\C-c)
13364 (if (not expert)
13365 (org-fast-tag-show-exit
13366 (setq exit-after-next (not exit-after-next)))
13367 (setq expert nil)
13368 (delete-other-windows)
13369 (set-window-buffer (split-window-vertically) " *Org tags*")
13370 (org-switch-to-buffer-other-window " *Org tags*")
13371 (org-fit-window-to-buffer)))
13372 ((or (= c ?\C-g)
13373 (and (= c ?q) (not (rassoc c ntable))))
13374 (org-detach-overlay org-tags-overlay)
13375 (setq quit-flag t))
13376 ((= c ?\ )
13377 (setq current nil)
13378 (if exit-after-next (setq exit-after-next 'now)))
13380 (condition-case nil
13381 (setq tg (org-icompleting-read
13382 "Tag: "
13383 (or buffer-tags
13384 (with-current-buffer buf
13385 (org-get-buffer-tags)))))
13386 (quit (setq tg "")))
13388 (add-to-list 'buffer-tags (list tg))
13389 (if (member tg current)
13390 (setq current (delete tg current))
13391 (push tg current)))
13392 (if exit-after-next (setq exit-after-next 'now)))
13393 ((setq e (rassoc c todo-table) tg (car e))
13394 (with-current-buffer buf
13395 (save-excursion (org-todo tg)))
13396 (if exit-after-next (setq exit-after-next 'now)))
13397 ((setq e (rassoc c ntable) tg (car e))
13398 (if (member tg current)
13399 (setq current (delete tg current))
13400 (loop for g in groups do
13401 (if (member tg g)
13402 (mapc (lambda (x)
13403 (setq current (delete x current)))
13404 g)))
13405 (push tg current))
13406 (if exit-after-next (setq exit-after-next 'now))))
13408 ;; Create a sorted list
13409 (setq current
13410 (sort current
13411 (lambda (a b)
13412 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13413 (if (eq exit-after-next 'now) (throw 'exit t))
13414 (goto-char (point-min))
13415 (beginning-of-line 2)
13416 (delete-region (point) (point-at-eol))
13417 (org-fast-tag-insert "Current" current c-face)
13418 (org-set-current-tags-overlay current ov-prefix)
13419 (while (re-search-forward
13421 (setq tg (match-string 1))
13422 (add-text-properties
13423 (match-beginning 1) (match-end 1)
13424 (list 'face
13425 (cond
13426 ((member tg current) c-face)
13427 ((member tg inherited) i-face)
13428 (t (get-text-property (match-beginning 1) 'face))))))
13429 (goto-char (point-min)))))
13430 (org-detach-overlay org-tags-overlay)
13431 (if rtn
13432 (mapconcat 'identity current ":")
13433 nil))))
13435 (defun org-get-tags-string ()
13436 "Get the TAGS string in the current headline."
13437 (unless (org-on-heading-p t)
13438 (error "Not on a heading"))
13439 (save-excursion
13440 (beginning-of-line 1)
13442 (org-match-string-no-properties 1)
13443 "")))
13445 (defun org-get-tags ()
13446 "Get the list of tags specified in the current headline."
13447 (org-split-string (org-get-tags-string) ":"))
13449 (defun org-get-buffer-tags ()
13450 "Get a table of all tags used in the buffer, for completion."
13451 (let (tags)
13452 (save-excursion
13453 (goto-char (point-min))
13454 (while (re-search-forward
13456 (when (equal (char-after (point-at-bol 0)) ?*)
13457 (mapc (lambda (x) (add-to-list 'tags x))
13458 (org-split-string (org-match-string-no-properties 1) ":")))))
13459 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13460 (mapcar 'list tags)))
13462 ;;;; The mapping API
13464 ;;;###autoload
13465 (defun org-map-entries (func &optional match scope &rest skip)
13466 "Call FUNC at each headline selected by MATCH in SCOPE.
13468 FUNC is a function or a lisp form. The function will be called without
13469 arguments, with the cursor positioned at the beginning of the headline.
13470 The return values of all calls to the function will be collected and
13471 returned as a list.
13473 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13474 does not need to preserve point. After evaluation, the cursor will be
13475 moved to the end of the line (presumably of the headline of the
13476 processed entry) and search continues from there. Under some
13477 circumstances, this may not produce the wanted results. For example,
13478 if you have removed (e.g. archived) the current (sub)tree it could
13479 mean that the next entry will be skipped entirely. In such cases, you
13480 can specify the position from where search should continue by making
13481 FUNC set the variable `org-map-continue-from' to the desired buffer
13482 position.
13484 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13485 Only headlines that are matched by this query will be considered during
13486 the iteration. When MATCH is nil or t, all headlines will be
13487 visited by the iteration.
13489 SCOPE determines the scope of this command. It can be any of:
13491 nil The current buffer, respecting the restriction if any
13492 tree The subtree started with the entry at point
13493 region The entries within the active region, if any
13494 file The current buffer, without restriction
13495 file-with-archives
13496 The current buffer, and any archives associated with it
13497 agenda All agenda files
13498 agenda-with-archives
13499 All agenda files with any archive files associated with them
13500 \(file1 file2 ...)
13501 If this is a list, all files in the list will be scanned
13503 The remaining args are treated as settings for the skipping facilities of
13504 the scanner. The following items can be given here:
13506 archive skip trees with the archive tag.
13507 comment skip trees with the COMMENT keyword
13508 function or Emacs Lisp form:
13509 will be used as value for `org-agenda-skip-function', so whenever
13510 the function returns t, FUNC will not be called for that
13511 entry and search will continue from the point where the
13512 function leaves it.
13514 If your function needs to retrieve the tags including inherited tags
13515 at the *current* entry, you can use the value of the variable
13516 `org-scanner-tags' which will be much faster than getting the value
13517 with `org-get-tags-at'. If your function gets properties with
13518 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13519 to t around the call to `org-entry-properties' to get the same speedup.
13520 Note that if your function moves around to retrieve tags and properties at
13521 a *different* entry, you cannot use these techniques."
13522 (let* ((org-agenda-archives-mode nil) ; just to make sure
13523 (org-agenda-skip-archived-trees (memq 'archive skip))
13524 (org-agenda-skip-comment-trees (memq 'comment skip))
13525 (org-agenda-skip-function
13526 (car (org-delete-all '(comment archive) skip)))
13527 (org-tags-match-list-sublevels t)
13528 matcher file res
13529 org-todo-keywords-for-agenda
13530 org-done-keywords-for-agenda
13531 org-todo-keyword-alist-for-agenda
13532 org-drawers-for-agenda
13533 org-tag-alist-for-agenda)
13535 (cond
13536 ((eq match t) (setq matcher t))
13537 ((eq match nil) (setq matcher t))
13538 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13540 (save-excursion
13541 (save-restriction
13542 (cond ((eq scope 'tree)
13543 (org-back-to-heading t)
13544 (org-narrow-to-subtree)
13545 (setq scope nil))
13546 ((and (eq scope 'region) (org-region-active-p))
13547 (narrow-to-region (region-beginning) (region-end))
13548 (setq scope nil)))
13550 (if (not scope)
13551 (progn
13552 (org-prepare-agenda-buffers
13553 (list (buffer-file-name (current-buffer))))
13554 (setq res (org-scan-tags func matcher)))
13555 ;; Get the right scope
13556 (cond
13557 ((and scope (listp scope) (symbolp (car scope)))
13558 (setq scope (eval scope)))
13559 ((eq scope 'agenda)
13560 (setq scope (org-agenda-files t)))
13561 ((eq scope 'agenda-with-archives)
13562 (setq scope (org-agenda-files t))
13563 (setq scope (org-add-archive-files scope)))
13564 ((eq scope 'file)
13565 (setq scope (list (buffer-file-name))))
13566 ((eq scope 'file-with-archives)
13567 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13568 (org-prepare-agenda-buffers scope)
13569 (while (setq file (pop scope))
13570 (with-current-buffer (org-find-base-buffer-visiting file)
13571 (save-excursion
13572 (save-restriction
13573 (widen)
13574 (goto-char (point-min))
13575 (setq res (append res (org-scan-tags func matcher))))))))))
13576 res))
13578 ;;;; Properties
13580 ;;; Setting and retrieving properties
13582 (defconst org-special-properties
13583 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13584 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13585 "The special properties valid in Org-mode.
13587 These are properties that are not defined in the property drawer,
13588 but in some other way.")
13590 (defconst org-default-properties
13591 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13592 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13593 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13594 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13595 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13596 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13597 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13598 "Some properties that are used by Org-mode for various purposes.
13599 Being in this list makes sure that they are offered for completion.")
13602 "Regular expression matching the first line of a property drawer.")
13605 "Regular expression matching the last line of a property drawer.")
13608 "Regular expression matching the first line of a property drawer.")
13611 "Regular expression matching the first line of a property drawer.")
13613 (defconst org-property-drawer-re
13616 "Matches an entire property drawer.")
13618 (defconst org-clock-drawer-re
13621 "Matches an entire clock drawer.")
13623 (defsubst org-re-property (property)
13624 "Return a regexp matching PROPERTY.
13625 Match group 1 will be set to the value "
13628 (defun org-property-action ()
13629 "Do an action on properties."
13630 (interactive)
13631 (let (c)
13632 (org-at-property-p)
13633 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13634 (setq c (read-char-exclusive))
13635 (cond
13636 ((equal c ?s)
13637 (call-interactively 'org-set-property))
13638 ((equal c ?d)
13639 (call-interactively 'org-delete-property))
13640 ((equal c ?D)
13641 (call-interactively 'org-delete-property-globally))
13642 ((equal c ?c)
13643 (call-interactively 'org-compute-property-at-point))
13644 (t (error "No such property action %c" c)))))
13646 (defun org-set-effort (&optional value)
13647 "Set the effort property of the current entry.
13648 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13649 allowed value."
13650 (interactive "P")
13651 (if (equal value 0) (setq value 10))
13652 (let* ((completion-ignore-case t)
13653 (prop org-effort-property)
13654 (cur (org-entry-get nil prop))
13655 (allowed (org-property-get-allowed-values nil prop 'table))
13656 (existing (mapcar 'list (org-property-values prop)))
13657 rpl
13658 (val (cond
13659 ((stringp value) value)
13660 ((and allowed (integerp value))
13661 (or (car (nth (1- value) allowed))
13662 (car (org-last allowed))))
13663 (allowed
13664 (message "Select 1-9,0, [RET%s]: %s"
13665 (if cur (concat "=" cur) "")
13666 (mapconcat 'car allowed " "))
13667 (setq rpl (read-char-exclusive))
13669 cur
13670 (setq rpl (- rpl ?0))
13671 (if (equal rpl 0) (setq rpl 10))
13672 (if (and (> rpl 0) (<= rpl (length allowed)))
13673 (car (nth (1- rpl) allowed))
13674 (org-completing-read "Effort: " allowed nil))))
13675 (t
13676 (let (org-completion-use-ido org-completion-use-iswitchb)
13677 (org-completing-read
13679 (concat "[" cur "]") "")
13680 ": ")
13681 existing nil nil "" nil cur))))))
13682 (unless (equal (org-entry-get nil prop) val)
13683 (org-entry-put nil prop val))
13684 (message "%s is now %s" prop val)))
13686 (defun org-at-property-p ()
13687 "Is cursor inside a property drawer?"
13688 (save-excursion
13689 (beginning-of-line 1)
13691 (save-match-data ;; Used by calling procedures
13692 (let ((p (point))
13693 (range (unless (org-before-first-heading-p)
13694 (org-get-property-block))))
13695 (and range (<= (car range) p) (< p (cdr range))))))))
13697 (defun org-get-property-block (&optional beg end force)
13698 "Return the (beg . end) range of the body of the property drawer.
13699 BEG and END can be beginning and end of subtree, if not given
13700 they will be found.
13701 If the drawer does not exist and FORCE is non-nil, create the drawer."
13702 (catch 'exit
13703 (save-excursion
13704 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13705 (end (or end (progn (outline-next-heading) (point)))))
13706 (goto-char beg)
13707 (if (re-search-forward org-property-start-re end t)
13708 (setq beg (1+ (match-end 0)))
13709 (if force
13710 (save-excursion
13711 (org-insert-property-drawer)
13712 (setq end (progn (outline-next-heading) (point))))
13713 (throw 'exit nil))
13714 (goto-char beg)
13715 (if (re-search-forward org-property-start-re end t)
13716 (setq beg (1+ (match-end 0)))))
13717 (if (re-search-forward org-property-end-re end t)
13718 (setq end (match-beginning 0))
13719 (or force (throw 'exit nil))
13720 (goto-char beg)
13721 (setq end beg)
13722 (org-indent-line-function)
13724 (cons beg end)))))
13726 (defun org-entry-properties (&optional pom which specific)
13727 "Get all properties of the entry at point-or-marker POM.
13728 This includes the TODO keyword, the tags, time strings for deadline,
13729 scheduled, and clocking, and any additional properties defined in the
13730 entry. The return value is an alist, keys may occur multiple times
13731 if the property key was used several times.
13732 POM may also be nil, in which case the current entry is used.
13733 If WHICH is nil or `all', get all properties. If WHICH is
13734 `special' or `standard', only get that subclass. If WHICH
13735 is a string only get exactly this property. SPECIFIC can be a string, the
13736 specific property we are interested in. Specifying it can speed
13737 things up because then unnecessary parsing is avoided."
13738 (setq which (or which 'all))
13739 (org-with-point-at pom
13740 (let ((clockstr (substring org-clock-string 0 -1))
13741 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13742 (case-fold-search nil)
13743 beg end range props sum-props key key1 value string clocksum)
13744 (save-excursion
13745 (when (condition-case nil
13746 (and (org-mode-p) (org-back-to-heading t))
13747 (error nil))
13748 (setq beg (point))
13749 (setq sum-props (get-text-property (point) 'org-summaries))
13750 (setq clocksum (get-text-property (point) :org-clock-minutes))
13751 (outline-next-heading)
13752 (setq end (point))
13753 (when (memq which '(all special))
13754 ;; Get the special properties, like TODO and tags
13755 (goto-char beg)
13756 (when (and (or (not specific) (string= specific "TODO"))
13757 (looking-at org-todo-line-regexp) (match-end 2))
13758 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13759 (when (and (or (not specific) (string= specific "PRIORITY"))
13760 (looking-at org-priority-regexp))
13761 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13762 (when (or (not specific) (string= specific "FILE"))
13763 (push (cons "FILE" buffer-file-name) props))
13764 (when (and (or (not specific) (string= specific "TAGS"))
13765 (setq value (org-get-tags-string))
13767 (push (cons "TAGS" value) props))
13768 (when (and (or (not specific) (string= specific "ALLTAGS"))
13769 (setq value (org-get-tags-at)))
13770 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13771 ":"))
13772 props))
13773 (when (or (not specific) (string= specific "BLOCKED"))
13774 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13775 (when (or (not specific)
13776 (member specific
13777 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13778 "TIMESTAMP" "TIMESTAMP_IA")))
13779 (catch 'match
13780 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13781 (setq key (if (match-end 1)
13782 (substring (org-match-string-no-properties 1)
13783 0 -1))
13784 string (if (equal key clockstr)
13785 (org-no-properties
13786 (org-trim
13787 (buffer-substring
13788 (match-beginning 3) (goto-char
13789 (point-at-eol)))))
13790 (substring (org-match-string-no-properties 3)
13791 1 -1)))
13792 ;; Get the correct property name from the key. This is
13793 ;; necessary if the user has configured time keywords.
13794 (setq key1 (concat key ":"))
13795 (cond
13796 ((not key)
13797 (setq key
13798 (if (= (char-after (match-beginning 3)) ?\[)
13799 "TIMESTAMP_IA" "TIMESTAMP")))
13800 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13801 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13802 ((equal key1 org-closed-string) (setq key "CLOSED"))
13803 ((equal key1 org-clock-string) (setq key "CLOCK")))
13804 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13805 (progn
13806 (push (cons key string) props)
13807 ;; no need to search further if match is found
13808 (throw 'match t))
13809 (when (or (equal key "CLOCK") (not (assoc key props)))
13810 (push (cons key string) props))))))
13811 )
13813 (when (memq which '(all standard))
13814 ;; Get the standard properties, like :PROP: ...
13815 (setq range (org-get-property-block beg end))
13816 (when range
13817 (goto-char (car range))
13818 (while (re-search-forward
13820 (cdr range) t)
13821 (setq key (org-match-string-no-properties 1)
13822 value (org-trim (or (org-match-string-no-properties 2) "")))
13823 (unless (member key excluded)
13824 (push (cons key (or value "")) props)))))
13825 (if clocksum
13826 (push (cons "CLOCKSUM"
13827 (org-columns-number-to-string (/ (float clocksum) 60.)
13828 'add_times))
13829 props))
13830 (unless (assoc "CATEGORY" props)
13831 (push (cons "CATEGORY" (org-get-category)) props))
13832 (append sum-props (nreverse props)))))))
13834 (defun org-entry-get (pom property &optional inherit literal-nil)
13835 "Get value of PROPERTY for entry at point-or-marker POM.
13836 If INHERIT is non-nil and the entry does not have the property,
13837 then also check higher levels of the hierarchy.
13838 If INHERIT is the symbol `selective', use inheritance only if the setting
13839 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13840 If the property is present but empty, the return value is the empty string.
13841 If the property is not present at all, nil is returned.
13844 do not interpret it as the list atom nil. This is used for inheritance
13846 (org-with-point-at pom
13847 (if (and inherit (if (eq inherit 'selective)
13848 (org-property-inherit-p property)
13849 t))
13850 (org-entry-get-with-inheritance property literal-nil)
13851 (if (member property org-special-properties)
13852 ;; We need a special property. Use `org-entry-properties' to
13853 ;; retrieve it, but specify the wanted property
13854 (cdr (assoc property (org-entry-properties nil 'special property)))
13855 (let ((range (unless (org-before-first-heading-p)
13856 (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 ;; Found the property, return it.
13863 (if (match-end 1)
13864 (if literal-nil
13865 (org-match-string-no-properties 1)
13866 (org-not-nil (org-match-string-no-properties 1)))
13867 "")))))))
13869 (defun org-property-or-variable-value (var &optional inherit)
13870 "Check if there is a property fixing the value of VAR.
13871 If yes, return this value. If not, return the current value of the variable."
13872 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13874 (read prop)
13875 (symbol-value var))))
13877 (defun org-entry-delete (pom property)
13878 "Delete the property PROPERTY from entry at point-or-marker POM."
13879 (org-with-point-at pom
13880 (if (member property org-special-properties)
13881 nil ; cannot delete these properties.
13882 (let ((range (org-get-property-block)))
13883 (if (and range
13884 (goto-char (car range))
13885 (re-search-forward
13886 (org-re-property property)
13887 (cdr range) t))
13888 (progn
13889 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13890 t)
13891 nil)))))
13893 ;; Multi-values properties are properties that contain multiple values
13894 ;; These values are assumed to be single words, separated by whitespace.
13895 (defun org-entry-add-to-multivalued-property (pom property value)
13896 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13897 (let* ((old (org-entry-get pom property))
13899 (setq value (org-entry-protect-space value))
13900 (unless (member value values)
13901 (setq values (cons value values))
13902 (org-entry-put pom property
13903 (mapconcat 'identity values " ")))))
13905 (defun org-entry-remove-from-multivalued-property (pom property value)
13906 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13907 (let* ((old (org-entry-get pom property))
13909 (setq value (org-entry-protect-space value))
13910 (when (member value values)
13911 (setq values (delete value values))
13912 (org-entry-put pom property
13913 (mapconcat 'identity values " ")))))
13915 (defun org-entry-member-in-multivalued-property (pom property value)
13916 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13917 (let* ((old (org-entry-get pom property))
13919 (setq value (org-entry-protect-space value))
13920 (member value values)))
13922 (defun org-entry-get-multivalued-property (pom property)
13923 "Return a list of values in a multivalued property."
13924 (let* ((value (org-entry-get pom property))
13926 (mapcar 'org-entry-restore-space values)))
13928 (defun org-entry-put-multivalued-property (pom property &rest values)
13929 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13930 VALUES should be a list of strings. Spaces will be protected."
13931 (org-entry-put pom property
13932 (mapconcat 'org-entry-protect-space values " "))
13933 (let* ((value (org-entry-get pom property))
13935 (mapcar 'org-entry-restore-space values)))
13937 (defun org-entry-protect-space (s)
13938 "Protect spaces and newline in string S."
13939 (while (string-match " " s)
13940 (setq s (replace-match "%20" t t s)))
13942 (setq s (replace-match "%0A" t t s)))
13943 s)
13945 (defun org-entry-restore-space (s)
13946 "Restore spaces and newline in string S."
13947 (while (string-match "%20" s)
13948 (setq s (replace-match " " t t s)))
13949 (while (string-match "%0A" s)
13951 s)
13953 (defvar org-entry-property-inherited-from (make-marker)
13954 "Marker pointing to the entry from where a property was inherited.
13955 Each call to `org-entry-get-with-inheritance' will set this marker to the
13956 location of the entry where the inheritance search matched. If there was
13957 no match, the marker will point nowhere.
13958 Note that also `org-entry-get' calls this function, if the INHERIT flag
13959 is set.")
13961 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13962 "Get entry property, and search higher levels if not present.
13963 The search will stop at the first ancestor which has the property defined.
13965 should be considered as undefined (this is the meaning of nil here).
13967 (move-marker org-entry-property-inherited-from nil)
13968 (let (tmp)
13969 (unless (org-before-first-heading-p)
13970 (save-excursion
13971 (save-restriction
13972 (widen)
13973 (catch 'ex
13974 (while t
13975 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13976 (org-back-to-heading t)
13977 (move-marker org-entry-property-inherited-from (point))
13978 (throw 'ex tmp))
13979 (or (org-up-heading-safe) (throw 'ex nil)))))))
13980 (setq tmp (or tmp
13981 (cdr (assoc property org-file-properties))
13982 (cdr (assoc property org-global-properties))
13983 (cdr (assoc property org-global-properties-fixed))))
13984 (if literal-nil tmp (org-not-nil tmp))))
13986 (defvar org-property-changed-functions nil
13987 "Hook called when the value of a property has changed.
13988 Each hook function should accept two arguments, the name of the property
13989 and the new value.")
13991 (defun org-entry-put (pom property value)
13992 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13993 (org-with-point-at pom
13994 (org-back-to-heading t)
13995 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13996 range)
13997 (cond
13998 ((equal property "TODO")
14000 (not (member value org-todo-keywords-1)))
14002 (if (or (not value)
14004 (setq value 'none))
14005 (org-todo value)
14006 (org-set-tags nil 'align))
14007 ((equal property "PRIORITY")
14009 (string-to-char value) ?\ ))
14010 (org-set-tags nil 'align))
14011 ((equal property "SCHEDULED")
14012 (if (re-search-forward org-scheduled-time-regexp end t)
14013 (cond
14014 ((eq value 'earlier) (org-timestamp-change -1 'day))
14015 ((eq value 'later) (org-timestamp-change 1 'day))
14016 (t (call-interactively 'org-schedule)))
14017 (call-interactively 'org-schedule)))
14018 ((equal property "DEADLINE")
14019 (if (re-search-forward org-deadline-time-regexp end t)
14020 (cond
14021 ((eq value 'earlier) (org-timestamp-change -1 'day))
14022 ((eq value 'later) (org-timestamp-change 1 'day))
14023 (t (call-interactively 'org-deadline)))
14024 (call-interactively 'org-deadline)))
14025 ((member property org-special-properties)
14026 (error "The %s property can not yet be set with `org-entry-put'"
14027 property))
14028 (t ; a non-special property
14029 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14030 (setq range (org-get-property-block beg end 'force))
14031 (goto-char (car range))
14032 (if (re-search-forward
14033 (org-re-property property) (cdr range) t)
14034 (progn
14035 (delete-region (match-beginning 0) (match-end 0))
14036 (goto-char (match-beginning 0)))
14037 (goto-char (cdr range))
14039 (backward-char 1)
14040 (org-indent-line-function))
14041 (insert ":" property ":")
14042 (and value (insert " " value))
14043 (org-indent-line-function)))))
14044 (run-hook-with-args 'org-property-changed-functions property value)))
14046 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14047 "Get all property keys in the current buffer.
14048 With INCLUDE-SPECIALS, also list the special properties that reflect things
14049 like tags and TODO state.
14050 With INCLUDE-DEFAULTS, also include properties that has special meaning
14051 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14052 and others.
14053 With INCLUDE-COLUMNS, also include property names given in COLUMN
14054 formats in the current buffer."
14055 (let (rtn range cfmt s p)
14056 (save-excursion
14057 (save-restriction
14058 (widen)
14059 (goto-char (point-min))
14060 (while (re-search-forward org-property-start-re nil t)
14061 (setq range (org-get-property-block))
14062 (goto-char (car range))
14063 (while (re-search-forward
14065 (cdr range) t)
14066 (add-to-list 'rtn (org-match-string-no-properties 1)))
14067 (outline-next-heading))))
14069 (when include-specials
14070 (setq rtn (append org-special-properties rtn)))
14072 (when include-defaults
14073 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14074 (add-to-list 'rtn org-effort-property))
14076 (when include-columns
14077 (save-excursion
14078 (save-restriction
14079 (widen)
14080 (goto-char (point-min))
14081 (while (re-search-forward
14083 nil t)
14084 (setq cfmt (match-string 2) s 0)
14086 cfmt s)
14087 (setq s (match-end 0)
14088 p (match-string 1 cfmt))
14089 (unless (or (equal p "ITEM")
14090 (member p org-special-properties))
14091 (add-to-list 'rtn (match-string 1 cfmt))))))))
14093 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14095 (defun org-property-values (key)
14096 "Return a list of all values of property KEY in the current buffer."
14097 (save-excursion
14098 (save-restriction
14099 (widen)
14100 (goto-char (point-min))
14101 (let ((re (org-re-property key))
14102 values)
14103 (while (re-search-forward re nil t)
14104 (add-to-list 'values (org-trim (match-string 1))))
14105 (delete "" values)))))
14107 (defun org-insert-property-drawer ()
14108 "Insert a property drawer into the current entry."
14109 (interactive)
14110 (org-back-to-heading t)
14111 (looking-at org-outline-regexp)
14112 (let ((indent (if org-adapt-indentation
14113 (- (match-end 0)(match-beginning 0))
14114 0))
14115 (beg (point))
14117 end hiddenp)
14118 (outline-next-heading)
14119 (setq end (point))
14120 (goto-char beg)
14121 (while (re-search-forward re end t))
14122 (setq hiddenp (outline-invisible-p))
14123 (end-of-line 1)
14126 (if (member (match-string 1) '("CLOCK:" ":END:"))
14127 ;; just skip this line
14128 (beginning-of-line 2)
14129 ;; Drawer start, find the end
14131 (beginning-of-line 1)))
14132 (org-skip-over-state-notes)
14134 (if (eq (char-before) ?*) (forward-char 1))
14136 (beginning-of-line 0)
14137 (org-indent-to-column indent)
14138 (beginning-of-line 2)
14139 (org-indent-to-column indent)
14140 (beginning-of-line 0)
14141 (if hiddenp
14142 (save-excursion
14143 (org-back-to-heading t)
14144 (hide-entry))
14145 (org-flag-drawer t))))
14147 (defvar org-property-set-functions-alist nil
14148 "Property set function alist.
14149 Each entry should have the following format:
14151 (PROPERTY . READ-FUNCTION)
14153 The read function will be called with the same argument as
14154 `org-completing-read'.")
14156 (defun org-set-property-function (property)
14157 "Get the function that should be used to set PROPERTY.
14158 This is computed according to `org-property-set-functions-alist'."
14159 (or (cdr (assoc property org-property-set-functions-alist))
14160 'org-completing-read))
14162 (defun org-read-property-value (property)
14163 "Read PROPERTY value from user."
14164 (let* ((completion-ignore-case t)
14165 (allowed (org-property-get-allowed-values nil property 'table))
14166 (cur (org-entry-get nil property))
14167 (prompt (concat property " value"
14169 (concat " [" cur "]") "") ": "))
14170 (set-function (org-set-property-function property))
14171 (val (if allowed
14172 (funcall set-function prompt allowed nil
14173 (not (get-text-property 0 'org-unrestricted
14174 (caar allowed))))
14175 (let (org-completion-use-ido org-completion-use-iswitchb)
14176 (funcall set-function prompt
14177 (mapcar 'list (org-property-values property))
14178 nil nil "" nil cur)))))
14179 (if (equal val "")
14180 cur
14181 val)))
14183 (defvar org-last-set-property nil)
14184 (defun org-read-property-name ()
14185 "Read a property name."
14186 (let* ((completion-ignore-case t)
14187 (keys (org-buffer-property-keys nil t t))
14188 (default-prop (or (save-excursion
14189 (save-match-data
14190 (beginning-of-line)
14192 (null (string= (match-string 1) "END"))
14193 (match-string 1))))
14194 org-last-set-property))
14195 (property (org-icompleting-read
14196 (concat "Property"
14197 (if default-prop (concat " [" default-prop "]") "")
14198 ": ")
14199 (mapcar 'list keys)
14200 nil nil nil nil
14201 default-prop
14202 )))
14203 (if (member property keys)
14204 property
14205 (or (cdr (assoc (downcase property)
14206 (mapcar (lambda (x) (cons (downcase x) x))
14207 keys)))
14208 property))))
14210 (defun org-set-property (property value)
14211 "In the current entry, set PROPERTY to VALUE.
14212 When called interactively, this will prompt for a property name, offering
14213 completion on existing and default properties. And then it will prompt
14214 for a value, offering completion either on allowed values (via an inherited
14215 xxx_ALL property) or on existing values in other instances of this property
14216 in the current file."
14217 (interactive (list nil nil))
14218 (let* ((property (or property (org-read-property-name)))
14219 (value (or value (org-read-property-value property))))
14220 (setq org-last-set-property property)
14221 (unless (equal (org-entry-get nil property) value)
14222 (org-entry-put nil property value))))
14224 (defun org-delete-property (property)
14225 "In the current entry, delete PROPERTY."
14226 (interactive
14227 (let* ((completion-ignore-case t)
14228 (prop (org-icompleting-read "Property: "
14229 (org-entry-properties nil 'standard))))
14230 (list prop)))
14231 (message "Property %s %s" property
14232 (if (org-entry-delete nil property)
14233 "deleted"
14234 "was not present in the entry")))
14236 (defun org-delete-property-globally (property)
14237 "Remove PROPERTY globally, from all entries."
14238 (interactive
14239 (let* ((completion-ignore-case t)
14240 (prop (org-icompleting-read
14241 "Globally remove property: "
14242 (mapcar 'list (org-buffer-property-keys)))))
14243 (list prop)))
14244 (save-excursion
14245 (save-restriction
14246 (widen)
14247 (goto-char (point-min))
14248 (let ((cnt 0))
14249 (while (re-search-forward
14250 (org-re-property property)
14251 nil t)
14252 (setq cnt (1+ cnt))
14253 (replace-match ""))
14256 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14258 (defun org-compute-property-at-point ()
14259 "Compute the property at point.
14260 This looks for an enclosing column format, extracts the operator and
14261 then applies it to the property in the column format's scope."
14262 (interactive)
14263 (unless (org-at-property-p)
14264 (error "Not at a property"))
14265 (let ((prop (org-match-string-no-properties 2)))
14266 (org-columns-get-format-and-top-level)
14267 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14268 (error "No operator defined for property %s" prop))
14269 (org-columns-compute prop)))
14271 (defvar org-property-allowed-value-functions nil
14272 "Hook for functions supplying allowed values for a specific property.
14273 The functions must take a single argument, the name of the property, and
14275 the values, this means that these values are intended as defaults for
14276 completion, but that other values should be allowed too.
14277 The functions must return nil if they are not responsible for this
14278 property.")
14280 (defun org-property-get-allowed-values (pom property &optional table)
14281 "Get allowed values for the property PROPERTY.
14282 When TABLE is non-nil, return an alist that can directly be used for
14283 completion."
14284 (let (vals)
14285 (cond
14286 ((equal property "TODO")
14287 (setq vals (org-with-point-at pom
14288 (append org-todo-keywords-1 '("")))))
14289 ((equal property "PRIORITY")
14290 (let ((n org-lowest-priority))
14291 (while (>= n org-highest-priority)
14292 (push (char-to-string n) vals)
14293 (setq n (1- n)))))
14294 ((member property org-special-properties))
14295 ((setq vals (run-hook-with-args-until-success
14296 'org-property-allowed-value-functions property)))
14297 (t
14298 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14300 (setq vals (car (read-from-string (concat "(" vals ")"))))
14301 (setq vals (mapcar (lambda (x)
14302 (cond ((stringp x) x)
14303 ((numberp x) (number-to-string x))
14304 ((symbolp x) (symbol-name x))
14305 (t "???")))
14306 vals)))))
14307 (when (member ":ETC" vals)
14308 (setq vals (remove ":ETC" vals))
14309 (org-add-props (car vals) '(org-unrestricted t)))
14310 (if table (mapcar 'list vals) vals)))
14312 (defun org-property-previous-allowed-value (&optional previous)
14313 "Switch to the next allowed value for this property."
14314 (interactive)
14315 (org-property-next-allowed-value t))
14317 (defun org-property-next-allowed-value (&optional previous)
14318 "Switch to the next allowed value for this property."
14319 (interactive)
14320 (unless (org-at-property-p)
14321 (error "Not at a property"))
14322 (let* ((key (match-string 2))
14323 (value (match-string 3))
14324 (allowed (or (org-property-get-allowed-values (point) key)
14325 (and (member value '("[ ]" "[-]" "[X]"))
14326 '("[ ]" "[X]"))))
14327 nval)
14328 (unless allowed
14329 (error "Allowed values for this property have not been defined"))
14330 (if previous (setq allowed (reverse allowed)))
14331 (if (member value allowed)
14332 (setq nval (car (cdr (member value allowed)))))
14333 (setq nval (or nval (car allowed)))
14334 (if (equal nval value)
14335 (error "Only one allowed value for this property"))
14336 (org-at-property-p)
14337 (replace-match (concat " :" key ": " nval) t t)
14338 (org-indent-line-function)
14339 (beginning-of-line 1)
14341 (run-hook-with-args 'org-property-changed-functions key nval)))
14343 (defun org-find-olp (path &optional this-buffer)
14344 "Return a marker pointing to the entry at outline path OLP.
14345 If anything goes wrong, throw an error.
14346 You can wrap this call to catch the error like this:
14348 (condition-case msg
14349 (org-mobile-locate-entry (match-string 4))
14350 (error (nth 1 msg)))
14352 The return value will then be either a string with the error message,
14353 or a marker if everything is OK.
14355 If THIS-BUFFER is set, the outline path does not contain a file,
14356 only headings."
14357 (let* ((file (if this-buffer buffer-file-name (pop path)))
14358 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14359 (level 1)
14360 (lmin 1)
14361 (lmax 1)
14362 limit re end found pos heading cnt flevel)
14363 (unless buffer (error "File not found :%s" file))
14364 (with-current-buffer buffer
14365 (save-excursion
14366 (save-restriction
14367 (widen)
14368 (setq limit (point-max))
14369 (goto-char (point-min))
14370 (while (setq heading (pop path))
14371 (setq re (format org-complex-heading-regexp-format
14372 (regexp-quote heading)))
14373 (setq cnt 0 pos (point))
14374 (while (re-search-forward re end t)
14375 (setq level (- (match-end 1) (match-beginning 1)))
14376 (if (and (>= level lmin) (<= level lmax))
14377 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14378 (when (= cnt 0) (error "Heading not found on level %d: %s"
14379 lmax heading))
14380 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14381 lmax heading))
14382 (goto-char found)
14383 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14384 (setq end (save-excursion (org-end-of-subtree t t))))
14385 (when (org-on-heading-p)
14386 (move-marker (make-marker) (point))))))))
14388 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14389 "Find node HEADING in BUFFER.
14390 Return a marker to the heading if it was found, or nil if not.
14391 If POS-ONLY is set, return just the position instead of a marker.
14393 The heading text must match exact, but it may have a TODO keyword,
14394 a priority cookie and tags in the standard locations."
14395 (with-current-buffer (or buffer (current-buffer))
14396 (save-excursion
14397 (save-restriction
14398 (widen)
14399 (goto-char (point-min))
14400 (let (case-fold-search)
14401 (if (re-search-forward
14402 (format org-complex-heading-regexp-format
14403 (regexp-quote heading)) nil t)
14404 (if pos-only
14405 (match-beginning 0)
14406 (move-marker (make-marker) (match-beginning 0)))))))))
14408 (defun org-find-exact-heading-in-directory (heading &optional dir)
14409 "Find Org node headline HEADING in all .org files in directory DIR.
14410 When the target headline is found, return a marker to this location."
14411 (let ((files (directory-files (or dir default-directory)
14413 file visiting m buffer)
14414 (catch 'found
14415 (while (setq file (pop files))
14416 (message "trying %s" file)
14417 (setq visiting (org-find-base-buffer-visiting file))
14418 (setq buffer (or visiting (find-file-noselect file)))
14419 (setq m (org-find-exact-headline-in-buffer
14420 heading buffer))
14421 (when (and (not m) (not visiting)) (kill-buffer buffer))
14422 (and m (throw 'found m))))))
14424 (defun org-find-entry-with-id (ident)
14425 "Locate the entry that contains the ID property with exact value IDENT.
14426 IDENT can be a string, a symbol or a number, this function will search for
14427 the string representation of it.
14428 Return the position where this entry starts, or nil if there is no such entry."
14429 (interactive "sID: ")
14430 (let ((id (cond
14431 ((stringp ident) ident)
14432 ((symbol-name ident) (symbol-name ident))
14433 ((numberp ident) (number-to-string ident))
14434 (t (error "IDENT %s must be a string, symbol or number" ident))))
14435 (case-fold-search nil))
14436 (save-excursion
14437 (save-restriction
14438 (widen)
14439 (goto-char (point-min))
14440 (when (re-search-forward
14442 nil t)
14443 (org-back-to-heading t)
14444 (point))))))
14446 ;;;; Timestamps
14448 (defvar org-last-changed-timestamp nil)
14449 (defvar org-last-inserted-timestamp nil
14450 "The last time stamp inserted with `org-insert-time-stamp'.")
14451 (defvar org-time-was-given) ; dynamically scoped parameter
14452 (defvar org-end-time-was-given) ; dynamically scoped parameter
14453 (defvar org-ts-what) ; dynamically scoped parameter
14455 (defun org-time-stamp (arg &optional inactive)
14456 "Prompt for a date/time and insert a time stamp.
14457 If the user specifies a time like HH:MM, or if this command is called
14458 with a prefix argument, the time stamp will contain date and time.
14459 Otherwise, only the date will be included. All parts of a date not
14460 specified by the user will be filled in from the current date/time.
14461 So if you press just return without typing anything, the time stamp
14462 will represent the current date/time. If there is already a timestamp
14463 at the cursor, it will be modified."
14464 (interactive "P")
14465 (let* ((ts nil)
14466 (default-time
14467 ;; Default time is either today, or, when entering a range,
14468 ;; the range start.
14469 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14470 (save-excursion
14471 (re-search-backward
14473 (- (point) 20) t)))
14474 (apply 'encode-time (org-parse-time-string (match-string 1)))
14475 (current-time)))
14476 (default-input (and ts (org-get-compact-tod ts)))
14477 (repeater (save-excursion
14478 (save-match-data
14479 (beginning-of-line)
14480 (when (re-search-forward
14482 (save-excursion (progn (end-of-line) (point))) t)
14483 (match-string 0)))))
14484 org-time-was-given org-end-time-was-given time)
14485 (cond
14486 ((and (org-at-timestamp-p t)
14487 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14488 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14489 (insert "--")
14490 (setq time (let ((this-command this-command))
14491 (org-read-date arg 'totime nil nil
14492 default-time default-input)))
14493 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14494 ((org-at-timestamp-p t)
14495 (setq time (let ((this-command this-command))
14496 (org-read-date arg 'totime nil nil default-time default-input)))
14497 (when (org-at-timestamp-p t) ; just to get the match data
14498 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14499 (replace-match "")
14500 (setq org-last-changed-timestamp
14501 (org-insert-time-stamp
14502 time (or org-time-was-given arg)
14503 inactive nil nil (list org-end-time-was-given)))
14504 (when repeater (goto-char (1- (point))) (insert " " repeater)
14505 (setq org-last-changed-timestamp
14506 (concat (substring org-last-inserted-timestamp 0 -1)
14507 " " repeater ">"))))
14508 (message "Timestamp updated"))
14509 (t
14510 (setq time (let ((this-command this-command))
14511 (org-read-date arg 'totime nil nil default-time default-input)))
14512 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14513 nil nil (list org-end-time-was-given))))))
14515 ;; FIXME: can we use this for something else, like computing time differences?
14516 (defun org-get-compact-tod (s)
14517 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14518 (let* ((t1 (match-string 1 s))
14519 (h1 (string-to-number (match-string 2 s)))
14520 (m1 (string-to-number (match-string 3 s)))
14521 (t2 (and (match-end 4) (match-string 5 s)))
14522 (h2 (and t2 (string-to-number (match-string 6 s))))
14523 (m2 (and t2 (string-to-number (match-string 7 s))))
14524 dh dm)
14525 (if (not t2)
14526 t1
14527 (setq dh (- h2 h1) dm (- m2 m1))
14528 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14529 (concat t1 "+" (number-to-string dh)
14530 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14532 (defun org-time-stamp-inactive (&optional arg)
14533 "Insert an inactive time stamp.
14534 An inactive time stamp is enclosed in square brackets instead of angle
14535 brackets. It is inactive in the sense that it does not trigger agenda entries,
14536 does not link to the calendar and cannot be changed with the S-cursor keys.
14537 So these are more for recording a certain time/date."
14538 (interactive "P")
14539 (org-time-stamp arg 'inactive))
14541 (defvar org-date-ovl (make-overlay 1 1))
14542 (overlay-put org-date-ovl 'face 'org-warning)
14543 (org-detach-overlay org-date-ovl)
14545 (defvar org-ans1) ; dynamically scoped parameter
14546 (defvar org-ans2) ; dynamically scoped parameter
14548 (defvar org-plain-time-of-day-regexp) ; defined below
14550 (defvar org-overriding-default-time nil) ; dynamically scoped
14551 (defvar org-read-date-overlay nil)
14552 (defvar org-dcst nil) ; dynamically scoped
14553 (defvar org-read-date-history nil)
14554 (defvar org-read-date-final-answer nil)
14555 (defvar org-read-date-analyze-futurep nil)
14556 (defvar org-read-date-analyze-forced-year nil)
14558 (defun org-read-date (&optional with-time to-time from-string prompt
14559 default-time default-input)
14560 "Read a date, possibly a time, and make things smooth for the user.
14561 The prompt will suggest to enter an ISO date, but you can also enter anything
14562 which will at least partially be understood by `parse-time-string'.
14563 Unrecognized parts of the date will default to the current day, month, year,
14564 hour and minute. If this command is called to replace a timestamp at point,
14565 of to enter the second timestamp of a range, the default time is taken
14566 from the existing stamp. Furthermore, the command prefers the future,
14567 so if you are giving a date where the year is not given, and the day-month
14568 combination is already past in the current year, it will assume you
14569 mean next year. For details, see the manual. A few examples:
14571 3-2-5 --> 2003-02-05
14572 feb 15 --> currentyear-02-15
14573 2/15 --> currentyear-02-15
14574 sep 12 9 --> 2009-09-12
14575 12:45 --> today 12:45
14576 22 sept 0:34 --> currentyear-09-22 0:34
14577 12 --> currentyear-currentmonth-12
14578 Fri --> nearest Friday (today or later)
14579 etc.
14581 Furthermore you can specify a relative date by giving, as the *first* thing
14582 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14583 change in days weeks, months, years.
14584 With a single plus or minus, the date is relative to today. With a double
14585 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14586 +4d --> four days from today
14587 +4 --> same as above
14588 +2w --> two weeks from today
14589 ++5 --> five days from default date
14591 The function understands only English month and weekday abbreviations,
14592 but this can be configured with the variables `parse-time-months' and
14593 `parse-time-weekdays'.
14595 While prompting, a calendar is popped up - you can also select the
14596 date with the mouse (button 1). The calendar shows a period of three
14597 months. To scroll it to other months, use the keys `>' and `<'.
14598 If you don't like the calendar, turn it off with
14599 \(setq org-read-date-popup-calendar nil)
14601 With optional argument TO-TIME, the date will immediately be converted
14602 to an internal time.
14603 With an optional argument WITH-TIME, the prompt will suggest to also
14604 insert a time. Note that when WITH-TIME is not set, you can still
14605 enter a time, and this function will inform the calling routine about
14606 this change. The calling routine may then choose to change the format
14607 used to insert the time stamp into the buffer to include the time.
14608 With optional argument FROM-STRING, read from this string instead from
14609 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14610 the time/date that is used for everything that is not specified by the
14611 user."
14612 (require 'parse-time)
14613 (let* ((org-time-stamp-rounding-minutes
14614 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14615 (org-dcst org-display-custom-times)
14616 (ct (org-current-time))
14617 (def (or org-overriding-default-time default-time ct))
14618 (defdecode (decode-time def))
14619 (dummy (progn
14620 (when (< (nth 2 defdecode) org-extend-today-until)
14621 (setcar (nthcdr 2 defdecode) -1)
14622 (setcar (nthcdr 1 defdecode) 59)
14623 (setq def (apply 'encode-time defdecode)
14624 defdecode (decode-time def)))))
14625 (calendar-frame-setup nil)
14626 (calendar-setup nil)
14627 (calendar-move-hook nil)
14628 (calendar-view-diary-initially-flag nil)
14629 (calendar-view-holidays-initially-flag nil)
14630 (timestr (format-time-string
14631 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14632 (prompt (concat (if prompt (concat prompt " ") "")
14633 (format "Date+time [%s]: " timestr)))
14634 ans (org-ans0 "") org-ans1 org-ans2 final)
14636 (cond
14637 (from-string (setq ans from-string))
14638 (org-read-date-popup-calendar
14639 (save-excursion
14640 (save-window-excursion
14641 (calendar)
14642 (unwind-protect
14643 (progn
14644 (calendar-forward-day (- (time-to-days def)
14645 (calendar-absolute-from-gregorian
14646 (calendar-current-date))))
14647 (org-eval-in-calendar nil t)
14648 (let* ((old-map (current-local-map))
14649 (map (copy-keymap calendar-mode-map))
14650 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14651 (org-defkey map (kbd "RET") 'org-calendar-select)
14652 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14653 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14654 (org-defkey minibuffer-local-map [(meta shift left)]
14655 (lambda () (interactive)
14656 (org-eval-in-calendar '(calendar-backward-month 1))))
14657 (org-defkey minibuffer-local-map [(meta shift right)]
14658 (lambda () (interactive)
14659 (org-eval-in-calendar '(calendar-forward-month 1))))
14660 (org-defkey minibuffer-local-map [(meta shift up)]
14661 (lambda () (interactive)
14662 (org-eval-in-calendar '(calendar-backward-year 1))))
14663 (org-defkey minibuffer-local-map [(meta shift down)]
14664 (lambda () (interactive)
14665 (org-eval-in-calendar '(calendar-forward-year 1))))
14666 (org-defkey minibuffer-local-map [?\e (shift left)]
14667 (lambda () (interactive)
14668 (org-eval-in-calendar '(calendar-backward-month 1))))
14669 (org-defkey minibuffer-local-map [?\e (shift right)]
14670 (lambda () (interactive)
14671 (org-eval-in-calendar '(calendar-forward-month 1))))
14672 (org-defkey minibuffer-local-map [?\e (shift up)]
14673 (lambda () (interactive)
14674 (org-eval-in-calendar '(calendar-backward-year 1))))
14675 (org-defkey minibuffer-local-map [?\e (shift down)]
14676 (lambda () (interactive)
14677 (org-eval-in-calendar '(calendar-forward-year 1))))
14678 (org-defkey minibuffer-local-map [(shift up)]
14679 (lambda () (interactive)
14680 (org-eval-in-calendar '(calendar-backward-week 1))))
14681 (org-defkey minibuffer-local-map [(shift down)]
14682 (lambda () (interactive)
14683 (org-eval-in-calendar '(calendar-forward-week 1))))
14684 (org-defkey minibuffer-local-map [(shift left)]
14685 (lambda () (interactive)
14686 (org-eval-in-calendar '(calendar-backward-day 1))))
14687 (org-defkey minibuffer-local-map [(shift right)]
14688 (lambda () (interactive)
14689 (org-eval-in-calendar '(calendar-forward-day 1))))
14690 (org-defkey minibuffer-local-map ">"
14691 (lambda () (interactive)
14692 (org-eval-in-calendar '(scroll-calendar-left 1))))
14693 (org-defkey minibuffer-local-map "<"
14694 (lambda () (interactive)
14695 (org-eval-in-calendar '(scroll-calendar-right 1))))
14696 (org-defkey minibuffer-local-map "\C-v"
14697 (lambda () (interactive)
14698 (org-eval-in-calendar
14699 '(calendar-scroll-left-three-months 1))))
14700 (org-defkey minibuffer-local-map "\M-v"
14701 (lambda () (interactive)
14702 (org-eval-in-calendar
14703 '(calendar-scroll-right-three-months 1))))
14704 (run-hooks 'org-read-date-minibuffer-setup-hook)
14705 (unwind-protect
14706 (progn
14707 (use-local-map map)
14708 (add-hook 'post-command-hook 'org-read-date-display)
14709 (setq org-ans0 (read-string prompt default-input
14710 'org-read-date-history nil))
14711 ;; org-ans0: from prompt
14712 ;; org-ans1: from mouse click
14713 ;; org-ans2: from calendar motion
14714 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14715 (remove-hook 'post-command-hook 'org-read-date-display)
14716 (use-local-map old-map)
14717 (when org-read-date-overlay
14718 (delete-overlay org-read-date-overlay)
14719 (setq org-read-date-overlay nil)))))
14720 (bury-buffer "*Calendar*")))))
14722 (t ; Naked prompt only
14723 (unwind-protect
14724 (setq ans (read-string prompt default-input
14725 'org-read-date-history timestr))
14726 (when org-read-date-overlay
14727 (delete-overlay org-read-date-overlay)
14728 (setq org-read-date-overlay nil)))))
14730 (setq final (org-read-date-analyze ans def defdecode))
14732 (when org-read-date-analyze-forced-year
14733 (message "Year was forced into %s"
14734 (if org-read-date-force-compatible-dates
14735 "compatible range (1970-2037)"
14736 "range representable on this machine"))
14737 (ding))
14739 ;; One round trip to get rid of 34th of August and stuff like that....
14740 (setq final (decode-time (apply 'encode-time final)))
14742 (setq org-read-date-final-answer ans)
14744 (if to-time
14745 (apply 'encode-time final)
14746 (if (and (boundp 'org-time-was-given) org-time-was-given)
14747 (format "%04d-%02d-%02d %02d:%02d"
14748 (nth 5 final) (nth 4 final) (nth 3 final)
14749 (nth 2 final) (nth 1 final))
14750 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14752 (defvar def)
14753 (defvar defdecode)
14754 (defvar with-time)
14755 (defun org-read-date-display ()
14756 "Display the current date prompt interpretation in the minibuffer."
14757 (when org-read-date-display-live
14758 (when org-read-date-overlay
14759 (delete-overlay org-read-date-overlay))
14760 (let ((p (point)))
14761 (end-of-line 1)
14762 (while (not (equal (buffer-substring
14763 (max (point-min) (- (point) 4)) (point))
14764 " "))
14765 (insert " "))
14766 (goto-char p))
14767 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14768 " " (or org-ans1 org-ans2)))
14769 (org-end-time-was-given nil)
14770 (f (org-read-date-analyze ans def defdecode))
14771 (fmts (if org-dcst
14772 org-time-stamp-custom-formats
14773 org-time-stamp-formats))
14774 (fmt (if (or with-time
14775 (and (boundp 'org-time-was-given) org-time-was-given))
14776 (cdr fmts)
14777 (car fmts)))
14778 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14779 (when (and org-end-time-was-given
14780 (string-match org-plain-time-of-day-regexp txt))
14781 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14782 org-end-time-was-given
14783 (substring txt (match-end 0)))))
14784 (when org-read-date-analyze-futurep
14785 (setq txt (concat txt " (=>F)")))
14786 (setq org-read-date-overlay
14787 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14788 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14790 (defun org-read-date-analyze (ans def defdecode)
14791 "Analyze the combined answer of the date prompt."
14792 ;; FIXME: cleanup and comment
14793 (let ((nowdecode (decode-time (current-time)))
14794 delta deltan deltaw deltadef year month day
14795 hour minute second wday pm h2 m2 tl wday1
14796 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14797 (setq org-read-date-analyze-futurep nil
14798 org-read-date-analyze-forced-year nil)
14800 (setq ans "+0"))
14802 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14803 (setq ans (replace-match "" t t ans)
14804 deltan (car delta)
14805 deltaw (nth 1 delta)
14806 deltadef (nth 2 delta)))
14808 ;; Check if there is an iso week date in there
14809 ;; If yes, store the info and postpone interpreting it until the rest
14810 ;; of the parsing is done
14811 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14812 (setq iso-year (if (match-end 1)
14813 (org-small-year-to-year
14814 (string-to-number (match-string 1 ans))))
14815 iso-weekday (if (match-end 3)
14816 (string-to-number (match-string 3 ans)))
14817 iso-week (string-to-number (match-string 2 ans)))
14818 (setq ans (replace-match "" t t ans)))
14820 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14821 (when (string-match
14823 (setq year (if (match-end 2)
14824 (string-to-number (match-string 2 ans))
14825 (progn (setq kill-year t)
14826 (string-to-number (format-time-string "%Y"))))
14827 month (string-to-number (match-string 3 ans))
14828 day (string-to-number (match-string 4 ans)))
14829 (if (< year 100) (setq year (+ 2000 year)))
14831 t nil ans)))
14833 ;; Help matching dottet european dates
14834 (when (string-match
14835 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14836 (setq year (if (match-end 3)
14837 (string-to-number (match-string 3 ans))
14838 (progn (setq kill-year t)
14839 (string-to-number (format-time-string "%Y"))))
14840 day (string-to-number (match-string 1 ans))
14841 month (string-to-number (match-string 2 ans))
14843 t nil ans)))
14845 ;; Help matching american dates, like 5/30 or 5/30/7
14846 (when (string-match
14847 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14848 (setq year (if (match-end 4)
14849 (string-to-number (match-string 4 ans))
14850 (progn (setq kill-year t)
14851 (string-to-number (format-time-string "%Y"))))
14852 month (string-to-number (match-string 1 ans))
14853 day (string-to-number (match-string 2 ans)))
14854 (if (< year 100) (setq year (+ 2000 year)))
14856 t nil ans)))
14857 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14858 ;; If there is a time with am/pm, and *no* time without it, we convert
14859 ;; so that matching will be successful.
14860 (loop for i from 1 to 2 do ; twice, for end time as well
14863 (setq hour (string-to-number (match-string 1 ans))
14864 minute (if (match-end 3)
14865 (string-to-number (match-string 3 ans))
14866 0)
14867 pm (equal ?p
14868 (string-to-char (downcase (match-string 4 ans)))))
14869 (if (and (= hour 12) (not pm))
14870 (setq hour 0)
14871 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14872 (setq ans (replace-match (format "%02d:%02d" hour minute)
14873 t t ans))))
14875 ;; Check if a time range is given as a duration
14876 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14877 (setq hour (string-to-number (match-string 1 ans))
14878 h2 (+ hour (string-to-number (match-string 3 ans)))
14879 minute (string-to-number (match-string 2 ans))
14880 m2 (+ minute (if (match-end 5) (string-to-number
14881 (match-string 5 ans))0)))
14882 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14883 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14884 t t ans)))
14886 ;; Check if there is a time range
14887 (when (boundp 'org-end-time-was-given)
14888 (setq org-time-was-given nil)
14889 (when (and (string-match org-plain-time-of-day-regexp ans)
14890 (match-end 8))
14891 (setq org-end-time-was-given (match-string 8 ans))
14892 (setq ans (concat (substring ans 0 (match-beginning 7))
14893 (substring ans (match-end 7))))))
14895 (setq tl (parse-time-string ans)
14896 day (or (nth 3 tl) (nth 3 defdecode))
14897 month (or (nth 4 tl)
14898 (if (and org-read-date-prefer-future
14899 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14900 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14901 (nth 4 defdecode)))
14902 year (or (and (not kill-year) (nth 5 tl))
14903 (if (and org-read-date-prefer-future
14904 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14905 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14906 (nth 5 defdecode)))
14907 hour (or (nth 2 tl) (nth 2 defdecode))
14908 minute (or (nth 1 tl) (nth 1 defdecode))
14909 second (or (nth 0 tl) 0)
14910 wday (nth 6 tl))
14912 (when (and (eq org-read-date-prefer-future 'time)
14913 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14914 (equal day (nth 3 nowdecode))
14915 (equal month (nth 4 nowdecode))
14916 (equal year (nth 5 nowdecode))
14917 (nth 2 tl)
14918 (or (< (nth 2 tl) (nth 2 nowdecode))
14919 (and (= (nth 2 tl) (nth 2 nowdecode))
14920 (nth 1 tl)
14921 (< (nth 1 tl) (nth 1 nowdecode)))))
14922 (setq day (1+ day)
14923 futurep t))
14925 ;; Special date definitions below
14926 (cond
14927 (iso-week
14928 ;; There was an iso week
14929 (require 'cal-iso)
14930 (setq futurep nil)
14931 (setq year (or iso-year year)
14932 day (or iso-weekday wday 1)
14933 wday nil ; to make sure that the trigger below does not match
14934 iso-date (calendar-gregorian-from-absolute
14935 (calendar-absolute-from-iso
14936 (list iso-week day year))))
14937 ; FIXME: Should we also push ISO weeks into the future?
14938 ; (when (and org-read-date-prefer-future
14939 ; (not iso-year)
14940 ; (< (calendar-absolute-from-gregorian iso-date)
14941 ; (time-to-days (current-time))))
14942 ; (setq year (1+ year)
14943 ; iso-date (calendar-gregorian-from-absolute
14944 ; (calendar-absolute-from-iso
14945 ; (list iso-week day year)))))
14946 (setq month (car iso-date)
14947 year (nth 2 iso-date)
14948 day (nth 1 iso-date)))
14949 (deltan
14950 (setq futurep nil)
14951 (unless deltadef
14952 (let ((now (decode-time (current-time))))
14953 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14954 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14955 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14956 ((equal deltaw "m") (setq month (+ month deltan)))
14957 ((equal deltaw "y") (setq year (+ year deltan)))))
14958 ((and wday (not (nth 3 tl)))
14959 (setq futurep nil)
14960 ;; Weekday was given, but no day, so pick that day in the week
14961 ;; on or after the derived date.
14962 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14963 (unless (equal wday wday1)
14964 (setq day (+ day (% (- wday wday1 -7) 7))))))
14965 (if (and (boundp 'org-time-was-given)
14966 (nth 2 tl))
14967 (setq org-time-was-given t))
14968 (if (< year 100) (setq year (+ 2000 year)))
14969 ;; Check of the date is representable
14970 (if org-read-date-force-compatible-dates
14971 (progn
14972 (if (< year 1970)
14973 (setq year 1970 org-read-date-analyze-forced-year t))
14974 (if (> year 2037)
14975 (setq year 2037 org-read-date-analyze-forced-year t)))
14976 (condition-case nil
14977 (ignore (encode-time second minute hour day month year))
14978 (error
14979 (setq year (nth 5 defdecode))
14980 (setq org-read-date-analyze-forced-year t))))
14981 (setq org-read-date-analyze-futurep futurep)
14982 (list second minute hour day month year)))
14984 (defvar parse-time-weekdays)
14986 (defun org-read-date-get-relative (s today default)
14987 "Check string S for special relative date string.
14988 TODAY and DEFAULT are internal times, for today and for a default.
14989 Return shift list (N what def-flag)
14991 N is the number of WHATs to shift.
14992 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14993 the DEFAULT date rather than TODAY."
14994 (when (and
14995 (string-match
14996 (concat
15001 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15002 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15003 (string-to-char (substring (match-string 1 s) -1))
15004 ?+))
15005 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15006 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15007 (what (if (match-end 3) (match-string 3 s) "d"))
15008 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15009 (date (if rel default today))
15010 (wday (nth 6 (decode-time date)))
15011 delta)
15012 (if wday1
15013 (progn
15014 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15015 (if (= dir ?-) (setq delta (- delta 7)))
15016 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15017 (list delta "d" rel))
15018 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15020 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15021 "Turn a user-specified date into the internal representation.
15022 The internal representation needed by the calendar is (month day year).
15023 This is a wrapper to handle the brain-dead convention in calendar that
15024 user function argument order change dependent on argument order."
15025 (if (boundp 'calendar-date-style)
15026 (cond
15027 ((eq calendar-date-style 'american)
15028 (list arg1 arg2 arg3))
15029 ((eq calendar-date-style 'european)
15030 (list arg2 arg1 arg3))
15031 ((eq calendar-date-style 'iso)
15032 (list arg2 arg3 arg1)))
15033 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15034 (if (org-bound-and-true-p european-calendar-style)
15035 (list arg2 arg1 arg3)
15036 (list arg1 arg2 arg3)))))
15038 (defun org-eval-in-calendar (form &optional keepdate)
15039 "Eval FORM in the calendar window and return to current window.
15040 Also, store the cursor date in variable org-ans2."
15041 (let ((sf (selected-frame))
15042 (sw (selected-window)))
15043 (select-window (get-buffer-window "*Calendar*" t))
15044 (eval form)
15045 (when (and (not keepdate) (calendar-cursor-to-date))
15046 (let* ((date (calendar-cursor-to-date))
15047 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15048 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15049 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15050 (select-window sw)
15051 (org-select-frame-set-input-focus sf)))
15053 (defun org-calendar-select ()
15054 "Return to `org-read-date' with the date currently selected.
15055 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15056 (interactive)
15057 (when (calendar-cursor-to-date)
15058 (let* ((date (calendar-cursor-to-date))
15059 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15060 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15061 (if (active-minibuffer-window) (exit-minibuffer))))
15063 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15064 "Insert a date stamp for the date given by the internal TIME.
15065 WITH-HM means use the stamp format that includes the time of the day.
15066 INACTIVE means use square brackets instead of angular ones, so that the
15067 stamp will not contribute to the agenda.
15068 PRE and POST are optional strings to be inserted before and after the
15069 stamp.
15070 The command returns the inserted time stamp."
15071 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15072 stamp)
15073 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15074 (insert-before-markers (or pre ""))
15075 (when (listp extra)
15076 (setq extra (car extra))
15077 (if (and (stringp extra)
15079 (setq extra (format "-%02d:%02d"
15080 (string-to-number (match-string 1 extra))
15081 (string-to-number (match-string 2 extra))))
15082 (setq extra nil)))
15083 (when extra
15084 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15085 (insert-before-markers (setq stamp (format-time-string fmt time)))
15086 (insert-before-markers (or post ""))
15087 (setq org-last-inserted-timestamp stamp)))
15089 (defun org-toggle-time-stamp-overlays ()
15090 "Toggle the use of custom time stamp formats."
15091 (interactive)
15092 (setq org-display-custom-times (not org-display-custom-times))
15093 (unless org-display-custom-times
15094 (let ((p (point-min)) (bmp (buffer-modified-p)))
15095 (while (setq p (next-single-property-change p 'display))
15096 (if (and (get-text-property p 'display)
15097 (eq (get-text-property p 'face) 'org-date))
15098 (remove-text-properties
15099 p (setq p (next-single-property-change p 'display))
15100 '(display t))))
15101 (set-buffer-modified-p bmp)))
15102 (if (featurep 'xemacs)
15103 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15104 (org-restart-font-lock)
15105 (setq org-table-may-need-update t)
15106 (if org-display-custom-times
15107 (message "Time stamps are overlayed with custom format")
15108 (message "Time stamp overlays removed")))
15110 (defun org-display-custom-time (beg end)
15111 "Overlay modified time stamp format over timestamp between BEG and END."
15112 (let* ((ts (buffer-substring beg end))
15113 t1 w1 with-hm tf time str w2 (off 0))
15114 (save-match-data
15115 (setq t1 (org-parse-time-string ts t))
15116 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15117 (setq off (- (match-end 0) (match-beginning 0)))))
15118 (setq end (- end off))
15119 (setq w1 (- end beg)
15120 with-hm (and (nth 1 t1) (nth 2 t1))
15121 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15122 time (org-fix-decoded-time t1)
15123 str (org-add-props
15124 (format-time-string
15125 (substring tf 1 -1) (apply 'encode-time time))
15126 nil 'mouse-face 'highlight)
15127 w2 (length str))
15128 (if (not (= w2 w1))
15129 (add-text-properties (1+ beg) (+ 2 beg)
15130 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15131 (if (featurep 'xemacs)
15132 (progn
15133 (put-text-property beg end 'invisible t)
15134 (put-text-property beg end 'end-glyph (make-glyph str)))
15135 (put-text-property beg end 'display str))))
15137 (defun org-translate-time (string)
15138 "Translate all timestamps in STRING to custom format.
15139 But do this only if the variable `org-display-custom-times' is set."
15140 (when org-display-custom-times
15141 (save-match-data
15142 (let* ((start 0)
15143 (re org-ts-regexp-both)
15144 t1 with-hm inactive tf time str beg end)
15145 (while (setq start (string-match re string start))
15146 (setq beg (match-beginning 0)
15147 end (match-end 0)
15148 t1 (save-match-data
15149 (org-parse-time-string (substring string beg end) t))
15150 with-hm (and (nth 1 t1) (nth 2 t1))
15151 inactive (equal (substring string beg (1+ beg)) "[")
15152 tf (funcall (if with-hm 'cdr 'car)
15153 org-time-stamp-custom-formats)
15154 time (org-fix-decoded-time t1)
15155 str (format-time-string
15156 (concat
15157 (if inactive "[" "<") (substring tf 1 -1)
15158 (if inactive "]" ">"))
15159 (apply 'encode-time time))
15160 string (replace-match str t t string)
15161 start (+ start (length str)))))))
15162 string)
15164 (defun org-fix-decoded-time (time)
15165 "Set 0 instead of nil for the first 6 elements of time.
15166 Don't touch the rest."
15167 (let ((n 0))
15168 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15170 (defun org-days-to-time (timestamp-string)
15171 "Difference between TIMESTAMP-STRING and now in days."
15172 (- (time-to-days (org-time-string-to-time timestamp-string))
15173 (time-to-days (current-time))))
15175 (defun org-deadline-close (timestamp-string &optional ndays)
15176 "Is the time in TIMESTAMP-STRING close to the current date?"
15177 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15178 (and (< (org-days-to-time timestamp-string) ndays)
15179 (not (org-entry-is-done-p))))
15181 (defun org-get-wdays (ts)
15182 "Get the deadline lead time appropriate for timestring TS."
15183 (cond
15184 ((<= org-deadline-warning-days 0)
15185 ;; 0 or negative, enforce this value no matter what
15186 (- org-deadline-warning-days))
15188 ;; lead time is specified.
15189 (floor (* (string-to-number (match-string 1 ts))
15190 (cdr (assoc (match-string 2 ts)
15191 '(("d" . 1) ("w" . 7)
15192 ("m" . 30.4) ("y" . 365.25)))))))
15193 ;; go for the default.
15194 (t org-deadline-warning-days)))
15196 (defun org-calendar-select-mouse (ev)
15197 "Return to `org-read-date' with the date currently selected.
15198 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15199 (interactive "e")
15200 (mouse-set-point ev)
15201 (when (calendar-cursor-to-date)
15202 (let* ((date (calendar-cursor-to-date))
15203 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15204 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15205 (if (active-minibuffer-window) (exit-minibuffer))))
15207 (defun org-check-deadlines (ndays)
15208 "Check if there are any deadlines due or past due.
15209 A deadline is considered due if it happens within `org-deadline-warning-days'
15210 days from today's date. If the deadline appears in an entry marked DONE,
15211 it is not shown. The prefix arg NDAYS can be used to test that many
15213 (interactive "P")
15214 (let* ((org-warn-days
15215 (cond
15216 ((equal ndays '(4)) 100000)
15217 (ndays (prefix-numeric-value ndays))
15218 (t (abs org-deadline-warning-days))))
15219 (case-fold-search nil)
15221 (callback
15222 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15224 (message "%d deadlines past-due or due within %d days"
15225 (org-occur regexp nil callback)
15226 org-warn-days)))
15228 (defun org-check-before-date (date)
15229 "Check if there are deadlines or scheduled entries before DATE."
15230 (interactive (list (org-read-date)))
15231 (let ((case-fold-search nil)
15235 (callback
15236 (lambda () (time-less-p
15237 (org-time-string-to-time (match-string 2))
15238 (org-time-string-to-time date)))))
15239 (message "%d entries before %s"
15240 (org-occur regexp nil callback) date)))
15242 (defun org-check-after-date (date)
15243 "Check if there are deadlines or scheduled entries after DATE."
15244 (interactive (list (org-read-date)))
15245 (let ((case-fold-search nil)
15249 (callback
15250 (lambda () (not
15251 (time-less-p
15252 (org-time-string-to-time (match-string 2))
15253 (org-time-string-to-time date))))))
15254 (message "%d entries after %s"
15255 (org-occur regexp nil callback) date)))
15257 (defun org-evaluate-time-range (&optional to-buffer)
15258 "Evaluate a time range by computing the difference between start and end.
15259 Normally the result is just printed in the echo area, but with prefix arg
15260 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15261 If the time range is actually in a table, the result is inserted into the
15262 next column.
15263 For time difference computation, a year is assumed to be exactly 365
15264 days in order to avoid rounding problems."
15265 (interactive "P")
15266 (or
15267 (org-clock-update-time-maybe)
15268 (save-excursion
15269 (unless (org-at-date-range-p t)
15270 (goto-char (point-at-bol))
15271 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15272 (if (not (org-at-date-range-p t))
15273 (error "Not at a time-stamp range, and none found in current line")))
15274 (let* ((ts1 (match-string 1))
15275 (ts2 (match-string 2))
15276 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15277 (match-end (match-end 0))
15278 (time1 (org-time-string-to-time ts1))
15279 (time2 (org-time-string-to-time ts2))
15280 (t1 (org-float-time time1))
15281 (t2 (org-float-time time2))
15282 (diff (abs (- t2 t1)))
15283 (negative (< (- t2 t1) 0))
15284 ;; (ys (floor (* 365 24 60 60)))
15285 (ds (* 24 60 60))
15286 (hs (* 60 60))
15287 (fy "%dy %dd %02d:%02d")
15288 (fy1 "%dy %dd")
15289 (fd "%dd %02d:%02d")
15290 (fd1 "%dd")
15291 (fh "%02d:%02d")
15292 y d h m align)
15293 (if havetime
15294 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15295 y 0
15296 d (floor (/ diff ds)) diff (mod diff ds)
15297 h (floor (/ diff hs)) diff (mod diff hs)
15298 m (floor (/ diff 60)))
15299 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15300 y 0
15301 d (floor (+ (/ diff ds) 0.5))
15302 h 0 m 0))
15303 (if (not to-buffer)
15304 (message "%s" (org-make-tdiff-string y d h m))
15305 (if (org-at-table-p)
15306 (progn
15307 (goto-char match-end)
15308 (setq align t)
15309 (and (looking-at " *|") (goto-char (match-end 0))))
15310 (goto-char match-end))
15311 (if (looking-at
15313 (replace-match ""))
15314 (if negative (insert " -"))
15315 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15316 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15317 (insert " " (format fh h m))))
15318 (if align (org-table-align))
15319 (message "Time difference inserted")))))
15321 (defun org-make-tdiff-string (y d h m)
15322 (let ((fmt "")
15323 (l nil))
15324 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15325 l (push y l)))
15326 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15327 l (push d l)))
15328 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15329 l (push h l)))
15330 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15331 l (push m l)))
15332 (apply 'format fmt (nreverse l))))
15334 (defun org-time-string-to-time (s)
15335 (apply 'encode-time (org-parse-time-string s)))
15336 (defun org-time-string-to-seconds (s)
15337 (org-float-time (org-time-string-to-time s)))
15339 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15340 "Convert a time stamp to an absolute day number.
15341 If there is a specifier for a cyclic time stamp, get the closest date to
15342 DAYNR.
15343 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15344 The variable date is bound by the calendar when this is called."
15345 (cond
15347 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15348 daynr
15349 (+ daynr 1000)))
15351 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15352 (time-to-days (current-time))) (match-string 0 s)
15353 prefer show-all))
15354 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15356 (defun org-days-to-iso-week (days)
15357 "Return the iso week number."
15358 (require 'cal-iso)
15359 (car (calendar-iso-from-absolute days)))
15361 (defun org-small-year-to-year (year)
15362 "Convert 2-digit years into 4-digit years.
15363 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15364 The year 2000 cannot be abbreviated. Any year larger than 99
15365 is returned unchanged."
15366 (if (< year 38)
15367 (setq year (+ 2000 year))
15368 (if (< year 100)
15369 (setq year (+ 1900 year))))
15370 year)
15372 (defun org-time-from-absolute (d)
15373 "Return the time corresponding to date D.
15374 D may be an absolute day number, or a calendar-type list (month day year)."
15375 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15376 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15378 (defun org-calendar-holiday ()
15379 "List of holidays, for Diary display in Org-mode."
15380 (require 'holidays)
15381 (let ((hl (funcall
15382 (if (fboundp 'calendar-check-holidays)
15383 'calendar-check-holidays 'check-calendar-holidays) date)))
15384 (if hl (mapconcat 'identity hl "; "))))
15386 (defun org-diary-sexp-entry (sexp entry date)
15387 "Process a SEXP diary ENTRY for DATE."
15388 (require 'diary-lib)
15389 (let ((result (if calendar-debug-sexp
15390 (let ((stack-trace-on-error t))
15391 (eval (car (read-from-string sexp))))
15392 (condition-case nil
15393 (eval (car (read-from-string sexp)))
15394 (error
15395 (beep)
15396 (message "Bad sexp at line %d in %s: %s"
15397 (org-current-line)
15398 (buffer-file-name) sexp)
15399 (sleep-for 2))))))
15400 (cond ((stringp result) (split-string result "; "))
15401 ((and (consp result)
15402 (not (consp (cdr result)))
15403 (stringp (cdr result))) (cdr result))
15404 ((and (consp result)
15405 (stringp (car result))) result)
15406 (result entry)
15407 (t nil))))
15409 (defun org-diary-to-ical-string (frombuf)
15410 "Get iCalendar entries from diary entries in buffer FROMBUF.
15411 This uses the icalendar.el library."
15412 (let* ((tmpdir (if (featurep 'xemacs)
15413 (temp-directory)
15414 temporary-file-directory))
15415 (tmpfile (make-temp-name
15416 (expand-file-name "orgics" tmpdir)))
15417 buf rtn b e)
15418 (with-current-buffer frombuf
15419 (icalendar-export-region (point-min) (point-max) tmpfile)
15420 (setq buf (find-buffer-visiting tmpfile))
15421 (set-buffer buf)
15422 (goto-char (point-min))
15423 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15424 (setq b (match-beginning 0)))
15425 (goto-char (point-max))
15426 (if (re-search-backward "^END:VEVENT" nil t)
15427 (setq e (match-end 0)))
15429 (kill-buffer buf)
15430 (delete-file tmpfile)
15431 rtn))
15433 (defun org-closest-date (start current change prefer show-all)
15434 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15435 When PREFER is `past', return a date that is either CURRENT or past.
15436 When PREFER is `future', return a date that is either CURRENT or future.
15437 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15438 ;; Make the proper lists from the dates
15439 (catch 'exit
15440 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15441 dn dw sday cday n1 n2 n0
15442 d m y y1 y2 date1 date2 nmonths nm ny m2)
15444 (setq start (org-date-to-gregorian start)
15445 current (org-date-to-gregorian
15446 (if show-all
15447 current
15448 (time-to-days (current-time))))
15449 sday (calendar-absolute-from-gregorian start)
15450 cday (calendar-absolute-from-gregorian current))
15452 (if (<= cday sday) (throw 'exit sday))
15455 (setq dn (string-to-number (match-string 1 change))
15456 dw (cdr (assoc (match-string 2 change) a1)))
15457 (error "Invalid change specifier: %s" change))
15458 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15459 (cond
15460 ((eq dw 'day)
15461 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15462 n2 (+ n1 dn)))
15463 ((eq dw 'year)
15464 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15465 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15466 (setq date1 (list m d y1)
15467 n1 (calendar-absolute-from-gregorian date1)
15468 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15469 n2 (calendar-absolute-from-gregorian date2)))
15470 ((eq dw 'month)
15471 ;; approx number of month between the two dates
15472 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15473 ;; How often does dn fit in there?
15474 (setq d (nth 1 start) m (car start) y (nth 2 start)
15475 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15476 m (+ m nm)
15477 ny (floor (/ m 12))
15478 y (+ y ny)
15479 m (- m (* ny 12)))
15480 (while (> m 12) (setq m (- m 12) y (1+ y)))
15481 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15482 (setq m2 (+ m dn) y2 y)
15483 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15484 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15485 (while (<= n2 cday)
15486 (setq n1 n2 m m2 y y2)
15487 (setq m2 (+ m dn) y2 y)
15488 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15489 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15490 ;; Make sure n1 is the earlier date
15491 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15492 (if show-all
15493 (cond
15494 ((eq prefer 'past) (if (= cday n2) n2 n1))
15495 ((eq prefer 'future) (if (= cday n1) n1 n2))
15496 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15497 (cond
15498 ((eq prefer 'past) (if (= cday n2) n2 n1))
15499 ((eq prefer 'future) (if (= cday n1) n1 n2))
15500 (t (if (= cday n1) n1 n2)))))))
15502 (defun org-date-to-gregorian (date)
15503 "Turn any specification of DATE into a Gregorian date for the calendar."
15504 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15505 ((and (listp date) (= (length date) 3)) date)
15506 ((stringp date)
15507 (setq date (org-parse-time-string date))
15508 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15509 ((listp date)
15510 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15512 (defun org-parse-time-string (s &optional nodefault)
15513 "Parse the standard Org-mode time string.
15514 This should be a lot faster than the normal `parse-time-string'.
15515 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15516 hour and minute fields will be nil if not given."
15517 (if (string-match org-ts-regexp0 s)
15518 (list 0
15519 (if (or (match-beginning 8) (not nodefault))
15520 (string-to-number (or (match-string 8 s) "0")))
15521 (if (or (match-beginning 7) (not nodefault))
15522 (string-to-number (or (match-string 7 s) "0")))
15523 (string-to-number (match-string 4 s))
15524 (string-to-number (match-string 3 s))
15525 (string-to-number (match-string 2 s))
15526 nil nil nil)
15527 (error "Not a standard Org-mode time string: %s" s)))
15529 (defun org-timestamp-up (&optional arg)
15530 "Increase the date item at the cursor by one.
15531 If the cursor is on the year, change the year. If it is on the month,
15532 the day or the time, change that.
15533 With prefix ARG, change by that many units."
15534 (interactive "p")
15535 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15537 (defun org-timestamp-down (&optional arg)
15538 "Decrease the date item at the cursor by one.
15539 If the cursor is on the year, change the year. If it is on the month,
15540 the day or the time, change that.
15541 With prefix ARG, change by that many units."
15542 (interactive "p")
15543 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15545 (defun org-timestamp-up-day (&optional arg)
15546 "Increase the date in the time stamp by one day.
15547 With prefix ARG, change that many days."
15548 (interactive "p")
15549 (if (and (not (org-at-timestamp-p t))
15550 (org-on-heading-p))
15551 (org-todo 'up)
15552 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15554 (defun org-timestamp-down-day (&optional arg)
15555 "Decrease the date in the time stamp by one day.
15556 With prefix ARG, change that many days."
15557 (interactive "p")
15558 (if (and (not (org-at-timestamp-p t))
15559 (org-on-heading-p))
15560 (org-todo 'down)
15561 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15563 (defun org-at-timestamp-p (&optional inactive-ok)
15564 "Determine if the cursor is in or at a timestamp."
15565 (interactive)
15566 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15567 (pos (point))
15568 (ans (or (looking-at tsr)
15569 (save-excursion
15571 (if (> (point) (point-min)) (backward-char 1))
15572 (and (looking-at tsr)
15573 (> (- (match-end 0) pos) -1))))))
15574 (and ans
15575 (boundp 'org-ts-what)
15576 (setq org-ts-what
15577 (cond
15578 ((= pos (match-beginning 0)) 'bracket)
15579 ((= pos (1- (match-end 0))) 'bracket)
15580 ((org-pos-in-match-range pos 2) 'year)
15581 ((org-pos-in-match-range pos 3) 'month)
15582 ((org-pos-in-match-range pos 7) 'hour)
15583 ((org-pos-in-match-range pos 8) 'minute)
15584 ((or (org-pos-in-match-range pos 4)
15585 (org-pos-in-match-range pos 5)) 'day)
15586 ((and (> pos (or (match-end 8) (match-end 5)))
15587 (< pos (match-end 0)))
15588 (- pos (or (match-end 8) (match-end 5))))
15589 (t 'day))))
15590 ans))
15592 (defun org-toggle-timestamp-type ()
15593 "Toggle the type (<active> or [inactive]) of a time stamp."
15594 (interactive)
15595 (when (org-at-timestamp-p t)
15596 (let ((beg (match-beginning 0)) (end (match-end 0))
15597 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15598 (save-excursion
15599 (goto-char beg)
15600 (while (re-search-forward "[][<>]" end t)
15601 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15602 t t)))
15603 (message "Timestamp is now %sactive"
15604 (if (equal (char-after beg) ?<) "" "in")))))
15606 (defun org-timestamp-change (n &optional what updown)
15607 "Change the date in the time stamp at point.
15608 The date will be changed by N times WHAT. WHAT can be `day', `month',
15609 `year', `minute', `second'. If WHAT is not given, the cursor position
15610 in the timestamp determines what will be changed."
15611 (let ((origin (point)) origin-cat
15612 with-hm inactive
15613 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15614 org-ts-what
15615 extra rem
15616 ts time time0)
15617 (if (not (org-at-timestamp-p t))
15618 (error "Not at a timestamp"))
15619 (if (and (not what) (eq org-ts-what 'bracket))
15620 (org-toggle-timestamp-type)
15621 ;; Point isn't on brackets. Remember the part of the time-stamp
15622 ;; the point was in. Indeed, size of time-stamps may change,
15623 ;; but point must be kept in the same category nonetheless.
15624 (setq origin-cat org-ts-what)
15625 (if (and (not what) (not (eq org-ts-what 'day))
15626 org-display-custom-times
15627 (get-text-property (point) 'display)
15628 (not (get-text-property (1- (point)) 'display)))
15629 (setq org-ts-what 'day))
15630 (setq org-ts-what (or what org-ts-what)
15631 inactive (= (char-after (match-beginning 0)) ?\[)
15632 ts (match-string 0))
15633 (replace-match "")
15634 (if (string-match
15636 ts)
15637 (setq extra (match-string 1 ts)))
15639 (setq with-hm t))
15640 (setq time0 (org-parse-time-string ts))
15641 (when (and updown
15642 (eq org-ts-what 'minute)
15643 (not current-prefix-arg))
15644 ;; This looks like s-up and s-down. Change by one rounding step.
15645 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15646 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15647 (setcar (cdr time0) (+ (nth 1 time0)
15648 (if (> n 0) (- rem) (- dm rem))))))
15649 (setq time
15650 (encode-time (or (car time0) 0)
15651 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15652 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15653 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15654 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15655 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15656 (nthcdr 6 time0)))
15657 (when (and (member org-ts-what '(hour minute))
15658 extra
15660 (setq extra (org-modify-ts-extra
15661 extra
15662 (if (eq org-ts-what 'hour) 2 5)
15663 n dm)))
15664 (when (integerp org-ts-what)
15665 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15666 (if (eq what 'calendar)
15667 (let ((cal-date (org-get-date-from-calendar)))
15668 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15669 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15670 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15671 (setcar time0 (or (car time0) 0))
15672 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15673 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15674 (setq time (apply 'encode-time time0))))
15675 ;; Insert the new time-stamp, and ensure point stays in the same
15676 ;; category as before (i.e. not after the last position in that
15677 ;; category).
15678 (let ((pos (point)))
15679 ;; Stay before inserted string. `save-excursion' is of no use.
15680 (setq org-last-changed-timestamp
15681 (org-insert-time-stamp time with-hm inactive nil nil extra))
15682 (goto-char pos))
15683 (save-match-data
15684 (looking-at org-ts-regexp3)
15685 (goto-char (cond
15686 ;; `day' category ends before `hour' if any, or at
15687 ;; the end of the day name.
15688 ((eq origin-cat 'day)
15689 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15690 ((eq origin-cat 'hour) (min (match-end 7) origin))
15691 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15692 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15693 ;; `year' and `month' have both fixed size: point
15694 ;; couldn't have moved into another part.
15695 (t origin))))
15696 ;; Update clock if on a CLOCK line.
15697 (org-clock-update-time-maybe)
15698 ;; Try to recenter the calendar window, if any.
15699 (if (and org-calendar-follow-timestamp-change
15700 (get-buffer-window "*Calendar*" t)
15701 (memq org-ts-what '(day month year)))
15702 (org-recenter-calendar (time-to-days time))))))
15704 (defun org-modify-ts-extra (s pos n dm)
15705 "Change the different parts of the lead-time and repeat fields in timestamp."
15706 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15707 ng h m new rem)
15708 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15709 (cond
15710 ((or (org-pos-in-match-range pos 2)
15711 (org-pos-in-match-range pos 3))
15712 (setq m (string-to-number (match-string 3 s))
15713 h (string-to-number (match-string 2 s)))
15714 (if (org-pos-in-match-range pos 2)
15715 (setq h (+ h n))
15716 (setq n (* dm (org-no-warnings (signum n))))
15717 (when (not (= 0 (setq rem (% m dm))))
15718 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15719 (setq m (+ m n)))
15720 (if (< m 0) (setq m (+ m 60) h (1- h)))
15721 (if (> m 59) (setq m (- m 60) h (1+ h)))
15722 (setq h (min 24 (max 0 h)))
15723 (setq ng 1 new (format "-%02d:%02d" h m)))
15724 ((org-pos-in-match-range pos 6)
15725 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15726 ((org-pos-in-match-range pos 5)
15727 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15729 ((org-pos-in-match-range pos 9)
15730 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15731 ((org-pos-in-match-range pos 8)
15732 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15734 (when ng
15735 (setq s (concat
15736 (substring s 0 (match-beginning ng))
15737 new
15738 (substring s (match-end ng))))))
15739 s))
15741 (defun org-recenter-calendar (date)
15742 "If the calendar is visible, recenter it to DATE."
15743 (let* ((win (selected-window))
15744 (cwin (get-buffer-window "*Calendar*" t))
15745 (calendar-move-hook nil))
15746 (when cwin
15747 (select-window cwin)
15748 (calendar-goto-date (if (listp date) date
15749 (calendar-gregorian-from-absolute date)))
15750 (select-window win))))
15752 (defun org-goto-calendar (&optional arg)
15753 "Go to the Emacs calendar at the current date.
15754 If there is a time stamp in the current line, go to that date.
15755 A prefix ARG can be used to force the current date."
15756 (interactive "P")
15757 (let ((tsr org-ts-regexp) diff
15758 (calendar-move-hook nil)
15759 (calendar-view-holidays-initially-flag nil)
15760 (calendar-view-diary-initially-flag nil))
15761 (if (or (org-at-timestamp-p)
15762 (save-excursion
15763 (beginning-of-line 1)
15764 (looking-at (concat ".*" tsr))))
15765 (let ((d1 (time-to-days (current-time)))
15766 (d2 (time-to-days
15767 (org-time-string-to-time (match-string 1)))))
15768 (setq diff (- d2 d1))))
15769 (calendar)
15770 (calendar-goto-today)
15771 (if (and diff (not arg)) (calendar-forward-day diff))))
15773 (defun org-get-date-from-calendar ()
15774 "Return a list (month day year) of date at point in calendar."
15775 (with-current-buffer "*Calendar*"
15776 (save-match-data
15777 (calendar-cursor-to-date))))
15779 (defun org-date-from-calendar ()
15780 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15781 If there is already a time stamp at the cursor position, update it."
15782 (interactive)
15783 (if (org-at-timestamp-p t)
15784 (org-timestamp-change 0 'calendar)
15785 (let ((cal-date (org-get-date-from-calendar)))
15786 (org-insert-time-stamp
15787 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15789 (defun org-minutes-to-hh:mm-string (m)
15790 "Compute H:MM from a number of minutes."
15791 (let ((h (/ m 60)))
15792 (setq m (- m (* 60 h)))
15793 (format org-time-clocksum-format h m)))
15795 (defun org-hh:mm-string-to-minutes (s)
15796 "Convert a string H:MM to a number of minutes.
15797 If the string is just a number, interpret it as minutes.
15798 In fact, the first hh:mm or number in the string will be taken,
15799 there can be extra stuff in the string.
15800 If no number is found, the return value is 0."
15801 (cond
15802 ((integerp s) s)
15804 (+ (* (string-to-number (match-string 1 s)) 60)
15805 (string-to-number (match-string 2 s))))
15807 (string-to-number (match-string 1 s)))
15808 (t 0)))
15810 (defcustom org-effort-durations
15811 `(("h" . 60)
15812 ("d" . ,(* 60 8))
15813 ("w" . ,(* 60 8 5))
15814 ("m" . ,(* 60 8 5 4))
15815 ("y" . ,(* 60 8 5 40)))
15816 "Conversion factor to minutes for an effort modifier.
15818 Each entry has the form (MODIFIER . MINUTES).
15820 In an effort string, a number followed by MODIFIER is multiplied
15821 by the specified number of MINUTES to obtain an effort in
15822 minutes.
15826 :group 'org-agenda
15827 :type '(alist :key-type (string :tag "Modifier")
15828 :value-type (number :tag "Minutes")))
15830 (defun org-duration-string-to-minutes (s)
15831 "Convert a duration string S to minutes.
15833 A bare number is interpreted as minutes, modifiers can be set by
15834 customizing `org-effort-durations' (which see).
15836 Entries containing a colon are interpreted as H:MM by
15837 `org-hh:mm-string-to-minutes'."
15838 (let ((result 0)
15840 (regexp-opt (mapcar 'car org-effort-durations))
15842 (while (string-match re s)
15843 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15844 (string-to-number (match-string 1 s))))
15845 (setq s (replace-match "" nil t s)))
15846 (incf result (org-hh:mm-string-to-minutes s))
15847 result))
15849 ;;;; Files
15851 (defun org-save-all-org-buffers ()
15852 "Save all Org-mode buffers without user confirmation."
15853 (interactive)
15854 (message "Saving all Org-mode buffers...")
15855 (save-some-buffers t 'org-mode-p)
15856 (when (featurep 'org-id) (org-id-locations-save))
15857 (message "Saving all Org-mode buffers... done"))
15859 (defun org-revert-all-org-buffers ()
15860 "Revert all Org-mode buffers.
15861 Prompt for confirmation when there are unsaved changes.
15862 Be sure you know what you are doing before letting this function
15863 overwrite your changes.
15865 This function is useful in a setup where one tracks org files
15866 with a version control system, to revert on one machine after pulling
15867 changes from another. I believe the procedure must be like this:
15869 1. M-x org-save-all-org-buffers
15870 2. Pull changes from the other machine, resolve conflicts
15871 3. M-x org-revert-all-org-buffers"
15872 (interactive)
15873 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15874 (error "Abort"))
15875 (save-excursion
15876 (save-window-excursion
15877 (mapc
15878 (lambda (b)
15879 (when (and (with-current-buffer b (org-mode-p))
15880 (with-current-buffer b buffer-file-name))
15881 (org-pop-to-buffer-same-window b)
15882 (revert-buffer t 'no-confirm)))
15883 (buffer-list))
15884 (when (and (featurep 'org-id) org-id-track-globally)
15885 (org-id-locations-load)))))
15887 ;;;; Agenda files
15889 ;;;###autoload
15890 (defun org-switchb (&optional arg)
15891 "Switch between Org buffers.
15892 With a prefix argument, restrict available to files.
15893 With two prefix arguments, restrict available buffers to agenda files.
15895 Defaults to `iswitchb' for buffer name completion.
15896 Set `org-completion-use-ido' to make it use ido instead."
15897 (interactive "P")
15898 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15899 ((equal arg '(16)) (org-buffer-list 'agenda))
15900 (t (org-buffer-list))))
15901 (org-completion-use-iswitchb org-completion-use-iswitchb)
15902 (org-completion-use-ido org-completion-use-ido))
15903 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15904 (setq org-completion-use-iswitchb t))
15905 (org-pop-to-buffer-same-window
15906 (org-icompleting-read "Org buffer: "
15907 (mapcar 'list (mapcar 'buffer-name blist))
15908 nil t))))
15910 ;;; Define some older names previously used for this functionality
15911 ;;;###autoload
15912 (defalias 'org-ido-switchb 'org-switchb)
15913 ;;;###autoload
15914 (defalias 'org-iswitchb 'org-switchb)
15916 (defun org-buffer-list (&optional predicate exclude-tmp)
15917 "Return a list of Org buffers.
15918 PREDICATE can be `export', `files' or `agenda'.
15920 export restrict the list to Export buffers.
15921 files restrict the list to buffers visiting Org files.
15922 agenda restrict the list to buffers visiting agenda files.
15924 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15925 (let* ((bfn nil)
15926 (agenda-files (and (eq predicate 'agenda)
15927 (mapcar 'file-truename (org-agenda-files t))))
15928 (filter
15929 (cond
15930 ((eq predicate 'files)
15931 (lambda (b) (with-current-buffer b (org-mode-p))))
15932 ((eq predicate 'export)
15933 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15934 ((eq predicate 'agenda)
15935 (lambda (b)
15936 (with-current-buffer b
15937 (and (org-mode-p)
15938 (setq bfn (buffer-file-name b))
15939 (member (file-truename bfn) agenda-files)))))
15940 (t (lambda (b) (with-current-buffer b
15941 (or (org-mode-p)
15942 (string-match "\*Org .*Export"
15943 (buffer-name b)))))))))
15944 (delq nil
15945 (mapcar
15946 (lambda(b)
15947 (if (and (funcall filter b)
15948 (or (not exclude-tmp)
15949 (not (string-match "tmp" (buffer-name b)))))
15950 b
15951 nil))
15952 (buffer-list)))))
15954 (defun org-agenda-files (&optional unrestricted archives)
15955 "Get the list of agenda files.
15956 Optional UNRESTRICTED means return the full list even if a restriction
15957 is currently in place.
15958 When ARCHIVES is t, include all archive files that are really being
15959 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15960 `org-agenda-archives-mode' is t."
15961 (let ((files
15962 (cond
15963 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15964 ((stringp org-agenda-files) (org-read-agenda-file-list))
15965 ((listp org-agenda-files) org-agenda-files)
15966 (t (error "Invalid value of `org-agenda-files'")))))
15967 (setq files (apply 'append
15968 (mapcar (lambda (f)
15969 (if (file-directory-p f)
15970 (directory-files
15971 f t org-agenda-file-regexp)
15972 (list f)))
15973 files)))
15974 (when org-agenda-skip-unavailable-files
15975 (setq files (delq nil
15976 (mapcar (function
15977 (lambda (file)
15978 (and (file-readable-p file) file)))
15979 files))))
15980 (when (or (eq archives t)
15981 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15982 (setq files (org-add-archive-files files)))
15983 files))
15985 (defun org-agenda-file-p (&optional file)
15986 "Return non-nil, if FILE is an agenda file.
15987 If FILE is omitted, use the file associated with the current
15988 buffer."
15989 (member (or file (buffer-file-name))
15990 (org-agenda-files t)))
15992 (defun org-edit-agenda-file-list ()
15993 "Edit the list of agenda files.
15994 Depending on setup, this either uses customize to edit the variable
15995 `org-agenda-files', or it visits the file that is holding the list. In the
15996 latter case, the buffer is set up in a way that saving it automatically kills
15997 the buffer and restores the previous window configuration."
15998 (interactive)
15999 (if (stringp org-agenda-files)
16000 (let ((cw (current-window-configuration)))
16001 (find-file org-agenda-files)
16002 (org-set-local 'org-window-configuration cw)
16003 (org-add-hook 'after-save-hook
16004 (lambda ()
16005 (set-window-configuration
16006 (prog1 org-window-configuration
16007 (kill-buffer (current-buffer))))
16008 (org-install-agenda-files-menu)
16009 (message "New agenda file list installed"))
16010 nil 'local)
16011 (message "%s" (substitute-command-keys
16013 (customize-variable 'org-agenda-files)))
16015 (defun org-store-new-agenda-file-list (list)
16016 "Set new value for the agenda file list and save it correctly."
16017 (if (stringp org-agenda-files)
16018 (let ((fe (org-read-agenda-file-list t)) b u)
16019 (while (setq b (find-buffer-visiting org-agenda-files))
16020 (kill-buffer b))
16021 (with-temp-file org-agenda-files
16022 (insert
16023 (mapconcat
16024 (lambda (f) ;; Keep un-expanded entries.
16025 (if (setq u (assoc f fe))
16026 (cdr u)
16027 f))
16030 (let ((org-mode-hook nil) (org-inhibit-startup t)
16031 (org-insert-mode-line-in-empty-file nil))
16032 (setq org-agenda-files list)
16033 (customize-save-variable 'org-agenda-files org-agenda-files))))
16035 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16036 "Read the list of agenda files from a file.
16037 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16038 filenames, used by `org-store-new-agenda-file-list' to write back
16039 un-expanded file names."
16040 (when (file-directory-p org-agenda-files)
16041 (error "`org-agenda-files' cannot be a single directory"))
16042 (when (stringp org-agenda-files)
16043 (with-temp-buffer
16044 (insert-file-contents org-agenda-files)
16045 (mapcar
16046 (lambda (f)
16047 (let ((e (expand-file-name (substitute-in-file-name f)
16048 org-directory)))
16049 (if pair-with-expansion
16050 (cons e f)
16051 e)))
16054 ;;;###autoload
16055 (defun org-cycle-agenda-files ()
16056 "Cycle through the files in `org-agenda-files'.
16057 If the current buffer visits an agenda file, find the next one in the list.
16058 If the current buffer does not, find the first agenda file."
16059 (interactive)
16060 (let* ((fs (org-agenda-files t))
16061 (files (append fs (list (car fs))))
16062 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16063 file)
16064 (unless files (error "No agenda files"))
16065 (catch 'exit
16066 (while (setq file (pop files))
16067 (if (equal (file-truename file) tcf)
16068 (when (car files)
16069 (find-file (car files))
16070 (throw 'exit t))))
16071 (find-file (car fs)))
16072 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16074 (defun org-agenda-file-to-front (&optional to-end)
16075 "Move/add the current file to the top of the agenda file list.
16076 If the file is not present in the list, it is added to the front. If it is
16077 present, it is moved there. With optional argument TO-END, add/move to the
16078 end of the list."
16079 (interactive "P")
16080 (let ((org-agenda-skip-unavailable-files nil)
16081 (file-alist (mapcar (lambda (x)
16082 (cons (file-truename x) x))
16083 (org-agenda-files t)))
16084 (ctf (file-truename buffer-file-name))
16085 x had)
16086 (setq x (assoc ctf file-alist) had x)
16088 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16089 (if to-end
16090 (setq file-alist (append (delq x file-alist) (list x)))
16091 (setq file-alist (cons x (delq x file-alist))))
16092 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16093 (org-install-agenda-files-menu)
16094 (message "File %s to %s of agenda file list"
16095 (if had "moved" "added") (if to-end "end" "front"))))
16097 (defun org-remove-file (&optional file)
16098 "Remove current file from the list of files in variable `org-agenda-files'.
16099 These are the files which are being checked for agenda entries.
16100 Optional argument FILE means use this file instead of the current."
16101 (interactive)
16102 (let* ((org-agenda-skip-unavailable-files nil)
16103 (file (or file buffer-file-name))
16104 (true-file (file-truename file))
16105 (afile (abbreviate-file-name file))
16106 (files (delq nil (mapcar
16107 (lambda (x)
16108 (if (equal true-file
16109 (file-truename x))
16110 nil x))
16111 (org-agenda-files t)))))
16112 (if (not (= (length files) (length (org-agenda-files t))))
16113 (progn
16114 (org-store-new-agenda-file-list files)
16115 (org-install-agenda-files-menu)
16116 (message "Removed file: %s" afile))
16117 (message "File was not in list: %s (not removed)" afile))))
16119 (defun org-file-menu-entry (file)
16120 (vector file (list 'find-file file) t))
16122 (defun org-check-agenda-file (file)
16123 "Make sure FILE exists. If not, ask user what to do."
16124 (when (not (file-exists-p file))
16125 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16126 (abbreviate-file-name file))
16127 (let ((r (downcase (read-char-exclusive))))
16128 (cond
16129 ((equal r ?r)
16130 (org-remove-file file)
16131 (throw 'nextfile t))
16132 (t (error "Abort"))))))
16134 (defun org-get-agenda-file-buffer (file)
16135 "Get a buffer visiting FILE. If the buffer needs to be created, add
16136 it to the list of buffers which might be released later."
16137 (let ((buf (org-find-base-buffer-visiting file)))
16138 (if buf
16139 buf ; just return it
16140 ;; Make a new buffer and remember it
16141 (setq buf (find-file-noselect file))
16142 (if buf (push buf org-agenda-new-buffers))
16143 buf)))
16145 (defun org-release-buffers (blist)
16146 "Release all buffers in list, asking the user for confirmation when needed.
16147 When a buffer is unmodified, it is just killed. When modified, it is saved
16148 \(if the user agrees) and then killed."
16149 (let (buf file)
16150 (while (setq buf (pop blist))
16151 (setq file (buffer-file-name buf))
16152 (when (and (buffer-modified-p buf)
16153 file
16154 (y-or-n-p (format "Save file %s? " file)))
16155 (with-current-buffer buf (save-buffer)))
16156 (kill-buffer buf))))
16158 (defun org-prepare-agenda-buffers (files)
16159 "Create buffers for all agenda files, protect archived trees and comments."
16160 (interactive)
16161 (let ((pa '(:org-archived t))
16162 (pc '(:org-comment t))
16163 (pall '(:org-archived t :org-comment t))
16164 (inhibit-read-only t)
16165 (rea (concat ":" org-archive-tag ":"))
16166 bmp file re)
16167 (save-excursion
16168 (save-restriction
16169 (while (setq file (pop files))
16170 (catch 'nextfile
16171 (if (bufferp file)
16172 (set-buffer file)
16173 (org-check-agenda-file file)
16174 (set-buffer (org-get-agenda-file-buffer file)))
16175 (widen)
16176 (setq bmp (buffer-modified-p))
16177 (org-refresh-category-properties)
16178 (setq org-todo-keywords-for-agenda
16179 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16180 (setq org-done-keywords-for-agenda
16181 (append org-done-keywords-for-agenda org-done-keywords))
16182 (setq org-todo-keyword-alist-for-agenda
16183 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16184 (setq org-drawers-for-agenda
16185 (append org-drawers-for-agenda org-drawers))
16186 (setq org-tag-alist-for-agenda
16187 (append org-tag-alist-for-agenda org-tag-alist))
16189 (save-excursion
16190 (remove-text-properties (point-min) (point-max) pall)
16191 (when org-agenda-skip-archived-trees
16192 (goto-char (point-min))
16193 (while (re-search-forward rea nil t)
16194 (if (org-on-heading-p t)
16195 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16196 (goto-char (point-min))
16198 (while (re-search-forward re nil t)
16199 (add-text-properties
16200 (match-beginning 0) (org-end-of-subtree t) pc)))
16201 (set-buffer-modified-p bmp)))))
16202 (setq org-todo-keywords-for-agenda
16203 (org-uniquify org-todo-keywords-for-agenda))
16204 (setq org-todo-keyword-alist-for-agenda
16205 (org-uniquify org-todo-keyword-alist-for-agenda)
16206 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16208 ;;;; Embedded LaTeX
16210 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16211 "Keymap for the minor `org-cdlatex-mode'.")
16213 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16214 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16215 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16216 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16217 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16219 (defvar org-cdlatex-texmathp-advice-is-done nil
16220 "Flag remembering if we have applied the advice to texmathp already.")
16222 (define-minor-mode org-cdlatex-mode
16223 "Toggle the minor `org-cdlatex-mode'.
16224 This mode supports entering LaTeX environment and math in LaTeX fragments
16225 in Org-mode.
16227 nil " OCDL" nil
16228 (when org-cdlatex-mode (require 'cdlatex))
16229 (unless org-cdlatex-texmathp-advice-is-done
16230 (setq org-cdlatex-texmathp-advice-is-done t)
16231 (defadvice texmathp (around org-math-always-on activate)
16232 "Always return t in org-mode buffers.
16233 This is because we want to insert math symbols without dollars even outside
16234 the LaTeX math segments. If Orgmode thinks that point is actually inside
16235 an embedded LaTeX fragment, let texmathp do its job.
16237 (interactive)
16238 (let (p)
16239 (cond
16240 ((not (org-mode-p)) ad-do-it)
16241 ((eq this-command 'cdlatex-math-symbol)
16242 (setq ad-return-value t
16243 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16244 (t
16245 (let ((p (org-inside-LaTeX-fragment-p)))
16246 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16247 (setq ad-return-value t
16248 texmathp-why '("Org-mode embedded math" . 0))
16249 (if p ad-do-it)))))))))
16251 (defun turn-on-org-cdlatex ()
16252 "Unconditionally turn on `org-cdlatex-mode'."
16253 (org-cdlatex-mode 1))
16255 (defun org-inside-LaTeX-fragment-p ()
16256 "Test if point is inside a LaTeX fragment.
16258 sequence appearing also before point.
16259 Even though the matchers for math are configurable, this function assumes
16261 delimiters are skipped when they have been removed by customization.
16262 The return value is nil, or a cons cell with the delimiter and the
16263 position of this delimiter.
16265 This function does a reasonably good job, but can locally be fooled by
16266 for example currency specifications. For example it will assume being in
16268 fragments that are properly closed, but during editing, we have to live
16269 with the uncertainty caused by missing closing delimiters. This function
16270 looks only before point, not after."
16271 (catch 'exit
16272 (let ((pos (point))
16273 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16274 (lim (progn
16276 (point)))
16277 dd-on str (start 0) m re)
16278 (goto-char pos)
16279 (when dodollar
16281 re (nth 1 (assoc "$" org-latex-regexps)))
16282 (while (string-match re str start)
16283 (cond
16284 ((= (match-end 0) (length str))
16285 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16286 ((= (match-end 0) (- (length str) 5))
16287 (throw 'exit nil))
16288 (t (setq start (match-end 0))))))
16289 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16290 (goto-char pos)
16291 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16292 (and (match-beginning 2) (throw 'exit nil))
16293 ;; count $$
16295 (setq dd-on (not dd-on)))
16296 (goto-char pos)
16297 (if dd-on (cons "$$" m))))))
16299 (defun org-inside-latex-macro-p ()
16300 "Is point inside a LaTeX macro or its arguments?"
16301 (save-match-data
16302 (org-in-regexp
16305 (defun org-try-cdlatex-tab ()
16306 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16307 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16308 - inside a LaTeX fragment, or
16309 - after the first word in a line, where an abbreviation expansion could
16310 insert a LaTeX environment."
16311 (when org-cdlatex-mode
16312 (cond
16313 ((save-excursion
16314 (skip-chars-backward "a-zA-Z0-9*")
16316 (bolp))
16317 (cdlatex-tab) t)
16318 ((org-inside-LaTeX-fragment-p)
16319 (cdlatex-tab) t)
16320 (t nil))))
16322 (defun org-cdlatex-underscore-caret (&optional arg)
16323 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16324 Revert to the normal definition outside of these fragments."
16325 (interactive "P")
16326 (if (org-inside-LaTeX-fragment-p)
16327 (call-interactively 'cdlatex-sub-superscript)
16328 (let (org-cdlatex-mode)
16329 (call-interactively (key-binding (vector last-input-event))))))
16331 (defun org-cdlatex-math-modify (&optional arg)
16332 "Execute `cdlatex-math-modify' in LaTeX fragments.
16333 Revert to the normal definition outside of these fragments."
16334 (interactive "P")
16335 (if (org-inside-LaTeX-fragment-p)
16336 (call-interactively 'cdlatex-math-modify)
16337 (let (org-cdlatex-mode)
16338 (call-interactively (key-binding (vector last-input-event))))))
16340 (defvar org-latex-fragment-image-overlays nil
16341 "List of overlays carrying the images of latex fragments.")
16342 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16344 (defun org-remove-latex-fragment-image-overlays ()
16345 "Remove all overlays with LaTeX fragment images in current buffer."
16346 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16347 (setq org-latex-fragment-image-overlays nil))
16349 (defun org-preview-latex-fragment (&optional subtree)
16350 "Preview the LaTeX fragment at point, or all locally or globally.
16351 If the cursor is in a LaTeX fragment, create the image and overlay
16352 it over the source code. If there is no fragment at point, display
16353 all fragments in the current text, from one headline to the next. With
16354 prefix SUBTREE, display all fragments in the current subtree. With a
16356 the cursor is before the first headline,
16357 display all fragments in the buffer.
16359 (interactive "P")
16360 (org-remove-latex-fragment-image-overlays)
16361 (save-excursion
16362 (save-restriction
16363 (let (beg end at msg)
16364 (cond
16365 ((or (equal subtree '(16))
16366 (not (save-excursion
16367 (re-search-backward org-outline-regexp-bol nil t))))
16368 (setq beg (point-min) end (point-max)
16369 msg "Creating images for buffer...%s"))
16370 ((equal subtree '(4))
16371 (org-back-to-heading)
16372 (setq beg (point) end (org-end-of-subtree t)
16373 msg "Creating images for subtree...%s"))
16374 (t
16375 (if (setq at (org-inside-LaTeX-fragment-p))
16376 (goto-char (max (point-min) (- (cdr at) 2)))
16377 (org-back-to-heading))
16378 (setq beg (point) end (progn (outline-next-heading) (point))
16379 msg (if at "Creating image...%s"
16380 "Creating images for entry...%s"))))
16381 (message msg "")
16382 (narrow-to-region beg end)
16383 (goto-char beg)
16384 (org-format-latex
16385 (concat "ltxpng/" (file-name-sans-extension
16386 (file-name-nondirectory
16387 buffer-file-name)))
16388 default-directory 'overlays msg at 'forbuffer 'dvipng)
16389 (message msg "done. Use `C-c C-c' to remove images.")))))
16391 (defvar org-latex-regexps
16393 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16396 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16400 "Regular expressions for matching embedded LaTeX.")
16402 (defvar org-export-have-math nil) ;; dynamic scoping
16403 (defun org-format-latex (prefix &optional dir overlays msg at
16404 forbuffer processing-type)
16405 "Replace LaTeX fragments with links to an image, and produce images.
16406 Some of the options can be changed using the variable
16407 `org-format-latex-options'."
16408 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16409 (let* ((prefixnodir (file-name-nondirectory prefix))
16410 (absprefix (expand-file-name prefix dir))
16411 (todir (file-name-directory absprefix))
16412 (opt org-format-latex-options)
16413 (matchers (plist-get opt :matchers))
16414 (re-list org-latex-regexps)
16415 (org-format-latex-header-extra
16416 (plist-get (org-infile-export-plist) :latex-header-extra))
16417 (cnt 0) txt hash link beg end re e checkdir
16418 executables-checked string
16419 m n block linkfile movefile ov)
16420 ;; Check the different regular expressions
16421 (while (setq e (pop re-list))
16422 (setq m (car e) re (nth 1 e) n (nth 2 e)
16424 (when (member m matchers)
16425 (goto-char (point-min))
16426 (while (re-search-forward re nil t)
16427 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16428 (not (get-text-property (match-beginning n)
16429 'org-protected))
16430 (or (not overlays)
16431 (not (eq (get-char-property (match-beginning n)
16432 'org-overlay-type)
16433 'org-latex-overlay))))
16434 (setq org-export-have-math t)
16435 (cond
16436 ((eq processing-type 'verbatim)
16437 ;; Leave the text verbatim, just protect it
16438 (add-text-properties (match-beginning n) (match-end n)
16439 '(org-protected t)))
16440 ((eq processing-type 'mathjax)
16441 ;; Prepare for MathJax processing
16442 (setq string (match-string n))
16443 (if (member m '("$" "$1"))
16444 (save-excursion
16445 (delete-region (match-beginning n) (match-end n))
16446 (goto-char (match-beginning n))
16449 '(org-protected t))))
16450 (add-text-properties (match-beginning n) (match-end n)
16451 '(org-protected t))))
16452 ((or (eq processing-type 'dvipng) t)
16453 ;; Process to an image
16454 (setq txt (match-string n)
16455 beg (match-beginning n) end (match-end n)
16456 cnt (1+ cnt))
16457 (let (print-length print-level) ; make sure full list is printed
16458 (setq hash (sha1 (prin1-to-string
16459 (list org-format-latex-header
16460 org-format-latex-header-extra
16461 org-export-latex-default-packages-alist
16462 org-export-latex-packages-alist
16463 org-format-latex-options
16464 forbuffer txt)))
16465 linkfile (format "%s_%s.png" prefix hash)
16466 movefile (format "%s_%s.png" absprefix hash)))
16467 (setq link (concat block "[[file:" linkfile "]]" block))
16468 (if msg (message msg cnt))
16469 (goto-char beg)
16470 (unless checkdir ; make sure the directory exists
16471 (setq checkdir t)
16472 (or (file-directory-p todir) (make-directory todir t)))
16474 (unless executables-checked
16475 (org-check-external-command
16476 "latex" "needed to convert LaTeX fragments to images")
16477 (org-check-external-command
16478 "dvipng" "needed to convert LaTeX fragments to images")
16479 (setq executables-checked t))
16481 (unless (file-exists-p movefile)
16482 (org-create-formula-image
16483 txt movefile opt forbuffer))
16484 (if overlays
16485 (progn
16486 (mapc (lambda (o)
16487 (if (eq (overlay-get o 'org-overlay-type)
16488 'org-latex-overlay)
16489 (delete-overlay o)))
16490 (overlays-in beg end))
16491 (setq ov (make-overlay beg end))
16492 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16493 (if (featurep 'xemacs)
16494 (progn
16495 (overlay-put ov 'invisible t)
16496 (overlay-put
16497 ov 'end-glyph
16498 (make-glyph (vector 'png :file movefile))))
16499 (overlay-put
16500 ov 'display
16501 (list 'image :type 'png :file movefile :ascent 'center)))
16502 (push ov org-latex-fragment-image-overlays)
16503 (goto-char end))
16504 (delete-region beg end)
16505 (insert (org-add-props link
16506 (list 'org-latex-src
16507 (replace-regexp-in-string
16510 ;; This function borrows from Ganesh Swami's latex2png.el
16511 (defun org-create-formula-image (string tofile options buffer)
16512 "This calls dvipng."
16513 (require 'org-latex)
16514 (let* ((tmpdir (if (featurep 'xemacs)
16515 (temp-directory)
16516 temporary-file-directory))
16517 (texfilebase (make-temp-name
16518 (expand-file-name "orgtex" tmpdir)))
16519 (texfile (concat texfilebase ".tex"))
16520 (dvifile (concat texfilebase ".dvi"))
16521 (pngfile (concat texfilebase ".png"))
16522 (fnh (if (featurep 'xemacs)
16523 (font-height (get-face-font 'default))
16524 (face-attribute 'default :height nil)))
16525 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16526 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16527 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16528 "Black"))
16529 (bg (or (plist-get options (if buffer :background :html-background))
16530 "Transparent")))
16531 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16532 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16533 (with-temp-file texfile
16534 (insert (org-splice-latex-header
16535 org-format-latex-header
16536 org-export-latex-default-packages-alist
16537 org-export-latex-packages-alist t
16538 org-format-latex-header-extra))
16540 (require 'org-latex)
16541 (org-export-latex-fix-inputenc))
16542 (let ((dir default-directory))
16543 (condition-case nil
16544 (progn
16545 (cd tmpdir)
16546 (call-process "latex" nil nil nil texfile))
16547 (error nil))
16548 (cd dir))
16549 (if (not (file-exists-p dvifile))
16550 (progn (message "Failed to create dvi file from %s" texfile) nil)
16551 (condition-case nil
16552 (call-process "dvipng" nil nil nil
16553 "-fg" fg "-bg" bg
16554 "-D" dpi
16555 ;;"-x" scale "-y" scale
16556 "-T" "tight"
16557 "-o" pngfile
16558 dvifile)
16559 (error nil))
16560 (if (not (file-exists-p pngfile))
16561 (if org-format-latex-signal-error
16562 (error "Failed to create png file from %s" texfile)
16563 (message "Failed to create png file from %s" texfile)
16564 nil)
16565 ;; Use the requested file name and clean up
16566 (copy-file pngfile tofile 'replace)
16567 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16568 (delete-file (concat texfilebase e)))
16569 pngfile))))
16571 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16572 "Fill a LaTeX header template TPL.
16573 In the template, the following place holders will be recognized:
16576 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16578 [NO-PACKAGES] do not include PKG
16579 [EXTRA] the string EXTRA
16580 [NO-EXTRA] do not include EXTRA
16582 For backward compatibility, if both the positive and the negative place
16584 assumed to be present at the end of the template.
16585 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16586 EXTRA is a string.
16587 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16588 (let (rpl (end ""))
16590 (setq rpl (if (or (match-end 1) (not def-pkg))
16591 "" (org-latex-packages-to-string def-pkg snippets-p t))
16592 tpl (replace-match rpl t t tpl))
16593 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16596 (setq rpl (if (or (match-end 1) (not pkg))
16597 "" (org-latex-packages-to-string pkg snippets-p t))
16598 tpl (replace-match rpl t t tpl))
16599 (if pkg (setq end
16601 (org-latex-packages-to-string pkg snippets-p)))))
16604 (setq rpl (if (or (match-end 1) (not extra))
16606 tpl (replace-match rpl t t tpl))
16612 tpl)))
16614 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16616 (setq pkg (mapconcat (lambda(p)
16617 (cond
16618 ((stringp p) p)
16619 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16620 (format "%% Package %s omitted" (cadr p)))
16621 ((equal "" (car p))
16623 (t
16625 (car p) (cadr p)))))
16626 pkg
16630 (defun org-dvipng-color (attr)
16631 "Return an rgb color specification for dvipng."
16632 (apply 'format "rgb %s %s %s"
16633 (mapcar 'org-normalize-color
16634 (color-values (face-attribute 'default attr nil)))))
16636 (defun org-normalize-color (value)
16637 "Return string to be used as color value for an RGB component."
16638 (format "%g" (/ value 65535.0)))
16640 ;; Image display
16643 (defvar org-inline-image-overlays nil)
16644 (make-variable-buffer-local 'org-inline-image-overlays)
16646 (defun org-toggle-inline-images (&optional include-linked)
16647 "Toggle the display of inline images.
16648 INCLUDE-LINKED is passed to `org-display-inline-images'."
16649 (interactive "P")
16650 (if org-inline-image-overlays
16651 (progn
16652 (org-remove-inline-images)
16653 (message "Inline image display turned off"))
16654 (org-display-inline-images include-linked)
16655 (if org-inline-image-overlays
16656 (message "%d images displayed inline"
16657 (length org-inline-image-overlays))
16658 (message "No images to display inline"))))
16660 (defun org-display-inline-images (&optional include-linked refresh beg end)
16661 "Display inline images.
16662 Normally only links without a description part are inlined, because this
16663 is how it will work for export. When INCLUDE-LINKED is set, also links
16664 with a description part will be inlined. This can be nice for a quick
16665 look at those images, but it does not reflect what exported files will look
16666 like.
16667 When REFRESH is set, refresh existing images between BEG and END.
16668 This will create new image displays only if necessary.
16669 BEG and END default to the buffer boundaries."
16670 (interactive "P")
16671 (unless refresh
16672 (org-remove-inline-images)
16673 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16674 (save-excursion
16675 (save-restriction
16676 (widen)
16677 (setq beg (or beg (point-min)) end (or end (point-max)))
16678 (goto-char (point-min))
16680 (substring (org-image-file-name-regexp) 0 -2)
16682 old file ov img)
16683 (while (re-search-forward re end t)
16684 (setq old (get-char-property-and-overlay (match-beginning 1)
16685 'org-image-overlay))
16686 (setq file (expand-file-name
16687 (concat (or (match-string 3) "") (match-string 4))))
16688 (when (file-exists-p file)
16689 (if (and (car-safe old) refresh)
16690 (image-refresh (overlay-get (cdr old) 'display))
16691 (setq img (save-match-data (create-image file)))
16692 (when img
16693 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16694 (overlay-put ov 'display img)
16695 (overlay-put ov 'face 'default)
16696 (overlay-put ov 'org-image-overlay t)
16697 (overlay-put ov 'modification-hooks
16698 (list 'org-display-inline-modification-hook))
16699 (push ov org-inline-image-overlays)))))))))
16701 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16702 "Remove inline-display overlay if a corresponding region is modified."
16703 (let ((inhibit-modification-hooks t))
16704 (when (and ov after)
16705 (delete ov org-inline-image-overlays)
16706 (delete-overlay ov))))
16708 (defun org-remove-inline-images ()
16709 "Remove inline display of images."
16710 (interactive)
16711 (mapc 'delete-overlay org-inline-image-overlays)
16712 (setq org-inline-image-overlays nil))
16714 ;;;; Key bindings
16716 ;; Make `C-c C-x' a prefix key
16717 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16719 ;; TAB key with modifiers
16720 (org-defkey org-mode-map "\C-i" 'org-cycle)
16721 (org-defkey org-mode-map [(tab)] 'org-cycle)
16722 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16723 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16725 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16726 ;; The following line is necessary under Suse GNU/Linux
16727 (unless (featurep 'xemacs)
16728 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16729 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16730 (define-key org-mode-map [backtab] 'org-shifttab)
16732 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16733 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16734 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16736 ;; Cursor keys with modifiers
16737 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16738 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16739 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16740 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16742 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16743 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16744 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16745 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16747 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16748 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16749 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16750 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16752 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16753 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16754 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16755 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16757 ;; Babel keys
16758 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16759 (mapc (lambda (pair)
16760 (define-key org-babel-map (car pair) (cdr pair)))
16761 org-babel-key-bindings)
16763 ;;; Extra keys for tty access.
16764 ;; We only set them when really needed because otherwise the
16765 ;; menus don't show the simple keys
16767 (when (or org-use-extra-keys
16768 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16769 (not window-system))
16770 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16771 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16772 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16773 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16774 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16775 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16776 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16777 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16778 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16779 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16780 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16781 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16782 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16783 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16784 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16785 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16786 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16787 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16788 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16789 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16790 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16791 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16792 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16793 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16794 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16795 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16796 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16797 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16799 ;; All the other keys
16801 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16802 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16803 (if (boundp 'narrow-map)
16804 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16805 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16806 (if (boundp 'narrow-map)
16807 (org-defkey narrow-map "b" 'org-narrow-to-block)
16808 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16809 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16810 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16811 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16812 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16813 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16814 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16815 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16816 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16817 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16818 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16819 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16820 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16821 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16822 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16823 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16824 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16826 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16827 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16828 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16829 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16830 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16831 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16832 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16833 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16834 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16835 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16836 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16837 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16838 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16839 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16840 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16841 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16842 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16843 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16844 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16845 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16847 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16848 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16849 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16850 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16851 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16852 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16853 (org-defkey org-mode-map "\C-c^" 'org-sort)
16854 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16855 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16856 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16857 (org-defkey org-mode-map "\C-m" 'org-return)
16858 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16859 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16860 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16861 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16862 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16863 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16864 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16865 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16866 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16867 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16868 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16869 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16870 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16871 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16872 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16873 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16874 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16875 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16876 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16877 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16878 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16879 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16881 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16882 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16883 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16884 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16886 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16887 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16888 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16889 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16890 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16891 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16892 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16893 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16894 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16895 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16897 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16898 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16899 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16900 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16901 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16902 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16903 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16905 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16906 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16907 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16908 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16909 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16911 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16913 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16915 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16916 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16918 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16921 (when (featurep 'xemacs)
16922 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16925 (defconst org-speed-commands-default
16926 '(
16927 ("Outline Navigation")
16928 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16929 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16930 ("f" . (org-speed-move-safe 'org-forward-same-level))
16931 ("b" . (org-speed-move-safe 'org-backward-same-level))
16932 ("u" . (org-speed-move-safe 'outline-up-heading))
16933 ("j" . org-goto)
16934 ("g" . (org-refile t))
16935 ("Outline Visibility")
16936 ("c" . org-cycle)
16937 ("C" . org-shifttab)
16938 (" " . org-display-outline-path)
16939 ("Outline Structure Editing")
16940 ("U" . org-shiftmetaup)
16941 ("D" . org-shiftmetadown)
16942 ("r" . org-metaright)
16943 ("l" . org-metaleft)
16944 ("R" . org-shiftmetaright)
16945 ("L" . org-shiftmetaleft)
16946 ("i" . (progn (forward-char 1) (call-interactively
16947 'org-insert-heading-respect-content)))
16948 ("^" . org-sort)
16949 ("w" . org-refile)
16950 ("a" . org-archive-subtree-default-with-confirmation)
16951 ("." . org-mark-subtree)
16952 ("Clock Commands")
16953 ("I" . org-clock-in)
16954 ("O" . org-clock-out)
16955 ("Meta Data Editing")
16956 ("t" . org-todo)
16957 ("0" . (org-priority ?\ ))
16958 ("1" . (org-priority ?A))
16959 ("2" . (org-priority ?B))
16960 ("3" . (org-priority ?C))
16961 (";" . org-set-tags-command)
16962 ("e" . org-set-effort)
16963 ("Agenda Views etc")
16964 ("v" . org-agenda)
16965 ("/" . org-sparse-tree)
16966 ("Misc")
16967 ("o" . org-open-at-point)
16968 ("?" . org-speed-command-help)
16969 ("<" . (org-agenda-set-restriction-lock 'subtree))
16970 (">" . (org-agenda-remove-restriction-lock))
16971 )
16972 "The default speed commands.")
16974 (defun org-print-speed-command (e)
16975 (if (> (length (car e)) 1)
16976 (progn
16978 (princ (car e))
16980 (princ (make-string (length (car e)) ?-))
16982 (princ (car e))
16983 (princ " ")
16984 (if (symbolp (cdr e))
16985 (princ (symbol-name (cdr e)))
16986 (prin1 (cdr e)))
16989 (defun org-speed-command-help ()
16990 "Show the available speed commands."
16991 (interactive)
16992 (if (not org-use-speed-commands)
16993 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16994 (with-output-to-temp-buffer "*Help*"
16996 (mapc 'org-print-speed-command org-speed-commands-user)
16999 (mapc 'org-print-speed-command org-speed-commands-default))
17000 (with-current-buffer "*Help*"
17001 (setq truncate-lines t))))
17003 (defun org-speed-move-safe (cmd)
17004 "Execute CMD, but make sure that the cursor always ends up in a headline.
17005 If not, return to the original position and throw an error."
17006 (interactive)
17007 (let ((pos (point)))
17008 (call-interactively cmd)
17009 (unless (and (bolp) (org-on-heading-p))
17010 (goto-char pos)
17011 (error "Boundary reached while executing %s" cmd))))
17013 (defvar org-self-insert-command-undo-counter 0)
17015 (defvar org-table-auto-blank-field) ; defined in org-table.el
17016 (defvar org-speed-command nil)
17018 (defun org-speed-command-default-hook (keys)
17019 "Hook for activating single-letter speed commands.
17020 `org-speed-commands-default' specifies a minimal command set. Use
17021 `org-speed-commands-user' for further customization."
17022 (when (or (and (bolp) (looking-at org-outline-regexp))
17023 (and (functionp org-use-speed-commands)
17024 (funcall org-use-speed-commands)))
17025 (cdr (assoc keys (append org-speed-commands-user
17026 org-speed-commands-default)))))
17028 (defun org-babel-speed-command-hook (keys)
17029 "Hook for activating single-letter code block commands."
17030 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17031 (cdr (assoc keys org-babel-key-bindings))))
17033 (defcustom org-speed-command-hook
17034 '(org-speed-command-default-hook org-babel-speed-command-hook)
17035 "Hook for activating speed commands at strategic locations.
17036 Hook functions are called in sequence until a valid handler is
17037 found.
17039 Each hook takes a single argument, a user-pressed command key
17040 which is also a `self-insert-command' from the global map.
17042 Within the hook, examine the cursor position and the command key
17043 and return nil or a valid handler as appropriate. Handler could
17044 be one of an interactive command, a function, or a form.
17046 Set `org-use-speed-commands' to non-nil value to enable this
17047 hook. The default setting is `org-speed-command-default-hook'."
17048 :group 'org-structure
17049 :type 'hook)
17051 (defun org-self-insert-command (N)
17052 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17053 If the cursor is in a table looking at whitespace, the whitespace is
17054 overwritten, and the table is not marked as requiring realignment."
17055 (interactive "p")
17056 (cond
17057 ((and org-use-speed-commands
17058 (setq org-speed-command
17059 (run-hook-with-args-until-success
17060 'org-speed-command-hook (this-command-keys))))
17061 (cond
17062 ((commandp org-speed-command)
17063 (setq this-command org-speed-command)
17064 (call-interactively org-speed-command))
17065 ((functionp org-speed-command)
17066 (funcall org-speed-command))
17067 ((and org-speed-command (listp org-speed-command))
17068 (eval org-speed-command))
17069 (t (let (org-use-speed-commands)
17070 (call-interactively 'org-self-insert-command)))))
17071 ((and
17072 (org-table-p)
17073 (progn
17074 ;; check if we blank the field, and if that triggers align
17075 (and (featurep 'org-table) org-table-auto-blank-field
17076 (member last-command
17077 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17079 ;; got extra space, this field does not determine column width
17080 (let (org-table-may-need-update) (org-table-blank-field))
17081 ;; no extra space, this field may determine column width
17082 (org-table-blank-field)))
17083 t)
17084 (eq N 1)
17086 (let (org-table-may-need-update)
17087 (goto-char (1- (match-end 0)))
17088 (delete-char -1)
17089 (goto-char (match-beginning 0))
17090 (self-insert-command N)))
17091 (t
17092 (setq org-table-may-need-update t)
17093 (self-insert-command N)
17094 (org-fix-tags-on-the-fly)
17095 (if org-self-insert-cluster-for-undo
17096 (if (not (eq last-command 'org-self-insert-command))
17097 (setq org-self-insert-command-undo-counter 1)
17098 (if (>= org-self-insert-command-undo-counter 20)
17099 (setq org-self-insert-command-undo-counter 1)
17100 (and (> org-self-insert-command-undo-counter 0)
17101 buffer-undo-list (listp buffer-undo-list)
17102 (not (cadr buffer-undo-list)) ; remove nil entry
17103 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17104 (setq org-self-insert-command-undo-counter
17105 (1+ org-self-insert-command-undo-counter))))))))
17107 (defun org-fix-tags-on-the-fly ()
17108 (when (and (equal (char-after (point-at-bol)) ?*)
17109 (org-on-heading-p))
17110 (org-align-tags-here org-tags-column)))
17112 (defun org-delete-backward-char (N)
17113 "Like `delete-backward-char', insert whitespace at field end in tables.
17114 When deleting backwards, in tables this function will insert whitespace in
17116 still be marked for re-alignment if the field did fill the entire column,
17117 because, in this case the deletion might narrow the column."
17118 (interactive "p")
17119 (if (and (org-table-p)
17120 (eq N 1)
17121 (string-match "|" (buffer-substring (point-at-bol) (point)))
17122 (looking-at ".*?|"))
17123 (let ((pos (point))
17125 (c org-table-may-need-update))
17126 (backward-delete-char N)
17127 (if (not overwrite-mode)
17128 (progn
17129 (skip-chars-forward "^|")
17130 (insert " ")
17131 (goto-char (1- pos))))
17132 ;; noalign: if there were two spaces at the end, this field
17133 ;; does not determine the width of the column.
17134 (if noalign (setq org-table-may-need-update c)))
17135 (backward-delete-char N)
17136 (org-fix-tags-on-the-fly)))
17138 (defun org-delete-char (N)
17139 "Like `delete-char', but insert whitespace at field end in tables.
17140 When deleting characters, in tables this function will insert whitespace in
17142 still be marked for re-alignment if the field did fill the entire column,
17143 because, in this case the deletion might narrow the column."
17144 (interactive "p")
17145 (if (and (org-table-p)
17146 (not (bolp))
17147 (not (= (char-after) ?|))
17148 (eq N 1))
17149 (if (looking-at ".*?|")
17150 (let ((pos (point))
17152 (c org-table-may-need-update))
17153 (replace-match (concat
17154 (substring (match-string 0) 1 -1)
17155 " |"))
17156 (goto-char pos)
17157 ;; noalign: if there were two spaces at the end, this field
17158 ;; does not determine the width of the column.
17159 (if noalign (setq org-table-may-need-update c)))
17160 (delete-char N))
17161 (delete-char N)
17162 (org-fix-tags-on-the-fly)))
17164 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17165 (put 'org-self-insert-command 'delete-selection t)
17166 (put 'orgtbl-self-insert-command 'delete-selection t)
17167 (put 'org-delete-char 'delete-selection 'supersede)
17168 (put 'org-delete-backward-char 'delete-selection 'supersede)
17169 (put 'org-yank 'delete-selection 'yank)
17171 ;; Make `flyspell-mode' delay after some commands
17172 (put 'org-self-insert-command 'flyspell-delayed t)
17173 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17174 (put 'org-delete-char 'flyspell-delayed t)
17175 (put 'org-delete-backward-char 'flyspell-delayed t)
17177 ;; Make pabbrev-mode expand after org-mode commands
17178 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17179 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17181 ;; How to do this: Measure non-white length of current string
17182 ;; If equal to column width, we should realign.
17184 (defun org-remap (map &rest commands)
17185 "In MAP, remap the functions given in COMMANDS.
17186 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17187 (let (new old)
17188 (while commands
17189 (setq old (pop commands) new (pop commands))
17190 (if (fboundp 'command-remapping)
17191 (org-defkey map (vector 'remap old) new)
17192 (substitute-key-definition old new map global-map)))))
17194 (when (eq org-enable-table-editor 'optimized)
17195 ;; If the user wants maximum table support, we need to hijack
17196 ;; some standard editing functions
17197 (org-remap org-mode-map
17198 'self-insert-command 'org-self-insert-command
17199 'delete-char 'org-delete-char
17200 'delete-backward-char 'org-delete-backward-char)
17201 (org-defkey org-mode-map "|" 'org-force-self-insert))
17203 (defvar org-ctrl-c-ctrl-c-hook nil
17204 "Hook for functions attaching themselves to `C-c C-c'.
17206 This can be used to add additional functionality to the C-c C-c
17207 key which executes context-dependent commands. This hook is run
17208 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17209 run after the last test.
17211 Each function will be called with no arguments. The function
17212 must check if the context is appropriate for it to act. If yes,
17213 it should do its thing and then return a non-nil value. If the
17214 context is wrong, just do nothing and return nil.")
17216 (defvar org-ctrl-c-ctrl-c-final-hook nil
17217 "Hook for functions attaching themselves to `C-c C-c'.
17219 This can be used to add additional functionality to the C-c C-c
17220 key which executes context-dependent commands. This hook is run
17221 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17222 before the first test.
17224 Each function will be called with no arguments. The function
17225 must check if the context is appropriate for it to act. If yes,
17226 it should do its thing and then return a non-nil value. If the
17227 context is wrong, just do nothing and return nil.")
17229 (defvar org-tab-first-hook nil
17230 "Hook for functions to attach themselves to TAB.
17231 See `org-ctrl-c-ctrl-c-hook' for more information.
17232 This hook runs as the first action when TAB is pressed, even before
17233 `org-cycle' messes around with the `outline-regexp' to cater for
17234 inline tasks and plain list item folding.
17235 If any function in this hook returns t, any other actions that
17236 would have been caused by TAB (such as table field motion or visibility
17237 cycling) will not occur.")
17239 (defvar org-tab-after-check-for-table-hook nil
17240 "Hook for functions to attach themselves to TAB.
17241 See `org-ctrl-c-ctrl-c-hook' for more information.
17242 This hook runs after it has been established that the cursor is not in a
17243 table, but before checking if the cursor is in a headline or if global cycling
17244 should be done.
17245 If any function in this hook returns t, not other actions like visibility
17246 cycling will be done.")
17248 (defvar org-tab-after-check-for-cycling-hook nil
17249 "Hook for functions to attach themselves to TAB.
17250 See `org-ctrl-c-ctrl-c-hook' for more information.
17251 This hook runs after it has been established that not table field motion and
17252 not visibility should be done because of current context. This is probably
17253 the place where a package like yasnippets can hook in.")
17255 (defvar org-tab-before-tab-emulation-hook nil
17256 "Hook for functions to attach themselves to TAB.
17257 See `org-ctrl-c-ctrl-c-hook' for more information.
17258 This hook runs after every other options for TAB have been exhausted, but
17261 (defvar org-metaleft-hook nil
17262 "Hook for functions attaching themselves to `M-left'.
17263 See `org-ctrl-c-ctrl-c-hook' for more information.")
17264 (defvar org-metaright-hook nil
17265 "Hook for functions attaching themselves to `M-right'.
17266 See `org-ctrl-c-ctrl-c-hook' for more information.")
17267 (defvar org-metaup-hook nil
17268 "Hook for functions attaching themselves to `M-up'.
17269 See `org-ctrl-c-ctrl-c-hook' for more information.")
17270 (defvar org-metadown-hook nil
17271 "Hook for functions attaching themselves to `M-down'.
17272 See `org-ctrl-c-ctrl-c-hook' for more information.")
17273 (defvar org-shiftmetaleft-hook nil
17274 "Hook for functions attaching themselves to `M-S-left'.
17275 See `org-ctrl-c-ctrl-c-hook' for more information.")
17276 (defvar org-shiftmetaright-hook nil
17277 "Hook for functions attaching themselves to `M-S-right'.
17278 See `org-ctrl-c-ctrl-c-hook' for more information.")
17279 (defvar org-shiftmetaup-hook nil
17280 "Hook for functions attaching themselves to `M-S-up'.
17281 See `org-ctrl-c-ctrl-c-hook' for more information.")
17282 (defvar org-shiftmetadown-hook nil
17283 "Hook for functions attaching themselves to `M-S-down'.
17284 See `org-ctrl-c-ctrl-c-hook' for more information.")
17285 (defvar org-metareturn-hook nil
17286 "Hook for functions attaching themselves to `M-RET'.
17287 See `org-ctrl-c-ctrl-c-hook' for more information.")
17288 (defvar org-shiftup-hook nil
17289 "Hook for functions attaching themselves to `S-up'.
17290 See `org-ctrl-c-ctrl-c-hook' for more information.")
17291 (defvar org-shiftup-final-hook nil
17292 "Hook for functions attaching themselves to `S-up'.
17293 This one runs after all other options except shift-select have been excluded.
17294 See `org-ctrl-c-ctrl-c-hook' for more information.")
17295 (defvar org-shiftdown-hook nil
17296 "Hook for functions attaching themselves to `S-down'.
17297 See `org-ctrl-c-ctrl-c-hook' for more information.")
17298 (defvar org-shiftdown-final-hook nil
17299 "Hook for functions attaching themselves to `S-down'.
17300 This one runs after all other options except shift-select have been excluded.
17301 See `org-ctrl-c-ctrl-c-hook' for more information.")
17302 (defvar org-shiftleft-hook nil
17303 "Hook for functions attaching themselves to `S-left'.
17304 See `org-ctrl-c-ctrl-c-hook' for more information.")
17305 (defvar org-shiftleft-final-hook nil
17306 "Hook for functions attaching themselves to `S-left'.
17307 This one runs after all other options except shift-select have been excluded.
17308 See `org-ctrl-c-ctrl-c-hook' for more information.")
17309 (defvar org-shiftright-hook nil
17310 "Hook for functions attaching themselves to `S-right'.
17311 See `org-ctrl-c-ctrl-c-hook' for more information.")
17312 (defvar org-shiftright-final-hook nil
17313 "Hook for functions attaching themselves to `S-right'.
17314 This one runs after all other options except shift-select have been excluded.
17315 See `org-ctrl-c-ctrl-c-hook' for more information.")
17317 (defun org-modifier-cursor-error ()
17318 "Throw an error, a modified cursor command was applied in wrong context."
17319 (error "This command is active in special context like tables, headlines or items"))
17321 (defun org-shiftselect-error ()
17322 "Throw an error because Shift-Cursor command was applied in wrong context."
17323 (if (and (boundp 'shift-select-mode) shift-select-mode)
17324 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17325 (error "This command works only in special context like headlines or timestamps")))
17327 (defun org-call-for-shift-select (cmd)
17328 (let ((this-command-keys-shift-translated t))
17329 (call-interactively cmd)))
17331 (defun org-shifttab (&optional arg)
17332 "Global visibility cycling or move to previous table field.
17333 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17334 on context.
17335 See the individual commands for more information."
17336 (interactive "P")
17337 (cond
17338 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17339 ((integerp arg)
17340 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17341 (message "Content view to level: %d" arg)
17342 (org-content (prefix-numeric-value arg2))
17343 (setq org-cycle-global-status 'overview)))
17344 (t (call-interactively 'org-global-cycle))))
17346 (defun org-shiftmetaleft ()
17347 "Promote subtree or delete table column.
17348 Calls `org-promote-subtree', `org-outdent-item',
17349 or `org-table-delete-column', depending on context.
17350 See the individual commands for more information."
17351 (interactive)
17352 (cond
17353 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17354 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17355 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17356 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17357 (t (org-modifier-cursor-error))))
17359 (defun org-shiftmetaright ()
17360 "Demote subtree or insert table column.
17361 Calls `org-demote-subtree', `org-indent-item',
17362 or `org-table-insert-column', depending on context.
17363 See the individual commands for more information."
17364 (interactive)
17365 (cond
17366 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17367 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17368 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17369 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17370 (t (org-modifier-cursor-error))))
17372 (defun org-shiftmetaup (&optional arg)
17373 "Move subtree up or kill table row.
17374 Calls `org-move-subtree-up' or `org-table-kill-row' or
17375 `org-move-item-up' depending on context. See the individual commands
17376 for more information."
17377 (interactive "P")
17378 (cond
17379 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17380 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17381 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17382 ((org-at-item-p) (call-interactively 'org-move-item-up))
17383 (t (org-modifier-cursor-error))))
17385 (defun org-shiftmetadown (&optional arg)
17386 "Move subtree down or insert table row.
17387 Calls `org-move-subtree-down' or `org-table-insert-row' or
17388 `org-move-item-down', depending on context. See the individual
17389 commands for more information."
17390 (interactive "P")
17391 (cond
17392 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17393 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17394 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17395 ((org-at-item-p) (call-interactively 'org-move-item-down))
17396 (t (org-modifier-cursor-error))))
17398 (defsubst org-hidden-tree-error ()
17399 (error
17400 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17402 (defun org-metaleft (&optional arg)
17403 "Promote heading or move table column to left.
17404 Calls `org-do-promote' or `org-table-move-column', depending on context.
17405 With no specific context, calls the Emacs default `backward-word'.
17406 See the individual commands for more information."
17407 (interactive "P")
17408 (cond
17409 ((run-hook-with-args-until-success 'org-metaleft-hook))
17410 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17411 ((org-with-limited-levels
17412 (or (org-on-heading-p)
17413 (and (org-region-active-p)
17414 (save-excursion
17415 (goto-char (region-beginning))
17416 (org-on-heading-p)))))
17417 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17418 (call-interactively 'org-do-promote))
17419 ;; At an inline task.
17420 ((org-on-heading-p)
17421 (call-interactively 'org-inlinetask-promote))
17422 ((or (org-at-item-p)
17423 (and (org-region-active-p)
17424 (save-excursion
17425 (goto-char (region-beginning))
17426 (org-at-item-p))))
17427 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17428 (call-interactively 'org-outdent-item))
17429 (t (call-interactively 'backward-word))))
17431 (defun org-metaright (&optional arg)
17432 "Demote subtree or move table column to right.
17433 Calls `org-do-demote' or `org-table-move-column', depending on context.
17434 With no specific context, calls the Emacs default `forward-word'.
17435 See the individual commands for more information."
17436 (interactive "P")
17437 (cond
17438 ((run-hook-with-args-until-success 'org-metaright-hook))
17439 ((org-at-table-p) (call-interactively 'org-table-move-column))
17440 ((org-with-limited-levels
17441 (or (org-on-heading-p)
17442 (and (org-region-active-p)
17443 (save-excursion
17444 (goto-char (region-beginning))
17445 (org-on-heading-p)))))
17446 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17447 (call-interactively 'org-do-demote))
17448 ;; At an inline task.
17449 ((org-on-heading-p)
17450 (call-interactively 'org-inlinetask-demote))
17451 ((or (org-at-item-p)
17452 (and (org-region-active-p)
17453 (save-excursion
17454 (goto-char (region-beginning))
17455 (org-at-item-p))))
17456 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17457 (call-interactively 'org-indent-item))
17458 (t (call-interactively 'forward-word))))
17460 (defun org-check-for-hidden (what)
17461 "Check if there are hidden headlines/items in the current visual line.
17462 WHAT can be either `headlines' or `items'. If the current line is
17463 an outline or item heading and it has a folded subtree below it,
17464 this function returns t, nil otherwise."
17465 (let ((re (cond
17466 ((eq what 'headlines) org-outline-regexp-bol)
17467 ((eq what 'items) (org-item-beginning-re))
17468 (t (error "This should not happen"))))
17469 beg end)
17470 (save-excursion
17471 (catch 'exit
17472 (unless (org-region-active-p)
17473 (setq beg (point-at-bol))
17474 (beginning-of-line 2)
17475 (while (and (not (eobp)) ;; this is like `next-line'
17476 (get-char-property (1- (point)) 'invisible))
17477 (beginning-of-line 2))
17478 (setq end (point))
17479 (goto-char beg)
17480 (goto-char (point-at-eol))
17481 (setq end (max end (point)))
17482 (while (re-search-forward re end t)
17483 (if (get-char-property (match-beginning 0) 'invisible)
17484 (throw 'exit t))))
17485 nil))))
17487 (defun org-metaup (&optional arg)
17488 "Move subtree up or move table row up.
17489 Calls `org-move-subtree-up' or `org-table-move-row' or
17490 `org-move-item-up', depending on context. See the individual commands
17491 for more information."
17492 (interactive "P")
17493 (cond
17494 ((run-hook-with-args-until-success 'org-metaup-hook))
17495 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17496 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17497 ((org-at-item-p) (call-interactively 'org-move-item-up))
17498 (t (transpose-lines 1) (beginning-of-line -1))))
17500 (defun org-metadown (&optional arg)
17501 "Move subtree down or move table row down.
17502 Calls `org-move-subtree-down' or `org-table-move-row' or
17503 `org-move-item-down', depending on context. See the individual
17504 commands for more information."
17505 (interactive "P")
17506 (cond
17507 ((run-hook-with-args-until-success 'org-metadown-hook))
17508 ((org-at-table-p) (call-interactively 'org-table-move-row))
17509 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17510 ((org-at-item-p) (call-interactively 'org-move-item-down))
17511 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17513 (defun org-shiftup (&optional arg)
17514 "Increase item in timestamp or increase priority of current headline.
17515 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17516 depending on context. See the individual commands for more information."
17517 (interactive "P")
17518 (cond
17519 ((run-hook-with-args-until-success 'org-shiftup-hook))
17520 ((and org-support-shift-select (org-region-active-p))
17521 (org-call-for-shift-select 'previous-line))
17522 ((org-at-timestamp-p t)
17523 (call-interactively (if org-edit-timestamp-down-means-later
17524 'org-timestamp-down 'org-timestamp-up)))
17525 ((and (not (eq org-support-shift-select 'always))
17526 org-enable-priority-commands
17527 (org-on-heading-p))
17528 (call-interactively 'org-priority-up))
17529 ((and (not org-support-shift-select) (org-at-item-p))
17530 (call-interactively 'org-previous-item))
17531 ((org-clocktable-try-shift 'up arg))
17532 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17533 (org-support-shift-select
17534 (org-call-for-shift-select 'previous-line))
17535 (t (org-shiftselect-error))))
17537 (defun org-shiftdown (&optional arg)
17538 "Decrease item in timestamp or decrease priority of current headline.
17539 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17540 depending on context. See the individual commands for more information."
17541 (interactive "P")
17542 (cond
17543 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17544 ((and org-support-shift-select (org-region-active-p))
17545 (org-call-for-shift-select 'next-line))
17546 ((org-at-timestamp-p t)
17547 (call-interactively (if org-edit-timestamp-down-means-later
17548 'org-timestamp-up 'org-timestamp-down)))
17549 ((and (not (eq org-support-shift-select 'always))
17550 org-enable-priority-commands
17551 (org-on-heading-p))
17552 (call-interactively 'org-priority-down))
17553 ((and (not org-support-shift-select) (org-at-item-p))
17554 (call-interactively 'org-next-item))
17555 ((org-clocktable-try-shift 'down arg))
17556 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17557 (org-support-shift-select
17558 (org-call-for-shift-select 'next-line))
17559 (t (org-shiftselect-error))))
17561 (defun org-shiftright (&optional arg)
17562 "Cycle the thing at point or in the current line, depending on context.
17563 Depending on context, this does one of the following:
17565 - switch a timestamp at point one day into the future
17566 - on a headline, switch to the next TODO keyword.
17567 - on an item, switch entire list to the next bullet type
17568 - on a property line, switch to the next allowed value
17569 - on a clocktable definition line, move time block into the future"
17570 (interactive "P")
17571 (cond
17572 ((run-hook-with-args-until-success 'org-shiftright-hook))
17573 ((and org-support-shift-select (org-region-active-p))
17574 (org-call-for-shift-select 'forward-char))
17575 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17576 ((and (not (eq org-support-shift-select 'always))
17577 (org-on-heading-p))
17578 (let ((org-inhibit-logging
17579 (not org-treat-S-cursor-todo-selection-as-state-change))
17580 (org-inhibit-blocking
17581 (not org-treat-S-cursor-todo-selection-as-state-change)))
17582 (org-call-with-arg 'org-todo 'right)))
17583 ((or (and org-support-shift-select
17584 (not (eq org-support-shift-select 'always))
17585 (org-at-item-bullet-p))
17586 (and (not org-support-shift-select) (org-at-item-p)))
17587 (org-call-with-arg 'org-cycle-list-bullet nil))
17588 ((and (not (eq org-support-shift-select 'always))
17589 (org-at-property-p))
17590 (call-interactively 'org-property-next-allowed-value))
17591 ((org-clocktable-try-shift 'right arg))
17592 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17593 (org-support-shift-select
17594 (org-call-for-shift-select 'forward-char))
17595 (t (org-shiftselect-error))))
17597 (defun org-shiftleft (&optional arg)
17598 "Cycle the thing at point or in the current line, depending on context.
17599 Depending on context, this does one of the following:
17601 - switch a timestamp at point one day into the past
17602 - on a headline, switch to the previous TODO keyword.
17603 - on an item, switch entire list to the previous bullet type
17604 - on a property line, switch to the previous allowed value
17605 - on a clocktable definition line, move time block into the past"
17606 (interactive "P")
17607 (cond
17608 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17609 ((and org-support-shift-select (org-region-active-p))
17610 (org-call-for-shift-select 'backward-char))
17611 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17612 ((and (not (eq org-support-shift-select 'always))
17613 (org-on-heading-p))
17614 (let ((org-inhibit-logging
17615 (not org-treat-S-cursor-todo-selection-as-state-change))
17616 (org-inhibit-blocking
17617 (not org-treat-S-cursor-todo-selection-as-state-change)))
17618 (org-call-with-arg 'org-todo 'left)))
17619 ((or (and org-support-shift-select
17620 (not (eq org-support-shift-select 'always))
17621 (org-at-item-bullet-p))
17622 (and (not org-support-shift-select) (org-at-item-p)))
17623 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17624 ((and (not (eq org-support-shift-select 'always))
17625 (org-at-property-p))
17626 (call-interactively 'org-property-previous-allowed-value))
17627 ((org-clocktable-try-shift 'left arg))
17628 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17629 (org-support-shift-select
17630 (org-call-for-shift-select 'backward-char))
17631 (t (org-shiftselect-error))))
17633 (defun org-shiftcontrolright ()
17634 "Switch to next TODO set."
17635 (interactive)
17636 (cond
17637 ((and org-support-shift-select (org-region-active-p))
17638 (org-call-for-shift-select 'forward-word))
17639 ((and (not (eq org-support-shift-select 'always))
17640 (org-on-heading-p))
17641 (org-call-with-arg 'org-todo 'nextset))
17642 (org-support-shift-select
17643 (org-call-for-shift-select 'forward-word))
17644 (t (org-shiftselect-error))))
17646 (defun org-shiftcontrolleft ()
17647 "Switch to previous TODO set."
17648 (interactive)
17649 (cond
17650 ((and org-support-shift-select (org-region-active-p))
17651 (org-call-for-shift-select 'backward-word))
17652 ((and (not (eq org-support-shift-select 'always))
17653 (org-on-heading-p))
17654 (org-call-with-arg 'org-todo 'previousset))
17655 (org-support-shift-select
17656 (org-call-for-shift-select 'backward-word))
17657 (t (org-shiftselect-error))))
17659 (defun org-shiftcontrolup ()
17660 "Change timestamps synchronously up in CLOCK log lines."
17661 (interactive)
17662 (cond ((and (not org-support-shift-select)
17663 (org-at-clock-log-p)
17664 (org-at-timestamp-p t))
17665 (org-clock-timestamps-up))
17666 (t (org-shiftselect-error))))
17668 (defun org-shiftcontroldown ()
17669 "Change timestamps synchronously down in CLOCK log lines."
17670 (interactive)
17671 (cond ((and (not org-support-shift-select)
17672 (org-at-clock-log-p)
17673 (org-at-timestamp-p t))
17674 (org-clock-timestamps-down))
17675 (t (org-shiftselect-error))))
17677 (defun org-ctrl-c-ret ()
17678 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17679 (interactive)
17680 (cond
17681 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17682 (t (call-interactively 'org-insert-heading))))
17684 (defun org-copy-visible (beg end)
17685 "Copy the visible parts of the region."
17686 (interactive "r")
17687 (let (snippets s)
17688 (save-excursion
17689 (save-restriction
17690 (narrow-to-region beg end)
17691 (setq s (goto-char (point-min)))
17692 (while (not (= (point) (point-max)))
17693 (goto-char (org-find-invisible))
17694 (push (buffer-substring s (point)) snippets)
17695 (setq s (goto-char (org-find-visible))))))
17696 (kill-new (apply 'concat (nreverse snippets)))))
17698 (defun org-copy-special ()
17699 "Copy region in table or copy current subtree.
17700 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17701 See the individual commands for more information."
17702 (interactive)
17703 (call-interactively
17704 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17706 (defun org-cut-special ()
17707 "Cut region in table or cut current subtree.
17708 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17709 See the individual commands for more information."
17710 (interactive)
17711 (call-interactively
17712 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17714 (defun org-paste-special (arg)
17715 "Paste rectangular region into table, or past subtree relative to level.
17716 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17717 See the individual commands for more information."
17718 (interactive "P")
17719 (if (org-at-table-p)
17720 (org-table-paste-rectangle)
17721 (org-paste-subtree arg)))
17723 (defun org-edit-special (&optional arg)
17724 "Call a special editor for the stuff at point.
17725 When at a table, call the formula editor with `org-table-edit-formulas'.
17726 When at the first line of an src example, call `org-edit-src-code'.
17727 When in an #+include line, visit the include file. Otherwise call
17728 `ffap' to visit the file at point."
17729 (interactive)
17730 ;; possibly prep session before editing source
17731 (when arg
17732 (let* ((info (org-babel-get-src-block-info))
17733 (lang (nth 0 info))
17734 (params (nth 2 info))
17735 (session (cdr (assoc :session params))))
17736 (when (and info session) ;; we are in a source-code block with a session
17737 (funcall
17738 (intern (concat "org-babel-prep-session:" lang)) session params))))
17739 (cond ;; proceed with `org-edit-special'
17740 ((save-excursion
17741 (beginning-of-line 1)
17742 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17743 (find-file (org-trim (match-string 1))))
17744 ((org-edit-src-code))
17745 ((org-edit-fixed-width-region))
17746 ((org-at-table.el-p)
17747 (org-edit-src-code))
17748 ((or (org-at-table-p)
17749 (save-excursion
17750 (beginning-of-line 1)
17752 (call-interactively 'org-table-edit-formulas))
17753 (t (call-interactively 'ffap))))
17755 (defun org-ctrl-c-ctrl-c (&optional arg)
17756 "Set tags in headline, or update according to changed information at point.
17758 This command does many different things, depending on context:
17760 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17761 this is what we do.
17763 - If the cursor is on a statistics cookie, update it.
17765 - If the cursor is in a headline, prompt for tags and insert them
17766 into the current line, aligned to `org-tags-column'. When called
17767 with prefix arg, realign all tags in the current buffer.
17769 - If the cursor is in one of the special #+KEYWORD lines, this
17770 triggers scanning the buffer for these lines and updating the
17771 information.
17773 - If the cursor is inside a table, realign the table. This command
17774 works even if the automatic table editor has been turned off.
17776 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17777 the entire table.
17779 - If the cursor is at a footnote reference or definition, jump to
17780 the corresponding definition or references, respectively.
17782 - If the cursor is a the beginning of a dynamic block, update it.
17784 - If the current buffer is a capture buffer, close note and file it.
17786 - If the cursor is on a <<<target>>>, update radio targets and
17787 corresponding links in this buffer.
17789 - If the cursor is on a numbered item in a plain list, renumber the
17790 ordered list.
17792 - If the cursor is on a checkbox, toggle it.
17794 - If the cursor is on a code block, evaluate it. The variable
17795 `org-confirm-babel-evaluate' can be used to control prompting
17796 before code block evaluation, by default every code block
17797 evaluation requires confirmation. Code block evaluation can be
17798 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17799 (interactive "P")
17800 (let ((org-enable-table-editor t))
17801 (cond
17802 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17803 org-occur-highlights
17804 org-latex-fragment-image-overlays)
17805 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17806 (org-remove-occur-highlights)
17807 (org-remove-latex-fragment-image-overlays)
17808 (message "Temporary highlights/overlays removed from current buffer"))
17809 ((and (local-variable-p 'org-finish-function (current-buffer))
17810 (fboundp org-finish-function))
17811 (funcall org-finish-function))
17812 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17813 ((or (looking-at org-property-start-re)
17814 (org-at-property-p))
17815 (call-interactively 'org-property-action))
17816 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17818 (or (org-on-heading-p) (org-at-item-p)))
17819 (call-interactively 'org-update-statistics-cookies))
17820 ((org-on-heading-p) (call-interactively 'org-set-tags))
17821 ((org-at-table.el-p)
17822 (message "Use C-c ' to edit table.el tables"))
17823 ((org-at-table-p)
17824 (org-table-maybe-eval-formula)
17825 (if arg
17826 (call-interactively 'org-table-recalculate)
17827 (org-table-maybe-recalculate-line))
17828 (call-interactively 'org-table-align)
17829 (orgtbl-send-table 'maybe))
17830 ((or (org-footnote-at-reference-p)
17831 (org-footnote-at-definition-p))
17832 (call-interactively 'org-footnote-action))
17833 ((org-at-item-checkbox-p)
17834 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17835 ;; list only if at top item.
17836 (let* ((cbox (match-string 1))
17837 (struct (org-list-struct))
17838 (old-struct (copy-tree struct))
17839 (parents (org-list-parents-alist struct))
17840 (prevs (org-list-prevs-alist struct))
17841 (orderedp (org-entry-get nil "ORDERED"))
17842 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17843 block-item)
17844 ;; Use a light version of `org-toggle-checkbox' to avoid
17845 ;; computing list structure twice.
17846 (org-list-set-checkbox (point-at-bol) struct
17847 (cond
17848 ((equal arg '(16)) "[-]")
17849 ((equal arg '(4)) nil)
17850 ((equal "[X]" cbox) "[ ]")
17851 (t "[X]")))
17852 (org-list-struct-fix-ind struct parents)
17853 (org-list-struct-fix-bul struct prevs)
17854 (setq block-item
17855 (org-list-struct-fix-box struct parents prevs orderedp))
17856 (when block-item
17857 (message
17858 "Checkboxes were removed due to unchecked box at line %d"
17859 (org-current-line block-item)))
17860 (org-list-struct-apply-struct struct old-struct)
17861 (org-update-checkbox-count-maybe)
17862 (when firstp (org-list-send-list 'maybe))))
17863 ((org-at-item-p)
17864 ;; Cursor at an item: repair list. Do checkbox related actions
17865 ;; only if function was called with an argument. Send list only
17866 ;; if at top item.
17867 (let* ((struct (org-list-struct))
17868 (old-struct (copy-tree struct))
17869 (parents (org-list-parents-alist struct))
17870 (prevs (org-list-prevs-alist struct))
17871 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17872 (org-list-struct-fix-ind struct parents)
17873 (org-list-struct-fix-bul struct prevs)
17874 (when arg
17875 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17876 (org-list-struct-fix-box struct parents prevs))
17877 (org-list-struct-apply-struct struct old-struct)
17878 (when arg (org-update-checkbox-count-maybe))
17879 (when firstp (org-list-send-list 'maybe))))
17880 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17881 ;; Dynamic block
17882 (beginning-of-line 1)
17883 (save-excursion (org-update-dblock)))
17884 ((save-excursion
17885 (beginning-of-line 1)
17887 (cond
17888 ((equal (match-string 1) "TBLFM")
17889 ;; Recalculate the table before this line
17890 (save-excursion
17891 (beginning-of-line 1)
17893 (if (org-at-table-p)
17894 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17895 (t
17896 (let ((org-inhibit-startup-visibility-stuff t)
17897 (org-startup-align-all-tables nil))
17898 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17899 (message "Local setup has been refreshed"))))
17900 ((org-clock-update-time-maybe))
17901 (t
17902 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17903 (error "C-c C-c can do nothing useful at this location"))))))
17905 (defun org-mode-restart ()
17906 "Restart Org-mode, to scan again for special lines.
17907 Also updates the keyword regular expressions."
17908 (interactive)
17909 (org-mode)
17910 (message "Org-mode restarted"))
17912 (defun org-kill-note-or-show-branches ()
17913 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17914 (interactive)
17915 (if (not org-finish-function)
17916 (progn
17917 (hide-subtree)
17918 (call-interactively 'show-branches))
17919 (let ((org-note-abort t))
17920 (funcall org-finish-function))))
17922 (defun org-return (&optional indent)
17923 "Goto next table row or insert a newline.
17924 Calls `org-table-next-row' or `newline', depending on context.
17925 See the individual commands for more information."
17926 (interactive)
17927 (cond
17928 ((bobp) (if indent (newline-and-indent) (newline)))
17929 ((org-at-table-p)
17930 (org-table-justify-field-maybe)
17931 (call-interactively 'org-table-next-row))
17932 ;; when `newline-and-indent' is called within a list, make sure
17933 ;; text moved stays inside the item.
17934 ((and (org-in-item-p) indent)
17935 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17936 (progn
17937 (newline)
17938 (org-indent-line-to (length (match-string 0))))
17939 (let ((ind (org-get-indentation)))
17940 (newline)
17941 (if (org-looking-back org-list-end-re)
17942 (org-indent-line-function)
17943 (org-indent-line-to ind)))))
17944 ((and org-return-follows-link
17945 (eq (get-text-property (point) 'face) 'org-link))
17946 (call-interactively 'org-open-at-point))
17947 ((and (org-at-heading-p)
17948 (looking-at
17950 (org-show-entry)
17951 (end-of-line 1)
17952 (newline))
17953 (t (if indent (newline-and-indent) (newline)))))
17955 (defun org-return-indent ()
17956 "Goto next table row or insert a newline and indent.
17957 Calls `org-table-next-row' or `newline-and-indent', depending on
17958 context. See the individual commands for more information."
17959 (interactive)
17960 (org-return t))
17962 (defun org-ctrl-c-star ()
17963 "Compute table, or change heading status of lines.
17964 Calls `org-table-recalculate' or `org-toggle-heading',
17965 depending on context."
17966 (interactive)
17967 (cond
17968 ((org-at-table-p)
17969 (call-interactively 'org-table-recalculate))
17970 (t
17971 ;; Convert all lines in region to list items
17972 (call-interactively 'org-toggle-heading))))
17974 (defun org-ctrl-c-minus ()
17975 "Insert separator line in table or modify bullet status of line.
17976 Also turns a plain line or a region of lines into list items.
17977 Calls `org-table-insert-hline', `org-toggle-item', or
17978 `org-cycle-list-bullet', depending on context."
17979 (interactive)
17980 (cond
17981 ((org-at-table-p)
17982 (call-interactively 'org-table-insert-hline))
17983 ((org-region-active-p)
17984 (call-interactively 'org-toggle-item))
17985 ((org-in-item-p)
17986 (call-interactively 'org-cycle-list-bullet))
17987 (t
17988 (call-interactively 'org-toggle-item))))
17990 (defun org-toggle-item (arg)
17991 "Convert headings or normal lines to items, items to normal lines.
17992 If there is no active region, only the current line is considered.
17994 If the first non blank line in the region is an headline, convert
17995 all headlines to items, shifting text accordingly.
17997 If it is an item, convert all items to normal lines.
17999 If it is normal text, change region into an item. With a prefix
18000 argument ARG, change each line in region into an item."
18001 (interactive "P")
18002 (let ((shift-text
18003 (function
18004 ;; Shift text in current section to IND, from point to END.
18005 ;; The function leaves point to END line.
18006 (lambda (ind end)
18007 (let ((min-i 1000) (end (copy-marker end)))
18008 ;; First determine the minimum indentation (MIN-I) of
18009 ;; the text.
18010 (save-excursion
18011 (catch 'exit
18012 (while (< (point) end)
18013 (let ((i (org-get-indentation)))
18014 (cond
18015 ;; Skip blank lines and inline tasks.
18017 ((looking-at org-outline-regexp-bol))
18018 ;; We can't find less than 0 indentation.
18019 ((zerop i) (throw 'exit (setq min-i 0)))
18020 ((< i min-i) (setq min-i i))))
18021 (forward-line))))
18022 ;; Then indent each line so that a line indented to
18023 ;; MIN-I becomes indented to IND. Ignore blank lines
18024 ;; and inline tasks in the process.
18025 (let ((delta (- ind min-i)))
18026 (while (< (point) end)
18028 (looking-at org-outline-regexp-bol))
18029 (org-indent-line-to (+ (org-get-indentation) delta)))
18030 (forward-line)))))))
18031 (skip-blanks
18032 (function
18033 ;; Return beginning of first non-blank line, starting from
18034 ;; line at POS.
18035 (lambda (pos)
18036 (save-excursion
18037 (goto-char pos)
18039 (point-at-bol)))))
18040 beg end)
18041 ;; Determine boundaries of changes.
18042 (if (org-region-active-p)
18043 (setq beg (funcall skip-blanks (region-beginning))
18044 end (copy-marker (region-end)))
18045 (setq beg (funcall skip-blanks (point-at-bol))
18046 end (copy-marker (point-at-eol))))
18047 ;; Depending on the starting line, choose an action on the text
18048 ;; between BEG and END.
18049 (org-with-limited-levels
18050 (save-excursion
18051 (goto-char beg)
18052 (cond
18053 ;; Case 1. Start at an item: de-itemize. Note that it only
18054 ;; happens when a region is active: `org-ctrl-c-minus'
18055 ;; would call `org-cycle-list-bullet' otherwise.
18056 ((org-at-item-p)
18057 (while (< (point) end)
18058 (when (org-at-item-p)
18060 (delete-region (point) (match-end 0)))
18061 (forward-line)))
18062 ;; Case 2. Start at an heading: convert to items.
18063 ((org-on-heading-p)
18064 (let* ((bul (org-list-bullet-string "-"))
18065 (bul-len (length bul))
18066 ;; Indentation of the first heading. It should be
18067 ;; relative to the indentation of its parent, if any.
18068 (start-ind (save-excursion
18069 (cond
18070 ((not org-adapt-indentation) 0)
18071 ((not (outline-previous-heading)) 0)
18072 (t (length (match-string 0))))))
18073 ;; Level of first heading. Further headings will be
18074 ;; compared to it to determine hierarchy in the list.
18075 (ref-level (org-reduced-level (org-outline-level))))
18076 (while (< (point) end)
18077 (let* ((level (org-reduced-level (org-outline-level)))
18078 (delta (max 0 (- level ref-level))))
18079 ;; If current headline is less indented than the first
18080 ;; one, set it as reference, in order to preserve
18081 ;; subtrees.
18082 (when (< level ref-level) (setq ref-level level))
18083 (replace-match bul t t)
18084 (org-indent-line-to (+ start-ind (* delta bul-len)))
18085 ;; Ensure all text down to END (or SECTION-END) belongs
18086 ;; to the newly created item.
18087 (let ((section-end (save-excursion
18088 (or (outline-next-heading) (point)))))
18089 (forward-line)
18090 (funcall shift-text
18091 (+ start-ind (* (1+ delta) bul-len))
18092 (min end section-end)))))))
18093 ;; Case 3. Normal line with ARG: turn each non-item line into
18094 ;; an item.
18095 (arg
18096 (while (< (point) end)
18097 (unless (or (org-on-heading-p) (org-at-item-p))
18099 (replace-match
18101 (forward-line)))
18102 ;; Case 4. Normal line without ARG: make the first line of
18103 ;; region an item, and shift indentation of others
18104 ;; lines to set them as item's body.
18105 (t (let* ((bul (org-list-bullet-string "-"))
18106 (bul-len (length bul))
18107 (ref-ind (org-get-indentation)))
18109 (insert bul)
18110 (forward-line)
18111 (while (< (point) end)
18112 ;; Ensure that lines less indented than first one
18113 ;; still get included in item body.
18114 (funcall shift-text
18115 (+ ref-ind bul-len)
18116 (min end (save-excursion (or (outline-next-heading)
18117 (point)))))
18118 (forward-line)))))))))
18120 (defun org-toggle-heading (&optional nstars)
18121 "Convert headings to normal text, or items or text to headings.
18122 If there is no active region, only the current line is considered.
18124 If the first non blank line is an headline, remove the stars from
18125 all headlines in the region.
18127 If it is a plain list item, turn all plain list items into headings.
18129 If it is a normal line, turn each and every normal line (i.e. not
18130 an heading or an item) in the region into a heading.
18132 When converting a line into a heading, the number of stars is chosen
18133 such that the lines become children of the current entry. However,
18134 when a prefix argument is given, its value determines the number of
18135 stars to add."
18136 (interactive "P")
18137 (let ((skip-blanks
18138 (function
18139 ;; Return beginning of first non-blank line, starting from
18140 ;; line at POS.
18141 (lambda (pos)
18142 (save-excursion
18143 (goto-char pos)
18145 (point-at-bol)))))
18146 beg end)
18147 ;; Determine boundaries of changes. If region ends at a bol, do
18148 ;; not consider the last line to be in the region.
18149 (if (org-region-active-p)
18150 (setq beg (funcall skip-blanks (region-beginning))
18151 end (copy-marker (save-excursion
18152 (goto-char (region-end))
18153 (if (bolp) (point) (point-at-eol)))))
18154 (setq beg (funcall skip-blanks (point-at-bol))
18155 end (copy-marker (point-at-eol))))
18156 ;; Ensure inline tasks don't count as headings.
18157 (org-with-limited-levels
18158 (save-excursion
18159 (goto-char beg)
18160 (cond
18161 ;; Case 1. Started at an heading: de-star headings.
18162 ((org-on-heading-p)
18163 (while (< (point) end)
18164 (when (org-on-heading-p t)
18165 (looking-at org-outline-regexp) (replace-match ""))
18166 (forward-line)))
18167 ;; Case 2. Started at an item: change items into headlines.
18168 ;; One star will be added by `org-list-to-subtree'.
18169 ((org-at-item-p)
18170 (let* ((stars (make-string
18171 (if nstars
18172 ;; subtract the star that will be added again by
18173 ;; `org-list-to-subtree'
18174 (1- (prefix-numeric-value current-prefix-arg))
18175 (or (org-current-level) 0))
18176 ?*))
18177 (add-stars
18178 (cond (nstars "") ; stars from prefix only
18179 ((equal stars "") "") ; before first heading
18180 (org-odd-levels-only "*") ; inside heading, odd
18181 (t "")))) ; inside heading, oddeven
18182 (while (< (point) end)
18183 (when (org-at-item-p)
18184 ;; Pay attention to cases when region ends before list.
18185 (let* ((struct (org-list-struct))
18186 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18187 (save-restriction
18188 (narrow-to-region (point) list-end)
18189 (insert
18190 (org-list-to-subtree
18191 (org-list-parse-list t)
18192 '(:istart (concat stars add-stars (funcall get-stars depth))
18193 :icount (concat stars add-stars (funcall get-stars depth))))))))
18194 (forward-line))))
18195 ;; Case 3. Started at normal text: make every line an heading,
18196 ;; skipping headlines and items.
18197 (t (let* ((stars (make-string
18198 (if nstars
18199 (prefix-numeric-value current-prefix-arg)
18200 (or (org-current-level) 0))
18201 ?*))
18202 (add-stars
18203 (cond (nstars "") ; stars from prefix only
18204 ((equal stars "") "*") ; before first heading
18205 (org-odd-levels-only "**") ; inside heading, odd
18206 (t "*"))) ; inside heading, oddeven
18207 (rpl (concat stars add-stars " ")))
18208 (while (< (point) end)
18209 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18211 (replace-match (concat rpl (match-string 2))))
18212 (forward-line)))))))))
18214 (defun org-meta-return (&optional arg)
18215 "Insert a new heading or wrap a region in a table.
18216 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18217 See the individual commands for more information."
18218 (interactive "P")
18219 (cond
18220 ((run-hook-with-args-until-success 'org-metareturn-hook))
18221 ((org-at-table-p)
18222 (call-interactively 'org-table-wrap-region))
18223 (t (call-interactively 'org-insert-heading))))
18225 ;;; Menu entries
18227 ;; Define the Org-mode menus
18228 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18229 '("Tbl"
18230 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18231 ["Next Field" org-cycle (org-at-table-p)]
18232 ["Previous Field" org-shifttab (org-at-table-p)]
18233 ["Next Row" org-return (org-at-table-p)]
18234 "--"
18235 ["Blank Field" org-table-blank-field (org-at-table-p)]
18236 ["Edit Field" org-table-edit-field (org-at-table-p)]
18237 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18238 "--"
18239 ("Column"
18240 ["Move Column Left" org-metaleft (org-at-table-p)]
18241 ["Move Column Right" org-metaright (org-at-table-p)]
18242 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18243 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18244 ("Row"
18245 ["Move Row Up" org-metaup (org-at-table-p)]
18246 ["Move Row Down" org-metadown (org-at-table-p)]
18247 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18248 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18249 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18250 "--"
18251 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18252 ("Rectangle"
18253 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18254 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18255 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18256 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18257 "--"
18258 ("Calculate"
18259 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18260 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18261 ["Edit Formulas" org-edit-special (org-at-table-p)]
18262 "--"
18263 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18264 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18265 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18266 "--"
18267 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18268 "--"
18269 ["Sum Column/Rectangle" org-table-sum
18270 (or (org-at-table-p) (org-region-active-p))]
18271 ["Which Column?" org-table-current-column (org-at-table-p)])
18272 ["Debug Formulas"
18273 org-table-toggle-formula-debugger
18274 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18275 ["Show Col/Row Numbers"
18276 org-table-toggle-coordinate-overlays
18277 :style toggle
18278 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18279 "--"
18280 ["Create" org-table-create (and (not (org-at-table-p))
18281 org-enable-table-editor)]
18282 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18283 ["Import from File" org-table-import (not (org-at-table-p))]
18284 ["Export to File" org-table-export (org-at-table-p)]
18285 "--"
18286 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18288 (easy-menu-define org-org-menu org-mode-map "Org menu"
18289 '("Org"
18290 ("Show/Hide"
18291 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18292 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18293 ["Sparse Tree..." org-sparse-tree t]
18294 ["Reveal Context" org-reveal t]
18295 ["Show All" show-all t]
18296 "--"
18297 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18298 "--"
18299 ["New Heading" org-insert-heading t]
18300 ("Navigate Headings"
18301 ["Up" outline-up-heading t]
18302 ["Next" outline-next-visible-heading t]
18303 ["Previous" outline-previous-visible-heading t]
18304 ["Next Same Level" outline-forward-same-level t]
18305 ["Previous Same Level" outline-backward-same-level t]
18306 "--"
18307 ["Jump" org-goto t])
18308 ("Edit Structure"
18309 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18310 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18311 "--"
18312 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18313 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18314 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18315 "--"
18316 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18317 "--"
18318 ["Copy visible text" org-copy-visible t]
18319 "--"
18320 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18321 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18322 ["Demote Heading" org-metaright (not (org-at-table-p))]
18323 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18324 "--"
18325 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18326 "--"
18327 ["Convert to odd levels" org-convert-to-odd-levels t]
18328 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18329 ("Editing"
18330 ["Emphasis..." org-emphasize t]
18331 ["Edit Source Example" org-edit-special t]
18332 "--"
18333 ["Footnote new/jump" org-footnote-action t]
18334 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18335 ("Archive"
18336 ["Archive (default method)" org-archive-subtree-default t]
18337 "--"
18338 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18339 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18340 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18341 )
18342 "--"
18343 ("Hyperlinks"
18344 ["Store Link (Global)" org-store-link t]
18345 ["Find existing link to here" org-occur-link-in-agenda-files t]
18346 ["Insert Link" org-insert-link t]
18347 ["Follow Link" org-open-at-point t]
18348 "--"
18349 ["Next link" org-next-link t]
18350 ["Previous link" org-previous-link t]
18351 "--"
18352 ["Descriptive Links"
18353 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18354 :style radio
18355 :selected (member '(org-link) buffer-invisibility-spec)]
18356 ["Literal Links"
18357 (progn
18358 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18359 :style radio
18360 :selected (not (member '(org-link) buffer-invisibility-spec))])
18361 "--"
18362 ("TODO Lists"
18363 ["TODO/DONE/-" org-todo t]
18364 ("Select keyword"
18365 ["Next keyword" org-shiftright (org-on-heading-p)]
18366 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18367 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18368 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18369 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18370 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18371 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18372 "--"
18373 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18374 :selected org-enforce-todo-dependencies :style toggle :active t]
18375 "Settings for tree at point"
18376 ["Do Children sequentially" org-toggle-ordered-property :style radio
18377 :selected (org-entry-get nil "ORDERED")
18378 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18379 ["Do Children parallel" org-toggle-ordered-property :style radio
18380 :selected (not (org-entry-get nil "ORDERED"))
18381 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18382 "--"
18383 ["Set Priority" org-priority t]
18384 ["Priority Up" org-shiftup t]
18385 ["Priority Down" org-shiftdown t]
18386 "--"
18387 ["Get news from all feeds" org-feed-update-all t]
18388 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18389 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18390 ("TAGS and Properties"
18391 ["Set Tags" org-set-tags-command t]
18392 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18393 "--"
18394 ["Set property" org-set-property t]
18395 ["Column view of properties" org-columns t]
18396 ["Insert Column View DBlock" org-insert-columns-dblock t])
18397 ("Dates and Scheduling"
18398 ["Timestamp" org-time-stamp t]
18399 ["Timestamp (inactive)" org-time-stamp-inactive t]
18400 ("Change Date"
18401 ["1 Day Later" org-shiftright t]
18402 ["1 Day Earlier" org-shiftleft t]
18403 ["1 ... Later" org-shiftup t]
18404 ["1 ... Earlier" org-shiftdown t])
18405 ["Compute Time Range" org-evaluate-time-range t]
18406 ["Schedule Item" org-schedule t]
18407 ["Deadline" org-deadline t]
18408 "--"
18409 ["Custom time format" org-toggle-time-stamp-overlays
18410 :style radio :selected org-display-custom-times]
18411 "--"
18412 ["Goto Calendar" org-goto-calendar t]
18413 ["Date from Calendar" org-date-from-calendar t]
18414 "--"
18415 ["Start/Restart Timer" org-timer-start t]
18416 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18417 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18418 ["Insert Timer String" org-timer t]
18419 ["Insert Timer Item" org-timer-item t])
18420 ("Logging work"
18421 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18422 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18423 ["Clock out" org-clock-out t]
18424 ["Clock cancel" org-clock-cancel t]
18425 "--"
18426 ["Mark as default task" org-clock-mark-default-task t]
18427 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18428 ["Goto running clock" org-clock-goto t]
18429 "--"
18430 ["Display times" org-clock-display t]
18431 ["Create clock table" org-clock-report t]
18432 "--"
18433 ["Record DONE time"
18434 (progn (setq org-log-done (not org-log-done))
18435 (message "Switching to %s will %s record a timestamp"
18436 (car org-done-keywords)
18437 (if org-log-done "automatically" "not")))
18438 :style toggle :selected org-log-done])
18439 "--"
18440 ["Agenda Command..." org-agenda t]
18441 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18442 ("File List for Agenda")
18443 ("Special views current file"
18444 ["TODO Tree" org-show-todo-tree t]
18445 ["Check Deadlines" org-check-deadlines t]
18446 ["Timeline" org-timeline t]
18447 ["Tags/Property tree" org-match-sparse-tree t])
18448 "--"
18449 ["Export/Publish..." org-export t]
18450 ("LaTeX"
18451 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18452 :selected org-cdlatex-mode]
18453 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18454 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18455 ["Modify math symbol" org-cdlatex-math-modify
18456 (org-inside-LaTeX-fragment-p)]
18457 ["Insert citation" org-reftex-citation t]
18458 "--"
18459 ["Template for BEAMER" org-insert-beamer-options-template t])
18460 "--"
18461 ("MobileOrg"
18462 ["Push Files and Views" org-mobile-push t]
18463 ["Get Captured and Flagged" org-mobile-pull t]
18464 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18465 "--"
18466 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18467 "--"
18468 ("Documentation"
18469 ["Show Version" org-version t]
18470 ["Info Documentation" org-info t])
18471 ("Customize"
18472 ["Browse Org Group" org-customize t]
18473 "--"
18474 ["Expand This Menu" org-create-customize-menu
18475 (fboundp 'customize-menu-create)])
18476 ["Send bug report" org-submit-bug-report t]
18477 "--"
18478 ("Refresh/Reload"
18479 ["Refresh setup current buffer" org-mode-restart t]
18480 ["Reload Org (after update)" org-reload t]
18481 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18482 ))
18484 (defun org-info (&optional node)
18485 "Read documentation for Org-mode in the info system.
18486 With optional NODE, go directly to that node."
18487 (interactive)
18488 (info (format "(org)%s" (or node ""))))
18490 ;;;###autoload
18491 (defun org-submit-bug-report ()
18492 "Submit a bug report on Org-mode via mail.
18494 Don't hesitate to report any problems or inaccurate documentation.
18496 If you don't have setup sending mail from (X)Emacs, please copy the
18497 output buffer into your mail program, as it gives us important
18498 information about your Org-mode version and configuration."
18499 (interactive)
18500 (require 'reporter)
18501 (org-load-modules-maybe)
18502 (org-require-autoloaded-modules)
18503 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18504 (reporter-submit-bug-report
18505 "emacs-orgmode@gnu.org"
18506 (org-version)
18507 (let (list)
18508 (save-window-excursion
18509 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18510 (delete-other-windows)
18511 (erase-buffer)
18512 (insert "You are about to submit a bug report to the Org-mode mailing list.
18514 We would like to add your full Org-mode and Outline configuration to the
18515 bug report. This greatly simplifies the work of the maintainer and
18516 other experts on the mailing list.
18518 HOWEVER, some variables you have customized may contain private
18519 information. The names of customers, colleagues, or friends, might
18520 appear in the form of file names, tags, todo states, or search strings.
18521 If you answer yes to the prompt, you might want to check and remove
18522 such private information before sending the email.")
18523 (add-text-properties (point-min) (point-max) '(face org-warning))
18524 (when (yes-or-no-p "Include your Org-mode configuration ")
18525 (mapatoms
18526 (lambda (v)
18527 (and (boundp v)
18529 (or (and (symbol-value v)
18531 (and
18532 (get v 'custom-type) (get v 'standard-value)
18533 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18534 (push v list)))))
18535 (kill-buffer (get-buffer "*Warn about privacy*"))
18536 list))
18537 nil nil
18538 "Remember to cover the basics, that is, what you expected to happen and
18539 what in fact did happen. You don't know how to make a good report? See
18541 http://orgmode.org/manual/Feedback.html#Feedback
18543 Your bug report will be posted to the Org-mode mailing list.
18544 ------------------------------------------------------------------------")
18545 (save-excursion
18550 (defun org-install-agenda-files-menu ()
18551 (let ((bl (buffer-list)))
18552 (save-excursion
18553 (while bl
18554 (set-buffer (pop bl))
18555 (if (org-mode-p) (setq bl nil)))
18556 (when (org-mode-p)
18557 (easy-menu-change
18558 '("Org") "File List for Agenda"
18559 (append
18560 (list
18561 ["Edit File List" (org-edit-agenda-file-list) t]
18562 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18563 ["Remove Current File from List" org-remove-file t]
18564 ["Cycle through agenda files" org-cycle-agenda-files t]
18565 ["Occur in all agenda files" org-occur-in-agenda-files t]
18566 "--")
18567 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18569 ;;;; Documentation
18571 ;;;###autoload
18572 (defun org-require-autoloaded-modules ()
18573 (interactive)
18574 (mapc 'require
18575 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18576 org-docbook org-exp org-html org-icalendar
18577 org-id org-latex
18578 org-publish org-remember org-table
18579 org-timer org-xoxo)))
18581 ;;;###autoload
18582 (defun org-reload (&optional uncompiled)
18583 "Reload all org lisp files.
18584 With prefix arg UNCOMPILED, load the uncompiled versions."
18585 (interactive "P")
18586 (require 'find-func)
18588 (dir-org (file-name-directory (org-find-library-name "org")))
18589 (dir-org-contrib (ignore-errors
18590 (file-name-directory
18591 (org-find-library-name "org-contribdir"))))
18592 (babel-files
18593 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18594 (append (list nil "comint" "eval" "exp" "keys"
18595 "lob" "ref" "table" "tangle")
18596 (delq nil
18597 (mapcar
18598 (lambda (lang)
18599 (when (cdr lang) (symbol-name (car lang))))
18600 org-babel-load-languages)))))
18601 (files
18602 (append (directory-files dir-org t file-re)
18603 babel-files
18604 (and dir-org-contrib
18605 (directory-files dir-org-contrib t file-re))))
18606 (remove-re (concat (if (featurep 'xemacs)
18607 "org-colview" "org-colview-xemacs")
18609 (setq files (mapcar 'file-name-sans-extension files))
18610 (setq files (mapcar
18611 (lambda (x) (if (string-match remove-re x) nil x))
18612 files))
18613 (setq files (delq nil files))
18614 (mapc
18615 (lambda (f)
18616 (when (featurep (intern (file-name-nondirectory f)))
18617 (if (and (not uncompiled)
18618 (file-exists-p (concat f ".elc")))
18619 (load (concat f ".elc") nil nil t)
18620 (load (concat f ".el") nil nil t))))
18621 files))
18622 (org-version))
18624 ;;;###autoload
18625 (defun org-customize ()
18626 "Call the customize function with org as argument."
18627 (interactive)
18628 (org-load-modules-maybe)
18629 (org-require-autoloaded-modules)
18630 (customize-browse 'org))
18632 (defun org-create-customize-menu ()
18633 "Create a full customization menu for Org-mode, insert it into the menu."
18634 (interactive)
18635 (org-load-modules-maybe)
18636 (org-require-autoloaded-modules)
18637 (if (fboundp 'customize-menu-create)
18638 (progn
18639 (easy-menu-change
18640 '("Org") "Customize"
18641 `(["Browse Org group" org-customize t]
18642 "--"
18643 ,(customize-menu-create 'org)
18644 ["Set" Custom-set t]
18645 ["Save" Custom-save t]
18646 ["Reset to Current" Custom-reset-current t]
18647 ["Reset to Saved" Custom-reset-saved t]
18648 ["Reset to Standard Settings" Custom-reset-standard t]))
18650 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18652 ;;;; Miscellaneous stuff
18654 ;;; Generally useful functions
18656 (defun org-get-at-bol (property)
18657 "Get text property PROPERTY at beginning of line."
18658 (get-text-property (point-at-bol) property))
18660 (defun org-find-text-property-in-string (prop s)
18661 "Return the first non-nil value of property PROP in string S."
18662 (or (get-text-property 0 prop s)
18663 (get-text-property (or (next-single-property-change 0 prop s) 0)
18664 prop s)))
18666 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18667 "Display the given MESSAGE as a warning."
18668 (if (fboundp 'display-warning)
18669 (display-warning 'org message
18670 (if (featurep 'xemacs) 'warning :warning))
18671 (let ((buf (get-buffer-create "*Org warnings*")))
18672 (with-current-buffer buf
18673 (goto-char (point-max))
18674 (insert "Warning (Org): " message)
18675 (unless (bolp)
18676 (newline)))
18677 (display-buffer buf)
18678 (sit-for 0))))
18680 (defun org-eval (form)
18681 "Eval FORM and return result."
18682 (condition-case error
18683 (eval form)
18684 (error (format "%%![Error: %s]" error))))
18686 (defun org-in-commented-line ()
18687 "Is point in a line starting with `#'?"
18688 (equal (char-after (point-at-bol)) ?#))
18690 (defun org-in-indented-comment-line ()
18691 "Is point in a line starting with `#' after some white space?"
18692 (save-excursion
18693 (save-match-data
18694 (goto-char (point-at-bol))
18697 (defun org-in-verbatim-emphasis ()
18698 (save-match-data
18699 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18701 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18702 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18703 (if (and marker (marker-buffer marker)
18704 (buffer-live-p (marker-buffer marker)))
18705 (progn
18706 (org-pop-to-buffer-same-window (marker-buffer marker))
18707 (if (or (> marker (point-max)) (< marker (point-min)))
18708 (widen))
18709 (goto-char marker)
18710 (org-show-context 'org-goto))
18711 (if bookmark
18712 (bookmark-jump bookmark)
18713 (error "Cannot find location"))))
18715 (defun org-quote-csv-field (s)
18716 "Quote field for inclusion in CSV material."
18719 s))
18721 (defun org-force-self-insert (N)
18722 "Needed to enforce self-insert under remapping."
18723 (interactive "p")
18724 (self-insert-command N))
18726 (defun org-string-width (s)
18727 "Compute width of string, ignoring invisible characters.
18728 This ignores character with invisibility property `org-link', and also
18729 characters with property `org-cwidth', because these will become invisible
18730 upon the next fontification round."
18731 (let (b l)
18732 (when (or (eq t buffer-invisibility-spec)
18733 (assq 'org-link buffer-invisibility-spec))
18734 (while (setq b (text-property-any 0 (length s)
18735 'invisible 'org-link s))
18736 (setq s (concat (substring s 0 b)
18737 (substring s (or (next-single-property-change
18738 b 'invisible s) (length s)))))))
18739 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18740 (setq s (concat (substring s 0 b)
18741 (substring s (or (next-single-property-change
18742 b 'org-cwidth s) (length s))))))
18743 (setq l (string-width s) b -1)
18744 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18745 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18746 l))
18748 (defun org-shorten-string (s maxlength)
18749 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18750 If the string is shorter or has length MAXLENGTH, just return the
18751 original string. If it is longer, the functions finds a space in the
18752 string, breaks this string off at that locations and adds three dots
18753 as ellipsis. Including the ellipsis, the string will not be longer
18754 than MAXLENGTH. If finding a good breaking point in the string does
18755 not work, the string is just chopped off in the middle of a word
18756 if necessary."
18757 (if (<= (length s) maxlength)
18758 s
18759 (let* ((n (max (- maxlength 4) 1))
18761 (if (string-match re s)
18762 (concat (match-string 1 s) "...")
18763 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18765 (defun org-get-indentation (&optional line)
18766 "Get the indentation of the current line, interpreting tabs.
18767 When LINE is given, assume it represents a line and compute its indentation."
18768 (if line
18769 (if (string-match "^ *" (org-remove-tabs line))
18770 (match-end 0))
18771 (save-excursion
18772 (beginning-of-line 1)
18774 (current-column))))
18776 (defun org-get-string-indentation (s)
18777 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18778 (let ((n -1) (i 0) (w tab-width) c)
18779 (catch 'exit
18780 (while (< (setq n (1+ n)) (length s))
18781 (setq c (aref s n))
18782 (cond ((= c ?\ ) (setq i (1+ i)))
18784 (t (throw 'exit t)))))
18785 i))
18787 (defun org-remove-tabs (s &optional width)
18788 "Replace tabulators in S with spaces.
18789 Assumes that s is a single line, starting in column 0."
18790 (setq width (or width tab-width))
18792 (setq s (replace-match
18793 (make-string
18794 (- (* width (/ (+ (match-beginning 0) width) width))
18795 (match-beginning 0)) ?\ )
18796 t t s)))
18797 s)
18799 (defun org-fix-indentation (line ind)
18800 "Fix indentation in LINE.
18801 IND is a cons cell with target and minimum indentation.
18802 If the current indentation in LINE is smaller than the minimum,
18803 leave it alone. If it is larger than ind, set it to the target."
18804 (let* ((l (org-remove-tabs line))
18805 (i (org-get-indentation l))
18806 (i1 (car ind)) (i2 (cdr ind)))
18807 (if (>= i i2) (setq l (substring line i2)))
18808 (if (> i1 0)
18809 (concat (make-string i1 ?\ ) l)
18810 l)))
18812 (defun org-remove-indentation (code &optional n)
18813 "Remove the maximum common indentation from the lines in CODE.
18814 N may optionally be the number of spaces to remove."
18815 (with-temp-buffer
18816 (insert code)
18817 (org-do-remove-indentation n)
18818 (buffer-string)))
18820 (defun org-do-remove-indentation (&optional n)
18821 "Remove the maximum common indentation from the buffer."
18822 (untabify (point-min) (point-max))
18823 (let ((min 10000) re)
18824 (if n
18825 (setq min n)
18826 (goto-char (point-min))
18828 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18829 (unless (or (= min 0) (= min 10000))
18831 (goto-char (point-min))
18832 (while (re-search-forward re nil t)
18833 (replace-match "")
18834 (end-of-line 1))
18835 min)))
18837 (defun org-fill-template (template alist)
18838 "Find each %key of ALIST in TEMPLATE and replace it."
18839 (let ((case-fold-search nil)
18840 entry key value)
18841 (setq alist (sort (copy-sequence alist)
18842 (lambda (a b) (< (length (car a)) (length (car b))))))
18843 (while (setq entry (pop alist))
18844 (setq template
18845 (replace-regexp-in-string
18846 (concat "%" (regexp-quote (car entry)))
18847 (cdr entry) template t t)))
18848 template))
18850 (defun org-base-buffer (buffer)
18851 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18852 (if (not buffer)
18853 buffer
18854 (or (buffer-base-buffer buffer)
18855 buffer)))
18857 (defun org-trim (s)
18858 "Remove whitespace at beginning and end of string."
18861 s)
18863 (defun org-wrap (string &optional width lines)
18864 "Wrap string to either a number of lines, or a width in characters.
18865 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18866 that costs. If there is a word longer than WIDTH, the text is actually
18867 wrapped to the length of that word.
18868 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18869 many lines, whatever width that takes.
18870 The return value is a list of lines, without newlines at the end."
18872 (maxword (apply 'max (mapcar 'org-string-width words)))
18873 w ll)
18874 (cond (width
18875 (org-do-wrap words (max maxword width)))
18876 (lines
18877 (setq w maxword)
18878 (setq ll (org-do-wrap words maxword))
18879 (if (<= (length ll) lines)
18880 ll
18881 (setq ll words)
18882 (while (> (length ll) lines)
18883 (setq w (1+ w))
18884 (setq ll (org-do-wrap words w)))
18885 ll))
18886 (t (error "Cannot wrap this")))))
18888 (defun org-do-wrap (words width)
18889 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18890 (let (lines line)
18891 (while words
18892 (setq line (pop words))
18893 (while (and words (< (+ (length line) (length (car words))) width))
18894 (setq line (concat line " " (pop words))))
18895 (setq lines (push line lines)))
18896 (nreverse lines)))
18898 (defun org-split-string (string &optional separators)
18899 "Splits STRING into substrings at SEPARATORS.
18900 No empty strings are returned if there are matches at the beginning
18901 and end of string."
18903 (start 0)
18904 notfirst
18905 (list nil))
18906 (while (and (string-match rexp string
18907 (if (and notfirst
18908 (= start (match-beginning 0))
18909 (< start (length string)))
18910 (1+ start) start))
18911 (< (match-beginning 0) (length string)))
18912 (setq notfirst t)
18913 (or (eq (match-beginning 0) 0)
18914 (and (eq (match-beginning 0) (match-end 0))
18915 (eq (match-beginning 0) start))
18916 (setq list
18917 (cons (substring string start (match-beginning 0))
18918 list)))
18919 (setq start (match-end 0)))
18920 (or (eq start (length string))
18921 (setq list
18922 (cons (substring string start)
18923 list)))
18924 (nreverse list)))
18926 (defun org-quote-vert (s)
18928 (while (string-match "|" s)
18930 s)
18932 (defun org-uuidgen-p (s)
18933 "Is S an ID created by UUIDGEN?"
18934 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18936 (defun org-context ()
18937 "Return a list of contexts of the current cursor position.
18938 If several contexts apply, all are returned.
18939 Each context entry is a list with a symbol naming the context, and
18940 two positions indicating start and end of the context. Possible
18941 contexts are:
18943 :headline anywhere in a headline
18944 :headline-stars on the leading stars in a headline
18945 :todo-keyword on a TODO keyword (including DONE) in a headline
18946 :tags on the TAGS in a headline
18947 :priority on the priority cookie in a headline
18948 :item on the first line of a plain list item
18949 :item-bullet on the bullet/number of a plain list item
18950 :checkbox on the checkbox in a plain list item
18951 :table in an org-mode table
18952 :table-special on a special filed in a table
18953 :table-table in a table.el table
18954 :link on a hyperlink
18955 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18956 :target on a <<target>>
18957 :radio-target on a <<<radio-target>>>
18958 :latex-fragment on a LaTeX fragment
18959 :latex-preview on a LaTeX fragment with overlayed preview image
18961 This function expects the position to be visible because it uses font-lock
18962 faces as a help to recognize the following contexts: :table-special, :link,
18963 and :keyword."
18964 (let* ((f (get-text-property (point) 'face))
18965 (faces (if (listp f) f (list f)))
18966 (p (point)) clist o)
18967 ;; First the large context
18968 (cond
18969 ((org-on-heading-p t)
18970 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18971 (when (progn
18972 (beginning-of-line 1)
18973 (looking-at org-todo-line-tags-regexp))
18974 (push (org-point-in-group p 1 :headline-stars) clist)
18975 (push (org-point-in-group p 2 :todo-keyword) clist)
18976 (push (org-point-in-group p 4 :tags) clist))
18977 (goto-char p)
18980 (push (org-point-in-group p 0 :priority) clist)))
18982 ((org-at-item-p)
18983 (push (org-point-in-group p 2 :item-bullet) clist)
18984 (push (list :item (point-at-bol)
18985 (save-excursion (org-end-of-item) (point)))
18986 clist)
18987 (and (org-at-item-checkbox-p)
18988 (push (org-point-in-group p 0 :checkbox) clist)))
18990 ((org-at-table-p)
18991 (push (list :table (org-table-begin) (org-table-end)) clist)
18992 (if (memq 'org-formula faces)
18993 (push (list :table-special
18994 (previous-single-property-change p 'face)
18995 (next-single-property-change p 'face)) clist)))
18996 ((org-at-table-p 'any)
18997 (push (list :table-table) clist)))
18998 (goto-char p)
19000 ;; Now the small context
19001 (cond
19002 ((org-at-timestamp-p)
19003 (push (org-point-in-group p 0 :timestamp) clist))
19004 ((memq 'org-link faces)
19005 (push (list :link
19006 (previous-single-property-change p 'face)
19007 (next-single-property-change p 'face)) clist))
19008 ((memq 'org-special-keyword faces)
19009 (push (list :keyword
19010 (previous-single-property-change p 'face)
19011 (next-single-property-change p 'face)) clist))
19012 ((org-on-target-p)
19013 (push (org-point-in-group p 0 :target) clist)
19014 (goto-char (1- (match-beginning 0)))
19015 (if (looking-at org-radio-target-regexp)
19016 (push (org-point-in-group p 0 :radio-target) clist))
19017 (goto-char p))
19018 ((setq o (car (delq nil
19019 (mapcar
19020 (lambda (x)
19021 (if (memq x org-latex-fragment-image-overlays) x))
19022 (overlays-at (point))))))
19023 (push (list :latex-fragment
19024 (overlay-start o) (overlay-end o)) clist)
19025 (push (list :latex-preview
19026 (overlay-start o) (overlay-end o)) clist))
19027 ((org-inside-LaTeX-fragment-p)
19028 ;; FIXME: positions wrong.
19029 (push (list :latex-fragment (point) (point)) clist)))
19031 (setq clist (nreverse (delq nil clist)))
19032 clist))
19034 ;; FIXME: Compare with at-regexp-p Do we need both?
19035 (defun org-in-regexp (re &optional nlines visually)
19036 "Check if point is inside a match of regexp.
19037 Normally only the current line is checked, but you can include NLINES extra
19038 lines both before and after point into the search.
19039 If VISUALLY is set, require that the cursor is not after the match but
19040 really on, so that the block visually is on the match."
19041 (catch 'exit
19042 (let ((pos (point))
19043 (eol (point-at-eol (+ 1 (or nlines 0))))
19044 (inc (if visually 1 0)))
19045 (save-excursion
19046 (beginning-of-line (- 1 (or nlines 0)))
19047 (while (re-search-forward re eol t)
19048 (if (and (<= (match-beginning 0) pos)
19049 (>= (+ inc (match-end 0)) pos))
19050 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19052 (defun org-at-regexp-p (regexp)
19053 "Is point inside a match of REGEXP in the current line?"
19054 (catch 'exit
19055 (save-excursion
19056 (let ((pos (point)) (end (point-at-eol)))
19057 (beginning-of-line 1)
19058 (while (re-search-forward regexp end t)
19059 (if (and (<= (match-beginning 0) pos)
19060 (>= (match-end 0) pos))
19061 (throw 'exit t)))
19062 nil))))
19064 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19065 "Non-nil when point is between matches of START-RE and END-RE.
19067 Also return a non-nil value when point is on one of the matches.
19069 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19070 buffer positions. Default values are the positions of headlines
19071 surrounding the point.
19073 The functions returns a cons cell whose car (resp. cdr) is the
19074 position before START-RE (resp. after END-RE)."
19075 (save-match-data
19076 (let ((pos (point))
19077 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19078 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19079 beg end)
19080 (save-excursion
19081 ;; Point is on a block when on START-RE or if START-RE can be
19082 ;; found before it...
19083 (and (or (org-at-regexp-p start-re)
19084 (re-search-backward start-re limit-up t))
19085 (setq beg (match-beginning 0))
19086 ;; ... and END-RE after it...
19087 (goto-char (match-end 0))
19088 (re-search-forward end-re limit-down t)
19089 (> (setq end (match-end 0)) pos)
19090 ;; ... without another START-RE in-between.
19091 (goto-char (match-beginning 0))
19092 (not (re-search-backward start-re pos t))
19093 ;; Return value.
19094 (cons beg end))))))
19096 (defun org-in-block-p (names)
19097 "Is point inside any block whose name belongs to NAMES?
19099 NAMES is a list of strings containing names of blocks."
19100 (save-match-data
19101 (catch 'exit
19102 (let ((case-fold-search t)
19103 (lim-up (save-excursion (outline-previous-heading)))
19104 (lim-down (save-excursion (outline-next-heading))))
19105 (mapc (lambda (name)
19106 (let ((n (regexp-quote name)))
19107 (when (org-between-regexps-p
19110 lim-up lim-down)
19111 (throw 'exit t))))
19112 names))
19113 nil)))
19115 (defun org-occur-in-agenda-files (regexp &optional nlines)
19116 "Call `multi-occur' with buffers for all agenda files."
19118 (let* ((files (org-agenda-files))
19119 (tnames (mapcar 'file-truename files))
19120 (extra org-agenda-text-search-extra-files)
19121 f)
19122 (when (eq (car extra) 'agenda-archives)
19123 (setq extra (cdr extra))
19124 (setq files (org-add-archive-files files)))
19125 (while (setq f (pop extra))
19126 (unless (member (file-truename f) tnames)
19127 (add-to-list 'files f 'append)
19128 (add-to-list 'tnames (file-truename f) 'append)))
19129 (multi-occur
19130 (mapcar (lambda (x)
19131 (with-current-buffer
19132 (or (get-file-buffer x) (find-file-noselect x))
19133 (widen)
19134 (current-buffer)))
19135 files)
19136 regexp)))
19138 (if (boundp 'occur-mode-find-occurrence-hook)
19139 ;; Emacs 23
19140 (add-hook 'occur-mode-find-occurrence-hook
19141 (lambda ()
19142 (when (org-mode-p)
19143 (org-reveal))))
19144 ;; Emacs 22
19145 (defadvice occur-mode-goto-occurrence
19146 (after org-occur-reveal activate)
19147 (and (org-mode-p) (org-reveal)))
19148 (defadvice occur-mode-goto-occurrence-other-window
19149 (after org-occur-reveal activate)
19150 (and (org-mode-p) (org-reveal)))
19151 (defadvice occur-mode-display-occurrence
19152 (after org-occur-reveal activate)
19153 (when (org-mode-p)
19154 (let ((pos (occur-mode-find-occurrence)))
19155 (with-current-buffer (marker-buffer pos)
19156 (save-excursion
19157 (goto-char pos)
19158 (org-reveal)))))))
19160 (defun org-occur-link-in-agenda-files ()
19161 "Create a link and search for it in the agendas.
19162 The link is not stored in `org-stored-links', it is just created
19163 for the search purpose."
19164 (interactive)
19165 (let ((link (condition-case nil
19166 (org-store-link nil)
19167 (error "Unable to create a link to here"))))
19168 (org-occur-in-agenda-files (regexp-quote link))))
19170 (defun org-uniquify (list)
19171 "Remove duplicate elements from LIST."
19172 (let (res)
19173 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19174 res))
19176 (defun org-delete-all (elts list)
19177 "Remove all elements in ELTS from LIST."
19178 (while elts
19179 (setq list (delete (pop elts) list)))
19180 list)
19182 (defun org-count (cl-item cl-seq)
19183 "Count the number of occurrences of ITEM in SEQ.
19184 Taken from `count' in cl-seq.el with all keyword arguments removed."
19185 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19186 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19187 (while (< cl-start cl-end)
19188 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19189 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19190 (setq cl-start (1+ cl-start)))
19191 cl-count))
19193 (defun org-remove-if (predicate seq)
19194 "Remove everything from SEQ that fulfills PREDICATE."
19195 (let (res e)
19196 (while seq
19197 (setq e (pop seq))
19198 (if (not (funcall predicate e)) (push e res)))
19199 (nreverse res)))
19201 (defun org-remove-if-not (predicate seq)
19202 "Remove everything from SEQ that does not fulfill PREDICATE."
19203 (let (res e)
19204 (while seq
19205 (setq e (pop seq))
19206 (if (funcall predicate e) (push e res)))
19207 (nreverse res)))
19209 (defun org-back-over-empty-lines ()
19210 "Move backwards over whitespace, to the beginning of the first empty line.
19211 Returns the number of empty lines passed."
19212 (let ((pos (point)))
19213 (if (cdr (assoc 'heading org-blank-before-new-entry))
19215 (unless (eobp)
19216 (forward-line -1)))
19217 (beginning-of-line 2)
19218 (goto-char (min (point) pos))
19219 (count-lines (point) pos)))
19221 (defun org-skip-whitespace ()
19224 (defun org-point-in-group (point group &optional context)
19225 "Check if POINT is in match-group GROUP.
19226 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19227 match. If the match group does not exist or point is not inside it,
19228 return nil."
19229 (and (match-beginning group)
19230 (>= point (match-beginning group))
19231 (<= point (match-end group))
19232 (if context
19233 (list context (match-beginning group) (match-end group))
19234 t)))
19236 (defun org-switch-to-buffer-other-window (&rest args)
19237 "Switch to buffer in a second window on the current frame.
19238 In particular, do not allow pop-up frames.
19239 Returns the newly created buffer."
19240 (let (pop-up-frames special-display-buffer-names special-display-regexps
19241 special-display-function)
19242 (apply 'switch-to-buffer-other-window args)))
19244 (defun org-combine-plists (&rest plists)
19245 "Create a single property list from all plists in PLISTS.
19246 The process starts by copying the first list, and then setting properties
19247 from the other lists. Settings in the last list are the most significant
19248 ones and overrule settings in the other lists."
19249 (let ((rtn (copy-sequence (pop plists)))
19250 p v ls)
19251 (while plists
19252 (setq ls (pop plists))
19253 (while ls
19254 (setq p (pop ls) v (pop ls))
19255 (setq rtn (plist-put rtn p v))))
19256 rtn))
19258 (defun org-move-line-down (arg)
19259 "Move the current line down. With prefix argument, move it past ARG lines."
19260 (interactive "p")
19261 (let ((col (current-column))
19262 beg end pos)
19263 (beginning-of-line 1) (setq beg (point))
19264 (beginning-of-line 2) (setq end (point))
19265 (beginning-of-line (+ 1 arg))
19266 (setq pos (move-marker (make-marker) (point)))
19267 (insert (delete-and-extract-region beg end))
19268 (goto-char pos)
19269 (org-move-to-column col)))
19271 (defun org-move-line-up (arg)
19272 "Move the current line up. With prefix argument, move it past ARG lines."
19273 (interactive "p")
19274 (let ((col (current-column))
19275 beg end pos)
19276 (beginning-of-line 1) (setq beg (point))
19277 (beginning-of-line 2) (setq end (point))
19278 (beginning-of-line (- arg))
19279 (setq pos (move-marker (make-marker) (point)))
19280 (insert (delete-and-extract-region beg end))
19281 (goto-char pos)
19282 (org-move-to-column col)))
19284 (defun org-replace-escapes (string table)
19285 "Replace %-escapes in STRING with values in TABLE.
19287 The sequences in STRING may contain normal field width and padding information,
19289 so values can contain further %-escapes if they are define later in TABLE."
19290 (let ((tbl (copy-alist table))
19291 (case-fold-search nil)
19292 (pchg 0)
19293 e re rpl)
19294 (while (setq e (pop tbl))
19295 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19296 (when (and (cdr e) (string-match re (cdr e)))
19297 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19298 (safe "SREF"))
19299 (add-text-properties 0 3 (list 'sref sref) safe)
19300 (setcdr e (replace-match safe t t (cdr e)))))
19301 (while (string-match re string)
19302 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19303 (cdr e)))
19304 (setq string (replace-match rpl t t string))))
19305 (while (setq pchg (next-property-change pchg string))
19306 (let ((sref (get-text-property pchg 'sref string)))
19307 (when (and sref (string-match "SREF" string pchg))
19308 (setq string (replace-match sref t t string)))))
19309 string))
19311 (defun org-sublist (list start end)
19312 "Return a section of LIST, from START to END.
19313 Counting starts at 1."
19314 (let (rtn (c start))
19315 (setq list (nthcdr (1- start) list))
19316 (while (and list (<= c end))
19317 (push (pop list) rtn)
19318 (setq c (1+ c)))
19319 (nreverse rtn)))
19321 (defun org-find-base-buffer-visiting (file)
19322 "Like `find-buffer-visiting' but always return the base buffer and
19323 not an indirect buffer."
19324 (let ((buf (or (get-file-buffer file)
19325 (find-buffer-visiting file))))
19326 (if buf
19327 (or (buffer-base-buffer buf) buf)
19328 nil)))
19330 (defun org-image-file-name-regexp (&optional extensions)
19331 "Return regexp matching the file names of images.
19332 If EXTENSIONS is given, only match these."
19333 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19334 (image-file-name-regexp)
19335 (let ((image-file-name-extensions
19336 (or extensions
19337 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19338 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19340 (regexp-opt (nconc (mapcar 'upcase
19341 image-file-name-extensions)
19342 image-file-name-extensions)
19343 t)
19346 (defun org-file-image-p (file &optional extensions)
19347 "Return non-nil if FILE is an image."
19348 (save-match-data
19349 (string-match (org-image-file-name-regexp extensions) file)))
19351 (defun org-get-cursor-date ()
19352 "Return the date at cursor in as a time.
19353 This works in the calendar and in the agenda, anywhere else it just
19354 returns the current time."
19355 (let (date day defd)
19356 (cond
19357 ((eq major-mode 'calendar-mode)
19358 (setq date (calendar-cursor-to-date)
19359 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19360 ((eq major-mode 'org-agenda-mode)
19361 (setq day (get-text-property (point) 'day))
19362 (if day
19363 (setq date (calendar-gregorian-from-absolute day)
19364 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19365 (nth 2 date))))))
19366 (or defd (current-time))))
19368 (defvar org-agenda-action-marker (make-marker)
19369 "Marker pointing to the entry for the next agenda action.")
19371 (defun org-mark-entry-for-agenda-action ()
19372 "Mark the current entry as target of an agenda action.
19373 Agenda actions are actions executed from the agenda with the key `k',
19374 which make use of the date at the cursor."
19375 (interactive)
19376 (move-marker org-agenda-action-marker
19377 (save-excursion (org-back-to-heading t) (point))
19378 (current-buffer))
19379 (message
19380 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19382 (defun org-mark-subtree ()
19383 "Mark the current subtree.
19384 This puts point at the start of the current subtree, and mark at the end.
19386 If point is in an inline task, mark that task instead."
19387 (interactive)
19388 (let ((inline-task-p
19389 (and (featurep 'org-inlinetask)
19390 (org-inlinetask-in-task-p)))
19391 (beg))
19392 ;; Get beginning of subtree
19393 (cond
19394 (inline-task-p (org-inlinetask-goto-beginning))
19395 ((org-at-heading-p) (beginning-of-line))
19396 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19397 (setq beg (point))
19398 ;; Get end of it
19399 (if inline-task-p
19400 (org-inlinetask-goto-end)
19401 (org-end-of-subtree))
19402 ;; Mark zone
19403 (push-mark (point) nil t)
19404 (goto-char beg)))
19406 ;;; Paragraph filling stuff.
19407 ;; We want this to be just right, so use the full arsenal.
19409 (defun org-indent-line-function ()
19410 "Indent line depending on context."
19411 (interactive)
19412 (let* ((pos (point))
19413 (itemp (org-at-item-p))
19414 (case-fold-search t)
19416 (inline-task-p (and (featurep 'org-inlinetask)
19417 (org-inlinetask-in-task-p)))
19418 (inline-re (and inline-task-p
19419 (org-inlinetask-outline-regexp)))
19420 column)
19421 (beginning-of-line 1)
19422 (cond
19423 ;; Comments
19424 ((looking-at "# ") (setq column 0))
19425 ;; Headings
19426 ((looking-at org-outline-regexp) (setq column 0))
19427 ;; Included files
19429 ;; Footnote definition
19430 ((looking-at org-footnote-definition-re) (setq column 0))
19431 ;; Literal examples
19433 (setq column (org-get-indentation))) ; do nothing
19434 ;; Lists
19435 ((ignore-errors (goto-char (org-in-item-p)))
19436 (setq column (if itemp
19437 (org-get-indentation)
19438 (org-list-item-body-column (point))))
19439 (goto-char pos))
19440 ;; Drawers
19442 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19443 (save-excursion
19444 (goto-char (1- (match-beginning 1)))
19445 (setq column (current-column))))
19446 ;; Special blocks
19448 (save-excursion
19449 (re-search-backward
19451 (setq column (org-get-indentation (match-string 0))))
19454 (save-excursion
19456 (setq column
19457 (if (equal (downcase (match-string 1)) "src")
19458 ;; src blocks: let `org-edit-src-exit' handle them
19459 (org-get-indentation)
19460 (org-get-indentation (match-string 0)))))
19461 ;; This line has nothing special, look at the previous relevant
19462 ;; line to compute indentation
19463 (t
19464 (beginning-of-line 0)
19465 (while (and (not (bobp))
19466 (not (looking-at org-drawer-regexp))
19467 ;; When point started in an inline task, do not move
19468 ;; above task starting line.
19469 (not (and inline-task-p (looking-at inline-re)))
19470 ;; Skip drawers, blocks, empty lines, verbatim,
19471 ;; comments, tables, footnotes definitions, lists,
19472 ;; inline tasks.
19474 (re-search-backward org-drawer-regexp nil t))
19478 (looking-at org-footnote-definition-re)
19479 (and (ignore-errors (goto-char (org-in-item-p)))
19480 (goto-char
19481 (org-list-get-top-point (org-list-struct))))
19482 (and (not inline-task-p)
19483 (featurep 'org-inlinetask)
19484 (org-inlinetask-in-task-p)
19485 (or (org-inlinetask-goto-beginning) t))))
19486 (beginning-of-line 0))
19487 (cond
19488 ;; There was an heading above.
19490 (if (not org-adapt-indentation)
19491 (setq column 0)
19492 (goto-char (match-end 0))
19493 (setq column (current-column))))
19494 ;; A drawer had started and is unfinished
19495 ((looking-at org-drawer-regexp)
19496 (goto-char (1- (match-beginning 1)))
19497 (setq column (current-column)))
19498 ;; Else, nothing noticeable found: get indentation and go on.
19499 (t (setq column (org-get-indentation))))))
19500 ;; Now apply indentation and move cursor accordingly
19501 (goto-char pos)
19502 (if (<= (current-column) (current-indentation))
19503 (org-indent-line-to column)
19504 (save-excursion (org-indent-line-to column)))
19505 ;; Special polishing for properties, see `org-property-format'
19506 (setq column (current-column))
19507 (beginning-of-line 1)
19508 (if (looking-at
19510 (replace-match (concat (match-string 1)
19511 (format org-property-format
19512 (match-string 2) (match-string 3)))
19513 t t))
19514 (org-move-to-column column)))
19516 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19517 "Variable to store copy of `adaptive-fill-regexp'.
19518 Since `adaptive-fill-regexp' is set to never match, we need to
19519 store a backup of its value before entering `org-mode' so that
19520 the functionality can be provided as a fall-back.")
19522 (defun org-set-autofill-regexps ()
19523 (interactive)
19524 ;; In the paragraph separator we include headlines, because filling
19525 ;; text in a line directly attached to a headline would otherwise
19526 ;; fill the headline as well.
19529 ;; The paragraph starter includes hand-formatted lists.
19530 (org-set-local
19531 'paragraph-start
19532 (concat
19541 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19542 ;; But only if the user has not turned off tables or fixed-width regions
19543 (org-set-local
19544 'auto-fill-inhibit-regexp
19545 (concat org-outline-regexp
19548 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19549 (concat
19551 (if org-enable-table-editor "|" "")
19552 (if org-enable-fixed-width-editor ":" "")
19553 "]"))))
19554 ;; We use our own fill-paragraph function, to make sure that tables
19555 ;; and fixed-width regions are not wrapped. That function will pass
19556 ;; through to `fill-paragraph' when appropriate.
19557 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19558 ;; Prevent auto-fill from inserting unwanted new items.
19559 (org-set-local 'fill-nobreak-predicate
19560 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19561 fill-nobreak-predicate
19562 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19563 ;; Adaptive filling: To get full control, first make sure that
19564 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19565 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19566 (org-set-local 'org-adaptive-fill-regexp-backup
19567 adaptive-fill-regexp))
19569 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19570 (org-set-local 'adaptive-fill-function
19571 'org-adaptive-fill-function)
19572 (org-set-local
19573 'align-mode-rules-list
19574 '((org-in-buffer-settings
19576 (modes . '(org-mode))))))
19578 (defun org-fill-item-nobreak-p ()
19579 "Non-nil when a line break at point would insert a new item."
19580 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19582 (defun org-fill-paragraph (&optional justify)
19583 "Re-align a table, pass through to fill-paragraph if no table."
19584 (let ((table-p (org-at-table-p))
19585 (table.el-p (org-at-table.el-p))
19586 (itemp (org-in-item-p)))
19587 (cond ((and (equal (char-after (point-at-bol)) ?*)
19588 (save-excursion (goto-char (point-at-bol))
19589 (looking-at org-outline-regexp)))
19590 t) ; skip headlines
19591 (table.el-p t) ; skip table.el tables
19592 (table-p (org-table-align) t) ; align Org tables
19593 (itemp ; align text in items
19594 (let* ((struct (save-excursion (goto-char itemp)
19595 (org-list-struct)))
19596 (parents (org-list-parents-alist struct))
19597 (children (org-list-get-children itemp struct parents))
19598 beg end prev next prefix)
19599 ;; Determine in which part of item point is: before
19600 ;; first child, after last child, between two
19601 ;; sub-lists, or simply in item if there's no child.
19602 (cond
19603 ((not children)
19604 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19605 beg itemp
19606 end (org-list-get-item-end itemp struct)))
19607 ((< (point) (setq next (car children)))
19608 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19609 beg itemp
19610 end next))
19611 ((> (point) (setq prev (car (last children))))
19612 (setq beg (org-list-get-item-end prev struct)
19613 end (org-list-get-item-end itemp struct)
19614 prefix (save-excursion
19615 (goto-char beg)
19617 (make-string (current-column) ?\ ))))
19618 (t (catch 'exit
19619 (while (setq next (pop children))
19620 (if (> (point) next)
19621 (setq prev next)
19622 (setq beg (org-list-get-item-end prev struct)
19623 end next
19624 prefix (save-excursion
19625 (goto-char beg)
19627 (make-string (current-column) ?\ )))
19628 (throw 'exit nil))))))
19629 ;; Use `fill-paragraph' with buffer narrowed to item
19630 ;; without any child, and with our computed PREFIX.
19631 (flet ((fill-context-prefix (from to &optional flr) prefix))
19632 (save-restriction
19633 (narrow-to-region beg end)
19634 (save-excursion (fill-paragraph justify)))) t))
19635 ;; Special case where point is not in a list but is on
19636 ;; a paragraph adjacent to a list: make sure this paragraph
19637 ;; doesn't get merged with the end of the list by narrowing
19638 ;; buffer first.
19639 ((save-excursion (forward-paragraph -1)
19640 (setq itemp (org-in-item-p)))
19641 (let ((struct (save-excursion (goto-char itemp)
19642 (org-list-struct))))
19643 (save-restriction
19644 (narrow-to-region (org-list-get-bottom-point struct)
19645 (save-excursion (forward-paragraph 1)
19646 (point)))
19647 (fill-paragraph justify) t)))
19648 ;; Else simply call `fill-paragraph'.
19649 (t nil))))
19651 ;; For reference, this is the default value of adaptive-fill-regexp
19654 (defun org-adaptive-fill-function ()
19655 "Return a fill prefix for org-mode files."
19656 (let (itemp)
19657 (save-excursion
19658 (cond
19659 ;; Comment line
19661 (match-string-no-properties 0))
19662 ;; Plain list item
19663 ((org-at-item-p)
19664 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19665 ;; Point is in a list after `backward-paragraph': original
19666 ;; point wasn't in the list, or filling would have been taken
19667 ;; care of by `org-auto-fill-function', but the list and the
19668 ;; real paragraph are not separated by a blank line. Thus, move
19669 ;; point after the list to go back to real paragraph and
19670 ;; determine fill-prefix.
19671 ((setq itemp (org-in-item-p))
19672 (goto-char itemp)
19673 (let* ((struct (org-list-struct))
19674 (bottom (org-list-get-bottom-point struct)))
19675 (goto-char bottom)
19676 (make-string (org-get-indentation) ?\ )))
19677 ;; Other text
19678 ((looking-at org-adaptive-fill-regexp-backup)
19679 (match-string-no-properties 0))))))
19681 (defun org-auto-fill-function ()
19682 "Auto-fill function."
19683 (let (itemp prefix)
19684 ;; When in a list, compute an appropriate fill-prefix and make
19685 ;; sure it will be used by `do-auto-fill'.
19686 (if (setq itemp (org-in-item-p))
19687 (progn
19688 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19689 (flet ((fill-context-prefix (from to &optional flr) prefix))
19690 (do-auto-fill)))
19691 ;; Else just use `do-auto-fill'.
19692 (do-auto-fill))))
19694 ;;; Other stuff.
19696 (defun org-toggle-fixed-width-section (arg)
19697 "Toggle the fixed-width export.
19698 If there is no active region, the QUOTE keyword at the current headline is
19699 inserted or removed. When present, it causes the text between this headline
19700 and the next to be exported as fixed-width text, and unmodified.
19701 If there is an active region, this command adds or removes a colon as the
19702 first character of this line. If the first character of a line is a colon,
19703 this line is also exported in fixed-width font."
19704 (interactive "P")
19705 (let* ((cc 0)
19706 (regionp (org-region-active-p))
19707 (beg (if regionp (region-beginning) (point)))
19708 (end (if regionp (region-end)))
19709 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19710 (case-fold-search nil)
19712 off)
19713 (if regionp
19714 (save-excursion
19715 (goto-char beg)
19716 (setq cc (current-column))
19717 (beginning-of-line 1)
19718 (setq off (looking-at re))
19719 (while (> nlines 0)
19720 (setq nlines (1- nlines))
19721 (beginning-of-line 1)
19722 (cond
19723 (arg
19724 (org-move-to-column cc t)
19726 (forward-line -1))
19727 ((and off (looking-at re))
19728 (replace-match "" t t nil 1))
19729 ((not off) (org-move-to-column cc t) (insert ": ")))
19730 (forward-line 1)))
19731 (save-excursion
19732 (org-back-to-heading)
19733 (if (looking-at (concat org-outline-regexp
19735 (replace-match "" t t nil 1)
19736 (if (looking-at org-outline-regexp)
19737 (progn
19738 (goto-char (match-end 0))
19739 (insert org-quote-string " "))))))))
19741 (defun org-reftex-citation ()
19742 "Use reftex-citation to insert a citation into the buffer.
19743 This looks for a line like
19745 #+BIBLIOGRAPHY: foo plain option:-d
19747 and derives from it that foo.bib is the bibliography file relevant
19748 for this document. It then installs the necessary environment for RefTeX
19749 to work in this buffer and calls `reftex-citation' to insert a citation
19750 into the buffer.
19752 Export of such citations to both LaTeX and HTML is handled by the contributed
19753 package org-exp-bibtex by Taru Karttunen."
19754 (interactive)
19755 (let ((reftex-docstruct-symbol 'rds)
19757 rds bib)
19758 (save-excursion
19759 (save-restriction
19760 (widen)
19761 (let ((case-fold-search t)
19763 (if (not (save-excursion
19764 (or (re-search-forward re nil t)
19765 (re-search-backward re nil t))))
19766 (error "No bibliography defined in file")
19767 (setq bib (concat (match-string 1) ".bib")
19768 rds (list (list 'bib bib)))))))
19769 (call-interactively 'reftex-citation)))
19771 ;;;; Functions extending outline functionality
19773 (defun org-beginning-of-line (&optional arg)
19774 "Go to the beginning of the current line. If that is invisible, continue
19775 to a visible line beginning. This makes the function of C-a more intuitive.
19776 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19777 first attempt, and only move to after the tags when the cursor is already
19778 beyond the end of the headline."
19779 (interactive "P")
19780 (let ((pos (point))
19781 (special (if (consp org-special-ctrl-a/e)
19782 (car org-special-ctrl-a/e)
19783 org-special-ctrl-a/e))
19784 refpos)
19785 (if (org-bound-and-true-p line-move-visual)
19786 (beginning-of-visual-line 1)
19787 (beginning-of-line 1))
19788 (if (and arg (fboundp 'move-beginning-of-line))
19789 (call-interactively 'move-beginning-of-line)
19790 (if (bobp)
19791 nil
19792 (backward-char 1)
19793 (if (org-truely-invisible-p)
19794 (while (and (not (bobp)) (org-truely-invisible-p))
19795 (backward-char 1)
19796 (beginning-of-line 1))
19797 (forward-char 1))))
19798 (when special
19799 (cond
19800 ((and (looking-at org-complex-heading-regexp)
19801 (= (char-after (match-end 1)) ?\ ))
19802 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19803 (point-at-eol)))
19804 (goto-char
19805 (if (eq special t)
19806 (cond ((> pos refpos) refpos)
19807 ((= pos (point)) refpos)
19808 (t (point)))
19809 (cond ((> pos (point)) (point))
19810 ((not (eq last-command this-command)) (point))
19811 (t refpos)))))
19812 ((org-at-item-p)
19813 (goto-char
19814 (if (eq special t)
19815 (cond ((> pos (match-end 0)) (match-end 0))
19816 ((= pos (point)) (match-end 0))
19817 (t (point)))
19818 (cond ((> pos (point)) (point))
19819 ((not (eq last-command this-command)) (point))
19820 (t (match-end 0))))))))
19821 (org-no-warnings
19822 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19824 (defun org-end-of-line (&optional arg)
19825 "Go to the end of the line.
19826 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19827 first attempt, and only move to after the tags when the cursor is already
19828 beyond the end of the headline."
19829 (interactive "P")
19830 (let ((special (if (consp org-special-ctrl-a/e)
19831 (cdr org-special-ctrl-a/e)
19832 org-special-ctrl-a/e)))
19833 (if (or (not special)
19834 (not (org-on-heading-p))
19835 arg)
19836 (call-interactively
19837 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19838 ((fboundp 'move-end-of-line) 'move-end-of-line)
19839 (t 'end-of-line)))
19840 (let ((pos (point)))
19841 (beginning-of-line 1)
19843 (if (eq special t)
19844 (if (or (< pos (match-beginning 1))
19845 (= pos (match-end 0)))
19846 (goto-char (match-beginning 1))
19847 (goto-char (match-end 0)))
19848 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19849 (goto-char (match-end 0))
19850 (goto-char (match-beginning 1))))
19851 (call-interactively (if (fboundp 'move-end-of-line)
19852 'move-end-of-line
19853 'end-of-line)))))
19854 (org-no-warnings
19855 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19857 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19858 (define-key org-mode-map "\C-e" 'org-end-of-line)
19860 (defun org-backward-sentence (&optional arg)
19861 "Go to beginning of sentence, or beginning of table field.
19862 This will call `backward-sentence' or `org-table-beginning-of-field',
19863 depending on context."
19864 (interactive "P")
19865 (cond
19866 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19867 (t (call-interactively 'backward-sentence))))
19869 (defun org-forward-sentence (&optional arg)
19870 "Go to end of sentence, or end of table field.
19871 This will call `forward-sentence' or `org-table-end-of-field',
19872 depending on context."
19873 (interactive "P")
19874 (cond
19875 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19876 (t (call-interactively 'forward-sentence))))
19878 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19879 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19881 (defun org-kill-line (&optional arg)
19882 "Kill line, to tags or end of line."
19883 (interactive "P")
19884 (cond
19885 ((or (not org-special-ctrl-k)
19886 (bolp)
19887 (not (org-on-heading-p)))
19888 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19889 org-ctrl-k-protect-subtree)
19890 (if (or (eq org-ctrl-k-protect-subtree 'error)
19891 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19892 (error "C-k aborted - would kill hidden subtree")))
19893 (call-interactively 'kill-line))
19895 (kill-region (point) (match-beginning 1))
19896 (org-set-tags nil t))
19897 (t (kill-region (point) (point-at-eol)))))
19899 (define-key org-mode-map "\C-k" 'org-kill-line)
19901 (defun org-yank (&optional arg)
19902 "Yank. If the kill is a subtree, treat it specially.
19903 This command will look at the current kill and check if is a single
19904 subtree, or a series of subtrees[1]. If it passes the test, and if the
19905 cursor is at the beginning of a line or after the stars of a currently
19906 empty headline, then the yank is handled specially. How exactly depends
19907 on the value of the following variables, both set by default.
19909 org-yank-folded-subtrees
19910 When set, the subtree(s) will be folded after insertion, but only
19911 if doing so would now swallow text after the yanked text.
19913 org-yank-adjusted-subtrees
19914 When set, the subtree will be promoted or demoted in order to
19915 fit into the local outline tree structure, which means that the level
19916 will be adjusted so that it becomes the smaller one of the two
19917 *visible* surrounding headings.
19919 Any prefix to this command will cause `yank' to be called directly with
19921 will just
19922 plainly yank the text as it is.
19924 \[1] The test checks if the first non-white line is a heading
19925 and if there are no other headings with fewer stars."
19926 (interactive "P")
19927 (org-yank-generic 'yank arg))
19929 (defun org-yank-generic (command arg)
19930 "Perform some yank-like command.
19932 This function implements the behavior described in the `org-yank'
19933 documentation. However, it has been generalized to work for any
19934 interactive command with similar behavior."
19936 ;; pretend to be command COMMAND
19937 (setq this-command command)
19939 (if arg
19940 (call-interactively command)
19942 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19943 (and (org-kill-is-subtree-p)
19944 (or (bolp)
19946 (string-match
19948 (buffer-substring (point-at-bol) (point)))))))
19949 swallowp)
19950 (cond
19951 ((and subtreep org-yank-folded-subtrees)
19952 (let ((beg (point))
19953 end)
19954 (if (and subtreep org-yank-adjusted-subtrees)
19955 (org-paste-subtree nil nil 'for-yank)
19956 (call-interactively command))
19958 (setq end (point))
19959 (goto-char beg)
19960 (when (and (bolp) subtreep
19961 (not (setq swallowp
19962 (org-yank-folding-would-swallow-text beg end))))
19963 (org-with-limited-levels
19964 (or (looking-at org-outline-regexp)
19965 (re-search-forward org-outline-regexp-bol end t))
19966 (while (and (< (point) end) (looking-at org-outline-regexp))
19967 (hide-subtree)
19968 (org-cycle-show-empty-lines 'folded)
19969 (condition-case nil
19970 (outline-forward-same-level 1)
19971 (error (goto-char end))))))
19972 (when swallowp
19973 (message
19974 "Inserted text not folded because that would swallow text"))
19976 (goto-char end)
19978 (beginning-of-line 1)
19979 (push-mark beg 'nomsg)))
19980 ((and subtreep org-yank-adjusted-subtrees)
19981 (let ((beg (point-at-bol)))
19982 (org-paste-subtree nil nil 'for-yank)
19983 (push-mark beg 'nomsg)))
19984 (t
19985 (call-interactively command))))))
19987 (defun org-yank-folding-would-swallow-text (beg end)
19988 "Would hide-subtree at BEG swallow any text after END?"
19989 (let (level)
19990 (org-with-limited-levels
19991 (save-excursion
19992 (goto-char beg)
19993 (when (or (looking-at org-outline-regexp)
19994 (re-search-forward org-outline-regexp-bol end t))
19995 (setq level (org-outline-level)))
19996 (goto-char end)
19998 (if (or (eobp)
19999 (and (bolp) (looking-at org-outline-regexp)
20000 (<= (org-outline-level) level)))
20001 nil ; Nothing would be swallowed
20002 t))))) ; something would swallow
20004 (define-key org-mode-map "\C-y" 'org-yank)
20006 (defun org-truely-invisible-p ()
20007 "Check if point is at a character currently not visible.
20008 This version does not only check the character property, but also
20009 `visible-mode'."
20010 ;; Early versions of noutline don't have `outline-invisible-p'.
20011 (if (org-bound-and-true-p visible-mode)
20012 nil
20013 (outline-invisible-p)))
20015 (defun org-invisible-p2 ()
20016 "Check if point is at a character currently not visible."
20017 (save-excursion
20018 (if (and (eolp) (not (bobp))) (backward-char 1))
20019 ;; Early versions of noutline don't have `outline-invisible-p'.
20020 (outline-invisible-p)))
20022 (defun org-back-to-heading (&optional invisible-ok)
20023 "Call `outline-back-to-heading', but provide a better error message."
20024 (condition-case nil
20025 (outline-back-to-heading invisible-ok)
20026 (error (error "Before first headline at position %d in buffer %s"
20027 (point) (current-buffer)))))
20029 (defun org-beginning-of-defun ()
20030 "Go to the beginning of the subtree, i.e. back to the heading."
20031 (org-back-to-heading))
20032 (defun org-end-of-defun ()
20033 "Go to the end of the subtree."
20034 (org-end-of-subtree nil t))
20036 (defun org-before-first-heading-p ()
20037 "Before first heading?"
20038 (save-excursion
20039 (end-of-line)
20040 (null (re-search-backward org-outline-regexp-bol nil t))))
20042 (defun org-on-heading-p (&optional ignored)
20043 (outline-on-heading-p t))
20044 (defun org-at-heading-p (&optional ignored)
20045 (outline-on-heading-p t))
20047 (defun org-point-at-end-of-empty-headline ()
20048 "If point is at the end of an empty headline, return t, else nil.
20049 If the heading only contains a TODO keyword, it is still still considered
20050 empty."
20052 (save-excursion
20053 (beginning-of-line 1)
20054 (let ((case-fold-search nil))
20057 (defun org-at-heading-or-item-p ()
20058 (or (org-on-heading-p) (org-at-item-p)))
20060 (defun org-on-target-p ()
20061 (or (org-in-regexp org-radio-target-regexp)
20062 (org-in-regexp org-target-regexp)))
20064 (defun org-up-heading-all (arg)
20065 "Move to the heading line of which the present line is a subheading.
20066 This function considers both visible and invisible heading lines.
20067 With argument, move up ARG levels."
20068 (if (fboundp 'outline-up-heading-all)
20069 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20070 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20072 (defun org-up-heading-safe ()
20073 "Move to the heading line of which the present line is a subheading.
20074 This version will not throw an error. It will return the level of the
20075 headline found, or nil if no higher level is found.
20077 Also, this function will be a lot faster than `outline-up-heading',
20078 because it relies on stars being the outline starters. This can really
20079 make a significant difference in outlines with very many siblings."
20080 (let (start-level re)
20081 (org-back-to-heading t)
20082 (setq start-level (funcall outline-level))
20083 (if (equal start-level 1)
20084 nil
20086 (if (re-search-backward re nil t)
20087 (funcall outline-level)))))
20089 (defun org-first-sibling-p ()
20090 "Is this heading the first child of its parents?"
20091 (interactive)
20092 (let ((re org-outline-regexp-bol)
20093 level l)
20094 (unless (org-at-heading-p t)
20095 (error "Not at a heading"))
20096 (setq level (funcall outline-level))
20097 (save-excursion
20098 (if (not (re-search-backward re nil t))
20099 t
20100 (setq l (funcall outline-level))
20101 (< l level)))))
20103 (defun org-goto-sibling (&optional previous)
20104 "Goto the next sibling, even if it is invisible.
20105 When PREVIOUS is set, go to the previous sibling instead. Returns t
20106 when a sibling was found. When none is found, return nil and don't
20107 move point."
20108 (let ((fun (if previous 're-search-backward 're-search-forward))
20109 (pos (point))
20110 (re org-outline-regexp-bol)
20111 level l)
20112 (when (condition-case nil (org-back-to-heading t) (error nil))
20113 (setq level (funcall outline-level))
20114 (catch 'exit
20115 (or previous (forward-char 1))
20116 (while (funcall fun re nil t)
20117 (setq l (funcall outline-level))
20118 (when (< l level) (goto-char pos) (throw 'exit nil))
20119 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20120 (goto-char pos)
20121 nil))))
20123 (defun org-show-siblings ()
20124 "Show all siblings of the current headline."
20125 (save-excursion
20126 (while (org-goto-sibling) (org-flag-heading nil)))
20127 (save-excursion
20128 (while (org-goto-sibling 'previous)
20129 (org-flag-heading nil))))
20131 (defun org-goto-first-child ()
20132 "Goto the first child, even if it is invisible.
20133 Return t when a child was found. Otherwise don't move point and
20134 return nil."
20135 (let (level (pos (point)) (re org-outline-regexp-bol))
20136 (when (condition-case nil (org-back-to-heading t) (error nil))
20137 (setq level (outline-level))
20138 (forward-char 1)
20139 (if (and (re-search-forward re nil t) (> (outline-level) level))
20140 (progn (goto-char (match-beginning 0)) t)
20141 (goto-char pos) nil))))
20143 (defun org-show-hidden-entry ()
20144 "Show an entry where even the heading is hidden."
20145 (save-excursion
20146 (org-show-entry)))
20148 (defun org-flag-heading (flag &optional entry)
20149 "Flag the current heading. FLAG non-nil means make invisible.
20150 When ENTRY is non-nil, show the entire entry."
20151 (save-excursion
20152 (org-back-to-heading t)
20153 ;; Check if we should show the entire entry
20154 (if entry
20155 (progn
20156 (org-show-entry)
20157 (save-excursion
20158 (and (outline-next-heading)
20159 (org-flag-heading nil))))
20160 (outline-flag-region (max (point-min) (1- (point)))
20161 (save-excursion (outline-end-of-heading) (point))
20162 flag))))
20164 (defun org-get-next-sibling ()
20165 "Move to next heading of the same level, and return point.
20166 If there is no such heading, return nil.
20167 This is like outline-next-sibling, but invisible headings are ok."
20168 (let ((level (funcall outline-level)))
20169 (outline-next-heading)
20170 (while (and (not (eobp)) (> (funcall outline-level) level))
20171 (outline-next-heading))
20172 (if (or (eobp) (< (funcall outline-level) level))
20173 nil
20174 (point))))
20176 (defun org-get-last-sibling ()
20177 "Move to previous heading of the same level, and return point.
20178 If there is no such heading, return nil."
20179 (let ((opoint (point))
20180 (level (funcall outline-level)))
20181 (outline-previous-heading)
20182 (when (and (/= (point) opoint) (outline-on-heading-p t))
20183 (while (and (> (funcall outline-level) level)
20184 (not (bobp)))
20185 (outline-previous-heading))
20186 (if (< (funcall outline-level) level)
20187 nil
20188 (point)))))
20190 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20191 ;; This contains an exact copy of the original function, but it uses
20192 ;; `org-back-to-heading', to make it work also in invisible
20193 ;; trees. And is uses an invisible-OK argument.
20194 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20195 ;; Furthermore, when used inside Org, finding the end of a large subtree
20196 ;; with many children and grandchildren etc, this can be much faster
20197 ;; than the outline version.
20198 (org-back-to-heading invisible-OK)
20199 (let ((first t)
20200 (level (funcall outline-level)))
20201 (if (and (org-mode-p) (< level 1000))
20202 ;; A true heading (not a plain list item), in Org-mode
20203 ;; This means we can easily find the end by looking
20204 ;; only for the right number of stars. Using a regexp to do
20205 ;; this is so much faster than using a Lisp loop.
20207 (forward-char 1)
20208 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20209 ;; something else, do it the slow way
20210 (while (and (not (eobp))
20211 (or first (> (funcall outline-level) level)))
20212 (setq first nil)
20213 (outline-next-heading)))
20214 (unless to-heading
20216 (progn
20217 ;; Go to end of line before heading
20218 (forward-char -1)
20220 ;; leave blank line before heading
20221 (forward-char -1))))))
20222 (point))
20224 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20225 "Use Org version in org-mode, for dramatic speed-up."
20226 (if (org-mode-p)
20227 (progn
20228 (org-end-of-subtree nil t)
20229 (unless (eobp) (backward-char 1)))
20230 ad-do-it))
20232 (defun org-end-of-meta-data-and-drawers ()
20233 "Jump to the first text after meta data and drawers in the current entry.
20234 This will move over empty lines, lines with planning time stamps,
20235 clocking lines, and drawers."
20236 (org-back-to-heading t)
20237 (let ((end (save-excursion (outline-next-heading) (point)))
20240 (forward-line 1)
20241 (while (re-search-forward re end t)
20242 (if (not (match-end 1))
20243 ;; empty or planning line
20244 (forward-line 1)
20245 ;; a drawer, find the end
20247 (forward-line 1)))
20249 (point)))
20251 (defun org-forward-same-level (arg &optional invisible-ok)
20252 "Move forward to the arg'th subheading at same level as this one.
20253 Stop at the first and last subheadings of a superior heading.
20254 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20255 it wil also look at invisible ones."
20256 (interactive "p")
20257 (org-back-to-heading invisible-ok)
20258 (org-on-heading-p)
20259 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20261 l)
20262 (forward-char 1)
20263 (while (> arg 0)
20264 (while (and (re-search-forward re nil 'move)
20265 (setq l (- (match-end 0) (match-beginning 0) 1))
20266 (= l level)
20267 (not invisible-ok)
20268 (progn (backward-char 1) (outline-invisible-p)))
20269 (if (< l level) (setq arg 1)))
20270 (setq arg (1- arg)))
20271 (beginning-of-line 1)))
20273 (defun org-backward-same-level (arg &optional invisible-ok)
20274 "Move backward to the arg'th subheading at same level as this one.
20275 Stop at the first and last subheadings of a superior heading."
20276 (interactive "p")
20277 (org-back-to-heading)
20278 (org-on-heading-p)
20279 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20281 l)
20282 (while (> arg 0)
20283 (while (and (re-search-backward re nil 'move)
20284 (setq l (- (match-end 0) (match-beginning 0) 1))
20285 (= l level)
20286 (not invisible-ok)
20287 (outline-invisible-p))
20288 (if (< l level) (setq arg 1)))
20289 (setq arg (1- arg)))))
20291 (defun org-show-subtree ()
20292 "Show everything after this heading at deeper levels."
20293 (outline-flag-region
20294 (point)
20295 (save-excursion
20296 (org-end-of-subtree t t))
20297 nil))
20299 (defun org-show-entry ()
20300 "Show the body directly following this heading.
20301 Show the heading too, if it is currently invisible."
20302 (interactive)
20303 (save-excursion
20304 (condition-case nil
20305 (progn
20306 (org-back-to-heading t)
20307 (outline-flag-region
20308 (max (point-min) (1- (point)))
20309 (save-excursion
20310 (if (re-search-forward
20312 (match-beginning 1)
20313 (point-max)))
20314 nil)
20315 (org-cycle-hide-drawers 'children))
20316 (error nil))))
20318 (defun org-make-options-regexp (kwds &optional extra)
20319 "Make a regular expression for keyword lines."
20320 (concat
20321 "^"
20328 ;; Make isearch reveal the necessary context
20329 (defun org-isearch-end ()
20330 "Reveal context after isearch exits."
20331 (when isearch-success ; only if search was successful
20332 (if (featurep 'xemacs)
20333 ;; Under XEmacs, the hook is run in the correct place,
20334 ;; we directly show the context.
20335 (org-show-context 'isearch)
20336 ;; In Emacs the hook runs *before* restoring the overlays.
20337 ;; So we have to use a one-time post-command-hook to do this.
20338 ;; (Emacs 22 has a special variable, see function `org-mode')
20339 (unless (and (boundp 'isearch-mode-end-hook-quit)
20340 isearch-mode-end-hook-quit)
20341 ;; Only when the isearch was not quitted.
20342 (org-add-hook 'post-command-hook 'org-isearch-post-command
20343 'append 'local)))))
20345 (defun org-isearch-post-command ()
20346 "Remove self from hook, and show context."
20347 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20348 (org-show-context 'isearch))
20351 ;;;; Integration with and fixes for other packages
20353 ;;; Imenu support
20355 (defvar org-imenu-markers nil
20356 "All markers currently used by Imenu.")
20357 (make-variable-buffer-local 'org-imenu-markers)
20359 (defun org-imenu-new-marker (&optional pos)
20360 "Return a new marker for use by Imenu, and remember the marker."
20361 (let ((m (make-marker)))
20362 (move-marker m (or pos (point)))
20363 (push m org-imenu-markers)
20364 m))
20366 (defun org-imenu-get-tree ()
20367 "Produce the index for Imenu."
20368 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20369 (setq org-imenu-markers nil)
20370 (let* ((n org-imenu-depth)
20371 (re (concat "^" (org-get-limited-outline-regexp)))
20372 (subs (make-vector (1+ n) nil))
20373 (last-level 0)
20374 m level head)
20375 (save-excursion
20376 (save-restriction
20377 (widen)
20378 (goto-char (point-max))
20379 (while (re-search-backward re nil t)
20380 (setq level (org-reduced-level (funcall outline-level)))
20381 (when (<= level n)
20382 (looking-at org-complex-heading-regexp)
20383 (setq head (org-link-display-format
20384 (org-match-string-no-properties 4))
20385 m (org-imenu-new-marker))
20386 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20387 (if (>= level last-level)
20388 (push (cons head m) (aref subs level))
20389 (push (cons head (aref subs (1+ level))) (aref subs level))
20390 (loop for i from (1+ level) to n do (aset subs i nil)))
20391 (setq last-level level)))))
20392 (aref subs 1)))
20394 (eval-after-load "imenu"
20395 '(progn
20396 (add-hook 'imenu-after-jump-hook
20397 (lambda ()
20398 (if (org-mode-p)
20399 (org-show-context 'org-goto))))))
20401 (defun org-link-display-format (link)
20402 "Replace a link with either the description, or the link target
20403 if no description is present"
20404 (save-match-data
20405 (if (string-match org-bracket-link-analytic-regexp link)
20406 (replace-match (if (match-end 5)
20407 (match-string 5 link)
20408 (concat (match-string 1 link)
20409 (match-string 3 link)))
20410 nil t link)
20411 link)))
20413 ;; Speedbar support
20415 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20416 "Overlay marking the agenda restriction line in speedbar.")
20417 (overlay-put org-speedbar-restriction-lock-overlay
20418 'face 'org-agenda-restriction-lock)
20419 (overlay-put org-speedbar-restriction-lock-overlay
20420 'help-echo "Agendas are currently limited to this item.")
20421 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20423 (defun org-speedbar-set-agenda-restriction ()
20424 "Restrict future agenda commands to the location at point in speedbar.
20426 (interactive)
20427 (require 'org-agenda)
20428 (let (p m tp np dir txt)
20429 (cond
20430 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20431 'org-imenu t))
20432 (setq m (get-text-property p 'org-imenu-marker))
20433 (with-current-buffer (marker-buffer m)
20434 (goto-char m)
20435 (org-agenda-set-restriction-lock 'subtree)))
20436 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20437 'speedbar-function 'speedbar-find-file))
20438 (setq tp (previous-single-property-change
20439 (1+ p) 'speedbar-function)
20440 np (next-single-property-change
20441 tp 'speedbar-function)
20442 dir (speedbar-line-directory)
20443 txt (buffer-substring-no-properties (or tp (point-min))
20444 (or np (point-max))))
20445 (with-current-buffer (find-file-noselect
20446 (let ((default-directory dir))
20447 (expand-file-name txt)))
20448 (unless (org-mode-p)
20449 (error "Cannot restrict to non-Org-mode file"))
20450 (org-agenda-set-restriction-lock 'file)))
20451 (t (error "Don't know how to restrict Org-mode's agenda")))
20452 (move-overlay org-speedbar-restriction-lock-overlay
20453 (point-at-bol) (point-at-eol))
20454 (setq current-prefix-arg nil)
20455 (org-agenda-maybe-redo)))
20457 (eval-after-load "speedbar"
20458 '(progn
20459 (speedbar-add-supported-extension ".org")
20460 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20461 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20462 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20463 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20464 (add-hook 'speedbar-visiting-tag-hook
20465 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20467 ;;; Fixes and Hacks for problems with other packages
20469 ;; Make flyspell not check words in links, to not mess up our keymap
20470 (defun org-mode-flyspell-verify ()
20471 "Don't let flyspell put overlays at active buttons, or on
20472 {todo,all-time,additional-option-like}-keywords."
20473 (let ((pos (max (1- (point)) (point-min)))
20474 (word (thing-at-point 'word)))
20475 (and (not (get-text-property pos 'keymap))
20476 (not (get-text-property pos 'org-no-flyspell))
20477 (not (member word org-todo-keywords-1))
20478 (not (member word org-all-time-keywords))
20479 (not (member word org-additional-option-like-keywords)))))
20481 (defun org-remove-flyspell-overlays-in (beg end)
20482 "Remove flyspell overlays in region."
20483 (and (org-bound-and-true-p flyspell-mode)
20484 (fboundp 'flyspell-delete-region-overlays)
20485 (flyspell-delete-region-overlays beg end))
20486 (add-text-properties beg end '(org-no-flyspell t)))
20488 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20489 (eval-after-load "bookmark"
20490 '(if (boundp 'bookmark-after-jump-hook)
20491 ;; We can use the hook
20492 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20493 ;; Hook not available, use advice
20494 (defadvice bookmark-jump (after org-make-visible activate)
20495 "Make the position visible."
20496 (org-bookmark-jump-unhide))))
20498 ;; Make sure saveplace shows the location if it was hidden
20499 (eval-after-load "saveplace"
20500 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20501 "Make the position visible."
20502 (org-bookmark-jump-unhide)))
20504 ;; Make sure ecb shows the location if it was hidden
20505 (eval-after-load "ecb"
20506 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20507 "Make hierarchy visible when jumping into location from ECB tree buffer."
20508 (if (org-mode-p)
20509 (org-show-context))))
20511 (defun org-bookmark-jump-unhide ()
20512 "Unhide the current position, to show the bookmark location."
20513 (and (org-mode-p)
20514 (or (outline-invisible-p)
20515 (save-excursion (goto-char (max (point-min) (1- (point))))
20516 (outline-invisible-p)))
20517 (org-show-context 'bookmark-jump)))
20519 ;; Make session.el ignore our circular variable
20520 (eval-after-load "session"
20521 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20523 ;;;; Experimental code
20525 (defun org-closed-in-range ()
20526 "Sparse tree of items closed in a certain time range.
20527 Still experimental, may disappear in the future."
20528 (interactive)
20529 ;; Get the time interval from the user.
20530 (let* ((time1 (org-float-time
20531 (org-read-date nil 'to-time nil "Starting date: ")))
20532 (time2 (org-float-time
20533 (org-read-date nil 'to-time nil "End date:")))
20534 ;; callback function
20535 (callback (lambda ()
20536 (let ((time
20537 (org-float-time
20538 (apply 'encode-time
20539 (org-parse-time-string
20540 (match-string 1))))))
20541 ;; check if time in interval
20542 (and (>= time time1) (<= time time2))))))
20543 ;; make tree, check each match with the callback
20546 ;;;; Finish up
20548 (provide 'org)
20550 (run-hooks 'org-load-hook)
20552 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20554 ;;; org.el ends here