| blob | c29ef115400bc9f2fe4b7ae1919e0799867b1c30 |
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)
7675 (case-fold-search t) ;; allow #+BEGIN
7676 b_start b_end)
7677 (if (org-in-regexps-block-p bstart bend)
7678 (progn
7679 (save-excursion (re-search-backward bstart nil t)
7680 (setq b_start (match-beginning 0)))
7681 (save-excursion (re-search-forward bend nil t)
7682 (setq b_end (match-end 0)))
7683 (narrow-to-region b_start b_end))
7684 (error "Not in a block"))))
7686 (eval-when-compile
7687 (defvar org-property-drawer-re))
7689 (defvar org-property-start-re) ;; defined below
7690 (defun org-clone-subtree-with-time-shift (n &optional shift)
7691 "Clone the task (subtree) at point N times.
7692 The clones will be inserted as siblings.
7694 In interactive use, the user will be prompted for the number of
7695 clones to be produced, and for a time SHIFT, which may be a
7696 repeater as used in time stamps, for example `+3d'.
7698 When a valid repeater is given and the entry contains any time
7699 stamps, the clones will become a sequence in time, with time
7700 stamps in the subtree shifted for each clone produced. If SHIFT
7701 is nil or the empty string, time stamps will be left alone. The
7702 ID property of the original subtree is removed.
7704 If the original subtree did contain time stamps with a repeater,
7705 the following will happen:
7706 - the repeater will be removed in each clone
7707 - an additional clone will be produced, with the current, unshifted
7708 date(s) in the entry.
7709 - the original entry will be placed *after* all the clones, with
7710 repeater intact.
7711 - the start days in the repeater in the original entry will be shifted
7712 to past the last clone.
7713 I this way you can spell out a number of instances of a repeating task,
7714 and still retain the repeater to cover future instances of the task."
7715 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7716 (let (beg end template task idprop
7717 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7718 (if (not (and (integerp n) (> n 0)))
7719 (error "Invalid number of replications %s" n))
7722 shift)))
7723 (error "Invalid shift specification %s" shift))
7724 (when doshift
7725 (setq shift-n (string-to-number (match-string 1 shift))
7726 shift-what (cdr (assoc (match-string 2 shift)
7727 '(("d" . day) ("w" . week)
7728 ("m" . month) ("y" . year))))))
7729 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7730 (setq nmin 1 nmax n)
7731 (org-back-to-heading t)
7732 (setq beg (point))
7733 (setq idprop (org-entry-get nil "ID"))
7734 (org-end-of-subtree t t)
7736 (setq end (point))
7737 (setq template (buffer-substring beg end))
7738 ;; Remove clocks and empty drawers
7739 (with-temp-buffer
7740 (insert template)
7741 (goto-char (point-min))
7742 (while (re-search-forward
7744 (replace-match "")
7745 (kill-whole-line))
7746 (goto-char (point-min))
7747 (while (re-search-forward
7749 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7750 (setq template (buffer-substring (point-min) (point-max))))
7751 (when (and doshift
7753 (delete-region beg end)
7754 (setq end beg)
7755 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7756 (goto-char end)
7757 (loop for n from nmin to nmax do
7758 ;; prepare clone
7759 (with-temp-buffer
7760 (insert template)
7761 (org-mode)
7762 (goto-char (point-min))
7763 (and idprop (if org-clone-delete-id
7764 (org-entry-delete nil "ID")
7765 (org-id-get-create t)))
7766 (while (re-search-forward org-property-start-re nil t)
7767 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7768 (goto-char (point-min))
7769 (when doshift
7770 (while (re-search-forward org-ts-regexp-both nil t)
7771 (org-timestamp-change (* n shift-n) shift-what))
7772 (unless (= n n-no-remove)
7773 (goto-char (point-min))
7774 (while (re-search-forward org-ts-regexp nil t)
7775 (save-excursion
7776 (goto-char (match-beginning 0))
7778 (delete-region (match-beginning 1) (match-end 1)))))))
7779 (setq task (buffer-string)))
7780 (insert task))
7781 (goto-char beg)))
7783 ;;; Outline Sorting
7785 (defun org-sort (with-case)
7786 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7787 Optional argument WITH-CASE means sort case-sensitively.
7788 With a double prefix argument, also remove duplicate entries."
7789 (interactive "P")
7790 (cond
7791 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7792 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7793 (t
7794 (org-call-with-arg 'org-sort-entries with-case))))
7796 (defun org-sort-remove-invisible (s)
7797 (remove-text-properties 0 (length s) org-rm-props s)
7798 (while (string-match org-bracket-link-regexp s)
7799 (setq s (replace-match (if (match-end 2)
7800 (match-string 3 s)
7801 (match-string 1 s)) t t s)))
7802 s)
7804 (defvar org-priority-regexp) ; defined later in the file
7806 (defvar org-after-sorting-entries-or-items-hook nil
7807 "Hook that is run after a bunch of entries or items have been sorted.
7808 When children are sorted, the cursor is in the parent line when this
7809 hook gets called. When a region or a plain list is sorted, the cursor
7810 will be in the first entry of the sorted region/list.")
7812 (defun org-sort-entries
7813 (&optional with-case sorting-type getkey-func compare-func property)
7814 "Sort entries on a certain level of an outline tree.
7815 If there is an active region, the entries in the region are sorted.
7816 Else, if the cursor is before the first entry, sort the top-level items.
7817 Else, the children of the entry at point are sorted.
7819 Sorting can be alphabetically, numerically, by date/time as given by
7820 a time stamp, by a property or by priority.
7822 The command prompts for the sorting type unless it has been given to the
7823 function through the SORTING-TYPE argument, which needs to be a character,
7824 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7825 precise meaning of each character:
7827 n Numerically, by converting the beginning of the entry/item to a number.
7828 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7829 t By date/time, either the first active time stamp in the entry, or, if
7830 none exist, by the first inactive one.
7831 s By the scheduled date/time.
7832 d By deadline date/time.
7833 c By creation time, which is assumed to be the first inactive time stamp
7834 at the beginning of a line.
7835 p By priority according to the cookie.
7836 r By the value of a property.
7838 Capital letters will reverse the sort order.
7840 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7841 called with point at the beginning of the record. It must return either
7842 a string or a number that should serve as the sorting key for that record.
7844 Comparing entries ignores case by default. However, with an optional argument
7845 WITH-CASE, the sorting considers case as well."
7846 (interactive "P")
7847 (let ((case-func (if with-case 'identity 'downcase))
7848 start beg end stars re re2
7849 txt what tmp)
7850 ;; Find beginning and end of region to sort
7851 (cond
7852 ((org-region-active-p)
7853 ;; we will sort the region
7854 (setq end (region-end)
7855 what "region")
7856 (goto-char (region-beginning))
7857 (if (not (org-on-heading-p)) (outline-next-heading))
7858 (setq start (point)))
7859 ((or (org-on-heading-p)
7860 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7861 ;; we will sort the children of the current headline
7862 (org-back-to-heading)
7863 (setq start (point)
7864 end (progn (org-end-of-subtree t t)
7866 (org-back-over-empty-lines)
7867 (point))
7868 what "children")
7869 (goto-char start)
7870 (show-subtree)
7871 (outline-next-heading))
7872 (t
7873 ;; we will sort the top-level entries in this file
7874 (goto-char (point-min))
7875 (or (org-on-heading-p) (outline-next-heading))
7876 (setq start (point))
7877 (goto-char (point-max))
7878 (beginning-of-line 1)
7880 ;; File ends in a non-white line
7881 (end-of-line 1)
7883 (setq end (point-max))
7884 (setq what "top-level")
7885 (goto-char start)
7886 (show-all)))
7888 (setq beg (point))
7889 (if (>= beg end) (error "Nothing to sort"))
7892 (setq stars (match-string 1)
7893 re (concat "^" (regexp-quote stars) " +")
7895 txt (buffer-substring beg end))
7897 (if (and (not (equal stars "*")) (string-match re2 txt))
7898 (error "Region to sort contains a level above the first entry"))
7900 (unless sorting-type
7901 (message
7902 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7904 A/N/T/S/D/C/P/O/F means reversed:"
7905 what)
7906 (setq sorting-type (read-char-exclusive))
7908 (and (= (downcase sorting-type) ?f)
7909 (setq getkey-func
7910 (org-icompleting-read "Sort using function: "
7911 obarray 'fboundp t nil nil))
7912 (setq getkey-func (intern getkey-func)))
7914 (and (= (downcase sorting-type) ?r)
7915 (setq property
7916 (org-icompleting-read "Property: "
7917 (mapcar 'list (org-buffer-property-keys t))
7918 nil t))))
7920 (message "Sorting entries...")
7922 (save-restriction
7923 (narrow-to-region start end)
7924 (let ((dcst (downcase sorting-type))
7925 (case-fold-search nil)
7926 (now (current-time)))
7927 (sort-subr
7928 (/= dcst sorting-type)
7929 ;; This function moves to the beginning character of the "record" to
7930 ;; be sorted.
7931 (lambda nil
7932 (if (re-search-forward re nil t)
7933 (goto-char (match-beginning 0))
7934 (goto-char (point-max))))
7935 ;; This function moves to the last character of the "record" being
7936 ;; sorted.
7937 (lambda nil
7938 (save-match-data
7939 (condition-case nil
7940 (outline-forward-same-level 1)
7941 (error
7942 (goto-char (point-max))))))
7943 ;; This function returns the value that gets sorted against.
7944 (lambda nil
7945 (cond
7946 ((= dcst ?n)
7947 (if (looking-at org-complex-heading-regexp)
7948 (string-to-number (match-string 4))
7949 nil))
7950 ((= dcst ?a)
7951 (if (looking-at org-complex-heading-regexp)
7952 (funcall case-func (match-string 4))
7953 nil))
7954 ((= dcst ?t)
7955 (let ((end (save-excursion (outline-next-heading) (point))))
7956 (if (or (re-search-forward org-ts-regexp end t)
7957 (re-search-forward org-ts-regexp-both end t))
7958 (org-time-string-to-seconds (match-string 0))
7959 (org-float-time now))))
7960 ((= dcst ?c)
7961 (let ((end (save-excursion (outline-next-heading) (point))))
7962 (if (re-search-forward
7964 end t)
7965 (org-time-string-to-seconds (match-string 0))
7966 (org-float-time now))))
7967 ((= dcst ?s)
7968 (let ((end (save-excursion (outline-next-heading) (point))))
7969 (if (re-search-forward org-scheduled-time-regexp end t)
7970 (org-time-string-to-seconds (match-string 1))
7971 (org-float-time now))))
7972 ((= dcst ?d)
7973 (let ((end (save-excursion (outline-next-heading) (point))))
7974 (if (re-search-forward org-deadline-time-regexp end t)
7975 (org-time-string-to-seconds (match-string 1))
7976 (org-float-time now))))
7977 ((= dcst ?p)
7978 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7979 (string-to-char (match-string 2))
7980 org-default-priority))
7981 ((= dcst ?r)
7982 (or (org-entry-get nil property) ""))
7983 ((= dcst ?o)
7984 (if (looking-at org-complex-heading-regexp)
7985 (- 9999 (length (member (match-string 2)
7986 org-todo-keywords-1)))))
7987 ((= dcst ?f)
7988 (if getkey-func
7989 (progn
7990 (setq tmp (funcall getkey-func))
7991 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7992 tmp)
7993 (error "Invalid key function `%s'" getkey-func)))
7994 (t (error "Invalid sorting type `%c'" sorting-type))))
7995 nil
7996 (cond
7997 ((= dcst ?a) 'string<)
7998 ((= dcst ?f) compare-func)
7999 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8000 (t nil)))))
8001 (run-hooks 'org-after-sorting-entries-or-items-hook)
8002 (message "Sorting entries...done")))
8004 (defun org-do-sort (table what &optional with-case sorting-type)
8005 "Sort TABLE of WHAT according to SORTING-TYPE.
8006 The user will be prompted for the SORTING-TYPE if the call to this
8007 function does not specify it. WHAT is only for the prompt, to indicate
8008 what is being sorted. The sorting key will be extracted from
8009 the car of the elements of the table.
8010 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8011 (unless sorting-type
8012 (message
8013 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8014 what)
8015 (setq sorting-type (read-char-exclusive)))
8016 (let ((dcst (downcase sorting-type))
8017 extractfun comparefun)
8018 ;; Define the appropriate functions
8019 (cond
8020 ((= dcst ?n)
8021 (setq extractfun 'string-to-number
8022 comparefun (if (= dcst sorting-type) '< '>)))
8023 ((= dcst ?a)
8024 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8025 (lambda(x) (downcase (org-sort-remove-invisible x))))
8026 comparefun (if (= dcst sorting-type)
8027 'string<
8028 (lambda (a b) (and (not (string< a b))
8029 (not (string= a b)))))))
8030 ((= dcst ?t)
8031 (setq extractfun
8032 (lambda (x)
8033 (if (or (string-match org-ts-regexp x)
8034 (string-match org-ts-regexp-both x))
8035 (org-float-time
8036 (org-time-string-to-time (match-string 0 x)))
8037 0))
8038 comparefun (if (= dcst sorting-type) '< '>)))
8039 (t (error "Invalid sorting type `%c'" sorting-type)))
8041 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8042 table)
8043 (lambda (a b) (funcall comparefun (car a) (car b))))))
8046 ;;; The orgstruct minor mode
8048 ;; Define a minor mode which can be used in other modes in order to
8049 ;; integrate the org-mode structure editing commands.
8051 ;; This is really a hack, because the org-mode structure commands use
8052 ;; keys which normally belong to the major mode. Here is how it
8053 ;; works: The minor mode defines all the keys necessary to operate the
8054 ;; structure commands, but wraps the commands into a function which
8055 ;; tests if the cursor is currently at a headline or a plain list
8056 ;; item. If that is the case, the structure command is used,
8057 ;; temporarily setting many Org-mode variables like regular
8058 ;; expressions for filling etc. However, when any of those keys is
8059 ;; used at a different location, function uses `key-binding' to look
8060 ;; up if the key has an associated command in another currently active
8061 ;; keymap (minor modes, major mode, global), and executes that
8062 ;; command. There might be problems if any of the keys is otherwise
8063 ;; used as a prefix key.
8065 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8066 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8067 ;; addresses this by checking explicitly for both bindings.
8069 (defvar orgstruct-mode-map (make-sparse-keymap)
8070 "Keymap for the minor `orgstruct-mode'.")
8072 (defvar org-local-vars nil
8073 "List of local variables, for use by `orgstruct-mode'.")
8075 ;;;###autoload
8076 (define-minor-mode orgstruct-mode
8077 "Toggle the minor mode `orgstruct-mode'.
8078 This mode is for using Org-mode structure commands in other
8079 modes. The following keys behave as if Org-mode were active, if
8080 the cursor is on a headline, or on a plain list item (both as
8081 defined by Org-mode).
8083 M-up Move entry/item up
8084 M-down Move entry/item down
8085 M-left Promote
8086 M-right Demote
8087 M-S-up Move entry/item up
8088 M-S-down Move entry/item down
8089 M-S-left Promote subtree
8090 M-S-right Demote subtree
8091 M-q Fill paragraph and items like in Org-mode
8092 C-c ^ Sort entries
8093 C-c - Cycle list bullet
8094 TAB Cycle item visibility
8095 M-RET Insert new heading/item
8096 S-M-RET Insert new TODO heading / Checkbox item
8097 C-c C-c Set tags / toggle checkbox"
8098 nil " OrgStruct" nil
8099 (org-load-modules-maybe)
8100 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8102 ;;;###autoload
8103 (defun turn-on-orgstruct ()
8104 "Unconditionally turn on `orgstruct-mode'."
8105 (orgstruct-mode 1))
8107 (defun orgstruct++-mode (&optional arg)
8108 "Toggle `orgstruct-mode', the enhanced version of it.
8109 In addition to setting orgstruct-mode, this also exports all indentation
8110 and autofilling variables from org-mode into the buffer. It will also
8111 recognize item context in multiline items.
8112 Note that turning off orgstruct-mode will *not* remove the
8113 indentation/paragraph settings. This can only be done by refreshing the
8115 (interactive "P")
8116 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8117 (if (< arg 1)
8118 (orgstruct-mode -1)
8119 (orgstruct-mode 1)
8120 (let (var val)
8121 (mapc
8122 (lambda (x)
8123 (when (string-match
8125 (symbol-name (car x)))
8126 (setq var (car x) val (nth 1 x))
8127 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8128 org-local-vars)
8129 (org-set-local 'orgstruct-is-++ t))))
8131 (defvar orgstruct-is-++ nil
8132 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8133 (make-variable-buffer-local 'orgstruct-is-++)
8135 ;;;###autoload
8136 (defun turn-on-orgstruct++ ()
8137 "Unconditionally turn on `orgstruct++-mode'."
8138 (orgstruct++-mode 1))
8140 (defun orgstruct-error ()
8141 "Error when there is no default binding for a structure key."
8142 (interactive)
8143 (error "This key has no function outside structure elements"))
8145 (defun orgstruct-setup ()
8146 "Setup orgstruct keymaps."
8147 (let ((nfunc 0)
8148 (bindings
8149 (list
8150 '([(meta up)] org-metaup)
8151 '([(meta down)] org-metadown)
8152 '([(meta left)] org-metaleft)
8153 '([(meta right)] org-metaright)
8154 '([(meta shift up)] org-shiftmetaup)
8155 '([(meta shift down)] org-shiftmetadown)
8156 '([(meta shift left)] org-shiftmetaleft)
8157 '([(meta shift right)] org-shiftmetaright)
8158 '([?\e (up)] org-metaup)
8159 '([?\e (down)] org-metadown)
8160 '([?\e (left)] org-metaleft)
8161 '([?\e (right)] org-metaright)
8162 '([?\e (shift up)] org-shiftmetaup)
8163 '([?\e (shift down)] org-shiftmetadown)
8164 '([?\e (shift left)] org-shiftmetaleft)
8165 '([?\e (shift right)] org-shiftmetaright)
8166 '([(shift up)] org-shiftup)
8167 '([(shift down)] org-shiftdown)
8168 '([(shift left)] org-shiftleft)
8169 '([(shift right)] org-shiftright)
8170 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8171 '("\M-q" fill-paragraph)
8172 '("\C-c^" org-sort)
8173 '("\C-c-" org-cycle-list-bullet)))
8174 elt key fun cmd)
8175 (while (setq elt (pop bindings))
8176 (setq nfunc (1+ nfunc))
8177 (setq key (org-key (car elt))
8178 fun (nth 1 elt)
8179 cmd (orgstruct-make-binding fun nfunc key))
8180 (org-defkey orgstruct-mode-map key cmd))
8182 ;; Special treatment needed for TAB and RET
8183 (org-defkey orgstruct-mode-map [(tab)]
8184 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8185 (org-defkey orgstruct-mode-map "\C-i"
8186 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8188 (org-defkey orgstruct-mode-map "\M-\C-m"
8189 (orgstruct-make-binding 'org-insert-heading 105
8190 "\M-\C-m" [(meta return)]))
8191 (org-defkey orgstruct-mode-map [(meta return)]
8192 (orgstruct-make-binding 'org-insert-heading 106
8193 [(meta return)] "\M-\C-m"))
8195 (org-defkey orgstruct-mode-map [(shift meta return)]
8196 (orgstruct-make-binding 'org-insert-todo-heading 107
8197 [(meta return)] "\M-\C-m"))
8199 (org-defkey orgstruct-mode-map "\e\C-m"
8200 (orgstruct-make-binding 'org-insert-heading 108
8201 "\e\C-m" [?\e (return)]))
8202 (org-defkey orgstruct-mode-map [?\e (return)]
8203 (orgstruct-make-binding 'org-insert-heading 109
8204 [?\e (return)] "\e\C-m"))
8205 (org-defkey orgstruct-mode-map [?\e (shift return)]
8206 (orgstruct-make-binding 'org-insert-todo-heading 110
8207 [?\e (return)] "\e\C-m"))
8209 (unless org-local-vars
8210 (setq org-local-vars (org-get-local-variables)))
8212 t))
8214 (defun orgstruct-make-binding (fun n &rest keys)
8215 "Create a function for binding in the structure minor mode.
8216 FUN is the command to call inside a table. N is used to create a unique
8217 command name. KEYS are keys that should be checked in for a command
8218 to execute outside of tables."
8219 (eval
8220 (list 'defun
8221 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8222 '(arg)
8224 "Outside of structure, run the binding of `"
8225 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8226 "'.")
8227 '(interactive "p")
8228 (list 'if
8229 `(org-context-p 'headline 'item
8230 (and orgstruct-is-++
8231 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8232 'item-body))
8233 (list 'org-run-like-in-org-mode (list 'quote fun))
8234 (list 'let '(orgstruct-mode)
8235 (list 'call-interactively
8236 (append '(or)
8237 (mapcar (lambda (k)
8238 (list 'key-binding k))
8239 keys)
8240 '('orgstruct-error))))))))
8242 (defun org-context-p (&rest contexts)
8243 "Check if local context is any of CONTEXTS.
8244 Possible values in the list of contexts are `table', `headline', and `item'."
8245 (let ((pos (point)))
8246 (goto-char (point-at-bol))
8247 (prog1 (or (and (memq 'table contexts)
8249 (and (memq 'headline contexts)
8250 (looking-at org-outline-regexp))
8251 (and (memq 'item contexts)
8253 (and (memq 'item-body contexts)
8254 (org-in-item-p)))
8255 (goto-char pos))))
8257 (defun org-get-local-variables ()
8258 "Return a list of all local variables in an org-mode buffer."
8259 (let (varlist)
8260 (with-current-buffer (get-buffer-create "*Org tmp*")
8261 (erase-buffer)
8262 (org-mode)
8263 (setq varlist (buffer-local-variables)))
8264 (kill-buffer "*Org tmp*")
8265 (delq nil
8266 (mapcar
8267 (lambda (x)
8268 (setq x
8269 (if (symbolp x)
8270 (list x)
8271 (list (car x) (list 'quote (cdr x)))))
8272 (if (string-match
8273 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8274 (symbol-name (car x)))
8275 x nil))
8276 varlist))))
8278 (defun org-clone-local-variables (from-buffer &optional regexp)
8279 "Clone local variables from FROM-BUFFER.
8280 Optional argument REGEXP selects variables to clone."
8281 (mapc
8282 (lambda (pair)
8283 (and (symbolp (car pair))
8284 (or (null regexp)
8285 (string-match regexp (symbol-name (car pair))))
8286 (set (make-local-variable (car pair))
8287 (cdr pair))))
8288 (buffer-local-variables from-buffer)))
8290 ;;;###autoload
8291 (defun org-run-like-in-org-mode (cmd)
8292 "Run a command, pretending that the current buffer is in Org-mode.
8293 This will temporarily bind local variables that are typically bound in
8294 Org-mode to the values they have in Org-mode, and then interactively
8295 call CMD."
8296 (org-load-modules-maybe)
8297 (unless org-local-vars
8298 (setq org-local-vars (org-get-local-variables)))
8299 (eval (list 'let org-local-vars
8300 (list 'call-interactively (list 'quote cmd)))))
8302 ;;;; Archiving
8304 (defun org-get-category (&optional pos force-refresh)
8305 "Get the category applying to position POS."
8306 (if force-refresh (org-refresh-category-properties))
8307 (let ((pos (or pos (point))))
8308 (or (get-text-property pos 'org-category)
8309 (progn (org-refresh-category-properties)
8310 (get-text-property pos 'org-category)))))
8312 (defun org-refresh-category-properties ()
8313 "Refresh category text properties in the buffer."
8314 (let ((def-cat (cond
8315 ((null org-category)
8316 (if buffer-file-name
8317 (file-name-sans-extension
8318 (file-name-nondirectory buffer-file-name))
8319 "???"))
8320 ((symbolp org-category) (symbol-name org-category))
8321 (t org-category)))
8322 beg end cat pos optionp)
8323 (org-unmodified
8324 (save-excursion
8325 (save-restriction
8326 (widen)
8327 (goto-char (point-min))
8328 (put-text-property (point) (point-max) 'org-category def-cat)
8329 (while (re-search-forward
8331 (setq pos (match-end 0)
8332 optionp (equal (char-after (match-beginning 0)) ?#)
8333 cat (org-trim (match-string 2)))
8334 (if optionp
8335 (setq beg (point-at-bol) end (point-max))
8336 (org-back-to-heading t)
8337 (setq beg (point) end (org-end-of-subtree t t)))
8338 (put-text-property beg end 'org-category cat)
8339 (goto-char pos)))))))
8342 ;;;; Link Stuff
8344 ;;; Link abbreviations
8346 (defun org-link-expand-abbrev (link)
8347 "Apply replacements as defined in `org-link-abbrev-alist."
8349 (let* ((key (match-string 1 link))
8350 (as (or (assoc key org-link-abbrev-alist-local)
8351 (assoc key org-link-abbrev-alist)))
8352 (tag (and (match-end 2) (match-string 3 link)))
8353 rpl)
8354 (if (not as)
8355 link
8356 (setq rpl (cdr as))
8357 (cond
8358 ((symbolp rpl) (funcall rpl tag))
8359 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8360 ((string-match "%h" rpl)
8361 (replace-match (url-hexify-string (or tag "")) t t rpl))
8362 (t (concat rpl tag)))))
8363 link))
8365 ;;; Storing and inserting links
8367 (defvar org-insert-link-history nil
8368 "Minibuffer history for links inserted with `org-insert-link'.")
8370 (defvar org-stored-links nil
8371 "Contains the links stored with `org-store-link'.")
8373 (defvar org-store-link-plist nil
8374 "Plist with info about the most recently link created with `org-store-link'.")
8376 (defvar org-link-protocols nil
8377 "Link protocols added to Org-mode using `org-add-link-type'.")
8379 (defvar org-store-link-functions nil
8380 "List of functions that are called to create and store a link.
8381 Each function will be called in turn until one returns a non-nil
8382 value. Each function should check if it is responsible for creating
8383 this link (for example by looking at the major mode).
8384 If not, it must exit and return nil.
8385 If yes, it should return a non-nil value after a calling
8386 `org-store-link-props' with a list of properties and values.
8387 Special properties are:
8391 This is obligatory as well.
8392 :description Optional default description for the second pair
8393 of brackets in an Org-mode link. The user can still change
8394 this when inserting this link into an Org-mode buffer.
8396 In addition to these, any additional properties can be specified
8397 and then used in remember templates.")
8399 (defun org-add-link-type (type &optional follow export)
8400 "Add TYPE to the list of `org-link-types'.
8401 Re-compute all regular expressions depending on `org-link-types'
8403 FOLLOW and EXPORT are two functions.
8405 FOLLOW should take the link path as the single argument and do whatever
8406 is necessary to follow the link, for example find a file or display
8407 a mail message.
8409 EXPORT should format the link path for export to one of the export formats.
8410 It should be a function accepting three arguments:
8413 desc the description of the link, if any, or a description added by
8414 org-export-normalize-links if there is none
8415 format the export format, a symbol like `html' or `latex' or `ascii'..
8417 The function may use the FORMAT information to return different values
8418 depending on the format. The return value will be put literally into
8419 the exported file. If the return value is nil, this means Org should
8420 do what it normally does with links which do not have EXPORT defined.
8422 Org-mode has a built-in default for exporting links. If you are happy with
8423 this default, there is no need to define an export function for the link
8424 type. For a simple example of an export function, see `org-bbdb.el'."
8425 (add-to-list 'org-link-types type t)
8426 (org-make-link-regexps)
8427 (if (assoc type org-link-protocols)
8428 (setcdr (assoc type org-link-protocols) (list follow export))
8429 (push (list type follow export) org-link-protocols)))
8431 (defvar org-agenda-buffer-name)
8433 ;;;###autoload
8434 (defun org-store-link (arg)
8436 This link is added to `org-stored-links' and can later be inserted
8439 For some link types, a prefix arg is interpreted:
8440 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8441 For file links, arg negates `org-context-in-file-links'."
8442 (interactive "P")
8443 (org-load-modules-maybe)
8444 (setq org-store-link-plist nil) ; reset
8445 (org-with-limited-levels
8446 (let (link cpltxt desc description search txt custom-id agenda-link)
8447 (cond
8449 ((run-hook-with-args-until-success 'org-store-link-functions)
8450 (setq link (plist-get org-store-link-plist :link)
8451 desc (or (plist-get org-store-link-plist :description) link)))
8453 ((equal (buffer-name) "*Org Edit Src Example*")
8454 (let (label gc)
8455 (while (or (not label)
8456 (save-excursion
8457 (save-restriction
8458 (widen)
8459 (goto-char (point-min))
8460 (re-search-forward
8461 (regexp-quote (format org-coderef-label-format label))
8462 nil t))))
8463 (when label (message "Label exists already") (sit-for 2))
8464 (setq label (read-string "Code line label: " label)))
8465 (end-of-line 1)
8466 (setq link (format org-coderef-label-format label))
8467 (setq gc (- 79 (length link)))
8468 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8469 (insert link)
8470 (setq link (concat "(" label ")") desc nil)))
8472 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8473 ;; We are in the agenda, link to referenced location
8474 (let ((m (or (get-text-property (point) 'org-hd-marker)
8475 (get-text-property (point) 'org-marker))))
8476 (when m
8477 (org-with-point-at m
8478 (setq agenda-link
8479 (if (org-called-interactively-p 'any)
8480 (call-interactively 'org-store-link)
8481 (org-store-link nil)))))))
8483 ((eq major-mode 'calendar-mode)
8484 (let ((cd (calendar-cursor-to-date)))
8485 (setq link
8486 (format-time-string
8487 (car org-time-stamp-formats)
8488 (apply 'encode-time
8489 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8490 nil nil nil))))
8491 (org-store-link-props :type "calendar" :date cd)))
8493 ((eq major-mode 'w3-mode)
8494 (setq cpltxt (if (and (buffer-name)
8495 (not (string-match "Untitled" (buffer-name))))
8496 (buffer-name)
8497 (url-view-url t))
8498 link (org-make-link (url-view-url t)))
8499 (org-store-link-props :type "w3" :url (url-view-url t)))
8501 ((eq major-mode 'w3m-mode)
8502 (setq cpltxt (or w3m-current-title w3m-current-url)
8503 link (org-make-link w3m-current-url))
8504 (org-store-link-props :type "w3m" :url (url-view-url t)))
8506 ((setq search (run-hook-with-args-until-success
8507 'org-create-file-search-functions))
8508 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8509 "::" search))
8510 (setq cpltxt (or description link)))
8512 ((eq major-mode 'image-mode)
8513 (setq cpltxt (concat "file:"
8514 (abbreviate-file-name buffer-file-name))
8515 link (org-make-link cpltxt))
8516 (org-store-link-props :type "image" :file buffer-file-name))
8518 ((eq major-mode 'dired-mode)
8519 ;; link to the file in the current line
8520 (let ((file (dired-get-filename nil t)))
8521 (setq file (if file
8522 (abbreviate-file-name
8523 (expand-file-name (dired-get-filename nil t)))
8524 ;; otherwise, no file so use current directory.
8525 default-directory))
8526 (setq cpltxt (concat "file:" file)
8527 link (org-make-link cpltxt))))
8529 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8530 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8531 (cond
8533 (setq cpltxt
8534 (concat "file:"
8535 (abbreviate-file-name
8536 (buffer-file-name (buffer-base-buffer)))
8537 "::" (match-string 1))
8538 link (org-make-link cpltxt)))
8539 ((and (featurep 'org-id)
8540 (or (eq org-link-to-org-use-id t)
8541 (and (eq org-link-to-org-use-id 'create-if-interactive)
8542 (org-called-interactively-p 'any))
8543 (and (eq org-link-to-org-use-id
8544 'create-if-interactive-and-no-custom-id)
8545 (org-called-interactively-p 'any)
8546 (not custom-id))
8547 (and org-link-to-org-use-id
8548 (org-entry-get nil "ID"))))
8549 ;; We can make a link using the ID.
8550 (setq link (condition-case nil
8551 (prog1 (org-id-store-link)
8552 (setq desc (plist-get org-store-link-plist
8553 :description)))
8554 (error
8555 ;; probably before first headline, link to file only
8556 (concat "file:"
8557 (abbreviate-file-name
8558 (buffer-file-name (buffer-base-buffer))))))))
8559 (t
8560 ;; Just link to current headline
8561 (setq cpltxt (concat "file:"
8562 (abbreviate-file-name
8563 (buffer-file-name (buffer-base-buffer)))))
8564 ;; Add a context search string
8565 (when (org-xor org-context-in-file-links arg)
8566 (setq txt (cond
8567 ((org-on-heading-p) nil)
8568 ((org-region-active-p)
8569 (buffer-substring (region-beginning) (region-end)))
8570 (t nil)))
8572 (setq cpltxt
8573 (concat cpltxt "::"
8574 (condition-case nil
8575 (org-make-org-heading-search-string txt)
8576 (error "")))
8577 desc (or (nth 4 (ignore-errors
8578 (org-heading-components))) "NONE"))))
8580 (setq cpltxt (substring cpltxt 0 -2)))
8581 (setq link (org-make-link cpltxt)))))
8583 ((buffer-file-name (buffer-base-buffer))
8584 ;; Just link to this file here.
8585 (setq cpltxt (concat "file:"
8586 (abbreviate-file-name
8587 (buffer-file-name (buffer-base-buffer)))))
8588 ;; Add a context string
8589 (when (org-xor org-context-in-file-links arg)
8590 (setq txt (if (org-region-active-p)
8591 (buffer-substring (region-beginning) (region-end))
8592 (buffer-substring (point-at-bol) (point-at-eol))))
8593 ;; Only use search option if there is some text.
8595 (setq cpltxt
8596 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8597 desc "NONE")))
8598 (setq link (org-make-link cpltxt)))
8600 ((org-called-interactively-p 'interactive)
8601 (error "Cannot link to a buffer which is not visiting a file"))
8603 (t (setq link nil)))
8605 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8606 (setq link (or link cpltxt)
8607 desc (or desc cpltxt))
8608 (if (equal desc "NONE") (setq desc nil))
8610 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8611 (progn
8612 (setq org-stored-links
8613 (cons (list link desc) org-stored-links))
8614 (message "Stored: %s" (or desc link))
8615 (when custom-id
8616 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8617 "::#" custom-id))
8618 (setq org-stored-links
8619 (cons (list link desc) org-stored-links))))
8620 (or agenda-link (and link (org-make-link-string link desc)))))))
8622 (defun org-store-link-props (&rest plist)
8623 "Store link properties, extract names and addresses."
8624 (let (x adr)
8625 (when (setq x (plist-get plist :from))
8626 (setq adr (mail-extract-address-components x))
8627 (setq plist (plist-put plist :fromname (car adr)))
8628 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8629 (when (setq x (plist-get plist :to))
8630 (setq adr (mail-extract-address-components x))
8631 (setq plist (plist-put plist :toname (car adr)))
8632 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8633 (let ((from (plist-get plist :from))
8634 (to (plist-get plist :to)))
8635 (when (and from to org-from-is-user-regexp)
8636 (setq plist
8637 (plist-put plist :fromto
8638 (if (string-match org-from-is-user-regexp from)
8639 (concat "to %t")
8640 (concat "from %f"))))))
8641 (setq org-store-link-plist plist))
8643 (defun org-add-link-props (&rest plist)
8644 "Add these properties to the link property list."
8645 (let (key value)
8646 (while plist
8647 (setq key (pop plist) value (pop plist))
8648 (setq org-store-link-plist
8649 (plist-put org-store-link-plist key value)))))
8651 (defun org-email-link-description (&optional fmt)
8652 "Return the description part of an email link.
8653 This takes information from `org-store-link-plist' and formats it
8654 according to FMT (default from `org-email-link-description-format')."
8655 (setq fmt (or fmt org-email-link-description-format))
8656 (let* ((p org-store-link-plist)
8657 (to (plist-get p :toaddress))
8658 (from (plist-get p :fromaddress))
8659 (table
8660 (list
8661 (cons "%c" (plist-get p :fromto))
8662 (cons "%F" (plist-get p :from))
8663 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8664 (cons "%T" (plist-get p :to))
8665 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8666 (cons "%s" (plist-get p :subject))
8667 (cons "%d" (plist-get p :date))
8668 (cons "%m" (plist-get p :message-id)))))
8669 (when (string-match "%c" fmt)
8670 ;; Check if the user wrote this message
8671 (if (and org-from-is-user-regexp from to
8672 (save-match-data (string-match org-from-is-user-regexp from)))
8673 (setq fmt (replace-match "to %t" t t fmt))
8674 (setq fmt (replace-match "from %f" t t fmt))))
8675 (org-replace-escapes fmt table)))
8677 (defun org-make-org-heading-search-string (&optional string heading)
8678 "Make search string for STRING or current headline."
8679 (interactive)
8680 (let ((s (or string (org-get-heading)))
8681 (lines org-context-in-file-links))
8682 (unless (and string (not heading))
8683 ;; We are using a headline, clean up garbage in there.
8684 (if (string-match org-todo-regexp s)
8685 (setq s (replace-match "" t t s)))
8687 (setq s (replace-match "" t t s)))
8688 (setq s (org-trim s))
8691 (setq s (replace-match "" t t s)))
8692 (while (string-match org-ts-regexp s)
8693 (setq s (replace-match "" t t s))))
8694 (or string (setq s (concat "*" s))) ; Add * for headlines
8695 (when (and string (integerp lines) (> lines 0))
8697 (when (< lines (length slines))
8698 (setq s (mapconcat
8699 'identity
8700 (reverse (nthcdr (- (length slines) lines)
8704 (defun org-make-link (&rest strings)
8705 "Concatenate STRINGS."
8706 (apply 'concat strings))
8708 (defun org-make-link-string (link &optional description)
8709 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8711 (error "Empty link"))
8712 (when (and description
8713 (stringp description)
8715 (setq description nil))
8716 (when (stringp description)
8717 ;; Remove brackets from the description, they are fatal.
8719 (setq description (replace-match "{" t t description)))
8721 (setq description (replace-match "}" t t description))))
8722 (when (equal link description)
8723 ;; No description needed, it is identical
8724 (setq description nil))
8725 (when (and (not description)
8726 (not (string-match (org-image-file-name-regexp) link))
8727 (not (equal link (org-link-escape link))))
8728 (setq description (org-extract-attributes link)))
8729 (setq link
8730 (cond ((string-match (org-image-file-name-regexp) link) link)
8731 ((string-match org-link-types-re link)
8732 (concat (match-string 1 link)
8733 (org-link-escape (substring link (match-end 1)))))
8734 (t (org-link-escape link))))
8735 (concat "[[" link "]"
8736 (if description (concat "[" description "]") "")
8737 "]"))
8739 (defconst org-link-escape-chars
8740 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8741 "List of characters that should be escaped in link.
8742 This is the list that is used for internal purposes.")
8744 (defvar org-url-encoding-use-url-hexify nil)
8746 (defconst org-link-escape-chars-browser
8747 '(?\ )
8748 "List of escapes for characters that are problematic in links.
8749 This is the list that is used before handing over to the browser.")
8751 (defun org-link-escape (text &optional table merge)
8752 "Return percent escaped representation of TEXT.
8753 TEXT is a string with the text to escape.
8754 Optional argument TABLE is a list with characters that should be
8755 escaped. When nil, `org-link-escape-chars' is used.
8756 If optional argument MERGE is set, merge TABLE into
8757 `org-link-escape-chars'."
8758 (if (and org-url-encoding-use-url-hexify (not table))
8759 (url-hexify-string text)
8760 (cond
8761 ((and table merge)
8762 (mapc (lambda (defchr)
8763 (unless (member defchr table)
8764 (setq table (cons defchr table)))) org-link-escape-chars))
8765 ((null table)
8766 (setq table org-link-escape-chars)))
8767 (mapconcat
8768 (lambda (char)
8769 (if (or (member char table)
8770 (< char 32) (= char 37) (> char 126))
8771 (mapconcat (lambda (sequence-element)
8772 (format "%%%.2X" sequence-element))
8773 (or (encode-coding-char char 'utf-8)
8774 (error "Unable to percent escape character: %s"
8775 (char-to-string char))) "")
8776 (char-to-string char))) text "")))
8778 (defun org-link-unescape (str)
8779 "Unhex hexified unicode strings as returned from the JavaScript function
8780 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8781 (unless (and (null str) (string= "" str))
8782 (let ((pos 0) (case-fold-search t) unhexed)
8784 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8785 (setq str (replace-match unhexed t t str))
8786 (setq pos (+ pos (length unhexed))))))
8787 str)
8789 (defun org-link-unescape-compound (hex)
8790 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8791 Note: this function also decodes single byte encodings like
8793 (save-match-data
8794 (let* ((bytes (cdr (split-string hex "%")))
8795 (ret "")
8796 (eat 0)
8797 (sum 0))
8798 (while bytes
8799 (let* ((val (string-to-number (pop bytes) 16))
8800 (shift-xor
8801 (if (= 0 eat)
8802 (cond
8803 ((>= val 252) (cons 6 252))
8804 ((>= val 248) (cons 5 248))
8805 ((>= val 240) (cons 4 240))
8806 ((>= val 224) (cons 3 224))
8807 ((>= val 192) (cons 2 192))
8808 (t (cons 0 0)))
8809 (cons 6 128))))
8810 (if (>= val 192) (setq eat (car shift-xor)))
8811 (setq val (logxor val (cdr shift-xor)))
8812 (setq sum (+ (lsh sum (car shift-xor)) val))
8813 (if (> eat 0) (setq eat (- eat 1)))
8814 (cond
8815 ((= 0 eat) ;multi byte
8816 (setq ret (concat ret (org-char-to-string sum)))
8817 (setq sum 0))
8818 ((not bytes) ; single byte(s)
8819 (setq ret (org-link-unescape-single-byte-sequence hex))))
8820 )) ;; end (while bytes
8821 ret )))
8823 (defun org-link-unescape-single-byte-sequence (hex)
8824 "Unhexify hex-encoded single byte character sequences."
8825 (mapconcat (lambda (byte)
8826 (char-to-string (string-to-number byte 16)))
8827 (cdr (split-string hex "%")) ""))
8829 (defun org-xor (a b)
8830 "Exclusive or."
8831 (if a (not b) b))
8833 (defun org-fixup-message-id-for-http (s)
8834 "Replace special characters in a message id, so it can be used in an http query."
8835 (when (string-match "%" s)
8836 (setq s (mapconcat (lambda (c)
8837 (if (eq c ?%)
8838 "%25"
8839 (char-to-string c)))
8840 s "")))
8841 (while (string-match "<" s)
8842 (setq s (replace-match "%3C" t t s)))
8843 (while (string-match ">" s)
8844 (setq s (replace-match "%3E" t t s)))
8845 (while (string-match "@" s)
8846 (setq s (replace-match "%40" t t s)))
8847 s)
8849 ;;;###autoload
8850 (defun org-insert-link-global ()
8851 "Insert a link like Org-mode does.
8852 This command can be called in any mode to insert a link in Org-mode syntax."
8853 (interactive)
8854 (org-load-modules-maybe)
8855 (org-run-like-in-org-mode 'org-insert-link))
8857 (defun org-insert-link (&optional complete-file link-location)
8858 "Insert a link. At the prompt, enter the link.
8860 Completion can be used to insert any of the link protocol prefixes like
8861 http or ftp in use.
8863 The history can be used to select a link previously stored with
8864 `org-store-link'. When the empty string is entered (i.e. if you just
8865 press RET at the prompt), the link defaults to the most recently
8866 stored link. As SPC triggers completion in the minibuffer, you need to
8867 use M-SPC or C-q SPC to force the insertion of a space character.
8869 You will also be prompted for a description, and if one is given, it will
8870 be displayed in the buffer instead of the link.
8872 If there is already a link at point, this command will allow you to edit link
8873 and description parts.
8876 be selected using completion. The path to the file will be relative to the
8877 current directory if the file is in the current directory or a subdirectory.
8878 Otherwise, the link will be the absolute path as completed in the minibuffer
8879 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8880 option `org-link-file-path-type'.
8883 the current directory or below.
8886 `org-keep-stored-link-after-insertion'.
8888 If `org-make-link-description-function' is non-nil, this function will be
8889 called with the link target, and the result will be the default
8890 link description.
8892 If the LINK-LOCATION parameter is non-nil, this value will be
8893 used as the link location instead of reading one interactively."
8894 (interactive "P")
8895 (let* ((wcf (current-window-configuration))
8896 (region (if (org-region-active-p)
8897 (buffer-substring (region-beginning) (region-end))))
8898 (remove (and region (list (region-beginning) (region-end))))
8899 (desc region)
8900 tmphist ; byte-compile incorrectly complains about this
8901 (link link-location)
8902 entry file all-prefixes)
8903 (cond
8904 (link-location) ; specified by arg, just use it.
8905 ((org-in-regexp org-bracket-link-regexp 1)
8906 ;; We do have a link at point, and we are going to edit it.
8907 (setq remove (list (match-beginning 0) (match-end 0)))
8908 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8909 (setq link (read-string "Link: "
8910 (org-link-unescape
8911 (org-match-string-no-properties 1)))))
8912 ((or (org-in-regexp org-angle-link-re)
8913 (org-in-regexp org-plain-link-re))
8914 ;; Convert to bracket link
8915 (setq remove (list (match-beginning 0) (match-end 0))
8916 link (read-string "Link: "
8917 (org-remove-angle-brackets (match-string 0)))))
8918 ((member complete-file '((4) (16)))
8919 ;; Completing read for file names.
8920 (setq link (org-file-complete-link complete-file)))
8921 (t
8922 ;; Read link, with completion for stored links.
8923 (with-output-to-temp-buffer "*Org Links*"
8924 (princ "Insert a link.
8926 (when org-stored-links
8928 (princ (mapconcat
8929 (lambda (x)
8930 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8932 (let ((cw (selected-window)))
8933 (select-window (get-buffer-window "*Org Links*" 'visible))
8934 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8935 (unless (pos-visible-in-window-p (point-max))
8936 (org-fit-window-to-buffer))
8937 (and (window-live-p cw) (select-window cw)))
8938 ;; Fake a link history, containing the stored links.
8939 (setq tmphist (append (mapcar 'car org-stored-links)
8940 org-insert-link-history))
8941 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8942 (mapcar 'car org-link-abbrev-alist)
8943 org-link-types))
8944 (unwind-protect
8945 (progn
8946 (setq link
8947 (let ((org-completion-use-ido nil)
8948 (org-completion-use-iswitchb nil))
8949 (org-completing-read
8950 "Link: "
8951 (append
8952 (mapcar (lambda (x) (list (concat x ":")))
8953 all-prefixes)
8954 (mapcar 'car org-stored-links))
8955 nil nil nil
8956 'tmphist
8957 (car (car org-stored-links)))))
8959 (error "No link selected"))
8960 (if (or (member link all-prefixes)
8961 (and (equal ":" (substring link -1))
8962 (member (substring link 0 -1) all-prefixes)
8963 (setq link (substring link 0 -1))))
8964 (setq link (org-link-try-special-completion link))))
8965 (set-window-configuration wcf)
8966 (kill-buffer "*Org Links*"))
8967 (setq entry (assoc link org-stored-links))
8968 (or entry (push link org-insert-link-history))
8969 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8970 (not org-keep-stored-link-after-insertion))
8971 (setq org-stored-links (delq (assoc link org-stored-links)
8972 org-stored-links)))
8973 (setq desc (or desc (nth 1 entry)))))
8975 (if (string-match org-plain-link-re link)
8976 ;; URL-like link, normalize the use of angular brackets.
8977 (setq link (org-make-link (org-remove-angle-brackets link))))
8979 ;; Check if we are linking to the current file with a search option
8980 ;; If yes, simplify the link by using only the search option.
8981 (when (and buffer-file-name
8983 (let* ((path (match-string 1 link))
8984 (case-fold-search nil)
8985 (search (match-string 2 link)))
8986 (save-match-data
8987 (if (equal (file-truename buffer-file-name) (file-truename path))
8988 ;; We are linking to this same file, with a search option
8989 (setq link search)))))
8991 ;; Check if we can/should use a relative path. If yes, simplify the link
8993 (let* ((type (match-string 1 link))
8994 (path (match-string 2 link))
8995 (origpath path)
8996 (case-fold-search nil))
8997 (cond
8998 ((or (eq org-link-file-path-type 'absolute)
8999 (equal complete-file '(16)))
9000 (setq path (abbreviate-file-name (expand-file-name path))))
9001 ((eq org-link-file-path-type 'noabbrev)
9002 (setq path (expand-file-name path)))
9003 ((eq org-link-file-path-type 'relative)
9004 (setq path (file-relative-name path)))
9005 (t
9006 (save-match-data
9007 (if (string-match (concat "^" (regexp-quote
9008 (expand-file-name
9009 (file-name-as-directory
9010 default-directory))))
9011 (expand-file-name path))
9012 ;; We are linking a file with relative path name.
9013 (setq path (substring (expand-file-name path)
9014 (match-end 0)))
9015 (setq path (abbreviate-file-name (expand-file-name path)))))))
9016 (setq link (concat type path))
9017 (if (equal desc origpath)
9018 (setq desc path))))
9020 (if org-make-link-description-function
9021 (setq desc (funcall org-make-link-description-function link desc)))
9023 (setq desc (read-string "Description: " desc))
9025 (if remove (apply 'delete-region remove))
9026 (insert (org-make-link-string link desc))))
9028 (defun org-link-try-special-completion (type)
9029 "If there is completion support for link type TYPE, offer it."
9030 (let ((fun (intern (concat "org-" type "-complete-link"))))
9031 (if (functionp fun)
9032 (funcall fun)
9033 (read-string "Link (no completion support): " (concat type ":")))))
9035 (defun org-file-complete-link (&optional arg)
9036 "Create a file link using completion."
9037 (let (file link)
9038 (setq file (read-file-name "File: "))
9039 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9040 (pwd1 (file-name-as-directory (abbreviate-file-name
9041 (expand-file-name ".")))))
9042 (cond
9043 ((equal arg '(16))
9044 (setq link (org-make-link
9045 "file:"
9046 (abbreviate-file-name (expand-file-name file)))))
9048 (setq link (org-make-link "file:" (match-string 1 file))))
9050 (expand-file-name file))
9051 (setq link (org-make-link
9052 "file:" (match-string 1 (expand-file-name file)))))
9053 (t (setq link (org-make-link "file:" file)))))
9054 link))
9056 (defun org-completing-read (&rest args)
9057 "Completing-read with SPACE being a normal character."
9058 (let ((minibuffer-local-completion-map
9059 (copy-keymap minibuffer-local-completion-map)))
9060 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9061 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9062 (apply 'org-icompleting-read args)))
9064 (defun org-completing-read-no-i (&rest args)
9065 (let (org-completion-use-ido org-completion-use-iswitchb)
9066 (apply 'org-completing-read args)))
9068 (defun org-iswitchb-completing-read (prompt choices &rest args)
9069 "Use iswitch as a completing-read replacement to choose from choices.
9070 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9071 from."
9072 (let* ((iswitchb-use-virtual-buffers nil)
9073 (iswitchb-make-buflist-hook
9074 (lambda ()
9075 (setq iswitchb-temp-buflist choices))))
9076 (iswitchb-read-buffer prompt)))
9078 (defun org-icompleting-read (&rest args)
9079 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9080 (org-without-partial-completion
9081 (if (and org-completion-use-ido
9082 (fboundp 'ido-completing-read)
9083 (boundp 'ido-mode) ido-mode
9084 (listp (second args)))
9085 (let ((ido-enter-matching-directory nil))
9086 (apply 'ido-completing-read (concat (car args))
9087 (if (consp (car (nth 1 args)))
9088 (mapcar 'car (nth 1 args))
9089 (nth 1 args))
9090 (cddr args)))
9091 (if (and org-completion-use-iswitchb
9092 (boundp 'iswitchb-mode) iswitchb-mode
9093 (listp (second args)))
9094 (apply 'org-iswitchb-completing-read (concat (car args))
9095 (if (consp (car (nth 1 args)))
9096 (mapcar 'car (nth 1 args))
9097 (nth 1 args))
9098 (cddr args))
9099 (apply 'completing-read args)))))
9101 (defun org-extract-attributes (s)
9102 "Extract the attributes cookie from a string and set as text property."
9103 (let (a attr (start 0) key value)
9104 (save-match-data
9106 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9108 (setq key (match-string 1 a) value (match-string 2 a)
9109 start (match-end 0)
9110 attr (plist-put attr (intern key) value))))
9111 (org-add-props s nil 'org-attr attr))
9112 s))
9114 (defun org-extract-attributes-from-string (tag)
9115 (let (key value attr)
9117 (setq key (match-string 1 tag) value (match-string 2 tag)
9118 tag (replace-match "" t t tag)
9119 attr (plist-put attr (intern key) value)))
9120 (cons tag attr)))
9122 (defun org-attributes-to-string (plist)
9123 "Format a property list into an HTML attribute list."
9124 (let ((s "") key value)
9125 (while plist
9126 (setq key (pop plist) value (pop plist))
9127 (and value
9129 s))
9131 ;;; Opening/following a link
9133 (defvar org-link-search-failed nil)
9135 (defvar org-open-link-functions nil
9136 "Hook for functions finding a plain text link.
9137 These functions must take a single argument, the link content.
9138 They will be called for links that look like [[link text][description]]
9142 These functions will be called *before* Org attempts to resolve the
9143 link by doing text searches in the current buffer - so if you want a
9145 handle this as a special case.
9147 When the function does handle the link, it must return a non-nil value.
9148 If it decides that it is not responsible for this link, it must return
9149 nil to indicate that that Org-mode can continue with other options
9150 like exact and fuzzy text search.")
9152 (defun org-next-link ()
9153 "Move forward to the next link.
9154 If the link is in hidden text, expose it."
9155 (interactive)
9156 (when (and org-link-search-failed (eq this-command last-command))
9157 (goto-char (point-min))
9158 (message "Link search wrapped back to beginning of buffer"))
9159 (setq org-link-search-failed nil)
9160 (let* ((pos (point))
9161 (ct (org-context))
9162 (a (assoc :link ct)))
9163 (if a (goto-char (nth 2 a)))
9164 (if (re-search-forward org-any-link-re nil t)
9165 (progn
9166 (goto-char (match-beginning 0))
9167 (if (outline-invisible-p) (org-show-context)))
9168 (goto-char pos)
9169 (setq org-link-search-failed t)
9170 (error "No further link found"))))
9172 (defun org-previous-link ()
9173 "Move backward to the previous link.
9174 If the link is in hidden text, expose it."
9175 (interactive)
9176 (when (and org-link-search-failed (eq this-command last-command))
9177 (goto-char (point-max))
9178 (message "Link search wrapped back to end of buffer"))
9179 (setq org-link-search-failed nil)
9180 (let* ((pos (point))
9181 (ct (org-context))
9182 (a (assoc :link ct)))
9183 (if a (goto-char (nth 1 a)))
9184 (if (re-search-backward org-any-link-re nil t)
9185 (progn
9186 (goto-char (match-beginning 0))
9187 (if (outline-invisible-p) (org-show-context)))
9188 (goto-char pos)
9189 (setq org-link-search-failed t)
9190 (error "No further link found"))))
9192 (defun org-translate-link (s)
9193 "Translate a link string if a translation function has been defined."
9194 (if (and org-link-translation-function
9195 (fboundp org-link-translation-function)
9197 (progn
9198 (setq s (funcall org-link-translation-function
9199 (match-string 1) (match-string 2)))
9200 (concat (car s) ":" (cdr s)))
9201 s))
9203 (defun org-translate-link-from-planner (type path)
9204 "Translate a link from Emacs Planner syntax so that Org can follow it.
9205 This is still an experimental function, your mileage may vary."
9206 (cond
9207 ((member type '("http" "https" "news" "ftp"))
9208 ;; standard Internet links are the same.
9209 nil)
9210 ((and (equal type "irc") (string-match "^//" path))
9211 ;; Planner has two / at the beginning of an irc link, we have 1.
9212 ;; We should have zero, actually....
9213 (setq path (substring path 1)))
9214 ((and (equal type "lisp") (string-match "^/" path))
9215 ;; Planner has a slash, we do not.
9216 (setq type "elisp" path (substring path 1)))
9218 ;; A typical message link. Planner has the id after the final slash,
9219 ;; we separate it with a hash mark
9220 (setq path (concat (match-string 1 path) "#"
9221 (org-remove-angle-brackets (match-string 2 path)))))
9222 )
9223 (cons type path))
9225 (defun org-find-file-at-mouse (ev)
9226 "Open file link or URL at mouse."
9227 (interactive "e")
9228 (mouse-set-point ev)
9229 (org-open-at-point 'in-emacs))
9231 (defun org-open-at-mouse (ev)
9232 "Open file link or URL at mouse."
9233 (interactive "e")
9234 (mouse-set-point ev)
9235 (if (eq major-mode 'org-agenda-mode)
9236 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9237 (org-open-at-point))
9239 (defvar org-window-config-before-follow-link nil
9240 "The window configuration before following a link.
9241 This is saved in case the need arises to restore it.")
9243 (defvar org-open-link-marker (make-marker)
9244 "Marker pointing to the location where `org-open-at-point; was called.")
9246 ;;;###autoload
9247 (defun org-open-at-point-global ()
9248 "Follow a link like Org-mode does.
9249 This command can be called in any mode to follow a link that has
9250 Org-mode syntax."
9251 (interactive)
9252 (org-run-like-in-org-mode 'org-open-at-point))
9254 ;;;###autoload
9255 (defun org-open-link-from-string (s &optional arg reference-buffer)
9256 "Open a link in the string S, as if it was in Org-mode."
9258 (let ((reference-buffer (or reference-buffer (current-buffer))))
9259 (with-temp-buffer
9260 (let ((org-inhibit-startup t))
9261 (org-mode)
9262 (insert s)
9263 (goto-char (point-min))
9264 (when reference-buffer
9265 (setq org-link-abbrev-alist-local
9266 (with-current-buffer reference-buffer
9267 org-link-abbrev-alist-local)))
9268 (org-open-at-point arg reference-buffer)))))
9270 (defvar org-open-at-point-functions nil
9271 "Hook that is run when following a link at point.
9273 Functions in this hook must return t if they identify and follow
9274 a link at point. If they don't find anything interesting at point,
9275 they must return nil.")
9277 (defun org-open-at-point (&optional arg reference-buffer)
9278 "Open link at or after point.
9279 If there is no link at point, this function will search forward up to
9280 the end of the current line.
9281 Normally, files will be opened by an appropriate application. If the
9282 optional prefix argument ARG is non-nil, Emacs will visit the file.
9283 With a double prefix argument, try to open outside of Emacs, in the
9284 application the system uses for this file type."
9285 (interactive "P")
9286 ;; if in a code block, then open the block's results
9287 (unless (call-interactively #'org-babel-open-src-block-result)
9288 (org-load-modules-maybe)
9289 (move-marker org-open-link-marker (point))
9290 (setq org-window-config-before-follow-link (current-window-configuration))
9291 (org-remove-occur-highlights nil nil t)
9292 (cond
9293 ((and (org-on-heading-p)
9294 (not (org-in-regexp
9299 (not (get-text-property (point) 'org-linked-text)))
9300 (or (org-offer-links-in-entry arg)
9301 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9302 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9303 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9304 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9305 (not (org-in-regexp org-bracket-link-regexp)))
9306 (org-footnote-action))
9307 (t
9308 (let (type path link line search (pos (point)))
9309 (catch 'match
9310 (save-excursion
9312 (when (org-in-regexp org-bracket-link-regexp 1)
9313 (setq link (org-extract-attributes
9314 (org-link-unescape (org-match-string-no-properties 1))))
9316 (setq link (replace-match " " t t link)))
9317 (setq link (org-link-expand-abbrev link))
9318 (cond
9319 ((or (file-name-absolute-p link)
9321 (setq type "file" path link))
9322 ((string-match org-link-re-with-space3 link)
9323 (setq type (match-string 1 link) path (match-string 2 link)))
9324 (t (setq type "thisfile" path link)))
9325 (throw 'match t)))
9327 (when (get-text-property (point) 'org-linked-text)
9328 (setq type "thisfile"
9329 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9330 (1+ (point)) (point))
9331 path (buffer-substring
9332 (or (previous-single-property-change pos 'org-linked-text)
9333 (point-min))
9334 (or (next-single-property-change pos 'org-linked-text)
9335 (point-max))))
9336 (throw 'match t))
9338 (save-excursion
9339 (when (or (org-in-regexp org-angle-link-re)
9340 (org-in-regexp org-plain-link-re))
9341 (setq type (match-string 1) path (match-string 2))
9342 (throw 'match t)))
9343 (save-excursion
9345 (setq type "tags"
9346 path (match-string 1))
9347 (while (string-match ":" path)
9348 (setq path (replace-match "+" t t path)))
9349 (throw 'match t)))
9351 (setq type "tree-match"
9352 path (match-string 1))
9353 (throw 'match t)))
9354 (unless path
9355 (error "No link found"))
9357 ;; switch back to reference buffer
9358 ;; needed when if called in a temporary buffer through
9359 ;; org-open-link-from-string
9360 (with-current-buffer (or reference-buffer (current-buffer))
9362 ;; Remove any trailing spaces in path
9364 (setq path (replace-match "" t t path)))
9365 (if (and org-link-translation-function
9366 (fboundp org-link-translation-function))
9367 ;; Check if we need to translate the link
9368 (let ((tmp (funcall org-link-translation-function type path)))
9369 (setq type (car tmp) path (cdr tmp))))
9371 (cond
9373 ((assoc type org-link-protocols)
9374 (funcall (nth 1 (assoc type org-link-protocols)) path))
9376 ((equal type "mailto")
9377 (let ((cmd (car org-link-mailto-program))
9378 (args (cdr org-link-mailto-program)) args1
9379 (address path) (subject "") a)
9381 (setq address (match-string 1 path)
9382 subject (org-link-escape (match-string 2 path))))
9383 (while args
9384 (cond
9385 ((not (stringp (car args))) (push (pop args) args1))
9386 (t (setq a (pop args))
9387 (if (string-match "%a" a)
9388 (setq a (replace-match address t t a)))
9389 (if (string-match "%s" a)
9390 (setq a (replace-match subject t t a)))
9391 (push a args1))))
9392 (apply cmd (nreverse args1))))
9394 ((member type '("http" "https" "ftp" "news"))
9395 (browse-url (concat type ":" (org-link-escape
9396 path org-link-escape-chars-browser))))
9398 ((string= type "doi")
9399 (browse-url (concat "http://dx.doi.org/"
9400 (org-link-escape
9401 path org-link-escape-chars-browser))))
9403 ((member type '("message"))
9404 (browse-url (concat type ":" path)))
9406 ((string= type "tags")
9407 (org-tags-view arg path))
9409 ((string= type "tree-match")
9412 ((string= type "file")
9414 (setq line (string-to-number (match-string 1 path))
9415 path (substring path 0 (match-beginning 0)))
9417 (setq search (match-string 1 path)
9418 path (substring path 0 (match-beginning 0)))))
9419 (if (string-match "[*?{]" (file-name-nondirectory path))
9420 (dired path)
9421 (org-open-file path arg line search)))
9423 ((string= type "shell")
9424 (let ((cmd path))
9425 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9426 (string-match org-confirm-shell-link-not-regexp cmd))
9427 (not org-confirm-shell-link-function)
9428 (funcall org-confirm-shell-link-function
9430 (org-add-props cmd nil
9431 'face 'org-warning))))
9432 (progn
9433 (message "Executing %s" cmd)
9434 (shell-command cmd))
9435 (error "Abort"))))
9437 ((string= type "elisp")
9438 (let ((cmd path))
9439 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9440 (string-match org-confirm-elisp-link-not-regexp cmd))
9441 (not org-confirm-elisp-link-function)
9442 (funcall org-confirm-elisp-link-function
9444 (org-add-props cmd nil
9445 'face 'org-warning))))
9446 (message "%s => %s" cmd
9447 (if (equal (string-to-char cmd) ?\()
9448 (eval (read cmd))
9449 (call-interactively (read cmd))))
9450 (error "Abort"))))
9452 ((and (string= type "thisfile")
9453 (run-hook-with-args-until-success
9454 'org-open-link-functions path)))
9456 ((string= type "thisfile")
9457 (if arg
9458 (switch-to-buffer-other-window
9459 (org-get-buffer-for-internal-link (current-buffer)))
9460 (org-mark-ring-push))
9461 (let ((cmd `(org-link-search
9462 ,path
9463 ,(cond ((equal arg '(4)) ''occur)
9464 ((equal arg '(16)) ''org-occur)
9465 (t nil))
9466 ,pos)))
9467 (condition-case nil (eval cmd)
9468 (error (progn (widen) (eval cmd))))))
9470 (t
9471 (browse-url-at-point)))))))
9472 (move-marker org-open-link-marker nil)
9473 (run-hook-with-args 'org-follow-link-hook)))
9475 (defun org-offer-links-in-entry (&optional nth zero)
9476 "Offer links in the current entry and follow the selected link.
9477 If there is only one link, follow it immediately as well.
9478 If NTH is an integer, immediately pick the NTH link found.
9479 If ZERO is a string, check also this string for a link, and if
9480 there is one, offer it as link number zero."
9484 (cnt ?0)
9485 (in-emacs (if (integerp nth) nil nth))
9486 have-zero end links link c)
9487 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9488 (push (match-string 0 zero) links)
9489 (setq cnt (1- cnt) have-zero t))
9490 (save-excursion
9491 (org-back-to-heading t)
9492 (setq end (save-excursion (outline-next-heading) (point)))
9493 (while (re-search-forward re end t)
9494 (push (match-string 0) links))
9495 (setq links (org-uniquify (reverse links))))
9497 (cond
9498 ((null links)
9499 (message "No links"))
9500 ((equal (length links) 1)
9501 (setq link (list (car links))))
9502 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9503 (setq link (nth (if have-zero nth (1- nth)) links)))
9504 (t ; we have to select a link
9505 (save-excursion
9506 (save-window-excursion
9507 (delete-other-windows)
9508 (with-output-to-temp-buffer "*Select Link*"
9509 (mapc (lambda (l)
9510 (if (not (string-match org-bracket-link-regexp l))
9512 (org-remove-angle-brackets l)))
9513 (if (match-end 3)
9515 (match-string 3 l) (match-string 1 l)))
9517 (match-string 1 l))))))
9518 links))
9519 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9520 (message "Select link to open, RET to open all:")
9521 (setq c (read-char-exclusive))
9522 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9523 (when (equal c ?q) (error "Abort"))
9524 (if (equal c ?\C-m)
9525 (setq link links)
9526 (setq nth (- c ?0))
9527 (if have-zero (setq nth (1+ nth)))
9528 (unless (and (integerp nth) (>= (length links) nth))
9529 (error "Invalid link selection"))
9530 (setq link (list (nth (1- nth) links))))))
9531 (if link
9532 (let ((buf (current-buffer)))
9533 (dolist (l link)
9534 (org-open-link-from-string l in-emacs buf))
9535 t)
9536 nil)))
9538 ;; Add special file links that specify the way of opening
9540 (org-add-link-type "file+sys" 'org-open-file-with-system)
9541 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9542 (defun org-open-file-with-system (path)
9543 "Open file at PATH using the system way of opening it."
9544 (org-open-file path 'system))
9545 (defun org-open-file-with-emacs (path)
9546 "Open file at PATH in Emacs."
9547 (org-open-file path 'emacs))
9548 (defun org-remove-file-link-modifiers ()
9549 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9550 (goto-char (point-min))
9552 (org-if-unprotected
9553 (replace-match "file:" t t))))
9554 (eval-after-load "org-exp"
9555 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9556 'org-remove-file-link-modifiers))
9558 ;;;; Time estimates
9560 (defun org-get-effort (&optional pom)
9561 "Get the effort estimate for the current entry."
9562 (org-entry-get pom org-effort-property))
9564 ;;; File search
9566 (defvar org-create-file-search-functions nil
9567 "List of functions to construct the right search string for a file link.
9568 These functions are called in turn with point at the location to
9569 which the link should point.
9571 A function in the hook should first test if it would like to
9572 handle this file type, for example by checking the `major-mode'
9573 or the file extension. If it decides not to handle this file, it
9574 should just return nil to give other functions a chance. If it
9575 does handle the file, it must return the search string to be used
9576 when following the link. The search string will be part of the
9577 file link, given after a double colon, and `org-open-at-point'
9578 will automatically search for it. If special measures must be
9579 taken to make the search successful, another function should be
9580 added to the companion hook `org-execute-file-search-functions',
9581 which see.
9583 A function in this hook may also use `setq' to set the variable
9584 `description' to provide a suggestion for the descriptive text to
9585 be used for this link when it gets inserted into an Org-mode
9588 (defvar org-execute-file-search-functions nil
9589 "List of functions to execute a file search triggered by a link.
9591 Functions added to this hook must accept a single argument, the
9592 search string that was part of the file link, the part after the
9593 double colon. The function must first check if it would like to
9594 handle this search, for example by checking the `major-mode' or
9595 the file extension. If it decides not to handle this search, it
9596 should just return nil to give other functions a chance. If it
9597 does handle the search, it must return a non-nil value to keep
9598 other functions from trying.
9600 Each function can access the current prefix argument through the
9601 variable `current-prefix-argument'. Note that a single prefix is
9602 used to force opening a link in Emacs, so it may be good to only
9603 use a numeric or double prefix to guide the search function.
9605 In case this is needed, a function in this hook can also restore
9606 the window configuration before `org-open-at-point' was called using:
9608 (set-window-configuration org-window-config-before-follow-link)")
9610 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9611 (defun org-link-search (s &optional type avoid-pos)
9612 "Search for a link search option.
9613 If S is surrounded by forward slashes, it is interpreted as a
9614 regular expression. In org-mode files, this will create an `org-occur'
9615 sparse tree. In ordinary files, `occur' will be used to list matches.
9616 If the current buffer is in `dired-mode', grep will be used to search
9617 in all files. If AVOID-POS is given, ignore matches near that position."
9618 (let ((case-fold-search t)
9622 org-emphasis-alist)
9624 (pos (point))
9625 (pre nil) (post nil)
9626 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9627 (cond
9628 ;; First check if there are any special search functions
9629 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9630 ;; Now try the builtin stuff
9631 ((and (equal (string-to-char s0) ?#)
9632 (> (length s0) 1)
9633 (save-excursion
9634 (goto-char (point-min))
9635 (and
9636 (re-search-forward
9638 (setq type 'dedicated
9639 pos (match-beginning 0))))
9640 ;; There is an exact target for this
9641 (goto-char pos)
9642 (org-back-to-heading t)))
9643 ((save-excursion
9644 (goto-char (point-min))
9645 (and
9646 (re-search-forward
9647 (concat "<<" (regexp-quote s0) ">>") nil t)
9648 (setq type 'dedicated
9649 pos (match-beginning 0))))
9650 ;; There is an exact target for this
9651 (goto-char pos))
9653 (save-excursion
9654 (goto-char (point-min))
9655 (and
9656 (re-search-forward
9657 (concat "[^[]" (regexp-quote
9658 (format org-coderef-label-format
9659 (match-string 1 s0))))
9660 nil t)
9661 (setq type 'dedicated
9662 pos (1+ (match-beginning 0))))))
9663 ;; There is a coderef target for this
9664 (goto-char pos))
9666 ;; A regular expression
9667 (cond
9668 ((org-mode-p)
9669 (org-occur (match-string 1 s)))
9670 ;;((eq major-mode 'dired-mode)
9671 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9672 (t (org-do-occur (match-string 1 s)))))
9673 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9674 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9675 (goto-char (point-min))
9676 (cond
9677 ((let (case-fold-search)
9678 (re-search-forward (format org-complex-heading-regexp-format
9679 (regexp-quote s))
9680 nil t))
9681 ;; OK, found a match
9682 (setq type 'dedicated)
9683 (goto-char (match-beginning 0)))
9684 ((and (not org-link-search-inhibit-query)
9685 (eq org-link-search-must-match-exact-headline 'query-to-create)
9686 (y-or-n-p "No match - create this as a new heading? "))
9687 (goto-char (point-max))
9688 (or (bolp) (newline))
9690 (beginning-of-line 0))
9691 (t
9692 (goto-char pos)
9693 (error "No match"))))
9694 (t
9695 ;; A normal search string
9696 (when (equal (string-to-char s) ?*)
9697 ;; Anchor on headlines, post may include tags.
9700 s (substring s 1)))
9701 (remove-text-properties
9702 0 (length s)
9703 '(face nil mouse-face nil keymap nil fontified nil) s)
9704 ;; Make a series of regular expressions to find a match
9713 re4 (concat "[^a-zA-Z_]" re4_)
9715 re1 (concat pre re2 post)
9716 re3 (concat pre (if pre re4_ re4) post)
9717 re5 (concat pre ".*" re4)
9718 re2 (concat pre re2)
9719 re2a (concat pre (if pre re2a_ re2a))
9720 re4 (concat pre (if pre re4_ re4))
9724 ))
9725 (cond
9726 ((eq type 'org-occur) (org-occur reall))
9727 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9728 (t (goto-char (point-min))
9729 (setq type 'fuzzy)
9730 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9731 (org-search-not-self 1 re1 nil t)
9732 (org-search-not-self 1 re2 nil t)
9733 (org-search-not-self 1 re2a nil t)
9734 (org-search-not-self 1 re3 nil t)
9735 (org-search-not-self 1 re4 nil t)
9736 (org-search-not-self 1 re5 nil t)
9737 )
9738 (goto-char (match-beginning 1))
9739 (goto-char pos)
9740 (error "No match"))))))
9741 (and (org-mode-p) (org-show-context 'link-search))
9742 type))
9744 (defun org-search-not-self (group &rest args)
9745 "Execute `re-search-forward', but only accept matches that do not
9746 enclose the position of `org-open-link-marker'."
9747 (let ((m org-open-link-marker))
9748 (catch 'exit
9749 (while (apply 're-search-forward args)
9750 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9751 (goto-char (match-end group))
9752 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9753 (> (match-beginning 0) (marker-position m))
9754 (< (match-end 0) (marker-position m)))
9755 (save-match-data
9756 (or (not (org-in-regexp
9757 org-bracket-link-analytic-regexp 1))
9758 (not (match-end 4)) ; no description
9759 (and (<= (match-beginning 4) (point))
9760 (>= (match-end 4) (point))))))
9761 (throw 'exit (point))))))))
9763 (defun org-get-buffer-for-internal-link (buffer)
9764 "Return a buffer to be used for displaying the link target of internal links."
9765 (cond
9766 ((not org-display-internal-link-with-indirect-buffer)
9767 buffer)
9768 ((string-match "(Clone)$" (buffer-name buffer))
9769 (message "Buffer is already a clone, not making another one")
9770 ;; we also do not modify visibility in this case
9771 buffer)
9772 (t ; make a new indirect buffer for displaying the link
9773 (let* ((bn (buffer-name buffer))
9774 (ibn (concat bn "(Clone)"))
9775 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9776 (with-current-buffer ib (org-overview))
9777 ib))))
9779 (defun org-do-occur (regexp &optional cleanup)
9780 "Call the Emacs command `occur'.
9781 If CLEANUP is non-nil, remove the printout of the regular expression
9782 in the *Occur* buffer. This is useful if the regex is long and not useful
9783 to read."
9784 (occur regexp)
9785 (when cleanup
9786 (let ((cwin (selected-window)) win beg end)
9787 (when (setq win (get-buffer-window "*Occur*"))
9788 (select-window win))
9789 (goto-char (point-min))
9790 (when (re-search-forward "match[a-z]+" nil t)
9791 (setq beg (match-end 0))
9793 (setq end (1- (match-beginning 0)))))
9794 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9795 (goto-char (point-min))
9796 (select-window cwin))))
9798 ;;; The mark ring for links jumps
9800 (defvar org-mark-ring nil
9801 "Mark ring for positions before jumps in Org-mode.")
9802 (defvar org-mark-ring-last-goto nil
9803 "Last position in the mark ring used to go back.")
9804 ;; Fill and close the ring
9805 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9806 (loop for i from 1 to org-mark-ring-length do
9807 (push (make-marker) org-mark-ring))
9808 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9809 org-mark-ring)
9811 (defun org-mark-ring-push (&optional pos buffer)
9812 "Put the current position or POS into the mark ring and rotate it."
9813 (interactive)
9814 (setq pos (or pos (point)))
9815 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9816 (move-marker (car org-mark-ring)
9817 (or pos (point))
9818 (or buffer (current-buffer)))
9819 (message "%s"
9820 (substitute-command-keys
9823 (defun org-mark-ring-goto (&optional n)
9824 "Jump to the previous position in the mark ring.
9825 With prefix arg N, jump back that many stored positions. When
9826 called several times in succession, walk through the entire ring.
9827 Org-mode commands jumping to a different position in the current file,
9828 or to another Org-mode file, automatically push the old position
9829 onto the ring."
9830 (interactive "p")
9831 (let (p m)
9832 (if (eq last-command this-command)
9833 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9834 (setq p org-mark-ring))
9835 (setq org-mark-ring-last-goto p)
9836 (setq m (car p))
9837 (org-pop-to-buffer-same-window (marker-buffer m))
9838 (goto-char m)
9839 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9841 (defun org-remove-angle-brackets (s)
9842 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9843 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9844 s)
9845 (defun org-add-angle-brackets (s)
9846 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9847 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9848 s)
9849 (defun org-remove-double-quotes (s)
9852 s)
9854 ;;; Following specific links
9856 (defun org-follow-timestamp-link ()
9857 (cond
9858 ((org-at-date-range-p t)
9859 (let ((org-agenda-start-on-weekday)
9860 (t1 (match-string 1))
9861 (t2 (match-string 2)))
9862 (setq t1 (time-to-days (org-time-string-to-time t1))
9863 t2 (time-to-days (org-time-string-to-time t2)))
9864 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9865 ((org-at-timestamp-p t)
9866 (org-agenda-list nil (time-to-days (org-time-string-to-time
9867 (substring (match-string 1) 0 10)))
9868 1))
9869 (t (error "This should not happen"))))
9872 ;;; Following file links
9873 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9874 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9875 (declare-function mailcap-mime-info
9876 "mailcap" (string &optional request no-decode))
9877 (defvar org-wait nil)
9878 (defun org-open-file (path &optional in-emacs line search)
9879 "Open the file at PATH.
9880 First, this expands any special file name abbreviations. Then the
9881 configuration variable `org-file-apps' is checked if it contains an
9882 entry for this file type, and if yes, the corresponding command is launched.
9884 If no application is found, Emacs simply visits the file.
9886 With optional prefix argument IN-EMACS, Emacs will visit the file.
9888 prefix arg, Org tries to avoid opening in Emacs
9889 and to use an external application to visit the file.
9891 Optional LINE specifies a line to go to, optional SEARCH a string
9892 to search for. If LINE or SEARCH is given, the file will be
9893 opened in Emacs, unless an entry from org-file-apps that makes
9894 use of groups in a regexp matches.
9895 If the file does not exist, an error is thrown."
9896 (let* ((file (if (equal path "")
9897 buffer-file-name
9898 (substitute-in-file-name (expand-file-name path))))
9899 (file-apps (append org-file-apps (org-default-apps)))
9900 (apps (org-remove-if
9901 'org-file-apps-entry-match-against-dlink-p file-apps))
9902 (apps-dlink (org-remove-if-not
9903 'org-file-apps-entry-match-against-dlink-p file-apps))
9904 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9905 (dirp (if remp nil (file-directory-p file)))
9906 (file (if (and dirp org-open-directory-means-index-dot-org)
9907 (concat (file-name-as-directory file) "index.org")
9908 file))
9909 (a-m-a-p (assq 'auto-mode apps))
9910 (dfile (downcase file))
9911 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9912 (link (cond ((and (eq line nil)
9913 (eq search nil))
9914 file)
9915 (line
9916 (concat file "::" (number-to-string line)))
9917 (search
9918 (concat file "::" search))))
9919 (dlink (downcase link))
9920 (old-buffer (current-buffer))
9921 (old-pos (point))
9922 (old-mode major-mode)
9923 ext cmd link-match-data)
9925 (setq ext (match-string 1 dfile))
9927 (setq ext (match-string 1 dfile))))
9928 (cond
9929 ((member in-emacs '((16) system))
9930 (setq cmd (cdr (assoc 'system apps))))
9931 (in-emacs (setq cmd 'emacs))
9932 (t
9933 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9934 (and dirp (cdr (assoc 'directory apps)))
9935 ; first, try matching against apps-dlink
9936 ; if we get a match here, store the match data for later
9937 (let ((match (assoc-default dlink apps-dlink
9938 'string-match)))
9939 (if match
9940 (progn (setq link-match-data (match-data))
9941 match)
9942 (progn (setq in-emacs (or in-emacs line search))
9943 nil))) ; if we have no match in apps-dlink,
9944 ; always open the file in emacs if line or search
9945 ; is given (for backwards compatibility)
9946 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9947 'string-match)
9948 (cdr (assoc ext apps))
9949 (cdr (assoc t apps))))))
9950 (when (eq cmd 'system)
9951 (setq cmd (cdr (assoc 'system apps))))
9952 (when (eq cmd 'default)
9953 (setq cmd (cdr (assoc t apps))))
9954 (when (eq cmd 'mailcap)
9955 (require 'mailcap)
9956 (mailcap-parse-mailcaps)
9957 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9958 (command (mailcap-mime-info mime-type)))
9959 (if (stringp command)
9960 (setq cmd command)
9961 (setq cmd 'emacs))))
9962 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9963 (not (file-exists-p file))
9964 (not org-open-non-existing-files))
9965 (error "No such file: %s" file))
9966 (cond
9968 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9970 (setq cmd (replace-match "%s" t t cmd)))
9971 (while (string-match "%s" cmd)
9972 (setq cmd (replace-match
9973 (save-match-data
9974 (shell-quote-argument
9975 (convert-standard-filename file)))
9976 t t cmd)))
9978 ;; Replace "%1", "%2" etc. in command with group matches from regex
9979 (save-match-data
9980 (let ((match-index 1)
9981 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9982 (set-match-data link-match-data)
9983 (while (<= match-index number-of-groups)
9984 (let ((regex (concat "%" (number-to-string match-index)))
9985 (replace-with (match-string match-index dlink)))
9986 (while (string-match regex cmd)
9987 (setq cmd (replace-match replace-with t t cmd))))
9988 (setq match-index (+ match-index 1)))))
9990 (save-window-excursion
9991 (start-process-shell-command cmd nil cmd)
9992 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9993 ))
9994 ((or (stringp cmd)
9995 (eq cmd 'emacs))
9996 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9997 (widen)
9998 (if line (org-goto-line line)
9999 (if search (org-link-search search))))
10000 ((consp cmd)
10001 (let ((file (convert-standard-filename file)))
10002 (save-match-data
10003 (set-match-data link-match-data)
10004 (eval cmd))))
10005 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10006 (and (org-mode-p) (eq old-mode 'org-mode)
10007 (or (not (equal old-buffer (current-buffer)))
10008 (not (equal old-pos (point))))
10009 (org-mark-ring-push old-pos old-buffer))))
10011 (defun org-file-apps-entry-match-against-dlink-p (entry)
10012 "This function returns non-nil if `entry' uses a regular
10013 expression which should be matched against the whole link by
10014 org-open-file.
10016 It assumes that is the case when the entry uses a regular
10017 expression which has at least one grouping construct and the
10018 action is either a lisp form or a command string containing
10019 '%1', i.e. using at least one subexpression match as a
10020 parameter."
10021 (let ((selector (car entry))
10022 (action (cdr entry)))
10023 (if (stringp selector)
10024 (and (> (regexp-opt-depth selector) 0)
10025 (or (and (stringp action)
10026 (string-match "%[0-9]" action))
10027 (consp action)))
10028 nil)))
10030 (defun org-default-apps ()
10031 "Return the default applications for this operating system."
10032 (cond
10033 ((eq system-type 'darwin)
10034 org-file-apps-defaults-macosx)
10035 ((eq system-type 'windows-nt)
10036 org-file-apps-defaults-windowsnt)
10037 (t org-file-apps-defaults-gnu)))
10039 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10040 "Convert extensions to regular expressions in the cars of LIST.
10041 Also, weed out any non-string entries, because the return value is used
10042 only for regexp matching.
10043 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10044 point to the symbol `emacs', indicating that the file should
10045 be opened in Emacs."
10046 (append
10047 (delq nil
10048 (mapcar (lambda (x)
10049 (if (not (stringp (car x)))
10050 nil
10052 x
10054 list))
10055 (if add-auto-mode
10056 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10058 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10059 (defun org-file-remote-p (file)
10060 "Test whether FILE specifies a location on a remote system.
10061 Return non-nil if the location is indeed remote.
10065 (cond ((fboundp 'file-remote-p)
10066 (file-remote-p file))
10067 ((fboundp 'tramp-handle-file-remote-p)
10068 (tramp-handle-file-remote-p file))
10069 ((and (boundp 'ange-ftp-name-format)
10070 (string-match (car ange-ftp-name-format) file))
10071 t)
10072 (t nil)))
10075 ;;;; Refiling
10077 (defun org-get-org-file ()
10078 "Read a filename, with default directory `org-directory'."
10079 (let ((default (or org-default-notes-file remember-data-file)))
10080 (read-file-name (format "File name [%s]: " default)
10081 (file-name-as-directory org-directory)
10082 default)))
10084 (defun org-notes-order-reversed-p ()
10085 "Check if the current file should receive notes in reversed order."
10086 (cond
10087 ((not org-reverse-note-order) nil)
10088 ((eq t org-reverse-note-order) t)
10089 ((not (listp org-reverse-note-order)) nil)
10090 (t (catch 'exit
10091 (let ((all org-reverse-note-order)
10092 entry)
10093 (while (setq entry (pop all))
10094 (if (string-match (car entry) buffer-file-name)
10095 (throw 'exit (cdr entry))))
10096 nil)))))
10098 (defvar org-refile-target-table nil
10099 "The list of refile targets, created by `org-refile'.")
10101 (defvar org-agenda-new-buffers nil
10102 "Buffers created to visit agenda files.")
10104 (defvar org-refile-cache nil
10105 "Cache for refile targets.")
10107 (defvar org-refile-markers nil
10108 "All the markers used for caching refile locations.")
10110 (defun org-refile-marker (pos)
10111 "Get a new refile marker, but only if caching is in use."
10112 (if (not org-refile-use-cache)
10113 pos
10114 (let ((m (make-marker)))
10115 (move-marker m pos)
10116 (push m org-refile-markers)
10117 m)))
10119 (defun org-refile-cache-clear ()
10120 "Clear the refile cache and disable all the markers."
10121 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10122 (setq org-refile-markers nil)
10123 (setq org-refile-cache nil)
10124 (message "Refile cache has been cleared"))
10126 (defun org-refile-cache-check-set (set)
10127 "Check if all the markers in the cache still have live buffers."
10128 (let (marker)
10129 (catch 'exit
10130 (while (and set (setq marker (nth 3 (pop set))))
10131 ;; if org-refile-use-outline-path is 'file, marker may be nil
10132 (when (and marker (null (marker-buffer marker)))
10133 (message "not found") (sit-for 3)
10134 (throw 'exit nil)))
10135 t)))
10137 (defun org-refile-cache-put (set &rest identifiers)
10138 "Push the refile targets SET into the cache, under IDENTIFIERS."
10139 (let* ((key (sha1 (prin1-to-string identifiers)))
10140 (entry (assoc key org-refile-cache)))
10141 (if entry
10142 (setcdr entry set)
10143 (push (cons key set) org-refile-cache))))
10145 (defun org-refile-cache-get (&rest identifiers)
10146 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10147 (cond
10148 ((not org-refile-cache) nil)
10149 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10150 (t
10151 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10152 org-refile-cache))))
10153 (and set (org-refile-cache-check-set set) set)))))
10155 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10156 "Produce a table with refile targets."
10157 (let ((case-fold-search nil)
10158 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10159 (entries (or org-refile-targets '((nil . (:level . 1)))))
10160 targets tgs txt re files f desc descre fast-path-p level pos0)
10161 (message "Getting targets...")
10162 (with-current-buffer (or default-buffer (current-buffer))
10163 (while (setq entry (pop entries))
10164 (setq files (car entry) desc (cdr entry))
10165 (setq fast-path-p nil)
10166 (cond
10167 ((null files) (setq files (list (current-buffer))))
10168 ((eq files 'org-agenda-files)
10169 (setq files (org-agenda-files 'unrestricted)))
10170 ((and (symbolp files) (fboundp files))
10171 (setq files (funcall files)))
10172 ((and (symbolp files) (boundp files))
10173 (setq files (symbol-value files))))
10174 (if (stringp files) (setq files (list files)))
10175 (cond
10176 ((eq (car desc) :tag)
10178 ((eq (car desc) :todo)
10180 ((eq (car desc) :regexp)
10181 (setq descre (cdr desc)))
10182 ((eq (car desc) :level)
10184 (if org-odd-levels-only
10185 (1- (* 2 (cdr desc)))
10186 (cdr desc)))
10188 ((eq (car desc) :maxlevel)
10189 (setq fast-path-p t)
10191 (if org-odd-levels-only
10192 (1- (* 2 (cdr desc)))
10193 (cdr desc)))
10195 (t (error "Bad refiling target description %s" desc)))
10196 (while (setq f (pop files))
10197 (with-current-buffer
10198 (if (bufferp f) f (org-get-agenda-file-buffer f))
10199 (or
10200 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10201 (progn
10202 (if (bufferp f) (setq f (buffer-file-name
10203 (buffer-base-buffer f))))
10204 (setq f (and f (expand-file-name f)))
10205 (if (eq org-refile-use-outline-path 'file)
10206 (push (list (file-name-nondirectory f) f nil nil) tgs))
10207 (save-excursion
10208 (save-restriction
10209 (widen)
10210 (goto-char (point-min))
10211 (while (re-search-forward descre nil t)
10212 (goto-char (setq pos0 (point-at-bol)))
10213 (catch 'next
10214 (when org-refile-target-verify-function
10215 (save-match-data
10216 (or (funcall org-refile-target-verify-function)
10217 (throw 'next t))))
10218 (when (and (looking-at org-complex-heading-regexp)
10219 (not (member (match-string 4) excluded-entries)))
10220 (setq level (org-reduced-level
10221 (- (match-end 1) (match-beginning 1)))
10222 txt (org-link-display-format (match-string 4))
10224 re (format org-complex-heading-regexp-format
10225 (regexp-quote (match-string 4))))
10226 (when org-refile-use-outline-path
10227 (setq txt (mapconcat
10228 'org-protect-slash
10229 (append
10230 (if (eq org-refile-use-outline-path
10231 'file)
10232 (list (file-name-nondirectory
10233 (buffer-file-name
10234 (buffer-base-buffer))))
10235 (if (eq org-refile-use-outline-path
10236 'full-file-path)
10237 (list (buffer-file-name
10238 (buffer-base-buffer)))))
10239 (org-get-outline-path fast-path-p
10240 level txt)
10241 (list txt))
10242 "/")))
10243 (push (list txt f re (org-refile-marker (point)))
10244 tgs)))
10245 (when (= (point) pos0)
10246 ;; verification function has not moved point
10247 (goto-char (point-at-eol))))))))
10248 (when org-refile-use-cache
10249 (org-refile-cache-put tgs (buffer-file-name) descre))
10250 (setq targets (append tgs targets))
10251 ))))
10252 (message "Getting targets...done")
10253 (nreverse targets)))
10255 (defun org-protect-slash (s)
10256 (while (string-match "/" s)
10258 s)
10260 (defvar org-olpa (make-vector 20 nil))
10262 (defun org-get-outline-path (&optional fastp level heading)
10263 "Return the outline path to the current entry, as a list.
10265 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10266 routine which makes outline path derivations for an entire file,
10267 avoiding backtracing. Refile target collection makes use of that."
10268 (if fastp
10269 (progn
10270 (if (> level 19)
10271 (error "Outline path failure, more than 19 levels"))
10272 (loop for i from level upto 19 do
10273 (aset org-olpa i nil))
10274 (prog1
10275 (delq nil (append org-olpa nil))
10276 (aset org-olpa level heading)))
10277 (let (rtn case-fold-search)
10278 (save-excursion
10279 (save-restriction
10280 (widen)
10281 (while (org-up-heading-safe)
10282 (when (looking-at org-complex-heading-regexp)
10283 (push (org-match-string-no-properties 4) rtn)))
10284 rtn)))))
10286 (defun org-format-outline-path (path &optional width prefix)
10287 "Format the outline path PATH for display.
10288 Width is the maximum number of characters that is available.
10289 Prefix is a prefix to be included in the returned string,
10290 such as the file name."
10291 (setq width (or width 79))
10292 (if prefix (setq width (- width (length prefix))))
10293 (if (not path)
10294 (or prefix "")
10295 (let* ((nsteps (length path))
10296 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10297 (maxwidth (if (<= total-width width)
10298 10000 ;; everything fits
10299 ;; we need to shorten the level headings
10300 (/ (- width nsteps) nsteps)))
10301 (org-odd-levels-only nil)
10302 (n 0)
10303 (total (1+ (length prefix))))
10304 (setq maxwidth (max maxwidth 10))
10305 (concat prefix
10306 (mapconcat
10307 (lambda (h)
10308 (setq n (1+ n))
10309 (if (and (= n nsteps) (< maxwidth 10000))
10310 (setq maxwidth (- total-width total)))
10311 (if (< (length h) maxwidth)
10312 (progn (setq total (+ total (length h) 1)) h)
10313 (setq h (substring h 0 (- maxwidth 2))
10314 total (+ total maxwidth 1))
10316 (setq h (substring h 0 (match-beginning 0))))
10317 (setq h (concat h "..")))
10318 (org-add-props h nil 'face
10319 (nth (% (1- n) org-n-level-faces)
10320 org-level-faces))
10321 h)
10322 path "/")))))
10324 (defun org-display-outline-path (&optional file current)
10325 "Display the current outline path in the echo area."
10326 (interactive "P")
10327 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10328 (case-fold-search nil)
10329 (path (and (org-mode-p) (org-get-outline-path))))
10330 (if current (setq path (append path
10331 (save-excursion
10332 (org-back-to-heading t)
10333 (if (looking-at org-complex-heading-regexp)
10334 (list (match-string 4)))))))
10335 (message "%s"
10336 (org-format-outline-path
10337 path
10338 (1- (frame-width))
10339 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10341 (defvar org-refile-history nil
10342 "History for refiling operations.")
10344 (defvar org-after-refile-insert-hook nil
10345 "Hook run after `org-refile' has inserted its stuff at the new location.
10346 Note that this is still *before* the stuff will be removed from
10347 the *old* location.")
10349 (defvar org-capture-last-stored-marker)
10350 (defun org-refile (&optional goto default-buffer rfloc)
10351 "Move the entry or entries at point to another heading.
10352 The list of target headings is compiled using the information in
10353 `org-refile-targets', which see.
10355 At the target location, the entry is filed as a subitem of the target
10356 heading. Depending on `org-reverse-note-order', the new subitem will
10357 either be the first or the last subitem.
10359 If there is an active region, all entries in that region will be moved.
10360 However, the region must fulfill the requirement that the first heading
10361 is the first one sets the top-level of the moved text - at most siblings
10362 below it are allowed.
10364 With prefix arg GOTO, the command will only visit the target location
10365 and not actually move anything.
10368 go to the location where the last refiling operation has put the subtree.
10369 With a prefix argument of `2', refile to the running clock.
10371 RFLOC can be a refile location obtained in a different way.
10373 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10375 If you are using target caching (see `org-refile-use-cache'),
10376 You have to clear the target cache in order to find new targets.
10377 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10378 prefix argument (`C-u C-u C-u C-c C-w')."
10380 (interactive "P")
10381 (if (member goto '(0 (64)))
10382 (org-refile-cache-clear)
10383 (let* ((cbuf (current-buffer))
10384 (regionp (org-region-active-p))
10385 (region-start (and regionp (region-beginning)))
10386 (region-end (and regionp (region-end)))
10387 (region-length (and regionp (- region-end region-start)))
10388 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10389 pos it nbuf file re level reversed)
10390 (setq last-command nil)
10391 (when regionp
10392 (goto-char region-start)
10393 (or (bolp) (goto-char (point-at-bol)))
10394 (setq region-start (point))
10395 (unless (org-kill-is-subtree-p
10396 (buffer-substring region-start region-end))
10397 (error "The region is not a (sequence of) subtree(s)")))
10398 (if (equal goto '(16))
10399 (org-refile-goto-last-stored)
10400 (when (or
10401 (and (equal goto 2)
10402 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10403 (prog1
10404 (setq it (list (or org-clock-heading "running clock")
10405 (buffer-file-name
10406 (marker-buffer org-clock-hd-marker))
10407 ""
10408 (marker-position org-clock-hd-marker)))
10409 (setq goto nil)))
10410 (setq it (or rfloc
10411 (save-excursion
10412 (org-refile-get-location
10413 (if goto "Goto" "Refile to") default-buffer
10414 org-refile-allow-creating-parent-nodes)))))
10415 (setq file (nth 1 it)
10416 re (nth 2 it)
10417 pos (nth 3 it))
10418 (if (and (not goto)
10419 pos
10420 (equal (buffer-file-name) file)
10421 (if regionp
10422 (and (>= pos region-start)
10423 (<= pos region-end))
10424 (and (>= pos (point))
10425 (< pos (save-excursion
10426 (org-end-of-subtree t t))))))
10427 (error "Cannot refile to position inside the tree or region"))
10429 (setq nbuf (or (find-buffer-visiting file)
10430 (find-file-noselect file)))
10431 (if goto
10432 (progn
10433 (org-pop-to-buffer-same-window nbuf)
10434 (goto-char pos)
10435 (org-show-context 'org-goto))
10436 (if regionp
10437 (progn
10438 (org-kill-new (buffer-substring region-start region-end))
10439 (org-save-markers-in-region region-start region-end))
10440 (org-copy-subtree 1 nil t))
10441 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10442 (find-file-noselect file)))
10443 (setq reversed (org-notes-order-reversed-p))
10444 (save-excursion
10445 (save-restriction
10446 (widen)
10447 (if pos
10448 (progn
10449 (goto-char pos)
10450 (looking-at org-outline-regexp)
10451 (setq level (org-get-valid-level (funcall outline-level) 1))
10452 (goto-char
10453 (if reversed
10454 (or (outline-next-heading) (point-max))
10455 (or (save-excursion (org-get-next-sibling))
10456 (org-end-of-subtree t t)
10457 (point-max)))))
10458 (setq level 1)
10459 (if (not reversed)
10460 (goto-char (point-max))
10461 (goto-char (point-min))
10462 (or (outline-next-heading) (goto-char (point-max)))))
10463 (if (not (bolp)) (newline))
10464 (org-paste-subtree level)
10465 (when org-log-refile
10466 (org-add-log-setup 'refile nil nil 'findpos
10467 org-log-refile)
10468 (unless (eq org-log-refile 'note)
10469 (save-excursion (org-add-log-note))))
10470 (and org-auto-align-tags (org-set-tags nil t))
10471 (bookmark-set "org-refile-last-stored")
10472 ;; If we are refiling for capture, make sure that the
10473 ;; last-capture pointers point here
10474 (when (org-bound-and-true-p org-refile-for-capture)
10475 (bookmark-set "org-capture-last-stored-marker")
10476 (move-marker org-capture-last-stored-marker (point)))
10477 (if (fboundp 'deactivate-mark) (deactivate-mark))
10478 (run-hooks 'org-after-refile-insert-hook))))
10479 (if regionp
10480 (delete-region (point) (+ (point) region-length))
10481 (org-cut-subtree))
10482 (when (featurep 'org-inlinetask)
10483 (org-inlinetask-remove-END-maybe))
10484 (setq org-markers-to-move nil)
10487 (defun org-refile-goto-last-stored ()
10488 "Go to the location where the last refile was stored."
10489 (interactive)
10490 (bookmark-jump "org-refile-last-stored")
10491 (message "This is the location of the last refile"))
10493 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10494 "Prompt the user for a refile location, using PROMPT.
10495 PROMPT should not be suffixed with a colon and a space, because
10496 this function appends the default value from
10497 `org-refile-history' automatically, if that is not empty."
10498 (let ((org-refile-targets org-refile-targets)
10499 (org-refile-use-outline-path org-refile-use-outline-path)
10500 excluded-entries)
10501 (when (and (eq major-mode 'org-mode)
10502 (not org-refile-use-cache))
10503 (org-map-tree
10504 (lambda()
10505 (setq excluded-entries
10506 (append excluded-entries (list (org-get-heading t t)))))))
10507 (setq org-refile-target-table
10508 (org-refile-get-targets default-buffer excluded-entries)))
10509 (unless org-refile-target-table
10510 (error "No refile targets"))
10511 (let* ((prompt (concat prompt
10512 (and (car org-refile-history)
10513 (concat " (default " (car org-refile-history) ")"))
10514 ": "))
10515 (cbuf (current-buffer))
10516 (partial-completion-mode nil)
10517 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10518 (cfunc (if (and org-refile-use-outline-path
10519 org-outline-path-complete-in-steps)
10520 'org-olpath-completing-read
10521 'org-icompleting-read))
10522 (extra (if org-refile-use-outline-path "/" ""))
10523 (filename (and cfn (expand-file-name cfn)))
10524 (tbl (mapcar
10525 (lambda (x)
10526 (if (and (not (member org-refile-use-outline-path
10527 '(file full-file-path)))
10528 (not (equal filename (nth 1 x))))
10529 (cons (concat (car x) extra " ("
10530 (file-name-nondirectory (nth 1 x)) ")")
10531 (cdr x))
10532 (cons (concat (car x) extra) (cdr x))))
10533 org-refile-target-table))
10534 (completion-ignore-case t)
10535 pa answ parent-target child parent old-hist)
10536 (setq old-hist org-refile-history)
10537 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10538 nil 'org-refile-history (car org-refile-history)))
10539 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10540 (org-refile-check-position pa)
10541 (if pa
10542 (progn
10543 (when (or (not org-refile-history)
10544 (not (eq old-hist org-refile-history))
10545 (not (equal (car pa) (car org-refile-history))))
10546 (setq org-refile-history
10547 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10548 org-refile-history
10549 (cdr org-refile-history))))
10550 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10551 (pop org-refile-history)))
10552 pa)
10554 (progn
10555 (setq parent (match-string 1 answ)
10556 child (match-string 2 answ))
10557 (setq parent-target (or (assoc parent tbl)
10558 (assoc (concat parent "/") tbl)))
10559 (when (and parent-target
10560 (or (eq new-nodes t)
10561 (and (eq new-nodes 'confirm)
10563 child)))))
10564 (org-refile-new-child parent-target child)))
10565 (error "Invalid target location")))))
10567 (defun org-refile-check-position (refile-pointer)
10568 "Check if the refile pointer matches the readline to which it points."
10569 (let* ((file (nth 1 refile-pointer))
10570 (re (nth 2 refile-pointer))
10571 (pos (nth 3 refile-pointer))
10572 buffer)
10573 (when (org-string-nw-p re)
10574 (setq buffer (if (markerp pos)
10575 (marker-buffer pos)
10576 (or (find-buffer-visiting file)
10577 (find-file-noselect file))))
10578 (with-current-buffer buffer
10579 (save-excursion
10580 (save-restriction
10581 (widen)
10582 (goto-char pos)
10583 (beginning-of-line 1)
10584 (unless (org-looking-at-p re)
10585 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10587 (defun org-refile-new-child (parent-target child)
10588 "Use refile target PARENT-TARGET to add new CHILD below it."
10589 (unless parent-target
10590 (error "Cannot find parent for new node"))
10591 (let ((file (nth 1 parent-target))
10592 (pos (nth 3 parent-target))
10593 level)
10594 (with-current-buffer (or (find-buffer-visiting file)
10595 (find-file-noselect file))
10596 (save-excursion
10597 (save-restriction
10598 (widen)
10599 (if pos
10600 (goto-char pos)
10601 (goto-char (point-max))
10602 (if (not (bolp)) (newline)))
10603 (when (looking-at org-outline-regexp)
10604 (setq level (funcall outline-level))
10605 (org-end-of-subtree t t))
10606 (org-back-over-empty-lines)
10608 (if pos (org-get-valid-level level 1) 1) ?*)
10610 (beginning-of-line 0)
10611 (list (concat (car parent-target) "/" child) file "" (point)))))))
10613 (defun org-olpath-completing-read (prompt collection &rest args)
10614 "Read an outline path like a file name."
10615 (let ((thetable collection)
10616 (org-completion-use-ido nil) ; does not work with ido.
10617 (org-completion-use-iswitchb nil)) ; or iswitchb
10618 (apply
10619 'org-icompleting-read prompt
10620 (lambda (string predicate &optional flag)
10621 (let (rtn r f (l (length string)))
10622 (cond
10623 ((eq flag nil)
10624 ;; try completion
10625 (try-completion string thetable))
10626 ((eq flag t)
10627 ;; all-completions
10628 (setq rtn (all-completions string thetable predicate))
10629 (mapcar
10630 (lambda (x)
10631 (setq r (substring x l))
10632 (if (string-match " ([^)]*)$" x)
10633 (setq f (match-string 0 x))
10634 (setq f ""))
10635 (if (string-match "/" r)
10636 (concat string (substring r 0 (match-end 0)) f)
10637 x))
10638 rtn))
10639 ((eq flag 'lambda)
10640 ;; exact match?
10641 (assoc string thetable)))
10642 ))
10643 args)))
10645 ;;;; Dynamic blocks
10647 (defun org-find-dblock (name)
10648 "Find the first dynamic block with name NAME in the buffer.
10649 If not found, stay at current position and return nil."
10650 (let (pos)
10651 (save-excursion
10652 (goto-char (point-min))
10654 nil t)
10655 (match-beginning 0))))
10656 (if pos (goto-char pos))
10657 pos))
10659 (defconst org-dblock-start-re
10661 "Matches the start line of a dynamic block, with parameters.")
10664 "Matches the end of a dynamic block.")
10666 (defun org-create-dblock (plist)
10667 "Create a dynamic block section, with parameters taken from PLIST.
10668 PLIST must contain a :name entry which is used as name of the block."
10670 (end-of-line 1)
10671 (newline))
10672 (let ((col (current-column))
10673 (name (plist-get plist :name)))
10674 (insert "#+BEGIN: " name)
10675 (while plist
10676 (if (eq (car plist) :name)
10677 (setq plist (cddr plist))
10678 (insert " " (prin1-to-string (pop plist)))))
10680 (beginning-of-line -2)))
10682 (defun org-prepare-dblock ()
10683 "Prepare dynamic block for refresh.
10684 This empties the block, puts the cursor at the insert position and returns
10685 the property list including an extra property :name with the block name."
10686 (unless (looking-at org-dblock-start-re)
10687 (error "Not at a dynamic block"))
10688 (let* ((begdel (1+ (match-end 0)))
10689 (name (org-no-properties (match-string 1)))
10690 (params (append (list :name name)
10691 (read (concat "(" (match-string 3) ")")))))
10692 (save-excursion
10693 (beginning-of-line 1)
10695 (setq params (plist-put params :indentation-column (current-column))))
10696 (unless (re-search-forward org-dblock-end-re nil t)
10697 (error "Dynamic block not terminated"))
10698 (setq params
10699 (append params
10700 (list :content (buffer-substring
10701 begdel (match-beginning 0)))))
10702 (delete-region begdel (match-beginning 0))
10703 (goto-char begdel)
10704 (open-line 1)
10705 params))
10707 (defun org-map-dblocks (&optional command)
10708 "Apply COMMAND to all dynamic blocks in the current buffer.
10709 If COMMAND is not given, use `org-update-dblock'."
10710 (let ((cmd (or command 'org-update-dblock)))
10711 (save-excursion
10712 (goto-char (point-min))
10713 (while (re-search-forward org-dblock-start-re nil t)
10714 (goto-char (match-beginning 0))
10715 (save-excursion
10716 (condition-case nil
10717 (funcall cmd)
10718 (error (message "Error during update of dynamic block"))))
10719 (unless (re-search-forward org-dblock-end-re nil t)
10720 (error "Dynamic block not terminated"))))))
10722 (defun org-dblock-update (&optional arg)
10723 "User command for updating dynamic blocks.
10724 Update the dynamic block at point. With prefix ARG, update all dynamic
10725 blocks in the buffer."
10726 (interactive "P")
10727 (if arg
10728 (org-update-all-dblocks)
10729 (or (looking-at org-dblock-start-re)
10730 (org-beginning-of-dblock))
10731 (org-update-dblock)))
10733 (defun org-update-dblock ()
10734 "Update the dynamic block at point.
10735 This means to empty the block, parse for parameters and then call
10736 the correct writing function."
10737 (interactive)
10738 (save-window-excursion
10739 (let* ((pos (point))
10740 (line (org-current-line))
10741 (params (org-prepare-dblock))
10742 (name (plist-get params :name))
10743 (indent (plist-get params :indentation-column))
10744 (cmd (intern (concat "org-dblock-write:" name))))
10745 (message "Updating dynamic block `%s' at line %d..." name line)
10746 (funcall cmd params)
10747 (message "Updating dynamic block `%s' at line %d...done" name line)
10748 (goto-char pos)
10749 (when (and indent (> indent 0))
10750 (setq indent (make-string indent ?\ ))
10751 (save-excursion
10752 (org-beginning-of-dblock)
10753 (forward-line 1)
10754 (while (not (looking-at org-dblock-end-re))
10755 (insert indent)
10756 (beginning-of-line 2))
10757 (when (looking-at org-dblock-end-re)
10759 (replace-match ""))
10760 (insert indent)))))))
10762 (defun org-beginning-of-dblock ()
10763 "Find the beginning of the dynamic block at point.
10764 Error if there is no such block at point."
10765 (let ((pos (point))
10766 beg)
10767 (end-of-line 1)
10768 (if (and (re-search-backward org-dblock-start-re nil t)
10769 (setq beg (match-beginning 0))
10770 (re-search-forward org-dblock-end-re nil t)
10771 (> (match-end 0) pos))
10772 (goto-char beg)
10773 (goto-char pos)
10774 (error "Not in a dynamic block"))))
10776 (defun org-update-all-dblocks ()
10777 "Update all dynamic blocks in the buffer.
10778 This function can be used in a hook."
10779 (interactive)
10780 (when (org-mode-p)
10781 (org-map-dblocks 'org-update-dblock)))
10784 ;;;; Completion
10786 (defconst org-additional-option-like-keywords
10787 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10788 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10789 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10790 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10791 "BEGIN:" "END:"
10792 "ORGTBL" "TBLFM:" "TBLNAME:"
10793 "BEGIN_EXAMPLE" "END_EXAMPLE"
10794 "BEGIN_QUOTE" "END_QUOTE"
10795 "BEGIN_VERSE" "END_VERSE"
10796 "BEGIN_CENTER" "END_CENTER"
10797 "BEGIN_SRC" "END_SRC"
10798 "BEGIN_RESULT" "END_RESULT"
10799 "SOURCE:" "SRCNAME:" "FUNCTION:"
10800 "RESULTS:" "DATA:"
10801 "HEADER:" "HEADERS:"
10802 "BABEL:"
10803 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10804 "CAPTION:" "LABEL:"
10805 "SETUPFILE:"
10806 "INCLUDE:"
10807 "BIND:"
10808 "MACRO:"))
10810 (defcustom org-structure-template-alist
10811 '(
10824 ("L" "#+latex: "
10828 ("H" "#+html: "
10831 ("A" "#+ascii: ")
10832 ("i" "#+index: ?"
10833 "#+index: ?")
10834 ("I" "#+include %file ?"
10836 )
10837 "Structure completion elements.
10838 This is a list of abbreviation keys and values. The value gets inserted
10839 if you type `<' followed by the key and then press the completion key,
10840 usually `M-TAB'. %file will be replaced by a file name after prompting
10841 for the file using completion. The cursor will be placed at the position
10842 of the `?` in the template.
10843 There are two templates for each key, the first uses the original Org syntax,
10844 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10845 the default when the /org-mtags.el/ module has been loaded. See also the
10846 variable `org-mtags-prefer-muse-templates'.
10847 This is an experimental feature, it is undecided if it is going to stay in."
10848 :group 'org-completion
10849 :type '(repeat
10850 (string :tag "Key")
10851 (string :tag "Template")
10852 (string :tag "Muse Template")))
10854 (defun org-try-structure-completion ()
10855 "Try to complete a structure template before point.
10857 expands them."
10858 (let ((l (buffer-substring (point-at-bol) (point)))
10859 a)
10862 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10863 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10864 (match-beginning 1)) a)
10865 t)))
10867 (defun org-complete-expand-structure-template (start cell)
10868 "Expand a structure template."
10869 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10870 (rpl (nth (if musep 2 1) cell))
10871 (ind ""))
10872 (delete-region start (point))
10874 (cond
10875 ((bolp))
10877 (setq ind (buffer-substring (point-at-bol) (point))))
10878 (t (newline))))
10879 (setq start (point))
10880 (if (string-match "%file" rpl)
10881 (setq rpl (replace-match
10882 (concat
10884 (save-match-data
10885 (abbreviate-file-name (read-file-name "Include file: ")))
10887 t t rpl)))
10890 (insert rpl)
10893 ;;;; TODO, DEADLINE, Comments
10895 (defun org-toggle-comment ()
10896 "Change the COMMENT state of an entry."
10897 (interactive)
10898 (save-excursion
10899 (org-back-to-heading)
10900 (let (case-fold-search)
10901 (if (looking-at (concat org-outline-regexp
10903 (replace-match "" t t nil 1)
10904 (if (looking-at org-outline-regexp)
10905 (progn
10906 (goto-char (match-end 0))
10907 (insert org-comment-string " ")))))))
10909 (defvar org-last-todo-state-is-todo nil
10910 "This is non-nil when the last TODO state change led to a TODO state.
10911 If the last change removed the TODO tag or switched to DONE, then
10912 this is nil.")
10914 (defvar org-setting-tags nil) ; dynamically skipped
10916 (defvar org-todo-setup-filter-hook nil
10917 "Hook for functions that pre-filter todo specs.
10918 Each function takes a todo spec and returns either nil or the spec
10919 transformed into canonical form." )
10921 (defvar org-todo-get-default-hook nil
10922 "Hook for functions that get a default item for todo.
10923 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10924 nil or a string to be used for the todo mark." )
10926 (defvar org-agenda-headline-snapshot-before-repeat)
10928 (defun org-current-effective-time ()
10929 "Return current time adjusted for `org-extend-today-until' variable"
10930 (let* ((ct (org-current-time))
10931 (dct (decode-time ct))
10932 (ct1
10933 (if (< (nth 2 dct) org-extend-today-until)
10934 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
10935 ct)))
10936 ct1))
10938 (defun org-todo-yesterday (&optional arg)
10939 "Like `org-todo' but the time of change will be 23:59 of yesterday"
10940 (interactive "P")
10941 (let* ((hour (third (decode-time
10942 (org-current-time))))
10943 (org-extend-today-until (1+ hour)))
10944 (org-todo arg)))
10946 (defun org-agenda-todo-yesterday (&optional arg)
10947 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday"
10948 (interactive "P")
10949 (let* ((hour (third (decode-time
10950 (org-current-time))))
10951 (org-extend-today-until (1+ hour)))
10952 (org-agenda-todo arg)))
10954 (defun org-todo (&optional arg)
10955 "Change the TODO state of an item.
10956 The state of an item is given by a keyword at the start of the heading,
10957 like
10958 *** TODO Write paper
10959 *** DONE Call mom
10961 The different keywords are specified in the variable `org-todo-keywords'.
10963 So for this example: when the item starts with TODO, it is changed to DONE.
10964 When it starts with DONE, the DONE is removed. And when neither TODO nor
10965 DONE are present, add TODO at the beginning of the heading.
10968 state.
10969 With numeric prefix arg, switch to that state.
10971 keywords (nextset).
10974 For calling through lisp, arg is also interpreted in the following way:
10975 'none -> empty state
10977 'done -> switch to DONE
10978 'nextset -> switch to the next set of keywords
10979 'previousset -> switch to the previous set of keywords
10981 really is a member of `org-todo-keywords'."
10982 (interactive "P")
10983 (if (equal arg '(16)) (setq arg 'nextset))
10984 (let ((org-blocker-hook org-blocker-hook)
10985 (case-fold-search nil))
10986 (when (equal arg '(64))
10987 (setq arg nil org-blocker-hook nil))
10988 (when (and org-blocker-hook
10989 (or org-inhibit-blocking
10990 (org-entry-get nil "NOBLOCKING")))
10991 (setq org-blocker-hook nil))
10992 (save-excursion
10993 (catch 'exit
10994 (org-back-to-heading t)
10995 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
10997 (looking-at " *"))
10998 (let* ((match-data (match-data))
10999 (startpos (point-at-bol))
11000 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11001 (org-log-done org-log-done)
11002 (org-log-repeat org-log-repeat)
11003 (org-todo-log-states org-todo-log-states)
11004 (this (match-string 1))
11005 (hl-pos (match-beginning 0))
11006 (head (org-get-todo-sequence-head this))
11007 (ass (assoc head org-todo-kwd-alist))
11008 (interpret (nth 1 ass))
11009 (done-word (nth 3 ass))
11010 (final-done-word (nth 4 ass))
11011 (last-state (or this ""))
11012 (completion-ignore-case t)
11013 (member (member this org-todo-keywords-1))
11014 (tail (cdr member))
11015 (state (cond
11016 ((and org-todo-key-trigger
11017 (or (and (equal arg '(4))
11018 (eq org-use-fast-todo-selection 'prefix))
11019 (and (not arg) org-use-fast-todo-selection
11020 (not (eq org-use-fast-todo-selection
11021 'prefix)))))
11022 ;; Use fast selection
11023 (org-fast-todo-selection))
11024 ((and (equal arg '(4))
11025 (or (not org-use-fast-todo-selection)
11026 (not org-todo-key-trigger)))
11027 ;; Read a state with completion
11028 (org-icompleting-read
11029 "State: " (mapcar (lambda(x) (list x))
11030 org-todo-keywords-1)
11031 nil t))
11032 ((eq arg 'right)
11033 (if this
11034 (if tail (car tail) nil)
11035 (car org-todo-keywords-1)))
11036 ((eq arg 'left)
11037 (if (equal member org-todo-keywords-1)
11038 nil
11039 (if this
11040 (nth (- (length org-todo-keywords-1)
11041 (length tail) 2)
11042 org-todo-keywords-1)
11043 (org-last org-todo-keywords-1))))
11044 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11045 (setq arg nil))) ; hack to fall back to cycling
11046 (arg
11047 ;; user or caller requests a specific state
11048 (cond
11049 ((equal arg "") nil)
11050 ((eq arg 'none) nil)
11051 ((eq arg 'done) (or done-word (car org-done-keywords)))
11052 ((eq arg 'nextset)
11053 (or (car (cdr (member head org-todo-heads)))
11054 (car org-todo-heads)))
11055 ((eq arg 'previousset)
11056 (let ((org-todo-heads (reverse org-todo-heads)))
11057 (or (car (cdr (member head org-todo-heads)))
11058 (car org-todo-heads))))
11059 ((car (member arg org-todo-keywords-1)))
11060 ((stringp arg)
11061 (error "State `%s' not valid in this file" arg))
11062 ((nth (1- (prefix-numeric-value arg))
11063 org-todo-keywords-1))))
11064 ((null member) (or head (car org-todo-keywords-1)))
11065 ((equal this final-done-word) nil) ;; -> make empty
11066 ((null tail) nil) ;; -> first entry
11067 ((memq interpret '(type priority))
11068 (if (eq this-command last-command)
11069 (car tail)
11070 (if (> (length tail) 0)
11071 (or done-word (car org-done-keywords))
11072 nil)))
11073 (t
11074 (car tail))))
11075 (state (or
11076 (run-hook-with-args-until-success
11077 'org-todo-get-default-hook state last-state)
11078 state))
11079 (next (if state (concat " " state " ") " "))
11080 (change-plist (list :type 'todo-state-change :from this :to state
11081 :position startpos))
11082 dolog now-done-p)
11083 (when org-blocker-hook
11084 (setq org-last-todo-state-is-todo
11085 (not (member this org-done-keywords)))
11086 (unless (save-excursion
11087 (save-match-data
11088 (org-with-wide-buffer
11089 (run-hook-with-args-until-failure
11090 'org-blocker-hook change-plist))))
11091 (if (org-called-interactively-p 'interactive)
11092 (error "TODO state change from %s to %s blocked" this state)
11093 ;; fail silently
11094 (message "TODO state change from %s to %s blocked" this state)
11095 (throw 'exit nil))))
11096 (store-match-data match-data)
11097 (replace-match next t t)
11098 (unless (pos-visible-in-window-p hl-pos)
11099 (message "TODO state changed to %s" (org-trim next)))
11100 (unless head
11101 (setq head (org-get-todo-sequence-head state)
11102 ass (assoc head org-todo-kwd-alist)
11103 interpret (nth 1 ass)
11104 done-word (nth 3 ass)
11105 final-done-word (nth 4 ass)))
11106 (when (memq arg '(nextset previousset))
11107 (message "Keyword-Set %d/%d: %s"
11108 (- (length org-todo-sets) -1
11109 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11110 (length org-todo-sets)
11111 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11112 (setq org-last-todo-state-is-todo
11113 (not (member state org-done-keywords)))
11114 (setq now-done-p (and (member state org-done-keywords)
11115 (not (member this org-done-keywords))))
11116 (and logging (org-local-logging logging))
11117 (when (and (or org-todo-log-states org-log-done)
11118 (not (eq org-inhibit-logging t))
11119 (not (memq arg '(nextset previousset))))
11120 ;; we need to look at recording a time and note
11121 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11122 (nth 2 (assoc this org-todo-log-states))))
11123 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11124 (setq dolog 'time))
11125 (when (and state
11126 (member state org-not-done-keywords)
11127 (not (member this org-not-done-keywords)))
11128 ;; This is now a todo state and was not one before
11129 ;; If there was a CLOSED time stamp, get rid of it.
11130 (org-add-planning-info nil nil 'closed))
11131 (when (and now-done-p org-log-done)
11132 ;; It is now done, and it was not done before
11133 (org-add-planning-info 'closed (org-current-effective-time))
11134 (if (and (not dolog) (eq 'note org-log-done))
11135 (org-add-log-setup 'done state this 'findpos 'note)))
11136 (when (and state dolog)
11137 ;; This is a non-nil state, and we need to log it
11138 (org-add-log-setup 'state state this 'findpos dolog)))
11139 ;; Fixup tag positioning
11140 (org-todo-trigger-tag-changes state)
11141 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11142 (when org-provide-todo-statistics
11143 (org-update-parent-todo-statistics))
11144 (run-hooks 'org-after-todo-state-change-hook)
11145 (if (and arg (not (member state org-done-keywords)))
11146 (setq head (org-get-todo-sequence-head state)))
11147 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11148 ;; Do we need to trigger a repeat?
11149 (when now-done-p
11150 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11151 ;; This is for the agenda, take a snapshot of the headline.
11152 (save-match-data
11153 (setq org-agenda-headline-snapshot-before-repeat
11154 (org-get-heading))))
11155 (org-auto-repeat-maybe state))
11156 ;; Fixup cursor location if close to the keyword
11157 (if (and (outline-on-heading-p)
11158 (not (bolp))
11159 (save-excursion (beginning-of-line 1)
11160 (looking-at org-todo-line-regexp))
11161 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11162 (progn
11163 (goto-char (or (match-end 2) (match-end 1)))
11164 (and (looking-at " ") (just-one-space))))
11165 (when org-trigger-hook
11166 (save-excursion
11167 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11169 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11170 "Block turning an entry into a TODO, using the hierarchy.
11171 This checks whether the current task should be blocked from state
11172 changes. Such blocking occurs when:
11174 1. The task has children which are not all in a completed state.
11176 2. A task has a parent with the property :ORDERED:, and there
11177 are siblings prior to the current task with incomplete
11178 status.
11180 3. The parent of the task is blocked because it has siblings that should
11181 be done first, or is child of a block grandparent TODO entry."
11183 (if (not org-enforce-todo-dependencies)
11184 t ; if locally turned off don't block
11185 (catch 'dont-block
11186 ;; If this is not a todo state change, or if this entry is already DONE,
11187 ;; do not block
11188 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11189 (member (plist-get change-plist :from)
11190 (cons 'done org-done-keywords))
11191 (member (plist-get change-plist :to)
11192 (cons 'todo org-not-done-keywords))
11193 (not (plist-get change-plist :to)))
11194 (throw 'dont-block t))
11195 ;; If this task has children, and any are undone, it's blocked
11196 (save-excursion
11197 (org-back-to-heading t)
11198 (let ((this-level (funcall outline-level)))
11199 (outline-next-heading)
11200 (let ((child-level (funcall outline-level)))
11201 (while (and (not (eobp))
11202 (> child-level this-level))
11203 ;; this todo has children, check whether they are all
11204 ;; completed
11205 (if (and (not (org-entry-is-done-p))
11206 (org-entry-is-todo-p))
11207 (throw 'dont-block nil))
11208 (outline-next-heading)
11209 (setq child-level (funcall outline-level))))))
11210 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11211 ;; any previous siblings are undone, it's blocked
11212 (save-excursion
11213 (org-back-to-heading t)
11214 (let* ((pos (point))
11215 (parent-pos (and (org-up-heading-safe) (point))))
11216 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11217 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11218 (forward-line 1)
11219 (re-search-forward org-not-done-heading-regexp pos t))
11220 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11221 ;; Search further up the hierarchy, to see if an anchestor is blocked
11222 (while t
11223 (goto-char parent-pos)
11224 (if (not (looking-at org-not-done-heading-regexp))
11225 (throw 'dont-block t)) ; do not block, parent is not a TODO
11226 (setq pos (point))
11227 (setq parent-pos (and (org-up-heading-safe) (point)))
11228 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11229 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11230 (forward-line 1)
11231 (re-search-forward org-not-done-heading-regexp pos t))
11232 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11234 (defcustom org-track-ordered-property-with-tag nil
11235 "Should the ORDERED property also be shown as a tag?
11236 The ORDERED property decides if an entry should require subtasks to be
11237 completed in sequence. Since a property is not very visible, setting
11238 this option means that toggling the ORDERED property with the command
11239 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11240 not relevant for the behavior, but it makes things more visible.
11242 Note that toggling the tag with tags commands will not change the property
11243 and therefore not influence behavior!
11245 This can be t, meaning the tag ORDERED should be used, It can also be a
11246 string to select a different tag for this task."
11247 :group 'org-todo
11248 :type '(choice
11249 (const :tag "No tracking" nil)
11250 (const :tag "Track with ORDERED tag" t)
11251 (string :tag "Use other tag")))
11253 (defun org-toggle-ordered-property ()
11254 "Toggle the ORDERED property of the current entry.
11255 For better visibility, you can track the value of this property with a tag.
11256 See variable `org-track-ordered-property-with-tag'."
11257 (interactive)
11258 (let* ((t1 org-track-ordered-property-with-tag)
11259 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11260 (save-excursion
11261 (org-back-to-heading)
11262 (if (org-entry-get nil "ORDERED")
11263 (progn
11264 (org-delete-property "ORDERED")
11265 (and tag (org-toggle-tag tag 'off))
11266 (message "Subtasks can be completed in arbitrary order"))
11267 (org-entry-put nil "ORDERED" "t")
11268 (and tag (org-toggle-tag tag 'on))
11269 (message "Subtasks must be completed in sequence")))))
11271 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11272 (defun org-block-todo-from-checkboxes (change-plist)
11273 "Block turning an entry into a TODO, using checkboxes.
11274 This checks whether the current task should be blocked from state
11275 changes because there are unchecked boxes in this entry."
11276 (if (not org-enforce-todo-checkbox-dependencies)
11277 t ; if locally turned off don't block
11278 (catch 'dont-block
11279 ;; If this is not a todo state change, or if this entry is already DONE,
11280 ;; do not block
11281 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11282 (member (plist-get change-plist :from)
11283 (cons 'done org-done-keywords))
11284 (member (plist-get change-plist :to)
11285 (cons 'todo org-not-done-keywords))
11286 (not (plist-get change-plist :to)))
11287 (throw 'dont-block t))
11288 ;; If this task has checkboxes that are not checked, it's blocked
11289 (save-excursion
11290 (org-back-to-heading t)
11291 (let ((beg (point)) end)
11292 (outline-next-heading)
11293 (setq end (point))
11294 (goto-char beg)
11296 end t)
11297 (progn
11298 (if (boundp 'org-blocked-by-checkboxes)
11299 (setq org-blocked-by-checkboxes t))
11300 (throw 'dont-block nil)))))
11301 t))) ; do not block
11303 (defun org-entry-blocked-p ()
11304 "Is the current entry blocked?"
11305 (if (org-entry-get nil "NOBLOCKING")
11306 nil ;; Never block this entry
11307 (not
11308 (run-hook-with-args-until-failure
11309 'org-blocker-hook
11310 (list :type 'todo-state-change
11311 :position (point)
11312 :from 'todo
11313 :to 'done)))))
11315 (defun org-update-statistics-cookies (all)
11316 "Update the statistics cookie, either from TODO or from checkboxes.
11317 This should be called with the cursor in a line with a statistics cookie."
11318 (interactive "P")
11319 (if all
11320 (progn
11321 (org-update-checkbox-count 'all)
11322 (org-map-entries 'org-update-parent-todo-statistics))
11323 (if (not (org-on-heading-p))
11324 (org-update-checkbox-count)
11325 (let ((pos (move-marker (make-marker) (point)))
11326 end l1 l2)
11327 (ignore-errors (org-back-to-heading t))
11328 (if (not (org-on-heading-p))
11329 (org-update-checkbox-count)
11330 (setq l1 (org-outline-level))
11331 (setq end (save-excursion
11332 (outline-next-heading)
11333 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11334 (point)))
11335 (if (and (save-excursion
11336 (re-search-forward
11338 (not (save-excursion (re-search-forward
11340 (org-update-checkbox-count)
11341 (if (and l2 (> l2 l1))
11342 (progn
11343 (goto-char end)
11344 (org-update-parent-todo-statistics))
11345 (goto-char pos)
11346 (beginning-of-line 1)
11347 (while (re-search-forward
11349 (point-at-eol) t)
11350 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11351 (goto-char pos)
11352 (move-marker pos nil)))))
11354 (defvar org-entry-property-inherited-from) ;; defined below
11355 (defun org-update-parent-todo-statistics ()
11356 "Update any statistics cookie in the parent of the current headline.
11357 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11358 the entire subtree and this will travel up the hierarchy and update
11359 statistics everywhere."
11360 (let* ((prop (save-excursion (org-up-heading-safe)
11361 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11362 (recursive (or (not org-hierarchical-todo-statistics)
11364 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11365 0))
11366 (first t)
11368 level ltoggle l1 new ndel
11369 (cnt-all 0) (cnt-done 0) is-percent kwd
11370 checkbox-beg ov ovs ove cookie-present)
11371 (catch 'exit
11372 (save-excursion
11373 (beginning-of-line 1)
11374 (setq ltoggle (funcall outline-level))
11375 ;; Three situations are to consider:
11377 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11378 ;; to the top-level ancestor on the headline;
11380 ;; 2. If parent has "recursive" property, repeat up to the
11381 ;; headline setting that property, taking inheritance into
11382 ;; account;
11384 ;; 3. Else, move up to direct parent and proceed only once.
11385 (while (and (setq level (org-up-heading-safe))
11386 (or recursive first)
11387 (>= (point) lim))
11388 (setq first nil cookie-present nil)
11389 (unless (and level
11390 (not (string-match
11392 (downcase (or (org-entry-get nil "COOKIE_DATA")
11393 "")))))
11394 (throw 'exit nil))
11395 (while (re-search-forward box-re (point-at-eol) t)
11396 (setq cnt-all 0 cnt-done 0 cookie-present t)
11397 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11398 (save-match-data
11399 (unless (outline-next-heading) (throw 'exit nil))
11400 (while (and (looking-at org-complex-heading-regexp)
11401 (> (setq l1 (length (match-string 1))) level))
11402 (setq kwd (and (or recursive (= l1 ltoggle))
11403 (match-string 2)))
11404 (if (or (eq org-provide-todo-statistics 'all-headlines)
11405 (and (listp org-provide-todo-statistics)
11406 (or (member kwd org-provide-todo-statistics)
11407 (member kwd org-done-keywords))))
11408 (setq cnt-all (1+ cnt-all))
11409 (if (eq org-provide-todo-statistics t)
11410 (and kwd (setq cnt-all (1+ cnt-all)))))
11411 (and (member kwd org-done-keywords)
11412 (setq cnt-done (1+ cnt-done)))
11413 (outline-next-heading)))
11414 (setq new
11415 (if is-percent
11416 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11417 (format "[%d/%d]" cnt-done cnt-all))
11418 ndel (- (match-end 0) checkbox-beg))
11419 ;; handle overlays when updating cookie from column view
11420 (when (setq ov (car (overlays-at checkbox-beg)))
11421 (setq ovs (overlay-start ov) ove (overlay-end ov))
11422 (delete-overlay ov))
11423 (goto-char checkbox-beg)
11424 (insert new)
11425 (delete-region (point) (+ (point) ndel))
11426 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11427 (when ov (move-overlay ov ovs ove)))
11428 (when cookie-present
11429 (run-hook-with-args 'org-after-todo-statistics-hook
11430 cnt-done (- cnt-all cnt-done))))))
11431 (run-hooks 'org-todo-statistics-hook)))
11433 (defvar org-after-todo-statistics-hook nil
11434 "Hook that is called after a TODO statistics cookie has been updated.
11435 Each function is called with two arguments: the number of not-done entries
11436 and the number of done entries.
11438 For example, the following function, when added to this hook, will switch
11439 an entry to DONE when all children are done, and back to TODO when new
11440 entries are set to a TODO status. Note that this hook is only called
11441 when there is a statistics cookie in the headline!
11443 (defun org-summary-todo (n-done n-not-done)
11445 (let (org-log-done org-log-states) ; turn off logging
11447 ")
11449 (defvar org-todo-statistics-hook nil
11450 "Hook that is run whenever Org thinks TODO statistics should be updated.
11451 This hook runs even if there is no statistics cookie present, in which case
11452 `org-after-todo-statistics-hook' would not run.")
11454 (defun org-todo-trigger-tag-changes (state)
11455 "Apply the changes defined in `org-todo-state-tags-triggers'."
11456 (let ((l org-todo-state-tags-triggers)
11457 changes)
11458 (when (or (not state) (equal state ""))
11459 (setq changes (append changes (cdr (assoc "" l)))))
11460 (when (and (stringp state) (> (length state) 0))
11461 (setq changes (append changes (cdr (assoc state l)))))
11462 (when (member state org-not-done-keywords)
11463 (setq changes (append changes (cdr (assoc 'todo l)))))
11464 (when (member state org-done-keywords)
11465 (setq changes (append changes (cdr (assoc 'done l)))))
11466 (dolist (c changes)
11467 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11469 (defun org-local-logging (value)
11470 "Get logging settings from a property VALUE."
11471 (let* (words w a)
11472 ;; directly set the variables, they are already local.
11473 (setq org-log-done nil
11474 org-log-repeat nil
11475 org-todo-log-states nil)
11476 (setq words (org-split-string value))
11477 (while (setq w (pop words))
11478 (cond
11479 ((setq a (assoc w org-startup-options))
11480 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11481 (set (nth 1 a) (nth 2 a))))
11482 ((setq a (org-extract-log-state-settings w))
11483 (and (member (car a) org-todo-keywords-1)
11484 (push a org-todo-log-states)))))))
11486 (defun org-get-todo-sequence-head (kwd)
11487 "Return the head of the TODO sequence to which KWD belongs.
11488 If KWD is not set, check if there is a text property remembering the
11489 right sequence."
11490 (let (p)
11491 (cond
11492 ((not kwd)
11493 (or (get-text-property (point-at-bol) 'org-todo-head)
11494 (progn
11495 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11496 nil (point-at-eol)))
11497 (get-text-property p 'org-todo-head))))
11498 ((not (member kwd org-todo-keywords-1))
11499 (car org-todo-keywords-1))
11500 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11502 (defun org-fast-todo-selection ()
11503 "Fast TODO keyword selection with single keys.
11504 Returns the new TODO keyword, or nil if no state change should occur."
11505 (let* ((fulltable org-todo-key-alist)
11506 (done-keywords org-done-keywords) ;; needed for the faces.
11507 (maxlen (apply 'max (mapcar
11508 (lambda (x)
11509 (if (stringp (car x)) (string-width (car x)) 0))
11510 fulltable)))
11511 (expert nil)
11512 (fwidth (+ maxlen 3 1 3))
11513 (ncol (/ (- (window-width) 4) fwidth))
11514 tg cnt e c tbl
11515 groups ingroup)
11516 (save-excursion
11517 (save-window-excursion
11518 (if expert
11519 (set-buffer (get-buffer-create " *Org todo*"))
11520 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11521 (erase-buffer)
11522 (org-set-local 'org-done-keywords done-keywords)
11523 (setq tbl fulltable cnt 0)
11524 (while (setq e (pop tbl))
11525 (cond
11526 ((equal e '(:startgroup))
11527 (push '() groups) (setq ingroup t)
11528 (when (not (= cnt 0))
11529 (setq cnt 0)
11531 (insert "{ "))
11532 ((equal e '(:endgroup))
11533 (setq ingroup nil cnt 0)
11535 ((equal e '(:newline))
11536 (when (not (= cnt 0))
11537 (setq cnt 0)
11539 (setq e (car tbl))
11540 (while (equal (car tbl) '(:newline))
11542 (setq tbl (cdr tbl)))))
11543 (t
11544 (setq tg (car e) c (cdr e))
11545 (if ingroup (push tg (car groups)))
11546 (setq tg (org-add-props tg nil 'face
11547 (org-get-todo-face tg)))
11548 (if (and (= cnt 0) (not ingroup)) (insert " "))
11549 (insert "[" c "] " tg (make-string
11550 (- fwidth 4 (length tg)) ?\ ))
11551 (when (= (setq cnt (1+ cnt)) ncol)
11553 (if ingroup (insert " "))
11554 (setq cnt 0)))))
11556 (goto-char (point-min))
11557 (if (not expert) (org-fit-window-to-buffer))
11558 (message "[a-z..]:Set [SPC]:clear")
11559 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11560 (cond
11561 ((or (= c ?\C-g)
11562 (and (= c ?q) (not (rassoc c fulltable))))
11563 (setq quit-flag t))
11564 ((= c ?\ ) nil)
11565 ((setq e (rassoc c fulltable) tg (car e))
11566 tg)
11567 (t (setq quit-flag t)))))))
11569 (defun org-entry-is-todo-p ()
11570 (member (org-get-todo-state) org-not-done-keywords))
11572 (defun org-entry-is-done-p ()
11573 (member (org-get-todo-state) org-done-keywords))
11575 (defun org-get-todo-state ()
11576 (save-excursion
11577 (org-back-to-heading t)
11578 (and (looking-at org-todo-line-regexp)
11579 (match-end 2)
11580 (match-string 2))))
11582 (defun org-at-date-range-p (&optional inactive-ok)
11583 "Is the cursor inside a date range?"
11584 (interactive)
11585 (save-excursion
11586 (catch 'exit
11587 (let ((pos (point)))
11589 (skip-chars-backward "<[")
11590 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11591 (>= (match-end 0) pos)
11592 (throw 'exit t))
11594 (skip-chars-backward "<[")
11595 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11596 (>= (match-end 0) pos)
11597 (throw 'exit t)))
11598 nil)))
11600 (defun org-get-repeat (&optional tagline)
11601 "Check if there is a deadline/schedule with repeater in this entry."
11602 (save-match-data
11603 (save-excursion
11604 (org-back-to-heading t)
11605 (and (re-search-forward (if tagline
11607 org-repeat-re)
11608 (org-entry-end-position) t)
11609 (match-string-no-properties 1)))))
11611 (defvar org-last-changed-timestamp)
11612 (defvar org-last-inserted-timestamp)
11613 (defvar org-log-post-message)
11614 (defvar org-log-note-purpose)
11615 (defvar org-log-note-how)
11616 (defvar org-log-note-extra)
11617 (defun org-auto-repeat-maybe (done-word)
11618 "Check if the current headline contains a repeated deadline/schedule.
11619 If yes, set TODO state back to what it was and change the base date
11620 of repeating deadline/scheduled time stamps to new date.
11621 This function is run automatically after each state change to a DONE state."
11622 ;; last-state is dynamically scoped into this function
11623 (let* ((repeat (org-get-repeat))
11624 (aa (assoc last-state org-todo-kwd-alist))
11625 (interpret (nth 1 aa))
11626 (head (nth 2 aa))
11627 (whata '(("d" . day) ("m" . month) ("y" . year)))
11628 (msg "Entry repeats: ")
11629 (org-log-done nil)
11630 (org-todo-log-states nil)
11631 re type n what ts time to-state)
11632 (when repeat
11633 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11634 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11635 org-todo-repeat-to-state))
11636 (unless (and to-state (member to-state org-todo-keywords-1))
11637 (setq to-state (if (eq interpret 'type) last-state head)))
11638 (org-todo to-state)
11639 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11640 (org-entry-put nil "LAST_REPEAT" (format-time-string
11641 (org-time-stamp-format t t))))
11642 (when org-log-repeat
11643 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11644 (memq 'org-add-log-note post-command-hook))
11645 ;; OK, we are already setup for some record
11646 (if (eq org-log-repeat 'note)
11647 ;; make sure we take a note, not only a time stamp
11648 (setq org-log-note-how 'note))
11649 ;; Set up for taking a record
11650 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11651 last-state
11652 'findpos org-log-repeat)))
11653 (org-back-to-heading t)
11654 (org-add-planning-info nil nil 'closed)
11658 (while (re-search-forward
11659 re (save-excursion (outline-next-heading) (point)) t)
11660 (setq type (if (match-end 1) org-scheduled-string
11661 (if (match-end 3) org-deadline-string "Plain:"))
11662 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11664 (setq n (string-to-number (match-string 2 ts))
11665 what (match-string 3 ts))
11666 (if (equal what "w") (setq n (* n 7) what "d"))
11667 ;; Preparation, see if we need to modify the start date for the change
11668 (when (match-end 1)
11669 (setq time (save-match-data (org-time-string-to-time ts)))
11670 (cond
11671 ((equal (match-string 1 ts) ".")
11672 ;; Shift starting date to today
11673 (org-timestamp-change
11674 (- (org-today) (time-to-days time))
11675 'day))
11676 ((equal (match-string 1 ts) "+")
11677 (let ((nshiftmax 10) (nshift 0))
11678 (while (or (= nshift 0)
11679 (<= (time-to-days time)
11680 (time-to-days (current-time))))
11681 (when (= (incf nshift) nshiftmax)
11682 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11683 (error "Abort")))
11684 (org-timestamp-change n (cdr (assoc what whata)))
11685 (org-at-timestamp-p t)
11686 (setq ts (match-string 1))
11687 (setq time (save-match-data (org-time-string-to-time ts)))))
11688 (org-timestamp-change (- n) (cdr (assoc what whata)))
11689 ;; rematch, so that we have everything in place for the real shift
11690 (org-at-timestamp-p t)
11691 (setq ts (match-string 1))
11693 (org-timestamp-change n (cdr (assoc what whata)))
11694 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11695 (setq org-log-post-message msg)
11696 (message "%s" msg))))
11698 (defun org-show-todo-tree (arg)
11699 "Make a compact tree which shows all headlines marked with TODO.
11700 The tree will show the lines where the regexp matches, and all higher
11701 headlines above the match.
11703 With a numeric prefix N, construct a sparse tree for the Nth element
11704 of `org-todo-keywords-1'."
11705 (interactive "P")
11706 (let ((case-fold-search nil)
11707 (kwd-re
11708 (cond ((null arg) org-not-done-regexp)
11709 ((equal arg '(4))
11710 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11711 (mapcar 'list org-todo-keywords-1))))
11715 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11716 (regexp-quote (nth (1- (prefix-numeric-value arg))
11717 org-todo-keywords-1)))
11718 (t (error "Invalid prefix argument: %s" arg)))))
11719 (message "%d TODO entries found"
11720 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11722 (defun org-deadline (&optional remove time)
11724 With argument REMOVE, remove any deadline from the item.
11725 With argument TIME, set the deadline at the corresponding date. TIME
11727 (interactive "P")
11728 (let* ((old-date (org-entry-get nil "DEADLINE"))
11729 (repeater (and old-date
11730 (string-match
11732 old-date)
11733 (match-string 1 old-date))))
11734 (if remove
11735 (progn
11736 (when (and old-date org-log-redeadline)
11737 (org-add-log-setup 'deldeadline nil old-date 'findpos
11738 org-log-redeadline))
11739 (org-remove-timestamp-with-keyword org-deadline-string)
11740 (message "Item no longer has a deadline."))
11741 (org-add-planning-info 'deadline time 'closed)
11742 (when (and old-date org-log-redeadline
11743 (not (equal old-date
11744 (substring org-last-inserted-timestamp 1 -1))))
11745 (org-add-log-setup 'redeadline nil old-date 'findpos
11746 org-log-redeadline))
11747 (when repeater
11748 (save-excursion
11749 (org-back-to-heading t)
11750 (when (re-search-forward (concat org-deadline-string " "
11751 org-last-inserted-timestamp)
11752 (save-excursion
11753 (outline-next-heading) (point)) t)
11754 (goto-char (1- (match-end 0)))
11755 (insert " " repeater)
11756 (setq org-last-inserted-timestamp
11757 (concat (substring org-last-inserted-timestamp 0 -1)
11758 " " repeater
11759 (substring org-last-inserted-timestamp -1))))))
11760 (message "Deadline on %s" org-last-inserted-timestamp))))
11762 (defun org-schedule (&optional remove time)
11763 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11764 With argument REMOVE, remove any scheduling date from the item.
11765 With argument TIME, scheduled at the corresponding date. TIME can
11767 (interactive "P")
11768 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11769 (repeater (and old-date
11770 (string-match
11772 old-date)
11773 (match-string 1 old-date))))
11774 (if remove
11775 (progn
11776 (when (and old-date org-log-reschedule)
11777 (org-add-log-setup 'delschedule nil old-date 'findpos
11778 org-log-reschedule))
11779 (org-remove-timestamp-with-keyword org-scheduled-string)
11780 (message "Item is no longer scheduled."))
11781 (org-add-planning-info 'scheduled time 'closed)
11782 (when (and old-date org-log-reschedule
11783 (not (equal old-date
11784 (substring org-last-inserted-timestamp 1 -1))))
11785 (org-add-log-setup 'reschedule nil old-date 'findpos
11786 org-log-reschedule))
11787 (when repeater
11788 (save-excursion
11789 (org-back-to-heading t)
11790 (when (re-search-forward (concat org-scheduled-string " "
11791 org-last-inserted-timestamp)
11792 (save-excursion
11793 (outline-next-heading) (point)) t)
11794 (goto-char (1- (match-end 0)))
11795 (insert " " repeater)
11796 (setq org-last-inserted-timestamp
11797 (concat (substring org-last-inserted-timestamp 0 -1)
11798 " " repeater
11799 (substring org-last-inserted-timestamp -1))))))
11800 (message "Scheduled to %s" org-last-inserted-timestamp))))
11802 (defun org-get-scheduled-time (pom &optional inherit)
11803 "Get the scheduled time as a time tuple, of a format suitable
11804 for calling org-schedule with, or if there is no scheduling,
11805 returns nil."
11806 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11807 (when time
11808 (apply 'encode-time (org-parse-time-string time)))))
11810 (defun org-get-deadline-time (pom &optional inherit)
11811 "Get the deadline as a time tuple, of a format suitable for
11812 calling org-deadline with, or if there is no scheduling, returns
11813 nil."
11814 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11815 (when time
11816 (apply 'encode-time (org-parse-time-string time)))))
11818 (defun org-remove-timestamp-with-keyword (keyword)
11819 "Remove all time stamps with KEYWORD in the current entry."
11821 beg)
11822 (save-excursion
11823 (org-back-to-heading t)
11824 (setq beg (point))
11825 (outline-next-heading)
11826 (while (re-search-backward re beg t)
11827 (replace-match "")
11829 (equal (char-before) ?\ ))
11830 (backward-delete-char 1)
11832 (point-at-bol) (point-at-eol)))
11833 (delete-region (point-at-bol)
11834 (min (point-max) (1+ (point-at-eol))))))))))
11836 (defun org-add-planning-info (what &optional time &rest remove)
11837 "Insert new timestamp with keyword in the line directly after the headline.
11838 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11839 If non is given, the user is prompted for a date.
11840 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11841 be removed."
11842 (interactive)
11843 (let (org-time-was-given org-end-time-was-given ts
11844 end default-time default-input)
11846 (catch 'exit
11847 (when (and (memq what '(scheduled deadline))
11848 (or (not time)
11849 (and (stringp time)
11850 (string-match "^[-+]+[0-9]" time))))
11851 ;; Try to get a default date/time from existing timestamp
11852 (save-excursion
11853 (org-back-to-heading t)
11854 (setq end (save-excursion (outline-next-heading) (point)))
11855 (when (re-search-forward (if (eq what 'scheduled)
11856 org-scheduled-time-regexp
11857 org-deadline-time-regexp)
11858 end t)
11859 (setq ts (match-string 1)
11860 default-time
11861 (apply 'encode-time (org-parse-time-string ts))
11862 default-input (and ts (org-get-compact-tod ts))))))
11863 (when what
11864 (setq time
11865 (if (and (stringp time)
11866 (string-match "^[-+]+[0-9]" time))
11867 ;; This is a relative time, set the proper date
11868 (apply 'encode-time
11869 (org-read-date-analyze
11870 time default-time (decode-time default-time)))
11871 ;; If necessary, get the time from the user
11872 (or time (org-read-date nil 'to-time nil nil
11873 default-time default-input)))))
11875 (when (and org-insert-labeled-timestamps-at-point
11876 (member what '(scheduled deadline)))
11877 (insert
11878 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11879 (org-insert-time-stamp time org-time-was-given
11880 nil nil nil (list org-end-time-was-given))
11881 (setq what nil))
11882 (save-excursion
11883 (save-restriction
11884 (let (col list elt ts buffer-invisibility-spec)
11885 (org-back-to-heading t)
11887 (goto-char (match-end 1))
11888 (setq col (current-column))
11889 (goto-char (match-end 0))
11891 (when (and (not what)
11892 (not (looking-at
11894 org-keyword-time-not-clock-regexp))))
11895 ;; Nothing to add, nothing to remove...... :-)
11896 (throw 'exit nil))
11897 (if (and (not (looking-at org-outline-regexp))
11900 (not (equal (match-string 1) org-clock-string)))
11901 (narrow-to-region (match-beginning 0) (match-end 0))
11903 (backward-char 1)
11904 (narrow-to-region (point) (point))
11905 (and org-adapt-indentation (org-indent-to-column col)))
11906 ;; Check if we have to remove something.
11907 (setq list (cons what remove))
11908 (while list
11909 (setq elt (pop list))
11910 (when (or (and (eq elt 'scheduled)
11911 (re-search-forward org-scheduled-time-regexp nil t))
11912 (and (eq elt 'deadline)
11913 (re-search-forward org-deadline-time-regexp nil t))
11914 (and (eq elt 'closed)
11915 (re-search-forward org-closed-time-regexp nil t)))
11916 (replace-match "")
11917 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11919 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11920 (when what
11921 (insert
11922 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11923 (cond ((eq what 'scheduled) org-scheduled-string)
11924 ((eq what 'deadline) org-deadline-string)
11925 ((eq what 'closed) org-closed-string))
11926 " ")
11927 (setq ts (org-insert-time-stamp
11928 time
11929 (or org-time-was-given
11930 (and (eq what 'closed) org-log-done-with-time))
11931 (eq what 'closed)
11932 nil nil (list org-end-time-was-given)))
11933 (insert
11934 (if (not (or (bolp) (eq (char-before) ?\ )
11935 (memq (char-after) '(32 10))
11936 (eobp))) " " ""))
11937 (end-of-line 1))
11938 (goto-char (point-min))
11939 (widen)
11942 (delete-region (1- (point)) (point-at-eol)))
11943 ts))))))
11945 (defvar org-log-note-marker (make-marker))
11946 (defvar org-log-note-purpose nil)
11947 (defvar org-log-note-state nil)
11948 (defvar org-log-note-previous-state nil)
11949 (defvar org-log-note-how nil)
11950 (defvar org-log-note-extra nil)
11951 (defvar org-log-note-window-configuration nil)
11952 (defvar org-log-note-return-to (make-marker))
11953 (defvar org-log-note-effective-time nil
11954 "Remembered current time so that dynamically scoped
11955 `org-extend-today-until' affects tha timestamps in state change
11956 log")
11958 (defvar org-log-post-message nil
11959 "Message to be displayed after a log note has been stored.
11960 The auto-repeater uses this.")
11962 (defun org-add-note ()
11963 "Add a note to the current entry.
11964 This is done in the same way as adding a state change note."
11965 (interactive)
11966 (org-add-log-setup 'note nil nil 'findpos nil))
11968 (defvar org-property-end-re)
11969 (defun org-add-log-setup (&optional purpose state prev-state
11970 findpos how extra)
11971 "Set up the post command hook to take a note.
11972 If this is about to TODO state change, the new state is expected in STATE.
11973 When FINDPOS is non-nil, find the correct position for the note in
11974 the current entry. If not, assume that it can be inserted at point.
11975 HOW is an indicator what kind of note should be created.
11976 EXTRA is additional text that will be inserted into the notes buffer."
11977 (let* ((org-log-into-drawer (org-log-into-drawer))
11978 (drawer (cond ((stringp org-log-into-drawer)
11979 org-log-into-drawer)
11980 (org-log-into-drawer "LOGBOOK")
11981 (t nil))))
11982 (save-restriction
11983 (save-excursion
11984 (when findpos
11985 (org-back-to-heading t)
11986 (narrow-to-region (point) (save-excursion
11987 (outline-next-heading) (point)))
11991 (goto-char (match-end 0))
11992 (cond
11993 (drawer
11995 nil t)
11996 (progn
11997 (goto-char (match-end 0))
11998 (or org-log-states-order-reversed
11999 (and (re-search-forward org-property-end-re nil t)
12000 (goto-char (1- (match-beginning 0))))))
12002 (beginning-of-line 0)
12003 (org-indent-line-function)
12004 (beginning-of-line 2)
12005 (org-indent-line-function)
12006 (end-of-line 0)))
12007 ((and org-log-state-notes-insert-after-drawers
12008 (save-excursion
12009 (forward-line) (looking-at org-drawer-regexp)))
12010 (forward-line)
12011 (while (looking-at org-drawer-regexp)
12012 (goto-char (match-end 0))
12013 (re-search-forward org-property-end-re (point-max) t)
12014 (forward-line))
12015 (forward-line -1)))
12016 (unless org-log-states-order-reversed
12018 (org-skip-over-state-notes)
12020 (move-marker org-log-note-marker (point))
12021 (setq org-log-note-purpose purpose
12022 org-log-note-state state
12023 org-log-note-previous-state prev-state
12024 org-log-note-how how
12025 org-log-note-extra extra
12026 org-log-note-effective-time (org-current-effective-time))
12027 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12029 (defun org-skip-over-state-notes ()
12030 "Skip past the list of State notes in an entry."
12032 (when (ignore-errors (goto-char (org-in-item-p)))
12033 (let* ((struct (org-list-struct))
12034 (prevs (org-list-prevs-alist struct)))
12036 (goto-char (or (org-list-get-next-item (point) struct prevs)
12037 (org-list-get-item-end (point) struct)))))))
12039 (defun org-add-log-note (&optional purpose)
12040 "Pop up a window for taking a note, and add this note later at point."
12041 (remove-hook 'post-command-hook 'org-add-log-note)
12042 (setq org-log-note-window-configuration (current-window-configuration))
12043 (delete-other-windows)
12044 (move-marker org-log-note-return-to (point))
12045 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12046 (goto-char org-log-note-marker)
12047 (org-switch-to-buffer-other-window "*Org Note*")
12048 (erase-buffer)
12049 (if (memq org-log-note-how '(time state))
12050 (let (current-prefix-arg) (org-store-log-note))
12051 (let ((org-inhibit-startup t)) (org-mode))
12052 (insert (format "# Insert note for %s.
12054 (cond
12055 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12056 ((eq org-log-note-purpose 'done) "closed todo item")
12057 ((eq org-log-note-purpose 'state)
12059 (or org-log-note-previous-state "")
12060 (or org-log-note-state "")))
12061 ((eq org-log-note-purpose 'reschedule)
12062 "rescheduling")
12063 ((eq org-log-note-purpose 'delschedule)
12064 "no longer scheduled")
12065 ((eq org-log-note-purpose 'redeadline)
12066 "changing deadline")
12067 ((eq org-log-note-purpose 'deldeadline)
12068 "removing deadline")
12069 ((eq org-log-note-purpose 'refile)
12070 "refiling")
12071 ((eq org-log-note-purpose 'note)
12072 "this entry")
12073 (t (error "This should not happen")))))
12074 (if org-log-note-extra (insert org-log-note-extra))
12075 (org-set-local 'org-finish-function 'org-store-log-note)))
12077 (defvar org-note-abort nil) ; dynamically scoped
12078 (defun org-store-log-note ()
12079 "Finish taking a log note, and insert it to where it belongs."
12080 (let ((txt (buffer-string))
12081 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12082 lines ind bul)
12083 (kill-buffer (current-buffer))
12085 (setq txt (replace-match "" t t txt)))
12087 (setq txt (replace-match "" t t txt)))
12090 (setq note
12091 (org-replace-escapes
12092 note
12093 (list (cons "%u" (user-login-name))
12094 (cons "%U" user-full-name)
12095 (cons "%t" (format-time-string
12096 (org-time-stamp-format 'long 'inactive)
12097 org-log-note-effective-time))
12098 (cons "%T" (format-time-string
12099 (org-time-stamp-format 'long nil)
12100 org-log-note-effective-time))
12101 (cons "%s" (if org-log-note-state
12103 ""))
12104 (cons "%S" (if org-log-note-previous-state
12108 (push note lines))
12109 (when (or current-prefix-arg org-note-abort)
12110 (when org-log-into-drawer
12111 (org-remove-empty-drawer-at
12112 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12113 org-log-note-marker))
12114 (setq lines nil))
12115 (when lines
12116 (with-current-buffer (marker-buffer org-log-note-marker)
12117 (save-excursion
12118 (goto-char org-log-note-marker)
12119 (move-marker org-log-note-marker nil)
12120 (end-of-line 1)
12122 (setq ind (save-excursion
12123 (if (ignore-errors (goto-char (org-in-item-p)))
12124 (let ((struct (org-list-struct)))
12125 (org-list-get-ind
12126 (org-list-get-top-point struct) struct))
12128 (cond
12129 ((and (org-at-heading-p)
12130 org-adapt-indentation)
12131 (1+ (org-current-level)))
12132 ((org-at-heading-p) 0)
12133 (t (org-get-indentation))))))
12134 (setq bul (org-list-bullet-string "-"))
12135 (org-indent-line-to ind)
12136 (insert bul (pop lines))
12137 (let ((ind-body (+ (length bul) ind)))
12138 (while lines
12140 (org-indent-line-to ind-body)
12141 (insert (pop lines))))
12142 (message "Note stored")
12143 (org-back-to-heading t)
12144 (org-cycle-hide-drawers 'children)))))
12145 (set-window-configuration org-log-note-window-configuration)
12146 (with-current-buffer (marker-buffer org-log-note-return-to)
12147 (goto-char org-log-note-return-to))
12148 (move-marker org-log-note-return-to nil)
12149 (and org-log-post-message (message "%s" org-log-post-message)))
12151 (defun org-remove-empty-drawer-at (drawer pos)
12152 "Remove an empty drawer DRAWER at position POS.
12153 POS may also be a marker."
12154 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12155 (save-excursion
12156 (save-restriction
12157 (widen)
12158 (goto-char pos)
12159 (if (org-in-regexp
12161 (replace-match ""))))))
12163 (defun org-sparse-tree (&optional arg)
12164 "Create a sparse tree, prompt for the details.
12165 This command can create sparse trees. You first need to select the type
12166 of match used to create the tree:
12168 t Show all TODO entries.
12169 T Show entries with a specific TODO keyword.
12170 m Show entries selected by a tags/property match.
12171 p Enter a property name and its value (both with completion on existing
12172 names/values) and show entries with that property.
12173 r Show entries matching a regular expression (`/' can be used as well)
12174 d Show deadlines due within `org-deadline-warning-days'.
12175 b Show deadlines and scheduled items before a date.
12176 a Show deadlines and scheduled items after a date."
12177 (interactive "P")
12178 (let (ans kwd value)
12179 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12180 (setq ans (read-char-exclusive))
12181 (cond
12182 ((equal ans ?d)
12183 (call-interactively 'org-check-deadlines))
12184 ((equal ans ?b)
12185 (call-interactively 'org-check-before-date))
12186 ((equal ans ?a)
12187 (call-interactively 'org-check-after-date))
12188 ((equal ans ?t)
12189 (org-show-todo-tree nil))
12190 ((equal ans ?T)
12191 (org-show-todo-tree '(4)))
12192 ((member ans '(?T ?m))
12193 (call-interactively 'org-match-sparse-tree))
12194 ((member ans '(?p ?P))
12195 (setq kwd (org-icompleting-read "Property: "
12196 (mapcar 'list (org-buffer-property-keys))))
12197 (setq value (org-icompleting-read "Value: "
12198 (mapcar 'list (org-property-values kwd))))
12201 (org-match-sparse-tree arg (concat kwd "=" value)))
12202 ((member ans '(?r ?R ?/))
12203 (call-interactively 'org-occur))
12206 (defvar org-occur-highlights nil
12207 "List of overlays used for occur matches.")
12208 (make-variable-buffer-local 'org-occur-highlights)
12209 (defvar org-occur-parameters nil
12210 "Parameters of the active org-occur calls.
12211 This is a list, each call to org-occur pushes as cons cell,
12212 containing the regular expression and the callback, onto the list.
12213 The list can contain several entries if `org-occur' has been called
12214 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12215 will only contain one set of parameters. When the highlights are
12216 removed (for example with `C-c C-c', or with the next edit (depending
12217 on `org-remove-highlights-with-change'), this variable is emptied
12218 as well.")
12219 (make-variable-buffer-local 'org-occur-parameters)
12221 (defun org-occur (regexp &optional keep-previous callback)
12222 "Make a compact tree which shows all matches of REGEXP.
12223 The tree will show the lines where the regexp matches, and all higher
12224 headlines above the match. It will also show the heading after the match,
12225 to make sure editing the matching entry is easy.
12226 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12227 call to `org-occur' will be kept, to allow stacking of calls to this
12228 command.
12229 If CALLBACK is non-nil, it is a function which is called to confirm
12230 that the match should indeed be shown."
12232 (when (equal regexp "")
12233 (error "Regexp cannot be empty"))
12234 (unless keep-previous
12235 (org-remove-occur-highlights nil nil t))
12236 (push (cons regexp callback) org-occur-parameters)
12237 (let ((cnt 0))
12238 (save-excursion
12239 (goto-char (point-min))
12240 (if (or (not keep-previous) ; do not want to keep
12241 (not org-occur-highlights)) ; no previous matches
12242 ;; hide everything
12243 (org-overview))
12244 (while (re-search-forward regexp nil t)
12245 (when (or (not callback)
12246 (save-match-data (funcall callback)))
12247 (setq cnt (1+ cnt))
12248 (when org-highlight-sparse-tree-matches
12249 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12250 (org-show-context 'occur-tree))))
12251 (when org-remove-highlights-with-change
12252 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12253 nil 'local))
12254 (unless org-sparse-tree-open-archived-trees
12255 (org-hide-archived-subtrees (point-min) (point-max)))
12256 (run-hooks 'org-occur-hook)
12257 (if (org-called-interactively-p 'interactive)
12258 (message "%d match(es) for regexp %s" cnt regexp))
12259 cnt))
12261 (defun org-occur-next-match (&optional n reset)
12262 "Function for `next-error-function' to find sparse tree matches.
12263 N is the number of matches to move, when negative move backwards.
12264 RESET is entirely ignored - this function always goes back to the
12265 starting point when no match is found."
12266 (let* ((limit (if (< n 0) (point-min) (point-max)))
12267 (search-func (if (< n 0)
12268 'previous-single-char-property-change
12269 'next-single-char-property-change))
12270 (n (abs n))
12271 (pos (point))
12272 p1)
12273 (catch 'exit
12274 (while (setq p1 (funcall search-func (point) 'org-type))
12275 (when (equal p1 limit)
12276 (goto-char pos)
12277 (error "No more matches"))
12278 (when (equal (get-char-property p1 'org-type) 'org-occur)
12279 (setq n (1- n))
12280 (when (= n 0)
12281 (goto-char p1)
12282 (throw 'exit (point))))
12283 (goto-char p1))
12284 (goto-char p1)
12285 (error "No more matches"))))
12287 (defun org-show-context (&optional key)
12288 "Make sure point and context are visible.
12289 How much context is shown depends upon the variables
12290 `org-show-hierarchy-above', `org-show-following-heading'. and
12291 `org-show-siblings'."
12292 (let ((heading-p (org-on-heading-p t))
12293 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12294 (following-p (org-get-alist-option org-show-following-heading key))
12295 (entry-p (org-get-alist-option org-show-entry-below key))
12296 (siblings-p (org-get-alist-option org-show-siblings key)))
12297 (catch 'exit
12298 ;; Show heading or entry text
12299 (if (and heading-p (not entry-p))
12300 (org-flag-heading nil) ; only show the heading
12301 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12302 (org-show-hidden-entry))) ; show entire entry
12303 (when following-p
12304 ;; Show next sibling, or heading below text
12305 (save-excursion
12306 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12307 (org-flag-heading nil))))
12308 (when siblings-p (org-show-siblings))
12309 (when hierarchy-p
12310 ;; show all higher headings, possibly with siblings
12311 (save-excursion
12312 (while (and (condition-case nil
12313 (progn (org-up-heading-all 1) t)
12314 (error nil))
12315 (not (bobp)))
12316 (org-flag-heading nil)
12317 (when siblings-p (org-show-siblings))))))))
12319 (defvar org-reveal-start-hook nil
12320 "Hook run before revealing a location.")
12322 (defun org-reveal (&optional siblings)
12323 "Show current entry, hierarchy above it, and the following headline.
12324 This can be used to show a consistent set of context around locations
12325 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12326 not t for the search context.
12328 With optional argument SIBLINGS, on each level of the hierarchy all
12329 siblings are shown. This repairs the tree structure to what it would
12330 look like when opened with hierarchical calls to `org-cycle'.
12332 go to the parent and show the
12333 entire tree."
12334 (interactive "P")
12335 (run-hooks 'org-reveal-start-hook)
12336 (let ((org-show-hierarchy-above t)
12337 (org-show-following-heading t)
12338 (org-show-siblings (if siblings t org-show-siblings)))
12339 (org-show-context nil))
12340 (when (equal siblings '(16))
12341 (save-excursion
12342 (when (org-up-heading-safe)
12343 (org-show-subtree)
12344 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12346 (defun org-highlight-new-match (beg end)
12347 "Highlight from BEG to END and mark the highlight is an occur headline."
12348 (let ((ov (make-overlay beg end)))
12349 (overlay-put ov 'face 'secondary-selection)
12350 (overlay-put ov 'org-type 'org-occur)
12351 (push ov org-occur-highlights)))
12353 (defun org-remove-occur-highlights (&optional beg end noremove)
12354 "Remove the occur highlights from the buffer.
12355 BEG and END are ignored. If NOREMOVE is nil, remove this function
12356 from the `before-change-functions' in the current buffer."
12357 (interactive)
12358 (unless org-inhibit-highlight-removal
12359 (mapc 'delete-overlay org-occur-highlights)
12360 (setq org-occur-highlights nil)
12361 (setq org-occur-parameters nil)
12362 (unless noremove
12363 (remove-hook 'before-change-functions
12364 'org-remove-occur-highlights 'local))))
12366 ;;;; Priorities
12369 "Regular expression matching the priority indicator.")
12371 (defvar org-remove-priority-next-time nil)
12373 (defun org-priority-up ()
12374 "Increase the priority of the current item."
12375 (interactive)
12376 (org-priority 'up))
12378 (defun org-priority-down ()
12379 "Decrease the priority of the current item."
12380 (interactive)
12381 (org-priority 'down))
12383 (defun org-priority (&optional action)
12384 "Change the priority of an item by ARG.
12385 ACTION can be `set', `up', `down', or a character."
12386 (interactive)
12387 (unless org-enable-priority-commands
12388 (error "Priority commands are disabled"))
12389 (setq action (or action 'set))
12390 (let (current new news have remove)
12391 (save-excursion
12392 (org-back-to-heading t)
12393 (if (looking-at org-priority-regexp)
12394 (setq current (string-to-char (match-string 2))
12395 have t))
12396 (cond
12397 ((eq action 'remove)
12398 (setq remove t new ?\ ))
12399 ((or (eq action 'set)
12400 (if (featurep 'xemacs) (characterp action) (integerp action)))
12401 (if (not (eq action 'set))
12402 (setq new action)
12403 (message "Priority %c-%c, SPC to remove: "
12404 org-highest-priority org-lowest-priority)
12405 (save-match-data
12406 (setq new (read-char-exclusive))))
12407 (if (and (= (upcase org-highest-priority) org-highest-priority)
12408 (= (upcase org-lowest-priority) org-lowest-priority))
12409 (setq new (upcase new)))
12410 (cond ((equal new ?\ ) (setq remove t))
12411 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12412 (error "Priority must be between `%c' and `%c'"
12413 org-highest-priority org-lowest-priority))))
12414 ((eq action 'up)
12415 (setq new (if have
12416 (1- current) ; normal cycling
12417 ;; last priority was empty
12418 (if (eq last-command this-command)
12419 org-lowest-priority ; wrap around empty to lowest
12420 ;; default
12421 (if org-priority-start-cycle-with-default
12422 org-default-priority
12423 (1- org-default-priority))))))
12424 ((eq action 'down)
12425 (setq new (if have
12426 (1+ current) ; normal cycling
12427 ;; last priority was empty
12428 (if (eq last-command this-command)
12429 org-highest-priority ; wrap around empty to highest
12430 ;; default
12431 (if org-priority-start-cycle-with-default
12432 org-default-priority
12433 (1+ org-default-priority))))))
12434 (t (error "Invalid action")))
12435 (if (or (< (upcase new) org-highest-priority)
12436 (> (upcase new) org-lowest-priority))
12437 (if (and (memq action '(up down))
12438 (not have) (not (eq last-command this-command)))
12439 ;; `new' is from default priority
12440 (error
12441 "The default can not be set, see `org-default-priority' why")
12442 ;; normal cycling: `new' is beyond highest/lowest priority
12443 ;; and is wrapped around to the empty priority
12444 (setq remove t)))
12445 (setq news (format "%c" new))
12446 (if have
12447 (if remove
12448 (replace-match "" t t nil 1)
12449 (replace-match news t t nil 2))
12450 (if remove
12451 (error "No priority cookie found in line")
12452 (let ((case-fold-search nil))
12453 (looking-at org-todo-line-regexp))
12454 (if (match-end 2)
12455 (progn
12456 (goto-char (match-end 2))
12457 (insert " [#" news "]"))
12458 (goto-char (match-beginning 3))
12459 (insert "[#" news "] "))))
12460 (org-preserve-lc (org-set-tags nil 'align)))
12461 (if remove
12462 (message "Priority removed")
12463 (message "Priority of current item set to %s" news))))
12465 (defun org-get-priority (s)
12466 "Find priority cookie and return priority."
12467 (if (functionp org-get-priority-function)
12468 (funcall org-get-priority-function)
12469 (save-match-data
12470 (if (not (string-match org-priority-regexp s))
12471 (* 1000 (- org-lowest-priority org-default-priority))
12472 (* 1000 (- org-lowest-priority
12473 (string-to-char (match-string 2 s))))))))
12475 ;;;; Tags
12477 (defvar org-agenda-archives-mode)
12478 (defvar org-map-continue-from nil
12479 "Position from where mapping should continue.
12480 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12482 (defvar org-scanner-tags nil
12483 "The current tag list while the tags scanner is running.")
12484 (defvar org-trust-scanner-tags nil
12485 "Should `org-get-tags-at' use the tags for the scanner.
12486 This is for internal dynamical scoping only.
12487 When this is non-nil, the function `org-get-tags-at' will return the value
12488 of `org-scanner-tags' instead of building the list by itself. This
12489 can lead to large speed-ups when the tags scanner is used in a file with
12490 many entries, and when the list of tags is retrieved, for example to
12491 obtain a list of properties. Building the tags list for each entry in such
12492 a file becomes an N^2 operation - but with this variable set, it scales
12493 as N.")
12495 (defun org-scan-tags (action matcher &optional todo-only)
12496 "Scan headline tags with inheritance and produce output ACTION.
12498 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12499 or `agenda' to produce an entry list for an agenda view. It can also be
12500 a Lisp form or a function that should be called at each matched headline, in
12501 this case the return value is a list of all return values from these calls.
12503 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12504 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12505 only lines with a TODO keyword are included in the output."
12506 (require 'org-agenda)
12509 (org-re
12511 (props (list 'face 'default
12512 'done-face 'org-agenda-done
12513 'undone-face 'default
12514 'mouse-face 'highlight
12515 'org-not-done-regexp org-not-done-regexp
12516 'org-todo-regexp org-todo-regexp
12517 'help-echo
12518 (format "mouse-2 or RET jump to org file %s"
12519 (abbreviate-file-name
12520 (or (buffer-file-name (buffer-base-buffer))
12521 (buffer-name (buffer-base-buffer)))))))
12522 (case-fold-search nil)
12523 (org-map-continue-from nil)
12524 lspos tags tags-list
12525 (tags-alist (list (cons 0 org-file-tags)))
12526 (llast 0) rtn rtn1 level category i txt
12527 todo marker entry priority)
12528 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12529 (setq action (list 'lambda nil action)))
12530 (save-excursion
12531 (goto-char (point-min))
12532 (when (eq action 'sparse-tree)
12533 (org-overview)
12534 (org-remove-occur-highlights))
12535 (while (re-search-forward re nil t)
12536 (catch :skip
12537 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12538 tags (if (match-end 4) (org-match-string-no-properties 4)))
12539 (goto-char (setq lspos (match-beginning 0)))
12540 (setq level (org-reduced-level (funcall outline-level))
12541 category (org-get-category))
12542 (setq i llast llast level)
12543 ;; remove tag lists from same and sublevels
12544 (while (>= i level)
12545 (when (setq entry (assoc i tags-alist))
12546 (setq tags-alist (delete entry tags-alist)))
12547 (setq i (1- i)))
12548 ;; add the next tags
12549 (when tags
12550 (setq tags (org-split-string tags ":")
12551 tags-alist
12552 (cons (cons level tags) tags-alist)))
12553 ;; compile tags for current headline
12554 (setq tags-list
12555 (if org-use-tag-inheritance
12556 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12557 tags)
12558 org-scanner-tags tags-list)
12559 (when org-use-tag-inheritance
12560 (setcdr (car tags-alist)
12561 (mapcar (lambda (x)
12562 (setq x (copy-sequence x))
12563 (org-add-prop-inherited x))
12564 (cdar tags-alist))))
12565 (when (and tags org-use-tag-inheritance
12566 (or (not (eq t org-use-tag-inheritance))
12567 org-tags-exclude-from-inheritance))
12568 ;; selective inheritance, remove uninherited ones
12569 (setcdr (car tags-alist)
12570 (org-remove-uninherited-tags (cdar tags-alist))))
12571 (when (and
12573 ;; eval matcher only when the todo condition is OK
12574 (and (or (not todo-only) (member todo org-not-done-keywords))
12575 (let ((case-fold-search t)) (eval matcher)))
12577 ;; Call the skipper, but return t if it does not skip,
12578 ;; so that the `and' form continues evaluating
12579 (progn
12580 (unless (eq action 'sparse-tree) (org-agenda-skip))
12581 t)
12583 ;; Check if timestamps are deselecting this entry
12584 (or (not todo-only)
12585 (and (member todo org-not-done-keywords)
12586 (or (not org-agenda-tags-todo-honor-ignore-options)
12587 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12589 ;; Extra check for the archive tag
12590 ;; FIXME: Does the skipper already do this????
12591 (or
12592 (not (member org-archive-tag tags-list))
12593 ;; we have an archive tag, should we use this anyway?
12594 (or (not org-agenda-skip-archived-trees)
12595 (and (eq action 'agenda) org-agenda-archives-mode))))
12597 ;; select this headline
12599 (cond
12600 ((eq action 'sparse-tree)
12601 (and org-highlight-sparse-tree-matches
12602 (org-get-heading) (match-end 0)
12603 (org-highlight-new-match
12604 (match-beginning 0) (match-beginning 1)))
12605 (org-show-context 'tags-tree))
12606 ((eq action 'agenda)
12607 (setq txt (org-format-agenda-item
12608 ""
12609 (concat
12610 (if (eq org-tags-match-list-sublevels 'indented)
12611 (make-string (1- level) ?.) "")
12612 (org-get-heading))
12613 category
12614 tags-list
12615 )
12616 priority (org-get-priority txt))
12617 (goto-char lspos)
12618 (setq marker (org-agenda-new-marker))
12619 (org-add-props txt props
12620 'org-marker marker 'org-hd-marker marker 'org-category category
12621 'todo-state todo
12622 'priority priority 'type "tagsmatch")
12623 (push txt rtn))
12624 ((functionp action)
12625 (setq org-map-continue-from nil)
12626 (save-excursion
12627 (setq rtn1 (funcall action))
12628 (push rtn1 rtn)))
12629 (t (error "Invalid action")))
12631 ;; if we are to skip sublevels, jump to end of subtree
12632 (unless org-tags-match-list-sublevels
12633 (org-end-of-subtree t)
12634 (backward-char 1))))
12635 ;; Get the correct position from where to continue
12636 (if org-map-continue-from
12637 (goto-char org-map-continue-from)
12638 (and (= (point) lspos) (end-of-line 1)))))
12639 (when (and (eq action 'sparse-tree)
12640 (not org-sparse-tree-open-archived-trees))
12641 (org-hide-archived-subtrees (point-min) (point-max)))
12642 (nreverse rtn)))
12644 (defun org-remove-uninherited-tags (tags)
12645 "Remove all tags that are not inherited from the list TAGS."
12646 (cond
12647 ((eq org-use-tag-inheritance t)
12648 (if org-tags-exclude-from-inheritance
12649 (org-delete-all org-tags-exclude-from-inheritance tags)
12650 tags))
12651 ((not org-use-tag-inheritance) nil)
12652 ((stringp org-use-tag-inheritance)
12653 (delq nil (mapcar
12654 (lambda (x)
12655 (if (and (string-match org-use-tag-inheritance x)
12656 (not (member x org-tags-exclude-from-inheritance)))
12657 x nil))
12658 tags)))
12659 ((listp org-use-tag-inheritance)
12660 (delq nil (mapcar
12661 (lambda (x)
12662 (if (member x org-use-tag-inheritance) x nil))
12663 tags)))))
12665 (defvar todo-only) ;; dynamically scoped
12667 (defun org-match-sparse-tree (&optional todo-only match)
12668 "Create a sparse tree according to tags string MATCH.
12669 MATCH can contain positive and negative selection of tags, like
12671 If optional argument TODO-ONLY is non-nil, only select lines that are
12672 also TODO lines."
12673 (interactive "P")
12674 (org-prepare-agenda-buffers (list (current-buffer)))
12675 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12677 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12679 (defvar org-cached-props nil)
12680 (defun org-cached-entry-get (pom property)
12681 (if (or (eq t org-use-property-inheritance)
12682 (and (stringp org-use-property-inheritance)
12683 (string-match org-use-property-inheritance property))
12684 (and (listp org-use-property-inheritance)
12685 (member property org-use-property-inheritance)))
12686 ;; Caching is not possible, check it directly
12687 (org-entry-get pom property 'inherit)
12688 ;; Get all properties, so that we can do complicated checks easily
12689 (cdr (assoc property (or org-cached-props
12690 (setq org-cached-props
12691 (org-entry-properties pom)))))))
12693 (defun org-global-tags-completion-table (&optional files)
12694 "Return the list of all tags in all agenda buffer/files.
12695 Optional FILES argument is a list of files to which can be used
12696 instead of the agenda files."
12697 (save-excursion
12698 (org-uniquify
12699 (delq nil
12700 (apply 'append
12701 (mapcar
12702 (lambda (file)
12703 (set-buffer (find-file-noselect file))
12704 (append (org-get-buffer-tags)
12705 (mapcar (lambda (x) (if (stringp (car-safe x))
12706 (list (car-safe x)) nil))
12707 org-tag-alist)))
12708 (if (and files (car files))
12709 files
12710 (org-agenda-files))))))))
12712 (defun org-make-tags-matcher (match)
12713 "Create the TAGS/TODO matcher form for the selection string MATCH."
12714 ;; todo-only is scoped dynamically into this function, and the function
12715 ;; may change it if the matcher asks for it.
12716 (unless match
12717 ;; Get a new match request, with completion
12718 (let ((org-last-tags-completion-table
12719 (org-global-tags-completion-table)))
12720 (setq match (org-completing-read-no-i
12721 "Match: " 'org-tags-completion-function nil nil nil
12722 'org-tags-history))))
12724 ;; Parse the string and create a lisp form
12725 (let ((match0 match)
12726 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12727 minus tag mm
12728 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12729 orterms term orlist re-p str-p level-p level-op time-p
12730 prop-p pn pv po gv rest)
12731 (if (string-match "/+" match)
12732 ;; match contains also a todo-matching request
12733 (progn
12734 (setq tagsmatch (substring match 0 (match-beginning 0))
12735 todomatch (substring match (match-end 0)))
12736 (if (string-match "^!" todomatch)
12737 (setq todo-only t todomatch (substring todomatch 1)))
12739 (setq todomatch nil)))
12740 ;; only matching tags
12741 (setq tagsmatch match todomatch nil))
12743 ;; Make the tags matcher
12745 (setq tagsmatcher t)
12746 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12747 (while (setq term (pop orterms))
12749 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12750 (while (string-match re term)
12751 (setq rest (substring term (match-end 0))
12752 minus (and (match-end 1)
12753 (equal (match-string 1 term) "-"))
12754 tag (save-match-data (replace-regexp-in-string
12756 (match-string 2 term)))
12757 re-p (equal (string-to-char tag) ?{)
12758 level-p (match-end 4)
12759 prop-p (match-end 5)
12760 mm (cond
12761 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12762 (level-p
12763 (setq level-op (org-op-to-function (match-string 3 term)))
12764 `(,level-op level ,(string-to-number
12765 (match-string 4 term))))
12766 (prop-p
12767 (setq pn (match-string 5 term)
12768 po (match-string 6 term)
12769 pv (match-string 7 term)
12770 re-p (equal (string-to-char pv) ?{)
12772 time-p (save-match-data
12774 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12775 (if time-p (setq pv (org-matcher-time pv)))
12776 (setq po (org-op-to-function po (if time-p 'time str-p)))
12777 (cond
12778 ((equal pn "CATEGORY")
12779 (setq gv '(get-text-property (point) 'org-category)))
12780 ((equal pn "TODO")
12781 (setq gv 'todo))
12782 (t
12783 (setq gv `(org-cached-entry-get nil ,pn))))
12784 (if re-p
12785 (if (eq po 'org<>)
12786 `(not (string-match ,pv (or ,gv "")))
12787 `(string-match ,pv (or ,gv "")))
12788 (if str-p
12789 `(,po (or ,gv "") ,pv)
12790 `(,po (string-to-number (or ,gv ""))
12791 ,(string-to-number pv) ))))
12792 (t `(member ,tag tags-list)))
12793 mm (if minus (list 'not mm) mm)
12794 term rest)
12795 (push mm tagsmatcher))
12796 (push (if (> (length tagsmatcher) 1)
12797 (cons 'and tagsmatcher)
12798 (car tagsmatcher))
12799 orlist)
12800 (setq tagsmatcher nil))
12801 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12802 (setq tagsmatcher
12803 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12804 ;; Make the todo matcher
12806 (setq todomatcher t)
12807 (setq orterms (org-split-string todomatch "|") orlist nil)
12808 (while (setq term (pop orterms))
12809 (while (string-match re term)
12810 (setq minus (and (match-end 1)
12811 (equal (match-string 1 term) "-"))
12812 kwd (match-string 2 term)
12813 re-p (equal (string-to-char kwd) ?{)
12814 term (substring term (match-end 0))
12815 mm (if re-p
12816 `(string-match ,(substring kwd 1 -1) todo)
12817 (list 'equal 'todo kwd))
12818 mm (if minus (list 'not mm) mm))
12819 (push mm todomatcher))
12820 (push (if (> (length todomatcher) 1)
12821 (cons 'and todomatcher)
12822 (car todomatcher))
12823 orlist)
12824 (setq todomatcher nil))
12825 (setq todomatcher (if (> (length orlist) 1)
12826 (cons 'or orlist) (car orlist))))
12828 ;; Return the string and lisp forms of the matcher
12829 (setq matcher (if todomatcher
12830 (list 'and tagsmatcher todomatcher)
12831 tagsmatcher))
12832 (cons match0 matcher)))
12834 (defun org-op-to-function (op &optional stringp)
12835 "Turn an operator into the appropriate function."
12836 (setq op
12837 (cond
12838 ((equal op "<" ) '(< string< org-time<))
12839 ((equal op ">" ) '(> org-string> org-time>))
12840 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12841 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12842 ((member op '("=" "==")) '(= string= org-time=))
12843 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12844 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12846 (defun org<> (a b) (not (= a b)))
12847 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12848 (defun org-string>= (a b) (not (string< a b)))
12849 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12850 (defun org-string<> (a b) (not (string= a b)))
12851 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12852 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12853 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12854 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12855 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12856 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12857 (defun org-2ft (s)
12858 "Convert S to a floating point time.
12859 If S is already a number, just return it. If it is a string, parse
12860 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12861 (cond
12862 ((numberp s) s)
12863 ((stringp s)
12864 (condition-case nil
12865 (float-time (apply 'encode-time (org-parse-time-string s)))
12866 (error 0.)))
12867 (t 0.)))
12869 (defun org-time-today ()
12870 "Time in seconds today at 0:00.
12871 Returns the float number of seconds since the beginning of the
12872 epoch to the beginning of today (00:00)."
12873 (float-time (apply 'encode-time
12874 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12876 (defun org-matcher-time (s)
12877 "Interpret a time comparison value."
12878 (save-match-data
12879 (cond
12880 ((string= s "<now>") (float-time))
12881 ((string= s "<today>") (org-time-today))
12882 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12883 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12885 (+ (org-time-today)
12886 (* (string-to-number (match-string 1 s))
12887 (cdr (assoc (match-string 2 s)
12888 '(("d" . 86400.0) ("w" . 604800.0)
12889 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12890 (t (org-2ft s)))))
12892 (defun org-match-any-p (re list)
12893 "Does re match any element of list?"
12894 (setq list (mapcar (lambda (x) (string-match re x)) list))
12895 (delq nil list))
12897 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12898 (defvar org-tags-overlay (make-overlay 1 1))
12899 (org-detach-overlay org-tags-overlay)
12901 (defun org-get-local-tags-at (&optional pos)
12902 "Get a list of tags defined in the current headline."
12903 (org-get-tags-at pos 'local))
12905 (defun org-get-local-tags ()
12906 "Get a list of tags defined in the current headline."
12907 (org-get-tags-at nil 'local))
12909 (defun org-get-tags-at (&optional pos local)
12910 "Get a list of all headline tags applicable at POS.
12911 POS defaults to point. If tags are inherited, the list contains
12912 the targets in the same sequence as the headlines appear, i.e.
12913 the tags of the current headline come last.
12914 When LOCAL is non-nil, only return tags from the current headline,
12915 ignore inherited ones."
12916 (interactive)
12917 (if (and org-trust-scanner-tags
12918 (or (not pos) (equal pos (point)))
12919 (not local))
12920 org-scanner-tags
12921 (let (tags ltags lastpos parent)
12922 (save-excursion
12923 (save-restriction
12924 (widen)
12925 (goto-char (or pos (point)))
12926 (save-match-data
12927 (catch 'done
12928 (condition-case nil
12929 (progn
12930 (org-back-to-heading t)
12931 (while (not (equal lastpos (point)))
12932 (setq lastpos (point))
12933 (when (looking-at
12935 (setq ltags (org-split-string
12936 (org-match-string-no-properties 1) ":"))
12937 (when parent
12938 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12939 (setq tags (append
12940 (if parent
12941 (org-remove-uninherited-tags ltags)
12942 ltags)
12943 tags)))
12944 (or org-use-tag-inheritance (throw 'done t))
12945 (if local (throw 'done t))
12946 (or (org-up-heading-safe) (error nil))
12947 (setq parent t)))
12948 (error nil)))))
12949 (if local
12950 tags
12951 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12953 (defun org-add-prop-inherited (s)
12954 (add-text-properties 0 (length s) '(inherited t) s)
12955 s)
12957 (defun org-toggle-tag (tag &optional onoff)
12958 "Toggle the tag TAG for the current line.
12959 If ONOFF is `on' or `off', don't toggle but set to this state."
12960 (let (res current)
12961 (save-excursion
12962 (org-back-to-heading t)
12964 (point-at-eol) t)
12965 (progn
12966 (setq current (match-string 1))
12967 (replace-match ""))
12968 (setq current ""))
12969 (setq current (nreverse (org-split-string current ":")))
12970 (cond
12971 ((eq onoff 'on)
12972 (setq res t)
12973 (or (member tag current) (push tag current)))
12974 ((eq onoff 'off)
12975 (or (not (member tag current)) (setq current (delete tag current))))
12976 (t (if (member tag current)
12977 (setq current (delete tag current))
12978 (setq res t)
12979 (push tag current))))
12980 (end-of-line 1)
12981 (if current
12982 (progn
12983 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12984 (org-set-tags nil t))
12985 (delete-horizontal-space))
12986 (run-hooks 'org-after-tags-change-hook))
12987 res))
12989 (defun org-align-tags-here (to-col)
12990 ;; Assumes that this is a headline
12991 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12992 (beginning-of-line 1)
12994 (< pos (match-beginning 2)))
12995 (progn
12996 (setq tags-l (- (match-end 2) (match-beginning 2)))
12997 (goto-char (match-beginning 1))
12998 (insert " ")
12999 (delete-region (point) (1+ (match-beginning 2)))
13000 (setq ncol (max (1+ (current-column))
13001 (1+ col)
13002 (if (> to-col 0)
13003 to-col
13004 (- (abs to-col) tags-l))))
13005 (setq p (point))
13006 (insert (make-string (- ncol (current-column)) ?\ ))
13007 (setq ncol (current-column))
13008 (when indent-tabs-mode (tabify p (point-at-eol)))
13009 (org-move-to-column (min ncol col) t))
13010 (goto-char pos))))
13012 (defun org-set-tags-command (&optional arg just-align)
13013 "Call the set-tags command for the current entry."
13014 (interactive "P")
13015 (if (org-on-heading-p)
13016 (org-set-tags arg just-align)
13017 (save-excursion
13018 (org-back-to-heading t)
13019 (org-set-tags arg just-align))))
13021 (defun org-set-tags-to (data)
13022 "Set the tags of the current entry to DATA, replacing the current tags.
13023 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13024 If DATA is nil or the empty string, any tags will be removed."
13025 (interactive "sTags: ")
13026 (setq data
13027 (cond
13028 ((eq data nil) "")
13029 ((equal data "") "")
13030 ((stringp data)
13031 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13032 ":"))
13033 ((listp data)
13034 (concat ":" (mapconcat 'identity data ":") ":"))
13035 (t nil)))
13036 (when data
13037 (save-excursion
13038 (org-back-to-heading t)
13039 (when (looking-at org-complex-heading-regexp)
13040 (if (match-end 5)
13041 (progn
13042 (goto-char (match-beginning 5))
13043 (insert data)
13044 (delete-region (point) (point-at-eol))
13045 (org-set-tags nil 'align))
13046 (goto-char (point-at-eol))
13047 (insert " " data)
13048 (org-set-tags nil 'align)))
13049 (beginning-of-line 1)
13051 (delete-region (match-beginning 1) (match-end 1))))))
13053 (defun org-align-all-tags ()
13054 "Align the tags i all headings."
13055 (interactive)
13056 (save-excursion
13057 (or (ignore-errors (org-back-to-heading t))
13058 (outline-next-heading))
13059 (if (org-on-heading-p)
13060 (org-set-tags t)
13061 (message "No headings"))))
13063 (defvar org-indent-indentation-per-level)
13064 (defun org-set-tags (&optional arg just-align)
13065 "Set the tags for the current headline.
13066 With prefix ARG, realign all tags in headings in the current buffer."
13067 (interactive "P")
13068 (let* ((re org-outline-regexp-bol)
13069 (current (org-get-tags-string))
13070 (col (current-column))
13071 (org-setting-tags t)
13072 table current-tags inherited-tags ; computed below when needed
13073 tags p0 c0 c1 rpl di tc level)
13074 (if arg
13075 (save-excursion
13076 (goto-char (point-min))
13077 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13078 (while (re-search-forward re nil t)
13079 (org-set-tags nil t)
13080 (end-of-line 1)))
13081 (message "All tags realigned to column %d" org-tags-column))
13082 (if just-align
13083 (setq tags current)
13084 ;; Get a new set of tags from the user
13085 (save-excursion
13086 (setq table (append org-tag-persistent-alist
13087 (or org-tag-alist (org-get-buffer-tags))
13088 (and
13089 org-complete-tags-always-offer-all-agenda-tags
13090 (org-global-tags-completion-table
13091 (org-agenda-files))))
13092 org-last-tags-completion-table table
13093 current-tags (org-split-string current ":")
13094 inherited-tags (nreverse
13095 (nthcdr (length current-tags)
13096 (nreverse (org-get-tags-at))))
13097 tags
13098 (if (or (eq t org-use-fast-tag-selection)
13099 (and org-use-fast-tag-selection
13100 (delq nil (mapcar 'cdr table))))
13101 (org-fast-tag-selection
13102 current-tags inherited-tags table
13103 (if org-fast-tag-selection-include-todo
13104 org-todo-key-alist))
13105 (let ((org-add-colon-after-tag-completion t))
13106 (org-trim
13107 (org-icompleting-read "Tags: "
13108 'org-tags-completion-function
13109 nil nil current 'org-tags-history))))))
13110 (while (string-match "[-+&]+" tags)
13111 ;; No boolean logic, just a list
13112 (setq tags (replace-match ":" t t tags))))
13114 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13116 (if org-tags-sort-function
13117 (setq tags (mapconcat 'identity
13118 (sort (org-split-string
13119 tags (org-re "[^[:alnum:]_@#%]+"))
13120 org-tags-sort-function) ":")))
13123 (setq tags "")
13124 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13125 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13127 ;; Insert new tags at the correct column
13128 (beginning-of-line 1)
13129 (setq level (or (and (looking-at org-outline-regexp)
13130 (- (match-end 0) (point) 1))
13131 1))
13132 (cond
13133 ((and (equal current "") (equal tags "")))
13134 ((re-search-forward
13136 (point-at-eol) t)
13137 (if (equal tags "")
13138 (setq rpl "")
13139 (goto-char (match-beginning 0))
13140 (setq c0 (current-column)
13141 ;; compute offset for the case of org-indent-mode active
13142 di (if org-indent-mode
13143 (* (1- org-indent-indentation-per-level) (1- level))
13144 0)
13145 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13146 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13147 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13148 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13149 (replace-match rpl t t)
13150 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13151 tags)
13152 (t (error "Tags alignment failed")))
13153 (org-move-to-column col)
13154 (unless just-align
13155 (run-hooks 'org-after-tags-change-hook)))))
13157 (defun org-change-tag-in-region (beg end tag off)
13158 "Add or remove TAG for each entry in the region.
13159 This works in the agenda, and also in an org-mode buffer."
13160 (interactive
13161 (list (region-beginning) (region-end)
13162 (let ((org-last-tags-completion-table
13163 (if (org-mode-p)
13164 (org-get-buffer-tags)
13165 (org-global-tags-completion-table))))
13166 (org-icompleting-read
13167 "Tag: " 'org-tags-completion-function nil nil nil
13168 'org-tags-history))
13169 (progn
13171 (equal (read-char-exclusive) ?r))))
13172 (if (fboundp 'deactivate-mark) (deactivate-mark))
13173 (let ((agendap (equal major-mode 'org-agenda-mode))
13174 l1 l2 m buf pos newhead (cnt 0))
13175 (goto-char end)
13176 (setq l2 (1- (org-current-line)))
13177 (goto-char beg)
13178 (setq l1 (org-current-line))
13179 (loop for l from l1 to l2 do
13180 (org-goto-line l)
13181 (setq m (get-text-property (point) 'org-hd-marker))
13182 (when (or (and (org-mode-p) (org-on-heading-p))
13183 (and agendap m))
13184 (setq buf (if agendap (marker-buffer m) (current-buffer))
13185 pos (if agendap m (point)))
13186 (with-current-buffer buf
13187 (save-excursion
13188 (save-restriction
13189 (goto-char pos)
13190 (setq cnt (1+ cnt))
13191 (org-toggle-tag tag (if off 'off 'on))
13192 (setq newhead (org-get-heading)))))
13193 (and agendap (org-agenda-change-all-lines newhead m))))
13194 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13196 (defun org-tags-completion-function (string predicate &optional flag)
13197 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13198 (confirm (lambda (x) (stringp (car x)))))
13200 (setq s1 (match-string 1 string)
13201 s2 (match-string 2 string))
13202 (setq s1 "" s2 string))
13203 (cond
13204 ((eq flag nil)
13205 ;; try completion
13206 (setq rtn (try-completion s2 ctable confirm))
13207 (if (stringp rtn)
13208 (setq rtn
13209 (concat s1 s2 (substring rtn (length s2))
13210 (if (and org-add-colon-after-tag-completion
13211 (assoc rtn ctable))
13212 ":" ""))))
13213 rtn)
13214 ((eq flag t)
13215 ;; all-completions
13216 (all-completions s2 ctable confirm)
13217 )
13218 ((eq flag 'lambda)
13219 ;; exact match?
13220 (assoc s2 ctable)))
13221 ))
13223 (defun org-fast-tag-insert (kwd tags face &optional end)
13224 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13225 (insert (format "%-12s" (concat kwd ":"))
13226 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13227 (or end "")))
13229 (defun org-fast-tag-show-exit (flag)
13230 (save-excursion
13231 (org-goto-line 3)
13233 (replace-match ""))
13234 (when flag
13235 (end-of-line 1)
13236 (org-move-to-column (- (window-width) 19) t)
13237 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13239 (defun org-set-current-tags-overlay (current prefix)
13240 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13241 (if (featurep 'xemacs)
13242 (org-overlay-display org-tags-overlay (concat prefix s)
13243 'secondary-selection)
13244 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13245 (org-overlay-display org-tags-overlay (concat prefix s)))))
13247 (defvar org-last-tag-selection-key nil)
13248 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13249 "Fast tag selection with single keys.
13250 CURRENT is the current list of tags in the headline, INHERITED is the
13251 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13252 possibly with grouping information. TODO-TABLE is a similar table with
13253 TODO keywords, should these have keys assigned to them.
13254 If the keys are nil, a-z are automatically assigned.
13255 Returns the new tags string, or nil to not change the current settings."
13256 (let* ((fulltable (append table todo-table))
13257 (maxlen (apply 'max (mapcar
13258 (lambda (x)
13259 (if (stringp (car x)) (string-width (car x)) 0))
13260 fulltable)))
13261 (buf (current-buffer))
13262 (expert (eq org-fast-tag-selection-single-key 'expert))
13263 (buffer-tags nil)
13264 (fwidth (+ maxlen 3 1 3))
13265 (ncol (/ (- (window-width) 4) fwidth))
13266 (i-face 'org-done)
13267 (c-face 'org-todo)
13268 tg cnt e c char c1 c2 ntable tbl rtn
13269 ov-start ov-end ov-prefix
13270 (exit-after-next org-fast-tag-selection-single-key)
13271 (done-keywords org-done-keywords)
13272 groups ingroup)
13273 (save-excursion
13274 (beginning-of-line 1)
13275 (if (looking-at
13277 (setq ov-start (match-beginning 1)
13278 ov-end (match-end 1)
13279 ov-prefix "")
13280 (setq ov-start (1- (point-at-eol))
13281 ov-end (1+ ov-start))
13283 (setq ov-prefix
13284 (concat
13285 (buffer-substring (1- (point)) (point))
13286 (if (> (current-column) org-tags-column)
13287 " "
13288 (make-string (- org-tags-column (current-column)) ?\ ))))))
13289 (move-overlay org-tags-overlay ov-start ov-end)
13290 (save-window-excursion
13291 (if expert
13292 (set-buffer (get-buffer-create " *Org tags*"))
13293 (delete-other-windows)
13294 (split-window-vertically)
13295 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13296 (erase-buffer)
13297 (org-set-local 'org-done-keywords done-keywords)
13300 (org-fast-tag-show-exit exit-after-next)
13301 (org-set-current-tags-overlay current ov-prefix)
13302 (setq tbl fulltable char ?a cnt 0)
13303 (while (setq e (pop tbl))
13304 (cond
13305 ((equal (car e) :startgroup)
13306 (push '() groups) (setq ingroup t)
13307 (when (not (= cnt 0))
13308 (setq cnt 0)
13310 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13311 ((equal (car e) :endgroup)
13312 (setq ingroup nil cnt 0)
13314 ((equal e '(:newline))
13315 (when (not (= cnt 0))
13316 (setq cnt 0)
13318 (setq e (car tbl))
13319 (while (equal (car tbl) '(:newline))
13321 (setq tbl (cdr tbl)))))
13322 (t
13323 (setq tg (copy-sequence (car e)) c2 nil)
13324 (if (cdr e)
13325 (setq c (cdr e))
13326 ;; automatically assign a character.
13327 (setq c1 (string-to-char
13328 (downcase (substring
13329 tg (if (= (string-to-char tg) ?@) 1 0)))))
13330 (if (or (rassoc c1 ntable) (rassoc c1 table))
13331 (while (or (rassoc char ntable) (rassoc char table))
13332 (setq char (1+ char)))
13333 (setq c2 c1))
13334 (setq c (or c2 char)))
13335 (if ingroup (push tg (car groups)))
13336 (setq tg (org-add-props tg nil 'face
13337 (cond
13338 ((not (assoc tg table))
13339 (org-get-todo-face tg))
13340 ((member tg current) c-face)
13341 ((member tg inherited) i-face)
13342 (t nil))))
13343 (if (and (= cnt 0) (not ingroup)) (insert " "))
13344 (insert "[" c "] " tg (make-string
13345 (- fwidth 4 (length tg)) ?\ ))
13346 (push (cons tg c) ntable)
13347 (when (= (setq cnt (1+ cnt)) ncol)
13349 (if ingroup (insert " "))
13350 (setq cnt 0)))))
13351 (setq ntable (nreverse ntable))
13353 (goto-char (point-min))
13354 (if (not expert) (org-fit-window-to-buffer))
13355 (setq rtn
13356 (catch 'exit
13357 (while t
13358 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13359 (if (not groups) "no " "")
13360 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13361 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13362 (setq org-last-tag-selection-key c)
13363 (cond
13365 ((= c ?!)
13366 (setq groups (not groups))
13367 (goto-char (point-min))
13368 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13369 ((= c ?\C-c)
13370 (if (not expert)
13371 (org-fast-tag-show-exit
13372 (setq exit-after-next (not exit-after-next)))
13373 (setq expert nil)
13374 (delete-other-windows)
13375 (set-window-buffer (split-window-vertically) " *Org tags*")
13376 (org-switch-to-buffer-other-window " *Org tags*")
13377 (org-fit-window-to-buffer)))
13378 ((or (= c ?\C-g)
13379 (and (= c ?q) (not (rassoc c ntable))))
13380 (org-detach-overlay org-tags-overlay)
13381 (setq quit-flag t))
13382 ((= c ?\ )
13383 (setq current nil)
13384 (if exit-after-next (setq exit-after-next 'now)))
13386 (condition-case nil
13387 (setq tg (org-icompleting-read
13388 "Tag: "
13389 (or buffer-tags
13390 (with-current-buffer buf
13391 (org-get-buffer-tags)))))
13392 (quit (setq tg "")))
13394 (add-to-list 'buffer-tags (list tg))
13395 (if (member tg current)
13396 (setq current (delete tg current))
13397 (push tg current)))
13398 (if exit-after-next (setq exit-after-next 'now)))
13399 ((setq e (rassoc c todo-table) tg (car e))
13400 (with-current-buffer buf
13401 (save-excursion (org-todo tg)))
13402 (if exit-after-next (setq exit-after-next 'now)))
13403 ((setq e (rassoc c ntable) tg (car e))
13404 (if (member tg current)
13405 (setq current (delete tg current))
13406 (loop for g in groups do
13407 (if (member tg g)
13408 (mapc (lambda (x)
13409 (setq current (delete x current)))
13410 g)))
13411 (push tg current))
13412 (if exit-after-next (setq exit-after-next 'now))))
13414 ;; Create a sorted list
13415 (setq current
13416 (sort current
13417 (lambda (a b)
13418 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13419 (if (eq exit-after-next 'now) (throw 'exit t))
13420 (goto-char (point-min))
13421 (beginning-of-line 2)
13422 (delete-region (point) (point-at-eol))
13423 (org-fast-tag-insert "Current" current c-face)
13424 (org-set-current-tags-overlay current ov-prefix)
13425 (while (re-search-forward
13427 (setq tg (match-string 1))
13428 (add-text-properties
13429 (match-beginning 1) (match-end 1)
13430 (list 'face
13431 (cond
13432 ((member tg current) c-face)
13433 ((member tg inherited) i-face)
13434 (t (get-text-property (match-beginning 1) 'face))))))
13435 (goto-char (point-min)))))
13436 (org-detach-overlay org-tags-overlay)
13437 (if rtn
13438 (mapconcat 'identity current ":")
13439 nil))))
13441 (defun org-get-tags-string ()
13442 "Get the TAGS string in the current headline."
13443 (unless (org-on-heading-p t)
13444 (error "Not on a heading"))
13445 (save-excursion
13446 (beginning-of-line 1)
13448 (org-match-string-no-properties 1)
13449 "")))
13451 (defun org-get-tags ()
13452 "Get the list of tags specified in the current headline."
13453 (org-split-string (org-get-tags-string) ":"))
13455 (defun org-get-buffer-tags ()
13456 "Get a table of all tags used in the buffer, for completion."
13457 (let (tags)
13458 (save-excursion
13459 (goto-char (point-min))
13460 (while (re-search-forward
13462 (when (equal (char-after (point-at-bol 0)) ?*)
13463 (mapc (lambda (x) (add-to-list 'tags x))
13464 (org-split-string (org-match-string-no-properties 1) ":")))))
13465 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13466 (mapcar 'list tags)))
13468 ;;;; The mapping API
13470 ;;;###autoload
13471 (defun org-map-entries (func &optional match scope &rest skip)
13472 "Call FUNC at each headline selected by MATCH in SCOPE.
13474 FUNC is a function or a lisp form. The function will be called without
13475 arguments, with the cursor positioned at the beginning of the headline.
13476 The return values of all calls to the function will be collected and
13477 returned as a list.
13479 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13480 does not need to preserve point. After evaluation, the cursor will be
13481 moved to the end of the line (presumably of the headline of the
13482 processed entry) and search continues from there. Under some
13483 circumstances, this may not produce the wanted results. For example,
13484 if you have removed (e.g. archived) the current (sub)tree it could
13485 mean that the next entry will be skipped entirely. In such cases, you
13486 can specify the position from where search should continue by making
13487 FUNC set the variable `org-map-continue-from' to the desired buffer
13488 position.
13490 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13491 Only headlines that are matched by this query will be considered during
13492 the iteration. When MATCH is nil or t, all headlines will be
13493 visited by the iteration.
13495 SCOPE determines the scope of this command. It can be any of:
13497 nil The current buffer, respecting the restriction if any
13498 tree The subtree started with the entry at point
13499 region The entries within the active region, if any
13500 file The current buffer, without restriction
13501 file-with-archives
13502 The current buffer, and any archives associated with it
13503 agenda All agenda files
13504 agenda-with-archives
13505 All agenda files with any archive files associated with them
13506 \(file1 file2 ...)
13507 If this is a list, all files in the list will be scanned
13509 The remaining args are treated as settings for the skipping facilities of
13510 the scanner. The following items can be given here:
13512 archive skip trees with the archive tag.
13513 comment skip trees with the COMMENT keyword
13514 function or Emacs Lisp form:
13515 will be used as value for `org-agenda-skip-function', so whenever
13516 the function returns t, FUNC will not be called for that
13517 entry and search will continue from the point where the
13518 function leaves it.
13520 If your function needs to retrieve the tags including inherited tags
13521 at the *current* entry, you can use the value of the variable
13522 `org-scanner-tags' which will be much faster than getting the value
13523 with `org-get-tags-at'. If your function gets properties with
13524 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13525 to t around the call to `org-entry-properties' to get the same speedup.
13526 Note that if your function moves around to retrieve tags and properties at
13527 a *different* entry, you cannot use these techniques."
13528 (let* ((org-agenda-archives-mode nil) ; just to make sure
13529 (org-agenda-skip-archived-trees (memq 'archive skip))
13530 (org-agenda-skip-comment-trees (memq 'comment skip))
13531 (org-agenda-skip-function
13532 (car (org-delete-all '(comment archive) skip)))
13533 (org-tags-match-list-sublevels t)
13534 matcher file res
13535 org-todo-keywords-for-agenda
13536 org-done-keywords-for-agenda
13537 org-todo-keyword-alist-for-agenda
13538 org-drawers-for-agenda
13539 org-tag-alist-for-agenda)
13541 (cond
13542 ((eq match t) (setq matcher t))
13543 ((eq match nil) (setq matcher t))
13544 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13546 (save-excursion
13547 (save-restriction
13548 (cond ((eq scope 'tree)
13549 (org-back-to-heading t)
13550 (org-narrow-to-subtree)
13551 (setq scope nil))
13552 ((and (eq scope 'region) (org-region-active-p))
13553 (narrow-to-region (region-beginning) (region-end))
13554 (setq scope nil)))
13556 (if (not scope)
13557 (progn
13558 (org-prepare-agenda-buffers
13559 (list (buffer-file-name (current-buffer))))
13560 (setq res (org-scan-tags func matcher)))
13561 ;; Get the right scope
13562 (cond
13563 ((and scope (listp scope) (symbolp (car scope)))
13564 (setq scope (eval scope)))
13565 ((eq scope 'agenda)
13566 (setq scope (org-agenda-files t)))
13567 ((eq scope 'agenda-with-archives)
13568 (setq scope (org-agenda-files t))
13569 (setq scope (org-add-archive-files scope)))
13570 ((eq scope 'file)
13571 (setq scope (list (buffer-file-name))))
13572 ((eq scope 'file-with-archives)
13573 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13574 (org-prepare-agenda-buffers scope)
13575 (while (setq file (pop scope))
13576 (with-current-buffer (org-find-base-buffer-visiting file)
13577 (save-excursion
13578 (save-restriction
13579 (widen)
13580 (goto-char (point-min))
13581 (setq res (append res (org-scan-tags func matcher))))))))))
13582 res))
13584 ;;;; Properties
13586 ;;; Setting and retrieving properties
13588 (defconst org-special-properties
13589 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13590 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13591 "The special properties valid in Org-mode.
13593 These are properties that are not defined in the property drawer,
13594 but in some other way.")
13596 (defconst org-default-properties
13597 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13598 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13599 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13600 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13601 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13602 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13603 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13604 "Some properties that are used by Org-mode for various purposes.
13605 Being in this list makes sure that they are offered for completion.")
13608 "Regular expression matching the first line of a property drawer.")
13611 "Regular expression matching the last line of a property drawer.")
13614 "Regular expression matching the first line of a property drawer.")
13617 "Regular expression matching the first line of a property drawer.")
13619 (defconst org-property-drawer-re
13622 "Matches an entire property drawer.")
13624 (defconst org-clock-drawer-re
13627 "Matches an entire clock drawer.")
13629 (defsubst org-re-property (property)
13630 "Return a regexp matching PROPERTY.
13631 Match group 1 will be set to the value "
13634 (defun org-property-action ()
13635 "Do an action on properties."
13636 (interactive)
13637 (let (c)
13638 (org-at-property-p)
13639 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13640 (setq c (read-char-exclusive))
13641 (cond
13642 ((equal c ?s)
13643 (call-interactively 'org-set-property))
13644 ((equal c ?d)
13645 (call-interactively 'org-delete-property))
13646 ((equal c ?D)
13647 (call-interactively 'org-delete-property-globally))
13648 ((equal c ?c)
13649 (call-interactively 'org-compute-property-at-point))
13650 (t (error "No such property action %c" c)))))
13652 (defun org-set-effort (&optional value)
13653 "Set the effort property of the current entry.
13654 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13655 allowed value."
13656 (interactive "P")
13657 (if (equal value 0) (setq value 10))
13658 (let* ((completion-ignore-case t)
13659 (prop org-effort-property)
13660 (cur (org-entry-get nil prop))
13661 (allowed (org-property-get-allowed-values nil prop 'table))
13662 (existing (mapcar 'list (org-property-values prop)))
13663 rpl
13664 (val (cond
13665 ((stringp value) value)
13666 ((and allowed (integerp value))
13667 (or (car (nth (1- value) allowed))
13668 (car (org-last allowed))))
13669 (allowed
13670 (message "Select 1-9,0, [RET%s]: %s"
13671 (if cur (concat "=" cur) "")
13672 (mapconcat 'car allowed " "))
13673 (setq rpl (read-char-exclusive))
13675 cur
13676 (setq rpl (- rpl ?0))
13677 (if (equal rpl 0) (setq rpl 10))
13678 (if (and (> rpl 0) (<= rpl (length allowed)))
13679 (car (nth (1- rpl) allowed))
13680 (org-completing-read "Effort: " allowed nil))))
13681 (t
13682 (let (org-completion-use-ido org-completion-use-iswitchb)
13683 (org-completing-read
13685 (concat "[" cur "]") "")
13686 ": ")
13687 existing nil nil "" nil cur))))))
13688 (unless (equal (org-entry-get nil prop) val)
13689 (org-entry-put nil prop val))
13690 (message "%s is now %s" prop val)))
13692 (defun org-at-property-p ()
13693 "Is cursor inside a property drawer?"
13694 (save-excursion
13695 (beginning-of-line 1)
13697 (save-match-data ;; Used by calling procedures
13698 (let ((p (point))
13699 (range (unless (org-before-first-heading-p)
13700 (org-get-property-block))))
13701 (and range (<= (car range) p) (< p (cdr range))))))))
13703 (defun org-get-property-block (&optional beg end force)
13704 "Return the (beg . end) range of the body of the property drawer.
13705 BEG and END can be beginning and end of subtree, if not given
13706 they will be found.
13707 If the drawer does not exist and FORCE is non-nil, create the drawer."
13708 (catch 'exit
13709 (save-excursion
13710 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13711 (end (or end (progn (outline-next-heading) (point)))))
13712 (goto-char beg)
13713 (if (re-search-forward org-property-start-re end t)
13714 (setq beg (1+ (match-end 0)))
13715 (if force
13716 (save-excursion
13717 (org-insert-property-drawer)
13718 (setq end (progn (outline-next-heading) (point))))
13719 (throw 'exit nil))
13720 (goto-char beg)
13721 (if (re-search-forward org-property-start-re end t)
13722 (setq beg (1+ (match-end 0)))))
13723 (if (re-search-forward org-property-end-re end t)
13724 (setq end (match-beginning 0))
13725 (or force (throw 'exit nil))
13726 (goto-char beg)
13727 (setq end beg)
13728 (org-indent-line-function)
13730 (cons beg end)))))
13732 (defun org-entry-properties (&optional pom which specific)
13733 "Get all properties of the entry at point-or-marker POM.
13734 This includes the TODO keyword, the tags, time strings for deadline,
13735 scheduled, and clocking, and any additional properties defined in the
13736 entry. The return value is an alist, keys may occur multiple times
13737 if the property key was used several times.
13738 POM may also be nil, in which case the current entry is used.
13739 If WHICH is nil or `all', get all properties. If WHICH is
13740 `special' or `standard', only get that subclass. If WHICH
13741 is a string only get exactly this property. SPECIFIC can be a string, the
13742 specific property we are interested in. Specifying it can speed
13743 things up because then unnecessary parsing is avoided."
13744 (setq which (or which 'all))
13745 (org-with-point-at pom
13746 (let ((clockstr (substring org-clock-string 0 -1))
13747 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13748 (case-fold-search nil)
13749 beg end range props sum-props key key1 value string clocksum)
13750 (save-excursion
13751 (when (condition-case nil
13752 (and (org-mode-p) (org-back-to-heading t))
13753 (error nil))
13754 (setq beg (point))
13755 (setq sum-props (get-text-property (point) 'org-summaries))
13756 (setq clocksum (get-text-property (point) :org-clock-minutes))
13757 (outline-next-heading)
13758 (setq end (point))
13759 (when (memq which '(all special))
13760 ;; Get the special properties, like TODO and tags
13761 (goto-char beg)
13762 (when (and (or (not specific) (string= specific "TODO"))
13763 (looking-at org-todo-line-regexp) (match-end 2))
13764 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13765 (when (and (or (not specific) (string= specific "PRIORITY"))
13766 (looking-at org-priority-regexp))
13767 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13768 (when (or (not specific) (string= specific "FILE"))
13769 (push (cons "FILE" buffer-file-name) props))
13770 (when (and (or (not specific) (string= specific "TAGS"))
13771 (setq value (org-get-tags-string))
13773 (push (cons "TAGS" value) props))
13774 (when (and (or (not specific) (string= specific "ALLTAGS"))
13775 (setq value (org-get-tags-at)))
13776 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13777 ":"))
13778 props))
13779 (when (or (not specific) (string= specific "BLOCKED"))
13780 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13781 (when (or (not specific)
13782 (member specific
13783 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13784 "TIMESTAMP" "TIMESTAMP_IA")))
13785 (catch 'match
13786 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13787 (setq key (if (match-end 1)
13788 (substring (org-match-string-no-properties 1)
13789 0 -1))
13790 string (if (equal key clockstr)
13791 (org-no-properties
13792 (org-trim
13793 (buffer-substring
13794 (match-beginning 3) (goto-char
13795 (point-at-eol)))))
13796 (substring (org-match-string-no-properties 3)
13797 1 -1)))
13798 ;; Get the correct property name from the key. This is
13799 ;; necessary if the user has configured time keywords.
13800 (setq key1 (concat key ":"))
13801 (cond
13802 ((not key)
13803 (setq key
13804 (if (= (char-after (match-beginning 3)) ?\[)
13805 "TIMESTAMP_IA" "TIMESTAMP")))
13806 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13807 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13808 ((equal key1 org-closed-string) (setq key "CLOSED"))
13809 ((equal key1 org-clock-string) (setq key "CLOCK")))
13810 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13811 (progn
13812 (push (cons key string) props)
13813 ;; no need to search further if match is found
13814 (throw 'match t))
13815 (when (or (equal key "CLOCK") (not (assoc key props)))
13816 (push (cons key string) props))))))
13817 )
13819 (when (memq which '(all standard))
13820 ;; Get the standard properties, like :PROP: ...
13821 (setq range (org-get-property-block beg end))
13822 (when range
13823 (goto-char (car range))
13824 (while (re-search-forward
13826 (cdr range) t)
13827 (setq key (org-match-string-no-properties 1)
13828 value (org-trim (or (org-match-string-no-properties 2) "")))
13829 (unless (member key excluded)
13830 (push (cons key (or value "")) props)))))
13831 (if clocksum
13832 (push (cons "CLOCKSUM"
13833 (org-columns-number-to-string (/ (float clocksum) 60.)
13834 'add_times))
13835 props))
13836 (unless (assoc "CATEGORY" props)
13837 (push (cons "CATEGORY" (org-get-category)) props))
13838 (append sum-props (nreverse props)))))))
13840 (defun org-entry-get (pom property &optional inherit literal-nil)
13841 "Get value of PROPERTY for entry at point-or-marker POM.
13842 If INHERIT is non-nil and the entry does not have the property,
13843 then also check higher levels of the hierarchy.
13844 If INHERIT is the symbol `selective', use inheritance only if the setting
13845 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13846 If the property is present but empty, the return value is the empty string.
13847 If the property is not present at all, nil is returned.
13850 do not interpret it as the list atom nil. This is used for inheritance
13852 (org-with-point-at pom
13853 (if (and inherit (if (eq inherit 'selective)
13854 (org-property-inherit-p property)
13855 t))
13856 (org-entry-get-with-inheritance property literal-nil)
13857 (if (member property org-special-properties)
13858 ;; We need a special property. Use `org-entry-properties' to
13859 ;; retrieve it, but specify the wanted property
13860 (cdr (assoc property (org-entry-properties nil 'special property)))
13861 (let ((range (unless (org-before-first-heading-p)
13862 (org-get-property-block))))
13863 (if (and range
13864 (goto-char (car range))
13865 (re-search-forward
13866 (org-re-property property)
13867 (cdr range) t))
13868 ;; Found the property, return it.
13869 (if (match-end 1)
13870 (if literal-nil
13871 (org-match-string-no-properties 1)
13872 (org-not-nil (org-match-string-no-properties 1)))
13873 "")))))))
13875 (defun org-property-or-variable-value (var &optional inherit)
13876 "Check if there is a property fixing the value of VAR.
13877 If yes, return this value. If not, return the current value of the variable."
13878 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13880 (read prop)
13881 (symbol-value var))))
13883 (defun org-entry-delete (pom property)
13884 "Delete the property PROPERTY from entry at point-or-marker POM."
13885 (org-with-point-at pom
13886 (if (member property org-special-properties)
13887 nil ; cannot delete these properties.
13888 (let ((range (org-get-property-block)))
13889 (if (and range
13890 (goto-char (car range))
13891 (re-search-forward
13892 (org-re-property property)
13893 (cdr range) t))
13894 (progn
13895 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13896 t)
13897 nil)))))
13899 ;; Multi-values properties are properties that contain multiple values
13900 ;; These values are assumed to be single words, separated by whitespace.
13901 (defun org-entry-add-to-multivalued-property (pom property value)
13902 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13903 (let* ((old (org-entry-get pom property))
13905 (setq value (org-entry-protect-space value))
13906 (unless (member value values)
13907 (setq values (cons value values))
13908 (org-entry-put pom property
13909 (mapconcat 'identity values " ")))))
13911 (defun org-entry-remove-from-multivalued-property (pom property value)
13912 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13913 (let* ((old (org-entry-get pom property))
13915 (setq value (org-entry-protect-space value))
13916 (when (member value values)
13917 (setq values (delete value values))
13918 (org-entry-put pom property
13919 (mapconcat 'identity values " ")))))
13921 (defun org-entry-member-in-multivalued-property (pom property value)
13922 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13923 (let* ((old (org-entry-get pom property))
13925 (setq value (org-entry-protect-space value))
13926 (member value values)))
13928 (defun org-entry-get-multivalued-property (pom property)
13929 "Return a list of values in a multivalued property."
13930 (let* ((value (org-entry-get pom property))
13932 (mapcar 'org-entry-restore-space values)))
13934 (defun org-entry-put-multivalued-property (pom property &rest values)
13935 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13936 VALUES should be a list of strings. Spaces will be protected."
13937 (org-entry-put pom property
13938 (mapconcat 'org-entry-protect-space values " "))
13939 (let* ((value (org-entry-get pom property))
13941 (mapcar 'org-entry-restore-space values)))
13943 (defun org-entry-protect-space (s)
13944 "Protect spaces and newline in string S."
13945 (while (string-match " " s)
13946 (setq s (replace-match "%20" t t s)))
13948 (setq s (replace-match "%0A" t t s)))
13949 s)
13951 (defun org-entry-restore-space (s)
13952 "Restore spaces and newline in string S."
13953 (while (string-match "%20" s)
13954 (setq s (replace-match " " t t s)))
13955 (while (string-match "%0A" s)
13957 s)
13959 (defvar org-entry-property-inherited-from (make-marker)
13960 "Marker pointing to the entry from where a property was inherited.
13961 Each call to `org-entry-get-with-inheritance' will set this marker to the
13962 location of the entry where the inheritance search matched. If there was
13963 no match, the marker will point nowhere.
13964 Note that also `org-entry-get' calls this function, if the INHERIT flag
13965 is set.")
13967 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13968 "Get entry property, and search higher levels if not present.
13969 The search will stop at the first ancestor which has the property defined.
13971 should be considered as undefined (this is the meaning of nil here).
13973 (move-marker org-entry-property-inherited-from nil)
13974 (let (tmp)
13975 (unless (org-before-first-heading-p)
13976 (save-excursion
13977 (save-restriction
13978 (widen)
13979 (catch 'ex
13980 (while t
13981 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13982 (org-back-to-heading t)
13983 (move-marker org-entry-property-inherited-from (point))
13984 (throw 'ex tmp))
13985 (or (org-up-heading-safe) (throw 'ex nil)))))))
13986 (setq tmp (or tmp
13987 (cdr (assoc property org-file-properties))
13988 (cdr (assoc property org-global-properties))
13989 (cdr (assoc property org-global-properties-fixed))))
13990 (if literal-nil tmp (org-not-nil tmp))))
13992 (defvar org-property-changed-functions nil
13993 "Hook called when the value of a property has changed.
13994 Each hook function should accept two arguments, the name of the property
13995 and the new value.")
13997 (defun org-entry-put (pom property value)
13998 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13999 (org-with-point-at pom
14000 (org-back-to-heading t)
14001 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14002 range)
14003 (cond
14004 ((equal property "TODO")
14006 (not (member value org-todo-keywords-1)))
14008 (if (or (not value)
14010 (setq value 'none))
14011 (org-todo value)
14012 (org-set-tags nil 'align))
14013 ((equal property "PRIORITY")
14015 (string-to-char value) ?\ ))
14016 (org-set-tags nil 'align))
14017 ((equal property "SCHEDULED")
14018 (if (re-search-forward org-scheduled-time-regexp end t)
14019 (cond
14020 ((eq value 'earlier) (org-timestamp-change -1 'day))
14021 ((eq value 'later) (org-timestamp-change 1 'day))
14022 (t (call-interactively 'org-schedule)))
14023 (call-interactively 'org-schedule)))
14024 ((equal property "DEADLINE")
14025 (if (re-search-forward org-deadline-time-regexp end t)
14026 (cond
14027 ((eq value 'earlier) (org-timestamp-change -1 'day))
14028 ((eq value 'later) (org-timestamp-change 1 'day))
14029 (t (call-interactively 'org-deadline)))
14030 (call-interactively 'org-deadline)))
14031 ((member property org-special-properties)
14032 (error "The %s property can not yet be set with `org-entry-put'"
14033 property))
14034 (t ; a non-special property
14035 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14036 (setq range (org-get-property-block beg end 'force))
14037 (goto-char (car range))
14038 (if (re-search-forward
14039 (org-re-property property) (cdr range) t)
14040 (progn
14041 (delete-region (match-beginning 0) (match-end 0))
14042 (goto-char (match-beginning 0)))
14043 (goto-char (cdr range))
14045 (backward-char 1)
14046 (org-indent-line-function))
14047 (insert ":" property ":")
14048 (and value (insert " " value))
14049 (org-indent-line-function)))))
14050 (run-hook-with-args 'org-property-changed-functions property value)))
14052 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14053 "Get all property keys in the current buffer.
14054 With INCLUDE-SPECIALS, also list the special properties that reflect things
14055 like tags and TODO state.
14056 With INCLUDE-DEFAULTS, also include properties that has special meaning
14057 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14058 and others.
14059 With INCLUDE-COLUMNS, also include property names given in COLUMN
14060 formats in the current buffer."
14061 (let (rtn range cfmt s p)
14062 (save-excursion
14063 (save-restriction
14064 (widen)
14065 (goto-char (point-min))
14066 (while (re-search-forward org-property-start-re nil t)
14067 (setq range (org-get-property-block))
14068 (goto-char (car range))
14069 (while (re-search-forward
14071 (cdr range) t)
14072 (add-to-list 'rtn (org-match-string-no-properties 1)))
14073 (outline-next-heading))))
14075 (when include-specials
14076 (setq rtn (append org-special-properties rtn)))
14078 (when include-defaults
14079 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14080 (add-to-list 'rtn org-effort-property))
14082 (when include-columns
14083 (save-excursion
14084 (save-restriction
14085 (widen)
14086 (goto-char (point-min))
14087 (while (re-search-forward
14089 nil t)
14090 (setq cfmt (match-string 2) s 0)
14092 cfmt s)
14093 (setq s (match-end 0)
14094 p (match-string 1 cfmt))
14095 (unless (or (equal p "ITEM")
14096 (member p org-special-properties))
14097 (add-to-list 'rtn (match-string 1 cfmt))))))))
14099 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14101 (defun org-property-values (key)
14102 "Return a list of all values of property KEY in the current buffer."
14103 (save-excursion
14104 (save-restriction
14105 (widen)
14106 (goto-char (point-min))
14107 (let ((re (org-re-property key))
14108 values)
14109 (while (re-search-forward re nil t)
14110 (add-to-list 'values (org-trim (match-string 1))))
14111 (delete "" values)))))
14113 (defun org-insert-property-drawer ()
14114 "Insert a property drawer into the current entry."
14115 (interactive)
14116 (org-back-to-heading t)
14117 (looking-at org-outline-regexp)
14118 (let ((indent (if org-adapt-indentation
14119 (- (match-end 0)(match-beginning 0))
14120 0))
14121 (beg (point))
14123 end hiddenp)
14124 (outline-next-heading)
14125 (setq end (point))
14126 (goto-char beg)
14127 (while (re-search-forward re end t))
14128 (setq hiddenp (outline-invisible-p))
14129 (end-of-line 1)
14132 (if (member (match-string 1) '("CLOCK:" ":END:"))
14133 ;; just skip this line
14134 (beginning-of-line 2)
14135 ;; Drawer start, find the end
14137 (beginning-of-line 1)))
14138 (org-skip-over-state-notes)
14140 (if (eq (char-before) ?*) (forward-char 1))
14142 (beginning-of-line 0)
14143 (org-indent-to-column indent)
14144 (beginning-of-line 2)
14145 (org-indent-to-column indent)
14146 (beginning-of-line 0)
14147 (if hiddenp
14148 (save-excursion
14149 (org-back-to-heading t)
14150 (hide-entry))
14151 (org-flag-drawer t))))
14153 (defvar org-property-set-functions-alist nil
14154 "Property set function alist.
14155 Each entry should have the following format:
14157 (PROPERTY . READ-FUNCTION)
14159 The read function will be called with the same argument as
14160 `org-completing-read'.")
14162 (defun org-set-property-function (property)
14163 "Get the function that should be used to set PROPERTY.
14164 This is computed according to `org-property-set-functions-alist'."
14165 (or (cdr (assoc property org-property-set-functions-alist))
14166 'org-completing-read))
14168 (defun org-read-property-value (property)
14169 "Read PROPERTY value from user."
14170 (let* ((completion-ignore-case t)
14171 (allowed (org-property-get-allowed-values nil property 'table))
14172 (cur (org-entry-get nil property))
14173 (prompt (concat property " value"
14175 (concat " [" cur "]") "") ": "))
14176 (set-function (org-set-property-function property))
14177 (val (if allowed
14178 (funcall set-function prompt allowed nil
14179 (not (get-text-property 0 'org-unrestricted
14180 (caar allowed))))
14181 (let (org-completion-use-ido org-completion-use-iswitchb)
14182 (funcall set-function prompt
14183 (mapcar 'list (org-property-values property))
14184 nil nil "" nil cur)))))
14185 (if (equal val "")
14186 cur
14187 val)))
14189 (defvar org-last-set-property nil)
14190 (defun org-read-property-name ()
14191 "Read a property name."
14192 (let* ((completion-ignore-case t)
14193 (keys (org-buffer-property-keys nil t t))
14194 (default-prop (or (save-excursion
14195 (save-match-data
14196 (beginning-of-line)
14198 (null (string= (match-string 1) "END"))
14199 (match-string 1))))
14200 org-last-set-property))
14201 (property (org-icompleting-read
14202 (concat "Property"
14203 (if default-prop (concat " [" default-prop "]") "")
14204 ": ")
14205 (mapcar 'list keys)
14206 nil nil nil nil
14207 default-prop
14208 )))
14209 (if (member property keys)
14210 property
14211 (or (cdr (assoc (downcase property)
14212 (mapcar (lambda (x) (cons (downcase x) x))
14213 keys)))
14214 property))))
14216 (defun org-set-property (property value)
14217 "In the current entry, set PROPERTY to VALUE.
14218 When called interactively, this will prompt for a property name, offering
14219 completion on existing and default properties. And then it will prompt
14220 for a value, offering completion either on allowed values (via an inherited
14221 xxx_ALL property) or on existing values in other instances of this property
14222 in the current file."
14223 (interactive (list nil nil))
14224 (let* ((property (or property (org-read-property-name)))
14225 (value (or value (org-read-property-value property))))
14226 (setq org-last-set-property property)
14227 (unless (equal (org-entry-get nil property) value)
14228 (org-entry-put nil property value))))
14230 (defun org-delete-property (property)
14231 "In the current entry, delete PROPERTY."
14232 (interactive
14233 (let* ((completion-ignore-case t)
14234 (prop (org-icompleting-read "Property: "
14235 (org-entry-properties nil 'standard))))
14236 (list prop)))
14237 (message "Property %s %s" property
14238 (if (org-entry-delete nil property)
14239 "deleted"
14240 "was not present in the entry")))
14242 (defun org-delete-property-globally (property)
14243 "Remove PROPERTY globally, from all entries."
14244 (interactive
14245 (let* ((completion-ignore-case t)
14246 (prop (org-icompleting-read
14247 "Globally remove property: "
14248 (mapcar 'list (org-buffer-property-keys)))))
14249 (list prop)))
14250 (save-excursion
14251 (save-restriction
14252 (widen)
14253 (goto-char (point-min))
14254 (let ((cnt 0))
14255 (while (re-search-forward
14256 (org-re-property property)
14257 nil t)
14258 (setq cnt (1+ cnt))
14259 (replace-match ""))
14262 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14264 (defun org-compute-property-at-point ()
14265 "Compute the property at point.
14266 This looks for an enclosing column format, extracts the operator and
14267 then applies it to the property in the column format's scope."
14268 (interactive)
14269 (unless (org-at-property-p)
14270 (error "Not at a property"))
14271 (let ((prop (org-match-string-no-properties 2)))
14272 (org-columns-get-format-and-top-level)
14273 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14274 (error "No operator defined for property %s" prop))
14275 (org-columns-compute prop)))
14277 (defvar org-property-allowed-value-functions nil
14278 "Hook for functions supplying allowed values for a specific property.
14279 The functions must take a single argument, the name of the property, and
14281 the values, this means that these values are intended as defaults for
14282 completion, but that other values should be allowed too.
14283 The functions must return nil if they are not responsible for this
14284 property.")
14286 (defun org-property-get-allowed-values (pom property &optional table)
14287 "Get allowed values for the property PROPERTY.
14288 When TABLE is non-nil, return an alist that can directly be used for
14289 completion."
14290 (let (vals)
14291 (cond
14292 ((equal property "TODO")
14293 (setq vals (org-with-point-at pom
14294 (append org-todo-keywords-1 '("")))))
14295 ((equal property "PRIORITY")
14296 (let ((n org-lowest-priority))
14297 (while (>= n org-highest-priority)
14298 (push (char-to-string n) vals)
14299 (setq n (1- n)))))
14300 ((member property org-special-properties))
14301 ((setq vals (run-hook-with-args-until-success
14302 'org-property-allowed-value-functions property)))
14303 (t
14304 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14306 (setq vals (car (read-from-string (concat "(" vals ")"))))
14307 (setq vals (mapcar (lambda (x)
14308 (cond ((stringp x) x)
14309 ((numberp x) (number-to-string x))
14310 ((symbolp x) (symbol-name x))
14311 (t "???")))
14312 vals)))))
14313 (when (member ":ETC" vals)
14314 (setq vals (remove ":ETC" vals))
14315 (org-add-props (car vals) '(org-unrestricted t)))
14316 (if table (mapcar 'list vals) vals)))
14318 (defun org-property-previous-allowed-value (&optional previous)
14319 "Switch to the next allowed value for this property."
14320 (interactive)
14321 (org-property-next-allowed-value t))
14323 (defun org-property-next-allowed-value (&optional previous)
14324 "Switch to the next allowed value for this property."
14325 (interactive)
14326 (unless (org-at-property-p)
14327 (error "Not at a property"))
14328 (let* ((key (match-string 2))
14329 (value (match-string 3))
14330 (allowed (or (org-property-get-allowed-values (point) key)
14331 (and (member value '("[ ]" "[-]" "[X]"))
14332 '("[ ]" "[X]"))))
14333 nval)
14334 (unless allowed
14335 (error "Allowed values for this property have not been defined"))
14336 (if previous (setq allowed (reverse allowed)))
14337 (if (member value allowed)
14338 (setq nval (car (cdr (member value allowed)))))
14339 (setq nval (or nval (car allowed)))
14340 (if (equal nval value)
14341 (error "Only one allowed value for this property"))
14342 (org-at-property-p)
14343 (replace-match (concat " :" key ": " nval) t t)
14344 (org-indent-line-function)
14345 (beginning-of-line 1)
14347 (run-hook-with-args 'org-property-changed-functions key nval)))
14349 (defun org-find-olp (path &optional this-buffer)
14350 "Return a marker pointing to the entry at outline path OLP.
14351 If anything goes wrong, throw an error.
14352 You can wrap this call to catch the error like this:
14354 (condition-case msg
14355 (org-mobile-locate-entry (match-string 4))
14356 (error (nth 1 msg)))
14358 The return value will then be either a string with the error message,
14359 or a marker if everything is OK.
14361 If THIS-BUFFER is set, the outline path does not contain a file,
14362 only headings."
14363 (let* ((file (if this-buffer buffer-file-name (pop path)))
14364 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14365 (level 1)
14366 (lmin 1)
14367 (lmax 1)
14368 limit re end found pos heading cnt flevel)
14369 (unless buffer (error "File not found :%s" file))
14370 (with-current-buffer buffer
14371 (save-excursion
14372 (save-restriction
14373 (widen)
14374 (setq limit (point-max))
14375 (goto-char (point-min))
14376 (while (setq heading (pop path))
14377 (setq re (format org-complex-heading-regexp-format
14378 (regexp-quote heading)))
14379 (setq cnt 0 pos (point))
14380 (while (re-search-forward re end t)
14381 (setq level (- (match-end 1) (match-beginning 1)))
14382 (if (and (>= level lmin) (<= level lmax))
14383 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14384 (when (= cnt 0) (error "Heading not found on level %d: %s"
14385 lmax heading))
14386 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14387 lmax heading))
14388 (goto-char found)
14389 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14390 (setq end (save-excursion (org-end-of-subtree t t))))
14391 (when (org-on-heading-p)
14392 (move-marker (make-marker) (point))))))))
14394 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14395 "Find node HEADING in BUFFER.
14396 Return a marker to the heading if it was found, or nil if not.
14397 If POS-ONLY is set, return just the position instead of a marker.
14399 The heading text must match exact, but it may have a TODO keyword,
14400 a priority cookie and tags in the standard locations."
14401 (with-current-buffer (or buffer (current-buffer))
14402 (save-excursion
14403 (save-restriction
14404 (widen)
14405 (goto-char (point-min))
14406 (let (case-fold-search)
14407 (if (re-search-forward
14408 (format org-complex-heading-regexp-format
14409 (regexp-quote heading)) nil t)
14410 (if pos-only
14411 (match-beginning 0)
14412 (move-marker (make-marker) (match-beginning 0)))))))))
14414 (defun org-find-exact-heading-in-directory (heading &optional dir)
14415 "Find Org node headline HEADING in all .org files in directory DIR.
14416 When the target headline is found, return a marker to this location."
14417 (let ((files (directory-files (or dir default-directory)
14419 file visiting m buffer)
14420 (catch 'found
14421 (while (setq file (pop files))
14422 (message "trying %s" file)
14423 (setq visiting (org-find-base-buffer-visiting file))
14424 (setq buffer (or visiting (find-file-noselect file)))
14425 (setq m (org-find-exact-headline-in-buffer
14426 heading buffer))
14427 (when (and (not m) (not visiting)) (kill-buffer buffer))
14428 (and m (throw 'found m))))))
14430 (defun org-find-entry-with-id (ident)
14431 "Locate the entry that contains the ID property with exact value IDENT.
14432 IDENT can be a string, a symbol or a number, this function will search for
14433 the string representation of it.
14434 Return the position where this entry starts, or nil if there is no such entry."
14435 (interactive "sID: ")
14436 (let ((id (cond
14437 ((stringp ident) ident)
14438 ((symbol-name ident) (symbol-name ident))
14439 ((numberp ident) (number-to-string ident))
14440 (t (error "IDENT %s must be a string, symbol or number" ident))))
14441 (case-fold-search nil))
14442 (save-excursion
14443 (save-restriction
14444 (widen)
14445 (goto-char (point-min))
14446 (when (re-search-forward
14448 nil t)
14449 (org-back-to-heading t)
14450 (point))))))
14452 ;;;; Timestamps
14454 (defvar org-last-changed-timestamp nil)
14455 (defvar org-last-inserted-timestamp nil
14456 "The last time stamp inserted with `org-insert-time-stamp'.")
14457 (defvar org-time-was-given) ; dynamically scoped parameter
14458 (defvar org-end-time-was-given) ; dynamically scoped parameter
14459 (defvar org-ts-what) ; dynamically scoped parameter
14461 (defun org-time-stamp (arg &optional inactive)
14462 "Prompt for a date/time and insert a time stamp.
14463 If the user specifies a time like HH:MM, or if this command is called
14464 with a prefix argument, the time stamp will contain date and time.
14465 Otherwise, only the date will be included. All parts of a date not
14466 specified by the user will be filled in from the current date/time.
14467 So if you press just return without typing anything, the time stamp
14468 will represent the current date/time. If there is already a timestamp
14469 at the cursor, it will be modified."
14470 (interactive "P")
14471 (let* ((ts nil)
14472 (default-time
14473 ;; Default time is either today, or, when entering a range,
14474 ;; the range start.
14475 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14476 (save-excursion
14477 (re-search-backward
14479 (- (point) 20) t)))
14480 (apply 'encode-time (org-parse-time-string (match-string 1)))
14481 (current-time)))
14482 (default-input (and ts (org-get-compact-tod ts)))
14483 (repeater (save-excursion
14484 (save-match-data
14485 (beginning-of-line)
14486 (when (re-search-forward
14488 (save-excursion (progn (end-of-line) (point))) t)
14489 (match-string 0)))))
14490 org-time-was-given org-end-time-was-given time)
14491 (cond
14492 ((and (org-at-timestamp-p t)
14493 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14494 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14495 (insert "--")
14496 (setq time (let ((this-command this-command))
14497 (org-read-date arg 'totime nil nil
14498 default-time default-input)))
14499 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14500 ((org-at-timestamp-p t)
14501 (setq time (let ((this-command this-command))
14502 (org-read-date arg 'totime nil nil default-time default-input)))
14503 (when (org-at-timestamp-p t) ; just to get the match data
14504 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14505 (replace-match "")
14506 (setq org-last-changed-timestamp
14507 (org-insert-time-stamp
14508 time (or org-time-was-given arg)
14509 inactive nil nil (list org-end-time-was-given)))
14510 (when repeater (goto-char (1- (point))) (insert " " repeater)
14511 (setq org-last-changed-timestamp
14512 (concat (substring org-last-inserted-timestamp 0 -1)
14513 " " repeater ">"))))
14514 (message "Timestamp updated"))
14515 (t
14516 (setq time (let ((this-command this-command))
14517 (org-read-date arg 'totime nil nil default-time default-input)))
14518 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14519 nil nil (list org-end-time-was-given))))))
14521 ;; FIXME: can we use this for something else, like computing time differences?
14522 (defun org-get-compact-tod (s)
14523 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14524 (let* ((t1 (match-string 1 s))
14525 (h1 (string-to-number (match-string 2 s)))
14526 (m1 (string-to-number (match-string 3 s)))
14527 (t2 (and (match-end 4) (match-string 5 s)))
14528 (h2 (and t2 (string-to-number (match-string 6 s))))
14529 (m2 (and t2 (string-to-number (match-string 7 s))))
14530 dh dm)
14531 (if (not t2)
14532 t1
14533 (setq dh (- h2 h1) dm (- m2 m1))
14534 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14535 (concat t1 "+" (number-to-string dh)
14536 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14538 (defun org-time-stamp-inactive (&optional arg)
14539 "Insert an inactive time stamp.
14540 An inactive time stamp is enclosed in square brackets instead of angle
14541 brackets. It is inactive in the sense that it does not trigger agenda entries,
14542 does not link to the calendar and cannot be changed with the S-cursor keys.
14543 So these are more for recording a certain time/date."
14544 (interactive "P")
14545 (org-time-stamp arg 'inactive))
14547 (defvar org-date-ovl (make-overlay 1 1))
14548 (overlay-put org-date-ovl 'face 'org-warning)
14549 (org-detach-overlay org-date-ovl)
14551 (defvar org-ans1) ; dynamically scoped parameter
14552 (defvar org-ans2) ; dynamically scoped parameter
14554 (defvar org-plain-time-of-day-regexp) ; defined below
14556 (defvar org-overriding-default-time nil) ; dynamically scoped
14557 (defvar org-read-date-overlay nil)
14558 (defvar org-dcst nil) ; dynamically scoped
14559 (defvar org-read-date-history nil)
14560 (defvar org-read-date-final-answer nil)
14561 (defvar org-read-date-analyze-futurep nil)
14562 (defvar org-read-date-analyze-forced-year nil)
14564 (defun org-read-date (&optional with-time to-time from-string prompt
14565 default-time default-input)
14566 "Read a date, possibly a time, and make things smooth for the user.
14567 The prompt will suggest to enter an ISO date, but you can also enter anything
14568 which will at least partially be understood by `parse-time-string'.
14569 Unrecognized parts of the date will default to the current day, month, year,
14570 hour and minute. If this command is called to replace a timestamp at point,
14571 of to enter the second timestamp of a range, the default time is taken
14572 from the existing stamp. Furthermore, the command prefers the future,
14573 so if you are giving a date where the year is not given, and the day-month
14574 combination is already past in the current year, it will assume you
14575 mean next year. For details, see the manual. A few examples:
14577 3-2-5 --> 2003-02-05
14578 feb 15 --> currentyear-02-15
14579 2/15 --> currentyear-02-15
14580 sep 12 9 --> 2009-09-12
14581 12:45 --> today 12:45
14582 22 sept 0:34 --> currentyear-09-22 0:34
14583 12 --> currentyear-currentmonth-12
14584 Fri --> nearest Friday (today or later)
14585 etc.
14587 Furthermore you can specify a relative date by giving, as the *first* thing
14588 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14589 change in days weeks, months, years.
14590 With a single plus or minus, the date is relative to today. With a double
14591 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14592 +4d --> four days from today
14593 +4 --> same as above
14594 +2w --> two weeks from today
14595 ++5 --> five days from default date
14597 The function understands only English month and weekday abbreviations,
14598 but this can be configured with the variables `parse-time-months' and
14599 `parse-time-weekdays'.
14601 While prompting, a calendar is popped up - you can also select the
14602 date with the mouse (button 1). The calendar shows a period of three
14603 months. To scroll it to other months, use the keys `>' and `<'.
14604 If you don't like the calendar, turn it off with
14605 \(setq org-read-date-popup-calendar nil)
14607 With optional argument TO-TIME, the date will immediately be converted
14608 to an internal time.
14609 With an optional argument WITH-TIME, the prompt will suggest to also
14610 insert a time. Note that when WITH-TIME is not set, you can still
14611 enter a time, and this function will inform the calling routine about
14612 this change. The calling routine may then choose to change the format
14613 used to insert the time stamp into the buffer to include the time.
14614 With optional argument FROM-STRING, read from this string instead from
14615 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14616 the time/date that is used for everything that is not specified by the
14617 user."
14618 (require 'parse-time)
14619 (let* ((org-time-stamp-rounding-minutes
14620 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14621 (org-dcst org-display-custom-times)
14622 (ct (org-current-time))
14623 (def (or org-overriding-default-time default-time ct))
14624 (defdecode (decode-time def))
14625 (dummy (progn
14626 (when (< (nth 2 defdecode) org-extend-today-until)
14627 (setcar (nthcdr 2 defdecode) -1)
14628 (setcar (nthcdr 1 defdecode) 59)
14629 (setq def (apply 'encode-time defdecode)
14630 defdecode (decode-time def)))))
14631 (calendar-frame-setup nil)
14632 (calendar-setup nil)
14633 (calendar-move-hook nil)
14634 (calendar-view-diary-initially-flag nil)
14635 (calendar-view-holidays-initially-flag nil)
14636 (timestr (format-time-string
14637 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14638 (prompt (concat (if prompt (concat prompt " ") "")
14639 (format "Date+time [%s]: " timestr)))
14640 ans (org-ans0 "") org-ans1 org-ans2 final)
14642 (cond
14643 (from-string (setq ans from-string))
14644 (org-read-date-popup-calendar
14645 (save-excursion
14646 (save-window-excursion
14647 (calendar)
14648 (unwind-protect
14649 (progn
14650 (calendar-forward-day (- (time-to-days def)
14651 (calendar-absolute-from-gregorian
14652 (calendar-current-date))))
14653 (org-eval-in-calendar nil t)
14654 (let* ((old-map (current-local-map))
14655 (map (copy-keymap calendar-mode-map))
14656 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14657 (org-defkey map (kbd "RET") 'org-calendar-select)
14658 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14659 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14660 (org-defkey minibuffer-local-map [(meta shift left)]
14661 (lambda () (interactive)
14662 (org-eval-in-calendar '(calendar-backward-month 1))))
14663 (org-defkey minibuffer-local-map [(meta shift right)]
14664 (lambda () (interactive)
14665 (org-eval-in-calendar '(calendar-forward-month 1))))
14666 (org-defkey minibuffer-local-map [(meta shift up)]
14667 (lambda () (interactive)
14668 (org-eval-in-calendar '(calendar-backward-year 1))))
14669 (org-defkey minibuffer-local-map [(meta shift down)]
14670 (lambda () (interactive)
14671 (org-eval-in-calendar '(calendar-forward-year 1))))
14672 (org-defkey minibuffer-local-map [?\e (shift left)]
14673 (lambda () (interactive)
14674 (org-eval-in-calendar '(calendar-backward-month 1))))
14675 (org-defkey minibuffer-local-map [?\e (shift right)]
14676 (lambda () (interactive)
14677 (org-eval-in-calendar '(calendar-forward-month 1))))
14678 (org-defkey minibuffer-local-map [?\e (shift up)]
14679 (lambda () (interactive)
14680 (org-eval-in-calendar '(calendar-backward-year 1))))
14681 (org-defkey minibuffer-local-map [?\e (shift down)]
14682 (lambda () (interactive)
14683 (org-eval-in-calendar '(calendar-forward-year 1))))
14684 (org-defkey minibuffer-local-map [(shift up)]
14685 (lambda () (interactive)
14686 (org-eval-in-calendar '(calendar-backward-week 1))))
14687 (org-defkey minibuffer-local-map [(shift down)]
14688 (lambda () (interactive)
14689 (org-eval-in-calendar '(calendar-forward-week 1))))
14690 (org-defkey minibuffer-local-map [(shift left)]
14691 (lambda () (interactive)
14692 (org-eval-in-calendar '(calendar-backward-day 1))))
14693 (org-defkey minibuffer-local-map [(shift right)]
14694 (lambda () (interactive)
14695 (org-eval-in-calendar '(calendar-forward-day 1))))
14696 (org-defkey minibuffer-local-map ">"
14697 (lambda () (interactive)
14698 (org-eval-in-calendar '(scroll-calendar-left 1))))
14699 (org-defkey minibuffer-local-map "<"
14700 (lambda () (interactive)
14701 (org-eval-in-calendar '(scroll-calendar-right 1))))
14702 (org-defkey minibuffer-local-map "\C-v"
14703 (lambda () (interactive)
14704 (org-eval-in-calendar
14705 '(calendar-scroll-left-three-months 1))))
14706 (org-defkey minibuffer-local-map "\M-v"
14707 (lambda () (interactive)
14708 (org-eval-in-calendar
14709 '(calendar-scroll-right-three-months 1))))
14710 (run-hooks 'org-read-date-minibuffer-setup-hook)
14711 (unwind-protect
14712 (progn
14713 (use-local-map map)
14714 (add-hook 'post-command-hook 'org-read-date-display)
14715 (setq org-ans0 (read-string prompt default-input
14716 'org-read-date-history nil))
14717 ;; org-ans0: from prompt
14718 ;; org-ans1: from mouse click
14719 ;; org-ans2: from calendar motion
14720 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14721 (remove-hook 'post-command-hook 'org-read-date-display)
14722 (use-local-map old-map)
14723 (when org-read-date-overlay
14724 (delete-overlay org-read-date-overlay)
14725 (setq org-read-date-overlay nil)))))
14726 (bury-buffer "*Calendar*")))))
14728 (t ; Naked prompt only
14729 (unwind-protect
14730 (setq ans (read-string prompt default-input
14731 'org-read-date-history timestr))
14732 (when org-read-date-overlay
14733 (delete-overlay org-read-date-overlay)
14734 (setq org-read-date-overlay nil)))))
14736 (setq final (org-read-date-analyze ans def defdecode))
14738 (when org-read-date-analyze-forced-year
14739 (message "Year was forced into %s"
14740 (if org-read-date-force-compatible-dates
14741 "compatible range (1970-2037)"
14742 "range representable on this machine"))
14743 (ding))
14745 ;; One round trip to get rid of 34th of August and stuff like that....
14746 (setq final (decode-time (apply 'encode-time final)))
14748 (setq org-read-date-final-answer ans)
14750 (if to-time
14751 (apply 'encode-time final)
14752 (if (and (boundp 'org-time-was-given) org-time-was-given)
14753 (format "%04d-%02d-%02d %02d:%02d"
14754 (nth 5 final) (nth 4 final) (nth 3 final)
14755 (nth 2 final) (nth 1 final))
14756 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14758 (defvar def)
14759 (defvar defdecode)
14760 (defvar with-time)
14761 (defun org-read-date-display ()
14762 "Display the current date prompt interpretation in the minibuffer."
14763 (when org-read-date-display-live
14764 (when org-read-date-overlay
14765 (delete-overlay org-read-date-overlay))
14766 (let ((p (point)))
14767 (end-of-line 1)
14768 (while (not (equal (buffer-substring
14769 (max (point-min) (- (point) 4)) (point))
14770 " "))
14771 (insert " "))
14772 (goto-char p))
14773 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14774 " " (or org-ans1 org-ans2)))
14775 (org-end-time-was-given nil)
14776 (f (org-read-date-analyze ans def defdecode))
14777 (fmts (if org-dcst
14778 org-time-stamp-custom-formats
14779 org-time-stamp-formats))
14780 (fmt (if (or with-time
14781 (and (boundp 'org-time-was-given) org-time-was-given))
14782 (cdr fmts)
14783 (car fmts)))
14784 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14785 (when (and org-end-time-was-given
14786 (string-match org-plain-time-of-day-regexp txt))
14787 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14788 org-end-time-was-given
14789 (substring txt (match-end 0)))))
14790 (when org-read-date-analyze-futurep
14791 (setq txt (concat txt " (=>F)")))
14792 (setq org-read-date-overlay
14793 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14794 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14796 (defun org-read-date-analyze (ans def defdecode)
14797 "Analyze the combined answer of the date prompt."
14798 ;; FIXME: cleanup and comment
14799 (let ((nowdecode (decode-time (current-time)))
14800 delta deltan deltaw deltadef year month day
14801 hour minute second wday pm h2 m2 tl wday1
14802 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14803 (setq org-read-date-analyze-futurep nil
14804 org-read-date-analyze-forced-year nil)
14806 (setq ans "+0"))
14808 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14809 (setq ans (replace-match "" t t ans)
14810 deltan (car delta)
14811 deltaw (nth 1 delta)
14812 deltadef (nth 2 delta)))
14814 ;; Check if there is an iso week date in there
14815 ;; If yes, store the info and postpone interpreting it until the rest
14816 ;; of the parsing is done
14817 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14818 (setq iso-year (if (match-end 1)
14819 (org-small-year-to-year
14820 (string-to-number (match-string 1 ans))))
14821 iso-weekday (if (match-end 3)
14822 (string-to-number (match-string 3 ans)))
14823 iso-week (string-to-number (match-string 2 ans)))
14824 (setq ans (replace-match "" t t ans)))
14826 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14827 (when (string-match
14829 (setq year (if (match-end 2)
14830 (string-to-number (match-string 2 ans))
14831 (progn (setq kill-year t)
14832 (string-to-number (format-time-string "%Y"))))
14833 month (string-to-number (match-string 3 ans))
14834 day (string-to-number (match-string 4 ans)))
14835 (if (< year 100) (setq year (+ 2000 year)))
14837 t nil ans)))
14839 ;; Help matching dottet european dates
14840 (when (string-match
14841 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14842 (setq year (if (match-end 3)
14843 (string-to-number (match-string 3 ans))
14844 (progn (setq kill-year t)
14845 (string-to-number (format-time-string "%Y"))))
14846 day (string-to-number (match-string 1 ans))
14847 month (string-to-number (match-string 2 ans))
14849 t nil ans)))
14851 ;; Help matching american dates, like 5/30 or 5/30/7
14852 (when (string-match
14853 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14854 (setq year (if (match-end 4)
14855 (string-to-number (match-string 4 ans))
14856 (progn (setq kill-year t)
14857 (string-to-number (format-time-string "%Y"))))
14858 month (string-to-number (match-string 1 ans))
14859 day (string-to-number (match-string 2 ans)))
14860 (if (< year 100) (setq year (+ 2000 year)))
14862 t nil ans)))
14863 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14864 ;; If there is a time with am/pm, and *no* time without it, we convert
14865 ;; so that matching will be successful.
14866 (loop for i from 1 to 2 do ; twice, for end time as well
14869 (setq hour (string-to-number (match-string 1 ans))
14870 minute (if (match-end 3)
14871 (string-to-number (match-string 3 ans))
14872 0)
14873 pm (equal ?p
14874 (string-to-char (downcase (match-string 4 ans)))))
14875 (if (and (= hour 12) (not pm))
14876 (setq hour 0)
14877 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14878 (setq ans (replace-match (format "%02d:%02d" hour minute)
14879 t t ans))))
14881 ;; Check if a time range is given as a duration
14882 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14883 (setq hour (string-to-number (match-string 1 ans))
14884 h2 (+ hour (string-to-number (match-string 3 ans)))
14885 minute (string-to-number (match-string 2 ans))
14886 m2 (+ minute (if (match-end 5) (string-to-number
14887 (match-string 5 ans))0)))
14888 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14889 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14890 t t ans)))
14892 ;; Check if there is a time range
14893 (when (boundp 'org-end-time-was-given)
14894 (setq org-time-was-given nil)
14895 (when (and (string-match org-plain-time-of-day-regexp ans)
14896 (match-end 8))
14897 (setq org-end-time-was-given (match-string 8 ans))
14898 (setq ans (concat (substring ans 0 (match-beginning 7))
14899 (substring ans (match-end 7))))))
14901 (setq tl (parse-time-string ans)
14902 day (or (nth 3 tl) (nth 3 defdecode))
14903 month (or (nth 4 tl)
14904 (if (and org-read-date-prefer-future
14905 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14906 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14907 (nth 4 defdecode)))
14908 year (or (and (not kill-year) (nth 5 tl))
14909 (if (and org-read-date-prefer-future
14910 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14911 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14912 (nth 5 defdecode)))
14913 hour (or (nth 2 tl) (nth 2 defdecode))
14914 minute (or (nth 1 tl) (nth 1 defdecode))
14915 second (or (nth 0 tl) 0)
14916 wday (nth 6 tl))
14918 (when (and (eq org-read-date-prefer-future 'time)
14919 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14920 (equal day (nth 3 nowdecode))
14921 (equal month (nth 4 nowdecode))
14922 (equal year (nth 5 nowdecode))
14923 (nth 2 tl)
14924 (or (< (nth 2 tl) (nth 2 nowdecode))
14925 (and (= (nth 2 tl) (nth 2 nowdecode))
14926 (nth 1 tl)
14927 (< (nth 1 tl) (nth 1 nowdecode)))))
14928 (setq day (1+ day)
14929 futurep t))
14931 ;; Special date definitions below
14932 (cond
14933 (iso-week
14934 ;; There was an iso week
14935 (require 'cal-iso)
14936 (setq futurep nil)
14937 (setq year (or iso-year year)
14938 day (or iso-weekday wday 1)
14939 wday nil ; to make sure that the trigger below does not match
14940 iso-date (calendar-gregorian-from-absolute
14941 (calendar-absolute-from-iso
14942 (list iso-week day year))))
14943 ; FIXME: Should we also push ISO weeks into the future?
14944 ; (when (and org-read-date-prefer-future
14945 ; (not iso-year)
14946 ; (< (calendar-absolute-from-gregorian iso-date)
14947 ; (time-to-days (current-time))))
14948 ; (setq year (1+ year)
14949 ; iso-date (calendar-gregorian-from-absolute
14950 ; (calendar-absolute-from-iso
14951 ; (list iso-week day year)))))
14952 (setq month (car iso-date)
14953 year (nth 2 iso-date)
14954 day (nth 1 iso-date)))
14955 (deltan
14956 (setq futurep nil)
14957 (unless deltadef
14958 (let ((now (decode-time (current-time))))
14959 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14960 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14961 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14962 ((equal deltaw "m") (setq month (+ month deltan)))
14963 ((equal deltaw "y") (setq year (+ year deltan)))))
14964 ((and wday (not (nth 3 tl)))
14965 (setq futurep nil)
14966 ;; Weekday was given, but no day, so pick that day in the week
14967 ;; on or after the derived date.
14968 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14969 (unless (equal wday wday1)
14970 (setq day (+ day (% (- wday wday1 -7) 7))))))
14971 (if (and (boundp 'org-time-was-given)
14972 (nth 2 tl))
14973 (setq org-time-was-given t))
14974 (if (< year 100) (setq year (+ 2000 year)))
14975 ;; Check of the date is representable
14976 (if org-read-date-force-compatible-dates
14977 (progn
14978 (if (< year 1970)
14979 (setq year 1970 org-read-date-analyze-forced-year t))
14980 (if (> year 2037)
14981 (setq year 2037 org-read-date-analyze-forced-year t)))
14982 (condition-case nil
14983 (ignore (encode-time second minute hour day month year))
14984 (error
14985 (setq year (nth 5 defdecode))
14986 (setq org-read-date-analyze-forced-year t))))
14987 (setq org-read-date-analyze-futurep futurep)
14988 (list second minute hour day month year)))
14990 (defvar parse-time-weekdays)
14992 (defun org-read-date-get-relative (s today default)
14993 "Check string S for special relative date string.
14994 TODAY and DEFAULT are internal times, for today and for a default.
14995 Return shift list (N what def-flag)
14997 N is the number of WHATs to shift.
14998 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14999 the DEFAULT date rather than TODAY."
15000 (when (and
15001 (string-match
15002 (concat
15007 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15008 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15009 (string-to-char (substring (match-string 1 s) -1))
15010 ?+))
15011 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15012 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15013 (what (if (match-end 3) (match-string 3 s) "d"))
15014 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15015 (date (if rel default today))
15016 (wday (nth 6 (decode-time date)))
15017 delta)
15018 (if wday1
15019 (progn
15020 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15021 (if (= dir ?-) (setq delta (- delta 7)))
15022 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15023 (list delta "d" rel))
15024 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15026 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15027 "Turn a user-specified date into the internal representation.
15028 The internal representation needed by the calendar is (month day year).
15029 This is a wrapper to handle the brain-dead convention in calendar that
15030 user function argument order change dependent on argument order."
15031 (if (boundp 'calendar-date-style)
15032 (cond
15033 ((eq calendar-date-style 'american)
15034 (list arg1 arg2 arg3))
15035 ((eq calendar-date-style 'european)
15036 (list arg2 arg1 arg3))
15037 ((eq calendar-date-style 'iso)
15038 (list arg2 arg3 arg1)))
15039 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15040 (if (org-bound-and-true-p european-calendar-style)
15041 (list arg2 arg1 arg3)
15042 (list arg1 arg2 arg3)))))
15044 (defun org-eval-in-calendar (form &optional keepdate)
15045 "Eval FORM in the calendar window and return to current window.
15046 Also, store the cursor date in variable org-ans2."
15047 (let ((sf (selected-frame))
15048 (sw (selected-window)))
15049 (select-window (get-buffer-window "*Calendar*" t))
15050 (eval form)
15051 (when (and (not keepdate) (calendar-cursor-to-date))
15052 (let* ((date (calendar-cursor-to-date))
15053 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15054 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15055 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15056 (select-window sw)
15057 (org-select-frame-set-input-focus sf)))
15059 (defun org-calendar-select ()
15060 "Return to `org-read-date' with the date currently selected.
15061 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15062 (interactive)
15063 (when (calendar-cursor-to-date)
15064 (let* ((date (calendar-cursor-to-date))
15065 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15066 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15067 (if (active-minibuffer-window) (exit-minibuffer))))
15069 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15070 "Insert a date stamp for the date given by the internal TIME.
15071 WITH-HM means use the stamp format that includes the time of the day.
15072 INACTIVE means use square brackets instead of angular ones, so that the
15073 stamp will not contribute to the agenda.
15074 PRE and POST are optional strings to be inserted before and after the
15075 stamp.
15076 The command returns the inserted time stamp."
15077 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15078 stamp)
15079 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15080 (insert-before-markers (or pre ""))
15081 (when (listp extra)
15082 (setq extra (car extra))
15083 (if (and (stringp extra)
15085 (setq extra (format "-%02d:%02d"
15086 (string-to-number (match-string 1 extra))
15087 (string-to-number (match-string 2 extra))))
15088 (setq extra nil)))
15089 (when extra
15090 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15091 (insert-before-markers (setq stamp (format-time-string fmt time)))
15092 (insert-before-markers (or post ""))
15093 (setq org-last-inserted-timestamp stamp)))
15095 (defun org-toggle-time-stamp-overlays ()
15096 "Toggle the use of custom time stamp formats."
15097 (interactive)
15098 (setq org-display-custom-times (not org-display-custom-times))
15099 (unless org-display-custom-times
15100 (let ((p (point-min)) (bmp (buffer-modified-p)))
15101 (while (setq p (next-single-property-change p 'display))
15102 (if (and (get-text-property p 'display)
15103 (eq (get-text-property p 'face) 'org-date))
15104 (remove-text-properties
15105 p (setq p (next-single-property-change p 'display))
15106 '(display t))))
15107 (set-buffer-modified-p bmp)))
15108 (if (featurep 'xemacs)
15109 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15110 (org-restart-font-lock)
15111 (setq org-table-may-need-update t)
15112 (if org-display-custom-times
15113 (message "Time stamps are overlayed with custom format")
15114 (message "Time stamp overlays removed")))
15116 (defun org-display-custom-time (beg end)
15117 "Overlay modified time stamp format over timestamp between BEG and END."
15118 (let* ((ts (buffer-substring beg end))
15119 t1 w1 with-hm tf time str w2 (off 0))
15120 (save-match-data
15121 (setq t1 (org-parse-time-string ts t))
15122 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15123 (setq off (- (match-end 0) (match-beginning 0)))))
15124 (setq end (- end off))
15125 (setq w1 (- end beg)
15126 with-hm (and (nth 1 t1) (nth 2 t1))
15127 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15128 time (org-fix-decoded-time t1)
15129 str (org-add-props
15130 (format-time-string
15131 (substring tf 1 -1) (apply 'encode-time time))
15132 nil 'mouse-face 'highlight)
15133 w2 (length str))
15134 (if (not (= w2 w1))
15135 (add-text-properties (1+ beg) (+ 2 beg)
15136 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15137 (if (featurep 'xemacs)
15138 (progn
15139 (put-text-property beg end 'invisible t)
15140 (put-text-property beg end 'end-glyph (make-glyph str)))
15141 (put-text-property beg end 'display str))))
15143 (defun org-translate-time (string)
15144 "Translate all timestamps in STRING to custom format.
15145 But do this only if the variable `org-display-custom-times' is set."
15146 (when org-display-custom-times
15147 (save-match-data
15148 (let* ((start 0)
15149 (re org-ts-regexp-both)
15150 t1 with-hm inactive tf time str beg end)
15151 (while (setq start (string-match re string start))
15152 (setq beg (match-beginning 0)
15153 end (match-end 0)
15154 t1 (save-match-data
15155 (org-parse-time-string (substring string beg end) t))
15156 with-hm (and (nth 1 t1) (nth 2 t1))
15157 inactive (equal (substring string beg (1+ beg)) "[")
15158 tf (funcall (if with-hm 'cdr 'car)
15159 org-time-stamp-custom-formats)
15160 time (org-fix-decoded-time t1)
15161 str (format-time-string
15162 (concat
15163 (if inactive "[" "<") (substring tf 1 -1)
15164 (if inactive "]" ">"))
15165 (apply 'encode-time time))
15166 string (replace-match str t t string)
15167 start (+ start (length str)))))))
15168 string)
15170 (defun org-fix-decoded-time (time)
15171 "Set 0 instead of nil for the first 6 elements of time.
15172 Don't touch the rest."
15173 (let ((n 0))
15174 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15176 (defun org-days-to-time (timestamp-string)
15177 "Difference between TIMESTAMP-STRING and now in days."
15178 (- (time-to-days (org-time-string-to-time timestamp-string))
15179 (time-to-days (current-time))))
15181 (defun org-deadline-close (timestamp-string &optional ndays)
15182 "Is the time in TIMESTAMP-STRING close to the current date?"
15183 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15184 (and (< (org-days-to-time timestamp-string) ndays)
15185 (not (org-entry-is-done-p))))
15187 (defun org-get-wdays (ts)
15188 "Get the deadline lead time appropriate for timestring TS."
15189 (cond
15190 ((<= org-deadline-warning-days 0)
15191 ;; 0 or negative, enforce this value no matter what
15192 (- org-deadline-warning-days))
15194 ;; lead time is specified.
15195 (floor (* (string-to-number (match-string 1 ts))
15196 (cdr (assoc (match-string 2 ts)
15197 '(("d" . 1) ("w" . 7)
15198 ("m" . 30.4) ("y" . 365.25)))))))
15199 ;; go for the default.
15200 (t org-deadline-warning-days)))
15202 (defun org-calendar-select-mouse (ev)
15203 "Return to `org-read-date' with the date currently selected.
15204 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15205 (interactive "e")
15206 (mouse-set-point ev)
15207 (when (calendar-cursor-to-date)
15208 (let* ((date (calendar-cursor-to-date))
15209 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15210 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15211 (if (active-minibuffer-window) (exit-minibuffer))))
15213 (defun org-check-deadlines (ndays)
15214 "Check if there are any deadlines due or past due.
15215 A deadline is considered due if it happens within `org-deadline-warning-days'
15216 days from today's date. If the deadline appears in an entry marked DONE,
15217 it is not shown. The prefix arg NDAYS can be used to test that many
15219 (interactive "P")
15220 (let* ((org-warn-days
15221 (cond
15222 ((equal ndays '(4)) 100000)
15223 (ndays (prefix-numeric-value ndays))
15224 (t (abs org-deadline-warning-days))))
15225 (case-fold-search nil)
15227 (callback
15228 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15230 (message "%d deadlines past-due or due within %d days"
15231 (org-occur regexp nil callback)
15232 org-warn-days)))
15234 (defun org-check-before-date (date)
15235 "Check if there are deadlines or scheduled entries before DATE."
15236 (interactive (list (org-read-date)))
15237 (let ((case-fold-search nil)
15241 (callback
15242 (lambda () (time-less-p
15243 (org-time-string-to-time (match-string 2))
15244 (org-time-string-to-time date)))))
15245 (message "%d entries before %s"
15246 (org-occur regexp nil callback) date)))
15248 (defun org-check-after-date (date)
15249 "Check if there are deadlines or scheduled entries after DATE."
15250 (interactive (list (org-read-date)))
15251 (let ((case-fold-search nil)
15255 (callback
15256 (lambda () (not
15257 (time-less-p
15258 (org-time-string-to-time (match-string 2))
15259 (org-time-string-to-time date))))))
15260 (message "%d entries after %s"
15261 (org-occur regexp nil callback) date)))
15263 (defun org-evaluate-time-range (&optional to-buffer)
15264 "Evaluate a time range by computing the difference between start and end.
15265 Normally the result is just printed in the echo area, but with prefix arg
15266 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15267 If the time range is actually in a table, the result is inserted into the
15268 next column.
15269 For time difference computation, a year is assumed to be exactly 365
15270 days in order to avoid rounding problems."
15271 (interactive "P")
15272 (or
15273 (org-clock-update-time-maybe)
15274 (save-excursion
15275 (unless (org-at-date-range-p t)
15276 (goto-char (point-at-bol))
15277 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15278 (if (not (org-at-date-range-p t))
15279 (error "Not at a time-stamp range, and none found in current line")))
15280 (let* ((ts1 (match-string 1))
15281 (ts2 (match-string 2))
15282 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15283 (match-end (match-end 0))
15284 (time1 (org-time-string-to-time ts1))
15285 (time2 (org-time-string-to-time ts2))
15286 (t1 (org-float-time time1))
15287 (t2 (org-float-time time2))
15288 (diff (abs (- t2 t1)))
15289 (negative (< (- t2 t1) 0))
15290 ;; (ys (floor (* 365 24 60 60)))
15291 (ds (* 24 60 60))
15292 (hs (* 60 60))
15293 (fy "%dy %dd %02d:%02d")
15294 (fy1 "%dy %dd")
15295 (fd "%dd %02d:%02d")
15296 (fd1 "%dd")
15297 (fh "%02d:%02d")
15298 y d h m align)
15299 (if havetime
15300 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15301 y 0
15302 d (floor (/ diff ds)) diff (mod diff ds)
15303 h (floor (/ diff hs)) diff (mod diff hs)
15304 m (floor (/ diff 60)))
15305 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15306 y 0
15307 d (floor (+ (/ diff ds) 0.5))
15308 h 0 m 0))
15309 (if (not to-buffer)
15310 (message "%s" (org-make-tdiff-string y d h m))
15311 (if (org-at-table-p)
15312 (progn
15313 (goto-char match-end)
15314 (setq align t)
15315 (and (looking-at " *|") (goto-char (match-end 0))))
15316 (goto-char match-end))
15317 (if (looking-at
15319 (replace-match ""))
15320 (if negative (insert " -"))
15321 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15322 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15323 (insert " " (format fh h m))))
15324 (if align (org-table-align))
15325 (message "Time difference inserted")))))
15327 (defun org-make-tdiff-string (y d h m)
15328 (let ((fmt "")
15329 (l nil))
15330 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15331 l (push y l)))
15332 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15333 l (push d l)))
15334 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15335 l (push h l)))
15336 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15337 l (push m l)))
15338 (apply 'format fmt (nreverse l))))
15340 (defun org-time-string-to-time (s)
15341 (apply 'encode-time (org-parse-time-string s)))
15342 (defun org-time-string-to-seconds (s)
15343 (org-float-time (org-time-string-to-time s)))
15345 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15346 "Convert a time stamp to an absolute day number.
15347 If there is a specifier for a cyclic time stamp, get the closest date to
15348 DAYNR.
15349 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15350 The variable date is bound by the calendar when this is called."
15351 (cond
15353 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15354 daynr
15355 (+ daynr 1000)))
15357 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15358 (time-to-days (current-time))) (match-string 0 s)
15359 prefer show-all))
15360 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15362 (defun org-days-to-iso-week (days)
15363 "Return the iso week number."
15364 (require 'cal-iso)
15365 (car (calendar-iso-from-absolute days)))
15367 (defun org-small-year-to-year (year)
15368 "Convert 2-digit years into 4-digit years.
15369 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15370 The year 2000 cannot be abbreviated. Any year larger than 99
15371 is returned unchanged."
15372 (if (< year 38)
15373 (setq year (+ 2000 year))
15374 (if (< year 100)
15375 (setq year (+ 1900 year))))
15376 year)
15378 (defun org-time-from-absolute (d)
15379 "Return the time corresponding to date D.
15380 D may be an absolute day number, or a calendar-type list (month day year)."
15381 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15382 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15384 (defun org-calendar-holiday ()
15385 "List of holidays, for Diary display in Org-mode."
15386 (require 'holidays)
15387 (let ((hl (funcall
15388 (if (fboundp 'calendar-check-holidays)
15389 'calendar-check-holidays 'check-calendar-holidays) date)))
15390 (if hl (mapconcat 'identity hl "; "))))
15392 (defun org-diary-sexp-entry (sexp entry date)
15393 "Process a SEXP diary ENTRY for DATE."
15394 (require 'diary-lib)
15395 (let ((result (if calendar-debug-sexp
15396 (let ((stack-trace-on-error t))
15397 (eval (car (read-from-string sexp))))
15398 (condition-case nil
15399 (eval (car (read-from-string sexp)))
15400 (error
15401 (beep)
15402 (message "Bad sexp at line %d in %s: %s"
15403 (org-current-line)
15404 (buffer-file-name) sexp)
15405 (sleep-for 2))))))
15406 (cond ((stringp result) (split-string result "; "))
15407 ((and (consp result)
15408 (not (consp (cdr result)))
15409 (stringp (cdr result))) (cdr result))
15410 ((and (consp result)
15411 (stringp (car result))) result)
15412 (result entry)
15413 (t nil))))
15415 (defun org-diary-to-ical-string (frombuf)
15416 "Get iCalendar entries from diary entries in buffer FROMBUF.
15417 This uses the icalendar.el library."
15418 (let* ((tmpdir (if (featurep 'xemacs)
15419 (temp-directory)
15420 temporary-file-directory))
15421 (tmpfile (make-temp-name
15422 (expand-file-name "orgics" tmpdir)))
15423 buf rtn b e)
15424 (with-current-buffer frombuf
15425 (icalendar-export-region (point-min) (point-max) tmpfile)
15426 (setq buf (find-buffer-visiting tmpfile))
15427 (set-buffer buf)
15428 (goto-char (point-min))
15429 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15430 (setq b (match-beginning 0)))
15431 (goto-char (point-max))
15432 (if (re-search-backward "^END:VEVENT" nil t)
15433 (setq e (match-end 0)))
15435 (kill-buffer buf)
15436 (delete-file tmpfile)
15437 rtn))
15439 (defun org-closest-date (start current change prefer show-all)
15440 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15441 When PREFER is `past', return a date that is either CURRENT or past.
15442 When PREFER is `future', return a date that is either CURRENT or future.
15443 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15444 ;; Make the proper lists from the dates
15445 (catch 'exit
15446 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15447 dn dw sday cday n1 n2 n0
15448 d m y y1 y2 date1 date2 nmonths nm ny m2)
15450 (setq start (org-date-to-gregorian start)
15451 current (org-date-to-gregorian
15452 (if show-all
15453 current
15454 (time-to-days (current-time))))
15455 sday (calendar-absolute-from-gregorian start)
15456 cday (calendar-absolute-from-gregorian current))
15458 (if (<= cday sday) (throw 'exit sday))
15461 (setq dn (string-to-number (match-string 1 change))
15462 dw (cdr (assoc (match-string 2 change) a1)))
15463 (error "Invalid change specifier: %s" change))
15464 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15465 (cond
15466 ((eq dw 'day)
15467 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15468 n2 (+ n1 dn)))
15469 ((eq dw 'year)
15470 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15471 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15472 (setq date1 (list m d y1)
15473 n1 (calendar-absolute-from-gregorian date1)
15474 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15475 n2 (calendar-absolute-from-gregorian date2)))
15476 ((eq dw 'month)
15477 ;; approx number of month between the two dates
15478 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15479 ;; How often does dn fit in there?
15480 (setq d (nth 1 start) m (car start) y (nth 2 start)
15481 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15482 m (+ m nm)
15483 ny (floor (/ m 12))
15484 y (+ y ny)
15485 m (- m (* ny 12)))
15486 (while (> m 12) (setq m (- m 12) y (1+ y)))
15487 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15488 (setq m2 (+ m dn) y2 y)
15489 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15490 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15491 (while (<= n2 cday)
15492 (setq n1 n2 m m2 y y2)
15493 (setq m2 (+ m dn) y2 y)
15494 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15495 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15496 ;; Make sure n1 is the earlier date
15497 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15498 (if show-all
15499 (cond
15500 ((eq prefer 'past) (if (= cday n2) n2 n1))
15501 ((eq prefer 'future) (if (= cday n1) n1 n2))
15502 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15503 (cond
15504 ((eq prefer 'past) (if (= cday n2) n2 n1))
15505 ((eq prefer 'future) (if (= cday n1) n1 n2))
15506 (t (if (= cday n1) n1 n2)))))))
15508 (defun org-date-to-gregorian (date)
15509 "Turn any specification of DATE into a Gregorian date for the calendar."
15510 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15511 ((and (listp date) (= (length date) 3)) date)
15512 ((stringp date)
15513 (setq date (org-parse-time-string date))
15514 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15515 ((listp date)
15516 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15518 (defun org-parse-time-string (s &optional nodefault)
15519 "Parse the standard Org-mode time string.
15520 This should be a lot faster than the normal `parse-time-string'.
15521 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15522 hour and minute fields will be nil if not given."
15523 (if (string-match org-ts-regexp0 s)
15524 (list 0
15525 (if (or (match-beginning 8) (not nodefault))
15526 (string-to-number (or (match-string 8 s) "0")))
15527 (if (or (match-beginning 7) (not nodefault))
15528 (string-to-number (or (match-string 7 s) "0")))
15529 (string-to-number (match-string 4 s))
15530 (string-to-number (match-string 3 s))
15531 (string-to-number (match-string 2 s))
15532 nil nil nil)
15533 (error "Not a standard Org-mode time string: %s" s)))
15535 (defun org-timestamp-up (&optional arg)
15536 "Increase the date item at the cursor by one.
15537 If the cursor is on the year, change the year. If it is on the month,
15538 the day or the time, change that.
15539 With prefix ARG, change by that many units."
15540 (interactive "p")
15541 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15543 (defun org-timestamp-down (&optional arg)
15544 "Decrease the date item at the cursor by one.
15545 If the cursor is on the year, change the year. If it is on the month,
15546 the day or the time, change that.
15547 With prefix ARG, change by that many units."
15548 (interactive "p")
15549 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15551 (defun org-timestamp-up-day (&optional arg)
15552 "Increase the date in the time stamp by one day.
15553 With prefix ARG, change that many days."
15554 (interactive "p")
15555 (if (and (not (org-at-timestamp-p t))
15556 (org-on-heading-p))
15557 (org-todo 'up)
15558 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15560 (defun org-timestamp-down-day (&optional arg)
15561 "Decrease the date in the time stamp by one day.
15562 With prefix ARG, change that many days."
15563 (interactive "p")
15564 (if (and (not (org-at-timestamp-p t))
15565 (org-on-heading-p))
15566 (org-todo 'down)
15567 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15569 (defun org-at-timestamp-p (&optional inactive-ok)
15570 "Determine if the cursor is in or at a timestamp."
15571 (interactive)
15572 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15573 (pos (point))
15574 (ans (or (looking-at tsr)
15575 (save-excursion
15577 (if (> (point) (point-min)) (backward-char 1))
15578 (and (looking-at tsr)
15579 (> (- (match-end 0) pos) -1))))))
15580 (and ans
15581 (boundp 'org-ts-what)
15582 (setq org-ts-what
15583 (cond
15584 ((= pos (match-beginning 0)) 'bracket)
15585 ((= pos (1- (match-end 0))) 'bracket)
15586 ((org-pos-in-match-range pos 2) 'year)
15587 ((org-pos-in-match-range pos 3) 'month)
15588 ((org-pos-in-match-range pos 7) 'hour)
15589 ((org-pos-in-match-range pos 8) 'minute)
15590 ((or (org-pos-in-match-range pos 4)
15591 (org-pos-in-match-range pos 5)) 'day)
15592 ((and (> pos (or (match-end 8) (match-end 5)))
15593 (< pos (match-end 0)))
15594 (- pos (or (match-end 8) (match-end 5))))
15595 (t 'day))))
15596 ans))
15598 (defun org-toggle-timestamp-type ()
15599 "Toggle the type (<active> or [inactive]) of a time stamp."
15600 (interactive)
15601 (when (org-at-timestamp-p t)
15602 (let ((beg (match-beginning 0)) (end (match-end 0))
15603 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15604 (save-excursion
15605 (goto-char beg)
15606 (while (re-search-forward "[][<>]" end t)
15607 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15608 t t)))
15609 (message "Timestamp is now %sactive"
15610 (if (equal (char-after beg) ?<) "" "in")))))
15612 (defun org-timestamp-change (n &optional what updown)
15613 "Change the date in the time stamp at point.
15614 The date will be changed by N times WHAT. WHAT can be `day', `month',
15615 `year', `minute', `second'. If WHAT is not given, the cursor position
15616 in the timestamp determines what will be changed."
15617 (let ((origin (point)) origin-cat
15618 with-hm inactive
15619 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15620 org-ts-what
15621 extra rem
15622 ts time time0)
15623 (if (not (org-at-timestamp-p t))
15624 (error "Not at a timestamp"))
15625 (if (and (not what) (eq org-ts-what 'bracket))
15626 (org-toggle-timestamp-type)
15627 ;; Point isn't on brackets. Remember the part of the time-stamp
15628 ;; the point was in. Indeed, size of time-stamps may change,
15629 ;; but point must be kept in the same category nonetheless.
15630 (setq origin-cat org-ts-what)
15631 (if (and (not what) (not (eq org-ts-what 'day))
15632 org-display-custom-times
15633 (get-text-property (point) 'display)
15634 (not (get-text-property (1- (point)) 'display)))
15635 (setq org-ts-what 'day))
15636 (setq org-ts-what (or what org-ts-what)
15637 inactive (= (char-after (match-beginning 0)) ?\[)
15638 ts (match-string 0))
15639 (replace-match "")
15640 (if (string-match
15642 ts)
15643 (setq extra (match-string 1 ts)))
15645 (setq with-hm t))
15646 (setq time0 (org-parse-time-string ts))
15647 (when (and updown
15648 (eq org-ts-what 'minute)
15649 (not current-prefix-arg))
15650 ;; This looks like s-up and s-down. Change by one rounding step.
15651 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15652 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15653 (setcar (cdr time0) (+ (nth 1 time0)
15654 (if (> n 0) (- rem) (- dm rem))))))
15655 (setq time
15656 (encode-time (or (car time0) 0)
15657 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15658 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15659 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15660 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15661 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15662 (nthcdr 6 time0)))
15663 (when (and (member org-ts-what '(hour minute))
15664 extra
15666 (setq extra (org-modify-ts-extra
15667 extra
15668 (if (eq org-ts-what 'hour) 2 5)
15669 n dm)))
15670 (when (integerp org-ts-what)
15671 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15672 (if (eq what 'calendar)
15673 (let ((cal-date (org-get-date-from-calendar)))
15674 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15675 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15676 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15677 (setcar time0 (or (car time0) 0))
15678 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15679 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15680 (setq time (apply 'encode-time time0))))
15681 ;; Insert the new time-stamp, and ensure point stays in the same
15682 ;; category as before (i.e. not after the last position in that
15683 ;; category).
15684 (let ((pos (point)))
15685 ;; Stay before inserted string. `save-excursion' is of no use.
15686 (setq org-last-changed-timestamp
15687 (org-insert-time-stamp time with-hm inactive nil nil extra))
15688 (goto-char pos))
15689 (save-match-data
15690 (looking-at org-ts-regexp3)
15691 (goto-char (cond
15692 ;; `day' category ends before `hour' if any, or at
15693 ;; the end of the day name.
15694 ((eq origin-cat 'day)
15695 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15696 ((eq origin-cat 'hour) (min (match-end 7) origin))
15697 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15698 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15699 ;; `year' and `month' have both fixed size: point
15700 ;; couldn't have moved into another part.
15701 (t origin))))
15702 ;; Update clock if on a CLOCK line.
15703 (org-clock-update-time-maybe)
15704 ;; Try to recenter the calendar window, if any.
15705 (if (and org-calendar-follow-timestamp-change
15706 (get-buffer-window "*Calendar*" t)
15707 (memq org-ts-what '(day month year)))
15708 (org-recenter-calendar (time-to-days time))))))
15710 (defun org-modify-ts-extra (s pos n dm)
15711 "Change the different parts of the lead-time and repeat fields in timestamp."
15712 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15713 ng h m new rem)
15714 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15715 (cond
15716 ((or (org-pos-in-match-range pos 2)
15717 (org-pos-in-match-range pos 3))
15718 (setq m (string-to-number (match-string 3 s))
15719 h (string-to-number (match-string 2 s)))
15720 (if (org-pos-in-match-range pos 2)
15721 (setq h (+ h n))
15722 (setq n (* dm (org-no-warnings (signum n))))
15723 (when (not (= 0 (setq rem (% m dm))))
15724 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15725 (setq m (+ m n)))
15726 (if (< m 0) (setq m (+ m 60) h (1- h)))
15727 (if (> m 59) (setq m (- m 60) h (1+ h)))
15728 (setq h (min 24 (max 0 h)))
15729 (setq ng 1 new (format "-%02d:%02d" h m)))
15730 ((org-pos-in-match-range pos 6)
15731 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15732 ((org-pos-in-match-range pos 5)
15733 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15735 ((org-pos-in-match-range pos 9)
15736 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15737 ((org-pos-in-match-range pos 8)
15738 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15740 (when ng
15741 (setq s (concat
15742 (substring s 0 (match-beginning ng))
15743 new
15744 (substring s (match-end ng))))))
15745 s))
15747 (defun org-recenter-calendar (date)
15748 "If the calendar is visible, recenter it to DATE."
15749 (let* ((win (selected-window))
15750 (cwin (get-buffer-window "*Calendar*" t))
15751 (calendar-move-hook nil))
15752 (when cwin
15753 (select-window cwin)
15754 (calendar-goto-date (if (listp date) date
15755 (calendar-gregorian-from-absolute date)))
15756 (select-window win))))
15758 (defun org-goto-calendar (&optional arg)
15759 "Go to the Emacs calendar at the current date.
15760 If there is a time stamp in the current line, go to that date.
15761 A prefix ARG can be used to force the current date."
15762 (interactive "P")
15763 (let ((tsr org-ts-regexp) diff
15764 (calendar-move-hook nil)
15765 (calendar-view-holidays-initially-flag nil)
15766 (calendar-view-diary-initially-flag nil))
15767 (if (or (org-at-timestamp-p)
15768 (save-excursion
15769 (beginning-of-line 1)
15770 (looking-at (concat ".*" tsr))))
15771 (let ((d1 (time-to-days (current-time)))
15772 (d2 (time-to-days
15773 (org-time-string-to-time (match-string 1)))))
15774 (setq diff (- d2 d1))))
15775 (calendar)
15776 (calendar-goto-today)
15777 (if (and diff (not arg)) (calendar-forward-day diff))))
15779 (defun org-get-date-from-calendar ()
15780 "Return a list (month day year) of date at point in calendar."
15781 (with-current-buffer "*Calendar*"
15782 (save-match-data
15783 (calendar-cursor-to-date))))
15785 (defun org-date-from-calendar ()
15786 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15787 If there is already a time stamp at the cursor position, update it."
15788 (interactive)
15789 (if (org-at-timestamp-p t)
15790 (org-timestamp-change 0 'calendar)
15791 (let ((cal-date (org-get-date-from-calendar)))
15792 (org-insert-time-stamp
15793 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15795 (defun org-minutes-to-hh:mm-string (m)
15796 "Compute H:MM from a number of minutes."
15797 (let ((h (/ m 60)))
15798 (setq m (- m (* 60 h)))
15799 (format org-time-clocksum-format h m)))
15801 (defun org-hh:mm-string-to-minutes (s)
15802 "Convert a string H:MM to a number of minutes.
15803 If the string is just a number, interpret it as minutes.
15804 In fact, the first hh:mm or number in the string will be taken,
15805 there can be extra stuff in the string.
15806 If no number is found, the return value is 0."
15807 (cond
15808 ((integerp s) s)
15810 (+ (* (string-to-number (match-string 1 s)) 60)
15811 (string-to-number (match-string 2 s))))
15813 (string-to-number (match-string 1 s)))
15814 (t 0)))
15816 (defcustom org-effort-durations
15817 `(("h" . 60)
15818 ("d" . ,(* 60 8))
15819 ("w" . ,(* 60 8 5))
15820 ("m" . ,(* 60 8 5 4))
15821 ("y" . ,(* 60 8 5 40)))
15822 "Conversion factor to minutes for an effort modifier.
15824 Each entry has the form (MODIFIER . MINUTES).
15826 In an effort string, a number followed by MODIFIER is multiplied
15827 by the specified number of MINUTES to obtain an effort in
15828 minutes.
15832 :group 'org-agenda
15833 :type '(alist :key-type (string :tag "Modifier")
15834 :value-type (number :tag "Minutes")))
15836 (defun org-duration-string-to-minutes (s)
15837 "Convert a duration string S to minutes.
15839 A bare number is interpreted as minutes, modifiers can be set by
15840 customizing `org-effort-durations' (which see).
15842 Entries containing a colon are interpreted as H:MM by
15843 `org-hh:mm-string-to-minutes'."
15844 (let ((result 0)
15846 (regexp-opt (mapcar 'car org-effort-durations))
15848 (while (string-match re s)
15849 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15850 (string-to-number (match-string 1 s))))
15851 (setq s (replace-match "" nil t s)))
15852 (incf result (org-hh:mm-string-to-minutes s))
15853 result))
15855 ;;;; Files
15857 (defun org-save-all-org-buffers ()
15858 "Save all Org-mode buffers without user confirmation."
15859 (interactive)
15860 (message "Saving all Org-mode buffers...")
15861 (save-some-buffers t 'org-mode-p)
15862 (when (featurep 'org-id) (org-id-locations-save))
15863 (message "Saving all Org-mode buffers... done"))
15865 (defun org-revert-all-org-buffers ()
15866 "Revert all Org-mode buffers.
15867 Prompt for confirmation when there are unsaved changes.
15868 Be sure you know what you are doing before letting this function
15869 overwrite your changes.
15871 This function is useful in a setup where one tracks org files
15872 with a version control system, to revert on one machine after pulling
15873 changes from another. I believe the procedure must be like this:
15875 1. M-x org-save-all-org-buffers
15876 2. Pull changes from the other machine, resolve conflicts
15877 3. M-x org-revert-all-org-buffers"
15878 (interactive)
15879 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15880 (error "Abort"))
15881 (save-excursion
15882 (save-window-excursion
15883 (mapc
15884 (lambda (b)
15885 (when (and (with-current-buffer b (org-mode-p))
15886 (with-current-buffer b buffer-file-name))
15887 (org-pop-to-buffer-same-window b)
15888 (revert-buffer t 'no-confirm)))
15889 (buffer-list))
15890 (when (and (featurep 'org-id) org-id-track-globally)
15891 (org-id-locations-load)))))
15893 ;;;; Agenda files
15895 ;;;###autoload
15896 (defun org-switchb (&optional arg)
15897 "Switch between Org buffers.
15898 With a prefix argument, restrict available to files.
15899 With two prefix arguments, restrict available buffers to agenda files.
15901 Defaults to `iswitchb' for buffer name completion.
15902 Set `org-completion-use-ido' to make it use ido instead."
15903 (interactive "P")
15904 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15905 ((equal arg '(16)) (org-buffer-list 'agenda))
15906 (t (org-buffer-list))))
15907 (org-completion-use-iswitchb org-completion-use-iswitchb)
15908 (org-completion-use-ido org-completion-use-ido))
15909 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15910 (setq org-completion-use-iswitchb t))
15911 (org-pop-to-buffer-same-window
15912 (org-icompleting-read "Org buffer: "
15913 (mapcar 'list (mapcar 'buffer-name blist))
15914 nil t))))
15916 ;;; Define some older names previously used for this functionality
15917 ;;;###autoload
15918 (defalias 'org-ido-switchb 'org-switchb)
15919 ;;;###autoload
15920 (defalias 'org-iswitchb 'org-switchb)
15922 (defun org-buffer-list (&optional predicate exclude-tmp)
15923 "Return a list of Org buffers.
15924 PREDICATE can be `export', `files' or `agenda'.
15926 export restrict the list to Export buffers.
15927 files restrict the list to buffers visiting Org files.
15928 agenda restrict the list to buffers visiting agenda files.
15930 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15931 (let* ((bfn nil)
15932 (agenda-files (and (eq predicate 'agenda)
15933 (mapcar 'file-truename (org-agenda-files t))))
15934 (filter
15935 (cond
15936 ((eq predicate 'files)
15937 (lambda (b) (with-current-buffer b (org-mode-p))))
15938 ((eq predicate 'export)
15939 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15940 ((eq predicate 'agenda)
15941 (lambda (b)
15942 (with-current-buffer b
15943 (and (org-mode-p)
15944 (setq bfn (buffer-file-name b))
15945 (member (file-truename bfn) agenda-files)))))
15946 (t (lambda (b) (with-current-buffer b
15947 (or (org-mode-p)
15948 (string-match "\*Org .*Export"
15949 (buffer-name b)))))))))
15950 (delq nil
15951 (mapcar
15952 (lambda(b)
15953 (if (and (funcall filter b)
15954 (or (not exclude-tmp)
15955 (not (string-match "tmp" (buffer-name b)))))
15956 b
15957 nil))
15958 (buffer-list)))))
15960 (defun org-agenda-files (&optional unrestricted archives)
15961 "Get the list of agenda files.
15962 Optional UNRESTRICTED means return the full list even if a restriction
15963 is currently in place.
15964 When ARCHIVES is t, include all archive files that are really being
15965 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15966 `org-agenda-archives-mode' is t."
15967 (let ((files
15968 (cond
15969 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15970 ((stringp org-agenda-files) (org-read-agenda-file-list))
15971 ((listp org-agenda-files) org-agenda-files)
15972 (t (error "Invalid value of `org-agenda-files'")))))
15973 (setq files (apply 'append
15974 (mapcar (lambda (f)
15975 (if (file-directory-p f)
15976 (directory-files
15977 f t org-agenda-file-regexp)
15978 (list f)))
15979 files)))
15980 (when org-agenda-skip-unavailable-files
15981 (setq files (delq nil
15982 (mapcar (function
15983 (lambda (file)
15984 (and (file-readable-p file) file)))
15985 files))))
15986 (when (or (eq archives t)
15987 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15988 (setq files (org-add-archive-files files)))
15989 files))
15991 (defun org-agenda-file-p (&optional file)
15992 "Return non-nil, if FILE is an agenda file.
15993 If FILE is omitted, use the file associated with the current
15994 buffer."
15995 (member (or file (buffer-file-name))
15996 (org-agenda-files t)))
15998 (defun org-edit-agenda-file-list ()
15999 "Edit the list of agenda files.
16000 Depending on setup, this either uses customize to edit the variable
16001 `org-agenda-files', or it visits the file that is holding the list. In the
16002 latter case, the buffer is set up in a way that saving it automatically kills
16003 the buffer and restores the previous window configuration."
16004 (interactive)
16005 (if (stringp org-agenda-files)
16006 (let ((cw (current-window-configuration)))
16007 (find-file org-agenda-files)
16008 (org-set-local 'org-window-configuration cw)
16009 (org-add-hook 'after-save-hook
16010 (lambda ()
16011 (set-window-configuration
16012 (prog1 org-window-configuration
16013 (kill-buffer (current-buffer))))
16014 (org-install-agenda-files-menu)
16015 (message "New agenda file list installed"))
16016 nil 'local)
16017 (message "%s" (substitute-command-keys
16019 (customize-variable 'org-agenda-files)))
16021 (defun org-store-new-agenda-file-list (list)
16022 "Set new value for the agenda file list and save it correctly."
16023 (if (stringp org-agenda-files)
16024 (let ((fe (org-read-agenda-file-list t)) b u)
16025 (while (setq b (find-buffer-visiting org-agenda-files))
16026 (kill-buffer b))
16027 (with-temp-file org-agenda-files
16028 (insert
16029 (mapconcat
16030 (lambda (f) ;; Keep un-expanded entries.
16031 (if (setq u (assoc f fe))
16032 (cdr u)
16033 f))
16036 (let ((org-mode-hook nil) (org-inhibit-startup t)
16037 (org-insert-mode-line-in-empty-file nil))
16038 (setq org-agenda-files list)
16039 (customize-save-variable 'org-agenda-files org-agenda-files))))
16041 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16042 "Read the list of agenda files from a file.
16043 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16044 filenames, used by `org-store-new-agenda-file-list' to write back
16045 un-expanded file names."
16046 (when (file-directory-p org-agenda-files)
16047 (error "`org-agenda-files' cannot be a single directory"))
16048 (when (stringp org-agenda-files)
16049 (with-temp-buffer
16050 (insert-file-contents org-agenda-files)
16051 (mapcar
16052 (lambda (f)
16053 (let ((e (expand-file-name (substitute-in-file-name f)
16054 org-directory)))
16055 (if pair-with-expansion
16056 (cons e f)
16057 e)))
16060 ;;;###autoload
16061 (defun org-cycle-agenda-files ()
16062 "Cycle through the files in `org-agenda-files'.
16063 If the current buffer visits an agenda file, find the next one in the list.
16064 If the current buffer does not, find the first agenda file."
16065 (interactive)
16066 (let* ((fs (org-agenda-files t))
16067 (files (append fs (list (car fs))))
16068 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16069 file)
16070 (unless files (error "No agenda files"))
16071 (catch 'exit
16072 (while (setq file (pop files))
16073 (if (equal (file-truename file) tcf)
16074 (when (car files)
16075 (find-file (car files))
16076 (throw 'exit t))))
16077 (find-file (car fs)))
16078 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16080 (defun org-agenda-file-to-front (&optional to-end)
16081 "Move/add the current file to the top of the agenda file list.
16082 If the file is not present in the list, it is added to the front. If it is
16083 present, it is moved there. With optional argument TO-END, add/move to the
16084 end of the list."
16085 (interactive "P")
16086 (let ((org-agenda-skip-unavailable-files nil)
16087 (file-alist (mapcar (lambda (x)
16088 (cons (file-truename x) x))
16089 (org-agenda-files t)))
16090 (ctf (file-truename buffer-file-name))
16091 x had)
16092 (setq x (assoc ctf file-alist) had x)
16094 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16095 (if to-end
16096 (setq file-alist (append (delq x file-alist) (list x)))
16097 (setq file-alist (cons x (delq x file-alist))))
16098 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16099 (org-install-agenda-files-menu)
16100 (message "File %s to %s of agenda file list"
16101 (if had "moved" "added") (if to-end "end" "front"))))
16103 (defun org-remove-file (&optional file)
16104 "Remove current file from the list of files in variable `org-agenda-files'.
16105 These are the files which are being checked for agenda entries.
16106 Optional argument FILE means use this file instead of the current."
16107 (interactive)
16108 (let* ((org-agenda-skip-unavailable-files nil)
16109 (file (or file buffer-file-name))
16110 (true-file (file-truename file))
16111 (afile (abbreviate-file-name file))
16112 (files (delq nil (mapcar
16113 (lambda (x)
16114 (if (equal true-file
16115 (file-truename x))
16116 nil x))
16117 (org-agenda-files t)))))
16118 (if (not (= (length files) (length (org-agenda-files t))))
16119 (progn
16120 (org-store-new-agenda-file-list files)
16121 (org-install-agenda-files-menu)
16122 (message "Removed file: %s" afile))
16123 (message "File was not in list: %s (not removed)" afile))))
16125 (defun org-file-menu-entry (file)
16126 (vector file (list 'find-file file) t))
16128 (defun org-check-agenda-file (file)
16129 "Make sure FILE exists. If not, ask user what to do."
16130 (when (not (file-exists-p file))
16131 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16132 (abbreviate-file-name file))
16133 (let ((r (downcase (read-char-exclusive))))
16134 (cond
16135 ((equal r ?r)
16136 (org-remove-file file)
16137 (throw 'nextfile t))
16138 (t (error "Abort"))))))
16140 (defun org-get-agenda-file-buffer (file)
16141 "Get a buffer visiting FILE. If the buffer needs to be created, add
16142 it to the list of buffers which might be released later."
16143 (let ((buf (org-find-base-buffer-visiting file)))
16144 (if buf
16145 buf ; just return it
16146 ;; Make a new buffer and remember it
16147 (setq buf (find-file-noselect file))
16148 (if buf (push buf org-agenda-new-buffers))
16149 buf)))
16151 (defun org-release-buffers (blist)
16152 "Release all buffers in list, asking the user for confirmation when needed.
16153 When a buffer is unmodified, it is just killed. When modified, it is saved
16154 \(if the user agrees) and then killed."
16155 (let (buf file)
16156 (while (setq buf (pop blist))
16157 (setq file (buffer-file-name buf))
16158 (when (and (buffer-modified-p buf)
16159 file
16160 (y-or-n-p (format "Save file %s? " file)))
16161 (with-current-buffer buf (save-buffer)))
16162 (kill-buffer buf))))
16164 (defun org-prepare-agenda-buffers (files)
16165 "Create buffers for all agenda files, protect archived trees and comments."
16166 (interactive)
16167 (let ((pa '(:org-archived t))
16168 (pc '(:org-comment t))
16169 (pall '(:org-archived t :org-comment t))
16170 (inhibit-read-only t)
16171 (rea (concat ":" org-archive-tag ":"))
16172 bmp file re)
16173 (save-excursion
16174 (save-restriction
16175 (while (setq file (pop files))
16176 (catch 'nextfile
16177 (if (bufferp file)
16178 (set-buffer file)
16179 (org-check-agenda-file file)
16180 (set-buffer (org-get-agenda-file-buffer file)))
16181 (widen)
16182 (setq bmp (buffer-modified-p))
16183 (org-refresh-category-properties)
16184 (setq org-todo-keywords-for-agenda
16185 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16186 (setq org-done-keywords-for-agenda
16187 (append org-done-keywords-for-agenda org-done-keywords))
16188 (setq org-todo-keyword-alist-for-agenda
16189 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16190 (setq org-drawers-for-agenda
16191 (append org-drawers-for-agenda org-drawers))
16192 (setq org-tag-alist-for-agenda
16193 (append org-tag-alist-for-agenda org-tag-alist))
16195 (save-excursion
16196 (remove-text-properties (point-min) (point-max) pall)
16197 (when org-agenda-skip-archived-trees
16198 (goto-char (point-min))
16199 (while (re-search-forward rea nil t)
16200 (if (org-on-heading-p t)
16201 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16202 (goto-char (point-min))
16204 (while (re-search-forward re nil t)
16205 (add-text-properties
16206 (match-beginning 0) (org-end-of-subtree t) pc)))
16207 (set-buffer-modified-p bmp)))))
16208 (setq org-todo-keywords-for-agenda
16209 (org-uniquify org-todo-keywords-for-agenda))
16210 (setq org-todo-keyword-alist-for-agenda
16211 (org-uniquify org-todo-keyword-alist-for-agenda)
16212 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16214 ;;;; Embedded LaTeX
16216 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16217 "Keymap for the minor `org-cdlatex-mode'.")
16219 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16220 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16221 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16222 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16223 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16225 (defvar org-cdlatex-texmathp-advice-is-done nil
16226 "Flag remembering if we have applied the advice to texmathp already.")
16228 (define-minor-mode org-cdlatex-mode
16229 "Toggle the minor `org-cdlatex-mode'.
16230 This mode supports entering LaTeX environment and math in LaTeX fragments
16231 in Org-mode.
16233 nil " OCDL" nil
16234 (when org-cdlatex-mode (require 'cdlatex))
16235 (unless org-cdlatex-texmathp-advice-is-done
16236 (setq org-cdlatex-texmathp-advice-is-done t)
16237 (defadvice texmathp (around org-math-always-on activate)
16238 "Always return t in org-mode buffers.
16239 This is because we want to insert math symbols without dollars even outside
16240 the LaTeX math segments. If Orgmode thinks that point is actually inside
16241 an embedded LaTeX fragment, let texmathp do its job.
16243 (interactive)
16244 (let (p)
16245 (cond
16246 ((not (org-mode-p)) ad-do-it)
16247 ((eq this-command 'cdlatex-math-symbol)
16248 (setq ad-return-value t
16249 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16250 (t
16251 (let ((p (org-inside-LaTeX-fragment-p)))
16252 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16253 (setq ad-return-value t
16254 texmathp-why '("Org-mode embedded math" . 0))
16255 (if p ad-do-it)))))))))
16257 (defun turn-on-org-cdlatex ()
16258 "Unconditionally turn on `org-cdlatex-mode'."
16259 (org-cdlatex-mode 1))
16261 (defun org-inside-LaTeX-fragment-p ()
16262 "Test if point is inside a LaTeX fragment.
16264 sequence appearing also before point.
16265 Even though the matchers for math are configurable, this function assumes
16267 delimiters are skipped when they have been removed by customization.
16268 The return value is nil, or a cons cell with the delimiter and the
16269 position of this delimiter.
16271 This function does a reasonably good job, but can locally be fooled by
16272 for example currency specifications. For example it will assume being in
16274 fragments that are properly closed, but during editing, we have to live
16275 with the uncertainty caused by missing closing delimiters. This function
16276 looks only before point, not after."
16277 (catch 'exit
16278 (let ((pos (point))
16279 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16280 (lim (progn
16282 (point)))
16283 dd-on str (start 0) m re)
16284 (goto-char pos)
16285 (when dodollar
16287 re (nth 1 (assoc "$" org-latex-regexps)))
16288 (while (string-match re str start)
16289 (cond
16290 ((= (match-end 0) (length str))
16291 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16292 ((= (match-end 0) (- (length str) 5))
16293 (throw 'exit nil))
16294 (t (setq start (match-end 0))))))
16295 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16296 (goto-char pos)
16297 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16298 (and (match-beginning 2) (throw 'exit nil))
16299 ;; count $$
16301 (setq dd-on (not dd-on)))
16302 (goto-char pos)
16303 (if dd-on (cons "$$" m))))))
16305 (defun org-inside-latex-macro-p ()
16306 "Is point inside a LaTeX macro or its arguments?"
16307 (save-match-data
16308 (org-in-regexp
16311 (defun org-try-cdlatex-tab ()
16312 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16313 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16314 - inside a LaTeX fragment, or
16315 - after the first word in a line, where an abbreviation expansion could
16316 insert a LaTeX environment."
16317 (when org-cdlatex-mode
16318 (cond
16319 ((save-excursion
16320 (skip-chars-backward "a-zA-Z0-9*")
16322 (bolp))
16323 (cdlatex-tab) t)
16324 ((org-inside-LaTeX-fragment-p)
16325 (cdlatex-tab) t)
16326 (t nil))))
16328 (defun org-cdlatex-underscore-caret (&optional arg)
16329 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16330 Revert to the normal definition outside of these fragments."
16331 (interactive "P")
16332 (if (org-inside-LaTeX-fragment-p)
16333 (call-interactively 'cdlatex-sub-superscript)
16334 (let (org-cdlatex-mode)
16335 (call-interactively (key-binding (vector last-input-event))))))
16337 (defun org-cdlatex-math-modify (&optional arg)
16338 "Execute `cdlatex-math-modify' in LaTeX fragments.
16339 Revert to the normal definition outside of these fragments."
16340 (interactive "P")
16341 (if (org-inside-LaTeX-fragment-p)
16342 (call-interactively 'cdlatex-math-modify)
16343 (let (org-cdlatex-mode)
16344 (call-interactively (key-binding (vector last-input-event))))))
16346 (defvar org-latex-fragment-image-overlays nil
16347 "List of overlays carrying the images of latex fragments.")
16348 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16350 (defun org-remove-latex-fragment-image-overlays ()
16351 "Remove all overlays with LaTeX fragment images in current buffer."
16352 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16353 (setq org-latex-fragment-image-overlays nil))
16355 (defun org-preview-latex-fragment (&optional subtree)
16356 "Preview the LaTeX fragment at point, or all locally or globally.
16357 If the cursor is in a LaTeX fragment, create the image and overlay
16358 it over the source code. If there is no fragment at point, display
16359 all fragments in the current text, from one headline to the next. With
16360 prefix SUBTREE, display all fragments in the current subtree. With a
16362 the cursor is before the first headline,
16363 display all fragments in the buffer.
16365 (interactive "P")
16366 (org-remove-latex-fragment-image-overlays)
16367 (save-excursion
16368 (save-restriction
16369 (let (beg end at msg)
16370 (cond
16371 ((or (equal subtree '(16))
16372 (not (save-excursion
16373 (re-search-backward org-outline-regexp-bol nil t))))
16374 (setq beg (point-min) end (point-max)
16375 msg "Creating images for buffer...%s"))
16376 ((equal subtree '(4))
16377 (org-back-to-heading)
16378 (setq beg (point) end (org-end-of-subtree t)
16379 msg "Creating images for subtree...%s"))
16380 (t
16381 (if (setq at (org-inside-LaTeX-fragment-p))
16382 (goto-char (max (point-min) (- (cdr at) 2)))
16383 (org-back-to-heading))
16384 (setq beg (point) end (progn (outline-next-heading) (point))
16385 msg (if at "Creating image...%s"
16386 "Creating images for entry...%s"))))
16387 (message msg "")
16388 (narrow-to-region beg end)
16389 (goto-char beg)
16390 (org-format-latex
16391 (concat "ltxpng/" (file-name-sans-extension
16392 (file-name-nondirectory
16393 buffer-file-name)))
16394 default-directory 'overlays msg at 'forbuffer 'dvipng)
16395 (message msg "done. Use `C-c C-c' to remove images.")))))
16397 (defvar org-latex-regexps
16399 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16402 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16406 "Regular expressions for matching embedded LaTeX.")
16408 (defvar org-export-have-math nil) ;; dynamic scoping
16409 (defun org-format-latex (prefix &optional dir overlays msg at
16410 forbuffer processing-type)
16411 "Replace LaTeX fragments with links to an image, and produce images.
16412 Some of the options can be changed using the variable
16413 `org-format-latex-options'."
16414 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16415 (let* ((prefixnodir (file-name-nondirectory prefix))
16416 (absprefix (expand-file-name prefix dir))
16417 (todir (file-name-directory absprefix))
16418 (opt org-format-latex-options)
16419 (matchers (plist-get opt :matchers))
16420 (re-list org-latex-regexps)
16421 (org-format-latex-header-extra
16422 (plist-get (org-infile-export-plist) :latex-header-extra))
16423 (cnt 0) txt hash link beg end re e checkdir
16424 executables-checked string
16425 m n block linkfile movefile ov)
16426 ;; Check the different regular expressions
16427 (while (setq e (pop re-list))
16428 (setq m (car e) re (nth 1 e) n (nth 2 e)
16430 (when (member m matchers)
16431 (goto-char (point-min))
16432 (while (re-search-forward re nil t)
16433 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16434 (not (get-text-property (match-beginning n)
16435 'org-protected))
16436 (or (not overlays)
16437 (not (eq (get-char-property (match-beginning n)
16438 'org-overlay-type)
16439 'org-latex-overlay))))
16440 (setq org-export-have-math t)
16441 (cond
16442 ((eq processing-type 'verbatim)
16443 ;; Leave the text verbatim, just protect it
16444 (add-text-properties (match-beginning n) (match-end n)
16445 '(org-protected t)))
16446 ((eq processing-type 'mathjax)
16447 ;; Prepare for MathJax processing
16448 (setq string (match-string n))
16449 (if (member m '("$" "$1"))
16450 (save-excursion
16451 (delete-region (match-beginning n) (match-end n))
16452 (goto-char (match-beginning n))
16455 '(org-protected t))))
16456 (add-text-properties (match-beginning n) (match-end n)
16457 '(org-protected t))))
16458 ((or (eq processing-type 'dvipng) t)
16459 ;; Process to an image
16460 (setq txt (match-string n)
16461 beg (match-beginning n) end (match-end n)
16462 cnt (1+ cnt))
16463 (let (print-length print-level) ; make sure full list is printed
16464 (setq hash (sha1 (prin1-to-string
16465 (list org-format-latex-header
16466 org-format-latex-header-extra
16467 org-export-latex-default-packages-alist
16468 org-export-latex-packages-alist
16469 org-format-latex-options
16470 forbuffer txt)))
16471 linkfile (format "%s_%s.png" prefix hash)
16472 movefile (format "%s_%s.png" absprefix hash)))
16473 (setq link (concat block "[[file:" linkfile "]]" block))
16474 (if msg (message msg cnt))
16475 (goto-char beg)
16476 (unless checkdir ; make sure the directory exists
16477 (setq checkdir t)
16478 (or (file-directory-p todir) (make-directory todir t)))
16480 (unless executables-checked
16481 (org-check-external-command
16482 "latex" "needed to convert LaTeX fragments to images")
16483 (org-check-external-command
16484 "dvipng" "needed to convert LaTeX fragments to images")
16485 (setq executables-checked t))
16487 (unless (file-exists-p movefile)
16488 (org-create-formula-image
16489 txt movefile opt forbuffer))
16490 (if overlays
16491 (progn
16492 (mapc (lambda (o)
16493 (if (eq (overlay-get o 'org-overlay-type)
16494 'org-latex-overlay)
16495 (delete-overlay o)))
16496 (overlays-in beg end))
16497 (setq ov (make-overlay beg end))
16498 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16499 (if (featurep 'xemacs)
16500 (progn
16501 (overlay-put ov 'invisible t)
16502 (overlay-put
16503 ov 'end-glyph
16504 (make-glyph (vector 'png :file movefile))))
16505 (overlay-put
16506 ov 'display
16507 (list 'image :type 'png :file movefile :ascent 'center)))
16508 (push ov org-latex-fragment-image-overlays)
16509 (goto-char end))
16510 (delete-region beg end)
16511 (insert (org-add-props link
16512 (list 'org-latex-src
16513 (replace-regexp-in-string
16516 ;; This function borrows from Ganesh Swami's latex2png.el
16517 (defun org-create-formula-image (string tofile options buffer)
16518 "This calls dvipng."
16519 (require 'org-latex)
16520 (let* ((tmpdir (if (featurep 'xemacs)
16521 (temp-directory)
16522 temporary-file-directory))
16523 (texfilebase (make-temp-name
16524 (expand-file-name "orgtex" tmpdir)))
16525 (texfile (concat texfilebase ".tex"))
16526 (dvifile (concat texfilebase ".dvi"))
16527 (pngfile (concat texfilebase ".png"))
16528 (fnh (if (featurep 'xemacs)
16529 (font-height (get-face-font 'default))
16530 (face-attribute 'default :height nil)))
16531 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16532 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16533 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16534 "Black"))
16535 (bg (or (plist-get options (if buffer :background :html-background))
16536 "Transparent")))
16537 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16538 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16539 (with-temp-file texfile
16540 (insert (org-splice-latex-header
16541 org-format-latex-header
16542 org-export-latex-default-packages-alist
16543 org-export-latex-packages-alist t
16544 org-format-latex-header-extra))
16546 (require 'org-latex)
16547 (org-export-latex-fix-inputenc))
16548 (let ((dir default-directory))
16549 (condition-case nil
16550 (progn
16551 (cd tmpdir)
16552 (call-process "latex" nil nil nil texfile))
16553 (error nil))
16554 (cd dir))
16555 (if (not (file-exists-p dvifile))
16556 (progn (message "Failed to create dvi file from %s" texfile) nil)
16557 (condition-case nil
16558 (call-process "dvipng" nil nil nil
16559 "-fg" fg "-bg" bg
16560 "-D" dpi
16561 ;;"-x" scale "-y" scale
16562 "-T" "tight"
16563 "-o" pngfile
16564 dvifile)
16565 (error nil))
16566 (if (not (file-exists-p pngfile))
16567 (if org-format-latex-signal-error
16568 (error "Failed to create png file from %s" texfile)
16569 (message "Failed to create png file from %s" texfile)
16570 nil)
16571 ;; Use the requested file name and clean up
16572 (copy-file pngfile tofile 'replace)
16573 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16574 (delete-file (concat texfilebase e)))
16575 pngfile))))
16577 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16578 "Fill a LaTeX header template TPL.
16579 In the template, the following place holders will be recognized:
16582 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16584 [NO-PACKAGES] do not include PKG
16585 [EXTRA] the string EXTRA
16586 [NO-EXTRA] do not include EXTRA
16588 For backward compatibility, if both the positive and the negative place
16590 assumed to be present at the end of the template.
16591 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16592 EXTRA is a string.
16593 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16594 (let (rpl (end ""))
16596 (setq rpl (if (or (match-end 1) (not def-pkg))
16597 "" (org-latex-packages-to-string def-pkg snippets-p t))
16598 tpl (replace-match rpl t t tpl))
16599 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16602 (setq rpl (if (or (match-end 1) (not pkg))
16603 "" (org-latex-packages-to-string pkg snippets-p t))
16604 tpl (replace-match rpl t t tpl))
16605 (if pkg (setq end
16607 (org-latex-packages-to-string pkg snippets-p)))))
16610 (setq rpl (if (or (match-end 1) (not extra))
16612 tpl (replace-match rpl t t tpl))
16618 tpl)))
16620 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16622 (setq pkg (mapconcat (lambda(p)
16623 (cond
16624 ((stringp p) p)
16625 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16626 (format "%% Package %s omitted" (cadr p)))
16627 ((equal "" (car p))
16629 (t
16631 (car p) (cadr p)))))
16632 pkg
16636 (defun org-dvipng-color (attr)
16637 "Return an rgb color specification for dvipng."
16638 (apply 'format "rgb %s %s %s"
16639 (mapcar 'org-normalize-color
16640 (color-values (face-attribute 'default attr nil)))))
16642 (defun org-normalize-color (value)
16643 "Return string to be used as color value for an RGB component."
16644 (format "%g" (/ value 65535.0)))
16646 ;; Image display
16649 (defvar org-inline-image-overlays nil)
16650 (make-variable-buffer-local 'org-inline-image-overlays)
16652 (defun org-toggle-inline-images (&optional include-linked)
16653 "Toggle the display of inline images.
16654 INCLUDE-LINKED is passed to `org-display-inline-images'."
16655 (interactive "P")
16656 (if org-inline-image-overlays
16657 (progn
16658 (org-remove-inline-images)
16659 (message "Inline image display turned off"))
16660 (org-display-inline-images include-linked)
16661 (if org-inline-image-overlays
16662 (message "%d images displayed inline"
16663 (length org-inline-image-overlays))
16664 (message "No images to display inline"))))
16666 (defun org-display-inline-images (&optional include-linked refresh beg end)
16667 "Display inline images.
16668 Normally only links without a description part are inlined, because this
16669 is how it will work for export. When INCLUDE-LINKED is set, also links
16670 with a description part will be inlined. This can be nice for a quick
16671 look at those images, but it does not reflect what exported files will look
16672 like.
16673 When REFRESH is set, refresh existing images between BEG and END.
16674 This will create new image displays only if necessary.
16675 BEG and END default to the buffer boundaries."
16676 (interactive "P")
16677 (unless refresh
16678 (org-remove-inline-images)
16679 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16680 (save-excursion
16681 (save-restriction
16682 (widen)
16683 (setq beg (or beg (point-min)) end (or end (point-max)))
16684 (goto-char (point-min))
16686 (substring (org-image-file-name-regexp) 0 -2)
16688 old file ov img)
16689 (while (re-search-forward re end t)
16690 (setq old (get-char-property-and-overlay (match-beginning 1)
16691 'org-image-overlay))
16692 (setq file (expand-file-name
16693 (concat (or (match-string 3) "") (match-string 4))))
16694 (when (file-exists-p file)
16695 (if (and (car-safe old) refresh)
16696 (image-refresh (overlay-get (cdr old) 'display))
16697 (setq img (save-match-data (create-image file)))
16698 (when img
16699 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16700 (overlay-put ov 'display img)
16701 (overlay-put ov 'face 'default)
16702 (overlay-put ov 'org-image-overlay t)
16703 (overlay-put ov 'modification-hooks
16704 (list 'org-display-inline-modification-hook))
16705 (push ov org-inline-image-overlays)))))))))
16707 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16708 "Remove inline-display overlay if a corresponding region is modified."
16709 (let ((inhibit-modification-hooks t))
16710 (when (and ov after)
16711 (delete ov org-inline-image-overlays)
16712 (delete-overlay ov))))
16714 (defun org-remove-inline-images ()
16715 "Remove inline display of images."
16716 (interactive)
16717 (mapc 'delete-overlay org-inline-image-overlays)
16718 (setq org-inline-image-overlays nil))
16720 ;;;; Key bindings
16722 ;; Make `C-c C-x' a prefix key
16723 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16725 ;; TAB key with modifiers
16726 (org-defkey org-mode-map "\C-i" 'org-cycle)
16727 (org-defkey org-mode-map [(tab)] 'org-cycle)
16728 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16729 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16731 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16732 ;; The following line is necessary under Suse GNU/Linux
16733 (unless (featurep 'xemacs)
16734 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16735 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16736 (define-key org-mode-map [backtab] 'org-shifttab)
16738 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16739 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16740 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16742 ;; Cursor keys with modifiers
16743 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16744 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16745 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16746 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16748 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16749 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16750 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16751 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16753 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16754 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16755 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16756 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16758 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16759 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16760 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16761 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16763 ;; Babel keys
16764 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16765 (mapc (lambda (pair)
16766 (define-key org-babel-map (car pair) (cdr pair)))
16767 org-babel-key-bindings)
16769 ;;; Extra keys for tty access.
16770 ;; We only set them when really needed because otherwise the
16771 ;; menus don't show the simple keys
16773 (when (or org-use-extra-keys
16774 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16775 (not window-system))
16776 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16777 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16778 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16779 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16780 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16781 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16782 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16783 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16784 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16785 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16786 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16787 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16788 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16789 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16790 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16791 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16792 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16793 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16794 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16795 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16796 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16797 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16798 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16799 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16800 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16801 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16802 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16803 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16805 ;; All the other keys
16807 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16808 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16809 (if (boundp 'narrow-map)
16810 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16811 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16812 (if (boundp 'narrow-map)
16813 (org-defkey narrow-map "b" 'org-narrow-to-block)
16814 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16815 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16816 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16817 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16818 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16819 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16820 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16821 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16822 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16823 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16824 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16825 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16826 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16827 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16828 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16829 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16830 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16832 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16833 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16834 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16835 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16836 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16837 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16838 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16839 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16840 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16841 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16842 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16843 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16844 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16845 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16846 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16847 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16848 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16849 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16850 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16851 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16853 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16854 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16855 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16856 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16857 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16858 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16859 (org-defkey org-mode-map "\C-c^" 'org-sort)
16860 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16861 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16862 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16863 (org-defkey org-mode-map "\C-m" 'org-return)
16864 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16865 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16866 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16867 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16868 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16869 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16870 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16871 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16872 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16873 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16874 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16875 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16876 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16877 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16878 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16879 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16880 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16881 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16882 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16883 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16884 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16885 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16887 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16888 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16889 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16890 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16892 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16893 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16894 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16895 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16896 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16897 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16898 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16899 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16900 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16901 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16903 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16904 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16905 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16906 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16907 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16908 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16909 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16911 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16912 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16913 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16914 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16915 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16917 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16919 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16921 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16922 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16924 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16927 (when (featurep 'xemacs)
16928 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16931 (defconst org-speed-commands-default
16932 '(
16933 ("Outline Navigation")
16934 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16935 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16936 ("f" . (org-speed-move-safe 'org-forward-same-level))
16937 ("b" . (org-speed-move-safe 'org-backward-same-level))
16938 ("u" . (org-speed-move-safe 'outline-up-heading))
16939 ("j" . org-goto)
16940 ("g" . (org-refile t))
16941 ("Outline Visibility")
16942 ("c" . org-cycle)
16943 ("C" . org-shifttab)
16944 (" " . org-display-outline-path)
16945 ("Outline Structure Editing")
16946 ("U" . org-shiftmetaup)
16947 ("D" . org-shiftmetadown)
16948 ("r" . org-metaright)
16949 ("l" . org-metaleft)
16950 ("R" . org-shiftmetaright)
16951 ("L" . org-shiftmetaleft)
16952 ("i" . (progn (forward-char 1) (call-interactively
16953 'org-insert-heading-respect-content)))
16954 ("^" . org-sort)
16955 ("w" . org-refile)
16956 ("a" . org-archive-subtree-default-with-confirmation)
16957 ("." . org-mark-subtree)
16958 ("Clock Commands")
16959 ("I" . org-clock-in)
16960 ("O" . org-clock-out)
16961 ("Meta Data Editing")
16962 ("t" . org-todo)
16963 ("0" . (org-priority ?\ ))
16964 ("1" . (org-priority ?A))
16965 ("2" . (org-priority ?B))
16966 ("3" . (org-priority ?C))
16967 (";" . org-set-tags-command)
16968 ("e" . org-set-effort)
16969 ("Agenda Views etc")
16970 ("v" . org-agenda)
16971 ("/" . org-sparse-tree)
16972 ("Misc")
16973 ("o" . org-open-at-point)
16974 ("?" . org-speed-command-help)
16975 ("<" . (org-agenda-set-restriction-lock 'subtree))
16976 (">" . (org-agenda-remove-restriction-lock))
16977 )
16978 "The default speed commands.")
16980 (defun org-print-speed-command (e)
16981 (if (> (length (car e)) 1)
16982 (progn
16984 (princ (car e))
16986 (princ (make-string (length (car e)) ?-))
16988 (princ (car e))
16989 (princ " ")
16990 (if (symbolp (cdr e))
16991 (princ (symbol-name (cdr e)))
16992 (prin1 (cdr e)))
16995 (defun org-speed-command-help ()
16996 "Show the available speed commands."
16997 (interactive)
16998 (if (not org-use-speed-commands)
16999 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17000 (with-output-to-temp-buffer "*Help*"
17002 (mapc 'org-print-speed-command org-speed-commands-user)
17005 (mapc 'org-print-speed-command org-speed-commands-default))
17006 (with-current-buffer "*Help*"
17007 (setq truncate-lines t))))
17009 (defun org-speed-move-safe (cmd)
17010 "Execute CMD, but make sure that the cursor always ends up in a headline.
17011 If not, return to the original position and throw an error."
17012 (interactive)
17013 (let ((pos (point)))
17014 (call-interactively cmd)
17015 (unless (and (bolp) (org-on-heading-p))
17016 (goto-char pos)
17017 (error "Boundary reached while executing %s" cmd))))
17019 (defvar org-self-insert-command-undo-counter 0)
17021 (defvar org-table-auto-blank-field) ; defined in org-table.el
17022 (defvar org-speed-command nil)
17024 (defun org-speed-command-default-hook (keys)
17025 "Hook for activating single-letter speed commands.
17026 `org-speed-commands-default' specifies a minimal command set. Use
17027 `org-speed-commands-user' for further customization."
17028 (when (or (and (bolp) (looking-at org-outline-regexp))
17029 (and (functionp org-use-speed-commands)
17030 (funcall org-use-speed-commands)))
17031 (cdr (assoc keys (append org-speed-commands-user
17032 org-speed-commands-default)))))
17034 (defun org-babel-speed-command-hook (keys)
17035 "Hook for activating single-letter code block commands."
17036 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17037 (cdr (assoc keys org-babel-key-bindings))))
17039 (defcustom org-speed-command-hook
17040 '(org-speed-command-default-hook org-babel-speed-command-hook)
17041 "Hook for activating speed commands at strategic locations.
17042 Hook functions are called in sequence until a valid handler is
17043 found.
17045 Each hook takes a single argument, a user-pressed command key
17046 which is also a `self-insert-command' from the global map.
17048 Within the hook, examine the cursor position and the command key
17049 and return nil or a valid handler as appropriate. Handler could
17050 be one of an interactive command, a function, or a form.
17052 Set `org-use-speed-commands' to non-nil value to enable this
17053 hook. The default setting is `org-speed-command-default-hook'."
17054 :group 'org-structure
17055 :type 'hook)
17057 (defun org-self-insert-command (N)
17058 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17059 If the cursor is in a table looking at whitespace, the whitespace is
17060 overwritten, and the table is not marked as requiring realignment."
17061 (interactive "p")
17062 (cond
17063 ((and org-use-speed-commands
17064 (setq org-speed-command
17065 (run-hook-with-args-until-success
17066 'org-speed-command-hook (this-command-keys))))
17067 (cond
17068 ((commandp org-speed-command)
17069 (setq this-command org-speed-command)
17070 (call-interactively org-speed-command))
17071 ((functionp org-speed-command)
17072 (funcall org-speed-command))
17073 ((and org-speed-command (listp org-speed-command))
17074 (eval org-speed-command))
17075 (t (let (org-use-speed-commands)
17076 (call-interactively 'org-self-insert-command)))))
17077 ((and
17078 (org-table-p)
17079 (progn
17080 ;; check if we blank the field, and if that triggers align
17081 (and (featurep 'org-table) org-table-auto-blank-field
17082 (member last-command
17083 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17085 ;; got extra space, this field does not determine column width
17086 (let (org-table-may-need-update) (org-table-blank-field))
17087 ;; no extra space, this field may determine column width
17088 (org-table-blank-field)))
17089 t)
17090 (eq N 1)
17092 (let (org-table-may-need-update)
17093 (goto-char (1- (match-end 0)))
17094 (delete-char -1)
17095 (goto-char (match-beginning 0))
17096 (self-insert-command N)))
17097 (t
17098 (setq org-table-may-need-update t)
17099 (self-insert-command N)
17100 (org-fix-tags-on-the-fly)
17101 (if org-self-insert-cluster-for-undo
17102 (if (not (eq last-command 'org-self-insert-command))
17103 (setq org-self-insert-command-undo-counter 1)
17104 (if (>= org-self-insert-command-undo-counter 20)
17105 (setq org-self-insert-command-undo-counter 1)
17106 (and (> org-self-insert-command-undo-counter 0)
17107 buffer-undo-list (listp buffer-undo-list)
17108 (not (cadr buffer-undo-list)) ; remove nil entry
17109 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17110 (setq org-self-insert-command-undo-counter
17111 (1+ org-self-insert-command-undo-counter))))))))
17113 (defun org-fix-tags-on-the-fly ()
17114 (when (and (equal (char-after (point-at-bol)) ?*)
17115 (org-on-heading-p))
17116 (org-align-tags-here org-tags-column)))
17118 (defun org-delete-backward-char (N)
17119 "Like `delete-backward-char', insert whitespace at field end in tables.
17120 When deleting backwards, in tables this function will insert whitespace in
17122 still be marked for re-alignment if the field did fill the entire column,
17123 because, in this case the deletion might narrow the column."
17124 (interactive "p")
17125 (if (and (org-table-p)
17126 (eq N 1)
17127 (string-match "|" (buffer-substring (point-at-bol) (point)))
17128 (looking-at ".*?|"))
17129 (let ((pos (point))
17131 (c org-table-may-need-update))
17132 (backward-delete-char N)
17133 (if (not overwrite-mode)
17134 (progn
17135 (skip-chars-forward "^|")
17136 (insert " ")
17137 (goto-char (1- pos))))
17138 ;; noalign: if there were two spaces at the end, this field
17139 ;; does not determine the width of the column.
17140 (if noalign (setq org-table-may-need-update c)))
17141 (backward-delete-char N)
17142 (org-fix-tags-on-the-fly)))
17144 (defun org-delete-char (N)
17145 "Like `delete-char', but insert whitespace at field end in tables.
17146 When deleting characters, in tables this function will insert whitespace in
17148 still be marked for re-alignment if the field did fill the entire column,
17149 because, in this case the deletion might narrow the column."
17150 (interactive "p")
17151 (if (and (org-table-p)
17152 (not (bolp))
17153 (not (= (char-after) ?|))
17154 (eq N 1))
17155 (if (looking-at ".*?|")
17156 (let ((pos (point))
17158 (c org-table-may-need-update))
17159 (replace-match (concat
17160 (substring (match-string 0) 1 -1)
17161 " |"))
17162 (goto-char pos)
17163 ;; noalign: if there were two spaces at the end, this field
17164 ;; does not determine the width of the column.
17165 (if noalign (setq org-table-may-need-update c)))
17166 (delete-char N))
17167 (delete-char N)
17168 (org-fix-tags-on-the-fly)))
17170 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17171 (put 'org-self-insert-command 'delete-selection t)
17172 (put 'orgtbl-self-insert-command 'delete-selection t)
17173 (put 'org-delete-char 'delete-selection 'supersede)
17174 (put 'org-delete-backward-char 'delete-selection 'supersede)
17175 (put 'org-yank 'delete-selection 'yank)
17177 ;; Make `flyspell-mode' delay after some commands
17178 (put 'org-self-insert-command 'flyspell-delayed t)
17179 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17180 (put 'org-delete-char 'flyspell-delayed t)
17181 (put 'org-delete-backward-char 'flyspell-delayed t)
17183 ;; Make pabbrev-mode expand after org-mode commands
17184 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17185 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17187 ;; How to do this: Measure non-white length of current string
17188 ;; If equal to column width, we should realign.
17190 (defun org-remap (map &rest commands)
17191 "In MAP, remap the functions given in COMMANDS.
17192 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17193 (let (new old)
17194 (while commands
17195 (setq old (pop commands) new (pop commands))
17196 (if (fboundp 'command-remapping)
17197 (org-defkey map (vector 'remap old) new)
17198 (substitute-key-definition old new map global-map)))))
17200 (when (eq org-enable-table-editor 'optimized)
17201 ;; If the user wants maximum table support, we need to hijack
17202 ;; some standard editing functions
17203 (org-remap org-mode-map
17204 'self-insert-command 'org-self-insert-command
17205 'delete-char 'org-delete-char
17206 'delete-backward-char 'org-delete-backward-char)
17207 (org-defkey org-mode-map "|" 'org-force-self-insert))
17209 (defvar org-ctrl-c-ctrl-c-hook nil
17210 "Hook for functions attaching themselves to `C-c C-c'.
17212 This can be used to add additional functionality to the C-c C-c
17213 key which executes context-dependent commands. This hook is run
17214 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17215 run after the last test.
17217 Each function will be called with no arguments. The function
17218 must check if the context is appropriate for it to act. If yes,
17219 it should do its thing and then return a non-nil value. If the
17220 context is wrong, just do nothing and return nil.")
17222 (defvar org-ctrl-c-ctrl-c-final-hook nil
17223 "Hook for functions attaching themselves to `C-c C-c'.
17225 This can be used to add additional functionality to the C-c C-c
17226 key which executes context-dependent commands. This hook is run
17227 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17228 before the first test.
17230 Each function will be called with no arguments. The function
17231 must check if the context is appropriate for it to act. If yes,
17232 it should do its thing and then return a non-nil value. If the
17233 context is wrong, just do nothing and return nil.")
17235 (defvar org-tab-first-hook nil
17236 "Hook for functions to attach themselves to TAB.
17237 See `org-ctrl-c-ctrl-c-hook' for more information.
17238 This hook runs as the first action when TAB is pressed, even before
17239 `org-cycle' messes around with the `outline-regexp' to cater for
17240 inline tasks and plain list item folding.
17241 If any function in this hook returns t, any other actions that
17242 would have been caused by TAB (such as table field motion or visibility
17243 cycling) will not occur.")
17245 (defvar org-tab-after-check-for-table-hook nil
17246 "Hook for functions to attach themselves to TAB.
17247 See `org-ctrl-c-ctrl-c-hook' for more information.
17248 This hook runs after it has been established that the cursor is not in a
17249 table, but before checking if the cursor is in a headline or if global cycling
17250 should be done.
17251 If any function in this hook returns t, not other actions like visibility
17252 cycling will be done.")
17254 (defvar org-tab-after-check-for-cycling-hook nil
17255 "Hook for functions to attach themselves to TAB.
17256 See `org-ctrl-c-ctrl-c-hook' for more information.
17257 This hook runs after it has been established that not table field motion and
17258 not visibility should be done because of current context. This is probably
17259 the place where a package like yasnippets can hook in.")
17261 (defvar org-tab-before-tab-emulation-hook nil
17262 "Hook for functions to attach themselves to TAB.
17263 See `org-ctrl-c-ctrl-c-hook' for more information.
17264 This hook runs after every other options for TAB have been exhausted, but
17267 (defvar org-metaleft-hook nil
17268 "Hook for functions attaching themselves to `M-left'.
17269 See `org-ctrl-c-ctrl-c-hook' for more information.")
17270 (defvar org-metaright-hook nil
17271 "Hook for functions attaching themselves to `M-right'.
17272 See `org-ctrl-c-ctrl-c-hook' for more information.")
17273 (defvar org-metaup-hook nil
17274 "Hook for functions attaching themselves to `M-up'.
17275 See `org-ctrl-c-ctrl-c-hook' for more information.")
17276 (defvar org-metadown-hook nil
17277 "Hook for functions attaching themselves to `M-down'.
17278 See `org-ctrl-c-ctrl-c-hook' for more information.")
17279 (defvar org-shiftmetaleft-hook nil
17280 "Hook for functions attaching themselves to `M-S-left'.
17281 See `org-ctrl-c-ctrl-c-hook' for more information.")
17282 (defvar org-shiftmetaright-hook nil
17283 "Hook for functions attaching themselves to `M-S-right'.
17284 See `org-ctrl-c-ctrl-c-hook' for more information.")
17285 (defvar org-shiftmetaup-hook nil
17286 "Hook for functions attaching themselves to `M-S-up'.
17287 See `org-ctrl-c-ctrl-c-hook' for more information.")
17288 (defvar org-shiftmetadown-hook nil
17289 "Hook for functions attaching themselves to `M-S-down'.
17290 See `org-ctrl-c-ctrl-c-hook' for more information.")
17291 (defvar org-metareturn-hook nil
17292 "Hook for functions attaching themselves to `M-RET'.
17293 See `org-ctrl-c-ctrl-c-hook' for more information.")
17294 (defvar org-shiftup-hook nil
17295 "Hook for functions attaching themselves to `S-up'.
17296 See `org-ctrl-c-ctrl-c-hook' for more information.")
17297 (defvar org-shiftup-final-hook nil
17298 "Hook for functions attaching themselves to `S-up'.
17299 This one runs after all other options except shift-select have been excluded.
17300 See `org-ctrl-c-ctrl-c-hook' for more information.")
17301 (defvar org-shiftdown-hook nil
17302 "Hook for functions attaching themselves to `S-down'.
17303 See `org-ctrl-c-ctrl-c-hook' for more information.")
17304 (defvar org-shiftdown-final-hook nil
17305 "Hook for functions attaching themselves to `S-down'.
17306 This one runs after all other options except shift-select have been excluded.
17307 See `org-ctrl-c-ctrl-c-hook' for more information.")
17308 (defvar org-shiftleft-hook nil
17309 "Hook for functions attaching themselves to `S-left'.
17310 See `org-ctrl-c-ctrl-c-hook' for more information.")
17311 (defvar org-shiftleft-final-hook nil
17312 "Hook for functions attaching themselves to `S-left'.
17313 This one runs after all other options except shift-select have been excluded.
17314 See `org-ctrl-c-ctrl-c-hook' for more information.")
17315 (defvar org-shiftright-hook nil
17316 "Hook for functions attaching themselves to `S-right'.
17317 See `org-ctrl-c-ctrl-c-hook' for more information.")
17318 (defvar org-shiftright-final-hook nil
17319 "Hook for functions attaching themselves to `S-right'.
17320 This one runs after all other options except shift-select have been excluded.
17321 See `org-ctrl-c-ctrl-c-hook' for more information.")
17323 (defun org-modifier-cursor-error ()
17324 "Throw an error, a modified cursor command was applied in wrong context."
17325 (error "This command is active in special context like tables, headlines or items"))
17327 (defun org-shiftselect-error ()
17328 "Throw an error because Shift-Cursor command was applied in wrong context."
17329 (if (and (boundp 'shift-select-mode) shift-select-mode)
17330 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17331 (error "This command works only in special context like headlines or timestamps")))
17333 (defun org-call-for-shift-select (cmd)
17334 (let ((this-command-keys-shift-translated t))
17335 (call-interactively cmd)))
17337 (defun org-shifttab (&optional arg)
17338 "Global visibility cycling or move to previous table field.
17339 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17340 on context.
17341 See the individual commands for more information."
17342 (interactive "P")
17343 (cond
17344 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17345 ((integerp arg)
17346 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17347 (message "Content view to level: %d" arg)
17348 (org-content (prefix-numeric-value arg2))
17349 (setq org-cycle-global-status 'overview)))
17350 (t (call-interactively 'org-global-cycle))))
17352 (defun org-shiftmetaleft ()
17353 "Promote subtree or delete table column.
17354 Calls `org-promote-subtree', `org-outdent-item',
17355 or `org-table-delete-column', depending on context.
17356 See the individual commands for more information."
17357 (interactive)
17358 (cond
17359 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17360 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17361 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17362 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17363 (t (org-modifier-cursor-error))))
17365 (defun org-shiftmetaright ()
17366 "Demote subtree or insert table column.
17367 Calls `org-demote-subtree', `org-indent-item',
17368 or `org-table-insert-column', depending on context.
17369 See the individual commands for more information."
17370 (interactive)
17371 (cond
17372 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17373 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17374 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17375 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17376 (t (org-modifier-cursor-error))))
17378 (defun org-shiftmetaup (&optional arg)
17379 "Move subtree up or kill table row.
17380 Calls `org-move-subtree-up' or `org-table-kill-row' or
17381 `org-move-item-up' depending on context. See the individual commands
17382 for more information."
17383 (interactive "P")
17384 (cond
17385 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17386 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17387 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17388 ((org-at-item-p) (call-interactively 'org-move-item-up))
17389 (t (org-modifier-cursor-error))))
17391 (defun org-shiftmetadown (&optional arg)
17392 "Move subtree down or insert table row.
17393 Calls `org-move-subtree-down' or `org-table-insert-row' or
17394 `org-move-item-down', depending on context. See the individual
17395 commands for more information."
17396 (interactive "P")
17397 (cond
17398 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17399 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17400 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17401 ((org-at-item-p) (call-interactively 'org-move-item-down))
17402 (t (org-modifier-cursor-error))))
17404 (defsubst org-hidden-tree-error ()
17405 (error
17406 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17408 (defun org-metaleft (&optional arg)
17409 "Promote heading or move table column to left.
17410 Calls `org-do-promote' or `org-table-move-column', depending on context.
17411 With no specific context, calls the Emacs default `backward-word'.
17412 See the individual commands for more information."
17413 (interactive "P")
17414 (cond
17415 ((run-hook-with-args-until-success 'org-metaleft-hook))
17416 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17417 ((org-with-limited-levels
17418 (or (org-on-heading-p)
17419 (and (org-region-active-p)
17420 (save-excursion
17421 (goto-char (region-beginning))
17422 (org-on-heading-p)))))
17423 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17424 (call-interactively 'org-do-promote))
17425 ;; At an inline task.
17426 ((org-on-heading-p)
17427 (call-interactively 'org-inlinetask-promote))
17428 ((or (org-at-item-p)
17429 (and (org-region-active-p)
17430 (save-excursion
17431 (goto-char (region-beginning))
17432 (org-at-item-p))))
17433 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17434 (call-interactively 'org-outdent-item))
17435 (t (call-interactively 'backward-word))))
17437 (defun org-metaright (&optional arg)
17438 "Demote subtree or move table column to right.
17439 Calls `org-do-demote' or `org-table-move-column', depending on context.
17440 With no specific context, calls the Emacs default `forward-word'.
17441 See the individual commands for more information."
17442 (interactive "P")
17443 (cond
17444 ((run-hook-with-args-until-success 'org-metaright-hook))
17445 ((org-at-table-p) (call-interactively 'org-table-move-column))
17446 ((org-with-limited-levels
17447 (or (org-on-heading-p)
17448 (and (org-region-active-p)
17449 (save-excursion
17450 (goto-char (region-beginning))
17451 (org-on-heading-p)))))
17452 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17453 (call-interactively 'org-do-demote))
17454 ;; At an inline task.
17455 ((org-on-heading-p)
17456 (call-interactively 'org-inlinetask-demote))
17457 ((or (org-at-item-p)
17458 (and (org-region-active-p)
17459 (save-excursion
17460 (goto-char (region-beginning))
17461 (org-at-item-p))))
17462 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17463 (call-interactively 'org-indent-item))
17464 (t (call-interactively 'forward-word))))
17466 (defun org-check-for-hidden (what)
17467 "Check if there are hidden headlines/items in the current visual line.
17468 WHAT can be either `headlines' or `items'. If the current line is
17469 an outline or item heading and it has a folded subtree below it,
17470 this function returns t, nil otherwise."
17471 (let ((re (cond
17472 ((eq what 'headlines) org-outline-regexp-bol)
17473 ((eq what 'items) (org-item-beginning-re))
17474 (t (error "This should not happen"))))
17475 beg end)
17476 (save-excursion
17477 (catch 'exit
17478 (unless (org-region-active-p)
17479 (setq beg (point-at-bol))
17480 (beginning-of-line 2)
17481 (while (and (not (eobp)) ;; this is like `next-line'
17482 (get-char-property (1- (point)) 'invisible))
17483 (beginning-of-line 2))
17484 (setq end (point))
17485 (goto-char beg)
17486 (goto-char (point-at-eol))
17487 (setq end (max end (point)))
17488 (while (re-search-forward re end t)
17489 (if (get-char-property (match-beginning 0) 'invisible)
17490 (throw 'exit t))))
17491 nil))))
17493 (defun org-metaup (&optional arg)
17494 "Move subtree up or move table row up.
17495 Calls `org-move-subtree-up' or `org-table-move-row' or
17496 `org-move-item-up', depending on context. See the individual commands
17497 for more information."
17498 (interactive "P")
17499 (cond
17500 ((run-hook-with-args-until-success 'org-metaup-hook))
17501 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17502 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17503 ((org-at-item-p) (call-interactively 'org-move-item-up))
17504 (t (transpose-lines 1) (beginning-of-line -1))))
17506 (defun org-metadown (&optional arg)
17507 "Move subtree down or move table row down.
17508 Calls `org-move-subtree-down' or `org-table-move-row' or
17509 `org-move-item-down', depending on context. See the individual
17510 commands for more information."
17511 (interactive "P")
17512 (cond
17513 ((run-hook-with-args-until-success 'org-metadown-hook))
17514 ((org-at-table-p) (call-interactively 'org-table-move-row))
17515 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17516 ((org-at-item-p) (call-interactively 'org-move-item-down))
17517 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17519 (defun org-shiftup (&optional arg)
17520 "Increase item in timestamp or increase priority of current headline.
17521 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17522 depending on context. See the individual commands for more information."
17523 (interactive "P")
17524 (cond
17525 ((run-hook-with-args-until-success 'org-shiftup-hook))
17526 ((and org-support-shift-select (org-region-active-p))
17527 (org-call-for-shift-select 'previous-line))
17528 ((org-at-timestamp-p t)
17529 (call-interactively (if org-edit-timestamp-down-means-later
17530 'org-timestamp-down 'org-timestamp-up)))
17531 ((and (not (eq org-support-shift-select 'always))
17532 org-enable-priority-commands
17533 (org-on-heading-p))
17534 (call-interactively 'org-priority-up))
17535 ((and (not org-support-shift-select) (org-at-item-p))
17536 (call-interactively 'org-previous-item))
17537 ((org-clocktable-try-shift 'up arg))
17538 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17539 (org-support-shift-select
17540 (org-call-for-shift-select 'previous-line))
17541 (t (org-shiftselect-error))))
17543 (defun org-shiftdown (&optional arg)
17544 "Decrease item in timestamp or decrease priority of current headline.
17545 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17546 depending on context. See the individual commands for more information."
17547 (interactive "P")
17548 (cond
17549 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17550 ((and org-support-shift-select (org-region-active-p))
17551 (org-call-for-shift-select 'next-line))
17552 ((org-at-timestamp-p t)
17553 (call-interactively (if org-edit-timestamp-down-means-later
17554 'org-timestamp-up 'org-timestamp-down)))
17555 ((and (not (eq org-support-shift-select 'always))
17556 org-enable-priority-commands
17557 (org-on-heading-p))
17558 (call-interactively 'org-priority-down))
17559 ((and (not org-support-shift-select) (org-at-item-p))
17560 (call-interactively 'org-next-item))
17561 ((org-clocktable-try-shift 'down arg))
17562 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17563 (org-support-shift-select
17564 (org-call-for-shift-select 'next-line))
17565 (t (org-shiftselect-error))))
17567 (defun org-shiftright (&optional arg)
17568 "Cycle the thing at point or in the current line, depending on context.
17569 Depending on context, this does one of the following:
17571 - switch a timestamp at point one day into the future
17572 - on a headline, switch to the next TODO keyword.
17573 - on an item, switch entire list to the next bullet type
17574 - on a property line, switch to the next allowed value
17575 - on a clocktable definition line, move time block into the future"
17576 (interactive "P")
17577 (cond
17578 ((run-hook-with-args-until-success 'org-shiftright-hook))
17579 ((and org-support-shift-select (org-region-active-p))
17580 (org-call-for-shift-select 'forward-char))
17581 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17582 ((and (not (eq org-support-shift-select 'always))
17583 (org-on-heading-p))
17584 (let ((org-inhibit-logging
17585 (not org-treat-S-cursor-todo-selection-as-state-change))
17586 (org-inhibit-blocking
17587 (not org-treat-S-cursor-todo-selection-as-state-change)))
17588 (org-call-with-arg 'org-todo 'right)))
17589 ((or (and org-support-shift-select
17590 (not (eq org-support-shift-select 'always))
17591 (org-at-item-bullet-p))
17592 (and (not org-support-shift-select) (org-at-item-p)))
17593 (org-call-with-arg 'org-cycle-list-bullet nil))
17594 ((and (not (eq org-support-shift-select 'always))
17595 (org-at-property-p))
17596 (call-interactively 'org-property-next-allowed-value))
17597 ((org-clocktable-try-shift 'right arg))
17598 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17599 (org-support-shift-select
17600 (org-call-for-shift-select 'forward-char))
17601 (t (org-shiftselect-error))))
17603 (defun org-shiftleft (&optional arg)
17604 "Cycle the thing at point or in the current line, depending on context.
17605 Depending on context, this does one of the following:
17607 - switch a timestamp at point one day into the past
17608 - on a headline, switch to the previous TODO keyword.
17609 - on an item, switch entire list to the previous bullet type
17610 - on a property line, switch to the previous allowed value
17611 - on a clocktable definition line, move time block into the past"
17612 (interactive "P")
17613 (cond
17614 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17615 ((and org-support-shift-select (org-region-active-p))
17616 (org-call-for-shift-select 'backward-char))
17617 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17618 ((and (not (eq org-support-shift-select 'always))
17619 (org-on-heading-p))
17620 (let ((org-inhibit-logging
17621 (not org-treat-S-cursor-todo-selection-as-state-change))
17622 (org-inhibit-blocking
17623 (not org-treat-S-cursor-todo-selection-as-state-change)))
17624 (org-call-with-arg 'org-todo 'left)))
17625 ((or (and org-support-shift-select
17626 (not (eq org-support-shift-select 'always))
17627 (org-at-item-bullet-p))
17628 (and (not org-support-shift-select) (org-at-item-p)))
17629 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17630 ((and (not (eq org-support-shift-select 'always))
17631 (org-at-property-p))
17632 (call-interactively 'org-property-previous-allowed-value))
17633 ((org-clocktable-try-shift 'left arg))
17634 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17635 (org-support-shift-select
17636 (org-call-for-shift-select 'backward-char))
17637 (t (org-shiftselect-error))))
17639 (defun org-shiftcontrolright ()
17640 "Switch to next TODO set."
17641 (interactive)
17642 (cond
17643 ((and org-support-shift-select (org-region-active-p))
17644 (org-call-for-shift-select 'forward-word))
17645 ((and (not (eq org-support-shift-select 'always))
17646 (org-on-heading-p))
17647 (org-call-with-arg 'org-todo 'nextset))
17648 (org-support-shift-select
17649 (org-call-for-shift-select 'forward-word))
17650 (t (org-shiftselect-error))))
17652 (defun org-shiftcontrolleft ()
17653 "Switch to previous TODO set."
17654 (interactive)
17655 (cond
17656 ((and org-support-shift-select (org-region-active-p))
17657 (org-call-for-shift-select 'backward-word))
17658 ((and (not (eq org-support-shift-select 'always))
17659 (org-on-heading-p))
17660 (org-call-with-arg 'org-todo 'previousset))
17661 (org-support-shift-select
17662 (org-call-for-shift-select 'backward-word))
17663 (t (org-shiftselect-error))))
17665 (defun org-shiftcontrolup ()
17666 "Change timestamps synchronously up in CLOCK log lines."
17667 (interactive)
17668 (cond ((and (not org-support-shift-select)
17669 (org-at-clock-log-p)
17670 (org-at-timestamp-p t))
17671 (org-clock-timestamps-up))
17672 (t (org-shiftselect-error))))
17674 (defun org-shiftcontroldown ()
17675 "Change timestamps synchronously down in CLOCK log lines."
17676 (interactive)
17677 (cond ((and (not org-support-shift-select)
17678 (org-at-clock-log-p)
17679 (org-at-timestamp-p t))
17680 (org-clock-timestamps-down))
17681 (t (org-shiftselect-error))))
17683 (defun org-ctrl-c-ret ()
17684 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17685 (interactive)
17686 (cond
17687 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17688 (t (call-interactively 'org-insert-heading))))
17690 (defun org-copy-visible (beg end)
17691 "Copy the visible parts of the region."
17692 (interactive "r")
17693 (let (snippets s)
17694 (save-excursion
17695 (save-restriction
17696 (narrow-to-region beg end)
17697 (setq s (goto-char (point-min)))
17698 (while (not (= (point) (point-max)))
17699 (goto-char (org-find-invisible))
17700 (push (buffer-substring s (point)) snippets)
17701 (setq s (goto-char (org-find-visible))))))
17702 (kill-new (apply 'concat (nreverse snippets)))))
17704 (defun org-copy-special ()
17705 "Copy region in table or copy current subtree.
17706 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17707 See the individual commands for more information."
17708 (interactive)
17709 (call-interactively
17710 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17712 (defun org-cut-special ()
17713 "Cut region in table or cut current subtree.
17714 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17715 See the individual commands for more information."
17716 (interactive)
17717 (call-interactively
17718 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17720 (defun org-paste-special (arg)
17721 "Paste rectangular region into table, or past subtree relative to level.
17722 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17723 See the individual commands for more information."
17724 (interactive "P")
17725 (if (org-at-table-p)
17726 (org-table-paste-rectangle)
17727 (org-paste-subtree arg)))
17729 (defun org-edit-special (&optional arg)
17730 "Call a special editor for the stuff at point.
17731 When at a table, call the formula editor with `org-table-edit-formulas'.
17732 When at the first line of an src example, call `org-edit-src-code'.
17733 When in an #+include line, visit the include file. Otherwise call
17734 `ffap' to visit the file at point."
17735 (interactive)
17736 ;; possibly prep session before editing source
17737 (when arg
17738 (let* ((info (org-babel-get-src-block-info))
17739 (lang (nth 0 info))
17740 (params (nth 2 info))
17741 (session (cdr (assoc :session params))))
17742 (when (and info session) ;; we are in a source-code block with a session
17743 (funcall
17744 (intern (concat "org-babel-prep-session:" lang)) session params))))
17745 (cond ;; proceed with `org-edit-special'
17746 ((save-excursion
17747 (beginning-of-line 1)
17748 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17749 (find-file (org-trim (match-string 1))))
17750 ((org-edit-src-code))
17751 ((org-edit-fixed-width-region))
17752 ((org-at-table.el-p)
17753 (org-edit-src-code))
17754 ((or (org-at-table-p)
17755 (save-excursion
17756 (beginning-of-line 1)
17758 (call-interactively 'org-table-edit-formulas))
17759 (t (call-interactively 'ffap))))
17761 (defun org-ctrl-c-ctrl-c (&optional arg)
17762 "Set tags in headline, or update according to changed information at point.
17764 This command does many different things, depending on context:
17766 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17767 this is what we do.
17769 - If the cursor is on a statistics cookie, update it.
17771 - If the cursor is in a headline, prompt for tags and insert them
17772 into the current line, aligned to `org-tags-column'. When called
17773 with prefix arg, realign all tags in the current buffer.
17775 - If the cursor is in one of the special #+KEYWORD lines, this
17776 triggers scanning the buffer for these lines and updating the
17777 information.
17779 - If the cursor is inside a table, realign the table. This command
17780 works even if the automatic table editor has been turned off.
17782 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17783 the entire table.
17785 - If the cursor is at a footnote reference or definition, jump to
17786 the corresponding definition or references, respectively.
17788 - If the cursor is a the beginning of a dynamic block, update it.
17790 - If the current buffer is a capture buffer, close note and file it.
17792 - If the cursor is on a <<<target>>>, update radio targets and
17793 corresponding links in this buffer.
17795 - If the cursor is on a numbered item in a plain list, renumber the
17796 ordered list.
17798 - If the cursor is on a checkbox, toggle it.
17800 - If the cursor is on a code block, evaluate it. The variable
17801 `org-confirm-babel-evaluate' can be used to control prompting
17802 before code block evaluation, by default every code block
17803 evaluation requires confirmation. Code block evaluation can be
17804 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17805 (interactive "P")
17806 (let ((org-enable-table-editor t))
17807 (cond
17808 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17809 org-occur-highlights
17810 org-latex-fragment-image-overlays)
17811 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17812 (org-remove-occur-highlights)
17813 (org-remove-latex-fragment-image-overlays)
17814 (message "Temporary highlights/overlays removed from current buffer"))
17815 ((and (local-variable-p 'org-finish-function (current-buffer))
17816 (fboundp org-finish-function))
17817 (funcall org-finish-function))
17818 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17819 ((or (looking-at org-property-start-re)
17820 (org-at-property-p))
17821 (call-interactively 'org-property-action))
17822 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17824 (or (org-on-heading-p) (org-at-item-p)))
17825 (call-interactively 'org-update-statistics-cookies))
17826 ((org-on-heading-p) (call-interactively 'org-set-tags))
17827 ((org-at-table.el-p)
17828 (message "Use C-c ' to edit table.el tables"))
17829 ((org-at-table-p)
17830 (org-table-maybe-eval-formula)
17831 (if arg
17832 (call-interactively 'org-table-recalculate)
17833 (org-table-maybe-recalculate-line))
17834 (call-interactively 'org-table-align)
17835 (orgtbl-send-table 'maybe))
17836 ((or (org-footnote-at-reference-p)
17837 (org-footnote-at-definition-p))
17838 (call-interactively 'org-footnote-action))
17839 ((org-at-item-checkbox-p)
17840 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17841 ;; list only if at top item.
17842 (let* ((cbox (match-string 1))
17843 (struct (org-list-struct))
17844 (old-struct (copy-tree struct))
17845 (parents (org-list-parents-alist struct))
17846 (prevs (org-list-prevs-alist struct))
17847 (orderedp (org-entry-get nil "ORDERED"))
17848 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17849 block-item)
17850 ;; Use a light version of `org-toggle-checkbox' to avoid
17851 ;; computing list structure twice.
17852 (org-list-set-checkbox (point-at-bol) struct
17853 (cond
17854 ((equal arg '(16)) "[-]")
17855 ((equal arg '(4)) nil)
17856 ((equal "[X]" cbox) "[ ]")
17857 (t "[X]")))
17858 (org-list-struct-fix-ind struct parents)
17859 (org-list-struct-fix-bul struct prevs)
17860 (setq block-item
17861 (org-list-struct-fix-box struct parents prevs orderedp))
17862 (when block-item
17863 (message
17864 "Checkboxes were removed due to unchecked box at line %d"
17865 (org-current-line block-item)))
17866 (org-list-struct-apply-struct struct old-struct)
17867 (org-update-checkbox-count-maybe)
17868 (when firstp (org-list-send-list 'maybe))))
17869 ((org-at-item-p)
17870 ;; Cursor at an item: repair list. Do checkbox related actions
17871 ;; only if function was called with an argument. Send list only
17872 ;; if at top item.
17873 (let* ((struct (org-list-struct))
17874 (old-struct (copy-tree struct))
17875 (parents (org-list-parents-alist struct))
17876 (prevs (org-list-prevs-alist struct))
17877 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17878 (org-list-struct-fix-ind struct parents)
17879 (org-list-struct-fix-bul struct prevs)
17880 (when arg
17881 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17882 (org-list-struct-fix-box struct parents prevs))
17883 (org-list-struct-apply-struct struct old-struct)
17884 (when arg (org-update-checkbox-count-maybe))
17885 (when firstp (org-list-send-list 'maybe))))
17886 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17887 ;; Dynamic block
17888 (beginning-of-line 1)
17889 (save-excursion (org-update-dblock)))
17890 ((save-excursion
17891 (beginning-of-line 1)
17893 (cond
17894 ((equal (match-string 1) "TBLFM")
17895 ;; Recalculate the table before this line
17896 (save-excursion
17897 (beginning-of-line 1)
17899 (if (org-at-table-p)
17900 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17901 (t
17902 (let ((org-inhibit-startup-visibility-stuff t)
17903 (org-startup-align-all-tables nil))
17904 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17905 (message "Local setup has been refreshed"))))
17906 ((org-clock-update-time-maybe))
17907 (t
17908 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17909 (error "C-c C-c can do nothing useful at this location"))))))
17911 (defun org-mode-restart ()
17912 "Restart Org-mode, to scan again for special lines.
17913 Also updates the keyword regular expressions."
17914 (interactive)
17915 (org-mode)
17916 (message "Org-mode restarted"))
17918 (defun org-kill-note-or-show-branches ()
17919 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17920 (interactive)
17921 (if (not org-finish-function)
17922 (progn
17923 (hide-subtree)
17924 (call-interactively 'show-branches))
17925 (let ((org-note-abort t))
17926 (funcall org-finish-function))))
17928 (defun org-return (&optional indent)
17929 "Goto next table row or insert a newline.
17930 Calls `org-table-next-row' or `newline', depending on context.
17931 See the individual commands for more information."
17932 (interactive)
17933 (cond
17934 ((bobp) (if indent (newline-and-indent) (newline)))
17935 ((org-at-table-p)
17936 (org-table-justify-field-maybe)
17937 (call-interactively 'org-table-next-row))
17938 ;; when `newline-and-indent' is called within a list, make sure
17939 ;; text moved stays inside the item.
17940 ((and (org-in-item-p) indent)
17941 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17942 (progn
17943 (newline)
17944 (org-indent-line-to (length (match-string 0))))
17945 (let ((ind (org-get-indentation)))
17946 (newline)
17947 (if (org-looking-back org-list-end-re)
17948 (org-indent-line-function)
17949 (org-indent-line-to ind)))))
17950 ((and org-return-follows-link
17951 (eq (get-text-property (point) 'face) 'org-link))
17952 (call-interactively 'org-open-at-point))
17953 ((and (org-at-heading-p)
17954 (looking-at
17956 (org-show-entry)
17957 (end-of-line 1)
17958 (newline))
17959 (t (if indent (newline-and-indent) (newline)))))
17961 (defun org-return-indent ()
17962 "Goto next table row or insert a newline and indent.
17963 Calls `org-table-next-row' or `newline-and-indent', depending on
17964 context. See the individual commands for more information."
17965 (interactive)
17966 (org-return t))
17968 (defun org-ctrl-c-star ()
17969 "Compute table, or change heading status of lines.
17970 Calls `org-table-recalculate' or `org-toggle-heading',
17971 depending on context."
17972 (interactive)
17973 (cond
17974 ((org-at-table-p)
17975 (call-interactively 'org-table-recalculate))
17976 (t
17977 ;; Convert all lines in region to list items
17978 (call-interactively 'org-toggle-heading))))
17980 (defun org-ctrl-c-minus ()
17981 "Insert separator line in table or modify bullet status of line.
17982 Also turns a plain line or a region of lines into list items.
17983 Calls `org-table-insert-hline', `org-toggle-item', or
17984 `org-cycle-list-bullet', depending on context."
17985 (interactive)
17986 (cond
17987 ((org-at-table-p)
17988 (call-interactively 'org-table-insert-hline))
17989 ((org-region-active-p)
17990 (call-interactively 'org-toggle-item))
17991 ((org-in-item-p)
17992 (call-interactively 'org-cycle-list-bullet))
17993 (t
17994 (call-interactively 'org-toggle-item))))
17996 (defun org-toggle-item (arg)
17997 "Convert headings or normal lines to items, items to normal lines.
17998 If there is no active region, only the current line is considered.
18000 If the first non blank line in the region is an headline, convert
18001 all headlines to items, shifting text accordingly.
18003 If it is an item, convert all items to normal lines.
18005 If it is normal text, change region into an item. With a prefix
18006 argument ARG, change each line in region into an item."
18007 (interactive "P")
18008 (let ((shift-text
18009 (function
18010 ;; Shift text in current section to IND, from point to END.
18011 ;; The function leaves point to END line.
18012 (lambda (ind end)
18013 (let ((min-i 1000) (end (copy-marker end)))
18014 ;; First determine the minimum indentation (MIN-I) of
18015 ;; the text.
18016 (save-excursion
18017 (catch 'exit
18018 (while (< (point) end)
18019 (let ((i (org-get-indentation)))
18020 (cond
18021 ;; Skip blank lines and inline tasks.
18023 ((looking-at org-outline-regexp-bol))
18024 ;; We can't find less than 0 indentation.
18025 ((zerop i) (throw 'exit (setq min-i 0)))
18026 ((< i min-i) (setq min-i i))))
18027 (forward-line))))
18028 ;; Then indent each line so that a line indented to
18029 ;; MIN-I becomes indented to IND. Ignore blank lines
18030 ;; and inline tasks in the process.
18031 (let ((delta (- ind min-i)))
18032 (while (< (point) end)
18034 (looking-at org-outline-regexp-bol))
18035 (org-indent-line-to (+ (org-get-indentation) delta)))
18036 (forward-line)))))))
18037 (skip-blanks
18038 (function
18039 ;; Return beginning of first non-blank line, starting from
18040 ;; line at POS.
18041 (lambda (pos)
18042 (save-excursion
18043 (goto-char pos)
18045 (point-at-bol)))))
18046 beg end)
18047 ;; Determine boundaries of changes.
18048 (if (org-region-active-p)
18049 (setq beg (funcall skip-blanks (region-beginning))
18050 end (copy-marker (region-end)))
18051 (setq beg (funcall skip-blanks (point-at-bol))
18052 end (copy-marker (point-at-eol))))
18053 ;; Depending on the starting line, choose an action on the text
18054 ;; between BEG and END.
18055 (org-with-limited-levels
18056 (save-excursion
18057 (goto-char beg)
18058 (cond
18059 ;; Case 1. Start at an item: de-itemize. Note that it only
18060 ;; happens when a region is active: `org-ctrl-c-minus'
18061 ;; would call `org-cycle-list-bullet' otherwise.
18062 ((org-at-item-p)
18063 (while (< (point) end)
18064 (when (org-at-item-p)
18066 (delete-region (point) (match-end 0)))
18067 (forward-line)))
18068 ;; Case 2. Start at an heading: convert to items.
18069 ((org-on-heading-p)
18070 (let* ((bul (org-list-bullet-string "-"))
18071 (bul-len (length bul))
18072 ;; Indentation of the first heading. It should be
18073 ;; relative to the indentation of its parent, if any.
18074 (start-ind (save-excursion
18075 (cond
18076 ((not org-adapt-indentation) 0)
18077 ((not (outline-previous-heading)) 0)
18078 (t (length (match-string 0))))))
18079 ;; Level of first heading. Further headings will be
18080 ;; compared to it to determine hierarchy in the list.
18081 (ref-level (org-reduced-level (org-outline-level))))
18082 (while (< (point) end)
18083 (let* ((level (org-reduced-level (org-outline-level)))
18084 (delta (max 0 (- level ref-level))))
18085 ;; If current headline is less indented than the first
18086 ;; one, set it as reference, in order to preserve
18087 ;; subtrees.
18088 (when (< level ref-level) (setq ref-level level))
18089 (replace-match bul t t)
18090 (org-indent-line-to (+ start-ind (* delta bul-len)))
18091 ;; Ensure all text down to END (or SECTION-END) belongs
18092 ;; to the newly created item.
18093 (let ((section-end (save-excursion
18094 (or (outline-next-heading) (point)))))
18095 (forward-line)
18096 (funcall shift-text
18097 (+ start-ind (* (1+ delta) bul-len))
18098 (min end section-end)))))))
18099 ;; Case 3. Normal line with ARG: turn each non-item line into
18100 ;; an item.
18101 (arg
18102 (while (< (point) end)
18103 (unless (or (org-on-heading-p) (org-at-item-p))
18105 (replace-match
18107 (forward-line)))
18108 ;; Case 4. Normal line without ARG: make the first line of
18109 ;; region an item, and shift indentation of others
18110 ;; lines to set them as item's body.
18111 (t (let* ((bul (org-list-bullet-string "-"))
18112 (bul-len (length bul))
18113 (ref-ind (org-get-indentation)))
18115 (insert bul)
18116 (forward-line)
18117 (while (< (point) end)
18118 ;; Ensure that lines less indented than first one
18119 ;; still get included in item body.
18120 (funcall shift-text
18121 (+ ref-ind bul-len)
18122 (min end (save-excursion (or (outline-next-heading)
18123 (point)))))
18124 (forward-line)))))))))
18126 (defun org-toggle-heading (&optional nstars)
18127 "Convert headings to normal text, or items or text to headings.
18128 If there is no active region, only the current line is considered.
18130 If the first non blank line is an headline, remove the stars from
18131 all headlines in the region.
18133 If it is a plain list item, turn all plain list items into headings.
18135 If it is a normal line, turn each and every normal line (i.e. not
18136 an heading or an item) in the region into a heading.
18138 When converting a line into a heading, the number of stars is chosen
18139 such that the lines become children of the current entry. However,
18140 when a prefix argument is given, its value determines the number of
18141 stars to add."
18142 (interactive "P")
18143 (let ((skip-blanks
18144 (function
18145 ;; Return beginning of first non-blank line, starting from
18146 ;; line at POS.
18147 (lambda (pos)
18148 (save-excursion
18149 (goto-char pos)
18151 (point-at-bol)))))
18152 beg end)
18153 ;; Determine boundaries of changes. If region ends at a bol, do
18154 ;; not consider the last line to be in the region.
18155 (if (org-region-active-p)
18156 (setq beg (funcall skip-blanks (region-beginning))
18157 end (copy-marker (save-excursion
18158 (goto-char (region-end))
18159 (if (bolp) (point) (point-at-eol)))))
18160 (setq beg (funcall skip-blanks (point-at-bol))
18161 end (copy-marker (point-at-eol))))
18162 ;; Ensure inline tasks don't count as headings.
18163 (org-with-limited-levels
18164 (save-excursion
18165 (goto-char beg)
18166 (cond
18167 ;; Case 1. Started at an heading: de-star headings.
18168 ((org-on-heading-p)
18169 (while (< (point) end)
18170 (when (org-on-heading-p t)
18171 (looking-at org-outline-regexp) (replace-match ""))
18172 (forward-line)))
18173 ;; Case 2. Started at an item: change items into headlines.
18174 ;; One star will be added by `org-list-to-subtree'.
18175 ((org-at-item-p)
18176 (let* ((stars (make-string
18177 (if nstars
18178 ;; subtract the star that will be added again by
18179 ;; `org-list-to-subtree'
18180 (1- (prefix-numeric-value current-prefix-arg))
18181 (or (org-current-level) 0))
18182 ?*))
18183 (add-stars
18184 (cond (nstars "") ; stars from prefix only
18185 ((equal stars "") "") ; before first heading
18186 (org-odd-levels-only "*") ; inside heading, odd
18187 (t "")))) ; inside heading, oddeven
18188 (while (< (point) end)
18189 (when (org-at-item-p)
18190 ;; Pay attention to cases when region ends before list.
18191 (let* ((struct (org-list-struct))
18192 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18193 (save-restriction
18194 (narrow-to-region (point) list-end)
18195 (insert
18196 (org-list-to-subtree
18197 (org-list-parse-list t)
18198 '(:istart (concat stars add-stars (funcall get-stars depth))
18199 :icount (concat stars add-stars (funcall get-stars depth))))))))
18200 (forward-line))))
18201 ;; Case 3. Started at normal text: make every line an heading,
18202 ;; skipping headlines and items.
18203 (t (let* ((stars (make-string
18204 (if nstars
18205 (prefix-numeric-value current-prefix-arg)
18206 (or (org-current-level) 0))
18207 ?*))
18208 (add-stars
18209 (cond (nstars "") ; stars from prefix only
18210 ((equal stars "") "*") ; before first heading
18211 (org-odd-levels-only "**") ; inside heading, odd
18212 (t "*"))) ; inside heading, oddeven
18213 (rpl (concat stars add-stars " ")))
18214 (while (< (point) end)
18215 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18217 (replace-match (concat rpl (match-string 2))))
18218 (forward-line)))))))))
18220 (defun org-meta-return (&optional arg)
18221 "Insert a new heading or wrap a region in a table.
18222 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18223 See the individual commands for more information."
18224 (interactive "P")
18225 (cond
18226 ((run-hook-with-args-until-success 'org-metareturn-hook))
18227 ((org-at-table-p)
18228 (call-interactively 'org-table-wrap-region))
18229 (t (call-interactively 'org-insert-heading))))
18231 ;;; Menu entries
18233 ;; Define the Org-mode menus
18234 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18235 '("Tbl"
18236 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18237 ["Next Field" org-cycle (org-at-table-p)]
18238 ["Previous Field" org-shifttab (org-at-table-p)]
18239 ["Next Row" org-return (org-at-table-p)]
18240 "--"
18241 ["Blank Field" org-table-blank-field (org-at-table-p)]
18242 ["Edit Field" org-table-edit-field (org-at-table-p)]
18243 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18244 "--"
18245 ("Column"
18246 ["Move Column Left" org-metaleft (org-at-table-p)]
18247 ["Move Column Right" org-metaright (org-at-table-p)]
18248 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18249 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18250 ("Row"
18251 ["Move Row Up" org-metaup (org-at-table-p)]
18252 ["Move Row Down" org-metadown (org-at-table-p)]
18253 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18254 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18255 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18256 "--"
18257 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18258 ("Rectangle"
18259 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18260 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18261 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18262 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18263 "--"
18264 ("Calculate"
18265 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18266 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18267 ["Edit Formulas" org-edit-special (org-at-table-p)]
18268 "--"
18269 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18270 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18271 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18272 "--"
18273 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18274 "--"
18275 ["Sum Column/Rectangle" org-table-sum
18276 (or (org-at-table-p) (org-region-active-p))]
18277 ["Which Column?" org-table-current-column (org-at-table-p)])
18278 ["Debug Formulas"
18279 org-table-toggle-formula-debugger
18280 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18281 ["Show Col/Row Numbers"
18282 org-table-toggle-coordinate-overlays
18283 :style toggle
18284 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18285 "--"
18286 ["Create" org-table-create (and (not (org-at-table-p))
18287 org-enable-table-editor)]
18288 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18289 ["Import from File" org-table-import (not (org-at-table-p))]
18290 ["Export to File" org-table-export (org-at-table-p)]
18291 "--"
18292 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18294 (easy-menu-define org-org-menu org-mode-map "Org menu"
18295 '("Org"
18296 ("Show/Hide"
18297 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18298 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18299 ["Sparse Tree..." org-sparse-tree t]
18300 ["Reveal Context" org-reveal t]
18301 ["Show All" show-all t]
18302 "--"
18303 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18304 "--"
18305 ["New Heading" org-insert-heading t]
18306 ("Navigate Headings"
18307 ["Up" outline-up-heading t]
18308 ["Next" outline-next-visible-heading t]
18309 ["Previous" outline-previous-visible-heading t]
18310 ["Next Same Level" outline-forward-same-level t]
18311 ["Previous Same Level" outline-backward-same-level t]
18312 "--"
18313 ["Jump" org-goto t])
18314 ("Edit Structure"
18315 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18316 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18317 "--"
18318 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18319 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18320 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18321 "--"
18322 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18323 "--"
18324 ["Copy visible text" org-copy-visible t]
18325 "--"
18326 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18327 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18328 ["Demote Heading" org-metaright (not (org-at-table-p))]
18329 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18330 "--"
18331 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18332 "--"
18333 ["Convert to odd levels" org-convert-to-odd-levels t]
18334 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18335 ("Editing"
18336 ["Emphasis..." org-emphasize t]
18337 ["Edit Source Example" org-edit-special t]
18338 "--"
18339 ["Footnote new/jump" org-footnote-action t]
18340 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18341 ("Archive"
18342 ["Archive (default method)" org-archive-subtree-default t]
18343 "--"
18344 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18345 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18346 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18347 )
18348 "--"
18349 ("Hyperlinks"
18350 ["Store Link (Global)" org-store-link t]
18351 ["Find existing link to here" org-occur-link-in-agenda-files t]
18352 ["Insert Link" org-insert-link t]
18353 ["Follow Link" org-open-at-point t]
18354 "--"
18355 ["Next link" org-next-link t]
18356 ["Previous link" org-previous-link t]
18357 "--"
18358 ["Descriptive Links"
18359 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18360 :style radio
18361 :selected (member '(org-link) buffer-invisibility-spec)]
18362 ["Literal Links"
18363 (progn
18364 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18365 :style radio
18366 :selected (not (member '(org-link) buffer-invisibility-spec))])
18367 "--"
18368 ("TODO Lists"
18369 ["TODO/DONE/-" org-todo t]
18370 ("Select keyword"
18371 ["Next keyword" org-shiftright (org-on-heading-p)]
18372 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18373 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18374 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18375 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18376 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18377 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18378 "--"
18379 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18380 :selected org-enforce-todo-dependencies :style toggle :active t]
18381 "Settings for tree at point"
18382 ["Do Children sequentially" org-toggle-ordered-property :style radio
18383 :selected (org-entry-get nil "ORDERED")
18384 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18385 ["Do Children parallel" org-toggle-ordered-property :style radio
18386 :selected (not (org-entry-get nil "ORDERED"))
18387 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18388 "--"
18389 ["Set Priority" org-priority t]
18390 ["Priority Up" org-shiftup t]
18391 ["Priority Down" org-shiftdown t]
18392 "--"
18393 ["Get news from all feeds" org-feed-update-all t]
18394 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18395 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18396 ("TAGS and Properties"
18397 ["Set Tags" org-set-tags-command t]
18398 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18399 "--"
18400 ["Set property" org-set-property t]
18401 ["Column view of properties" org-columns t]
18402 ["Insert Column View DBlock" org-insert-columns-dblock t])
18403 ("Dates and Scheduling"
18404 ["Timestamp" org-time-stamp t]
18405 ["Timestamp (inactive)" org-time-stamp-inactive t]
18406 ("Change Date"
18407 ["1 Day Later" org-shiftright t]
18408 ["1 Day Earlier" org-shiftleft t]
18409 ["1 ... Later" org-shiftup t]
18410 ["1 ... Earlier" org-shiftdown t])
18411 ["Compute Time Range" org-evaluate-time-range t]
18412 ["Schedule Item" org-schedule t]
18413 ["Deadline" org-deadline t]
18414 "--"
18415 ["Custom time format" org-toggle-time-stamp-overlays
18416 :style radio :selected org-display-custom-times]
18417 "--"
18418 ["Goto Calendar" org-goto-calendar t]
18419 ["Date from Calendar" org-date-from-calendar t]
18420 "--"
18421 ["Start/Restart Timer" org-timer-start t]
18422 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18423 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18424 ["Insert Timer String" org-timer t]
18425 ["Insert Timer Item" org-timer-item t])
18426 ("Logging work"
18427 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18428 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18429 ["Clock out" org-clock-out t]
18430 ["Clock cancel" org-clock-cancel t]
18431 "--"
18432 ["Mark as default task" org-clock-mark-default-task t]
18433 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18434 ["Goto running clock" org-clock-goto t]
18435 "--"
18436 ["Display times" org-clock-display t]
18437 ["Create clock table" org-clock-report t]
18438 "--"
18439 ["Record DONE time"
18440 (progn (setq org-log-done (not org-log-done))
18441 (message "Switching to %s will %s record a timestamp"
18442 (car org-done-keywords)
18443 (if org-log-done "automatically" "not")))
18444 :style toggle :selected org-log-done])
18445 "--"
18446 ["Agenda Command..." org-agenda t]
18447 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18448 ("File List for Agenda")
18449 ("Special views current file"
18450 ["TODO Tree" org-show-todo-tree t]
18451 ["Check Deadlines" org-check-deadlines t]
18452 ["Timeline" org-timeline t]
18453 ["Tags/Property tree" org-match-sparse-tree t])
18454 "--"
18455 ["Export/Publish..." org-export t]
18456 ("LaTeX"
18457 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18458 :selected org-cdlatex-mode]
18459 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18460 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18461 ["Modify math symbol" org-cdlatex-math-modify
18462 (org-inside-LaTeX-fragment-p)]
18463 ["Insert citation" org-reftex-citation t]
18464 "--"
18465 ["Template for BEAMER" org-insert-beamer-options-template t])
18466 "--"
18467 ("MobileOrg"
18468 ["Push Files and Views" org-mobile-push t]
18469 ["Get Captured and Flagged" org-mobile-pull t]
18470 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18471 "--"
18472 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18473 "--"
18474 ("Documentation"
18475 ["Show Version" org-version t]
18476 ["Info Documentation" org-info t])
18477 ("Customize"
18478 ["Browse Org Group" org-customize t]
18479 "--"
18480 ["Expand This Menu" org-create-customize-menu
18481 (fboundp 'customize-menu-create)])
18482 ["Send bug report" org-submit-bug-report t]
18483 "--"
18484 ("Refresh/Reload"
18485 ["Refresh setup current buffer" org-mode-restart t]
18486 ["Reload Org (after update)" org-reload t]
18487 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18488 ))
18490 (defun org-info (&optional node)
18491 "Read documentation for Org-mode in the info system.
18492 With optional NODE, go directly to that node."
18493 (interactive)
18494 (info (format "(org)%s" (or node ""))))
18496 ;;;###autoload
18497 (defun org-submit-bug-report ()
18498 "Submit a bug report on Org-mode via mail.
18500 Don't hesitate to report any problems or inaccurate documentation.
18502 If you don't have setup sending mail from (X)Emacs, please copy the
18503 output buffer into your mail program, as it gives us important
18504 information about your Org-mode version and configuration."
18505 (interactive)
18506 (require 'reporter)
18507 (org-load-modules-maybe)
18508 (org-require-autoloaded-modules)
18509 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18510 (reporter-submit-bug-report
18511 "emacs-orgmode@gnu.org"
18512 (org-version)
18513 (let (list)
18514 (save-window-excursion
18515 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18516 (delete-other-windows)
18517 (erase-buffer)
18518 (insert "You are about to submit a bug report to the Org-mode mailing list.
18520 We would like to add your full Org-mode and Outline configuration to the
18521 bug report. This greatly simplifies the work of the maintainer and
18522 other experts on the mailing list.
18524 HOWEVER, some variables you have customized may contain private
18525 information. The names of customers, colleagues, or friends, might
18526 appear in the form of file names, tags, todo states, or search strings.
18527 If you answer yes to the prompt, you might want to check and remove
18528 such private information before sending the email.")
18529 (add-text-properties (point-min) (point-max) '(face org-warning))
18530 (when (yes-or-no-p "Include your Org-mode configuration ")
18531 (mapatoms
18532 (lambda (v)
18533 (and (boundp v)
18535 (or (and (symbol-value v)
18537 (and
18538 (get v 'custom-type) (get v 'standard-value)
18539 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18540 (push v list)))))
18541 (kill-buffer (get-buffer "*Warn about privacy*"))
18542 list))
18543 nil nil
18544 "Remember to cover the basics, that is, what you expected to happen and
18545 what in fact did happen. You don't know how to make a good report? See
18547 http://orgmode.org/manual/Feedback.html#Feedback
18549 Your bug report will be posted to the Org-mode mailing list.
18550 ------------------------------------------------------------------------")
18551 (save-excursion
18556 (defun org-install-agenda-files-menu ()
18557 (let ((bl (buffer-list)))
18558 (save-excursion
18559 (while bl
18560 (set-buffer (pop bl))
18561 (if (org-mode-p) (setq bl nil)))
18562 (when (org-mode-p)
18563 (easy-menu-change
18564 '("Org") "File List for Agenda"
18565 (append
18566 (list
18567 ["Edit File List" (org-edit-agenda-file-list) t]
18568 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18569 ["Remove Current File from List" org-remove-file t]
18570 ["Cycle through agenda files" org-cycle-agenda-files t]
18571 ["Occur in all agenda files" org-occur-in-agenda-files t]
18572 "--")
18573 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18575 ;;;; Documentation
18577 ;;;###autoload
18578 (defun org-require-autoloaded-modules ()
18579 (interactive)
18580 (mapc 'require
18581 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18582 org-docbook org-exp org-html org-icalendar
18583 org-id org-latex
18584 org-publish org-remember org-table
18585 org-timer org-xoxo)))
18587 ;;;###autoload
18588 (defun org-reload (&optional uncompiled)
18589 "Reload all org lisp files.
18590 With prefix arg UNCOMPILED, load the uncompiled versions."
18591 (interactive "P")
18592 (require 'find-func)
18594 (dir-org (file-name-directory (org-find-library-name "org")))
18595 (dir-org-contrib (ignore-errors
18596 (file-name-directory
18597 (org-find-library-name "org-contribdir"))))
18598 (babel-files
18599 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18600 (append (list nil "comint" "eval" "exp" "keys"
18601 "lob" "ref" "table" "tangle")
18602 (delq nil
18603 (mapcar
18604 (lambda (lang)
18605 (when (cdr lang) (symbol-name (car lang))))
18606 org-babel-load-languages)))))
18607 (files
18608 (append (directory-files dir-org t file-re)
18609 babel-files
18610 (and dir-org-contrib
18611 (directory-files dir-org-contrib t file-re))))
18612 (remove-re (concat (if (featurep 'xemacs)
18613 "org-colview" "org-colview-xemacs")
18615 (setq files (mapcar 'file-name-sans-extension files))
18616 (setq files (mapcar
18617 (lambda (x) (if (string-match remove-re x) nil x))
18618 files))
18619 (setq files (delq nil files))
18620 (mapc
18621 (lambda (f)
18622 (when (featurep (intern (file-name-nondirectory f)))
18623 (if (and (not uncompiled)
18624 (file-exists-p (concat f ".elc")))
18625 (load (concat f ".elc") nil nil t)
18626 (load (concat f ".el") nil nil t))))
18627 files))
18628 (org-version))
18630 ;;;###autoload
18631 (defun org-customize ()
18632 "Call the customize function with org as argument."
18633 (interactive)
18634 (org-load-modules-maybe)
18635 (org-require-autoloaded-modules)
18636 (customize-browse 'org))
18638 (defun org-create-customize-menu ()
18639 "Create a full customization menu for Org-mode, insert it into the menu."
18640 (interactive)
18641 (org-load-modules-maybe)
18642 (org-require-autoloaded-modules)
18643 (if (fboundp 'customize-menu-create)
18644 (progn
18645 (easy-menu-change
18646 '("Org") "Customize"
18647 `(["Browse Org group" org-customize t]
18648 "--"
18649 ,(customize-menu-create 'org)
18650 ["Set" Custom-set t]
18651 ["Save" Custom-save t]
18652 ["Reset to Current" Custom-reset-current t]
18653 ["Reset to Saved" Custom-reset-saved t]
18654 ["Reset to Standard Settings" Custom-reset-standard t]))
18656 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18658 ;;;; Miscellaneous stuff
18660 ;;; Generally useful functions
18662 (defun org-get-at-bol (property)
18663 "Get text property PROPERTY at beginning of line."
18664 (get-text-property (point-at-bol) property))
18666 (defun org-find-text-property-in-string (prop s)
18667 "Return the first non-nil value of property PROP in string S."
18668 (or (get-text-property 0 prop s)
18669 (get-text-property (or (next-single-property-change 0 prop s) 0)
18670 prop s)))
18672 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18673 "Display the given MESSAGE as a warning."
18674 (if (fboundp 'display-warning)
18675 (display-warning 'org message
18676 (if (featurep 'xemacs) 'warning :warning))
18677 (let ((buf (get-buffer-create "*Org warnings*")))
18678 (with-current-buffer buf
18679 (goto-char (point-max))
18680 (insert "Warning (Org): " message)
18681 (unless (bolp)
18682 (newline)))
18683 (display-buffer buf)
18684 (sit-for 0))))
18686 (defun org-eval (form)
18687 "Eval FORM and return result."
18688 (condition-case error
18689 (eval form)
18690 (error (format "%%![Error: %s]" error))))
18692 (defun org-in-commented-line ()
18693 "Is point in a line starting with `#'?"
18694 (equal (char-after (point-at-bol)) ?#))
18696 (defun org-in-indented-comment-line ()
18697 "Is point in a line starting with `#' after some white space?"
18698 (save-excursion
18699 (save-match-data
18700 (goto-char (point-at-bol))
18703 (defun org-in-verbatim-emphasis ()
18704 (save-match-data
18705 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18707 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18708 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18709 (if (and marker (marker-buffer marker)
18710 (buffer-live-p (marker-buffer marker)))
18711 (progn
18712 (org-pop-to-buffer-same-window (marker-buffer marker))
18713 (if (or (> marker (point-max)) (< marker (point-min)))
18714 (widen))
18715 (goto-char marker)
18716 (org-show-context 'org-goto))
18717 (if bookmark
18718 (bookmark-jump bookmark)
18719 (error "Cannot find location"))))
18721 (defun org-quote-csv-field (s)
18722 "Quote field for inclusion in CSV material."
18725 s))
18727 (defun org-force-self-insert (N)
18728 "Needed to enforce self-insert under remapping."
18729 (interactive "p")
18730 (self-insert-command N))
18732 (defun org-string-width (s)
18733 "Compute width of string, ignoring invisible characters.
18734 This ignores character with invisibility property `org-link', and also
18735 characters with property `org-cwidth', because these will become invisible
18736 upon the next fontification round."
18737 (let (b l)
18738 (when (or (eq t buffer-invisibility-spec)
18739 (assq 'org-link buffer-invisibility-spec))
18740 (while (setq b (text-property-any 0 (length s)
18741 'invisible 'org-link s))
18742 (setq s (concat (substring s 0 b)
18743 (substring s (or (next-single-property-change
18744 b 'invisible s) (length s)))))))
18745 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18746 (setq s (concat (substring s 0 b)
18747 (substring s (or (next-single-property-change
18748 b 'org-cwidth s) (length s))))))
18749 (setq l (string-width s) b -1)
18750 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18751 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18752 l))
18754 (defun org-shorten-string (s maxlength)
18755 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18756 If the string is shorter or has length MAXLENGTH, just return the
18757 original string. If it is longer, the functions finds a space in the
18758 string, breaks this string off at that locations and adds three dots
18759 as ellipsis. Including the ellipsis, the string will not be longer
18760 than MAXLENGTH. If finding a good breaking point in the string does
18761 not work, the string is just chopped off in the middle of a word
18762 if necessary."
18763 (if (<= (length s) maxlength)
18764 s
18765 (let* ((n (max (- maxlength 4) 1))
18767 (if (string-match re s)
18768 (concat (match-string 1 s) "...")
18769 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18771 (defun org-get-indentation (&optional line)
18772 "Get the indentation of the current line, interpreting tabs.
18773 When LINE is given, assume it represents a line and compute its indentation."
18774 (if line
18775 (if (string-match "^ *" (org-remove-tabs line))
18776 (match-end 0))
18777 (save-excursion
18778 (beginning-of-line 1)
18780 (current-column))))
18782 (defun org-get-string-indentation (s)
18783 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18784 (let ((n -1) (i 0) (w tab-width) c)
18785 (catch 'exit
18786 (while (< (setq n (1+ n)) (length s))
18787 (setq c (aref s n))
18788 (cond ((= c ?\ ) (setq i (1+ i)))
18790 (t (throw 'exit t)))))
18791 i))
18793 (defun org-remove-tabs (s &optional width)
18794 "Replace tabulators in S with spaces.
18795 Assumes that s is a single line, starting in column 0."
18796 (setq width (or width tab-width))
18798 (setq s (replace-match
18799 (make-string
18800 (- (* width (/ (+ (match-beginning 0) width) width))
18801 (match-beginning 0)) ?\ )
18802 t t s)))
18803 s)
18805 (defun org-fix-indentation (line ind)
18806 "Fix indentation in LINE.
18807 IND is a cons cell with target and minimum indentation.
18808 If the current indentation in LINE is smaller than the minimum,
18809 leave it alone. If it is larger than ind, set it to the target."
18810 (let* ((l (org-remove-tabs line))
18811 (i (org-get-indentation l))
18812 (i1 (car ind)) (i2 (cdr ind)))
18813 (if (>= i i2) (setq l (substring line i2)))
18814 (if (> i1 0)
18815 (concat (make-string i1 ?\ ) l)
18816 l)))
18818 (defun org-remove-indentation (code &optional n)
18819 "Remove the maximum common indentation from the lines in CODE.
18820 N may optionally be the number of spaces to remove."
18821 (with-temp-buffer
18822 (insert code)
18823 (org-do-remove-indentation n)
18824 (buffer-string)))
18826 (defun org-do-remove-indentation (&optional n)
18827 "Remove the maximum common indentation from the buffer."
18828 (untabify (point-min) (point-max))
18829 (let ((min 10000) re)
18830 (if n
18831 (setq min n)
18832 (goto-char (point-min))
18834 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18835 (unless (or (= min 0) (= min 10000))
18837 (goto-char (point-min))
18838 (while (re-search-forward re nil t)
18839 (replace-match "")
18840 (end-of-line 1))
18841 min)))
18843 (defun org-fill-template (template alist)
18844 "Find each %key of ALIST in TEMPLATE and replace it."
18845 (let ((case-fold-search nil)
18846 entry key value)
18847 (setq alist (sort (copy-sequence alist)
18848 (lambda (a b) (< (length (car a)) (length (car b))))))
18849 (while (setq entry (pop alist))
18850 (setq template
18851 (replace-regexp-in-string
18852 (concat "%" (regexp-quote (car entry)))
18853 (cdr entry) template t t)))
18854 template))
18856 (defun org-base-buffer (buffer)
18857 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18858 (if (not buffer)
18859 buffer
18860 (or (buffer-base-buffer buffer)
18861 buffer)))
18863 (defun org-trim (s)
18864 "Remove whitespace at beginning and end of string."
18867 s)
18869 (defun org-wrap (string &optional width lines)
18870 "Wrap string to either a number of lines, or a width in characters.
18871 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18872 that costs. If there is a word longer than WIDTH, the text is actually
18873 wrapped to the length of that word.
18874 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18875 many lines, whatever width that takes.
18876 The return value is a list of lines, without newlines at the end."
18878 (maxword (apply 'max (mapcar 'org-string-width words)))
18879 w ll)
18880 (cond (width
18881 (org-do-wrap words (max maxword width)))
18882 (lines
18883 (setq w maxword)
18884 (setq ll (org-do-wrap words maxword))
18885 (if (<= (length ll) lines)
18886 ll
18887 (setq ll words)
18888 (while (> (length ll) lines)
18889 (setq w (1+ w))
18890 (setq ll (org-do-wrap words w)))
18891 ll))
18892 (t (error "Cannot wrap this")))))
18894 (defun org-do-wrap (words width)
18895 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18896 (let (lines line)
18897 (while words
18898 (setq line (pop words))
18899 (while (and words (< (+ (length line) (length (car words))) width))
18900 (setq line (concat line " " (pop words))))
18901 (setq lines (push line lines)))
18902 (nreverse lines)))
18904 (defun org-split-string (string &optional separators)
18905 "Splits STRING into substrings at SEPARATORS.
18906 No empty strings are returned if there are matches at the beginning
18907 and end of string."
18909 (start 0)
18910 notfirst
18911 (list nil))
18912 (while (and (string-match rexp string
18913 (if (and notfirst
18914 (= start (match-beginning 0))
18915 (< start (length string)))
18916 (1+ start) start))
18917 (< (match-beginning 0) (length string)))
18918 (setq notfirst t)
18919 (or (eq (match-beginning 0) 0)
18920 (and (eq (match-beginning 0) (match-end 0))
18921 (eq (match-beginning 0) start))
18922 (setq list
18923 (cons (substring string start (match-beginning 0))
18924 list)))
18925 (setq start (match-end 0)))
18926 (or (eq start (length string))
18927 (setq list
18928 (cons (substring string start)
18929 list)))
18930 (nreverse list)))
18932 (defun org-quote-vert (s)
18934 (while (string-match "|" s)
18936 s)
18938 (defun org-uuidgen-p (s)
18939 "Is S an ID created by UUIDGEN?"
18940 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18942 (defun org-context ()
18943 "Return a list of contexts of the current cursor position.
18944 If several contexts apply, all are returned.
18945 Each context entry is a list with a symbol naming the context, and
18946 two positions indicating start and end of the context. Possible
18947 contexts are:
18949 :headline anywhere in a headline
18950 :headline-stars on the leading stars in a headline
18951 :todo-keyword on a TODO keyword (including DONE) in a headline
18952 :tags on the TAGS in a headline
18953 :priority on the priority cookie in a headline
18954 :item on the first line of a plain list item
18955 :item-bullet on the bullet/number of a plain list item
18956 :checkbox on the checkbox in a plain list item
18957 :table in an org-mode table
18958 :table-special on a special filed in a table
18959 :table-table in a table.el table
18960 :link on a hyperlink
18961 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18962 :target on a <<target>>
18963 :radio-target on a <<<radio-target>>>
18964 :latex-fragment on a LaTeX fragment
18965 :latex-preview on a LaTeX fragment with overlayed preview image
18967 This function expects the position to be visible because it uses font-lock
18968 faces as a help to recognize the following contexts: :table-special, :link,
18969 and :keyword."
18970 (let* ((f (get-text-property (point) 'face))
18971 (faces (if (listp f) f (list f)))
18972 (p (point)) clist o)
18973 ;; First the large context
18974 (cond
18975 ((org-on-heading-p t)
18976 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18977 (when (progn
18978 (beginning-of-line 1)
18979 (looking-at org-todo-line-tags-regexp))
18980 (push (org-point-in-group p 1 :headline-stars) clist)
18981 (push (org-point-in-group p 2 :todo-keyword) clist)
18982 (push (org-point-in-group p 4 :tags) clist))
18983 (goto-char p)
18986 (push (org-point-in-group p 0 :priority) clist)))
18988 ((org-at-item-p)
18989 (push (org-point-in-group p 2 :item-bullet) clist)
18990 (push (list :item (point-at-bol)
18991 (save-excursion (org-end-of-item) (point)))
18992 clist)
18993 (and (org-at-item-checkbox-p)
18994 (push (org-point-in-group p 0 :checkbox) clist)))
18996 ((org-at-table-p)
18997 (push (list :table (org-table-begin) (org-table-end)) clist)
18998 (if (memq 'org-formula faces)
18999 (push (list :table-special
19000 (previous-single-property-change p 'face)
19001 (next-single-property-change p 'face)) clist)))
19002 ((org-at-table-p 'any)
19003 (push (list :table-table) clist)))
19004 (goto-char p)
19006 ;; Now the small context
19007 (cond
19008 ((org-at-timestamp-p)
19009 (push (org-point-in-group p 0 :timestamp) clist))
19010 ((memq 'org-link faces)
19011 (push (list :link
19012 (previous-single-property-change p 'face)
19013 (next-single-property-change p 'face)) clist))
19014 ((memq 'org-special-keyword faces)
19015 (push (list :keyword
19016 (previous-single-property-change p 'face)
19017 (next-single-property-change p 'face)) clist))
19018 ((org-on-target-p)
19019 (push (org-point-in-group p 0 :target) clist)
19020 (goto-char (1- (match-beginning 0)))
19021 (if (looking-at org-radio-target-regexp)
19022 (push (org-point-in-group p 0 :radio-target) clist))
19023 (goto-char p))
19024 ((setq o (car (delq nil
19025 (mapcar
19026 (lambda (x)
19027 (if (memq x org-latex-fragment-image-overlays) x))
19028 (overlays-at (point))))))
19029 (push (list :latex-fragment
19030 (overlay-start o) (overlay-end o)) clist)
19031 (push (list :latex-preview
19032 (overlay-start o) (overlay-end o)) clist))
19033 ((org-inside-LaTeX-fragment-p)
19034 ;; FIXME: positions wrong.
19035 (push (list :latex-fragment (point) (point)) clist)))
19037 (setq clist (nreverse (delq nil clist)))
19038 clist))
19040 ;; FIXME: Compare with at-regexp-p Do we need both?
19041 (defun org-in-regexp (re &optional nlines visually)
19042 "Check if point is inside a match of regexp.
19043 Normally only the current line is checked, but you can include NLINES extra
19044 lines both before and after point into the search.
19045 If VISUALLY is set, require that the cursor is not after the match but
19046 really on, so that the block visually is on the match."
19047 (catch 'exit
19048 (let ((pos (point))
19049 (eol (point-at-eol (+ 1 (or nlines 0))))
19050 (inc (if visually 1 0)))
19051 (save-excursion
19052 (beginning-of-line (- 1 (or nlines 0)))
19053 (while (re-search-forward re eol t)
19054 (if (and (<= (match-beginning 0) pos)
19055 (>= (+ inc (match-end 0)) pos))
19056 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19058 (defun org-at-regexp-p (regexp)
19059 "Is point inside a match of REGEXP in the current line?"
19060 (catch 'exit
19061 (save-excursion
19062 (let ((pos (point)) (end (point-at-eol)))
19063 (beginning-of-line 1)
19064 (while (re-search-forward regexp end t)
19065 (if (and (<= (match-beginning 0) pos)
19066 (>= (match-end 0) pos))
19067 (throw 'exit t)))
19068 nil))))
19070 (defun org-in-regexps-block-p (start-re end-re &optional bound)
19071 "Return t if the current point is between matches of START-RE and END-RE.
19072 This will also return t if point is on one of the two matches or
19073 in an unfinished block. END-RE can be a string or a form
19074 returning a string.
19076 An optional third argument bounds the search for START-RE. It
19077 defaults to previous heading or `point-min'."
19078 (let ((pos (point))
19079 (limit (or bound (save-excursion (outline-previous-heading)))))
19080 (save-excursion
19081 ;; we're on a block when point is on start-re...
19082 (or (org-at-regexp-p start-re)
19083 ;; ... or start-re can be found above...
19084 (and (re-search-backward start-re limit t)
19085 ;; ... but no end-re between start-re and point.
19086 (not (re-search-forward (eval end-re) pos t)))))))
19088 (defun org-in-block-p (names)
19089 "Is point inside any block whose name belongs to NAMES?
19091 NAMES is a list of strings containing names of blocks."
19092 (save-match-data
19093 (catch 'exit
19094 (let ((case-fold-search t))
19095 (mapc (lambda (name)
19096 (let ((n (regexp-quote name)))
19097 (when (org-in-regexps-block-p
19100 (throw 'exit t))))
19101 names))
19102 nil)))
19104 (defun org-occur-in-agenda-files (regexp &optional nlines)
19105 "Call `multi-occur' with buffers for all agenda files."
19107 (let* ((files (org-agenda-files))
19108 (tnames (mapcar 'file-truename files))
19109 (extra org-agenda-text-search-extra-files)
19110 f)
19111 (when (eq (car extra) 'agenda-archives)
19112 (setq extra (cdr extra))
19113 (setq files (org-add-archive-files files)))
19114 (while (setq f (pop extra))
19115 (unless (member (file-truename f) tnames)
19116 (add-to-list 'files f 'append)
19117 (add-to-list 'tnames (file-truename f) 'append)))
19118 (multi-occur
19119 (mapcar (lambda (x)
19120 (with-current-buffer
19121 (or (get-file-buffer x) (find-file-noselect x))
19122 (widen)
19123 (current-buffer)))
19124 files)
19125 regexp)))
19127 (if (boundp 'occur-mode-find-occurrence-hook)
19128 ;; Emacs 23
19129 (add-hook 'occur-mode-find-occurrence-hook
19130 (lambda ()
19131 (when (org-mode-p)
19132 (org-reveal))))
19133 ;; Emacs 22
19134 (defadvice occur-mode-goto-occurrence
19135 (after org-occur-reveal activate)
19136 (and (org-mode-p) (org-reveal)))
19137 (defadvice occur-mode-goto-occurrence-other-window
19138 (after org-occur-reveal activate)
19139 (and (org-mode-p) (org-reveal)))
19140 (defadvice occur-mode-display-occurrence
19141 (after org-occur-reveal activate)
19142 (when (org-mode-p)
19143 (let ((pos (occur-mode-find-occurrence)))
19144 (with-current-buffer (marker-buffer pos)
19145 (save-excursion
19146 (goto-char pos)
19147 (org-reveal)))))))
19149 (defun org-occur-link-in-agenda-files ()
19150 "Create a link and search for it in the agendas.
19151 The link is not stored in `org-stored-links', it is just created
19152 for the search purpose."
19153 (interactive)
19154 (let ((link (condition-case nil
19155 (org-store-link nil)
19156 (error "Unable to create a link to here"))))
19157 (org-occur-in-agenda-files (regexp-quote link))))
19159 (defun org-uniquify (list)
19160 "Remove duplicate elements from LIST."
19161 (let (res)
19162 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19163 res))
19165 (defun org-delete-all (elts list)
19166 "Remove all elements in ELTS from LIST."
19167 (while elts
19168 (setq list (delete (pop elts) list)))
19169 list)
19171 (defun org-count (cl-item cl-seq)
19172 "Count the number of occurrences of ITEM in SEQ.
19173 Taken from `count' in cl-seq.el with all keyword arguments removed."
19174 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19175 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19176 (while (< cl-start cl-end)
19177 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19178 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19179 (setq cl-start (1+ cl-start)))
19180 cl-count))
19182 (defun org-remove-if (predicate seq)
19183 "Remove everything from SEQ that fulfills PREDICATE."
19184 (let (res e)
19185 (while seq
19186 (setq e (pop seq))
19187 (if (not (funcall predicate e)) (push e res)))
19188 (nreverse res)))
19190 (defun org-remove-if-not (predicate seq)
19191 "Remove everything from SEQ that does not fulfill PREDICATE."
19192 (let (res e)
19193 (while seq
19194 (setq e (pop seq))
19195 (if (funcall predicate e) (push e res)))
19196 (nreverse res)))
19198 (defun org-back-over-empty-lines ()
19199 "Move backwards over whitespace, to the beginning of the first empty line.
19200 Returns the number of empty lines passed."
19201 (let ((pos (point)))
19202 (if (cdr (assoc 'heading org-blank-before-new-entry))
19204 (forward-line -1))
19205 (beginning-of-line 2)
19206 (goto-char (min (point) pos))
19207 (count-lines (point) pos)))
19209 (defun org-skip-whitespace ()
19212 (defun org-point-in-group (point group &optional context)
19213 "Check if POINT is in match-group GROUP.
19214 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19215 match. If the match group does not exist or point is not inside it,
19216 return nil."
19217 (and (match-beginning group)
19218 (>= point (match-beginning group))
19219 (<= point (match-end group))
19220 (if context
19221 (list context (match-beginning group) (match-end group))
19222 t)))
19224 (defun org-switch-to-buffer-other-window (&rest args)
19225 "Switch to buffer in a second window on the current frame.
19226 In particular, do not allow pop-up frames.
19227 Returns the newly created buffer."
19228 (let (pop-up-frames special-display-buffer-names special-display-regexps
19229 special-display-function)
19230 (apply 'switch-to-buffer-other-window args)))
19232 (defun org-combine-plists (&rest plists)
19233 "Create a single property list from all plists in PLISTS.
19234 The process starts by copying the first list, and then setting properties
19235 from the other lists. Settings in the last list are the most significant
19236 ones and overrule settings in the other lists."
19237 (let ((rtn (copy-sequence (pop plists)))
19238 p v ls)
19239 (while plists
19240 (setq ls (pop plists))
19241 (while ls
19242 (setq p (pop ls) v (pop ls))
19243 (setq rtn (plist-put rtn p v))))
19244 rtn))
19246 (defun org-move-line-down (arg)
19247 "Move the current line down. With prefix argument, move it past ARG lines."
19248 (interactive "p")
19249 (let ((col (current-column))
19250 beg end pos)
19251 (beginning-of-line 1) (setq beg (point))
19252 (beginning-of-line 2) (setq end (point))
19253 (beginning-of-line (+ 1 arg))
19254 (setq pos (move-marker (make-marker) (point)))
19255 (insert (delete-and-extract-region beg end))
19256 (goto-char pos)
19257 (org-move-to-column col)))
19259 (defun org-move-line-up (arg)
19260 "Move the current line up. With prefix argument, move it past ARG lines."
19261 (interactive "p")
19262 (let ((col (current-column))
19263 beg end pos)
19264 (beginning-of-line 1) (setq beg (point))
19265 (beginning-of-line 2) (setq end (point))
19266 (beginning-of-line (- arg))
19267 (setq pos (move-marker (make-marker) (point)))
19268 (insert (delete-and-extract-region beg end))
19269 (goto-char pos)
19270 (org-move-to-column col)))
19272 (defun org-replace-escapes (string table)
19273 "Replace %-escapes in STRING with values in TABLE.
19275 The sequences in STRING may contain normal field width and padding information,
19277 so values can contain further %-escapes if they are define later in TABLE."
19278 (let ((tbl (copy-alist table))
19279 (case-fold-search nil)
19280 (pchg 0)
19281 e re rpl)
19282 (while (setq e (pop tbl))
19283 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19284 (when (and (cdr e) (string-match re (cdr e)))
19285 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19286 (safe "SREF"))
19287 (add-text-properties 0 3 (list 'sref sref) safe)
19288 (setcdr e (replace-match safe t t (cdr e)))))
19289 (while (string-match re string)
19290 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19291 (cdr e)))
19292 (setq string (replace-match rpl t t string))))
19293 (while (setq pchg (next-property-change pchg string))
19294 (let ((sref (get-text-property pchg 'sref string)))
19295 (when (and sref (string-match "SREF" string pchg))
19296 (setq string (replace-match sref t t string)))))
19297 string))
19299 (defun org-sublist (list start end)
19300 "Return a section of LIST, from START to END.
19301 Counting starts at 1."
19302 (let (rtn (c start))
19303 (setq list (nthcdr (1- start) list))
19304 (while (and list (<= c end))
19305 (push (pop list) rtn)
19306 (setq c (1+ c)))
19307 (nreverse rtn)))
19309 (defun org-find-base-buffer-visiting (file)
19310 "Like `find-buffer-visiting' but always return the base buffer and
19311 not an indirect buffer."
19312 (let ((buf (or (get-file-buffer file)
19313 (find-buffer-visiting file))))
19314 (if buf
19315 (or (buffer-base-buffer buf) buf)
19316 nil)))
19318 (defun org-image-file-name-regexp (&optional extensions)
19319 "Return regexp matching the file names of images.
19320 If EXTENSIONS is given, only match these."
19321 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19322 (image-file-name-regexp)
19323 (let ((image-file-name-extensions
19324 (or extensions
19325 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19326 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19328 (regexp-opt (nconc (mapcar 'upcase
19329 image-file-name-extensions)
19330 image-file-name-extensions)
19331 t)
19334 (defun org-file-image-p (file &optional extensions)
19335 "Return non-nil if FILE is an image."
19336 (save-match-data
19337 (string-match (org-image-file-name-regexp extensions) file)))
19339 (defun org-get-cursor-date ()
19340 "Return the date at cursor in as a time.
19341 This works in the calendar and in the agenda, anywhere else it just
19342 returns the current time."
19343 (let (date day defd)
19344 (cond
19345 ((eq major-mode 'calendar-mode)
19346 (setq date (calendar-cursor-to-date)
19347 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19348 ((eq major-mode 'org-agenda-mode)
19349 (setq day (get-text-property (point) 'day))
19350 (if day
19351 (setq date (calendar-gregorian-from-absolute day)
19352 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19353 (nth 2 date))))))
19354 (or defd (current-time))))
19356 (defvar org-agenda-action-marker (make-marker)
19357 "Marker pointing to the entry for the next agenda action.")
19359 (defun org-mark-entry-for-agenda-action ()
19360 "Mark the current entry as target of an agenda action.
19361 Agenda actions are actions executed from the agenda with the key `k',
19362 which make use of the date at the cursor."
19363 (interactive)
19364 (move-marker org-agenda-action-marker
19365 (save-excursion (org-back-to-heading t) (point))
19366 (current-buffer))
19367 (message
19368 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19370 (defun org-mark-subtree ()
19371 "Mark the current subtree.
19372 This puts point at the start of the current subtree, and mark at the end.
19374 If point is in an inline task, mark that task instead."
19375 (interactive)
19376 (let ((inline-task-p
19377 (and (featurep 'org-inlinetask)
19378 (org-inlinetask-in-task-p)))
19379 (beg))
19380 ;; Get beginning of subtree
19381 (cond
19382 (inline-task-p (org-inlinetask-goto-beginning))
19383 ((org-at-heading-p) (beginning-of-line))
19384 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19385 (setq beg (point))
19386 ;; Get end of it
19387 (if inline-task-p
19388 (org-inlinetask-goto-end)
19389 (org-end-of-subtree))
19390 ;; Mark zone
19391 (push-mark (point) nil t)
19392 (goto-char beg)))
19394 ;;; Paragraph filling stuff.
19395 ;; We want this to be just right, so use the full arsenal.
19397 (defun org-indent-line-function ()
19398 "Indent line depending on context."
19399 (interactive)
19400 (let* ((pos (point))
19401 (itemp (org-at-item-p))
19402 (case-fold-search t)
19404 (inline-task-p (and (featurep 'org-inlinetask)
19405 (org-inlinetask-in-task-p)))
19406 (inline-re (and inline-task-p
19407 (org-inlinetask-outline-regexp)))
19408 column)
19409 (beginning-of-line 1)
19410 (cond
19411 ;; Comments
19412 ((looking-at "# ") (setq column 0))
19413 ;; Headings
19414 ((looking-at org-outline-regexp) (setq column 0))
19415 ;; Included files
19417 ;; Footnote definition
19418 ((looking-at org-footnote-definition-re) (setq column 0))
19419 ;; Literal examples
19421 (setq column (org-get-indentation))) ; do nothing
19422 ;; Lists
19423 ((ignore-errors (goto-char (org-in-item-p)))
19424 (setq column (if itemp
19425 (org-get-indentation)
19426 (org-list-item-body-column (point))))
19427 (goto-char pos))
19428 ;; Drawers
19430 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19431 (save-excursion
19432 (goto-char (1- (match-beginning 1)))
19433 (setq column (current-column))))
19434 ;; Special blocks
19436 (save-excursion
19437 (re-search-backward
19439 (setq column (org-get-indentation (match-string 0))))
19442 (save-excursion
19444 (setq column
19445 (if (equal (downcase (match-string 1)) "src")
19446 ;; src blocks: let `org-edit-src-exit' handle them
19447 (org-get-indentation)
19448 (org-get-indentation (match-string 0)))))
19449 ;; This line has nothing special, look at the previous relevant
19450 ;; line to compute indentation
19451 (t
19452 (beginning-of-line 0)
19453 (while (and (not (bobp))
19454 (not (looking-at org-drawer-regexp))
19455 ;; When point started in an inline task, do not move
19456 ;; above task starting line.
19457 (not (and inline-task-p (looking-at inline-re)))
19458 ;; Skip drawers, blocks, empty lines, verbatim,
19459 ;; comments, tables, footnotes definitions, lists,
19460 ;; inline tasks.
19462 (re-search-backward org-drawer-regexp nil t))
19466 (looking-at org-footnote-definition-re)
19467 (and (ignore-errors (goto-char (org-in-item-p)))
19468 (goto-char
19469 (org-list-get-top-point (org-list-struct))))
19470 (and (not inline-task-p)
19471 (featurep 'org-inlinetask)
19472 (org-inlinetask-in-task-p)
19473 (or (org-inlinetask-goto-beginning) t))))
19474 (beginning-of-line 0))
19475 (cond
19476 ;; There was an heading above.
19478 (if (not org-adapt-indentation)
19479 (setq column 0)
19480 (goto-char (match-end 0))
19481 (setq column (current-column))))
19482 ;; A drawer had started and is unfinished
19483 ((looking-at org-drawer-regexp)
19484 (goto-char (1- (match-beginning 1)))
19485 (setq column (current-column)))
19486 ;; Else, nothing noticeable found: get indentation and go on.
19487 (t (setq column (org-get-indentation))))))
19488 ;; Now apply indentation and move cursor accordingly
19489 (goto-char pos)
19490 (if (<= (current-column) (current-indentation))
19491 (org-indent-line-to column)
19492 (save-excursion (org-indent-line-to column)))
19493 ;; Special polishing for properties, see `org-property-format'
19494 (setq column (current-column))
19495 (beginning-of-line 1)
19496 (if (looking-at
19498 (replace-match (concat (match-string 1)
19499 (format org-property-format
19500 (match-string 2) (match-string 3)))
19501 t t))
19502 (org-move-to-column column)))
19504 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19505 "Variable to store copy of `adaptive-fill-regexp'.
19506 Since `adaptive-fill-regexp' is set to never match, we need to
19507 store a backup of its value before entering `org-mode' so that
19508 the functionality can be provided as a fall-back.")
19510 (defun org-set-autofill-regexps ()
19511 (interactive)
19512 ;; In the paragraph separator we include headlines, because filling
19513 ;; text in a line directly attached to a headline would otherwise
19514 ;; fill the headline as well.
19517 ;; The paragraph starter includes hand-formatted lists.
19518 (org-set-local
19519 'paragraph-start
19520 (concat
19529 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19530 ;; But only if the user has not turned off tables or fixed-width regions
19531 (org-set-local
19532 'auto-fill-inhibit-regexp
19533 (concat org-outline-regexp
19536 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19537 (concat
19539 (if org-enable-table-editor "|" "")
19540 (if org-enable-fixed-width-editor ":" "")
19541 "]"))))
19542 ;; We use our own fill-paragraph function, to make sure that tables
19543 ;; and fixed-width regions are not wrapped. That function will pass
19544 ;; through to `fill-paragraph' when appropriate.
19545 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19546 ;; Prevent auto-fill from inserting unwanted new items.
19547 (org-set-local 'fill-nobreak-predicate
19548 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19549 fill-nobreak-predicate
19550 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19551 ;; Adaptive filling: To get full control, first make sure that
19552 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19553 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19554 (org-set-local 'org-adaptive-fill-regexp-backup
19555 adaptive-fill-regexp))
19557 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19558 (org-set-local 'adaptive-fill-function
19559 'org-adaptive-fill-function)
19560 (org-set-local
19561 'align-mode-rules-list
19562 '((org-in-buffer-settings
19564 (modes . '(org-mode))))))
19566 (defun org-fill-item-nobreak-p ()
19567 "Non-nil when a line break at point would insert a new item."
19568 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19570 (defun org-fill-paragraph (&optional justify)
19571 "Re-align a table, pass through to fill-paragraph if no table."
19572 (let ((table-p (org-at-table-p))
19573 (table.el-p (org-at-table.el-p))
19574 (itemp (org-in-item-p)))
19575 (cond ((and (equal (char-after (point-at-bol)) ?*)
19576 (save-excursion (goto-char (point-at-bol))
19577 (looking-at org-outline-regexp)))
19578 t) ; skip headlines
19579 (table.el-p t) ; skip table.el tables
19580 (table-p (org-table-align) t) ; align Org tables
19581 (itemp ; align text in items
19582 (let* ((struct (save-excursion (goto-char itemp)
19583 (org-list-struct)))
19584 (parents (org-list-parents-alist struct))
19585 (children (org-list-get-children itemp struct parents))
19586 beg end prev next prefix)
19587 ;; Determine in which part of item point is: before
19588 ;; first child, after last child, between two
19589 ;; sub-lists, or simply in item if there's no child.
19590 (cond
19591 ((not children)
19592 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19593 beg itemp
19594 end (org-list-get-item-end itemp struct)))
19595 ((< (point) (setq next (car children)))
19596 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19597 beg itemp
19598 end next))
19599 ((> (point) (setq prev (car (last children))))
19600 (setq beg (org-list-get-item-end prev struct)
19601 end (org-list-get-item-end itemp struct)
19602 prefix (save-excursion
19603 (goto-char beg)
19605 (make-string (current-column) ?\ ))))
19606 (t (catch 'exit
19607 (while (setq next (pop children))
19608 (if (> (point) next)
19609 (setq prev next)
19610 (setq beg (org-list-get-item-end prev struct)
19611 end next
19612 prefix (save-excursion
19613 (goto-char beg)
19615 (make-string (current-column) ?\ )))
19616 (throw 'exit nil))))))
19617 ;; Use `fill-paragraph' with buffer narrowed to item
19618 ;; without any child, and with our computed PREFIX.
19619 (flet ((fill-context-prefix (from to &optional flr) prefix))
19620 (save-restriction
19621 (narrow-to-region beg end)
19622 (save-excursion (fill-paragraph justify)))) t))
19623 ;; Special case where point is not in a list but is on
19624 ;; a paragraph adjacent to a list: make sure this paragraph
19625 ;; doesn't get merged with the end of the list by narrowing
19626 ;; buffer first.
19627 ((save-excursion (forward-paragraph -1)
19628 (setq itemp (org-in-item-p)))
19629 (let ((struct (save-excursion (goto-char itemp)
19630 (org-list-struct))))
19631 (save-restriction
19632 (narrow-to-region (org-list-get-bottom-point struct)
19633 (save-excursion (forward-paragraph 1)
19634 (point)))
19635 (fill-paragraph justify) t)))
19636 ;; Else simply call `fill-paragraph'.
19637 (t nil))))
19639 ;; For reference, this is the default value of adaptive-fill-regexp
19642 (defun org-adaptive-fill-function ()
19643 "Return a fill prefix for org-mode files."
19644 (let (itemp)
19645 (save-excursion
19646 (cond
19647 ;; Comment line
19649 (match-string-no-properties 0))
19650 ;; Plain list item
19651 ((org-at-item-p)
19652 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19653 ;; Point is in a list after `backward-paragraph': original
19654 ;; point wasn't in the list, or filling would have been taken
19655 ;; care of by `org-auto-fill-function', but the list and the
19656 ;; real paragraph are not separated by a blank line. Thus, move
19657 ;; point after the list to go back to real paragraph and
19658 ;; determine fill-prefix.
19659 ((setq itemp (org-in-item-p))
19660 (goto-char itemp)
19661 (let* ((struct (org-list-struct))
19662 (bottom (org-list-get-bottom-point struct)))
19663 (goto-char bottom)
19664 (make-string (org-get-indentation) ?\ )))
19665 ;; Other text
19666 ((looking-at org-adaptive-fill-regexp-backup)
19667 (match-string-no-properties 0))))))
19669 (defun org-auto-fill-function ()
19670 "Auto-fill function."
19671 (let (itemp prefix)
19672 ;; When in a list, compute an appropriate fill-prefix and make
19673 ;; sure it will be used by `do-auto-fill'.
19674 (if (setq itemp (org-in-item-p))
19675 (progn
19676 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19677 (flet ((fill-context-prefix (from to &optional flr) prefix))
19678 (do-auto-fill)))
19679 ;; Else just use `do-auto-fill'.
19680 (do-auto-fill))))
19682 ;;; Other stuff.
19684 (defun org-toggle-fixed-width-section (arg)
19685 "Toggle the fixed-width export.
19686 If there is no active region, the QUOTE keyword at the current headline is
19687 inserted or removed. When present, it causes the text between this headline
19688 and the next to be exported as fixed-width text, and unmodified.
19689 If there is an active region, this command adds or removes a colon as the
19690 first character of this line. If the first character of a line is a colon,
19691 this line is also exported in fixed-width font."
19692 (interactive "P")
19693 (let* ((cc 0)
19694 (regionp (org-region-active-p))
19695 (beg (if regionp (region-beginning) (point)))
19696 (end (if regionp (region-end)))
19697 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19698 (case-fold-search nil)
19700 off)
19701 (if regionp
19702 (save-excursion
19703 (goto-char beg)
19704 (setq cc (current-column))
19705 (beginning-of-line 1)
19706 (setq off (looking-at re))
19707 (while (> nlines 0)
19708 (setq nlines (1- nlines))
19709 (beginning-of-line 1)
19710 (cond
19711 (arg
19712 (org-move-to-column cc t)
19714 (forward-line -1))
19715 ((and off (looking-at re))
19716 (replace-match "" t t nil 1))
19717 ((not off) (org-move-to-column cc t) (insert ": ")))
19718 (forward-line 1)))
19719 (save-excursion
19720 (org-back-to-heading)
19721 (if (looking-at (concat org-outline-regexp
19723 (replace-match "" t t nil 1)
19724 (if (looking-at org-outline-regexp)
19725 (progn
19726 (goto-char (match-end 0))
19727 (insert org-quote-string " "))))))))
19729 (defun org-reftex-citation ()
19730 "Use reftex-citation to insert a citation into the buffer.
19731 This looks for a line like
19733 #+BIBLIOGRAPHY: foo plain option:-d
19735 and derives from it that foo.bib is the bibliography file relevant
19736 for this document. It then installs the necessary environment for RefTeX
19737 to work in this buffer and calls `reftex-citation' to insert a citation
19738 into the buffer.
19740 Export of such citations to both LaTeX and HTML is handled by the contributed
19741 package org-exp-bibtex by Taru Karttunen."
19742 (interactive)
19743 (let ((reftex-docstruct-symbol 'rds)
19745 rds bib)
19746 (save-excursion
19747 (save-restriction
19748 (widen)
19749 (let ((case-fold-search t)
19751 (if (not (save-excursion
19752 (or (re-search-forward re nil t)
19753 (re-search-backward re nil t))))
19754 (error "No bibliography defined in file")
19755 (setq bib (concat (match-string 1) ".bib")
19756 rds (list (list 'bib bib)))))))
19757 (call-interactively 'reftex-citation)))
19759 ;;;; Functions extending outline functionality
19761 (defun org-beginning-of-line (&optional arg)
19762 "Go to the beginning of the current line. If that is invisible, continue
19763 to a visible line beginning. This makes the function of C-a more intuitive.
19764 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19765 first attempt, and only move to after the tags when the cursor is already
19766 beyond the end of the headline."
19767 (interactive "P")
19768 (let ((pos (point))
19769 (special (if (consp org-special-ctrl-a/e)
19770 (car org-special-ctrl-a/e)
19771 org-special-ctrl-a/e))
19772 refpos)
19773 (if (org-bound-and-true-p line-move-visual)
19774 (beginning-of-visual-line 1)
19775 (beginning-of-line 1))
19776 (if (and arg (fboundp 'move-beginning-of-line))
19777 (call-interactively 'move-beginning-of-line)
19778 (if (bobp)
19779 nil
19780 (backward-char 1)
19781 (if (org-truely-invisible-p)
19782 (while (and (not (bobp)) (org-truely-invisible-p))
19783 (backward-char 1)
19784 (beginning-of-line 1))
19785 (forward-char 1))))
19786 (when special
19787 (cond
19788 ((and (looking-at org-complex-heading-regexp)
19789 (= (char-after (match-end 1)) ?\ ))
19790 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19791 (point-at-eol)))
19792 (goto-char
19793 (if (eq special t)
19794 (cond ((> pos refpos) refpos)
19795 ((= pos (point)) refpos)
19796 (t (point)))
19797 (cond ((> pos (point)) (point))
19798 ((not (eq last-command this-command)) (point))
19799 (t refpos)))))
19800 ((org-at-item-p)
19801 (goto-char
19802 (if (eq special t)
19803 (cond ((> pos (match-end 0)) (match-end 0))
19804 ((= pos (point)) (match-end 0))
19805 (t (point)))
19806 (cond ((> pos (point)) (point))
19807 ((not (eq last-command this-command)) (point))
19808 (t (match-end 0))))))))
19809 (org-no-warnings
19810 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19812 (defun org-end-of-line (&optional arg)
19813 "Go to the end of the line.
19814 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19815 first attempt, and only move to after the tags when the cursor is already
19816 beyond the end of the headline."
19817 (interactive "P")
19818 (let ((special (if (consp org-special-ctrl-a/e)
19819 (cdr org-special-ctrl-a/e)
19820 org-special-ctrl-a/e)))
19821 (if (or (not special)
19822 (not (org-on-heading-p))
19823 arg)
19824 (call-interactively
19825 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19826 ((fboundp 'move-end-of-line) 'move-end-of-line)
19827 (t 'end-of-line)))
19828 (let ((pos (point)))
19829 (beginning-of-line 1)
19831 (if (eq special t)
19832 (if (or (< pos (match-beginning 1))
19833 (= pos (match-end 0)))
19834 (goto-char (match-beginning 1))
19835 (goto-char (match-end 0)))
19836 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19837 (goto-char (match-end 0))
19838 (goto-char (match-beginning 1))))
19839 (call-interactively (if (fboundp 'move-end-of-line)
19840 'move-end-of-line
19841 'end-of-line)))))
19842 (org-no-warnings
19843 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19845 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19846 (define-key org-mode-map "\C-e" 'org-end-of-line)
19848 (defun org-backward-sentence (&optional arg)
19849 "Go to beginning of sentence, or beginning of table field.
19850 This will call `backward-sentence' or `org-table-beginning-of-field',
19851 depending on context."
19852 (interactive "P")
19853 (cond
19854 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19855 (t (call-interactively 'backward-sentence))))
19857 (defun org-forward-sentence (&optional arg)
19858 "Go to end of sentence, or end of table field.
19859 This will call `forward-sentence' or `org-table-end-of-field',
19860 depending on context."
19861 (interactive "P")
19862 (cond
19863 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19864 (t (call-interactively 'forward-sentence))))
19866 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19867 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19869 (defun org-kill-line (&optional arg)
19870 "Kill line, to tags or end of line."
19871 (interactive "P")
19872 (cond
19873 ((or (not org-special-ctrl-k)
19874 (bolp)
19875 (not (org-on-heading-p)))
19876 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19877 org-ctrl-k-protect-subtree)
19878 (if (or (eq org-ctrl-k-protect-subtree 'error)
19879 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19880 (error "C-k aborted - would kill hidden subtree")))
19881 (call-interactively 'kill-line))
19883 (kill-region (point) (match-beginning 1))
19884 (org-set-tags nil t))
19885 (t (kill-region (point) (point-at-eol)))))
19887 (define-key org-mode-map "\C-k" 'org-kill-line)
19889 (defun org-yank (&optional arg)
19890 "Yank. If the kill is a subtree, treat it specially.
19891 This command will look at the current kill and check if is a single
19892 subtree, or a series of subtrees[1]. If it passes the test, and if the
19893 cursor is at the beginning of a line or after the stars of a currently
19894 empty headline, then the yank is handled specially. How exactly depends
19895 on the value of the following variables, both set by default.
19897 org-yank-folded-subtrees
19898 When set, the subtree(s) will be folded after insertion, but only
19899 if doing so would now swallow text after the yanked text.
19901 org-yank-adjusted-subtrees
19902 When set, the subtree will be promoted or demoted in order to
19903 fit into the local outline tree structure, which means that the level
19904 will be adjusted so that it becomes the smaller one of the two
19905 *visible* surrounding headings.
19907 Any prefix to this command will cause `yank' to be called directly with
19909 will just
19910 plainly yank the text as it is.
19912 \[1] The test checks if the first non-white line is a heading
19913 and if there are no other headings with fewer stars."
19914 (interactive "P")
19915 (org-yank-generic 'yank arg))
19917 (defun org-yank-generic (command arg)
19918 "Perform some yank-like command.
19920 This function implements the behavior described in the `org-yank'
19921 documentation. However, it has been generalized to work for any
19922 interactive command with similar behavior."
19924 ;; pretend to be command COMMAND
19925 (setq this-command command)
19927 (if arg
19928 (call-interactively command)
19930 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19931 (and (org-kill-is-subtree-p)
19932 (or (bolp)
19934 (string-match
19936 (buffer-substring (point-at-bol) (point)))))))
19937 swallowp)
19938 (cond
19939 ((and subtreep org-yank-folded-subtrees)
19940 (let ((beg (point))
19941 end)
19942 (if (and subtreep org-yank-adjusted-subtrees)
19943 (org-paste-subtree nil nil 'for-yank)
19944 (call-interactively command))
19946 (setq end (point))
19947 (goto-char beg)
19948 (when (and (bolp) subtreep
19949 (not (setq swallowp
19950 (org-yank-folding-would-swallow-text beg end))))
19951 (org-with-limited-levels
19952 (or (looking-at org-outline-regexp)
19953 (re-search-forward org-outline-regexp-bol end t))
19954 (while (and (< (point) end) (looking-at org-outline-regexp))
19955 (hide-subtree)
19956 (org-cycle-show-empty-lines 'folded)
19957 (condition-case nil
19958 (outline-forward-same-level 1)
19959 (error (goto-char end))))))
19960 (when swallowp
19961 (message
19962 "Inserted text not folded because that would swallow text"))
19964 (goto-char end)
19966 (beginning-of-line 1)
19967 (push-mark beg 'nomsg)))
19968 ((and subtreep org-yank-adjusted-subtrees)
19969 (let ((beg (point-at-bol)))
19970 (org-paste-subtree nil nil 'for-yank)
19971 (push-mark beg 'nomsg)))
19972 (t
19973 (call-interactively command))))))
19975 (defun org-yank-folding-would-swallow-text (beg end)
19976 "Would hide-subtree at BEG swallow any text after END?"
19977 (let (level)
19978 (org-with-limited-levels
19979 (save-excursion
19980 (goto-char beg)
19981 (when (or (looking-at org-outline-regexp)
19982 (re-search-forward org-outline-regexp-bol end t))
19983 (setq level (org-outline-level)))
19984 (goto-char end)
19986 (if (or (eobp)
19987 (and (bolp) (looking-at org-outline-regexp)
19988 (<= (org-outline-level) level)))
19989 nil ; Nothing would be swallowed
19990 t))))) ; something would swallow
19992 (define-key org-mode-map "\C-y" 'org-yank)
19994 (defun org-truely-invisible-p ()
19995 "Check if point is at a character currently not visible.
19996 This version does not only check the character property, but also
19997 `visible-mode'."
19998 ;; Early versions of noutline don't have `outline-invisible-p'.
19999 (if (org-bound-and-true-p visible-mode)
20000 nil
20001 (outline-invisible-p)))
20003 (defun org-invisible-p2 ()
20004 "Check if point is at a character currently not visible."
20005 (save-excursion
20006 (if (and (eolp) (not (bobp))) (backward-char 1))
20007 ;; Early versions of noutline don't have `outline-invisible-p'.
20008 (outline-invisible-p)))
20010 (defun org-back-to-heading (&optional invisible-ok)
20011 "Call `outline-back-to-heading', but provide a better error message."
20012 (condition-case nil
20013 (outline-back-to-heading invisible-ok)
20014 (error (error "Before first headline at position %d in buffer %s"
20015 (point) (current-buffer)))))
20017 (defun org-beginning-of-defun ()
20018 "Go to the beginning of the subtree, i.e. back to the heading."
20019 (org-back-to-heading))
20020 (defun org-end-of-defun ()
20021 "Go to the end of the subtree."
20022 (org-end-of-subtree nil t))
20024 (defun org-before-first-heading-p ()
20025 "Before first heading?"
20026 (save-excursion
20027 (end-of-line)
20028 (null (re-search-backward org-outline-regexp-bol nil t))))
20030 (defun org-on-heading-p (&optional ignored)
20031 (outline-on-heading-p t))
20032 (defun org-at-heading-p (&optional ignored)
20033 (outline-on-heading-p t))
20035 (defun org-point-at-end-of-empty-headline ()
20036 "If point is at the end of an empty headline, return t, else nil.
20037 If the heading only contains a TODO keyword, it is still still considered
20038 empty."
20040 (save-excursion
20041 (beginning-of-line 1)
20042 (let ((case-fold-search nil))
20045 (defun org-at-heading-or-item-p ()
20046 (or (org-on-heading-p) (org-at-item-p)))
20048 (defun org-on-target-p ()
20049 (or (org-in-regexp org-radio-target-regexp)
20050 (org-in-regexp org-target-regexp)))
20052 (defun org-up-heading-all (arg)
20053 "Move to the heading line of which the present line is a subheading.
20054 This function considers both visible and invisible heading lines.
20055 With argument, move up ARG levels."
20056 (if (fboundp 'outline-up-heading-all)
20057 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20058 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20060 (defun org-up-heading-safe ()
20061 "Move to the heading line of which the present line is a subheading.
20062 This version will not throw an error. It will return the level of the
20063 headline found, or nil if no higher level is found.
20065 Also, this function will be a lot faster than `outline-up-heading',
20066 because it relies on stars being the outline starters. This can really
20067 make a significant difference in outlines with very many siblings."
20068 (let (start-level re)
20069 (org-back-to-heading t)
20070 (setq start-level (funcall outline-level))
20071 (if (equal start-level 1)
20072 nil
20074 (if (re-search-backward re nil t)
20075 (funcall outline-level)))))
20077 (defun org-first-sibling-p ()
20078 "Is this heading the first child of its parents?"
20079 (interactive)
20080 (let ((re org-outline-regexp-bol)
20081 level l)
20082 (unless (org-at-heading-p t)
20083 (error "Not at a heading"))
20084 (setq level (funcall outline-level))
20085 (save-excursion
20086 (if (not (re-search-backward re nil t))
20087 t
20088 (setq l (funcall outline-level))
20089 (< l level)))))
20091 (defun org-goto-sibling (&optional previous)
20092 "Goto the next sibling, even if it is invisible.
20093 When PREVIOUS is set, go to the previous sibling instead. Returns t
20094 when a sibling was found. When none is found, return nil and don't
20095 move point."
20096 (let ((fun (if previous 're-search-backward 're-search-forward))
20097 (pos (point))
20098 (re org-outline-regexp-bol)
20099 level l)
20100 (when (condition-case nil (org-back-to-heading t) (error nil))
20101 (setq level (funcall outline-level))
20102 (catch 'exit
20103 (or previous (forward-char 1))
20104 (while (funcall fun re nil t)
20105 (setq l (funcall outline-level))
20106 (when (< l level) (goto-char pos) (throw 'exit nil))
20107 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20108 (goto-char pos)
20109 nil))))
20111 (defun org-show-siblings ()
20112 "Show all siblings of the current headline."
20113 (save-excursion
20114 (while (org-goto-sibling) (org-flag-heading nil)))
20115 (save-excursion
20116 (while (org-goto-sibling 'previous)
20117 (org-flag-heading nil))))
20119 (defun org-goto-first-child ()
20120 "Goto the first child, even if it is invisible.
20121 Return t when a child was found. Otherwise don't move point and
20122 return nil."
20123 (let (level (pos (point)) (re org-outline-regexp-bol))
20124 (when (condition-case nil (org-back-to-heading t) (error nil))
20125 (setq level (outline-level))
20126 (forward-char 1)
20127 (if (and (re-search-forward re nil t) (> (outline-level) level))
20128 (progn (goto-char (match-beginning 0)) t)
20129 (goto-char pos) nil))))
20131 (defun org-show-hidden-entry ()
20132 "Show an entry where even the heading is hidden."
20133 (save-excursion
20134 (org-show-entry)))
20136 (defun org-flag-heading (flag &optional entry)
20137 "Flag the current heading. FLAG non-nil means make invisible.
20138 When ENTRY is non-nil, show the entire entry."
20139 (save-excursion
20140 (org-back-to-heading t)
20141 ;; Check if we should show the entire entry
20142 (if entry
20143 (progn
20144 (org-show-entry)
20145 (save-excursion
20146 (and (outline-next-heading)
20147 (org-flag-heading nil))))
20148 (outline-flag-region (max (point-min) (1- (point)))
20149 (save-excursion (outline-end-of-heading) (point))
20150 flag))))
20152 (defun org-get-next-sibling ()
20153 "Move to next heading of the same level, and return point.
20154 If there is no such heading, return nil.
20155 This is like outline-next-sibling, but invisible headings are ok."
20156 (let ((level (funcall outline-level)))
20157 (outline-next-heading)
20158 (while (and (not (eobp)) (> (funcall outline-level) level))
20159 (outline-next-heading))
20160 (if (or (eobp) (< (funcall outline-level) level))
20161 nil
20162 (point))))
20164 (defun org-get-last-sibling ()
20165 "Move to previous heading of the same level, and return point.
20166 If there is no such heading, return nil."
20167 (let ((opoint (point))
20168 (level (funcall outline-level)))
20169 (outline-previous-heading)
20170 (when (and (/= (point) opoint) (outline-on-heading-p t))
20171 (while (and (> (funcall outline-level) level)
20172 (not (bobp)))
20173 (outline-previous-heading))
20174 (if (< (funcall outline-level) level)
20175 nil
20176 (point)))))
20178 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20179 ;; This contains an exact copy of the original function, but it uses
20180 ;; `org-back-to-heading', to make it work also in invisible
20181 ;; trees. And is uses an invisible-OK argument.
20182 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20183 ;; Furthermore, when used inside Org, finding the end of a large subtree
20184 ;; with many children and grandchildren etc, this can be much faster
20185 ;; than the outline version.
20186 (org-back-to-heading invisible-OK)
20187 (let ((first t)
20188 (level (funcall outline-level)))
20189 (if (and (org-mode-p) (< level 1000))
20190 ;; A true heading (not a plain list item), in Org-mode
20191 ;; This means we can easily find the end by looking
20192 ;; only for the right number of stars. Using a regexp to do
20193 ;; this is so much faster than using a Lisp loop.
20195 (forward-char 1)
20196 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20197 ;; something else, do it the slow way
20198 (while (and (not (eobp))
20199 (or first (> (funcall outline-level) level)))
20200 (setq first nil)
20201 (outline-next-heading)))
20202 (unless to-heading
20204 (progn
20205 ;; Go to end of line before heading
20206 (forward-char -1)
20208 ;; leave blank line before heading
20209 (forward-char -1))))))
20210 (point))
20212 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20213 "Use Org version in org-mode, for dramatic speed-up."
20214 (if (org-mode-p)
20215 (progn
20216 (org-end-of-subtree nil t)
20217 (unless (eobp) (backward-char 1)))
20218 ad-do-it))
20220 (defun org-end-of-meta-data-and-drawers ()
20221 "Jump to the first text after meta data and drawers in the current entry.
20222 This will move over empty lines, lines with planning time stamps,
20223 clocking lines, and drawers."
20224 (org-back-to-heading t)
20225 (let ((end (save-excursion (outline-next-heading) (point)))
20228 (forward-line 1)
20229 (while (re-search-forward re end t)
20230 (if (not (match-end 1))
20231 ;; empty or planning line
20232 (forward-line 1)
20233 ;; a drawer, find the end
20235 (forward-line 1)))
20237 (point)))
20239 (defun org-forward-same-level (arg &optional invisible-ok)
20240 "Move forward to the arg'th subheading at same level as this one.
20241 Stop at the first and last subheadings of a superior heading.
20242 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20243 it wil also look at invisible ones."
20244 (interactive "p")
20245 (org-back-to-heading invisible-ok)
20246 (org-on-heading-p)
20247 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20249 l)
20250 (forward-char 1)
20251 (while (> arg 0)
20252 (while (and (re-search-forward re nil 'move)
20253 (setq l (- (match-end 0) (match-beginning 0) 1))
20254 (= l level)
20255 (not invisible-ok)
20256 (progn (backward-char 1) (outline-invisible-p)))
20257 (if (< l level) (setq arg 1)))
20258 (setq arg (1- arg)))
20259 (beginning-of-line 1)))
20261 (defun org-backward-same-level (arg &optional invisible-ok)
20262 "Move backward to the arg'th subheading at same level as this one.
20263 Stop at the first and last subheadings of a superior heading."
20264 (interactive "p")
20265 (org-back-to-heading)
20266 (org-on-heading-p)
20267 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20269 l)
20270 (while (> arg 0)
20271 (while (and (re-search-backward re nil 'move)
20272 (setq l (- (match-end 0) (match-beginning 0) 1))
20273 (= l level)
20274 (not invisible-ok)
20275 (outline-invisible-p))
20276 (if (< l level) (setq arg 1)))
20277 (setq arg (1- arg)))))
20279 (defun org-show-subtree ()
20280 "Show everything after this heading at deeper levels."
20281 (outline-flag-region
20282 (point)
20283 (save-excursion
20284 (org-end-of-subtree t t))
20285 nil))
20287 (defun org-show-entry ()
20288 "Show the body directly following this heading.
20289 Show the heading too, if it is currently invisible."
20290 (interactive)
20291 (save-excursion
20292 (condition-case nil
20293 (progn
20294 (org-back-to-heading t)
20295 (outline-flag-region
20296 (max (point-min) (1- (point)))
20297 (save-excursion
20298 (if (re-search-forward
20300 (match-beginning 1)
20301 (point-max)))
20302 nil)
20303 (org-cycle-hide-drawers 'children))
20304 (error nil))))
20306 (defun org-make-options-regexp (kwds &optional extra)
20307 "Make a regular expression for keyword lines."
20308 (concat
20309 "^"
20316 ;; Make isearch reveal the necessary context
20317 (defun org-isearch-end ()
20318 "Reveal context after isearch exits."
20319 (when isearch-success ; only if search was successful
20320 (if (featurep 'xemacs)
20321 ;; Under XEmacs, the hook is run in the correct place,
20322 ;; we directly show the context.
20323 (org-show-context 'isearch)
20324 ;; In Emacs the hook runs *before* restoring the overlays.
20325 ;; So we have to use a one-time post-command-hook to do this.
20326 ;; (Emacs 22 has a special variable, see function `org-mode')
20327 (unless (and (boundp 'isearch-mode-end-hook-quit)
20328 isearch-mode-end-hook-quit)
20329 ;; Only when the isearch was not quitted.
20330 (org-add-hook 'post-command-hook 'org-isearch-post-command
20331 'append 'local)))))
20333 (defun org-isearch-post-command ()
20334 "Remove self from hook, and show context."
20335 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20336 (org-show-context 'isearch))
20339 ;;;; Integration with and fixes for other packages
20341 ;;; Imenu support
20343 (defvar org-imenu-markers nil
20344 "All markers currently used by Imenu.")
20345 (make-variable-buffer-local 'org-imenu-markers)
20347 (defun org-imenu-new-marker (&optional pos)
20348 "Return a new marker for use by Imenu, and remember the marker."
20349 (let ((m (make-marker)))
20350 (move-marker m (or pos (point)))
20351 (push m org-imenu-markers)
20352 m))
20354 (defun org-imenu-get-tree ()
20355 "Produce the index for Imenu."
20356 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20357 (setq org-imenu-markers nil)
20358 (let* ((n org-imenu-depth)
20359 (re (concat "^" (org-get-limited-outline-regexp)))
20360 (subs (make-vector (1+ n) nil))
20361 (last-level 0)
20362 m level head)
20363 (save-excursion
20364 (save-restriction
20365 (widen)
20366 (goto-char (point-max))
20367 (while (re-search-backward re nil t)
20368 (setq level (org-reduced-level (funcall outline-level)))
20369 (when (<= level n)
20370 (looking-at org-complex-heading-regexp)
20371 (setq head (org-link-display-format
20372 (org-match-string-no-properties 4))
20373 m (org-imenu-new-marker))
20374 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20375 (if (>= level last-level)
20376 (push (cons head m) (aref subs level))
20377 (push (cons head (aref subs (1+ level))) (aref subs level))
20378 (loop for i from (1+ level) to n do (aset subs i nil)))
20379 (setq last-level level)))))
20380 (aref subs 1)))
20382 (eval-after-load "imenu"
20383 '(progn
20384 (add-hook 'imenu-after-jump-hook
20385 (lambda ()
20386 (if (org-mode-p)
20387 (org-show-context 'org-goto))))))
20389 (defun org-link-display-format (link)
20390 "Replace a link with either the description, or the link target
20391 if no description is present"
20392 (save-match-data
20393 (if (string-match org-bracket-link-analytic-regexp link)
20394 (replace-match (if (match-end 5)
20395 (match-string 5 link)
20396 (concat (match-string 1 link)
20397 (match-string 3 link)))
20398 nil t link)
20399 link)))
20401 ;; Speedbar support
20403 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20404 "Overlay marking the agenda restriction line in speedbar.")
20405 (overlay-put org-speedbar-restriction-lock-overlay
20406 'face 'org-agenda-restriction-lock)
20407 (overlay-put org-speedbar-restriction-lock-overlay
20408 'help-echo "Agendas are currently limited to this item.")
20409 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20411 (defun org-speedbar-set-agenda-restriction ()
20412 "Restrict future agenda commands to the location at point in speedbar.
20414 (interactive)
20415 (require 'org-agenda)
20416 (let (p m tp np dir txt)
20417 (cond
20418 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20419 'org-imenu t))
20420 (setq m (get-text-property p 'org-imenu-marker))
20421 (with-current-buffer (marker-buffer m)
20422 (goto-char m)
20423 (org-agenda-set-restriction-lock 'subtree)))
20424 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20425 'speedbar-function 'speedbar-find-file))
20426 (setq tp (previous-single-property-change
20427 (1+ p) 'speedbar-function)
20428 np (next-single-property-change
20429 tp 'speedbar-function)
20430 dir (speedbar-line-directory)
20431 txt (buffer-substring-no-properties (or tp (point-min))
20432 (or np (point-max))))
20433 (with-current-buffer (find-file-noselect
20434 (let ((default-directory dir))
20435 (expand-file-name txt)))
20436 (unless (org-mode-p)
20437 (error "Cannot restrict to non-Org-mode file"))
20438 (org-agenda-set-restriction-lock 'file)))
20439 (t (error "Don't know how to restrict Org-mode's agenda")))
20440 (move-overlay org-speedbar-restriction-lock-overlay
20441 (point-at-bol) (point-at-eol))
20442 (setq current-prefix-arg nil)
20443 (org-agenda-maybe-redo)))
20445 (eval-after-load "speedbar"
20446 '(progn
20447 (speedbar-add-supported-extension ".org")
20448 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20449 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20450 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20451 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20452 (add-hook 'speedbar-visiting-tag-hook
20453 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20455 ;;; Fixes and Hacks for problems with other packages
20457 ;; Make flyspell not check words in links, to not mess up our keymap
20458 (defun org-mode-flyspell-verify ()
20459 "Don't let flyspell put overlays at active buttons, or on
20460 {todo,all-time,additional-option-like}-keywords."
20461 (let ((pos (max (1- (point)) (point-min)))
20462 (word (thing-at-point 'word)))
20463 (and (not (get-text-property pos 'keymap))
20464 (not (get-text-property pos 'org-no-flyspell))
20465 (not (member word org-todo-keywords-1))
20466 (not (member word org-all-time-keywords))
20467 (not (member word org-additional-option-like-keywords)))))
20469 (defun org-remove-flyspell-overlays-in (beg end)
20470 "Remove flyspell overlays in region."
20471 (and (org-bound-and-true-p flyspell-mode)
20472 (fboundp 'flyspell-delete-region-overlays)
20473 (flyspell-delete-region-overlays beg end))
20474 (add-text-properties beg end '(org-no-flyspell t)))
20476 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20477 (eval-after-load "bookmark"
20478 '(if (boundp 'bookmark-after-jump-hook)
20479 ;; We can use the hook
20480 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20481 ;; Hook not available, use advice
20482 (defadvice bookmark-jump (after org-make-visible activate)
20483 "Make the position visible."
20484 (org-bookmark-jump-unhide))))
20486 ;; Make sure saveplace shows the location if it was hidden
20487 (eval-after-load "saveplace"
20488 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20489 "Make the position visible."
20490 (org-bookmark-jump-unhide)))
20492 ;; Make sure ecb shows the location if it was hidden
20493 (eval-after-load "ecb"
20494 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20495 "Make hierarchy visible when jumping into location from ECB tree buffer."
20496 (if (org-mode-p)
20497 (org-show-context))))
20499 (defun org-bookmark-jump-unhide ()
20500 "Unhide the current position, to show the bookmark location."
20501 (and (org-mode-p)
20502 (or (outline-invisible-p)
20503 (save-excursion (goto-char (max (point-min) (1- (point))))
20504 (outline-invisible-p)))
20505 (org-show-context 'bookmark-jump)))
20507 ;; Make session.el ignore our circular variable
20508 (eval-after-load "session"
20509 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20511 ;;;; Experimental code
20513 (defun org-closed-in-range ()
20514 "Sparse tree of items closed in a certain time range.
20515 Still experimental, may disappear in the future."
20516 (interactive)
20517 ;; Get the time interval from the user.
20518 (let* ((time1 (org-float-time
20519 (org-read-date nil 'to-time nil "Starting date: ")))
20520 (time2 (org-float-time
20521 (org-read-date nil 'to-time nil "End date:")))
20522 ;; callback function
20523 (callback (lambda ()
20524 (let ((time
20525 (org-float-time
20526 (apply 'encode-time
20527 (org-parse-time-string
20528 (match-string 1))))))
20529 ;; check if time in interval
20530 (and (>= time time1) (<= time time2))))))
20531 ;; make tree, check each match with the callback
20534 ;;;; Finish up
20536 (provide 'org)
20538 (run-hooks 'org-load-hook)
20540 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20542 ;;; org.el ends here